@flipswitch-io/sdk 0.1.4 → 0.1.5

package/dist/index.d.mts

@@ -21,13 +21,6 @@ interface FlipswitchOptions {
      * @default true
      */
     enableRealtime?: boolean;
-    /**
-     * Enable telemetry collection.
-     * When enabled, the SDK sends usage statistics (SDK version, runtime version,
-     * OS, architecture) to help improve the service. No personal data is collected.
-     * @default true
-     */
-    enableTelemetry?: boolean;
     /**
      * Custom fetch function for making HTTP requests.
      * Useful for testing or custom networking needs.
@@ -35,13 +28,48 @@ interface FlipswitchOptions {
     fetchImplementation?: typeof fetch;
 }
 /**
- * Event emitted when a flag changes.
+ * Event emitted when a single flag is updated.
  */
-interface FlagChangeEvent {
+interface FlagUpdatedEvent {
+    /**
+     * The key of the flag that changed.
+     */
+    flagKey: string;
     /**
-     * The ID of the environment where the change occurred.
+     * ISO timestamp of when the change occurred.
      */
-    environmentId: number;
+    timestamp: string;
+}
+/**
+ * Event emitted when configuration changes that may affect multiple flags.
+ */
+interface ConfigUpdatedEvent {
+    /**
+     * The reason for the configuration update.
+     * Possible values: 'segment-modified', 'api-key-rotated'
+     */
+    reason: string;
+    /**
+     * ISO timestamp of when the change occurred.
+     */
+    timestamp: string;
+}
+/**
+ * Union type for all flag events.
+ * Used internally to handle both event types.
+ */
+type FlagEvent = {
+    type: 'flag-updated';
+    data: FlagUpdatedEvent;
+} | {
+    type: 'config-updated';
+    data: ConfigUpdatedEvent;
+};
+/**
+ * @deprecated Use FlagUpdatedEvent or ConfigUpdatedEvent instead.
+ * Event emitted when a flag changes (legacy format).
+ */
+interface FlagChangeEvent {
     /**
      * The key of the flag that changed, or null for bulk invalidation.
      */
@@ -122,7 +150,6 @@ declare class FlipswitchProvider {
     private readonly baseUrl;
     private readonly apiKey;
     private readonly enableRealtime;
-    private readonly enableTelemetry;
     private readonly fetchImpl;
     private readonly ofrepProvider;
     private sseClient;
@@ -300,4 +327,4 @@ declare class FlagCache {
     handleFlagChange(event: FlagChangeEvent): void;
 }
 
-export { FlagCache, type FlagChangeEvent, type FlagEvaluation, type FlipswitchEventHandlers, type FlipswitchOptions, FlipswitchProvider, SseClient, type SseConnectionStatus };
+export { type ConfigUpdatedEvent, FlagCache, type FlagChangeEvent, type FlagEvaluation, type FlagEvent, type FlagUpdatedEvent, type FlipswitchEventHandlers, type FlipswitchOptions, FlipswitchProvider, SseClient, type SseConnectionStatus };

package/dist/index.d.ts

@@ -21,13 +21,6 @@ interface FlipswitchOptions {
      * @default true
      */
     enableRealtime?: boolean;
-    /**
-     * Enable telemetry collection.
-     * When enabled, the SDK sends usage statistics (SDK version, runtime version,
-     * OS, architecture) to help improve the service. No personal data is collected.
-     * @default true
-     */
-    enableTelemetry?: boolean;
     /**
      * Custom fetch function for making HTTP requests.
      * Useful for testing or custom networking needs.
@@ -35,13 +28,48 @@ interface FlipswitchOptions {
     fetchImplementation?: typeof fetch;
 }
 /**
- * Event emitted when a flag changes.
+ * Event emitted when a single flag is updated.
  */
-interface FlagChangeEvent {
+interface FlagUpdatedEvent {
+    /**
+     * The key of the flag that changed.
+     */
+    flagKey: string;
     /**
-     * The ID of the environment where the change occurred.
+     * ISO timestamp of when the change occurred.
      */
-    environmentId: number;
+    timestamp: string;
+}
+/**
+ * Event emitted when configuration changes that may affect multiple flags.
+ */
+interface ConfigUpdatedEvent {
+    /**
+     * The reason for the configuration update.
+     * Possible values: 'segment-modified', 'api-key-rotated'
+     */
+    reason: string;
+    /**
+     * ISO timestamp of when the change occurred.
+     */
+    timestamp: string;
+}
+/**
+ * Union type for all flag events.
+ * Used internally to handle both event types.
+ */
+type FlagEvent = {
+    type: 'flag-updated';
+    data: FlagUpdatedEvent;
+} | {
+    type: 'config-updated';
+    data: ConfigUpdatedEvent;
+};
+/**
+ * @deprecated Use FlagUpdatedEvent or ConfigUpdatedEvent instead.
+ * Event emitted when a flag changes (legacy format).
+ */
+interface FlagChangeEvent {
     /**
      * The key of the flag that changed, or null for bulk invalidation.
      */
@@ -122,7 +150,6 @@ declare class FlipswitchProvider {
     private readonly baseUrl;
     private readonly apiKey;
     private readonly enableRealtime;
-    private readonly enableTelemetry;
     private readonly fetchImpl;
     private readonly ofrepProvider;
     private sseClient;
@@ -300,4 +327,4 @@ declare class FlagCache {
     handleFlagChange(event: FlagChangeEvent): void;
 }
 
-export { FlagCache, type FlagChangeEvent, type FlagEvaluation, type FlipswitchEventHandlers, type FlipswitchOptions, FlipswitchProvider, SseClient, type SseConnectionStatus };
+export { type ConfigUpdatedEvent, FlagCache, type FlagChangeEvent, type FlagEvaluation, type FlagEvent, type FlagUpdatedEvent, type FlipswitchEventHandlers, type FlipswitchOptions, FlipswitchProvider, SseClient, type SseConnectionStatus };

package/dist/index.js

@@ -149,13 +149,33 @@ var SseClient = class {
     if (eventType === "heartbeat") {
       return;
     }
-    if (eventType === "flag-change") {
-      try {
+    try {
+      if (eventType === "flag-updated") {
+        const parsed = JSON.parse(data);
+        const event = {
+          flagKey: parsed.flagKey,
+          timestamp: parsed.timestamp
+        };
+        this.onFlagChange(event);
+      } else if (eventType === "config-updated") {
+        const parsed = JSON.parse(data);
+        if (parsed.reason === "api-key-rotated") {
+          console.warn(
+            "[Flipswitch] API key has been rotated. You may need to update your API key configuration."
+          );
+        }
+        const event = {
+          flagKey: null,
+          // null indicates all flags should be refreshed
+          timestamp: parsed.timestamp
+        };
+        this.onFlagChange(event);
+      } else if (eventType === "flag-change") {
         const event = JSON.parse(data);
         this.onFlagChange(event);
-      } catch (error) {
-        console.error("[Flipswitch] Failed to parse flag-change event:", error);
       }
+    } catch (error) {
+      console.error(`[Flipswitch] Failed to parse ${eventType} event:`, error);
     }
   }
   /**
@@ -219,16 +239,15 @@ var FlipswitchProvider = class {
     this.baseUrl = (options.baseUrl ?? DEFAULT_BASE_URL).replace(/\/$/, "");
     this.apiKey = options.apiKey;
     this.enableRealtime = options.enableRealtime ?? true;
-    this.enableTelemetry = options.enableTelemetry ?? true;
     this.fetchImpl = options.fetchImplementation ?? (typeof window !== "undefined" ? fetch.bind(window) : fetch);
     this.userEventHandlers = eventHandlers ?? {};
-    const headers = [["X-API-Key", this.apiKey]];
-    if (this.enableTelemetry) {
-      headers.push(["X-Flipswitch-SDK", this.getTelemetrySdkHeader()]);
-      headers.push(["X-Flipswitch-Runtime", this.getTelemetryRuntimeHeader()]);
-      headers.push(["X-Flipswitch-OS", this.getTelemetryOsHeader()]);
-      headers.push(["X-Flipswitch-Features", this.getTelemetryFeaturesHeader()]);
-    }
+    const headers = [
+      ["X-API-Key", this.apiKey],
+      ["X-Flipswitch-SDK", this.getTelemetrySdkHeader()],
+      ["X-Flipswitch-Runtime", this.getTelemetryRuntimeHeader()],
+      ["X-Flipswitch-OS", this.getTelemetryOsHeader()],
+      ["X-Flipswitch-Features", this.getTelemetryFeaturesHeader()]
+    ];
     this.ofrepProvider = new import_ofrep_web_provider.OFREPWebProvider({
       baseUrl: this.baseUrl,
       fetchImplementation: this.fetchImpl,
@@ -286,7 +305,6 @@ var FlipswitchProvider = class {
     return `sse=${this.enableRealtime}`;
   }
   getTelemetryHeaders() {
-    if (!this.enableTelemetry) return {};
     return {
       "X-Flipswitch-SDK": this.getTelemetrySdkHeader(),
       "X-Flipswitch-Runtime": this.getTelemetryRuntimeHeader(),
@@ -375,9 +393,6 @@ var FlipswitchProvider = class {
    * Get telemetry headers as a map.
    */
   getTelemetryHeadersMap() {
-    if (!this.enableTelemetry) {
-      return void 0;
-    }
     return {
       "X-Flipswitch-SDK": this.getTelemetrySdkHeader(),
       "X-Flipswitch-Runtime": this.getTelemetryRuntimeHeader(),

package/dist/index.mjs

@@ -124,13 +124,33 @@ var SseClient = class {
     if (eventType === "heartbeat") {
       return;
     }
-    if (eventType === "flag-change") {
-      try {
+    try {
+      if (eventType === "flag-updated") {
+        const parsed = JSON.parse(data);
+        const event = {
+          flagKey: parsed.flagKey,
+          timestamp: parsed.timestamp
+        };
+        this.onFlagChange(event);
+      } else if (eventType === "config-updated") {
+        const parsed = JSON.parse(data);
+        if (parsed.reason === "api-key-rotated") {
+          console.warn(
+            "[Flipswitch] API key has been rotated. You may need to update your API key configuration."
+          );
+        }
+        const event = {
+          flagKey: null,
+          // null indicates all flags should be refreshed
+          timestamp: parsed.timestamp
+        };
+        this.onFlagChange(event);
+      } else if (eventType === "flag-change") {
         const event = JSON.parse(data);
         this.onFlagChange(event);
-      } catch (error) {
-        console.error("[Flipswitch] Failed to parse flag-change event:", error);
       }
+    } catch (error) {
+      console.error(`[Flipswitch] Failed to parse ${eventType} event:`, error);
     }
   }
   /**
@@ -194,16 +214,15 @@ var FlipswitchProvider = class {
     this.baseUrl = (options.baseUrl ?? DEFAULT_BASE_URL).replace(/\/$/, "");
     this.apiKey = options.apiKey;
     this.enableRealtime = options.enableRealtime ?? true;
-    this.enableTelemetry = options.enableTelemetry ?? true;
     this.fetchImpl = options.fetchImplementation ?? (typeof window !== "undefined" ? fetch.bind(window) : fetch);
     this.userEventHandlers = eventHandlers ?? {};
-    const headers = [["X-API-Key", this.apiKey]];
-    if (this.enableTelemetry) {
-      headers.push(["X-Flipswitch-SDK", this.getTelemetrySdkHeader()]);
-      headers.push(["X-Flipswitch-Runtime", this.getTelemetryRuntimeHeader()]);
-      headers.push(["X-Flipswitch-OS", this.getTelemetryOsHeader()]);
-      headers.push(["X-Flipswitch-Features", this.getTelemetryFeaturesHeader()]);
-    }
+    const headers = [
+      ["X-API-Key", this.apiKey],
+      ["X-Flipswitch-SDK", this.getTelemetrySdkHeader()],
+      ["X-Flipswitch-Runtime", this.getTelemetryRuntimeHeader()],
+      ["X-Flipswitch-OS", this.getTelemetryOsHeader()],
+      ["X-Flipswitch-Features", this.getTelemetryFeaturesHeader()]
+    ];
     this.ofrepProvider = new OFREPWebProvider({
       baseUrl: this.baseUrl,
       fetchImplementation: this.fetchImpl,
@@ -261,7 +280,6 @@ var FlipswitchProvider = class {
     return `sse=${this.enableRealtime}`;
   }
   getTelemetryHeaders() {
-    if (!this.enableTelemetry) return {};
     return {
       "X-Flipswitch-SDK": this.getTelemetrySdkHeader(),
       "X-Flipswitch-Runtime": this.getTelemetryRuntimeHeader(),
@@ -350,9 +368,6 @@ var FlipswitchProvider = class {
    * Get telemetry headers as a map.
    */
   getTelemetryHeadersMap() {
-    if (!this.enableTelemetry) {
-      return void 0;
-    }
     return {
       "X-Flipswitch-SDK": this.getTelemetrySdkHeader(),
       "X-Flipswitch-Runtime": this.getTelemetryRuntimeHeader(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flipswitch-io/sdk",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Flipswitch SDK with real-time SSE support for OpenFeature",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -56,7 +56,7 @@
     "@openfeature/ofrep-provider": "^0.2.2",
     "@openfeature/server-sdk": "^1.17.0",
     "@openfeature/web-sdk": "^1.7.2",
-    "@types/node": "^20.11.0",
+    "@types/node": "^24.0.0",
     "eslint": "^9.0.0",
     "tsup": "^8.0.1",
     "tsx": "^4.7.0",