@shipeasy/sdk 6.0.0 → 6.3.1

package/dist/server/index.js

@@ -34,10 +34,14 @@ __export(server_exports, {
   Client: () => Client,
   Engine: () => Engine,
   FLAG_REASONS: () => FLAG_REASONS,
+  LOG_LEVELS: () => LOG_LEVELS,
   _murmur3ForTests: () => _murmur3ForTests,
   _resetConfigureForTests: () => _resetConfigureForTests,
   _resetShipeasyServerForTests: () => _resetShipeasyServerForTests,
+  clearOverrides: () => clearOverrides,
   configure: () => configure,
+  configureForOffline: () => configureForOffline,
+  configureForTesting: () => configureForTesting,
   configureShipeasyServer: () => configureShipeasyServer,
   createInMemoryStickyStore: () => createInMemoryStickyStore,
   fetchLabelsForSSR: () => fetchLabelsForSSR,
@@ -47,6 +51,10 @@ __export(server_exports, {
   getShipeasyServerClient: () => getShipeasyServerClient,
   i18n: () => i18n,
   isExpected: () => isExpected,
+  onChange: () => onChange,
+  overrideConfig: () => overrideConfig,
+  overrideExperiment: () => overrideExperiment,
+  overrideFlag: () => overrideFlag,
   see: () => see,
   seeContext: () => seeContext,
   shipeasy: () => shipeasy,
@@ -114,6 +122,53 @@ function send(url) {
   }
 }
 
+// src/logger.ts
+var LOG_LEVELS = ["silent", "error", "warn", "info", "debug"];
+var RANK = {
+  silent: 0,
+  error: 1,
+  warn: 2,
+  info: 3,
+  debug: 4
+};
+var currentLevel = "warn";
+function setLogLevel(level) {
+  if (typeof level === "string" && Object.prototype.hasOwnProperty.call(RANK, level)) {
+    currentLevel = level;
+  }
+}
+function write(method, args) {
+  try {
+    const c = globalThis.console;
+    if (!c) return;
+    const fn = c[method] ?? c.log;
+    if (typeof fn === "function") fn.call(c, ...args);
+  } catch {
+  }
+}
+var logger = {
+  error(...args) {
+    if (RANK[currentLevel] >= RANK.error) write("error", args);
+  },
+  warn(...args) {
+    if (RANK[currentLevel] >= RANK.warn) write("warn", args);
+  },
+  info(...args) {
+    if (RANK[currentLevel] >= RANK.info) write("info", args);
+  },
+  debug(...args) {
+    if (RANK[currentLevel] >= RANK.debug) write("debug", args);
+  }
+};
+function safeRun(label, fallback, fn) {
+  try {
+    return fn();
+  } catch (err) {
+    logger.error(`[shipeasy] ${label} failed \u2014 returning safe default:`, String(err));
+    return fallback;
+  }
+}
+
 // src/see/core.ts
 var SEE_MAX_MESSAGE = 500;
 var SEE_MAX_STACK = 8e3;
@@ -575,6 +630,7 @@ var Engine = class _Engine {
   // 304). Never fired in testMode/offline (no polling happens there).
   changeListeners = /* @__PURE__ */ new Set();
   constructor(opts) {
+    setLogLevel(opts.logLevel);
     this.apiKey = opts.apiKey;
     this.baseUrl = (opts.baseUrl ?? "https://cdn.shipeasy.ai").replace(/\/$/, "");
     this.env = opts.env ?? "prod";
@@ -698,14 +754,14 @@ var Engine = class _Engine {
       try {
         l();
       } catch (err) {
-        console.warn("[shipeasy] onChange listener threw:", String(err));
+        logger.warn("[shipeasy] onChange listener threw:", String(err));
       }
     }
   }
   startPoll() {
     this.timer = setInterval(() => {
       this.fetchAll(true).catch(
-        (err) => console.warn("[shipeasy] background poll failed:", String(err))
+        (err) => logger.warn("[shipeasy] background poll failed:", String(err))
       );
     }, this.pollInterval * 1e3);
   }
@@ -784,7 +840,12 @@ var Engine = class _Engine {
       return "defaultValue" in opts ? opts.defaultValue : void 0;
     }
     if (!opts.decode) return raw;
-    return opts.decode(raw);
+    try {
+      return opts.decode(raw);
+    } catch (err) {
+      logger.warn(`[shipeasy] getConfig('${name}') decode failed:`, String(err));
+      return "defaultValue" in opts ? opts.defaultValue : void 0;
+    }
   }
   getExperiment(name, user, defaultParams, decode) {
     this.telemetry.emit("experiment", name);
@@ -799,7 +860,7 @@ var Engine = class _Engine {
       try {
         return { inExperiment: true, group: ov.group, params: decode(ov.params) };
       } catch (err) {
-        console.warn(`[shipeasy] getExperiment('${name}') override decode failed:`, String(err));
+        logger.warn(`[shipeasy] getExperiment('${name}') override decode failed:`, String(err));
         return notIn;
       }
     }
@@ -824,7 +885,7 @@ var Engine = class _Engine {
       try {
         return { inExperiment: true, group: g.name, params: decode(g.params) };
       } catch (err) {
-        console.warn(`[shipeasy] getExperiment('${name}') decode failed:`, String(err));
+        logger.warn(`[shipeasy] getExperiment('${name}') decode failed:`, String(err));
         return notIn;
       }
     };
@@ -876,7 +937,7 @@ var Engine = class _Engine {
       method: "POST",
       headers: { "X-SDK-Key": this.apiKey, "Content-Type": "text/plain" },
       body
-    }).catch((err) => console.warn("[shipeasy] track failed:", String(err)));
+    }).catch((err) => logger.warn("[shipeasy] track failed:", String(err)));
   }
   /**
    * Emit an exposure event for an experiment at the server-side decision point
@@ -907,7 +968,7 @@ var Engine = class _Engine {
       method: "POST",
       headers: { "X-SDK-Key": this.apiKey, "Content-Type": "text/plain" },
       body
-    }).catch((err) => console.warn("[shipeasy] logExposure failed:", String(err)));
+    }).catch((err) => logger.warn("[shipeasy] logExposure failed:", String(err)));
   }
   /**
    * Report a structured error into the errors primitive. Fire-and-forget —
@@ -927,7 +988,7 @@ var Engine = class _Engine {
         method: "POST",
         headers: { "X-SDK-Key": this.apiKey, "Content-Type": "text/plain" },
         body: JSON.stringify({ events: [ev] })
-      }).catch((err) => console.warn("[shipeasy] see() send failed:", String(err)));
+      }).catch((err) => logger.warn("[shipeasy] see() send failed:", String(err)));
     } catch {
     }
   }
@@ -981,7 +1042,11 @@ var Engine = class _Engine {
     const ks = this.flagsBlob?.killswitches?.[name];
     if (!ks) return false;
     if (switchKey === void 0) return isEnabled(ks.killed);
-    return isEnabled(ks.switches?.[switchKey]);
+    const switches = ks.switches ?? {};
+    if (Object.prototype.hasOwnProperty.call(switches, switchKey)) {
+      return isEnabled(switches[switchKey]);
+    }
+    return isEnabled(ks.killed);
   }
 };
 var _I18N_SSR_SYM = /* @__PURE__ */ Symbol.for("@shipeasy/sdk:ssr-i18n");
