@avsbhq/node 1.5.0 → 1.6.1

package/README.md

@@ -55,7 +55,7 @@ Get the SDK key for the environment you want to target from your A vs B project'
 AVSB_SDK_KEY=sdk_production_...
 ```
 
-When used server-side, the SDK key only ever needs to leave the server to hit the datafile CDN — it should never end up in client-rendered HTML, browser bundles, or browser-accessible config. Store it in environment variables only.
+When used server-side, the SDK key only ever needs to leave the server to hit the datafile CDN; it should never end up in client-rendered HTML, browser bundles, or browser-accessible config. Store it in environment variables only.
 
 Server SDK keys cannot be rotated without a process restart; the new key must be set in the environment before the server boots (or trigger a rolling restart in your orchestrator).
 
@@ -63,7 +63,7 @@ Server SDK keys cannot be rotated without a process restart; the new key must be
 
 ## 4. Identity
 
-The server SDK is stateless per request — it does not hold a persistent context. Pass the user context on each call using `forUser()` or as a `context` option on individual calls.
+The server SDK is stateless per request; it does not hold a persistent context. Pass the user context on each call using `forUser()` or as a `context` option on individual calls.
 
 ### `forUser(context)` / `createUserContext(context)`
 
@@ -106,7 +106,7 @@ const flag = server.getBoolFlag('big-cart-banner', false, {
     viewedSkus: ['SKU-1', 'SKU-2'], // for "products viewed" matching on SKU
     viewedCategories: ['trainers'], // for "products viewed" matching on category
     purchaseHistory: {
-      // PurchaseHistoryAttribute — exported for your own declarations
+      // PurchaseHistoryAttribute, exported for your own declarations
       hasPurchased: true,
       lastPurchaseAt: 1765500000000, // epoch milliseconds (optional)
       lifetimeSpend: 540.0, // decimal MAJOR units (optional)
@@ -118,9 +118,9 @@ const flag = server.getBoolFlag('big-cart-banner', false, {
 
 Server-side semantics to be aware of:
 
-- **All money is decimal major units.** Condition values are stored in minor units and converted using the project currency exponent from the datafile (default 2) — you never pass minor units.
-- **Missing or mistyped attributes evaluate the condition to `false`.** A completely absent `purchaseHistory` makes ALL purchase-history operators false — including `has_not_purchased`. On the server, absence means "not provided", not "never purchased" (this deliberately diverges from the browser snippet, where a profile miss is authoritative).
-- **Dataset-backed "products viewed" conditions evaluate `false` on the server.** Dataset view windows live in the browser; server callers use literal SKU/category lists. The session/30-day window distinction is also browser-only — supply whatever view list you consider current.
+- **All money is decimal major units.** Condition values are stored in minor units and converted using the project currency exponent from the datafile (default 2); you never pass minor units.
+- **Missing or mistyped attributes evaluate the condition to `false`.** A completely absent `purchaseHistory` makes ALL purchase-history operators false, including `has_not_purchased`. On the server, absence means "not provided", not "never purchased" (this deliberately diverges from the browser snippet, where a profile miss is authoritative).
+- **Dataset-backed "products viewed" conditions evaluate `false` on the server.** Dataset view windows live in the browser; server callers use literal SKU/category lists. The session/30-day window distinction is also browser-only; supply whatever view list you consider current.
 
 ### `alias(previousContext, newContext)`
 
@@ -135,7 +135,7 @@ await server.alias(
 
 ### Sharing identity with the web snippet
 
-To measure one metric across both the A vs B web snippet and this SDK (the setup behind cross-project metrics), the context `key` must equal the browser snippet's visitor id — the `_avsb_visitor` cookie UUID returned by `avsb.getVisitorId()`. Results join on raw id equality, so a different key means the two surfaces never line up. Forward the snippet id from the browser and use it as the key here, or link an internal account id to it with `alias()`. Full guide: [Shared Visitor Identity](https://avsb.cloud/docs/developer-reference/shared-visitor-identity).
+To measure one metric across both the A vs B web snippet and this SDK (the setup behind cross-project metrics), the context `key` must equal the browser snippet's visitor id: the `_avsb_visitor` cookie UUID returned by `avsb.getVisitorId()`. Results join on raw id equality, so a different key means the two surfaces never line up. Forward the snippet id from the browser and use it as the key here, or link an internal account id to it with `alias()`. Full guide: [Shared Visitor Identity](https://avsb.cloud/docs/developer-reference/shared-visitor-identity).
 
 ---
 
@@ -180,13 +180,13 @@ const flag = server.getFlag<boolean>('checkout-v2', false, {
 ### The `Flag<T>` object
 
 ```ts
