@sixtyninecommerce/client 0.30.0 → 0.32.0

package/dist/core/context.d.ts

@@ -1,3 +1,129 @@
-import type { StoreContext, StorefrontClientConfig } from '../types.js';
+import { type ChannelResolver, type ConditionalReadsOption, type ChannelInfo as CoreChannelInfo, type DeprecationNotice } from '@sixtyninecommerce/core';
+import { StorefrontError } from '../errors.js';
+import type { CacheTagResolver, ChannelInfo, MethodDeprecationNotice, OrderScope, StoreContext, StorefrontClientConfig, StoreRename } from '../types.js';
+/**
+ * What every store a client serves shares: where the services are, how to talk
+ * to them, and the CDN to fall back on. Read once from the configuration; a
+ * multi-store client holds ONE of these for all of its stores.
+ */
+export interface ClientEndpoints {
+    readonly fetch: typeof globalThis.fetch;
+    /** The configured CDN — used for a store whose channel sets no `cdnDomain`. */
+    readonly cdnUrl: string;
+    readonly vendureUrl: string;
+    readonly cmsUrl: string;
+    readonly pluginsUrl: string;
+    readonly retry: {
+        readonly attempts: number;
+        readonly baseDelayMs: number;
+    };
+    readonly cacheTags: boolean | CacheTagResolver;
+    readonly conditionalReads: ConditionalReadsOption;
+}
+/**
+ * The shopper half of a context: everything one request may change and no
+ * other request may see. A single-store client takes it from its config; a
+ * multi-store client builds a fresh one for every `forRequest`/`forStore`.
+ */
+export interface ShopperState {
+    readonly languageCode?: string;
+    readonly currencyCode?: string;
+    readonly authToken?: string;
+    readonly privateToken?: string;
+    readonly buyerIp?: string;
+    readonly orderScope?: OrderScope;
+    readonly head?: string;
+    readonly onAuthToken?: (token: string) => void;
+    readonly onAuthExpired?: () => void;
+    readonly onAuthCleared?: () => void;
+}
 export declare function createStoreContext(config: StorefrontClientConfig): Promise<StoreContext>;
+/**
+ * Who hears that a store was renamed. A configured `onStoreRenamed` is called once per client
+ * for each rename and may not throw into a request; without one the client warns ONCE PER
+ * PROCESS for each rename (several clients of one store in one process say it once).
+ * `audience` picks the warning: a single-store client follows the new code, a store router
+ * keeps the code `resolveStore` names.
+ *
+ * `instance` tells occurrences of the same pair of codes apart. A single-store client reports
+ * only when it actually switches, so it passes the alias's `renamedAt` (stamped afresh on every
+ * alias row the CMS writes): a rename undone, submitted again and undone again is heard each
+ * time. A router reports on every request that reaches an old code and never switches, so it
+ * passes the window's end, which a rewritten row keeps. A switch-back ("no longer answers") is
+ * never swallowed by another client's warning: a client says it whenever IT goes back, since
+ * its last word must not name a dead code.
+ */
+export declare function renameReporter(onStoreRenamed: StorefrontClientConfig['onStoreRenamed'], audience?: 'client' | 'router'): (rename: StoreRename, instance: string) => void;
+/**
+ * What the default reporter says. The end is the exact instant, in UTC: the old code stops at
+ * the rename's time of day, and a bare date reads as "through that day" in every zone.
+ */
+export declare function renameWarning(rename: StoreRename, audience?: 'client' | 'router'): string;
+/** Which rename an old-code answer belongs to (see {@link renameReporter}). */
+export declare function renameInstance(info: {
+    renamedAt?: string | undefined;
+    previousCodeUntil?: string | undefined;
+}): string;
+/**
+ * Validate and normalise the parts of a config every store shares. Throws the
+ * same refusals, in the same order, a single-store client always has.
+ */
+export declare function readClientEndpoints(config: Pick<StorefrontClientConfig, 'cdnUrl' | 'cacheTags' | 'conditionalReads' | 'fetch' | 'vendureUrl' | 'cmsUrl' | 'pluginsUrl' | 'retry'>): ClientEndpoints;
+/** The CMS channel resolver a client's transports re-resolve through. */
+export declare function createClientChannelResolver(endpoints: ClientEndpoints): ChannelResolver;
+/** The store's own CDN when its channel names one, else the configured CDN. */
+export declare function cdnForChannel(channel: ChannelInfo, fallbackCdnUrl: string): {
+    cdnUrl: string;
+    channelCdnDomain: string | null;
+};
+/**
+ * One request's context: the store's shared parts plus a NEW shopper half.
+ * Every field the modules write (`authToken`, `languageCode`, the session
+ * currency, `taxDisplay`, `orderScope`) lives on the object returned here and
+ * nowhere else, which is what keeps two requests from seeing each other's.
+ */
+export declare function assembleStoreContext(endpoints: ClientEndpoints, channel: ChannelInfo, channels: ChannelResolver, shopper: ShopperState, options?: {
+    readonly storeScopedCacheTags?: boolean;
+    readonly onDeprecation?: (notice: DeprecationNotice) => void;
+    readonly reportDeprecatedMethod?: (notice: MethodDeprecationNotice) => void;
+}): StoreContext;
+/**
+ * A customer token, refused blank. Blank would silently build an ANONYMOUS
+ * client — the opposite of what the caller asked for, discovered only when the
+ * first cart call lands elsewhere.
+ */
+export declare function assertCustomerToken(token: string | undefined): void;
+/** A session currency: three upper-case letters (the engine's `CurrencyCode`). */
+export declare function assertCurrencyCode(currencyCode: string | undefined): void;
+export declare function assertHeadKey(head: unknown, label: string): void;
+/**
+ * Refuse a private token in a browser: a token a page holds is a token every
+ * visitor holds. Runs before anything reaches the network.
+ */
+export declare function assertPrivateTokenRuntime(): void;
+/** A private token's SHAPE; whether it is live is the platform's answer. */
+export declare function assertPrivateTokenShape(token: string): void;
+/** A buyer address is honoured only beside a private token, and never blank. */
+export declare function assertBuyerIp(buyerIp: string | undefined, hasPrivateToken: boolean): void;
+/**
+ * Resolve the channel, and say what to DO about each way it can fail.
+ *
+ * `core` reports the failure accurately (`CHANNEL_NOT_FOUND`,
+ * `CHANNEL_RESOLUTION_TIMEOUT`, …); this is the one call a storefront author
+ * makes by hand, usually while wiring the SDK up for the first time, so the
+ * three failures they are actually going to hit name the thing to check.
+ */
+export declare function resolveChannel(channels: ChannelResolver, storeCode: string, cmsUrl: string): Promise<ChannelInfo>;
+/**
+ * {@link resolveChannel} without the reshaping: the resolver's own object, so
+ * a caller can tell by identity whether the answer changed since it last asked.
+ */
+export declare function resolveCoreChannel(channels: ChannelResolver, storeCode: string, cmsUrl: string): Promise<CoreChannelInfo>;
+/**
+ * `core` types the bag as `Record<string, unknown>` (it only checks it is an
+ * object); the generated `PublicChannelDto` names the keys the CMS sends.
+ */
+export declare function toChannelInfo(resolved: CoreChannelInfo): ChannelInfo;
+/** The refusal for a code that names no store this client may serve. */
+export declare function channelNotFound(storeCode: string): StorefrontError;
 //# sourceMappingURL=context.d.ts.map

