@pack/hydrogen 0.0.3 → 0.0.5

package/dist/create-pack-client.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="@shopify/oxygen-workers-types" />
-import { PackClient } from '@pack/client';
-import { CacheLong } from '@shopify/hydrogen';
-import { PreviewSession } from './preview/preview-session';
+import { PackClient } from "@pack/client";
+import { CacheCustom } from "@shopify/hydrogen";
+import { PreviewSession } from "./preview/preview-session";
 /** @see https://shopify.dev/docs/custom-storefronts/hydrogen/data-fetching/cache#caching-strategies */
-type CachingStrategy = ReturnType<typeof CacheLong>;
+type CachingStrategy = ReturnType<typeof CacheCustom>;
 interface EnvironmentOptions {
     /**
      * A Cache API instance.
@@ -14,7 +14,7 @@ interface EnvironmentOptions {
      * A runtime utility for serverless environments
      * @see https://developers.cloudflare.com/workers/runtime-apis/fetch-event/#waituntil
      */
-    waitUntil: ExecutionContext['waitUntil'];
+    waitUntil: ExecutionContext["waitUntil"];
 }
 interface CreatePackClientOptions extends EnvironmentOptions {
     apiUrl?: string;
@@ -45,7 +45,7 @@ export interface Pack {
         session: PreviewSession;
     };
     query: <T = any>(query: string, options?: QueryOptions) => Promise<QueryResponse<T>>;
-    isValidEditToken: PackClient['isValidEditToken'];
+    isValidEditToken: PackClient["isValidEditToken"];
 }
 export declare function createPackClient(options: CreatePackClientOptions): Pack;
 export {};