-flag.value          // T — the variation value
+flag.value          // T, the variation value
 flag.isEnabled()    // true if source === 'rule' && value is truthy
 flag.variationKey   // 'on' | 'off' | 'control' | null (null = default served)
 flag.exists()       // false when source === 'not_found'
 flag.source         // 'rule' | 'sticky' | 'holdout' | 'datafileOverride' | 'default' | ...
 flag.ruleId         // which rule matched
-flag.reasons        // string[] — evaluation path
+flag.reasons        // string[], evaluation path
 ```
 
 ### `getAllFlags(context, options?)`
@@ -275,7 +275,7 @@ if (!result.success && !result.degraded) {
 }
 ```
 
-`onReady()` never rejects — it always resolves. Check `result.success` to decide whether to proceed.
+`onReady()` never rejects; it always resolves. Check `result.success` to decide whether to proceed.
 
 ### Event bus
 
@@ -382,7 +382,7 @@ app.get('/checkout', (req, res) => {
 })
 ```
 
-`expressMiddleware` decorates each request with `req.avsb` — a `UserBoundClient` scoped to the context returned by `contextFrom`. It also opens an `AsyncLocalStorage` scope so `getRequestClient()` from `@avsbhq/utils` works anywhere in the call chain.
+`expressMiddleware` decorates each request with `req.avsb`: a `UserBoundClient` scoped to the context returned by `contextFrom`. It also opens an `AsyncLocalStorage` scope so `getRequestClient()` from `@avsbhq/utils` works anywhere in the call chain.
 
 ### Fastify
 
@@ -443,7 +443,7 @@ DynamoDB and PostgreSQL adapters are available in `@avsbhq/utils`.
 
 ### Real-time streaming
 
-Enable SSE streaming to receive datafile updates the instant a flag changes — no polling delay:
+Enable SSE streaming to receive datafile updates the instant a flag changes, with no polling delay:
 
 ```ts
 const server = new AvsbServer({
@@ -480,7 +480,7 @@ const entries = user.getDecisionLog().entries
 | `client.variation('key', context, default)` | `server.forUser(ctx).getBoolFlag('key', default).value` |
 | `client.variationDetail('key', context, default)` | `server.forUser(ctx).getFlag('key', default)` |
 | `client.track('event', context, { metricValue })` | `server.forUser(ctx).track('event', { value })` |
-| `client.identify(context)` | not applicable — server is stateless; use `forUser(ctx)` |
+| `client.identify(context)` | not applicable (server is stateless); use `forUser(ctx)` |
 | `client.allFlagsState(context)` | `server.getAllFlags(ctx)` |
 | `client.close()` | `await server.close()` |
 
@@ -488,7 +488,7 @@ Key differences:
 - `getFlag` returns `Flag<T>` not a raw value. Access `.value` for the primitive.
 - `track` uses `value` (not `metricValue`) for the numeric metric.
 - The server is context-free at construction; all evaluation is per-request via `forUser()`.
-- Multi-context is native — no `ldUser` adapter needed.
+- Multi-context is native, with no `ldUser` adapter needed.
 
 ### From Statsig Node
 

package/dist/index.cjs

@@ -50,7 +50,7 @@ function createDatasetsClient(options) {
   const requestTimeout = options.requestTimeout ?? DEFAULT_REQUEST_TIMEOUT;
   async function get(slug, key) {
     if (!slug || !key) {
-      logger.warn("datasets.get called with an empty slug or key \u2014 returning not found");
+      logger.warn("datasets.get called with an empty slug or key; returning not found");
       return miss(slug, null);
     }
     const datafile = getDatafile();
@@ -60,11 +60,11 @@ function createDatasetsClient(options) {
     }
     const dataset = datafile.datasets?.find((d) => d.slug === slug);
     if (!dataset) {
-      logger.debug(`Dataset "${slug}" not present in datafile \u2014 returning not found`);
+      logger.debug(`Dataset "${slug}" not present in datafile; returning not found`);
       return miss(slug, null);
     }
     if (!dataset.liveVersion) {
-      logger.debug(`Dataset "${slug}" has no live version \u2014 returning not found`);
+      logger.debug(`Dataset "${slug}" has no live version; returning not found`);
       return miss(slug, null);
     }
     const base = datafile.collectEndpoint.replace(/\/+$/, "");
@@ -172,7 +172,7 @@ function createRecsClient(options) {
     try {
       const recipeHandle = typeof req?.recipe === "string" ? req.recipe : "";
       if (recipeHandle === "") {
-        logger.warn("recs.get called with an empty recipe \u2014 returning served:false");
+        logger.warn("recs.get called with an empty recipe; returning served:false");
         return miss2("", false);
       }
       const datafile = getDatafile();
@@ -183,7 +183,7 @@ function createRecsClient(options) {
       const recipes = datafile.recipes;
       const entry = recipes?.find((r) => r.recipe === recipeHandle) ?? null;
       if (!entry) {
-        logger.debug(`Recipe "${recipeHandle}" not present in datafile \u2014 returning served:false`);
+        logger.debug(`Recipe "${recipeHandle}" not present in datafile; returning served:false`);
         return miss2(recipeHandle, false);
       }
       const seeds = resolveSeeds(req.context);
@@ -260,11 +260,11 @@ function createRecsClient(options) {
   }
   function trackClick(productId, opts) {
     if (typeof productId !== "string" || productId === "") {
-      logger.warn("recs.trackClick called with an empty productId \u2014 dropped");
+      logger.warn("recs.trackClick called with an empty productId; dropped");
       return;
     }
     if (!opts || !opts.visitorId || !opts.experimentId || !opts.variationId) {
-      logger.warn("recs.trackClick requires visitorId/experimentId/variationId \u2014 dropped");
+      logger.warn("recs.trackClick requires visitorId/experimentId/variationId; dropped");
       return;
     }
     const tracker = getTracker();
@@ -637,7 +637,7 @@ var AvsbServer = class {
   readyPromise = null;
   pendingEvents = [];
   /**
-   * §6 — `client.utils.*` surface. Constructed lazily on first access so
+   * §6: `client.utils.*` surface. Constructed lazily on first access so
    * the utils package is only imported when actually consumed.
    *
    * The server's event surface (`ServerEventMap`) is a subset of the
@@ -670,7 +670,7 @@ var AvsbServer = class {
    * Server-side datasets read surface (e-commerce suite Phase 2).
    * Constructed lazily on first access, mirroring the `utils` getter.
    * `client.datasets.get(slug, key)` resolves the live version from the
-   * current datafile and never throws — see ./datasets.ts.
+   * current datafile and never throws; see ./datasets.ts.
    */
   _datasets = null;
   get datasets() {
@@ -824,7 +824,7 @@ var AvsbServer = class {
     const decisionLog = options?.decisionLog;
     if (!context) {
       this.logger.warn(
-        `getFlag called without context for flagKey="${flagKey}" \u2014 returning default`
+        `getFlag called without context for flagKey="${flagKey}"; returning default`
       );
       return (0, import_core2.notFoundFlag)(defaultValue, "no context provided");
     }
@@ -1086,7 +1086,7 @@ var AvsbServer = class {
     const mismatch = (0, import_core2.checkExpectedType)(datafileFlag, expectedType, flag.value);
     if (mismatch) {
       this.logger.warn(
-        `Type mismatch on flag "${flagKey}": ${mismatch} \u2014 returning default`
+        `Type mismatch on flag "${flagKey}": ${mismatch}; returning default`
       );
       return (0, import_core2.notFoundFlag)(defaultValue, mismatch);
     }

package/dist/index.d.cts

@@ -66,7 +66,7 @@ interface MiddlewareConfig {
 /**
  * Purchase order shape for server-side purchase tracking.
  * Mirrors the client-side snippet PurchaseOrder interface.
- * Decimal values are forwarded as-is — no server-side currency conversion.
+ * Decimal values are forwarded as-is; no server-side currency conversion.
  */
 interface PurchaseOrder {
     /** Required. Unique order/transaction identifier. */
@@ -80,6 +80,10 @@ interface PurchaseOrder {
     tax?: number;
     discount?: number;
     coupon?: string;
+    /** Mark this as a test purchase. Test orders are stored but excluded from all
+     *  revenue, profit, recommendation, and audience calculations. Only send when
+     *  intentionally testing your integration. */
+    test?: boolean;
     items?: Array<{
         sku: string;
         /**
@@ -145,7 +149,7 @@ interface DatasetsClient {
  * key field simply carries the SDK key.
  *
  * Attribution is OPT-IN server-side: `get()` fires a `rec:impression` (via
- * the server tracker) only when the caller passes `attribution` — a server
+ * the server tracker) only when the caller passes `attribution`; a server
  * has no ambient variation context the way a browser harness does.
  *
  * Error posture matches datasets/flag evaluation: this client NEVER throws.
@@ -198,7 +202,7 @@ interface RecsClient {
     get(req: RecsGetRequest): Promise<RecsResult>;
     /**
      * Queue a rec:click for a product the shopper clicked. Pass `recipe` when
-     * known — results group click-through by (variation, recipe).
+     * known: results group click-through by (variation, recipe).
      */
     trackClick(productId: string, opts: RecsAttribution & {
         position?: number;
@@ -207,7 +211,7 @@ interface RecsClient {
 }
 /**
  * One entry of the datafile recipe registry (contract C3). Additive on
- * FlagDatafile — SDKs on older datafiles see it absent.
+ * FlagDatafile; SDKs on older datafiles see it absent.
  */
 interface DatafileRecipe {
     recipe: string;
@@ -227,7 +231,7 @@ interface DatafileRecipe {
  * alias. All flag evaluations and track calls use the bound context.
  *
  * Forced decisions set on a UserBoundClient survive only for the lifetime
- * of the instance — they do not affect the shared AvsbServer override state.
+ * of the instance; they do not affect the shared AvsbServer override state.
  * This makes them safe for test middleware and per-request debugging.
  *
  * Spec §5.8.
@@ -291,7 +295,7 @@ declare class AvsbServer {
     private readyPromise;
     private pendingEvents;
     /**
-     * §6 — `client.utils.*` surface. Constructed lazily on first access so
+     * §6: `client.utils.*` surface. Constructed lazily on first access so
      * the utils package is only imported when actually consumed.
      *
      * The server's event surface (`ServerEventMap`) is a subset of the
@@ -305,7 +309,7 @@ declare class AvsbServer {
      * Server-side datasets read surface (e-commerce suite Phase 2).
      * Constructed lazily on first access, mirroring the `utils` getter.
      * `client.datasets.get(slug, key)` resolves the live version from the
-     * current datafile and never throws — see ./datasets.ts.
+     * current datafile and never throws; see ./datasets.ts.
      */
     private _datasets;
     get datasets(): DatasetsClient;

package/dist/index.d.ts

@@ -66,7 +66,7 @@ interface MiddlewareConfig {
 /**
  * Purchase order shape for server-side purchase tracking.
  * Mirrors the client-side snippet PurchaseOrder interface.
- * Decimal values are forwarded as-is — no server-side currency conversion.
+ * Decimal values are forwarded as-is; no server-side currency conversion.
  */
 interface PurchaseOrder {
     /** Required. Unique order/transaction identifier. */
@@ -80,6 +80,10 @@ interface PurchaseOrder {
     tax?: number;
     discount?: number;
     coupon?: string;
+    /** Mark this as a test purchase. Test orders are stored but excluded from all
+     *  revenue, profit, recommendation, and audience calculations. Only send when
+     *  intentionally testing your integration. */
+    test?: boolean;
     items?: Array<{
         sku: string;
         /**
@@ -145,7 +149,7 @@ interface DatasetsClient {
  * key field simply carries the SDK key.
  *
  * Attribution is OPT-IN server-side: `get()` fires a `rec:impression` (via
- * the server tracker) only when the caller passes `attribution` — a server
+ * the server tracker) only when the caller passes `attribution`; a server
  * has no ambient variation context the way a browser harness does.
  *
  * Error posture matches datasets/flag evaluation: this client NEVER throws.
@@ -198,7 +202,7 @@ interface RecsClient {
     get(req: RecsGetRequest): Promise<RecsResult>;
     /**
      * Queue a rec:click for a product the shopper clicked. Pass `recipe` when
-     * known — results group click-through by (variation, recipe).
+     * known: results group click-through by (variation, recipe).
      */
     trackClick(productId: string, opts: RecsAttribution & {
         position?: number;
@@ -207,7 +211,7 @@ interface RecsClient {
 }
 /**
  * One entry of the datafile recipe registry (contract C3). Additive on
- * FlagDatafile — SDKs on older datafiles see it absent.
+ * FlagDatafile; SDKs on older datafiles see it absent.
  */
 interface DatafileRecipe {
     recipe: string;
@@ -227,7 +231,7 @@ interface DatafileRecipe {
  * alias. All flag evaluations and track calls use the bound context.
  *
  * Forced decisions set on a UserBoundClient survive only for the lifetime
- * of the instance — they do not affect the shared AvsbServer override state.
+ * of the instance; they do not affect the shared AvsbServer override state.
  * This makes them safe for test middleware and per-request debugging.
  *
  * Spec §5.8.
@@ -291,7 +295,7 @@ declare class AvsbServer {
     private readyPromise;
     private pendingEvents;
     /**
-     * §6 — `client.utils.*` surface. Constructed lazily on first access so
+     * §6: `client.utils.*` surface. Constructed lazily on first access so
      * the utils package is only imported when actually consumed.
      *
      * The server's event surface (`ServerEventMap`) is a subset of the
@@ -305,7 +309,7 @@ declare class AvsbServer {
      * Server-side datasets read surface (e-commerce suite Phase 2).
      * Constructed lazily on first access, mirroring the `utils` getter.
      * `client.datasets.get(slug, key)` resolves the live version from the
-     * current datafile and never throws — see ./datasets.ts.
+     * current datafile and never throws; see ./datasets.ts.
      */
     private _datasets;
     get datasets(): DatasetsClient;

package/dist/index.js

@@ -23,7 +23,7 @@ function createDatasetsClient(options) {
   const requestTimeout = options.requestTimeout ?? DEFAULT_REQUEST_TIMEOUT;
   async function get(slug, key) {
     if (!slug || !key) {
-      logger.warn("datasets.get called with an empty slug or key \u2014 returning not found");
+      logger.warn("datasets.get called with an empty slug or key; returning not found");
       return miss(slug, null);
     }
     const datafile = getDatafile();
@@ -33,11 +33,11 @@ function createDatasetsClient(options) {
     }
     const dataset = datafile.datasets?.find((d) => d.slug === slug);
     if (!dataset) {
-      logger.debug(`Dataset "${slug}" not present in datafile \u2014 returning not found`);
+      logger.debug(`Dataset "${slug}" not present in datafile; returning not found`);
       return miss(slug, null);
     }
     if (!dataset.liveVersion) {
-      logger.debug(`Dataset "${slug}" has no live version \u2014 returning not found`);
+      logger.debug(`Dataset "${slug}" has no live version; returning not found`);
       return miss(slug, null);
     }
     const base = datafile.collectEndpoint.replace(/\/+$/, "");
@@ -145,7 +145,7 @@ function createRecsClient(options) {
     try {
       const recipeHandle = typeof req?.recipe === "string" ? req.recipe : "";
       if (recipeHandle === "") {
-        logger.warn("recs.get called with an empty recipe \u2014 returning served:false");
+        logger.warn("recs.get called with an empty recipe; returning served:false");
         return miss2("", false);
       }
       const datafile = getDatafile();
@@ -156,7 +156,7 @@ function createRecsClient(options) {
       const recipes = datafile.recipes;
       const entry = recipes?.find((r) => r.recipe === recipeHandle) ?? null;
       if (!entry) {
-        logger.debug(`Recipe "${recipeHandle}" not present in datafile \u2014 returning served:false`);
+        logger.debug(`Recipe "${recipeHandle}" not present in datafile; returning served:false`);
         return miss2(recipeHandle, false);
       }
       const seeds = resolveSeeds(req.context);
@@ -233,11 +233,11 @@ function createRecsClient(options) {
   }
   function trackClick(productId, opts) {
     if (typeof productId !== "string" || productId === "") {
-      logger.warn("recs.trackClick called with an empty productId \u2014 dropped");
+      logger.warn("recs.trackClick called with an empty productId; dropped");
       return;
     }
     if (!opts || !opts.visitorId || !opts.experimentId || !opts.variationId) {
-      logger.warn("recs.trackClick requires visitorId/experimentId/variationId \u2014 dropped");
+      logger.warn("recs.trackClick requires visitorId/experimentId/variationId; dropped");
       return;
     }
     const tracker = getTracker();
@@ -613,7 +613,7 @@ var AvsbServer = class {
   readyPromise = null;
   pendingEvents = [];
   /**
-   * §6 — `client.utils.*` surface. Constructed lazily on first access so
+   * §6: `client.utils.*` surface. Constructed lazily on first access so
    * the utils package is only imported when actually consumed.
    *
    * The server's event surface (`ServerEventMap`) is a subset of the
@@ -646,7 +646,7 @@ var AvsbServer = class {
    * Server-side datasets read surface (e-commerce suite Phase 2).
    * Constructed lazily on first access, mirroring the `utils` getter.
    * `client.datasets.get(slug, key)` resolves the live version from the
-   * current datafile and never throws — see ./datasets.ts.
+   * current datafile and never throws; see ./datasets.ts.
    */
   _datasets = null;
   get datasets() {
@@ -800,7 +800,7 @@ var AvsbServer = class {
     const decisionLog = options?.decisionLog;
     if (!context) {
       this.logger.warn(
-        `getFlag called without context for flagKey="${flagKey}" \u2014 returning default`
+        `getFlag called without context for flagKey="${flagKey}"; returning default`
       );
       return notFoundFlag2(defaultValue, "no context provided");
     }
@@ -1062,7 +1062,7 @@ var AvsbServer = class {
     const mismatch = checkExpectedType(datafileFlag, expectedType, flag.value);
     if (mismatch) {
       this.logger.warn(
-        `Type mismatch on flag "${flagKey}": ${mismatch} \u2014 returning default`
+        `Type mismatch on flag "${flagKey}": ${mismatch}; returning default`
       );
       return notFoundFlag2(defaultValue, mismatch);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avsbhq/node",
-  "version": "1.5.0",
+  "version": "1.6.1",
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
@@ -33,8 +33,8 @@
     "test:watch": "vitest"
   },
   "dependencies": {
-    "@avsbhq/core": "1.3.0",
-    "@avsbhq/utils": "1.0.1"
+    "@avsbhq/core": "1.4.0",
+    "@avsbhq/utils": "1.0.2"
   },
   "devDependencies": {
     "tsup": "^8.0.0",