@shipeasy/sdk 5.3.0 → 6.0.0

package/dist/server/index.mjs

@@ -499,7 +499,7 @@ function parseOverrides(rawUrl) {
   }
   return { gates, configs, experiments };
 }
-var FlagsClient = class _FlagsClient {
+var Engine = class _Engine {
   apiKey;
   baseUrl;
   env;
@@ -514,7 +514,7 @@ var FlagsClient = class _FlagsClient {
   pollInterval = 30;
   timer = null;
   initialized = false;
-  // Test mode: built by `FlagsClient.forTesting()`. When set, init()/initOnce()
+  // Test mode: built by `Engine.forTesting()`. When set, init()/initOnce()
   // never fetch, track() is a no-op, and telemetry is off — the client is a
   // fully self-contained, network-free seam for unit tests.
   testMode;
@@ -555,13 +555,13 @@ var FlagsClient = class _FlagsClient {
    * with overrideFlag/overrideConfig/overrideExperiment. No SDK key required.
    *
    * ```ts
-   * const client = FlagsClient.forTesting();
+   * const client = Engine.forTesting();
    * client.overrideFlag("new_checkout", true);
    * client.getFlag("new_checkout", { user_id: "u1" }); // true
    * ```
    */
   static forTesting(opts) {
-    return new _FlagsClient({ apiKey: "", ...opts, testMode: true });
+    return new _Engine({ apiKey: "", ...opts, testMode: true });
   }
   /**
    * Build a fully OFFLINE client from a pre-captured snapshot — no network ever.
@@ -574,7 +574,7 @@ var FlagsClient = class _FlagsClient {
    * `{ flags: <GET /sdk/flags body>, experiments: <GET /sdk/experiments body> }`.
    */
   static fromSnapshot(snapshot) {
-    const client = new _FlagsClient({ apiKey: "", testMode: true });
+    const client = new _Engine({ apiKey: "", testMode: true });
     client.flagsBlob = snapshot.flags;
     client.expsBlob = snapshot.experiments;
     client.initialized = true;
@@ -584,13 +584,13 @@ var FlagsClient = class _FlagsClient {
    * Build a fully OFFLINE client from a snapshot JSON file on disk (Node only —
    * not available in the browser entrypoint). The file must contain
    * `{ "flags": <GET /sdk/flags body>, "experiments": <GET /sdk/experiments body> }`.
-   * See {@link FlagsClient.fromSnapshot}.
+   * See {@link Engine.fromSnapshot}.
    */
   static fromFile(path) {
     const fs = __require("fs");
     const raw = fs.readFileSync(path, "utf8");
     const snapshot = JSON.parse(raw);
-    return _FlagsClient.fromSnapshot(snapshot);
+    return _Engine.fromSnapshot(snapshot);
   }
   async init() {
     if (this.testMode) {
@@ -1050,7 +1050,7 @@ async function fetchLabelsForSSR(opts) {
 var _server = null;
 function configureShipeasyServer(opts) {
   if (_server) return _server;
-  _server = new FlagsClient(opts);
+  _server = new Engine(opts);
   return _server;
 }
 function getShipeasyServerClient() {
@@ -1118,46 +1118,62 @@ async function shipeasy(opts) {
     flags: bootstrap.flags,
     configs: bootstrap.configs,
     experiments: bootstrap.experiments,
-    getBootstrapHtml() {
-      return getBootstrapHtml(bootstrap, i18nData, {
-        editLabels,
+    getBootstrapData(emit) {
+      return getBootstrapData(bootstrap, i18nData, {
         i18nProfile: profile,
-        anonId
+        anonId,
+        ...emit
+      });
+    },
+    getBootstrapTags(emit) {
+      return getBootstrapTags(bootstrap, i18nData, {
+        i18nProfile: profile,
+        anonId,
+        ...emit
       });
     }
   };
 }
-function getBootstrapHtml(bootstrap, i18nData, opts) {
-  const parts = [];
-  const apiUrl = "https://cdn.shipeasy.ai";
+var DEFAULT_CDN = "https://cdn.shipeasy.ai";
+function getBootstrapData(bootstrap, i18nData, opts) {
+  const base = (opts.baseUrl ?? DEFAULT_CDN).replace(/\/$/, "");
   const profile = opts.i18nProfile ?? "en:prod";
-  const payload = {
-    flags: bootstrap?.flags ?? {},
-    configs: bootstrap?.configs ?? {},
-    experiments: bootstrap?.experiments ?? {},
-    // No key here — the server only knows the server key, which must never reach
-    // the browser. The client supplies its own client key via shipeasy({ clientKey }).
-    i18nProfile: profile,
-    apiUrl
+  const attrs = {
+    "data-se-bootstrap": "",
+    "data-flags": JSON.stringify(bootstrap?.flags ?? {}),
+    "data-configs": JSON.stringify(bootstrap?.configs ?? {}),
+    "data-experiments": JSON.stringify(bootstrap?.experiments ?? {}),
+    "data-killswitches": JSON.stringify(bootstrap?.killswitches ?? {}),
+    "data-i18n-profile": profile,
+    "data-api-url": base
   };
-  if (i18nData) payload.i18n = i18nData;
-  if (opts.editLabels) payload.editLabels = true;
-  if (opts.anonId) payload.anonId = opts.anonId;
-  parts.push(
-    `(function(){var Q=new URLSearchParams(location.search).has('se_edit_labels');var C=/(?:^|;\\s*)se_edit_labels=1(?:;|$)/.test(document.cookie);if(!Q&&!C)return;if(Q){try{document.cookie='se_edit_labels=1;path=/;max-age=86400;samesite=lax';}catch(_){}}var R;function P(v){if(!v||typeof v.t!=='function'||v.__sePatched)return;var O=v.t.bind(v);v.__sePatched=true;window._sei18n_t=O;v.t=function(k,vars){var r=O(k,vars);if(r===k)return k;var V='';try{if(vars&&typeof vars==='object'){var hasKey=false;for(var _k in vars){hasKey=true;break;}if(hasKey)V=JSON.stringify(vars);}}catch(_){V='';}return '\\uFFF9'+k+'\\uFFFA'+V+'\\uFFFA'+r+'\\uFFFB';};}Object.defineProperty(window,'i18n',{configurable:true,get:function(){return R;},set:function(v){P(v);R=v;}});})();`
-  );
-  parts.push(`window.__SE_BOOTSTRAP=${JSON.stringify(payload)};`);
-  if (opts.anonId) {
-    parts.push(
-      `(function(){try{var k=${JSON.stringify(ANON_ID_COOKIE)},v=${JSON.stringify(opts.anonId)};if(('; '+document.cookie).indexOf('; '+k+'=')===-1){document.cookie=k+'='+v+';path=/;max-age=31536000;samesite=lax'+(location.protocol==='https:'?';secure':'');}}catch(_){}})();`
-    );
-  }
-  if (i18nData?.strings && Object.keys(i18nData.strings).length > 0) {
-    parts.push(
-      `(function(){var d=window.__SE_BOOTSTRAP.i18n;if(!d)return;window.i18n={locale:d.locale,t:function(k,v){var r=d.strings[k];if(!r)return k;return v?r.replace(/\\{\\{(\\w+)\\}\\}/g,function(_,p){return v[p]!==undefined?String(v[p]):'{{'+p+'}}'}):r;},on:function(){return function(){};}};})();`
-    );
+  if (opts.anonId) attrs["data-anon-id"] = opts.anonId;
+  const bootstrapTag = { src: `${base}/sdk/bootstrap.js`, attrs };
+  let i18nLoader = null;
+  const hasStrings = !!(i18nData?.strings && Object.keys(i18nData.strings).length > 0);
+  if (hasStrings || opts.clientKey) {
+    const i18nAttrs = { "data-profile": profile };
+    if (opts.clientKey) i18nAttrs["data-key"] = opts.clientKey;
+    if (hasStrings) {
+      i18nAttrs["data-strings"] = JSON.stringify(i18nData.strings);
+      i18nAttrs["data-locale"] = i18nData.locale;
+    }
+    i18nLoader = { src: `${base}/sdk/i18n/loader.js`, attrs: i18nAttrs };
   }
-  return parts.join("");
+  return { bootstrap: bootstrapTag, i18nLoader };
+}
+function escapeAttr(v) {
+  return v.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
+}
+function renderScriptTag(spec) {
+  const attrs = Object.entries(spec.attrs).map(([k, v]) => v === "" ? ` ${k}` : ` ${k}="${escapeAttr(v)}"`).join("");
+  return `<script src="${escapeAttr(spec.src)}"${attrs}></script>`;
+}
+function getBootstrapTags(bootstrap, i18nData, opts) {
+  const data = getBootstrapData(bootstrap, i18nData, opts);
+  const tags = [data.bootstrap];
+  if (data.i18nLoader) tags.push(data.i18nLoader);
+  return tags.map(renderScriptTag).join("");
 }
 var flags = {
   configure(opts) {
@@ -1209,7 +1225,7 @@ var flags = {
     _server?.track(userId, eventName, props);
   },
   /** Emit an exposure for an enrolled experiment at the decision point. See
-   *  {@link FlagsClient.logExposure}. No-op before configure(). */
+   *  {@link Engine.logExposure}. No-op before configure(). */
   logExposure(user, name) {
     _server?.logExposure(user, name);
   },
@@ -1227,6 +1243,50 @@ var flags = {
     };
   }
 };
+var _identityAttributes = (user) => user && typeof user === "object" ? user : {};
+var _attributes = _identityAttributes;
+function configure(opts) {
+  const { attributes, ...engineOpts } = opts;
+  _attributes = attributes ?? _identityAttributes;
+  const engine = configureShipeasyServer(engineOpts);
+  void engine.initOnce().catch(() => {
+  });
+  return engine;
+}
+function _resetConfigureForTests() {
+  _attributes = _identityAttributes;
+}
+var Client = class {
+  engine;
+  /** The resolved attribute bag this handle evaluates against. */
+  attributes;
+  constructor(user) {
+    const engine = getShipeasyServerClient();
+    if (!engine) {
+      throw new Error(
+        "[shipeasy] new Client(user) called before configure({ apiKey }). Call configure() once at app boot from @shipeasy/sdk/server."
+      );
+    }
+    this.engine = engine;
+    this.attributes = _attributes(user);
+  }
+  getFlag(name, defaultValue = false) {
+    return this.engine.getFlag(name, this.attributes, defaultValue);
+  }
+  getFlagDetail(name) {
+    return this.engine.getFlagDetail(name, this.attributes);
+  }
+  getConfig(name, decodeOrOpts) {
+    return this.engine.getConfig(name, decodeOrOpts);
+  }
+  getExperiment(name, defaultParams, decode) {
+    return 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);
+  }
+};
 function dispatchSee(problem, consequence, extras, kind) {
   if (!_server) {
     console.warn("[shipeasy] see() called before shipeasy({ serverKey }) \u2014 error dropped");
@@ -1243,15 +1303,19 @@ var see = Object.assign(
 );
 export {
   ANON_ID_COOKIE,
+  Client,
+  Engine,
   FLAG_REASONS,
-  FlagsClient,
   _murmur3ForTests,
+  _resetConfigureForTests,
   _resetShipeasyServerForTests,
+  configure,
   configureShipeasyServer,
   createInMemoryStickyStore,
   fetchLabelsForSSR,
   flags,
-  getBootstrapHtml,
+  getBootstrapData,
+  getBootstrapTags,
   getShipeasyServerClient,
   i18n,
   isExpected,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipeasy/sdk",
-  "version": "5.3.0",
+  "version": "6.0.0",
   "description": "Shipeasy SDK — feature gates, runtime configs, experiments, and metrics for the Shipeasy hosted service.",
   "license": "SEE LICENSE IN LICENSE",
   "homepage": "https://shipeasy.ai",