@rebuy/rebuy 2.37.0-rc.1 → 3.0.0

package/README.md

@@ -1,3 +1,44 @@
-# Rebuy
+# @rebuy/rebuy
 
-Rebuy base package containing reusable API client, functions, and other common utilities. Initially developed for [@rebuy/rebuy-hydrogen](https://www.npmjs.com/package/@rebuy/rebuy-hydrogen).
+Shared zod schemas, legacy→CAB widget transforms, and server orchestrators for Rebuy's Shopify consumers — the library `rebuy-api`, `admin-nextjs`, and `rebuy-shopify-extensions` all build on.
+
+## Install
+
+```bash
+npm install @rebuy/rebuy zod
+```
+
+`zod ^4.4.3` is a **peer dependency**: consumers install their own copy so every package in a tree composes and `instanceof`-checks against ONE zod instance. Yarn v1 workspaces do not auto-install peers — declare zod explicitly there. `react-hook-form` is an **optional** peer, needed only by form-layer consumers that use the `SectionArrayPath`/`SectionPrefixPath` types against their own forms (type-only — nothing is bundled).
+
+Node `^22.14.0 || ^24.10.0 || ^26.0.0` for development; the published artifacts are plain ES2020 (ESM `.mjs` + CJS `.cjs`).
+
+## Entry points
+
+| Subpath | Contents |
+| --- | --- |
+| `@rebuy/rebuy` | Root barrel: schemas, client helpers, utilities |
+| `@rebuy/rebuy/client` | `RebuyClient` API client |
+| `@rebuy/rebuy/gwp` | Gift-with-purchase validation helpers |
+| `@rebuy/rebuy/pricing` | Variant pricing/discount forecast (`priceVariant`, `currencyDecimals`) |
+| `@rebuy/rebuy/routes` | `apiRoutes` + the `UPSTREAM_SUFFIXES` upstream-host allowlist |
+| `@rebuy/rebuy/schema/checkout-and-beyond` | The CAB section-tree schema (`CABRootSection` et al.) |
+| `@rebuy/rebuy/schema/checkout-and-beyond/constants` | CAB enums/constants (`SectionType`, `ButtonField`, …) |
+| `@rebuy/rebuy/schema/shop-config` | `ShopConfig` schema |
+| `@rebuy/rebuy/schema/user-config` | `UserConfig` schema |
+| `@rebuy/rebuy/schema/widget-data` | `WidgetData` schema |
+| `@rebuy/rebuy/server` | Server orchestrators for rebuy-api's `/cab/*` routes (settings→tree conversion, data sources, gifts, analytics) + request schemas |
+| `@rebuy/rebuy/transforms` | Legacy v1 widget → CAB tree converters |
+| `@rebuy/rebuy/utilities` | Misc utilities (`getIdFromGraphUrl`, `stripHtml`, `uuid`, …) |
+
+Every type derives from a zod schema via `z.infer` — defaults live in the schema (`.default()` at parse time), never in consumer render code.
+
+## Development
+
+```bash
+npm run lint            # eslint + prettier (a misformat is a lint error)
+npm run test:coverage   # vitest, 100% thresholds over the coverage allowlist
+npm run check-types     # tsc --noEmit
+npm run build           # types + esbuild bundles + check:dist smoke test
+```
+
+After any dependency change, regenerate the lockfile with the pinned npm 10 (`npm run lock && npm run lock:verify`) — never with npm 11. Versions are cut by semantic-release from ESLint-convention commits (`Fix:`, `Update:`, `New:`, `Breaking:`, …); never hand-bump `version`. See [AGENTS.md](./AGENTS.md) for the full contributor contract.

package/dist/api.d.ts

@@ -1,6 +1,6 @@
 type Config = {
     /**
-     * @deprecated
+     * @deprecated Use `staticDomain` (same host) — `cdnDomain` remains only for legacy callers and goes away in the next major.
      */
     cdnDomain: string;
     domain: string;
@@ -28,4 +28,3 @@ export declare class Api {
     callApi(method: string, path: string, data: RequestData, options?: FetchOptions): Promise<any>;
 }
 export default Api;
-//# sourceMappingURL=api.d.ts.map

package/dist/{client.js → client.cjs}

@@ -26,6 +26,7 @@ __export(client_exports, {
 module.exports = __toCommonJS(client_exports);
 
 // src/utilities.ts
+var import_uuid = require("uuid");
 function isBase64Encoded(str) {
   const base64Regex = /^([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?$/;
   return base64Regex.test(str) ? true : false;
@@ -69,19 +70,7 @@ function firstAvailableVariant(product) {
   return selectedVariant;
 }
 function uuid() {
-  let d = (/* @__PURE__ */ new Date()).getTime();
-  let d2 = performance && performance.now && performance.now() * 1e3 || 0;
-  return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, (c) => {
-    let r = Math.random() * 16;
-    if (d > 0) {
-      r = (d + r) % 16 | 0;
-      d = Math.floor(d / 16);
-    } else {
-      r = (d2 + r) % 16 | 0;
-      d2 = Math.floor(d2 / 16);
-    }
-    return (c === "x" ? r : r & 3 | 8).toString(16);
-  });
+  return (0, import_uuid.v4)();
 }
 function sessionId() {
   const config2 = {
@@ -264,7 +253,7 @@ function serialize(obj) {
 // src/api.ts
 var staging = {
   /**
-   * @deprecated
+   * @deprecated Use `staticDomain` (same host) — `cdnDomain` remains only for legacy callers and goes away in the next major.
    */
   cdnDomain: "https://cdn.enigneyuber.com",
   domain: "https://enigneyuber.com",
@@ -322,7 +311,7 @@ var Api = class {
   constructor(options) {
     this.config = {
       /**
-       * @deprecated
+       * @deprecated Use `staticDomain` (same host) — `cdnDomain` remains only for legacy callers and goes away in the next major.
        */
       cdnDomain: "https://cdn.rebuyengine.com",
       domain: "https://rebuyengine.com",
@@ -718,4 +707,3 @@ var RebuyClient = class {
   }
 };
 var client_default = RebuyClient;
-//# sourceMappingURL=client.js.map

package/dist/client.d.ts

@@ -11,4 +11,3 @@ export declare class RebuyClient {
     trackProductViewed(data: Record<string, any>): Promise<any>;
 }
 export default RebuyClient;
-//# sourceMappingURL=client.d.ts.map

package/dist/client.mjs

@@ -1,4 +1,5 @@
 // src/utilities.ts
+import { v4 as uuidv4 } from "uuid";
 function isBase64Encoded(str) {
   const base64Regex = /^([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?$/;
   return base64Regex.test(str) ? true : false;
@@ -42,19 +43,7 @@ function firstAvailableVariant(product) {
   return selectedVariant;
 }
 function uuid() {
-  let d = (/* @__PURE__ */ new Date()).getTime();
-  let d2 = performance && performance.now && performance.now() * 1e3 || 0;
-  return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, (c) => {
-    let r = Math.random() * 16;
-    if (d > 0) {
-      r = (d + r) % 16 | 0;
-      d = Math.floor(d / 16);
-    } else {
-      r = (d2 + r) % 16 | 0;
-      d2 = Math.floor(d2 / 16);
-    }
-    return (c === "x" ? r : r & 3 | 8).toString(16);
-  });
+  return uuidv4();
 }
 function sessionId() {
   const config2 = {
@@ -237,7 +226,7 @@ function serialize(obj) {
 // src/api.ts
 var staging = {
   /**
-   * @deprecated
+   * @deprecated Use `staticDomain` (same host) — `cdnDomain` remains only for legacy callers and goes away in the next major.
    */
   cdnDomain: "https://cdn.enigneyuber.com",
   domain: "https://enigneyuber.com",
@@ -295,7 +284,7 @@ var Api = class {
   constructor(options) {
     this.config = {
       /**
-       * @deprecated
+       * @deprecated Use `staticDomain` (same host) — `cdnDomain` remains only for legacy callers and goes away in the next major.
        */
       cdnDomain: "https://cdn.rebuyengine.com",
       domain: "https://rebuyengine.com",
@@ -695,4 +684,3 @@ export {
   RebuyClient,
   client_default as default
 };
-//# sourceMappingURL=client.mjs.map

package/dist/cookie.d.ts

@@ -54,4 +54,3 @@ declare const _default: {
     set: typeof set;
 };
 export default _default;
-//# sourceMappingURL=cookie.d.ts.map

package/dist/geolocation.d.ts

@@ -5,4 +5,3 @@ export declare class Geolocation {
     geolocation(): Promise<any>;
 }
 export default Geolocation;
-//# sourceMappingURL=geolocation.d.ts.map

package/dist/gwp/getValidGwpProductIds.d.ts

@@ -5,4 +5,3 @@ import { type MatchedRule } from '../gwp/types';
  * not in this set no longer qualifies and should be removed.
  */
 export declare const getValidGwpProductIds: (matchedRules?: MatchedRule[]) => Set<number>;
-//# sourceMappingURL=getValidGwpProductIds.d.ts.map

package/dist/gwp/hasUnsupportedRuleTypes.d.ts

@@ -4,4 +4,3 @@ import { type GwpMetadata } from '../gwp/types';
  * qualification can't be trusted, so keep it (never remove on uncertainty).
  */
 export declare const hasUnsupportedRuleTypes: (metadata?: GwpMetadata | null) => boolean;
-//# sourceMappingURL=hasUnsupportedRuleTypes.d.ts.map

package/dist/gwp/{index.js → index.cjs}

@@ -46,4 +46,3 @@ var isDefinitiveRuleAnswer = (metadata) => metadata != null && (metadata.matched
 // src/gwp/shouldRemoveGift.ts
 var hasLostDiscount = (gift) => !gift.discounted && gift.cost > 0;
 var shouldRemoveGift = (gift, validIds) => !validIds.has(gift.productId) || hasLostDiscount(gift);
-//# sourceMappingURL=index.js.map

package/dist/gwp/index.d.ts

@@ -3,4 +3,3 @@ export * from '../gwp/hasUnsupportedRuleTypes';
 export * from '../gwp/isDefinitiveRuleAnswer';
 export * from '../gwp/shouldRemoveGift';
 export * from '../gwp/types';
-//# sourceMappingURL=index.d.ts.map

package/dist/gwp/index.mjs

@@ -23,4 +23,3 @@ export {
   isDefinitiveRuleAnswer,
   shouldRemoveGift
 };
-//# sourceMappingURL=index.mjs.map

package/dist/gwp/isDefinitiveRuleAnswer.d.ts

@@ -7,4 +7,3 @@ import { type GwpMetadata } from '../gwp/types';
  * `unmatchedRules` IS definitive — the engine answered and nothing qualifies.
  */
 export declare const isDefinitiveRuleAnswer: (metadata?: GwpMetadata | null) => metadata is GwpMetadata;
-//# sourceMappingURL=isDefinitiveRuleAnswer.d.ts.map

package/dist/gwp/shouldRemoveGift.d.ts

@@ -12,4 +12,3 @@ export declare const hasLostDiscount: (gift: Pick<GwpGift, "cost" | "discounted"
  * discount, so the client must — the complete removal receipt (see rebuy-discount-architecture / GWP E2).
  */
 export declare const shouldRemoveGift: (gift: Pick<GwpGift, "cost" | "discounted" | "productId">, validIds: Set<number>) => boolean;
-//# sourceMappingURL=shouldRemoveGift.d.ts.map

package/dist/gwp/types.d.ts

@@ -37,4 +37,3 @@ export type GwpMetadata = {
     matchedRules?: MatchedRule[];
     unmatchedRules?: MatchedRule[];
 };
-//# sourceMappingURL=types.d.ts.map

package/dist/identity.d.ts

@@ -8,4 +8,3 @@ export declare class Identity {
     geolocation(): Promise<any>;
 }
 export default Identity;
-//# sourceMappingURL=identity.d.ts.map