@pack/hydrogen 1.0.4 → 1.0.6-ab-test.0

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

@@ -2,6 +2,7 @@
 import { PackClient } from "@pack/client";
 import { CacheCustom } from "@shopify/hydrogen";
 import { PackSession } from "./session/session";
+import { Test, TestInput } from "./tests/test";
 /** @see https://shopify.dev/docs/custom-storefronts/hydrogen/data-fetching/cache#caching-strategies */
 type CachingStrategy = ReturnType<typeof CacheCustom>;
 interface EnvironmentOptions {
@@ -16,7 +17,7 @@ interface EnvironmentOptions {
      */
     waitUntil: ExecutionContext["waitUntil"];
 }
-interface CreatePackClientOptions extends EnvironmentOptions {
+export interface CreatePackClientOptions extends EnvironmentOptions {
     apiUrl?: string;
     token?: string;
     storeId?: string;
@@ -29,6 +30,7 @@ type Variables = Record<string, any>;
 interface QueryOptions {
     variables?: Variables;
     cache?: CachingStrategy;
+    test?: TestInput;
 }
 interface QueryError {
     message: string;
@@ -39,18 +41,40 @@ interface QueryError {
 interface QueryResponse<T> {
     data: T | null;
     error: QueryError | null;
+    packTestInfo?: Test;
+}
+export interface PackCustomizerMeta {
+    environment?: string;
+    overlay?: {
+        src?: string;
+        version?: string;
+    };
+    [key: string]: any;
 }
 export interface Pack {
-    isPreviewModeEnabled: () => boolean;
-    session: PackSession;
-    query: <T = any>(query: string, options?: QueryOptions) => Promise<QueryResponse<T>>;
-    isValidEditToken: PackClient["isValidEditToken"];
+    abTest: Test | null | undefined;
+    /**
+     * @deprecated The method should not be used
+     */
     getPackSessionData(): {
         storeId: string;
         sessionId: string;
+        abTest: Test | null | undefined;
         isPreviewModeEnabled: boolean;
         customizerMeta: any;
     };
+    getPackContextData(): {
+        packStoreId: string;
+        packSessionId: string;
+        packAbTest: Test | null | undefined;
+        packIsPreviewMode: boolean;
+        packCustomizerMeta: PackCustomizerMeta | null;
+    };
+    handleRequest(request: Request): Promise<(response: Response) => void>;
+    isPreviewModeEnabled: () => boolean;
+    isValidEditToken: PackClient["isValidEditToken"];
+    query: <T = any>(query: string, options?: QueryOptions) => Promise<QueryResponse<T>>;
+    session: PackSession;
 }
 interface DefaultThemeData {
     data: Record<string, any>;

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,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAmB,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,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,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,WAAW,CAAC;IACrB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,0DAA0D;IAC1D,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC;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,EAAE,WAAW,CAAC;IACrB,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;IAEjD,kBAAkB,IAAI;QACpB,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC;QAClB,oBAAoB,EAAE,OAAO,CAAC;QAC9B,cAAc,EAAE,GAAG,CAAC;KACrB,CAAC;CACH;AAED,UAAU,gBAAgB;IACxB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B;AAoJD,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,IAAI,CAwIvE"}
+{"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,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAML,IAAI,EACJ,SAAS,EAGV,MAAM,cAAc,CAAC;AAEtB,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,MAAM,WAAW,uBAAwB,SAAQ,kBAAkB;IACjE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,WAAW,CAAC;IACrB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,0DAA0D;IAC1D,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC;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;IACxB,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB;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;IACzB,YAAY,CAAC,EAAE,IAAI,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE;QACR,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,IAAI;IACnB,MAAM,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,kBAAkB,IAAI;QACpB,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC;QAChC,oBAAoB,EAAE,OAAO,CAAC;QAC9B,cAAc,EAAE,GAAG,CAAC;KACrB,CAAC;IACF,kBAAkB,IAAI;QACpB,WAAW,EAAE,MAAM,CAAC;QACpB,aAAa,EAAE,MAAM,CAAC;QACtB,UAAU,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC;QACpC,iBAAiB,EAAE,OAAO,CAAC;QAC3B,kBAAkB,EAAE,kBAAkB,GAAG,IAAI,CAAC;KAC/C,CAAC;IACF,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC,CAAC;IACvE,oBAAoB,EAAE,MAAM,OAAO,CAAC;IACpC,gBAAgB,EAAE,UAAU,CAAC,kBAAkB,CAAC,CAAC;IACjD,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,OAAO,EAAE,WAAW,CAAC;CACtB;AAED,UAAU,gBAAgB;IACxB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B;AAoJD,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,IAAI,CAgPvE"}

package/dist/create-pack-client.js

@@ -1,5 +1,7 @@
 import { PackClient } from "@pack/client";
 import { CacheCustom, createWithCache } from "@shopify/hydrogen";
+import cookie from "cookie";
+import { getTestInfo, getTestFromQueryParams, getTestSession, getTestTargetingAttributesFromRequest, setTestHeaders, } from "./tests/test";
 /**
  * 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
@@ -113,16 +115,70 @@ export function createPackClient(options) {
     const previewEnabled = !!session.get("previewEnabled");
     const previewEnvironment = session.get("environment");
     const clientContentEnvironment = previewEnvironment || contentEnvironment;
+    let packClient;
+    let testFromQueryParams = null;
+    let testInfoForRequest = undefined;
     if (!token && !defaultThemeData) {
         throw new Error("The Pack client token is missing or empty. Please provide a valid token or default theme data.");
     }
     if (!storeId) {
         throw new Error("The Pack Store ID is missing or empty. Please provide a valid Store ID.");
     }
+    const handleRequest = async (request) => {
+        testFromQueryParams = getTestFromQueryParams(request);
+        const testTargetAudienceAttributes = getTestTargetingAttributesFromRequest(request);
+        if (packClient) {
+            testInfoForRequest = await getTestInfo({
+                request,
+                testTargetAudienceAttributes,
+                packClient,
+                session,
+            });
+        }
+        return (response) => {
+            const hasExposedTestCookie = request.headers
+                .get("cookie")
+                ?.includes("exposedTest");
+            if (hasExposedTestCookie) {
+                // Clear the exposedTest cookie
+                response.headers.set("Set-Cookie", cookie.serialize("exposedTest", "", {
+                    maxAge: 0,
+                }));
+            }
+        };
+    };
+    const getTestInfoForLoader = () => {
+        let testInfoForLoader = undefined;
+        if (testInfoForRequest?.isFirstExposure) {
+            const { isFirstExposure, ...testInfo } = testInfoForRequest;
+            testInfoForLoader = testInfo;
+        }
+        return testInfoForLoader;
+    };
     if (!token) {
         return {
-            session,
+            abTest: getTestSession(session, testFromQueryParams, previewEnabled),
+            handleRequest,
+            getPackSessionData: () => {
+                return {
+                    storeId: storeId,
+                    sessionId: session.id,
+                    abTest: getTestSession(session, testFromQueryParams, previewEnabled),
+                    isPreviewModeEnabled: previewEnabled,
+                    customizerMeta: session.get("customizerMeta"),
+                };
+            },
+            getPackContextData: () => {
+                return {
+                    packStoreId: storeId,
+                    packSessionId: session.id,
+                    packAbTest: getTestSession(session, testFromQueryParams, previewEnabled),
+                    packIsPreviewMode: previewEnabled,
+                    packCustomizerMeta: session.get("customizerMeta"),
+                };
+            },
             isPreviewModeEnabled: () => previewEnabled,
+            isValidEditToken: () => new Promise(() => false),
             async query(query, { variables } = {}) {
                 if (!defaultThemeData?.data) {
                     console.warn("Invalid default theme data provided to Pack client.");
@@ -131,18 +187,10 @@ export function createPackClient(options) {
                 const data = resolveQuery({ query, variables, defaultThemeData });
                 return { data: data, error: null };
             },
-            isValidEditToken: () => new Promise(() => false),
-            getPackSessionData: () => {
-                return {
-                    storeId: storeId,
-                    sessionId: session.id,
-                    isPreviewModeEnabled: previewEnabled,
-                    customizerMeta: session.get("customizerMeta"),
-                };
-            },
+            session,
         };
     }
-    const packClient = new PackClient({
+    packClient = new PackClient({
         // Use apiUrl, it is configured
         // Use active API URL if preview mode is enabled
         // Otherwise, Live PackClient uses its internal configuration
@@ -157,16 +205,40 @@ export function createPackClient(options) {
         sessionId: session.id,
         clientName: "HydrogenClient",
     });
-    console.log("*** packClient.apiUrl", packClient.apiUrl);
     return {
-        session,
+        abTest: getTestSession(session, testFromQueryParams, previewEnabled),
+        getPackSessionData: () => {
+            return {
+                storeId: storeId,
+                sessionId: session.id,
+                abTest: getTestSession(session, testFromQueryParams, previewEnabled),
+                isPreviewModeEnabled: previewEnabled,
+                customizerMeta: session.get("customizerMeta"),
+            };
+        },
+        getPackContextData: () => {
+            return {
+                packStoreId: storeId,
+                packSessionId: session.id,
+                packAbTest: getTestSession(session, testFromQueryParams, previewEnabled),
+                packIsPreviewMode: previewEnabled,
+                packCustomizerMeta: session.get("customizerMeta"),
+            };
+        },
+        handleRequest,
         isPreviewModeEnabled: () => previewEnabled,
-        async query(query, { variables, cache: strategy = cacheCustom } = {}) {
+        isValidEditToken: (token) => packClient.isValidEditToken(token),
+        async query(query, { variables, cache: strategy = cacheCustom, test } = {}) {
+            let headers = {};
             const withCache = createWithCache({
                 cache,
                 waitUntil,
             });
-            let headers = {};
+            headers = setTestHeaders(headers, {
+                previewEnabled,
+                testInfoForRequest,
+                testFromQueryParams: testFromQueryParams || test,
+            });
             const queryVariables = variables ? { ...variables } : {};
             if (previewEnabled) {
                 queryVariables.version = "CURRENT";
@@ -174,23 +246,27 @@ export function createPackClient(options) {
             else {
                 queryVariables.version = "PUBLISHED";
             }
+            const testInfoForLoader = getTestInfoForLoader();
             // Preview mode always bypasses the cache
             if (previewEnabled) {
                 try {
-                    return await packClient.fetch(query, {
-                        variables: queryVariables,
-                        headers: headers,
-                    });
+                    return {
+                        ...(await packClient.fetch(query, {
+                            variables: queryVariables,
+                            headers: headers,
+                        })),
+                        packTestInfo: testInfoForLoader,
+                    };
                 }
                 catch (error) {
-                    return { error, data: {} };
+                    return { error: error, data: null };
                 }
             }
             const queryHash = await getCacheKey(withCache, query, token, {
                 variables: queryVariables,
                 headers,
             });
-            return withCache(queryHash, strategy, async () => {
+            const response = await withCache(queryHash, strategy, async () => {
                 try {
                     return await packClient.fetch(query, {
                         variables: queryVariables,
@@ -198,18 +274,13 @@ export function createPackClient(options) {
                     });
                 }
                 catch (error) {
-                    return { error, data: {} };
+                    return { error, data: null };
                 }
             });
+            return response.error
+                ? response
+                : { ...response, packTestInfo: testInfoForLoader };
         },
-        isValidEditToken: (token) => packClient.isValidEditToken(token),
-        getPackSessionData: () => {
-            return {
-                storeId: storeId,
-                sessionId: session.id,
-                isPreviewModeEnabled: previewEnabled,
-                customizerMeta: session.get("customizerMeta"),
-            };
-        },
+        session,
     };
 }

package/dist/handle-request.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"handle-request.d.ts","sourceRoot":"","sources":["../src/handle-request.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAG5C,wBAAsB,aAAa,CACjC,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,OAAO,EAChB,aAAa,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,QAAQ,CAAC,GACrD,OAAO,CAAC,QAAQ,CAAC,CASnB"}
+{"version":3,"file":"handle-request.d.ts","sourceRoot":"","sources":["../src/handle-request.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAG5C,wBAAsB,aAAa,CACjC,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,OAAO,EAChB,aAAa,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,QAAQ,CAAC,GACrD,OAAO,CAAC,QAAQ,CAAC,CAanB"}

package/dist/handle-request.js

@@ -1,8 +1,10 @@
 import { packlytics } from "@pack/packlytics";
 export async function handleRequest(pack, request, handleRequest) {
+    const packHandleResponse = await pack.handleRequest(request);
     const response = await packlytics(pack, request, () => {
         return handleRequest(request);
     });
+    packHandleResponse(response);
     response.headers.append("powered-by", "Shopify, Hydrogen + Pack Digital");
     response.headers.append("Set-Cookie", await pack.session.commit());
     return response;

package/dist/index.d.ts

@@ -1,7 +1,9 @@
 import { handleRequest } from "./handle-request";
 import { usePackCookies } from "./session/usePackCookies";
 import { PackSession } from "./session/session";
-import { createPackClient } from "./create-pack-client";
+import { Pack, createPackClient } from "./create-pack-client";
 import { action as previewModeAction, loader as previewModeLoader } from "./preview/preview-mode";
-export { PackSession, createPackClient, handleRequest, previewModeAction, previewModeLoader, usePackCookies, };
+import { PackTestContext, usePackTestContext, PackTestProvider, PackTestRoute, useAbTest, useAbTestId, useAbTestHandle, useAbTestSessionId, useAbTestVariantId, useAbTestVariantHandle } from "./tests";
+export type { Pack };
+export { PackSession, createPackClient, handleRequest, previewModeAction, previewModeLoader, usePackCookies, PackTestContext, usePackTestContext, PackTestProvider, PackTestRoute, useAbTest, useAbTestId, useAbTestHandle, useAbTestSessionId, useAbTestVariantId, useAbTestVariantHandle, };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EACL,MAAM,IAAI,iBAAiB,EAC3B,MAAM,IAAI,iBAAiB,EAC5B,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,cAAc,GACf,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EACL,MAAM,IAAI,iBAAiB,EAC3B,MAAM,IAAI,iBAAiB,EAC5B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,eAAe,EACf,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,SAAS,EACT,WAAW,EACX,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,sBAAsB,EACvB,MAAM,SAAS,CAAC;AAEjB,YAAY,EAAE,IAAI,EAAE,CAAC;AAErB,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,SAAS,EACT,WAAW,EACX,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,sBAAsB,GACvB,CAAC"}

package/dist/index.js

@@ -3,4 +3,5 @@ import { usePackCookies } from "./session/usePackCookies";
 import { PackSession } from "./session/session";
 import { createPackClient } from "./create-pack-client";
 import { action as previewModeAction, loader as previewModeLoader, } from "./preview/preview-mode";
-export { PackSession, createPackClient, handleRequest, previewModeAction, previewModeLoader, usePackCookies, };
+import { PackTestContext, usePackTestContext, PackTestProvider, PackTestRoute, useAbTest, useAbTestId, useAbTestHandle, useAbTestSessionId, useAbTestVariantId, useAbTestVariantHandle, } from "./tests";
+export { PackSession, createPackClient, handleRequest, previewModeAction, previewModeLoader, usePackCookies, PackTestContext, usePackTestContext, PackTestProvider, PackTestRoute, useAbTest, useAbTestId, useAbTestHandle, useAbTestSessionId, useAbTestVariantId, useAbTestVariantHandle, };

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,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,cAwCpB,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;AAKnC,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,cA0CpB,CAAC"}

package/dist/preview/preview-mode.js

@@ -88,7 +88,9 @@ export const loader = async function ({ request, context }) {
     }
     let customizerMetaJson;
     try {
-        customizerMetaJson = customizerMeta ? JSON.parse(customizerMeta) : null;
+        customizerMetaJson = customizerMeta
+            ? JSON.parse(customizerMeta)
+            : null;
     }
     catch (_error) {
         customizerMetaJson = null;

package/dist/session/cookies-utils.js

@@ -1,5 +1,5 @@
 import { PACK_USER_CONSENT_COOKIE_ID } from "../constants";
-const cookie = require("cookie");
+import cookie from "cookie";
 const tokenHash = "xxxx-4xxx-xxxx-xxxxxxxxxxxx";
 export function hasUserConsent(request) {
     const cookies = cookie.parse(request.headers.get("Cookie"));

package/dist/tests/test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../../src/tests/test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGjD,MAAM,WAAW,SAAS;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE;QACX,EAAE,EAAE,MAAM,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,MAAM,WAAW,4BAA4B;IAC3C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAqBD,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,4BAA4B,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAClE,UAAU,EAAE,UAAU,CAAC;IACvB,OAAO,EAAE,WAAW,GAAG,SAAS,CAAC;CAClC;AAED,MAAM,WAAW,QAAS,SAAQ,IAAI;IACpC,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,wBAAsB,WAAW,CAAC,EAChC,OAAO,EACP,4BAA4B,EAC5B,UAAU,EACV,OAAO,GACR,EAAE,kBAAkB,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAuHpD;AAED,wBAAgB,cAAc,CAC5B,OAAO,EAAE,WAAW,GAAG,SAAS,EAChC,mBAAmB,EAAE,SAAS,GAAG,IAAI,EACrC,cAAc,EAAE,OAAO,GACtB,IAAI,GAAG,IAAI,GAAG,SAAS,CA8BzB;AAED,wBAAgB,qCAAqC,CACnD,OAAO,EAAE,OAAO,GACf,4BAA4B,CA0B9B;AAED,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI,CA2CzE;AAED,wBAAgB,cAAc,CAC5B,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE;IACP,cAAc,EAAE,OAAO,CAAC;IACxB,kBAAkB,CAAC,EAAE,QAAQ,CAAC;IAC9B,mBAAmB,CAAC,EAAE,SAAS,CAAC;CACjC,OAgCF"}
+{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../../src/tests/test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGjD,MAAM,WAAW,SAAS;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE;QACX,EAAE,EAAE,MAAM,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,MAAM,WAAW,4BAA4B;IAC3C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAqBD,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,4BAA4B,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAClE,UAAU,EAAE,UAAU,CAAC;IACvB,OAAO,EAAE,WAAW,GAAG,SAAS,CAAC;CAClC;AAED,MAAM,WAAW,QAAS,SAAQ,IAAI;IACpC,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AA+DD,wBAAsB,WAAW,CAAC,EAChC,OAAO,EACP,4BAA4B,EAC5B,UAAU,EACV,OAAO,GACR,EAAE,kBAAkB,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CA4DpD;AAED,wBAAgB,cAAc,CAC5B,OAAO,EAAE,WAAW,GAAG,SAAS,EAChC,mBAAmB,EAAE,SAAS,GAAG,IAAI,EACrC,cAAc,EAAE,OAAO,GACtB,IAAI,GAAG,IAAI,GAAG,SAAS,CA8BzB;AAED,wBAAgB,qCAAqC,CACnD,OAAO,EAAE,OAAO,GACf,4BAA4B,CA0B9B;AAED,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI,CA2CzE;AAED,wBAAgB,cAAc,CAC5B,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE;IACP,cAAc,EAAE,OAAO,CAAC;IACxB,kBAAkB,CAAC,EAAE,QAAQ,CAAC;IAC9B,mBAAmB,CAAC,EAAE,SAAS,CAAC;CACjC,OA+BF"}

package/dist/tests/test.js

@@ -16,99 +16,89 @@ const QUERY_TEST_VARIANT_IS_RUNNING = `#graphql
     testVariantIsRunning(handle: $handle, testId: $testId)
   }
 `;
-export async function getTestInfo({ request, testTargetAudienceAttributes, packClient, session, }) {
-    let testInfo = undefined;
-    if (session) {
-        // Request directly to API if it is using CDN to reduce latency
-        let isUsingCdn = false;
-        if (packClient.apiUrl === "https://apicdn.packdigital.com/graphql") {
-            packClient.apiUrl = "https://app.packdigital.com/graphql";
-            isUsingCdn = true;
-        }
-        const packClientFetchTestByRules = packClient.fetch(QUERY_TEST_BY_RULES, {
+async function packClientFetchTestByRules(packClient, testTargetAudienceAttributes) {
+    let resp = undefined;
+    // Check if are using CDN or a custom endpoint if so
+    // Request directly to API if it is using CDN to reduce latency
+    const isUsingCdn = packClient.apiUrl === "https://apicdn.packdigital.com/graphql";
+    if (isUsingCdn) {
+        packClient.apiUrl = "https://app.packdigital.com/graphql";
+    }
+    try {
+        const packClientFetchTestByRules = await packClient.fetch(QUERY_TEST_BY_RULES, {
             variables: {
                 testTargetAudienceAttributes,
             },
         });
-        const fetchTestByRulesSetTestInfoAsFirstExposure = async () => {
-            const resp = await packClientFetchTestByRules;
-            const responseTest = resp.data?.testByRules;
-            if (responseTest) {
-                testInfo = {
-                    ...responseTest,
-                    isFirstExposure: true,
-                };
-            }
-            else {
-                session.set("test", undefined);
-            }
-        };
-        const testSession = session.get("test");
-        let exposedTest = undefined;
-        const exposedTestCookieString = cookie.parse(request.headers.get("cookie") || "")?.exposedTest;
-        if (exposedTestCookieString) {
-            exposedTest = JSON.parse(exposedTestCookieString);
-        }
-        // If there is no assigned test on the session and an exposed test in the
-        // incoming request cookie it means that the user was exposed to a test
-        // for the first time previously.
-        if (!testSession && exposedTest) {
-            // Verify test is still running
-            const resp = await packClient.fetch(QUERY_TEST_VARIANT_IS_RUNNING, {
-                variables: {
-                    handle: exposedTest.testVariant.handle,
-                    testId: exposedTest.id,
-                },
-            });
-            // If the test is still running, set testInfo to the exposed test
-            if (!!resp.data.testVariantIsRunning) {
-                const { id, handle, testVariant } = exposedTest;
-                testInfo = {
-                    id,
-                    handle,
-                    testVariant,
-                };
-                session.set("test", {
-                    data: testInfo,
-                });
-            }
-            else {
-                // If the test is not running anymore, fetch a new test for the user
-                await fetchTestByRulesSetTestInfoAsFirstExposure();
-            }
+        if (packClientFetchTestByRules.data?.testByRules) {
+            resp = {
+                ...packClientFetchTestByRules.data?.testByRules,
+                isFirstExposure: true,
+            };
         }
-        else {
-            if (!testSession ||
-                !(testSession.data?.id && testSession.data?.testVariant)) {
-                // If there is no assigned test on the session, check if there is a test
-                // for attributes, then assign to session and return value.
-                await fetchTestByRulesSetTestInfoAsFirstExposure();
-            }
-            else {
-                // If there is test on session, check if the test on session is still running.
-                const packClientFetchTestVariantIsRunning = packClient.fetch(QUERY_TEST_VARIANT_IS_RUNNING, {
-                    variables: {
-                        handle: testSession.data.testVariant.handle,
-                        testId: testSession.data.id,
-                    },
-                });
-                const resp = await packClientFetchTestVariantIsRunning;
-                if (!!resp.data.testVariantIsRunning) {
-                    // If true, set testInfo to the testSession assigned test.
-                    testInfo = testSession.data;
-                }
-                else {
-                    // If not running, clear test session and fetch a new test for the user
-                    session.set("test", undefined);
-                    await fetchTestByRulesSetTestInfoAsFirstExposure();
-                }
-            }
+    }
+    catch (e) {
+        console.error(e);
+    }
+    // Return to CDN
+    if (isUsingCdn) {
+        packClient.apiUrl = "https://apicdn.packdigital.com/graphql";
+    }
+    return resp;
+}
+async function packClientCheckTestIsRunning(packClient, testSession) {
+    try {
+        const resp = await packClient.fetch(QUERY_TEST_VARIANT_IS_RUNNING, {
+            variables: {
+                handle: testSession.testVariant.handle,
+                testId: testSession.id,
+            },
+        });
+        return !!resp.data.testVariantIsRunning;
+    }
+    catch (e) {
+        console.error(e);
+    }
+    return false;
+}
+export async function getTestInfo({ request, testTargetAudienceAttributes, packClient, session, }) {
+    let testInfo = undefined;
+    let exposedTest = undefined;
+    if (!session) {
+        return testInfo;
+    }
+    const testSession = session.get("test");
+    const exposedTestCookieString = cookie.parse(request.headers.get("cookie") || "")?.exposedTest;
+    if (exposedTestCookieString) {
+        exposedTest = JSON.parse(exposedTestCookieString);
+    }
+    // If there is test on session, check if the test on session is still running.
+    if (testSession && testSession.data?.id && testSession.data?.testVariant) {
+        const testVariantIsRunning = await packClientCheckTestIsRunning(packClient, testSession.data);
+        // If true, set testInfo to the testSession assigned test.
+        if (testVariantIsRunning) {
+            testInfo = testSession.data;
         }
-        if (isUsingCdn) {
-            // Return to CDN
-            packClient.apiUrl = "https://apicdn.packdigital.com/graphql";
+    }
+    else if (exposedTest) {
+        // If there is no assigned test on the session and an exposed test in the
+        // incoming request cookie it means that the user was exposed to a test previously.
+        // Verify test is still running
+        const testVariantIsRunning = await packClientCheckTestIsRunning(packClient, exposedTest);
+        // If the test is still running, set testInfo to the exposed test
+        if (testVariantIsRunning) {
+            testInfo = exposedTest;
         }
     }
+    // If the testInfo is not setup that means that is not a valid test
+    // on the session or on the cookie, then fetch a new test for the user
+    if (!testInfo) {
+        testInfo = await packClientFetchTestByRules(packClient, testTargetAudienceAttributes);
+    }
+    // save this test on the session
+    session.set("test", {
+        data: testInfo,
+    });
     return testInfo;
 }
 export function getTestSession(session, testFromQueryParams, previewEnabled) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pack/hydrogen",
   "description": "Pack Hydrogen",
-  "version": "1.0.4",
+  "version": "1.0.6-ab-test.0",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "engines": {
@@ -22,14 +22,17 @@
     "dist"
   ],
   "dependencies": {
-    "@pack/client": "^1.0.1",
+    "@pack/client": "^1.0.1-ab-test.0",
     "@pack/packlytics": "^1.0.1",
-    "@shopify/hydrogen": "^2023.10.2"
+    "@shopify/hydrogen": "^2023.10.2",
+    "cookie": "^0.6.0",
+    "js-cookie": "^3.0.5"
   },
   "devDependencies": {
     "@remix-run/server-runtime": "^2.0.0",
     "@shopify/oxygen-workers-types": "^4.0.0",
     "@shopify/remix-oxygen": "^2.0.1",
+    "@types/js-cookie": "^3.0.6",
     "@types/node": "^20.11.17"
   },
   "peerDependencies": {