@pack/hydrogen 3.2.8 → 3.3.0

package/dist/index.d.ts

@@ -116,8 +116,10 @@ interface PackCustomizerMeta {
         version?: string;
     };
     previewContext?: {
+        linkName?: string;
         locale?: string;
         releaseId?: string;
+        releaseName?: string;
         pageDraft?: string;
         siteSettingsDraft?: string;
         testHandle?: string;
@@ -226,4 +228,85 @@ 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 };
+/**
+ * The identity signals audience conditions evaluate against. Built once per SSR
+ * request and passed to the resolver; every condition reads from this bundle
+ * rather than re-parsing the request.
+ *
+ * Two population levels:
+ *  - request-only (handleRequest / A/B): everything except customer identity;
+ *  - request + customer (root loader / Personalization): also `shopifyCustomerId`.
+ * All fields are optional; customer-keyed conditions simply don't match at the
+ * request-only level.
+ */
+interface IdentityBundle {
+    shopifyCustomerId?: string;
+    ga4ClientId?: string;
+    amplitudeDeviceId?: string;
+    amplitudeUserId?: string;
+    klaviyoProfileId?: string;
+    segmentAnonymousId?: string;
+    cookies: Record<string, string>;
+    hasConsent: boolean;
+    userAgent?: string;
+    deviceType: "mobile" | "tablet" | "desktop";
+    geo: {
+        country?: string;
+        region?: string;
+    };
+    url: {
+        path: string;
+        query: Record<string, string>;
+        host?: string;
+    };
+    referrer?: string;
+}
+interface BuildIdentityBundleOptions {
+    /** Shopify customer id, when resolved (loader-level / Personalization). */
+    shopifyCustomerId?: string;
+}
+/**
+ * Builds an IdentityBundle from an SSR request (headers + cookies) and, when
+ * available, the resolved Shopify customer. Pure and synchronous — safe to call
+ * once per request and memoize.
+ */
+declare function buildIdentityBundle(request: Request, options?: BuildIdentityBundleOptions): IdentityBundle;
+
+type ConditionEvaluator = (config: Record<string, any> | null | undefined, identity: IdentityBundle) => boolean | Promise<boolean>;
+declare function registerConditionEvaluator(type: string, evaluate: ConditionEvaluator): void;
+declare function getConditionEvaluator(type: string): ConditionEvaluator | undefined;
+declare function isConditionRegistered(type: string): boolean;
+
+type RuleGroupOperator = "AND" | "OR" | "NOT";
+interface RuleGroupNode {
+    op: RuleGroupOperator;
+    children: AudienceRuleNode[];
+}
+interface RuleConditionNode {
+    type: string;
+    provider?: string | null;
+    config?: Record<string, any> | null;
+    negate?: boolean | null;
+}
+type AudienceRuleNode = RuleGroupNode | RuleConditionNode;
+type AudienceRulesTree = AudienceRuleNode | Record<string, never>;
+
+interface MatchedCondition {
+    type: string;
+    provider?: string | null;
+    config?: Record<string, any> | null;
+    negate?: boolean | null;
+}
+interface AudienceResolution {
+    matches: boolean;
+    matchedConditions: MatchedCondition[];
+}
+/**
+ * Evaluates an audience rules tree against an IdentityBundle at SSR. AND/OR
+ * short-circuit; NOT ("none of these") matches when none of its children match;
+ * leaves dispatch to their registered evaluator (with leaf `negate` applied). An
+ * empty tree matches everyone. Unknown types + evaluator errors fail closed.
+ */
+declare function resolveRulesTree(rules: AudienceRulesTree | null | undefined, identity: IdentityBundle): Promise<AudienceResolution>;
+
+export { type AudienceResolution, type AudienceRuleNode, type AudienceRulesTree, type BuildIdentityBundleOptions, type ConditionEvaluator, type IdentityBundle, type MatchedCondition, type Pack, PackSession, PackTestContext, PackTestProvider, PackTestRoute, PackTestSession, type RuleConditionNode, type RuleGroupNode, type RuleGroupOperator, buildIdentityBundle, createPackClient, getConditionEvaluator, handleRequest, isConditionRegistered, action as previewModeAction, loader as previewModeLoader, registerConditionEvaluator, resolveRulesTree, useAbTest, useAbTestHandle, useAbTestId, useAbTestSessionId, useAbTestVariantHandle, useAbTestVariantId, usePackCookies, usePackTestContext };