@weaverse/hydrogen 5.25.0 → 6.0.0

package/dist/types/weaverse-client.d.ts

@@ -1,12 +1,11 @@
-import { createWithCache } from '@shopify/hydrogen';
-import type { CachingStrategy, CustomPageEntry, FetchProjectRequestBody, HydrogenComponentData, HydrogenPageData, LoadPageParams, ThemeSettingsResponse, WeaverseClientArgs, WeaverseLoaderData, WeaverseProjectConfigs } from './types';
+import type { CachingStrategy, CustomPageEntry, FetchProjectRequestBody, LoadPageParams, WeaverseClientArgs, WeaverseComponentData, WeaverseLoaderData, WeaversePageData, WeaverseProjectConfigs, WeaverseThemeSettingsResponse } from './types';
 /** Builder API resource whose freshness policy should be used for a request. */
 export type BuilderApiCacheTarget = 'custom-pages' | 'merchant-overrides' | 'project' | 'theme-settings';
 /** Fetch options accepted by {@link WeaverseClient.fetchWithCache}. */
 export interface WeaverseFetchWithCacheOptions extends RequestInit {
-    /** Builder API resource whose default freshness policy should be used. */
+    /** Builder API resource the request reads; part of the cache key. */
     cacheTarget?: BuilderApiCacheTarget;
-    /** Explicit Hydrogen caching strategy overriding the resource default. */
+    /** Explicit Hydrogen caching strategy overriding the default. */
     strategy?: CachingStrategy;
 }
 /** Pagination and locale options for {@link WeaverseClient.fetchCustomPages}. */
