@pack/hydrogen 1.0.0 → 1.0.1-ab-test.1

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,22 @@ interface QueryError {
 interface QueryResponse<T> {
     data: T | null;
     error: QueryError | null;
+    testInfo?: Test;
 }
 export interface Pack {
-    isPreviewModeEnabled: () => boolean;
-    session: PackSession;
-    query: <T = any>(query: string, options?: QueryOptions) => Promise<QueryResponse<T>>;
-    isValidEditToken: PackClient["isValidEditToken"];
+    abTest: Test | null | undefined;
     getPackSessionData(): {
         storeId: string;
         sessionId: string;
+        abTest: Test | null | undefined;
         isPreviewModeEnabled: boolean;
         customizerMeta: any;
     };
+    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;IACjD,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;AA2FD,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,IAAI,CAkIvE"}
+{"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,QAAQ,CAAC,EAAE,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,IAAI;IACnB,MAAM,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC;IAChC,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,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;AA2FD,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,IAAI,CAsMvE"}

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
@@ -76,16 +78,61 @@ 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"),
+                };
+            },
             isPreviewModeEnabled: () => previewEnabled,
+            isValidEditToken: () => new Promise(() => false),
             async query(query, { variables } = {}) {
                 if (!defaultThemeData?.data) {
                     console.warn("Invalid default theme data provided to Pack client.");
@@ -94,18 +141,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
@@ -120,14 +159,30 @@ export function createPackClient(options) {
         sessionId: session.id,
     });
     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"),
+            };
+        },
+        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 queryHash = await hashQuery(query, variables, headers);
             const queryVariables = variables ? { ...variables } : {};
             if (previewEnabled) {
@@ -136,19 +191,23 @@ 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,
+                        })),
+                        testInfo: testInfoForLoader,
+                    };
                 }
                 catch (error) {
                     return { error, data: {} };
                 }
             }