package/dist/create-pack-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-pack-client.d.ts","sourceRoot":"","sources":["../src/create-pack-client.ts"],"names":[],"mappings":";AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,cAAc,CAAA;AACvC,OAAO,EAAC,SAAS,EAAkB,MAAM,mBAAmB,CAAA;AAE5D,OAAO,EAAC,cAAc,EAAC,MAAM,2BAA2B,CAAA;AAExD,uGAAuG;AACvG,KAAK,eAAe,GAAG,UAAU,CAAC,OAAO,SAAS,CAAC,CAAA;AAEnD,UAAU,kBAAkB;IAC1B;;;OAGG;IACH,KAAK,EAAE,KAAK,CAAA;IACZ;;;OAGG;IACH,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAA;CACzC;AAED,UAAU,uBAAwB,SAAQ,kBAAkB;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE;QACR,OAAO,EAAE,cAAc,CAAA;KACxB,CAAA;IACD,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,KAAK,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAEpC,UAAU,YAAY;IACpB,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB,KAAK,CAAC,EAAE,eAAe,CAAA;CACxB;AAED,UAAU,UAAU;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb;AAED,UAAU,aAAa,CAAC,CAAC;IACvB,IAAI,EAAE,CAAC,GAAG,IAAI,CAAA;IACd,KAAK,EAAE,UAAU,GAAG,IAAI,CAAA;CACzB;AAED,MAAM,WAAW,IAAI;IACnB,oBAAoB,EAAE,MAAM,OAAO,CAAA;IACnC,OAAO,CAAC,EAAE;QACR,OAAO,EAAE,cAAc,CAAA;KACxB,CAAA;IACD,KAAK,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAA;IACpF,gBAAgB,EAAE,UAAU,CAAC,kBAAkB,CAAC,CAAA;CACjD;AA8BD,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,IAAI,CA2CvE"}
+{"version":3,"file":"create-pack-client.d.ts","sourceRoot":"","sources":["../src/create-pack-client.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAmB,MAAM,mBAAmB,CAAC;AAEjE,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D,uGAAuG;AACvG,KAAK,eAAe,GAAG,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC;AAEtD,UAAU,kBAAkB;IAC1B;;;OAGG;IACH,KAAK,EAAE,KAAK,CAAC;IACb;;;OAGG;IACH,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;CAC1C;AAED,UAAU,uBAAwB,SAAQ,kBAAkB;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE;QACR,OAAO,EAAE,cAAc,CAAC;KACzB,CAAC;IACF,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,KAAK,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAErC,UAAU,YAAY;IACpB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,KAAK,CAAC,EAAE,eAAe,CAAC;CACzB;AAED,UAAU,UAAU;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,UAAU,aAAa,CAAC,CAAC;IACvB,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;IACf,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,IAAI;IACnB,oBAAoB,EAAE,MAAM,OAAO,CAAC;IACpC,OAAO,CAAC,EAAE;QACR,OAAO,EAAE,cAAc,CAAC;KACzB,CAAC;IACF,KAAK,EAAE,CAAC,CAAC,GAAG,GAAG,EACb,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,YAAY,KACnB,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/B,gBAAgB,EAAE,UAAU,CAAC,kBAAkB,CAAC,CAAC;CAClD;AAqCD,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,IAAI,CA6DvE"}

package/dist/create-pack-client.js

@@ -1,6 +1,6 @@
-import { PackClient } from '@pack/client';
-import { CacheLong, createWithCache } from '@shopify/hydrogen';
-const PRODUCTION_ENVIRONMENT = 'production';
+import { PackClient } from "@pack/client";
+import { CacheCustom, createWithCache } from "@shopify/hydrogen";
+const PRODUCTION_ENVIRONMENT = "production";
 /**
  * Create an SHA-256 hash as a hex string
  * @see https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest#converting_a_digest_to_a_hex_string
@@ -9,14 +9,14 @@ async function sha256(message) {
     // encode as UTF-8
     const messageBuffer = new TextEncoder().encode(message);
     // hash the message
-    const hashBuffer = await crypto.subtle.digest('SHA-256', messageBuffer);
+    const hashBuffer = await crypto.subtle.digest("SHA-256", messageBuffer);
     // convert bytes to hex string
     return Array.from(new Uint8Array(hashBuffer))
-        .map((b) => b.toString(16).padStart(2, '0'))
-        .join('');
+        .map((b) => b.toString(16).padStart(2, "0"))
+        .join("");
 }
 /**
- * Hash query and its parameters for use as cache key
+ * Hash query and its parameters for use as cache key.
  * NOTE: Oxygen deployment will break if the cache key is long or contains `\n`
  */
 function hashQuery(query, variables) {
@@ -25,20 +25,30 @@ function hashQuery(query, variables) {
         hash += JSON.stringify(variables);
     return sha256(hash);
 }
+// Extends the CacheLong strategy with a stale-if-error policy
+const cacheCustom = CacheCustom({
+    maxAge: 3600,
+    staleWhileRevalidate: 82800,
+    staleIfError: 86400, // 1 day
+});
 export function createPackClient(options) {
     const { cache, waitUntil, preview, contentEnvironment, token, apiUrl } = options;
-    const previewEnabled = !!preview?.session.get('enabled');
-    const previewEnvironment = preview?.session.get('environment');
+    const previewEnabled = !!preview?.session.get("enabled");
+    const previewEnvironment = preview?.session.get("environment");
     const clientContentEnvironment = previewEnvironment || contentEnvironment || PRODUCTION_ENVIRONMENT;
+    // Use live API URL if preview mode is enabled and no API URL is provided
+    const clientApiUrl = previewEnabled && !apiUrl
+        ? "https://apicdn.packdigital.com/graphql"
+        : apiUrl;
     const packClient = new PackClient({
-        apiUrl,
+        apiUrl: clientApiUrl,
         token,
         contentEnvironment: clientContentEnvironment,
     });
     return {
         preview,
         isPreviewModeEnabled: () => previewEnabled,
-        async query(query, { variables, cache: strategy = CacheLong() } = {}) {
+        async query(query, { variables, cache: strategy = cacheCustom } = {}) {
             const queryHash = await hashQuery(query, variables);
             const withCache = createWithCache({
                 cache,
@@ -46,15 +56,28 @@ export function createPackClient(options) {
             });
             const queryVariables = variables ? { ...variables } : {};
             if (previewEnabled) {
-                queryVariables.version = 'CURRENT';
+                queryVariables.version = "CURRENT";
             }
             else {
-                queryVariables.version = 'PUBLISHED';
+                queryVariables.version = "PUBLISHED";
             }
             // Preview mode always bypasses the cache
-            if (previewEnabled)
-                return packClient.fetch(query, { variables: queryVariables });
-            return withCache(queryHash, strategy, () => packClient.fetch(query, { variables: queryVariables }));
+            if (previewEnabled) {
+                try {
+                    return await packClient.fetch(query, { variables: queryVariables });
+                }
+                catch (error) {
+                    return { error, data: {} };
+                }
+            }
+            return withCache(queryHash, strategy, async () => {
+                try {
+                    return await packClient.fetch(query, { variables: queryVariables });
+                }
+                catch (error) {
+                    return { error, data: {} };
+                }
+            });
         },
         isValidEditToken: (token) => packClient.isValidEditToken(token),
     };

package/dist/preview/preview-mode.d.ts

@@ -1,4 +1,4 @@
-import { type ActionFunction, type LoaderFunction } from "@shopify/remix-oxygen";
+import { type ActionFunction, type LoaderFunction } from "@remix-run/server-runtime";
 type JsonFunction = <Data>(data: Data, init?: number | ResponseInit) => TypedResponse<Data>;
 type RedirectFunction = (url: string, init?: number | ResponseInit) => Response;
 type TypedResponse<T = unknown> = Omit<Response, "json"> & {

package/dist/preview/preview-mode.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"preview-mode.d.ts","sourceRoot":"","sources":["../../src/preview/preview-mode.tsx"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,cAAc,EACpB,MAAM,uBAAuB,CAAC;AAI/B,KAAK,YAAY,GAAG,CAAC,IAAI,EACvB,IAAI,EAAE,IAAI,EACV,IAAI,CAAC,EAAE,MAAM,GAAG,YAAY,KACzB,aAAa,CAAC,IAAI,CAAC,CAAC;AAEzB,KAAK,gBAAgB,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,YAAY,KAAK,QAAQ,CAAC;AAIhF,KAAK,aAAa,CAAC,CAAC,GAAG,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,GAAG;IACzD,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;CACpB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,IAAI,EAAE,YAYlB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,QAAQ,EAAE,gBAetB,CAAC;AAoBF;;;GAGG;AACH,eAAO,MAAM,MAAM,EAAE,cAkBpB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,MAAM,EAAE,cA+BpB,CAAC"}
+{"version":3,"file":"preview-mode.d.ts","sourceRoot":"","sources":["../../src/preview/preview-mode.tsx"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,cAAc,EACpB,MAAM,2BAA2B,CAAC;AAInC,KAAK,YAAY,GAAG,CAAC,IAAI,EACvB,IAAI,EAAE,IAAI,EACV,IAAI,CAAC,EAAE,MAAM,GAAG,YAAY,KACzB,aAAa,CAAC,IAAI,CAAC,CAAC;AAEzB,KAAK,gBAAgB,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,YAAY,KAAK,QAAQ,CAAC;AAIhF,KAAK,aAAa,CAAC,CAAC,GAAG,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,GAAG;IACzD,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;CACpB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,IAAI,EAAE,YAYlB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,QAAQ,EAAE,gBAetB,CAAC;AAoBF;;;GAGG;AACH,eAAO,MAAM,MAAM,EAAE,cAkBpB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,MAAM,EAAE,cA+BpB,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pack/hydrogen",
   "description": "Pack Hydrogen",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "engines": {
@@ -22,11 +22,15 @@
     "dist"
   ],
   "dependencies": {
-    "@pack/client": "^0.0.5",
+    "@pack/client": "^0.0.6",
     "@shopify/hydrogen": "^2023.10.2"
   },
   "devDependencies": {
+    "@remix-run/server-runtime": "^2.0.0",
     "@shopify/oxygen-workers-types": "^4.0.0",
     "@shopify/remix-oxygen": "^2.0.1"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0"
   }
 }