@@ -32,11 +31,11 @@ export declare class WeaverseClient {
     basePageRequestBody: Omit<FetchProjectRequestBody, 'url'>;
     /** Resolved project and rendering-mode configuration. */
     configs: WeaverseProjectConfigs;
-    /** Hydrogen cache wrapper used for Builder API requests. */
-    withCache: ReturnType<typeof createWithCache>;
+    /** Hydrogen cached fetch used for Builder API requests. */
+    private cachedFetch;
     /** Incoming request associated with this client instance. */
     request: WeaverseClientArgs['request'];
-    /** Hydrogen customer-account client, when configured. */
+    /** Customer Account API client, when the storefront passes one. */
     customerAccount: WeaverseClientArgs['customerAccount'];
     /** Hydrogen Storefront API client and locale context. */
     storefront: WeaverseClientArgs['storefront'];
@@ -44,17 +43,17 @@ export declare class WeaverseClient {
     components: WeaverseClientArgs['components'];
     /** Theme schema used for defaults and Studio editing. */
     themeSchema: WeaverseClientArgs['themeSchema'];
-    /** Hydrogen runtime environment variables. */
+    /** Runtime environment variables. */
     env: WeaverseClientArgs['env'];
     /** Cache storage supplied by the Hydrogen runtime. */
     cache: WeaverseClientArgs['cache'];
-    /** Background execution hook supplied by the Oxygen runtime. */
+    /** Background execution hook supplied by the runtime. */
     waitUntil: WeaverseClientArgs['waitUntil'];
     private readonly parsedUrl;
     private readonly componentsByType;
     private readonly fetchTimeoutMs;
     private readonly throwPageLoadFailures;
-    /** Creates a request-scoped client from the Hydrogen app context. */
+    /** Creates a request-scoped client from the storefront's request context. */
     constructor(args: WeaverseClientArgs);
     /**
      * Initialize Hydrogen cache with proper configuration.
@@ -135,7 +134,6 @@ export declare class WeaverseClient {
     private resolveFromEnvironment;
     /**
      * Helper method for direct fetching in design mode.
-     * Returns same format as withCache.fetch for consistency.
      * Includes 10-second timeout to prevent hanging requests.
      */
     private readonly fetchOnce;
@@ -144,7 +142,7 @@ export declare class WeaverseClient {
     private isExternalPublicApiUrl;
     /**
      * Fetch data with caching support for both design mode and production.
-     * Uses direct fetch in design mode, Hydrogen's withCache in production.
+     * Uses direct fetch in design mode, Hydrogen's cached fetch in production.
      * Automatically includes projectId in cache key for multi-project isolation.
      *
      * @param url - The URL to fetch from
@@ -180,7 +178,7 @@ export declare class WeaverseClient {
      * const primaryColor = settings.theme.colors?.primary
      * ```
      */
-    loadThemeSettings: (strategy?: CachingStrategy) => Promise<ThemeSettingsResponse>;
+    loadThemeSettings: (strategy?: CachingStrategy) => Promise<WeaverseThemeSettingsResponse>;
     /**
      * Fetch locale-specific merchant overrides from the translation API.
      * Returns a nested JSON object with translated values.
@@ -192,9 +190,9 @@ export declare class WeaverseClient {
      * Used internally when API returns no page or when page needs default content.
      *
      * @param message - Custom message to display in the fallback page
-     * @returns HydrogenPageData with single main component containing the message
+     * @returns WeaversePageData with single main component containing the message
      */
-    generateFallbackPage: (message: string) => HydrogenPageData;
+    generateFallbackPage: (message: string) => WeaversePageData;
     /**
      * Fetch all published custom pages for sitemap generation.
      * Paginates automatically, never throws, returns accumulated results on partial failure.
@@ -230,6 +228,6 @@ export declare class WeaverseClient {
      */
     loadPage: (params?: LoadPageParams) => Promise<WeaverseLoaderData | null>;
     /** Executes the registered loader for one component and attaches its result. */
-    execComponentLoader: (item: HydrogenComponentData) => Promise<HydrogenComponentData>;
+    execComponentLoader: (item: WeaverseComponentData) => Promise<WeaverseComponentData>;
 }
 //# sourceMappingURL=weaverse-client.d.ts.map

package/dist/types/weaverse-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"weaverse-client.d.ts","sourceRoot":"","sources":["../../src/weaverse-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,eAAe,EAGhB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,KAAK,EACV,eAAe,EACf,eAAe,EAEf,uBAAuB,EAEvB,qBAAqB,EACrB,gBAAgB,EAChB,cAAc,EAGd,qBAAqB,EACrB,kBAAkB,EAClB,kBAAkB,EAClB,sBAAsB,EAGvB,MAAM,SAAS,CAAA;AAoMhB,gFAAgF;AAChF,MAAM,MAAM,qBAAqB,GAC7B,cAAc,GACd,oBAAoB,GACpB,SAAS,GACT,gBAAgB,CAAA;AAEpB,uEAAuE;AACvE,MAAM,WAAW,6BAA8B,SAAQ,WAAW;IAChE,0EAA0E;IAC1E,WAAW,CAAC,EAAE,qBAAqB,CAAA;IACnC,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,eAAe,CAAA;CAC3B;AAED,iFAAiF;AACjF,MAAM,WAAW,uBAAuB;IACtC,6DAA6D;IAC7D,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,8DAA8D;IAC9D,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAyCD;;;;;;GAMG;AACH,qBAAa,cAAc;IACzB,+CAA+C;IAC/C,GAAG,OAAW;IACd,4DAA4D;IAC5D,eAAe,EAAE,IAAI,CAAC,sBAAsB,EAAE,aAAa,CAAC,CAAA;IAC5D,0DAA0D;IAC1D,mBAAmB,EAAE,IAAI,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAA;IACzD,yDAAyD;IACzD,OAAO,EAAE,sBAAsB,CAAA;IAC/B,4DAA4D;IAC5D,SAAS,EAAE,UAAU,CAAC,OAAO,eAAe,CAAC,CAAA;IAE7C,6DAA6D;IAC7D,OAAO,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAA;IACtC,yDAAyD;IACzD,eAAe,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,CAAA;IACtD,yDAAyD;IACzD,UAAU,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAA;IAC5C,sEAAsE;IACtE,UAAU,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAA;IAC5C,yDAAyD;IACzD,WAAW,EAAE,kBAAkB,CAAC,aAAa,CAAC,CAAA;IAC9C,8CAA8C;IAC9C,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAA;IAC9B,sDAAsD;IACtD,KAAK,EAAE,kBAAkB,CAAC,OAAO,CAAC,CAAA;IAClC,gEAAgE;IAChE,SAAS,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAA;IAG1C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAK;IAC/B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAgC;IAGjE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAQ;IACvC,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAS;IAE/C,qEAAqE;IACrE,YAAY,IAAI,EAAE,kBAAkB,EAsBnC;IAED;;;OAGG;IACH,OAAO,CAAC,eAAe;IAcvB;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAsDzB;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAM/B;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,gBAAgB;IA2BxB;;;;;OAKG;IACH,OAAO,CAAC,mBAAmB;IAI3B;;;;;;OAMG;IACH,OAAO,CAAC,iBAAiB;IAoBzB;;;;;;;;;OASG;IACH,OAAO,CAAC,oBAAoB;IAe5B;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAK9B;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IA4D3B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAwBzB;;OAEG;IACH,OAAO,CAAC,sBAAsB;IAc9B;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,SAAS,CAqEzB;IAED,OAAO,CAAC,QAAQ,CAAC,WAAW,CAoB3B;IAGD,OAAO,CAAC,SAAS;IAKjB,OAAO,CAAC,sBAAsB;IAQ9B;;;;;;;;;;;;;;;;OAgBG;IACI,cAAc,GAAU,CAAC,GAAG,OAAO,OACnC,MAAM,YACF,6BAA6B,KACrC,OAAO,CAAC,CAAC,CAAC,CA2FZ;IAED;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB;IAQ5B;;;;;;;;;;;;OAYG;IACH,iBAAiB,cACJ,eAAe,KACzB,OAAO,CAAC,qBAAqB,CAAC,CA2HhC;IAED;;;;OAIG;IACH,OAAO,CAAC,sBAAsB,CA4D7B;IAED;;;;;;OAMG;IACH,oBAAoB,YAAa,MAAM,KAAG,gBAAgB,CAczD;IAED;;;OAGG;IACG,gBAAgB,CACpB,IAAI,CAAC,EAAE,uBAAuB,GAC7B,OAAO,CAAC,eAAe,EAAE,CAAC,CAiD5B;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,QAAQ,YACE,cAAc,KACrB,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAkMpC;IAED,gFAAgF;IAChF,mBAAmB,SAAgB,qBAAqB,oCAqBvD;CACF"}
+{"version":3,"file":"weaverse-client.d.ts","sourceRoot":"","sources":["../../src/weaverse-client.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,eAAe,EACf,eAAe,EAEf,uBAAuB,EACvB,cAAc,EAGd,kBAAkB,EAElB,qBAAqB,EAGrB,kBAAkB,EAClB,gBAAgB,EAChB,sBAAsB,EAEtB,6BAA6B,EAE9B,MAAM,SAAS,CAAA;AA+MhB,gFAAgF;AAChF,MAAM,MAAM,qBAAqB,GAC7B,cAAc,GACd,oBAAoB,GACpB,SAAS,GACT,gBAAgB,CAAA;AAEpB,uEAAuE;AACvE,MAAM,WAAW,6BAA8B,SAAQ,WAAW;IAChE,qEAAqE;IACrE,WAAW,CAAC,EAAE,qBAAqB,CAAA;IACnC,iEAAiE;IACjE,QAAQ,CAAC,EAAE,eAAe,CAAA;CAC3B;AAED,iFAAiF;AACjF,MAAM,WAAW,uBAAuB;IACtC,6DAA6D;IAC7D,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,8DAA8D;IAC9D,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AA6BD;;;;;;GAMG;AACH,qBAAa,cAAc;IACzB,+CAA+C;IAC/C,GAAG,OAAW;IACd,4DAA4D;IAC5D,eAAe,EAAE,IAAI,CAAC,sBAAsB,EAAE,aAAa,CAAC,CAAA;IAC5D,0DAA0D;IAC1D,mBAAmB,EAAE,IAAI,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAA;IACzD,yDAAyD;IACzD,OAAO,EAAE,sBAAsB,CAAA;IAC/B,2DAA2D;IAC3D,OAAO,CAAC,WAAW,CAAyC;IAE5D,6DAA6D;IAC7D,OAAO,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAA;IACtC,mEAAmE;IACnE,eAAe,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,CAAA;IACtD,yDAAyD;IACzD,UAAU,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAA;IAC5C,sEAAsE;IACtE,UAAU,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAA;IAC5C,yDAAyD;IACzD,WAAW,EAAE,kBAAkB,CAAC,aAAa,CAAC,CAAA;IAC9C,qCAAqC;IACrC,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAA;IAC9B,sDAAsD;IACtD,KAAK,EAAE,kBAAkB,CAAC,OAAO,CAAC,CAAA;IAClC,yDAAyD;IACzD,SAAS,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAA;IAG1C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAK;IAC/B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAgC;IAGjE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAQ;IACvC,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAS;IAE/C,6EAA6E;IAC7E,YAAY,IAAI,EAAE,kBAAkB,EAsBnC;IAED;;;OAGG;IACH,OAAO,CAAC,eAAe;IAavB;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAmDzB;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAM/B;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,gBAAgB;IA2BxB;;;;;OAKG;IACH,OAAO,CAAC,mBAAmB;IAI3B;;;;;;OAMG;IACH,OAAO,CAAC,iBAAiB;IAoBzB;;;;;;;;;OASG;IACH,OAAO,CAAC,oBAAoB;IAe5B;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAK9B;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IA4D3B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAwBzB;;OAEG;IACH,OAAO,CAAC,sBAAsB;IAc9B;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,SAAS,CAqEzB;IAED,OAAO,CAAC,QAAQ,CAAC,WAAW,CAoB3B;IAGD,OAAO,CAAC,SAAS;IAKjB,OAAO,CAAC,sBAAsB;IAQ9B;;;;;;;;;;;;;;;;OAgBG;IACI,cAAc,GAAU,CAAC,GAAG,OAAO,OACnC,MAAM,YACF,6BAA6B,KACrC,OAAO,CAAC,CAAC,CAAC,CAyFZ;IAED;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB;IAQ5B;;;;;;;;;;;;OAYG;IACH,iBAAiB,cACJ,eAAe,KACzB,OAAO,CAAC,6BAA6B,CAAC,CA8HxC;IAED;;;;OAIG;IACH,OAAO,CAAC,sBAAsB,CA4D7B;IAED;;;;;;OAMG;IACH,oBAAoB,YAAa,MAAM,KAAG,gBAAgB,CAczD;IAED;;;OAGG;IACG,gBAAgB,CACpB,IAAI,CAAC,EAAE,uBAAuB,GAC7B,OAAO,CAAC,eAAe,EAAE,CAAC,CAiD5B;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,QAAQ,YACE,cAAc,KACrB,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAkMpC;IAED,gFAAgF;IAChF,mBAAmB,SAAgB,qBAAqB,oCAqBvD;CACF"}