@pack/hydrogen 3.1.1-beta.0 → 3.2.0

package/README.md

@@ -1 +1,54 @@
-# hydrogen
+# `@pack/hydrogen`
+
+Hydrogen runtime integration for Pack content, preview, A/B testing, and server-side error tracking.
+
+## Install
+
+```bash
+npm install @pack/hydrogen
+```
+
+## Main exports
+
+- `createPackClient`
+- `handleRequest`
+- `PackSession`, `PackTestSession`
+- `previewModeAction`, `previewModeLoader`
+- A/B test helpers (`PackTestProvider`, `useAbTest`, etc.)
+
+## Minimal setup
+
+```ts
+import {
+  createPackClient,
+  handleRequest,
+} from '@pack/hydrogen';
+import { createServerErrorHandler } from '@pack/errors';
+
+// Optional if you want route-level error capture in addition to handleRequest wrapping.
+// Duplicate reports for the same Error instance are deduplicated automatically.
+export const handleError = createServerErrorHandler();
+
+export default async function fetch(request: Request, env: Env, ctx: ExecutionContext) {
+  const pack = createPackClient({
+    cache: caches.default,
+    waitUntil: ctx.waitUntil.bind(ctx),
+    storeId: env.PACK_STORE_ID,
+    token: env.PACK_API_TOKEN,
+    errorTracking: {
+      dsn: env.PUBLIC_PACK_ERROR_TRACKING_DSN,
+    },
+    session,
+    testSession,
+  });
+
+  return handleRequest(pack, request, (req) => storefrontHandler(req));
+}
+```
+
+## Development
+
+```bash
+yarn
+yarn build
+```

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { PackClient } from '@pack/client';
+import { ErrorTrackingOptions } from '@pack/errors';
 import { CacheCustom } from '@shopify/hydrogen';
 import { SessionStorage, Session, ActionFunctionArgs, LoaderFunctionArgs } from 'react-router';
 import * as react from 'react';
@@ -26,10 +27,14 @@ interface TestInput {
 interface Test$1 {
     id: string;
     handle: string;
+    impressionTrigger?: string;
     testVariant: {
         id: string;
         handle: string;
     };
+    impression?: {
+        sectionIds?: string[];
+    };
 }
 
 declare class PackTestSession {
@@ -81,6 +86,8 @@ interface CreatePackClientOptions extends EnvironmentOptions {
     i18n?: I18nOptions;
     /** Default theme data to use when no token is provided */
     defaultThemeData?: DefaultThemeData;
+    /** Configuration for server-side error tracking */
+    errorTracking?: ErrorTrackingOptions;
     /**
      * Initial request to extract query parameters from.
      * If not provided, it will be captured from the first handleRequest call.
@@ -138,12 +145,14 @@ interface Pack {
         packAbTest: Test$1 | null | undefined;
         packIsPreviewMode: boolean;
         packCustomizerMeta: PackCustomizerMeta | null;
+        packErrorTracking?: ErrorTrackingOptions;
     };
     handleRequest(request: Request): Promise<(response: Response) => void>;
     isPreviewModeEnabled: () => boolean;
     isValidEditToken: PackClient["isValidEditToken"];
     query: <T = any>(query: string, options: QueryOptions) => Promise<QueryResponse<T>>;
     session: PackSession;
+    errorTracking?: ErrorTrackingOptions;
     testSession: PackTestSession;
 }
 interface DefaultThemeData {
@@ -177,15 +186,23 @@ declare function action({ request, context }: ActionFunctionArgs): Promise<Respo
  */
 declare function loader({ request, context }: LoaderFunctionArgs): Promise<Response>;
 
-declare const PackTestRoute: () => null;
+type PackTestImpressionSelector = string | string[] | ((packTestInfo: Test$1) => string | string[] | undefined);
+type PackTestRouteProps = {
+    impressionSelector?: PackTestImpressionSelector;
+};
+declare const PackTestRoute: ({ impressionSelector, }?: PackTestRouteProps) => null;
 
 interface Test {
     id: string;
     handle: string;
+    impressionTrigger?: string;
     testVariant: {
         id: string;
         handle: string;
     };
+    impression?: {
+        sectionIds?: string[];
+    };
 }
 interface TestExposureCallbackArg extends Test {
     exposureTime: number;