SDK Reference

go get github.com/MarkDurbin104/GoGreen/sdk/go

import (
    gogreen "github.com/MarkDurbin104/GoGreen/sdk/go"
    shared "github.com/MarkDurbin104/GoGreen/lib/shared-data"
)
 
client, err := gogreen.NewClient(gogreen.Config{
    SDKKey:          "YOUR_SDK_KEY",
    EnvID:           "YOUR_ENV_ID",
    APIBaseURL:      "https://app.gogreenflags.com",
    StreamURL:       "https://app.gogreenflags.com",
    EventsURL:       "https://app.gogreenflags.com",
    EnableStreaming:  true,
    PollInterval:    30 * time.Second,
    RequestTimeout:  5 * time.Second,
    FlushInterval:   60 * time.Second,
})
if err != nil {
    log.Fatal(err)
}
defer client.Close()

user := shared.EvaluationContext{
    Key:    "user-123",
    Custom: map[string]interface{}{
        "plan":    "enterprise",
        "country": "US",
    },
}
 
// Simple evaluation
enabled := client.BoolVariation("feature-x", user, false)
theme := client.StringVariation("ui-theme", user, "light")
limit := client.NumberVariation("rate-limit", user, 100)
config := client.JSONVariation("feature-config", user, map[string]interface{}{})
 
// Detailed evaluation (includes reason, variation index, rule index)
val, detail := client.BoolVariationDetail("feature-x", user, false)
fmt.Printf("Value: %v, Reason: %s\n", val, detail.Reason)
// Reasons: FALLTHROUGH, RULE_MATCH, TARGET_MATCH, PREREQUISITE_FAILED, OFF, ERROR

// Track custom events for experimentation
client.Track("purchase", user, map[string]any{
    "revenue":  49.99,
    "currency": "USD",
})

// Listen for flag changes
client.On("config_updated", func(data interface{}) {
    fmt.Println("Flags updated!")
})
 
// Listen for diagnostic events
client.On("diagnostic", func(data interface{}) {
    event := data.(gogreen.DiagnosticEvent)
    fmt.Printf("Status: %s\n", event.ConnectionStatus)
})
 
// Listen for errors
client.On("error", func(data interface{}) {
    fmt.Printf("Error: %v\n", data)
})

// Create an offline test client with predetermined flag values
client, _ := gogreen.NewTestClient(map[string]interface{}{
    "feature-x":  true,
    "ui-theme":   "dark",
    "rate-limit": 50,
})
 
// Use in tests — no network calls
enabled := client.BoolVariation("feature-x", user, false) // returns true

client, _ := gogreen.NewClient(gogreen.Config{
    SDKKey: "YOUR_SDK_KEY",
    EnvID:  "YOUR_ENV_ID",
    // Try URLs in order; fall back on connection failure
    APIBaseURLs: []string{
        "https://eval-us.gogreenflags.com",
        "https://eval-eu.gogreenflags.com",
    },
    StreamURLs: []string{
        "https://stream-us.gogreenflags.com",
        "https://stream-eu.gogreenflags.com",
    },
})

npm install @gogreenflags/sdk

// CommonJS / TypeScript (works out of the box)
const { GoGreenClient } = require('@gogreenflags/sdk');
 
// ESM projects
import { createRequire } from 'node:module';
const require = createRequire(import.meta.url);
const { GoGreenClient } = require('@gogreenflags/sdk');

import { GoGreenClient } from '@gogreenflags/sdk'; // TypeScript with CommonJS moduleResolution
 
const client = new GoGreenClient({
  sdkKey: 'YOUR_SDK_KEY',
  environmentId: 'YOUR_ENV_ID',
  apiBaseUrl: 'https://app.gogreenflags.com',
  streamUrl: 'https://app.gogreenflags.com',
  eventsUrl: 'https://app.gogreenflags.com',
  enableStreaming: true,
  defaultContext: {
    key: 'user-123',
    custom: { plan: 'enterprise' },
  },
});

// Simple evaluation
const enabled = client.boolVariation('feature-x', false);
const theme = client.stringVariation('ui-theme', 'light');
const limit = client.numberVariation('rate-limit', 100);
const config = client.jsonVariation('feature-config', {});
 
// Detailed evaluation
const detail = client.boolVariationDetail('feature-x', false);
console.log(detail.value);          // true
console.log(detail.reason);         // "RULE_MATCH"
console.log(detail.variationIndex); // 0
console.log(detail.ruleIndex);      // 1

// Track custom events for experimentation
client.track('purchase', { revenue: 49.99, currency: 'USD' });

// Listen for flag changes
client.on('configUpdated', () => {
  console.log('Flags updated!');
});
 
// Listen for errors
client.on('error', (err) => {
  console.error('SDK error:', err);
});

import { testClient } from '@gogreenflags/sdk';
 
// Create an offline test client
const client = testClient({
  'feature-x': true,
  'ui-theme': 'dark',
  'rate-limit': 50,
});
 
// Use in unit tests — no network calls
const enabled = client.boolVariation('feature-x', false); // returns true

// Server: embed config in HTML
const config = await fetchConfig();
res.send(`<script>window.__GOGREEN_BOOTSTRAP__ = ${JSON.stringify(config)}</script>`);
 
// Client: use bootstrap to avoid flash of default values
const client = new GoGreenClient({
  sdkKey: 'YOUR_SDK_KEY',
  environmentId: 'YOUR_ENV_ID',
  defaultContext: { key: 'user-123' },
  bootstrap: window.__GOGREEN_BOOTSTRAP__,
});