-            return withCache(queryHash, strategy, async () => {
+            const response = await withCache(queryHash, strategy, async () => {
                 try {
                     return await packClient.fetch(query, {
                         variables: queryVariables,
@@ -159,15 +218,10 @@ export function createPackClient(options) {
                     return { error, data: {} };
                 }
             });
+            return response.error
+                ? response
+                : { ...response, testInfo: 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,CAanB"}
+{"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,CAiBnB"}

package/dist/handle-request.js

@@ -1,12 +1,14 @@
 import { packlytics } from "@pack/packlytics";
 export async function handleRequest(pack, request, handleRequest) {
-    const [response, _] = await Promise.all([
+    const packHandleResponse = await pack.handleRequest(request);
+    const [response] = await Promise.all([
         handleRequest(request),
         packlytics(request, pack.session, {
             storeFrontId: pack.getPackSessionData().storeId,
             sessionSecret: pack.session.secret,
         }),
     ]);
+    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

@@ -3,5 +3,6 @@ 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, };
 //# 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,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,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,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/tests/hooks.d.ts

@@ -0,0 +1,8 @@
+import { Test } from "./test";
+export declare function useAbTest(): Test | null;
+export declare function useAbTestSessionId(): string;
+export declare function useAbTestId(): string | undefined;
+export declare function useAbTestHandle(): string | undefined;
+export declare function useAbTestVariantId(): string | undefined;
+export declare function useAbTestVariantHandle(): string | undefined;
+//# sourceMappingURL=hooks.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../src/tests/hooks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAG9B,wBAAgB,SAAS,IAAI,IAAI,GAAG,IAAI,CAWvC;AAED,wBAAgB,kBAAkB,IAAI,MAAM,CAW3C;AAED,wBAAgB,WAAW,IAAI,MAAM,GAAG,SAAS,CAIhD;AAED,wBAAgB,eAAe,IAAI,MAAM,GAAG,SAAS,CAIpD;AAED,wBAAgB,kBAAkB,IAAI,MAAM,GAAG,SAAS,CAIvD;AAED,wBAAgB,sBAAsB,IAAI,MAAM,GAAG,SAAS,CAI3D"}

package/dist/tests/hooks.js

@@ -0,0 +1,33 @@
+import { useRouteLoaderData } from "@remix-run/react";
+export function useAbTest() {
+    // @ts-ignore
+    const { abTest: test } = useRouteLoaderData("root");
+    if (test === undefined) {
+        throw new Error("No A/B test found, are you sure you have call ...pack.getPackSessionData() on root loader return?");
+    }
+    return test;
+}
+export function useAbTestSessionId() {
+    // @ts-ignore
+    const { sessionId } = useRouteLoaderData("root");
+    if (!sessionId) {
+        throw new Error("No Session ID found, are you sure you have call ...pack.getPackSessionData() on root loader return?");
+    }
+    return sessionId;
+}
+export function useAbTestId() {
+    const test = useAbTest();
+    return test?.id;
+}
+export function useAbTestHandle() {
+    const test = useAbTest();
+    return test?.handle;
+}
+export function useAbTestVariantId() {
+    const test = useAbTest();
+    return test?.testVariant?.id;
+}
+export function useAbTestVariantHandle() {
+    const test = useAbTest();
+    return test?.testVariant?.handle;
+}

package/dist/tests/index.d.ts

@@ -0,0 +1,6 @@
+import { PackTestRoute } from "./pack-test-route";
+import { PackTestContext, usePackTestContext } from "./pack-test-context";
+import { PackTestProvider } from "./pack-test-provider";
+import { useAbTest, useAbTestHandle, useAbTestId, useAbTestSessionId, useAbTestVariantHandle, useAbTestVariantId } from "./hooks";
+export { PackTestContext, usePackTestContext, PackTestProvider, PackTestRoute, useAbTest, useAbTestId, useAbTestHandle, useAbTestSessionId, useAbTestVariantId, useAbTestVariantHandle, };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/tests/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EACL,SAAS,EACT,eAAe,EACf,WAAW,EACX,kBAAkB,EAClB,sBAAsB,EACtB,kBAAkB,EACnB,MAAM,SAAS,CAAC;AAEjB,OAAO,EACL,eAAe,EACf,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,SAAS,EACT,WAAW,EACX,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,sBAAsB,GACvB,CAAC"}

package/dist/tests/index.js

@@ -0,0 +1,5 @@
+import { PackTestRoute } from "./pack-test-route";
+import { PackTestContext, usePackTestContext } from "./pack-test-context";
+import { PackTestProvider } from "./pack-test-provider";
+import { useAbTest, useAbTestHandle, useAbTestId, useAbTestSessionId, useAbTestVariantHandle, useAbTestVariantId, } from "./hooks";
+export { PackTestContext, usePackTestContext, PackTestProvider, PackTestRoute, useAbTest, useAbTestId, useAbTestHandle, useAbTestSessionId, useAbTestVariantId, useAbTestVariantHandle, };

package/dist/tests/pack-test-context.d.ts

@@ -0,0 +1,15 @@
+export interface Test {
+    id: string;
+    handle: string;
+    testVariant: {
+        id: string;
+        handle: string;
+    };
+}
+type PackTestContextValue = {
+    testExposureCallback?: (test: Test) => void;
+};
+export declare const PackTestContext: import("react").Context<PackTestContextValue>;
+export declare const usePackTestContext: () => PackTestContextValue;
+export {};
+//# sourceMappingURL=pack-test-context.d.ts.map

package/dist/tests/pack-test-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pack-test-context.d.ts","sourceRoot":"","sources":["../../src/tests/pack-test-context.ts"],"names":[],"mappings":"AAEA,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,KAAK,oBAAoB,GAAG;IAC1B,oBAAoB,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;CAC7C,CAAC;AAEF,eAAO,MAAM,eAAe,+CAA0C,CAAC;AAEvE,eAAO,MAAM,kBAAkB,4BAAoC,CAAC"}

package/dist/tests/pack-test-context.js

@@ -0,0 +1,3 @@
+import { createContext, useContext } from "react";
+export const PackTestContext = createContext({});
+export const usePackTestContext = () => useContext(PackTestContext);

package/dist/tests/pack-test-provider.d.ts

@@ -0,0 +1,8 @@
+import React, { PropsWithChildren } from "react";
+import { Test } from "./pack-test-context";
+interface PackContentProps {
+    testExposureCallback?: (test: Test) => void;
+}
+export declare function PackTestProvider({ children, testExposureCallback, }: PropsWithChildren<PackContentProps>): React.JSX.Element;
+export {};
+//# sourceMappingURL=pack-test-provider.d.ts.map

package/dist/tests/pack-test-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pack-test-provider.d.ts","sourceRoot":"","sources":["../../src/tests/pack-test-provider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AACjD,OAAO,EAAmB,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAE5D,UAAU,gBAAgB;IACxB,oBAAoB,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;CAC7C;AAED,wBAAgB,gBAAgB,CAAC,EAC/B,QAAQ,EACR,oBAAoB,GACrB,EAAE,iBAAiB,CAAC,gBAAgB,CAAC,qBAYrC"}

package/dist/tests/pack-test-provider.js

@@ -0,0 +1,9 @@
+import React from "react";
+import { PackTestContext } from "./pack-test-context";
+export function PackTestProvider({ children, testExposureCallback, }) {
+    return (React.createElement(PackTestContext.Provider, { value: {
+            testExposureCallback: (test) => {
+                testExposureCallback && testExposureCallback(test);
+            },
+        } }, children));
+}

package/dist/tests/pack-test-route.d.ts

@@ -0,0 +1,2 @@
+export declare const PackTestRoute: () => null;
+//# sourceMappingURL=pack-test-route.d.ts.map

package/dist/tests/pack-test-route.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pack-test-route.d.ts","sourceRoot":"","sources":["../../src/tests/pack-test-route.ts"],"names":[],"mappings":"AAuCA,eAAO,MAAM,aAAa,YAIzB,CAAC"}

package/dist/tests/pack-test-route.js

@@ -0,0 +1,29 @@
+import { useLoaderData } from "@remix-run/react";
+import Cookies from "js-cookie";
+import { useEffect } from "react";
+import { useRevalidator } from "react-router-dom";
+import { usePackTestContext } from "./pack-test-context";
+const usePackLoaderData = () => {
+    const { testInfo } = useLoaderData();
+    const { testExposureCallback } = usePackTestContext();
+    const revalidator = useRevalidator();
+    const exposedTestCookieString = Cookies.get("exposedTest");
+    useEffect(() => {
+        if (testInfo && !exposedTestCookieString) {
+            // Set exposedTest cookie used by server to determine if session has been exposed to test
+            const expires = new Date();
+            expires.setHours(expires.getHours() + 24);
+            Cookies.set("exposedTest", JSON.stringify(testInfo), {
+                expires,
+            });
+            testExposureCallback?.(testInfo);
+            // TODO: This results in flashing of UI driven by site settings data.
+            // Need non-flashing solution.
+            revalidator.revalidate();
+        }
+    }, [testInfo, testExposureCallback]);
+};
+export const PackTestRoute = () => {
+    usePackLoaderData();
+    return null;
+};

package/dist/tests/test.d.ts

@@ -0,0 +1,45 @@
+import { PackClient } from "@pack/client";
+import { PackSession } from "../session/session";
+export interface TestInput {
+    testId?: string;
+    testHandle?: string;
+    testVariantId?: string;
+    testVariantHandle?: string;
+}
+export interface Test {
+    id: string;
+    handle: string;
+    testVariant: {
+        id: string;
+        handle: string;
+    };
+}
+export interface TestTargetAudienceAttributes {
+    url?: string;
+    query?: string;
+    path?: string;
+    utmCampaign?: string;
+    utmContent?: string;
+    utmMedium?: string;
+    utmSource?: string;
+    utmTerm?: string;
+}
+export interface GetTestInfoOptions {
+    request: Request;
+    testTargetAudienceAttributes: TestTargetAudienceAttributes | null;
+    packClient: PackClient;
+    session: PackSession | undefined;
+}
+export interface TestInfo extends Test {
+    isFirstExposure?: boolean;
+}
+export declare function getTestInfo({ request, testTargetAudienceAttributes, packClient, session, }: GetTestInfoOptions): Promise<TestInfo | undefined>;
+export declare function getTestSession(session: PackSession | undefined, testFromQueryParams: TestInput | null, previewEnabled: boolean): Test | null | undefined;
+export declare function getTestTargetingAttributesFromRequest(request: Request): TestTargetAudienceAttributes;
+export declare function getTestFromQueryParams(request: Request): TestInput | null;
+export declare function setTestHeaders(headers: any, options: {
+    previewEnabled: boolean;
+    testInfoForRequest?: TestInfo;
+    testFromQueryParams?: TestInput;
+}): any;
+//# sourceMappingURL=test.d.ts.map

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

@@ -0,0 +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,CAmHpD;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,OAmCF"}

package/dist/tests/test.js

@@ -0,0 +1,228 @@
+import cookie from "cookie";
+const QUERY_TEST_BY_RULES = `#graphql
+  query TestByRules($testTargetAudienceAttributes: JSON!) {
+    testByRules(attributes: $testTargetAudienceAttributes) {
+      id
+      handle
+      testVariant: TestVariant {
+        id
+        handle
+      }
+    }
+  }
+`;
+const QUERY_TEST_VARIANT_IS_RUNNING = `#graphql
+  query TestVariantIsRunning($handle: String!, $testId: ID!) {
+    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, {
+            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();
+            }
+        }
+        else {
+            if (!testSession) {
+                // 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();
+                }
+            }
+        }
+        if (isUsingCdn) {
+            // Return to CDN
+            packClient.apiUrl = "https://apicdn.packdigital.com/graphql";
+        }
+    }
+    return testInfo;
+}
+export function getTestSession(session, testFromQueryParams, previewEnabled) {
+    if (testFromQueryParams) {
+        return {
+            id: testFromQueryParams.testId || "",
+            handle: testFromQueryParams.testHandle || "",
+            testVariant: {
+                id: testFromQueryParams.testVariantId || "",
+                handle: testFromQueryParams.testVariantHandle || "",
+            },
+        };
+    }
+    if (previewEnabled) {
+        return {
+            id: "",
+            handle: "isPreview",
+            testVariant: {
+                id: "",
+                handle: "isPreview",
+            },
+        };
+    }
+    if (!session) {
+        return undefined;
+    }
+    const testSession = session.get("test");
+    return testSession?.data || null;
+}
+export function getTestTargetingAttributesFromRequest(request) {
+    let testTargetingAttributes = {};
+    const requestUrl = new URL(request.url);
+    const searchParams = requestUrl.searchParams;
+    testTargetingAttributes.url = requestUrl.origin + requestUrl.pathname;
+    testTargetingAttributes.query = requestUrl.search;
+    testTargetingAttributes.path = requestUrl.pathname;
+    searchParams.has("utm_campaign") &&
+        (testTargetingAttributes.utmCampaign =
+            searchParams.get("utm_campaign") || undefined);
+    searchParams.has("utm_content") &&
+        (testTargetingAttributes.utmContent =
+            searchParams.get("utm_content") || undefined);
+    searchParams.has("utm_medium") &&
+        (testTargetingAttributes.utmMedium =
+            searchParams.get("utm_medium") || undefined);
+    searchParams.has("utm_source") &&
+        (testTargetingAttributes.utmSource =
+            searchParams.get("utm_source") || undefined);
+    searchParams.has("utm_term") &&
+        (testTargetingAttributes.utmTerm =
+            searchParams.get("utm_term") || undefined);
+    return testTargetingAttributes;
+}
+export function getTestFromQueryParams(request) {
+    const requestUrl = new URL(request.url);
+    const params = requestUrl.searchParams;
+    if (params.has("testId") ||
+        params.has("test_id") ||
+        params.has("test-id") ||
+        params.has("testHandle") ||
+        params.has("test_handle") ||
+        params.has("test-handle") ||
+        params.has("testVariantId") ||
+        params.has("test_variant_id") ||
+        params.has("test-variant-id") ||
+        params.has("testVariantHandle") ||
+        params.has("test_variant_handle") ||
+        params.has("test-variant-handle")) {
+        return {
+            testId: params.get("testId") ||
+                params.get("test_id") ||
+                params.get("test-id") ||
+                "",
+            testHandle: params.get("testHandle") ||
+                params.get("test_handle") ||
+                params.get("test-handle") ||
+                "",
+            testVariantId: params.get("testVariantId") ||
+                params.get("test_variant_id") ||
+                params.get("test-variant-id") ||
+                "",
+            testVariantHandle: params.get("testVariantHandle") ||
+                params.get("test_variant_handle") ||
+                params.get("test-variant-handle") ||
+                "",
+        };
+    }
+    return null;
+}
+export function setTestHeaders(headers, options) {
+    const { previewEnabled, testFromQueryParams, testInfoForRequest } = options;
+    if (previewEnabled) {
+        return headers;
+    }
+    if (testFromQueryParams) {
+        headers["X-Pack-Test-Ignore-Test-Status"] = true;
+        if (testFromQueryParams.testId) {
+            headers["X-Pack-Test-Id"] = testFromQueryParams.testId;
+        }
+        if (testFromQueryParams.testHandle) {
+            headers["X-Pack-Test-Handle"] = testFromQueryParams.testHandle;
+        }
+        if (testFromQueryParams.testVariantId) {
+            headers["X-Pack-Test-Variant-Id"] = testFromQueryParams.testVariantId;
+        }
+        if (testFromQueryParams.testVariantHandle) {
+            headers["X-Pack-Test-Variant-Handle"] =
+                testFromQueryParams.testVariantHandle;
+        }
+    }
+    else if (testInfoForRequest) {
+        headers = {
+            "X-Pack-Test-Id": testInfoForRequest?.id,
+            "X-Pack-Test-Variant-Id": testInfoForRequest?.testVariant?.id,
+        };
+    }
+    return headers;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pack/hydrogen",
   "description": "Pack Hydrogen",
-  "version": "1.0.0",
+  "version": "1.0.1-ab-test.1",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "engines": {
@@ -22,14 +22,17 @@
     "dist"
   ],
   "dependencies": {
-    "@pack/client": "^1.0.0",
-    "@pack/packlytics": "^1.0.0",
-    "@shopify/hydrogen": "^2023.10.2"
+    "@pack/client": "^1.0.1-ab-test.0",
+    "@pack/packlytics": "^1.0.1-ab-test.0",
+    "@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": {