package/dist/core/context.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../src/core/context.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAGV,YAAY,EACZ,sBAAsB,EACvB,MAAM,aAAa,CAAC;AAErB,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,YAAY,CAAC,CAoE9F"}
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../src/core/context.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,eAAe,EACpB,KAAK,sBAAsB,EAC3B,KAAK,WAAW,IAAI,eAAe,EAEnC,KAAK,iBAAiB,EAIvB,MAAM,yBAAyB,CAAC;AAOjC,OAAO,EAAE,eAAe,EAAqB,MAAM,cAAc,CAAC;AAClE,OAAO,KAAK,EACV,gBAAgB,EAChB,WAAW,EACX,uBAAuB,EACvB,UAAU,EACV,YAAY,EACZ,sBAAsB,EACtB,WAAW,EACZ,MAAM,aAAa,CAAC;AASrB;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,KAAK,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;IACxC,+EAA+E;IAC/E,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5E,QAAQ,CAAC,SAAS,EAAE,OAAO,GAAG,gBAAgB,CAAC;IAC/C,QAAQ,CAAC,gBAAgB,EAAE,sBAAsB,CAAC;CACnD;AAGD;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC;IACjC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/C,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,IAAI,CAAC;IACpC,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,IAAI,CAAC;CACrC;AAED,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,YAAY,CAAC,CAoE9F;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,cAAc,CAC5B,cAAc,EAAE,sBAAsB,CAAC,gBAAgB,CAAC,EACxD,QAAQ,GAAE,QAAQ,GAAG,QAAmB,GACvC,CAAC,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,CAgCjD;AAKD;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,WAAW,EACnB,QAAQ,GAAE,QAAQ,GAAG,QAAmB,GACvC,MAAM,CAaR;AAED,+EAA+E;AAC/E,wBAAgB,cAAc,CAAC,IAAI,EAAE;IACnC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACxC,GAAG,MAAM,CAET;AA6GD;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,IAAI,CACV,sBAAsB,EACpB,QAAQ,GACR,WAAW,GACX,kBAAkB,GAClB,OAAO,GACP,YAAY,GACZ,QAAQ,GACR,YAAY,GACZ,OAAO,CACV,GACA,eAAe,CA+BjB;AAED,yEAAyE;AACzE,wBAAgB,2BAA2B,CAAC,SAAS,EAAE,eAAe,GAAG,eAAe,CAQvF;AAED,+EAA+E;AAC/E,wBAAgB,aAAa,CAC3B,OAAO,EAAE,WAAW,EACpB,cAAc,EAAE,MAAM,GACrB;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,CAQrD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,eAAe,EAC1B,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,eAAe,EACzB,OAAO,EAAE,YAAY,EACrB,OAAO,CAAC,EAAE;IACR,QAAQ,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC;IACxC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,IAAI,CAAC;IAC7D,QAAQ,CAAC,sBAAsB,CAAC,EAAE,CAAC,MAAM,EAAE,uBAAuB,KAAK,IAAI,CAAC;CAC7E,GACA,YAAY,CAkCd;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAInE;AAED,kFAAkF;AAClF,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CASzE;AAWD,wBAAgB,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAchE;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,IAAI,IAAI,CAShD;AAED,4EAA4E;AAC5E,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAS3D;AAED,gFAAgF;AAChF,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAazF;AAqHD;;;;;;;GAOG;AACH,wBAAsB,cAAc,CAClC,QAAQ,EAAE,eAAe,EACzB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,WAAW,CAAC,CAEtB;AAED;;;GAGG;AACH,wBAAsB,kBAAkB,CACtC,QAAQ,EAAE,eAAe,EACzB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,eAAe,CAAC,CAiB1B;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,eAAe,GAAG,WAAW,CAEpE;AAED,wEAAwE;AACxE,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,eAAe,CAOlE"}