@pack/hydrogen 1.0.8 → 2.0.0-beta.2

package/dist/index.d.mts

@@ -0,0 +1,195 @@
+import { PackClient } from '@pack/client';
+import { CacheCustom } from '@shopify/hydrogen';
+import { SessionStorage, Session } from '@shopify/remix-oxygen';
+import { ActionFunction, LoaderFunction } from '@remix-run/server-runtime';
+import * as react from 'react';
+import react__default, { Dispatch, SetStateAction, PropsWithChildren } from 'react';
+
+declare class PackSession {
+    #private;
+    readonly id: string;
+    readonly secret: string;
+    constructor(id: string, secret: string, sessionStorage: SessionStorage, session: Session);
+    static init(request: Request, secrets: string[]): Promise<PackSession>;
+    has(key: string): boolean;
+    get(key: string): any;
+    destroy(): Promise<string>;
+    set(key: string, value: any): void;
+    commit(): Promise<string>;
+}
+
+interface TestInput {
+    testId?: string;
+    testHandle?: string;
+    testVariantId?: string;
+    testVariantHandle?: string;
+}
+interface Test$1 {
+    id: string;
+    handle: string;
+    testVariant: {
+        id: string;
+        handle: string;
+    };
+}
+
+declare class PackTestSession {
+    #private;
+    readonly id: string;
+    constructor(id: string, sessionStorage: SessionStorage, session: Session);
+    static init(request: Request, secrets: string[]): Promise<PackTestSession>;
+    getTestData(): Test$1 | undefined;
+    getExpireAt(): string | undefined;
+    setTestData(testData: Test$1 | undefined): void;
+    setExpireAt(expireAt: string | undefined): void;
+    clearTestData(): void;
+    hasTestData(): boolean;
+    hasChanges(): boolean;
+    commit(): Promise<string>;
+    destroy(): Promise<string>;
+}
+
+/** @see https://shopify.dev/docs/custom-storefronts/hydrogen/data-fetching/cache#caching-strategies */
+type CachingStrategy = ReturnType<typeof CacheCustom>;
+interface EnvironmentOptions {
+    /**
+     * A Cache API instance.
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/Cache
+     */
+    cache: Cache;
+    /**
+     * A runtime utility for serverless environments
+     * @see https://developers.cloudflare.com/workers/runtime-apis/fetch-event/#waituntil
+     */
+    waitUntil: ExecutionContext["waitUntil"];
+}
+interface CreatePackClientOptions extends EnvironmentOptions {
+    apiUrl?: string;
+    token?: string;
+    storeId?: string;
+    session: PackSession;
+    testSession: PackTestSession;
+    contentEnvironment?: string;
+    /** Default theme data to use when no token is provided */
+    defaultThemeData?: DefaultThemeData;
+}
+type Variables = Record<string, any>;
+interface QueryOptions {
+    variables?: Variables;
+    cache?: CachingStrategy;
+    test?: TestInput;
+    request: Request;
+}
+interface QueryError {
+    message: string;
+    param?: string;
+    code?: string;
+    type: string;
+}
+interface QueryResponse<T> {
+    data: T | null;
+    error: QueryError | null;
+    packTestInfo?: Test$1;
+}
+interface PackCustomizerMeta {
+    environment?: string;
+    overlay?: {
+        src?: string;
+        version?: string;
+    };
+    [key: string]: any;
+}
+interface Pack {
+    abTest: Test$1 | null | undefined;
+    /**
+     * @deprecated The method should not be used
+     */
+    getPackSessionData(): {
+        storeId: string;
+        sessionId: string;
+        abTest: Test$1 | null | undefined;
+        isPreviewModeEnabled: boolean;
+        customizerMeta: any;
+    };
+    getPackContextData(): {
+        packStoreId: string;
+        packSessionId: string;
+        packAbTest: Test$1 | 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;
+    testSession: PackTestSession;
+}
+interface DefaultThemeData {
+    data: Record<string, any>;
+}
+declare function createPackClient(options: CreatePackClientOptions): Pack;
+
+declare function handleRequest(pack: Pack, request: Request, handleRequest: (request: Request) => Promise<Response>): Promise<Response>;
+
+type UsePackCookiesOptions = {
+    /**
+     * If set to `false`, Shopify cookies will be removed.
+     * If set to `true`, Shopify unique user token cookie will have cookie expiry of 1 year.
+     * Defaults to false.
+     **/
+    hasUserConsent?: boolean;
+    /**
+     * The domain scope of the cookie. Defaults to empty string.
+     **/
+    domain?: string;
+};
+declare function usePackCookies(options?: UsePackCookiesOptions): void;
+
+/**
+ * A `POST` request to this route will exit preview mode
+ * POST /api/edit Content-Type: application/x-www-form-urlencoded
+ */
+declare const action: ActionFunction;
+/**
+ * A `GET` request to this route will enter preview mode
+ */
+declare const loader: LoaderFunction;
+
+declare const PackTestRoute: () => null;
+
+interface Test {
+    id: string;
+    handle: string;
+    testVariant: {
+        id: string;
+        handle: string;
+    };
+}
+interface TestExposureCallbackArg extends Test {
+    exposureTime: number;
+}
+type PackTestContextValue = {
+    testExposureCallback?: (test: TestExposureCallbackArg) => void;
+    hasUserConsent?: boolean | undefined;
+    pendingExposureQueue?: Map<any, any>;
+    setPendingExposureQueue?: Dispatch<SetStateAction<Map<any, any>>>;
+    exposedExperiments?: Set<unknown>;
+};
+declare const PackTestContext: react.Context<PackTestContextValue>;
+declare const usePackTestContext: () => PackTestContextValue;
+
+interface PackContentProps {
+    testExposureCallback?: (test: Test) => void;
+    hasUserConsent?: boolean;
+}
+declare function PackTestProvider({ children, testExposureCallback, hasUserConsent, }: PropsWithChildren<PackContentProps>): react__default.JSX.Element;
+
+declare function useAbTest(): Test$1 | null;
+declare function useAbTestSessionId(): string;
+declare function useAbTestId(): string | undefined;
+declare function useAbTestHandle(): string | undefined;
+declare function useAbTestVariantId(): string | undefined;
+declare function useAbTestVariantHandle(): string | undefined;
+
+export { type Pack, PackSession, PackTestContext, PackTestProvider, PackTestRoute, PackTestSession, createPackClient, handleRequest, action as previewModeAction, loader as previewModeLoader, useAbTest, useAbTestHandle, useAbTestId, useAbTestSessionId, useAbTestVariantHandle, useAbTestVariantId, usePackCookies, usePackTestContext };