@@ -1110,7 +1175,7 @@ function _resetShipeasyServerForTests() {
 async function shipeasy(opts) {
   const serverKey = opts.serverKey ?? "";
   if (!serverKey) {
-    console.error(
+    logger.error(
       "[shipeasy] No server key \u2014 flags, experiments and SSR i18n skipped. Pass `serverKey` to shipeasy() from @shipeasy/sdk/server with your server key (SHIPEASY_SERVER_KEY). Set it as a Worker secret with `wrangler secret put SHIPEASY_SERVER_KEY` (or add it to .env for local dev). Do not pass a client key here \u2014 the server entrypoint only accepts the server key."
     );
   }
@@ -1118,7 +1183,8 @@ async function shipeasy(opts) {
   flags.configure({
     apiKey: serverKey,
     disableTelemetry: opts.disableTelemetry,
-    privateAttributes: opts.privateAttributes
+    privateAttributes: opts.privateAttributes,
+    logLevel: opts.logLevel
   });
   let resolvedUrlOverrides = opts.urlOverrides;
   if (!resolvedUrlOverrides) {
@@ -1244,21 +1310,30 @@ var flags = {
     _server?.destroy();
   },
   get(name, user, defaultValue = false) {
-    return _server?.getFlag(name, user, defaultValue) ?? defaultValue;
+    return safeRun("flags.get", defaultValue, () => _server?.getFlag(name, user, defaultValue) ?? defaultValue);
   },
   /** Evaluate a gate and report why (value + reason). See {@link FlagDetail}. */
   getDetail(name, user) {
-    return _server?.getFlagDetail(name, user) ?? { value: false, reason: "CLIENT_NOT_READY" };
+    return safeRun(
+      "flags.getDetail",
+      { value: false, reason: "CLIENT_NOT_READY" },
+      () => _server?.getFlagDetail(name, user) ?? { value: false, reason: "CLIENT_NOT_READY" }
+    );
   },
   getConfig(name, decodeOrOpts) {
-    return _server?.getConfig(name, decodeOrOpts);
+    return safeRun(
+      "flags.getConfig",
+      void 0,
+      () => _server?.getConfig(name, decodeOrOpts)
+    );
   },
   getExperiment(name, user, defaultParams, decode) {
-    return _server?.getExperiment(name, user, defaultParams, decode) ?? {
-      inExperiment: false,
-      group: "control",
-      params: defaultParams
-    };
+    const notIn = { inExperiment: false, group: "control", params: defaultParams };
+    return safeRun(
+      "flags.getExperiment",
+      notIn,
+      () => _server?.getExperiment(name, user, defaultParams, decode) ?? notIn
+    );
   },
   /**
    * Read a killswitch. Without `switchKey`, returns true when the whole
@@ -1266,15 +1341,15 @@ var flags = {
    * switch is on. Unknown killswitches / switches return false.
    */
   ks(name, switchKey) {
-    return _server?.getKillswitch(name, switchKey) ?? false;
+    return safeRun("flags.ks", false, () => _server?.getKillswitch(name, switchKey) ?? false);
   },
   track(userId, eventName, props) {
-    _server?.track(userId, eventName, props);
+    safeRun("flags.track", void 0, () => _server?.track(userId, eventName, props));
   },
   /** Emit an exposure for an enrolled experiment at the decision point. See
    *  {@link Engine.logExposure}. No-op before configure(). */
   logExposure(user, name) {
-    _server?.logExposure(user, name);
+    safeRun("flags.logExposure", void 0, () => _server?.logExposure(user, name));
   },
   /**
    * Evaluate all flags / configs / experiments for a user against the locally
@@ -1282,27 +1357,81 @@ var flags = {
    * overrides. Returns an empty payload when the blob hasn't been fetched yet.
    */
   evaluate(user, rawUrl) {
-    return _server?.evaluate(user, rawUrl) ?? {
-      flags: {},
-      configs: {},
-      experiments: {},
-      killswitches: {}
-    };
+    const empty = { flags: {}, configs: {}, experiments: {}, killswitches: {} };
+    return safeRun("flags.evaluate", empty, () => _server?.evaluate(user, rawUrl) ?? empty);
   }
 };
 var _identityAttributes = (user) => user && typeof user === "object" ? user : {};
 var _attributes = _identityAttributes;
 function configure(opts) {
-  const { attributes, ...engineOpts } = opts;
+  const { attributes, poll = false, init = true, ...engineOpts } = opts;
   _attributes = attributes ?? _identityAttributes;
   const engine = configureShipeasyServer(engineOpts);
-  void engine.initOnce().catch(() => {
-  });
+  if (poll) {
+    void engine.init().catch(() => {
+    });
+  } else if (init) {
+    void engine.initOnce().catch(() => {
+    });
+  }
   return engine;
 }
 function _resetConfigureForTests() {
   _attributes = _identityAttributes;
 }
+function _installGlobalEngine(engine, attributes) {
+  _server?.destroy();
+  _server = engine;
+  _attributes = attributes ?? _identityAttributes;
+  return engine;
+}
+function _applyOverrides(engine, flags2, configs, experiments) {
+  for (const [name, value] of Object.entries(flags2 ?? {})) engine.overrideFlag(name, value);
+  for (const [name, value] of Object.entries(configs ?? {})) engine.overrideConfig(name, value);
+  for (const [name, [group, params]] of Object.entries(experiments ?? {}))
+    engine.overrideExperiment(name, group, params);
+}
+function configureForTesting(opts = {}) {
+  const engine = Engine.forTesting();
+  _applyOverrides(engine, opts.flags, opts.configs, opts.experiments);
+  return _installGlobalEngine(engine, opts.attributes);
+}
+function configureForOffline(opts) {
+  let engine;
+  if (opts.path !== void 0) {
+    engine = Engine.fromFile(opts.path);
+  } else if (opts.snapshot !== void 0) {
+    engine = Engine.fromSnapshot(opts.snapshot);
+  } else {
+    throw new Error("[shipeasy] configureForOffline requires either { snapshot } or { path }");
+  }
+  _applyOverrides(engine, opts.flags, opts.configs, opts.experiments);
+  return _installGlobalEngine(engine, opts.attributes);
+}
+function _requireGlobal(fn) {
+  const engine = getShipeasyServerClient();
+  if (!engine) {
+    throw new Error(
+      `[shipeasy] ${fn}(...) called before configure({ apiKey }) (or a configureFor* sibling).`
+    );
+  }
+  return engine;
+}
+function overrideFlag(name, value) {
+  _requireGlobal("overrideFlag").overrideFlag(name, value);
+}
+function overrideConfig(name, value) {
+  _requireGlobal("overrideConfig").overrideConfig(name, value);
+}
+function overrideExperiment(name, group, params) {
+  _requireGlobal("overrideExperiment").overrideExperiment(name, group, params);
+}
+function clearOverrides() {
+  _requireGlobal("clearOverrides").clearOverrides();
+}
+function onChange(listener) {
+  return _requireGlobal("onChange").onChange(listener);
+}
 var Client = class {
   engine;
   /** The resolved attribute bag this handle evaluates against. */
@@ -1318,25 +1447,65 @@ var Client = class {
     this.attributes = _attributes(user);
   }
   getFlag(name, defaultValue = false) {
-    return this.engine.getFlag(name, this.attributes, defaultValue);
+    return safeRun(
+      "Client.getFlag",
+      defaultValue,
+      () => this.engine.getFlag(name, this.attributes, defaultValue)
+    );
   }
   getFlagDetail(name) {
-    return this.engine.getFlagDetail(name, this.attributes);
+    return safeRun(
+      "Client.getFlagDetail",
+      { value: false, reason: "CLIENT_NOT_READY" },
+      () => this.engine.getFlagDetail(name, this.attributes)
+    );
   }
   getConfig(name, decodeOrOpts) {
-    return this.engine.getConfig(name, decodeOrOpts);
+    return safeRun(
+      "Client.getConfig",
+      void 0,
+      () => this.engine.getConfig(name, decodeOrOpts)
+    );
   }
   getExperiment(name, defaultParams, decode) {
-    return this.engine.getExperiment(name, this.attributes, defaultParams, decode);
+    const notIn = { inExperiment: false, group: "control", params: defaultParams };
+    return safeRun(
+      "Client.getExperiment",
+      notIn,
+      () => this.engine.getExperiment(name, this.attributes, defaultParams, decode)
+    );
   }
   /** Read a killswitch (not user-bound; mirrors {@link Engine.getKillswitch}). */
   getKillswitch(name, switchKey) {
-    return this.engine.getKillswitch(name, switchKey);
+    return safeRun("Client.getKillswitch", false, () => this.engine.getKillswitch(name, switchKey));
+  }
+  /**
+   * 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, props) {
+    safeRun("Client.track", void 0, () => {
+      const id = this.attributes.user_id ?? this.attributes.anonymous_id;
+      if (id === void 0) return;
+      this.engine.track(String(id), eventName, props);
+    });
+  }
+  /**
+   * 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) {
+    safeRun("Client.logExposure", void 0, () => this.engine.logExposure(this.attributes, name));
   }
 };
 function dispatchSee(problem, consequence, extras, kind) {
   if (!_server) {
-    console.warn("[shipeasy] see() called before shipeasy({ serverKey }) \u2014 error dropped");
+    logger.warn("[shipeasy] see() called before shipeasy({ serverKey }) \u2014 error dropped");
     return;
   }
   _server.reportError(problem, consequence, extras, kind);
@@ -1354,10 +1523,14 @@ var see = Object.assign(
   Client,
   Engine,
   FLAG_REASONS,
+  LOG_LEVELS,
   _murmur3ForTests,
   _resetConfigureForTests,
   _resetShipeasyServerForTests,
+  clearOverrides,
   configure,
+  configureForOffline,
+  configureForTesting,
   configureShipeasyServer,
   createInMemoryStickyStore,
   fetchLabelsForSSR,
@@ -1367,6 +1540,10 @@ var see = Object.assign(
   getShipeasyServerClient,
   i18n,
   isExpected,
+  onChange,
+  overrideConfig,
+  overrideExperiment,
+  overrideFlag,
   see,
   seeContext,
   shipeasy,