@shipeasy/sdk 6.0.0 → 6.3.1

package/dist/server/index.d.mts

@@ -1,5 +1,9 @@
 import { AsyncLocalStorage } from 'node:async_hooks';
 
+type LogLevel = "silent" | "error" | "warn" | "info" | "debug";
+/** All accepted {@link LogLevel} values, in increasing verbosity. */
+declare const LOG_LEVELS: readonly LogLevel[];
+
 type SeeExtras = Record<string, string | number | boolean | null | undefined>;
 type SeeKind = "caught" | "uncaught" | "unhandled_rejection" | "network" | "violation";
 /** Built by `causesThe(subject).to(outcome)` — never constructed by hand. */
@@ -243,6 +247,16 @@ interface EngineOptions {
     disableTelemetry?: boolean;
     /** Override the telemetry beacon host. Defaults to {@link DEFAULT_TELEMETRY_URL}. */
     telemetryUrl?: string;
+    /**
+     * How chatty the SDK is on `console` when it catches an error internally.
+     * Every public runtime method (getFlag/getConfig/getExperiment/getKillswitch/
+     * track/logExposure/see) fails silently — it returns a safe default rather
+     * than throwing — and surfaces the swallowed error through this level so you
+     * still find out. Ordering: `silent` < `error` < `warn` < `info` < `debug`.
+     * Defaults to `"warn"` (prints `error` + `warn`). Pass `"silent"` to mute the
+     * SDK entirely. See {@link LogLevel}.
+     */
+    logLevel?: LogLevel;
     /**
      * Attribute names usable for targeting but never persisted in analytics
      * (LD/Statsig `privateAttributes`). The server evaluates locally so private
@@ -460,6 +474,13 @@ interface ShipeasyServerConfig {
     user?: User;
     /** i18n profile to load for SSR translations, e.g. "en:prod". Defaults to "en:prod". */
     i18nDefaultProfile?: string;
+    /**
+     * How chatty the SDK is on `console` when it swallows an internal error.
+     * `silent` < `error` < `warn` < `info` < `debug`; defaults to `"warn"`. Every
+     * runtime read/track/see call fails silently to a safe default and reports the
+     * cause at this level. See {@link EngineOptions.logLevel}.
+     */
+    logLevel?: LogLevel;
     /**
      * Disable per-evaluation usage telemetry. ON by default. On Cloudflare
      * Workers each beacon is an outbound subrequest, so disable on hot SSR paths
@@ -591,6 +612,20 @@ interface ConfigureOptions<U = unknown> extends Omit<EngineOptions, "apiKey"> {
      * verbatim, so it should carry `user_id`/`anonymous_id` + any targeting attrs).
      */
     attributes?: AttributesFn<U>;
+    /**
+     * Long-running server: start the **background poll** internally (initial fetch
+     * + periodic refresh) so flags stay fresh without a redeploy. Default `false`.
+     * With `poll: false` (default) a one-shot fetch is kicked off fire-and-forget
+     * (serverless-friendly). You never need to call `engine.init()` yourself —
+     * configuration owns the lifecycle.
+     */
+    poll?: boolean;
+    /**
+     * One-shot fetch on configure (fire-and-forget). Default `true`. Ignored when
+     * `poll: true` (the poll does the initial fetch). Set `false` only if you want
+     * to control the first fetch yourself.
+     */
+    init?: boolean;
 }
 /**
  * Configure the SDK once at app boot, then evaluate per user with
@@ -613,6 +648,77 @@ interface ConfigureOptions<U = unknown> extends Omit<EngineOptions, "apiKey"> {
 declare function configure<U = unknown>(opts: ConfigureOptions<U>): Engine;
 /** Test seam: reset the registered attribute transform. */
 declare function _resetConfigureForTests(): void;
