@shipeasy/sdk 2.5.1 → 2.5.2

package/dist/server/index.d.mts

@@ -132,14 +132,18 @@ declare function getShipeasyServerClient(): FlagsClient | null;
 declare function _resetShipeasyServerForTests(): void;
 interface ShipeasyServerConfig {
     /**
-     * Server-side API key — authenticates flag/experiment fetches from the edge.
-     * Never embedded in browser output. A warning is logged if omitted.
+     * Server-side API key — authenticates flag/experiment fetches from the edge
+     * (requireKey("server")). Never embedded in browser output. If omitted, flag
+     * and experiment evaluation is skipped and an error is logged — it is NOT
+     * substituted with clientKey (a client key 401s against /sdk/flags).
      */
     apiKey?: string;
     /**
      * Public client key — embedded in window.__SE_BOOTSTRAP and used by the
-     * browser SDK. Safe to expose (e.g. NEXT_PUBLIC_ env vars).
-     * Defaults to apiKey for single-key setups.
+     * browser SDK, and authenticates i18n string fetches (requireKey("client")).
+     * Safe to expose (e.g. NEXT_PUBLIC_ env vars). If omitted, i18n loading is
+     * skipped and an error is logged — it is NOT substituted with apiKey (a
+     * server key 401s against /sdk/i18n/strings).
      */
     clientKey?: string;
     /** Raw URL or query string for applying ?se_ks_* / ?se_cf_* / ?se_exp_* overrides. */

package/dist/server/index.d.ts

@@ -132,14 +132,18 @@ declare function getShipeasyServerClient(): FlagsClient | null;
 declare function _resetShipeasyServerForTests(): void;
 interface ShipeasyServerConfig {
     /**
-     * Server-side API key — authenticates flag/experiment fetches from the edge.
-     * Never embedded in browser output. A warning is logged if omitted.
+     * Server-side API key — authenticates flag/experiment fetches from the edge
+     * (requireKey("server")). Never embedded in browser output. If omitted, flag
+     * and experiment evaluation is skipped and an error is logged — it is NOT
+     * substituted with clientKey (a client key 401s against /sdk/flags).
      */
     apiKey?: string;
     /**
      * Public client key — embedded in window.__SE_BOOTSTRAP and used by the
-     * browser SDK. Safe to expose (e.g. NEXT_PUBLIC_ env vars).
-     * Defaults to apiKey for single-key setups.
+     * browser SDK, and authenticates i18n string fetches (requireKey("client")).
+     * Safe to expose (e.g. NEXT_PUBLIC_ env vars). If omitted, i18n loading is
+     * skipped and an error is logged — it is NOT substituted with apiKey (a
+     * server key 401s against /sdk/i18n/strings).
      */
     clientKey?: string;
     /** Raw URL or query string for applying ?se_ks_* / ?se_cf_* / ?se_exp_* overrides. */

package/dist/server/index.js

@@ -500,14 +500,19 @@ function _resetShipeasyServerForTests() {
   _server = null;
 }
 async function shipeasy(opts) {
-  if (!opts.apiKey && !opts.clientKey) {
-    console.warn("[shipeasy] apiKey is required \u2014 flag evaluation and i18n will not load.");
-  } else if (!opts.apiKey) {
-    console.warn("[shipeasy] apiKey not set \u2014 falling back to clientKey for server requests.");
-  }
-  const apiKey = opts.apiKey ?? opts.clientKey ?? "";
-  const clientKey = opts.clientKey ?? _rememberedClientKey ?? opts.apiKey ?? "";
+  const apiKey = opts.apiKey ?? "";
+  const clientKey = opts.clientKey ?? _rememberedClientKey ?? "";
   if (opts.clientKey && !_rememberedClientKey) _rememberedClientKey = opts.clientKey;
+  if (!apiKey) {
+    console.error(
+      "[shipeasy] No server key \u2014 flags & experiments skipped. Pass `apiKey` to shipeasy() 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 /sdk/flags requires a server key and will 401."
+    );
+  }
+  if (!clientKey) {
+    console.error(
+      "[shipeasy] No client key \u2014 i18n strings skipped, falling back to hardcoded text. Pass `clientKey` to shipeasy() with your public client key (NEXT_PUBLIC_SHIPEASY_CLIENT_KEY). Do not pass a server key here \u2014 /sdk/i18n/strings requires a client key and will 401."
+    );
+  }
   const profile = opts.i18nDefaultProfile ?? "en:prod";
   flags.configure({ apiKey });
   let resolvedUrlOverrides = opts.urlOverrides;
@@ -529,7 +534,10 @@ async function shipeasy(opts) {
   }
   const editLabels = resolvedUrlOverrides ? new URLSearchParams(resolvedUrlOverrides).has("se_edit_labels") : false;
   globalThis[_EDIT_MODE_SSR_SYM] = editLabels;
-  await Promise.allSettled([flags.initOnce(), i18n.init(clientKey, profile)]);
+  await Promise.allSettled([
+    apiKey ? flags.initOnce() : Promise.resolve(),
+    clientKey ? i18n.init(clientKey, profile) : Promise.resolve()
+  ]);
   const bootstrap = flags.evaluate(opts.user ?? {}, resolvedUrlOverrides);
   const i18nData = i18n.getForRequest();
   return {

package/dist/server/index.mjs

@@ -457,14 +457,19 @@ function _resetShipeasyServerForTests() {
   _server = null;
 }
 async function shipeasy(opts) {
-  if (!opts.apiKey && !opts.clientKey) {
-    console.warn("[shipeasy] apiKey is required \u2014 flag evaluation and i18n will not load.");
-  } else if (!opts.apiKey) {
-    console.warn("[shipeasy] apiKey not set \u2014 falling back to clientKey for server requests.");
-  }
-  const apiKey = opts.apiKey ?? opts.clientKey ?? "";
-  const clientKey = opts.clientKey ?? _rememberedClientKey ?? opts.apiKey ?? "";
+  const apiKey = opts.apiKey ?? "";
+  const clientKey = opts.clientKey ?? _rememberedClientKey ?? "";
   if (opts.clientKey && !_rememberedClientKey) _rememberedClientKey = opts.clientKey;
+  if (!apiKey) {
+    console.error(
+      "[shipeasy] No server key \u2014 flags & experiments skipped. Pass `apiKey` to shipeasy() 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 /sdk/flags requires a server key and will 401."
+    );
+  }
+  if (!clientKey) {
+    console.error(
+      "[shipeasy] No client key \u2014 i18n strings skipped, falling back to hardcoded text. Pass `clientKey` to shipeasy() with your public client key (NEXT_PUBLIC_SHIPEASY_CLIENT_KEY). Do not pass a server key here \u2014 /sdk/i18n/strings requires a client key and will 401."
+    );
+  }
   const profile = opts.i18nDefaultProfile ?? "en:prod";
   flags.configure({ apiKey });
   let resolvedUrlOverrides = opts.urlOverrides;
@@ -486,7 +491,10 @@ async function shipeasy(opts) {
   }
   const editLabels = resolvedUrlOverrides ? new URLSearchParams(resolvedUrlOverrides).has("se_edit_labels") : false;
   globalThis[_EDIT_MODE_SSR_SYM] = editLabels;
-  await Promise.allSettled([flags.initOnce(), i18n.init(clientKey, profile)]);
+  await Promise.allSettled([
+    apiKey ? flags.initOnce() : Promise.resolve(),
+    clientKey ? i18n.init(clientKey, profile) : Promise.resolve()
+  ]);
   const bootstrap = flags.evaluate(opts.user ?? {}, resolvedUrlOverrides);
   const i18nData = i18n.getForRequest();
   return {

package/package.json

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