@shipeasy/sdk 6.2.0 → 7.0.0

package/docs/skill/SKILL.md

@@ -1,6 +1,6 @@
 ---
 name: shipeasy-typescript
-description: Use Shipeasy (feature flags, configs, kill switches, A/B experiments, i18n) from TypeScript / JavaScript. Covers configure() + Client(user), getFlag/getConfig/getKillswitch/getExperiment, track, testing, OpenFeature, and the see() error reporter — server (@shipeasy/sdk/server) and browser (@shipeasy/sdk/client).
+description: Use Shipeasy (feature flags, configs, kill switches, A/B experiments, i18n) from TypeScript / JavaScript. Covers configure() + Client(user), getFlag/getConfig/getKillswitch/universe().assign(), track, testing, OpenFeature, and the see() error reporter — server (@shipeasy/sdk/server) and browser (@shipeasy/sdk/client).
 ---
 
 # Shipeasy TypeScript SDK
@@ -12,7 +12,7 @@ public **client** key). Everything works from vanilla JS.
 > The documented surface is exactly **`configure()`** (setup) and the bound
 > **`new Client(user)`** (use), plus the package-level helpers below. For deeper
 > docs, fetch any page/snippet from the manifest at
-> <https://shipeasy-ai.github.io/sdk/manifest.json> (raw page/snippet URLs below).
+> <https://shipeasy-ai.github.io/sdk-ts/manifest.json> (raw page/snippet URLs below).
 
 ## Install
 
@@ -42,28 +42,32 @@ flags.getFlagDetail("new_checkout");                   // { value, reason }
 `configure()` is first-config-wins and owns the fetch lifecycle (one-shot by
 default; `poll: true` for a background refresh). Construct `new Client(user)` once
 per user/request — it binds the user, so no method takes a user argument.
-Full reference: <https://shipeasy-ai.github.io/sdk/pages/configuration.md> ·
-<https://shipeasy-ai.github.io/sdk/pages/flags.md> ·
-snippets <https://shipeasy-ai.github.io/sdk/snippets/release/flags.md> ·
-<https://shipeasy-ai.github.io/sdk/snippets/release/configs.md> ·
-<https://shipeasy-ai.github.io/sdk/snippets/release/killswitches.md>
+Full reference: <https://shipeasy-ai.github.io/sdk-ts/pages/configuration.md> ·
+<https://shipeasy-ai.github.io/sdk-ts/pages/flags.md> ·
+snippets <https://shipeasy-ai.github.io/sdk-ts/snippets/release/flags.md> ·
+<https://shipeasy-ai.github.io/sdk-ts/snippets/release/configs.md> ·
+<https://shipeasy-ai.github.io/sdk-ts/snippets/release/killswitches.md>
 
 ## Experiments + track (Client-only, end to end)
 
 ```ts
 const flags = new Client(currentUser); // construct once per callsite
-const { inExperiment, group, params } = flags.getExperiment("hero_cta", {
-  primary_label: "Sign up", // default params (control / not-enrolled)
-});
-render(params.primary_label);
 
-flags.logExposure("hero_cta");          // record the exposure where you present it
+// Read experiments by UNIVERSE (a mutual-exclusion pool — the unit lands in ≤1
+// experiment). assign() auto-logs one deduped exposure when enrolled.
+const exp = flags.universe("hero_cta").assign();
+render(exp.get("primary_label", "Sign up")); // variant ?? universe default ?? fallback
+
+if (exp.enrolled) {
+  // exp.group is the variant, exp.name is the experiment
+}
 flags.track("purchase", { value: 42 }); // record a conversion for the bound user
 ```
 
-`ExperimentResult = { inExperiment: boolean; group: string; params: P }`. Full
-reference: <https://shipeasy-ai.github.io/sdk/pages/experiments.md> · track snippet
-<https://shipeasy-ai.github.io/sdk/snippets/metrics/track.md>
+`Assignment = { name: string | null; group: string | null; enrolled: boolean;
+get(field, fallback) }`. Full reference:
+<https://shipeasy-ai.github.io/sdk-ts/pages/experiments.md> · track snippet
+<https://shipeasy-ai.github.io/sdk-ts/snippets/metrics/track.md>
 
 ## i18n
 