+/** Seed shapes shared by {@link configureForTesting} / {@link configureForOffline}. */
+interface ConfigureTestOptions<U = unknown> {
+    /** Same transform as {@link configure} (default identity). */
+    attributes?: AttributesFn<U>;
+    /** `{ name: bool }` — forced `getFlag` results. */
+    flags?: Record<string, boolean>;
+    /** `{ name: value }` — forced `getConfig` results. */
+    configs?: Record<string, unknown>;
+    /** `{ name: [group, params] }` — forced enrolments. */
+    experiments?: Record<string, [string, Record<string, unknown>]>;
+}
+/**
+ * Configure the SDK in **test mode** — a drop-in sibling of {@link configure}
+ * with no network, ever (no api key needed). Seed what your code under test
+ * should see, then read through the ordinary `new Client(user)`:
+ *
+ * ```ts
+ * configureForTesting({ flags: { new_checkout: true } });
+ * const flags = new Client({ user_id: "u_1" });
+ * flags.getFlag("new_checkout"); // true
+ * ```
+ *
+ * Replaces any previously-configured engine, so tests can reconfigure freely.
+ */
+declare function configureForTesting<U = unknown>(opts?: ConfigureTestOptions<U>): Engine;
+/** Options for {@link configureForOffline} — exactly one of `snapshot` / `path`. */
+interface ConfigureOfflineOptions<U = unknown> extends ConfigureTestOptions<U> {
+    /** In-memory `{ flags: <body of /sdk/flags>, experiments: <body of /sdk/experiments> }`. */
+    snapshot?: {
+        flags: FlagsBlob;
+        experiments: ExpsBlob;
+    };
+    /** Path to a JSON file `{ flags, experiments }`. */
+    path?: string;
+}
+/**
+ * Configure the SDK **offline** — evaluate the REAL rules from an in-memory
+ * snapshot or a JSON file, with no network. A drop-in sibling of
+ * {@link configure} (no api key needed). Optional `flags`/`configs`/`experiments`
+ * overrides are layered on top (same shapes as {@link configureForTesting}).
+ * Replaces any previously-configured engine.
+ */
+declare function configureForOffline<U = unknown>(opts: ConfigureOfflineOptions<U>): Engine;
+/**
+ * Force `getFlag(name)` → `value` on the spot, for the current config. A quick
+ * in-test override layered on top of whatever {@link configureForTesting} /
+ * {@link configureForOffline} (or {@link configure}) set up — wins over the blob
+ * until {@link clearOverrides}.
+ */
+declare function overrideFlag(name: string, value: boolean): void;
+/** Force `getConfig(name)` → `value` on the spot (see {@link overrideFlag}). */
+declare function overrideConfig(name: string, value: unknown): void;
+/**
+ * Force `getExperiment(name)` to report enrolment in `group` with `params` on
+ * the spot (see {@link overrideFlag}).
+ */
+declare function overrideExperiment(name: string, group: string, params: Record<string, unknown>): void;
+/**
+ * Drop every on-the-spot flag/config/experiment override — INCLUDING the seed
+ * from {@link configureForTesting} (test mode has no blob beneath, so everything
+ * reverts to the empty-blob defaults). Under {@link configureForOffline} the
+ * snapshot remains and evaluations revert to it.
+ */
+declare function clearOverrides(): void;
+/**
+ * Register a listener fired after a background poll fetches NEW data (a 200, not
+ * a 304). Returns an unsubscribe callable. Requires `configure({ poll: true })`
+ * (no poll thread runs otherwise). Configuration owns the engine; you never
+ * touch it.
+ */
+declare function onChange(listener: () => void): () => void;
 /**
  * A user-bound evaluation handle. Construct one per user/request — it's cheap
  * (it delegates to the {@link Engine} built by {@link configure}); it does NOT
@@ -637,6 +743,21 @@ declare class Client<U = unknown> {
     getExperiment<P extends Record<string, unknown>>(name: string, defaultParams: P, decode?: (raw: unknown) => P): ExperimentResult<P>;
     /** Read a killswitch (not user-bound; mirrors {@link Engine.getKillswitch}). */
     getKillswitch(name: string, switchKey?: string): boolean;
