@flagix/js-sdk 1.1.0

package/.turbo/turbo-build.log

@@ -0,0 +1,19 @@
+
+> @flagix/js-sdk@1.1.0 build /home/runner/work/flagixx/flagixx/sdk/javascript
+> tsup src/index.ts --format cjs,esm --dts --clean
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.1
+CLI Target: es2020
+CLI Cleaning output folder
+CJS Build start
+ESM Build start
+CJS dist/index.js 17.16 KB
+CJS ⚡️ Build success in 49ms
+ESM dist/index.mjs 15.47 KB
+ESM ⚡️ Build success in 49ms
+DTS Build start
+DTS ⚡️ Build success in 1843ms
+DTS dist/index.d.ts  2.30 KB
+DTS dist/index.d.mts 2.30 KB

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# @flagix/js-sdk
+
+## 1.1.0
+
+### Minor Changes
+
+- ab7f12d: initial release
+
+### Patch Changes
+
+- Updated dependencies [ab7f12d]
+  - @flagix/evaluation-core@1.1.0

package/dist/index.d.mts

@@ -0,0 +1,68 @@
+import { EvaluationContext, VariationValue } from '@flagix/evaluation-core';
+export { EvaluationContext, FlagConfig, FlagVariation, VariationValue } from '@flagix/evaluation-core';
+
+/**
+ * 'info' is for detailed debugging information
+ * 'warn' is for non-critical issues
+ * 'error' is for critical failures
+ * 'none' suppresses all output.
+ */
+type LogLevel = "none" | "error" | "warn" | "info";
+
+type FlagixClientOptions = {
+    /** The API Key for the environment */
+    apiKey: string;
+    /** The base URL for the flag evaluation API  */
+    apiBaseUrl: string;
+    /** Optional context attributes  */
+    initialContext?: EvaluationContext;
+    /** Enable SDK logging */
+    logs?: {
+        level?: LogLevel;
+    };
+};
+
+declare const Flagix: {
+    /**
+     * Initializes the Flagix SDK, fetches all flags, and sets up an SSE connection.
+     */
+    initialize(options: FlagixClientOptions): Promise<void>;
+    /**
+     * Evaluates a flag based on the local cache and current context.
+     * @param flagKey The key of the flag to evaluate.
+     * @param contextOverrides Optional, temporary context overrides.
+     */
+    evaluate<T extends VariationValue>(flagKey: string, contextOverrides?: EvaluationContext): T | null;
+    /**
+     * Records a custom event for analytics.
+     * @param eventName The name of the event.
+     * @param properties Optional custom metadata.
+     * @param contextOverrides Optional context.
+     */
+    track(eventName: string, properties?: Record<string, unknown>, contextOverrides?: EvaluationContext): void;
+    /**
+     * Sets or updates the global evaluation context.
+     * @param newContext New context attributes to merge or replace.
+     */
+    setContext(newContext: EvaluationContext): void;
+    /**
+     * Closes the SSE connection and cleans up resources.
+     */
+    close(): void;
+    /**
+     * checks initialization status
+     */
+    isInitialized(): boolean;
+    /**
+     * Subscribes a listener to updates for any flag.
+     * @param listener The callback function (receives the updated flagKey).
+     */
+    onFlagUpdate(listener: (flagKey: string) => void): void;
+    /**
+     * Unsubscribes a listener from flag updates.
+     * @param listener The callback function to remove.
+     */
+    offFlagUpdate(listener: (flagKey: string) => void): void;
+};
+
+export { Flagix, type FlagixClientOptions };

package/dist/index.d.ts

@@ -0,0 +1,68 @@
+import { EvaluationContext, VariationValue } from '@flagix/evaluation-core';
+export { EvaluationContext, FlagConfig, FlagVariation, VariationValue } from '@flagix/evaluation-core';
+
+/**
+ * 'info' is for detailed debugging information
+ * 'warn' is for non-critical issues
+ * 'error' is for critical failures
+ * 'none' suppresses all output.
+ */
+type LogLevel = "none" | "error" | "warn" | "info";
+
+type FlagixClientOptions = {
+    /** The API Key for the environment */
+    apiKey: string;
+    /** The base URL for the flag evaluation API  */
+    apiBaseUrl: string;
+    /** Optional context attributes  */
+    initialContext?: EvaluationContext;
+    /** Enable SDK logging */
+    logs?: {
+        level?: LogLevel;
+    };
+};
+
+declare const Flagix: {
+    /**
+     * Initializes the Flagix SDK, fetches all flags, and sets up an SSE connection.
+     */
+    initialize(options: FlagixClientOptions): Promise<void>;
+    /**
+     * Evaluates a flag based on the local cache and current context.
+     * @param flagKey The key of the flag to evaluate.
+     * @param contextOverrides Optional, temporary context overrides.
+     */
+    evaluate<T extends VariationValue>(flagKey: string, contextOverrides?: EvaluationContext): T | null;
+    /**
+     * Records a custom event for analytics.
+     * @param eventName The name of the event.
+     * @param properties Optional custom metadata.
+     * @param contextOverrides Optional context.
+     */
+    track(eventName: string, properties?: Record<string, unknown>, contextOverrides?: EvaluationContext): void;
+    /**
+     * Sets or updates the global evaluation context.
+     * @param newContext New context attributes to merge or replace.
+     */
+    setContext(newContext: EvaluationContext): void;
+    /**
+     * Closes the SSE connection and cleans up resources.
+     */
+    close(): void;
+    /**
+     * checks initialization status
+     */
+    isInitialized(): boolean;
+    /**
+     * Subscribes a listener to updates for any flag.
+     * @param listener The callback function (receives the updated flagKey).
+     */
+    onFlagUpdate(listener: (flagKey: string) => void): void;
+    /**
+     * Unsubscribes a listener from flag updates.
+     * @param listener The callback function to remove.
+     */
+    offFlagUpdate(listener: (flagKey: string) => void): void;
+};
+
+export { Flagix, type FlagixClientOptions };