@@ -76,9 +80,9 @@ i18n.t("checkout.cta", "Place order");
 i18n.t("cart.count", "{count} items", { count: cart.length });
 ```
 
-Full reference: <https://shipeasy-ai.github.io/sdk/pages/i18n.md> · snippets
-<https://shipeasy-ai.github.io/sdk/snippets/i18n/setup.md> ·
-<https://shipeasy-ai.github.io/sdk/snippets/i18n/render.md>
+Full reference: <https://shipeasy-ai.github.io/sdk-ts/pages/i18n.md> · snippets
+<https://shipeasy-ai.github.io/sdk-ts/snippets/i18n/setup.md> ·
+<https://shipeasy-ai.github.io/sdk-ts/snippets/i18n/render.md>
 
 ## Error reporting (see)
 
@@ -94,8 +98,8 @@ see.ControlFlowException(e).because("because it wasn't an encoded Foo"); // expe
 
 Fire-and-forget on the next microtask (no `.send()`). Don't catch what you can't
 name a consequence for. You may `see()` then re-throw (links as `caused_by`). Full
-reference: <https://shipeasy-ai.github.io/sdk/pages/error-reporting.md> · snippet
-<https://shipeasy-ai.github.io/sdk/snippets/ops/see.md>
+reference: <https://shipeasy-ai.github.io/sdk-ts/pages/error-reporting.md> · snippet
+<https://shipeasy-ai.github.io/sdk-ts/snippets/ops/see.md>
 
 ## Testing — no network
 
@@ -120,7 +124,7 @@ configureForOffline({ path: "./shipeasy-snapshot.json" });
 // or: configureForOffline({ snapshot: { flags, experiments }, flags: { new_checkout: true } });
 ```
 
-Full reference: <https://shipeasy-ai.github.io/sdk/pages/testing.md>
+Full reference: <https://shipeasy-ai.github.io/sdk-ts/pages/testing.md>
 
 ## OpenFeature
 
@@ -133,13 +137,13 @@ await OpenFeature.setProviderAndWait(new ShipeasyProvider());
 await OpenFeature.getClient().getBooleanValue("new_checkout", false, { targetingKey: "u1" });
 ```
 
-Full reference: <https://shipeasy-ai.github.io/sdk/pages/openfeature.md>
+Full reference: <https://shipeasy-ai.github.io/sdk-ts/pages/openfeature.md>
 
 ## Advanced
 
 `privateAttributes`, `bucketBy` (custom bucketing unit), `stickyBucketing`
-(browser: on by default, `__se_sticky` cookie), manual exposure
-(`getExperiment(..., { logExposure: false })` + `flags.logExposure(name)`),
+(browser: on by default, `__se_sticky` cookie), exposure control (browser:
+`universe(name).assign({ logExposure: false })` + `disableAutoExposure`),
 `onChange(cb)` (requires `configure({ poll: true })`) / browser `subscribe()`.
 Devtools overlay: `Shift+Alt+S` or `?se=1`. Full reference:
-<https://shipeasy-ai.github.io/sdk/pages/advanced.md>
+<https://shipeasy-ai.github.io/sdk-ts/pages/advanced.md>

package/package.json

@@ -1,19 +1,20 @@
 {
   "name": "@shipeasy/sdk",
-  "version": "6.2.0",
+  "version": "7.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",
   "repository": {
     "type": "git",
-    "url": "https://github.com/shipeasy-ai/sdk.git"
+    "url": "https://github.com/shipeasy-ai/sdk-ts.git"
   },
   "bugs": {
-    "url": "https://github.com/shipeasy-ai/sdk/issues"
+    "url": "https://github.com/shipeasy-ai/sdk-ts/issues"
   },
   "main": "./dist/server/index.js",
   "module": "./dist/server/index.mjs",
   "browser": "./dist/client/index.js",
+  "react-native": "./dist/client/index.js",
   "typesVersions": {
     "*": {
       "client": [
@@ -29,6 +30,7 @@
   },
   "exports": {
     ".": {
+      "react-native": "./dist/client/index.js",
       "node": "./dist/server/index.js",
       "browser": "./dist/client/index.js",
       "default": "./dist/server/index.js"
@@ -105,11 +107,12 @@
     "@openfeature/server-sdk": "^1.22.0",
     "@openfeature/web-sdk": "^1.9.0",
     "@types/murmurhash-js": "^1.0.6",
-    "@types/node": "^20.0.0",
+    "@types/node": "^26.0.1",
     "next": "^16.2.3",
     "tsup": "^8.3.0",
-    "typescript": "^5.7.4",
-    "vitest": "^2.1.0",
+    "typescript": "^6.0.3",
+    "vite": "^6.4.3",
+    "vitest": "^4.1.9",
     "wrangler": "^4.83.0"
   },
   "publishConfig": {