+    /**
+     * Record a conversion/metric event for the bound user. Derives the unit from
+     * the resolved attribute bag (`user_id`, else `anonymous_id`) and delegates to
+     * {@link Engine.track} — so an experiment is end-to-end Client-only (no need to
+     * drop down to the Engine to log a conversion). Fire-and-forget; no-op in test
+     * mode.
+     */
+    track(eventName: string, props?: Record<string, unknown>): void;
+    /**
+     * Emit an exposure event for `name` at this server-side decision point for the
+     * bound user. Delegates to {@link Engine.logExposure} with the resolved
+     * attribute bag (re-evaluates enrolment; no-op when the user isn't enrolled or
+     * in test mode).
+     */
+    logExposure(name: string): void;
 }
 interface SeeApi {
     /**
@@ -689,4 +810,4 @@ interface SeeApi {
  */
 declare const see: SeeApi;
 
-export { ANON_ID_COOKIE, type AttributesFn, type BootstrapData, type BootstrapEmitOptions, type BootstrapPayload, Client, type ConfigureOptions, type Consequence, Engine, type EngineEnv, type EngineOptions, type ExperimentResult, type ExpsBlob, FLAG_REASONS, type FetchLabelsOptions, type FlagDetail, type FlagReason, type FlagsBlob, type GetConfigOptions, type I18nForRequest, type LabelFile, type ScriptTagSpec, type SeeApi, type SeeChain, type SeeControlFlowChain, type SeeErrorEvent, type SeeExtras, type SeeKind, type SeeViolationChain, type ShipeasyServerConfig, type ShipeasyServerHandle, type StickyBucketStore, type StickyEntry, type User, type Violation, _murmur3ForTests, _resetConfigureForTests, _resetShipeasyServerForTests, configure, configureShipeasyServer, createInMemoryStickyStore, fetchLabelsForSSR, flags, getBootstrapData, getBootstrapTags, getShipeasyServerClient, i18n, isExpected, see, seeContext, shipeasy, version };
+export { ANON_ID_COOKIE, type AttributesFn, type BootstrapData, type BootstrapEmitOptions, type BootstrapPayload, Client, type ConfigureOfflineOptions, type ConfigureOptions, type ConfigureTestOptions, type Consequence, Engine, type EngineEnv, type EngineOptions, type ExperimentResult, type ExpsBlob, FLAG_REASONS, type FetchLabelsOptions, type FlagDetail, type FlagReason, type FlagsBlob, type GetConfigOptions, type I18nForRequest, LOG_LEVELS, type LabelFile, type LogLevel, type ScriptTagSpec, type SeeApi, type SeeChain, type SeeControlFlowChain, type SeeErrorEvent, type SeeExtras, type SeeKind, type SeeViolationChain, type ShipeasyServerConfig, type ShipeasyServerHandle, type StickyBucketStore, type StickyEntry, type User, type Violation, _murmur3ForTests, _resetConfigureForTests, _resetShipeasyServerForTests, clearOverrides, configure, configureForOffline, configureForTesting, configureShipeasyServer, createInMemoryStickyStore, fetchLabelsForSSR, flags, getBootstrapData, getBootstrapTags, getShipeasyServerClient, i18n, isExpected, onChange, overrideConfig, overrideExperiment, overrideFlag, see, seeContext, shipeasy, version };

package/dist/server/index.d.ts

@@ -1,5 +1,9 @@
 import { AsyncLocalStorage } from 'node:async_hooks';
 
+type LogLevel = "silent" | "error" | "warn" | "info" | "debug";
+/** All accepted {@link LogLevel} values, in increasing verbosity. */
+declare const LOG_LEVELS: readonly LogLevel[];
+
 type SeeExtras = Record<string, string | number | boolean | null | undefined>;
 type SeeKind = "caught" | "uncaught" | "unhandled_rejection" | "network" | "violation";
 /** Built by `causesThe(subject).to(outcome)` — never constructed by hand. */
@@ -243,6 +247,16 @@ interface EngineOptions {
     disableTelemetry?: boolean;
     /** Override the telemetry beacon host. Defaults to {@link DEFAULT_TELEMETRY_URL}. */
     telemetryUrl?: string;
+    /**
+     * How chatty the SDK is on `console` when it catches an error internally.
+     * Every public runtime method (getFlag/getConfig/getExperiment/getKillswitch/
+     * track/logExposure/see) fails silently — it returns a safe default rather
+     * than throwing — and surfaces the swallowed error through this level so you
+     * still find out. Ordering: `silent` < `error` < `warn` < `info` < `debug`.
+     * Defaults to `"warn"` (prints `error` + `warn`). Pass `"silent"` to mute the
+     * SDK entirely. See {@link LogLevel}.
+     */
+    logLevel?: LogLevel;
     /**
      * Attribute names usable for targeting but never persisted in analytics
      * (LD/Statsig `privateAttributes`). The server evaluates locally so private
@@ -460,6 +474,13 @@ interface ShipeasyServerConfig {
     user?: User;
     /** i18n profile to load for SSR translations, e.g. "en:prod". Defaults to "en:prod". */
     i18nDefaultProfile?: string;
+    /**
+     * How chatty the SDK is on `console` when it swallows an internal error.
+     * `silent` < `error` < `warn` < `info` < `debug`; defaults to `"warn"`. Every
+     * runtime read/track/see call fails silently to a safe default and reports the
+     * cause at this level. See {@link EngineOptions.logLevel}.
+     */
+    logLevel?: LogLevel;
     /**
      * Disable per-evaluation usage telemetry. ON by default. On Cloudflare
      * Workers each beacon is an outbound subrequest, so disable on hot SSR paths
@@ -591,6 +612,20 @@ interface ConfigureOptions<U = unknown> extends Omit<EngineOptions, "apiKey"> {
      * verbatim, so it should carry `user_id`/`anonymous_id` + any targeting attrs).
      */
     attributes?: AttributesFn<U>;
+    /**
+     * Long-running server: start the **background poll** internally (initial fetch
+     * + periodic refresh) so flags stay fresh without a redeploy. Default `false`.
+     * With `poll: false` (default) a one-shot fetch is kicked off fire-and-forget
+     * (serverless-friendly). You never need to call `engine.init()` yourself —
+     * configuration owns the lifecycle.
+     */
+    poll?: boolean;
+    /**
+     * One-shot fetch on configure (fire-and-forget). Default `true`. Ignored when
+     * `poll: true` (the poll does the initial fetch). Set `false` only if you want
+     * to control the first fetch yourself.
+     */
+    init?: boolean;
 }
 /**
  * Configure the SDK once at app boot, then evaluate per user with
@@ -613,6 +648,77 @@ interface ConfigureOptions<U = unknown> extends Omit<EngineOptions, "apiKey"> {
 declare function configure<U = unknown>(opts: ConfigureOptions<U>): Engine;
 /** Test seam: reset the registered attribute transform. */
 declare function _resetConfigureForTests(): void;
+/** Seed shapes shared by {@link configureForTesting} / {@link configureForOffline}. */
+interface ConfigureTestOptions<U = unknown> {
+    /** Same transform as {@link configure} (default identity). */
+    attributes?: AttributesFn<U>;
+    /** `{ name: bool }` — forced `getFlag` results. */
+    flags?: Record<string, boolean>;
+    /** `{ name: value }` — forced `getConfig` results. */
+    configs?: Record<string, unknown>;
+    /** `{ name: [group, params] }` — forced enrolments. */
+    experiments?: Record<string, [string, Record<string, unknown>]>;
+}
+/**
+ * Configure the SDK in **test mode** — a drop-in sibling of {@link configure}
+ * with no network, ever (no api key needed). Seed what your code under test
+ * should see, then read through the ordinary `new Client(user)`:
+ *
+ * ```ts
+ * configureForTesting({ flags: { new_checkout: true } });
+ * const flags = new Client({ user_id: "u_1" });
+ * flags.getFlag("new_checkout"); // true
+ * ```
+ *
+ * Replaces any previously-configured engine, so tests can reconfigure freely.
+ */
+declare function configureForTesting<U = unknown>(opts?: ConfigureTestOptions<U>): Engine;
+/** Options for {@link configureForOffline} — exactly one of `snapshot` / `path`. */
+interface ConfigureOfflineOptions<U = unknown> extends ConfigureTestOptions<U> {
+    /** In-memory `{ flags: <body of /sdk/flags>, experiments: <body of /sdk/experiments> }`. */
+    snapshot?: {
+        flags: FlagsBlob;
+        experiments: ExpsBlob;
+    };
+    /** Path to a JSON file `{ flags, experiments }`. */
+    path?: string;
+}
+/**
+ * Configure the SDK **offline** — evaluate the REAL rules from an in-memory
+ * snapshot or a JSON file, with no network. A drop-in sibling of
+ * {@link configure} (no api key needed). Optional `flags`/`configs`/`experiments`
+ * overrides are layered on top (same shapes as {@link configureForTesting}).
+ * Replaces any previously-configured engine.
+ */
+declare function configureForOffline<U = unknown>(opts: ConfigureOfflineOptions<U>): Engine;
+/**
+ * Force `getFlag(name)` → `value` on the spot, for the current config. A quick
+ * in-test override layered on top of whatever {@link configureForTesting} /
+ * {@link configureForOffline} (or {@link configure}) set up — wins over the blob
+ * until {@link clearOverrides}.
+ */
+declare function overrideFlag(name: string, value: boolean): void;
+/** Force `getConfig(name)` → `value` on the spot (see {@link overrideFlag}). */
+declare function overrideConfig(name: string, value: unknown): void;
+/**
+ * Force `getExperiment(name)` to report enrolment in `group` with `params` on
+ * the spot (see {@link overrideFlag}).
+ */
+declare function overrideExperiment(name: string, group: string, params: Record<string, unknown>): void;
+/**
+ * Drop every on-the-spot flag/config/experiment override — INCLUDING the seed
+ * from {@link configureForTesting} (test mode has no blob beneath, so everything
+ * reverts to the empty-blob defaults). Under {@link configureForOffline} the
+ * snapshot remains and evaluations revert to it.
+ */
+declare function clearOverrides(): void;
+/**
+ * Register a listener fired after a background poll fetches NEW data (a 200, not
+ * a 304). Returns an unsubscribe callable. Requires `configure({ poll: true })`
+ * (no poll thread runs otherwise). Configuration owns the engine; you never
+ * touch it.
+ */
+declare function onChange(listener: () => void): () => void;
 /**
  * A user-bound evaluation handle. Construct one per user/request — it's cheap
  * (it delegates to the {@link Engine} built by {@link configure}); it does NOT
@@ -637,6 +743,21 @@ declare class Client<U = unknown> {
     getExperiment<P extends Record<string, unknown>>(name: string, defaultParams: P, decode?: (raw: unknown) => P): ExperimentResult<P>;
     /** Read a killswitch (not user-bound; mirrors {@link Engine.getKillswitch}). */
     getKillswitch(name: string, switchKey?: string): boolean;
+    /**
+     * Record a conversion/metric event for the bound user. Derives the unit from
+     * the resolved attribute bag (`user_id`, else `anonymous_id`) and delegates to
+     * {@link Engine.track} — so an experiment is end-to-end Client-only (no need to
+     * drop down to the Engine to log a conversion). Fire-and-forget; no-op in test
+     * mode.
+     */
+    track(eventName: string, props?: Record<string, unknown>): void;
+    /**
+     * Emit an exposure event for `name` at this server-side decision point for the
+     * bound user. Delegates to {@link Engine.logExposure} with the resolved
+     * attribute bag (re-evaluates enrolment; no-op when the user isn't enrolled or
+     * in test mode).
+     */
+    logExposure(name: string): void;
 }
 interface SeeApi {
     /**
@@ -689,4 +810,4 @@ interface SeeApi {
  */
 declare const see: SeeApi;
 
-export { ANON_ID_COOKIE, type AttributesFn, type BootstrapData, type BootstrapEmitOptions, type BootstrapPayload, Client, type ConfigureOptions, type Consequence, Engine, type EngineEnv, type EngineOptions, type ExperimentResult, type ExpsBlob, FLAG_REASONS, type FetchLabelsOptions, type FlagDetail, type FlagReason, type FlagsBlob, type GetConfigOptions, type I18nForRequest, type LabelFile, type ScriptTagSpec, type SeeApi, type SeeChain, type SeeControlFlowChain, type SeeErrorEvent, type SeeExtras, type SeeKind, type SeeViolationChain, type ShipeasyServerConfig, type ShipeasyServerHandle, type StickyBucketStore, type StickyEntry, type User, type Violation, _murmur3ForTests, _resetConfigureForTests, _resetShipeasyServerForTests, configure, configureShipeasyServer, createInMemoryStickyStore, fetchLabelsForSSR, flags, getBootstrapData, getBootstrapTags, getShipeasyServerClient, i18n, isExpected, see, seeContext, shipeasy, version };
+export { ANON_ID_COOKIE, type AttributesFn, type BootstrapData, type BootstrapEmitOptions, type BootstrapPayload, Client, type ConfigureOfflineOptions, type ConfigureOptions, type ConfigureTestOptions, type Consequence, Engine, type EngineEnv, type EngineOptions, type ExperimentResult, type ExpsBlob, FLAG_REASONS, type FetchLabelsOptions, type FlagDetail, type FlagReason, type FlagsBlob, type GetConfigOptions, type I18nForRequest, LOG_LEVELS, type LabelFile, type LogLevel, type ScriptTagSpec, type SeeApi, type SeeChain, type SeeControlFlowChain, type SeeErrorEvent, type SeeExtras, type SeeKind, type SeeViolationChain, type ShipeasyServerConfig, type ShipeasyServerHandle, type StickyBucketStore, type StickyEntry, type User, type Violation, _murmur3ForTests, _resetConfigureForTests, _resetShipeasyServerForTests, clearOverrides, configure, configureForOffline, configureForTesting, configureShipeasyServer, createInMemoryStickyStore, fetchLabelsForSSR, flags, getBootstrapData, getBootstrapTags, getShipeasyServerClient, i18n, isExpected, onChange, overrideConfig, overrideExperiment, overrideFlag, see, seeContext, shipeasy, version };