@amplifyup/sdk 0.1.21 → 0.1.23

package/dist/index.d.mts

@@ -1,7 +1,99 @@
-import { C as CDPAdapter, A as AmplifyUpConfig, E as EventProperties, I as IdentifyTraits, a as AmplifyUpTarget, b as EventTrackingConfig$1 } from './types-Cy5aWQ5c.mjs';
-export { P as PageConfig, Z as ZoneConfig, i as isAmplifyUpTarget, n as normalizeAmplifyUpTarget, r as resolveAmplifyUpTarget, c as resolveAmplifyUpUrls } from './types-Cy5aWQ5c.mjs';
+import { P as PageConfig, C as ContentSource, A as AmplifyContentMeta, a as CDPAdapter, b as AmplifyUpConfig, E as EventProperties, I as IdentifyInput, c as IdentifyTraits, d as ProfileFieldsInput, e as AmplifyUpTarget, f as EventTrackingConfig$1 } from './types-BxpG9Gsy.mjs';
+export { Z as ZoneConfig, i as isAmplifyUpTarget, n as normalizeAmplifyUpTarget, r as resolveAmplifyUpTarget, g as resolveAmplifyUpUrls } from './types-BxpG9Gsy.mjs';
 export { i as isComposerPreview, a as isPreviewRequest } from './preview-BMrIgUvp.mjs';
 
+interface FetchContentResult {
+    pageConfig: PageConfig | null;
+    source: ContentSource;
+    meta: AmplifyContentMeta | null;
+    error: string | null;
+}
+interface FetchContentOptions {
+    route: string;
+    trackingId: string;
+    anonId?: string | null;
+    siteId?: string | null;
+    /** Force preview (Composer); otherwise uses isComposerPreview() in browser. */
+    preview?: boolean;
+    orchestratorUrl: string;
+    edgeUrl: string;
+    /** Orchestrator layout fetch (SDK instance method or server helper). */
+    fetchOrchestratorPage: (route: string, preview: boolean) => Promise<PageConfig | null>;
+    fetchFn?: typeof fetch;
+}
+/**
+ * Single content entry point:
+ * - Composer / preview → orchestrator layout provider (drafts + live edits)
+ * - Production visitors → Edge /v1/resolve (personalized + CMS-populated)
+ *
+ * Production never falls back to the orchestrator on Edge failure —
+ * callers should render site fallback instead.
+ */
+declare function fetchContent(options: FetchContentOptions): Promise<FetchContentResult>;
+
+/** Mirrors Edge ResolvedComponent — SDK maps this into layoutTree nodes. */
+interface EdgeResolvedComponent {
+    instanceId: string;
+    componentId: string;
+    props: Record<string, unknown>;
+    children?: Record<string, EdgeResolvedComponent[]>;
+    appliedRules?: string[];
+    degraded?: boolean;
+}
+interface EdgeResolvedPayload {
+    siteId: string;
+    route: string;
+    version: number;
+    zones: Record<string, EdgeResolvedComponent[]>;
+    tree?: EdgeResolvedComponent[];
+    meta: {
+        variantKeys: Record<string, string>;
+        audienceLookup?: {
+            status: string;
+            durationMs: number;
+        };
+        decideLookup?: {
+            status: string;
+            durationMs: number;
+            checks: number;
+        };
+        experiments?: Array<{
+            key: string;
+            variantKey: string;
+            bucket: number;
+        }>;
+        bot?: unknown;
+        resolvedAt: string;
+        degraded?: boolean;
+    };
+}
+declare class EdgeResolveError extends Error {
+    status: number;
+    body: unknown;
+    constructor(message: string, status: number, body?: unknown);
+}
+declare function fetchEdgeResolve(options: {
+    edgeUrl: string;
+    trackingId: string;
+    route: string;
+    anonId?: string | null;
+    siteId?: string | null;
+    fetch?: typeof fetch;
+}): Promise<EdgeResolvedPayload>;
+
+/**
+ * Map Edge /v1/resolve payload → PageConfig for AmplifyRenderer.
+ * Prefers `tree` (full page skeleton with zones spliced in); falls back to
+ * flattening zone roots when older snapshots lack structure.
+ */
+declare function mapResolvedToPageConfig(payload: EdgeResolvedPayload): PageConfig;
+
+/**
+ * Normalize a route path for Edge resolve requests.
+ * Leading slash, no trailing slash (except root), query/hash stripped.
+ */
+declare function normalizeRoute(route: string): string;
+
 /**
  * AmplifyUp Tracking SDK
  *
@@ -11,6 +103,11 @@ export { i as isComposerPreview, a as isPreviewRequest } from './preview-BMrIgUv
  * All runtime data (events, profiles, decisions) lives in AWS.
  */
 
+/**
+ * Idle gap that starts a new logical visit when a tab is reactivated.
+ * Must stay aligned with SESSION_GAP_MS in apps/orchestrator/lib/aws-profiles.ts.
+ */
+declare const SESSION_IDLE_GAP_MS: number;
 interface EventTrackingConfig {
     eventName: string;
     eventType: string;
@@ -27,6 +124,8 @@ declare class AmplifyUpSDK {
     private apiGatewayUrl;
     private orchestratorUrl;
     private decisionApiUrl;
+    private edgeUrl;
+    private siteId;
     private target;
     private initialized;
     /** Prevents overlapping init() from React Strict Mode double-mount */
@@ -99,7 +198,10 @@ declare class AmplifyUpSDK {
      * State lives on the instance so SPA route changes can reset milestones.
      */
     private setupPageEngagement;
+    /** Flush dwell then reset — used on SPA route changes. */
     private resetEngagementForNewPage;
+    /** Reset dwell/scroll state without emitting (idle resume already flushed on hide). */
+    private resetEngagementQuiet;
     /**
      * SPA / soft navigation: fire a page view and reset engagement.
      * No-op when the path has not changed. Safe for React Strict Mode remounts.
@@ -140,9 +242,17 @@ declare class AmplifyUpSDK {
      */
     trackContentView(contentId: string, contentType: string, properties?: EventProperties): void;
     /**
-     * Identify user (when they sign up or log in)
+     * Identify a visitor.
+     * - identify('user_123') — bare string; server maps via org default type
+     * - identify({ email: '...', crm_id: '...' }) — explicit types
+     * - identify('user_123', traits) — legacy form
+     */
+    identify(userIdOrIdentifiers: IdentifyInput, traits?: IdentifyTraits): void;
+    /**
+     * Set profile fields (partial update). Omitted keys are left alone;
+     * an explicit empty value clears the field.
      */
-    identify(userId: string, traits?: IdentifyTraits): void;
+    setProfileFields(fields: ProfileFieldsInput): void;
     /**
      * Track content engagement (when user interacts with personalized content)
      */
@@ -206,6 +316,14 @@ declare class AmplifyUpSDK {
      * Get decision API URL
      */
     getDecisionApiUrl(): string | undefined;
+    /**
+     * Get Edge Worker URL (production content resolve)
+     */
+    getEdgeUrl(): string | undefined;
+    /**
+     * Optional site id from config (Edge can resolve via trackingId alone).
+     */
+    getSiteId(): string | undefined;
     /**
      * Build API URL for fetching page config from the Layout Provider
      */
@@ -336,7 +454,8 @@ declare const trackClick: (elementId: string, elementText: string, properties?:
 declare const trackFormSubmit: (formId: string, formData?: EventProperties) => void;
 declare const trackFormFieldInteraction: (fieldName: string, fieldValue?: string) => void;
 declare const trackContentView: (contentId: string, contentType: string, properties?: EventProperties) => void;
-declare const identify: (userId: string, traits?: IdentifyTraits) => void;
+declare const identify: (userIdOrIdentifiers: IdentifyInput, traits?: IdentifyTraits) => void;
+declare const setProfileFields: (fields: ProfileFieldsInput) => void;
 declare const trackContentEngagement: (contentId: string, engagementType: "view" | "click" | "dismiss") => void;
 declare const reset: () => void;
 declare const getInstanceId: () => string;
@@ -386,4 +505,4 @@ declare const verifyAWSConnection: () => {
 
 declare const _default: AmplifyUpSDK;
 
-export { AmplifyUpConfig, AmplifyUpSDK, AmplifyUpTarget, CDPAdapter, EventProperties, EventTrackingConfig$1 as EventTrackingConfig, IdentifyTraits, buildLayoutProviderUrl, buildPageRenderUrl, cleanupEventTracking, _default as default, fetchPageConfig, getDiagnostics, getInstanceId, getOrchestratorUrl, getSDK, getStatus, getTarget, getTrackingId, getUserId, identify, init, page, refreshEventTracking, reset, routeChange, setupComponentViewTracking, setupEventTracking, testTracking, track, trackClick, trackContentEngagement, trackContentView, trackFormFieldInteraction, trackFormSubmit, verifyAWSConnection };
+export { AmplifyContentMeta, AmplifyUpConfig, AmplifyUpSDK, AmplifyUpTarget, CDPAdapter, ContentSource, EdgeResolveError, EventProperties, EventTrackingConfig$1 as EventTrackingConfig, type FetchContentOptions, type FetchContentResult, IdentifyInput, IdentifyTraits, PageConfig, ProfileFieldsInput, SESSION_IDLE_GAP_MS, buildLayoutProviderUrl, buildPageRenderUrl, cleanupEventTracking, _default as default, fetchContent, fetchEdgeResolve, fetchPageConfig, getDiagnostics, getInstanceId, getOrchestratorUrl, getSDK, getStatus, getTarget, getTrackingId, getUserId, identify, init, mapResolvedToPageConfig, normalizeRoute, page, refreshEventTracking, reset, routeChange, setProfileFields, setupComponentViewTracking, setupEventTracking, testTracking, track, trackClick, trackContentEngagement, trackContentView, trackFormFieldInteraction, trackFormSubmit, verifyAWSConnection };

package/dist/index.d.ts

@@ -1,7 +1,99 @@
-import { C as CDPAdapter, A as AmplifyUpConfig, E as EventProperties, I as IdentifyTraits, a as AmplifyUpTarget, b as EventTrackingConfig$1 } from './types-Cy5aWQ5c.js';
-export { P as PageConfig, Z as ZoneConfig, i as isAmplifyUpTarget, n as normalizeAmplifyUpTarget, r as resolveAmplifyUpTarget, c as resolveAmplifyUpUrls } from './types-Cy5aWQ5c.js';
+import { P as PageConfig, C as ContentSource, A as AmplifyContentMeta, a as CDPAdapter, b as AmplifyUpConfig, E as EventProperties, I as IdentifyInput, c as IdentifyTraits, d as ProfileFieldsInput, e as AmplifyUpTarget, f as EventTrackingConfig$1 } from './types-BxpG9Gsy.js';
+export { Z as ZoneConfig, i as isAmplifyUpTarget, n as normalizeAmplifyUpTarget, r as resolveAmplifyUpTarget, g as resolveAmplifyUpUrls } from './types-BxpG9Gsy.js';
 export { i as isComposerPreview, a as isPreviewRequest } from './preview-BMrIgUvp.js';
 
+interface FetchContentResult {
+    pageConfig: PageConfig | null;
+    source: ContentSource;
+    meta: AmplifyContentMeta | null;
+    error: string | null;
+}
+interface FetchContentOptions {
+    route: string;
+    trackingId: string;
+    anonId?: string | null;
+    siteId?: string | null;
+    /** Force preview (Composer); otherwise uses isComposerPreview() in browser. */
+    preview?: boolean;
+    orchestratorUrl: string;
+    edgeUrl: string;
+    /** Orchestrator layout fetch (SDK instance method or server helper). */
+    fetchOrchestratorPage: (route: string, preview: boolean) => Promise<PageConfig | null>;
+    fetchFn?: typeof fetch;
+}
+/**
+ * Single content entry point:
+ * - Composer / preview → orchestrator layout provider (drafts + live edits)
+ * - Production visitors → Edge /v1/resolve (personalized + CMS-populated)
+ *
+ * Production never falls back to the orchestrator on Edge failure —
+ * callers should render site fallback instead.
+ */
+declare function fetchContent(options: FetchContentOptions): Promise<FetchContentResult>;
+
+/** Mirrors Edge ResolvedComponent — SDK maps this into layoutTree nodes. */
+interface EdgeResolvedComponent {
+    instanceId: string;
+    componentId: string;
+    props: Record<string, unknown>;
+    children?: Record<string, EdgeResolvedComponent[]>;
+    appliedRules?: string[];
+    degraded?: boolean;
+}
+interface EdgeResolvedPayload {
+    siteId: string;
+    route: string;
+    version: number;
+    zones: Record<string, EdgeResolvedComponent[]>;
+    tree?: EdgeResolvedComponent[];
+    meta: {
+        variantKeys: Record<string, string>;
+        audienceLookup?: {
+            status: string;
+            durationMs: number;
+        };
+        decideLookup?: {
+            status: string;
+            durationMs: number;
+            checks: number;
+        };
+        experiments?: Array<{
+            key: string;
+            variantKey: string;
+            bucket: number;
+        }>;
+        bot?: unknown;
+        resolvedAt: string;
+        degraded?: boolean;
+    };
+}
+declare class EdgeResolveError extends Error {
+    status: number;
+    body: unknown;
+    constructor(message: string, status: number, body?: unknown);
+}
+declare function fetchEdgeResolve(options: {
+    edgeUrl: string;
+    trackingId: string;
+    route: string;
+    anonId?: string | null;
+    siteId?: string | null;
+    fetch?: typeof fetch;
+}): Promise<EdgeResolvedPayload>;
+
+/**
+ * Map Edge /v1/resolve payload → PageConfig for AmplifyRenderer.
+ * Prefers `tree` (full page skeleton with zones spliced in); falls back to
+ * flattening zone roots when older snapshots lack structure.
+ */
+declare function mapResolvedToPageConfig(payload: EdgeResolvedPayload): PageConfig;
+
+/**
+ * Normalize a route path for Edge resolve requests.
+ * Leading slash, no trailing slash (except root), query/hash stripped.
+ */
+declare function normalizeRoute(route: string): string;
+
 /**
  * AmplifyUp Tracking SDK
  *
@@ -11,6 +103,11 @@ export { i as isComposerPreview, a as isPreviewRequest } from './preview-BMrIgUv
  * All runtime data (events, profiles, decisions) lives in AWS.
  */
 
+/**
+ * Idle gap that starts a new logical visit when a tab is reactivated.
+ * Must stay aligned with SESSION_GAP_MS in apps/orchestrator/lib/aws-profiles.ts.
+ */
+declare const SESSION_IDLE_GAP_MS: number;
 interface EventTrackingConfig {
     eventName: string;
     eventType: string;
@@ -27,6 +124,8 @@ declare class AmplifyUpSDK {
     private apiGatewayUrl;
     private orchestratorUrl;
     private decisionApiUrl;
+    private edgeUrl;
+    private siteId;
     private target;
     private initialized;
     /** Prevents overlapping init() from React Strict Mode double-mount */
@@ -99,7 +198,10 @@ declare class AmplifyUpSDK {
      * State lives on the instance so SPA route changes can reset milestones.
      */
     private setupPageEngagement;
+    /** Flush dwell then reset — used on SPA route changes. */
     private resetEngagementForNewPage;
+    /** Reset dwell/scroll state without emitting (idle resume already flushed on hide). */
+    private resetEngagementQuiet;
     /**
      * SPA / soft navigation: fire a page view and reset engagement.
      * No-op when the path has not changed. Safe for React Strict Mode remounts.
@@ -140,9 +242,17 @@ declare class AmplifyUpSDK {
      */
     trackContentView(contentId: string, contentType: string, properties?: EventProperties): void;
     /**
-     * Identify user (when they sign up or log in)
+     * Identify a visitor.
+     * - identify('user_123') — bare string; server maps via org default type
+     * - identify({ email: '...', crm_id: '...' }) — explicit types
+     * - identify('user_123', traits) — legacy form
+     */
+    identify(userIdOrIdentifiers: IdentifyInput, traits?: IdentifyTraits): void;
+    /**
+     * Set profile fields (partial update). Omitted keys are left alone;
+     * an explicit empty value clears the field.
      */
-    identify(userId: string, traits?: IdentifyTraits): void;
+    setProfileFields(fields: ProfileFieldsInput): void;
     /**
      * Track content engagement (when user interacts with personalized content)
      */
@@ -206,6 +316,14 @@ declare class AmplifyUpSDK {
      * Get decision API URL
      */
     getDecisionApiUrl(): string | undefined;
+    /**
+     * Get Edge Worker URL (production content resolve)
+     */
+    getEdgeUrl(): string | undefined;
+    /**
+     * Optional site id from config (Edge can resolve via trackingId alone).
+     */
+    getSiteId(): string | undefined;
     /**
      * Build API URL for fetching page config from the Layout Provider
      */
@@ -336,7 +454,8 @@ declare const trackClick: (elementId: string, elementText: string, properties?:
 declare const trackFormSubmit: (formId: string, formData?: EventProperties) => void;
 declare const trackFormFieldInteraction: (fieldName: string, fieldValue?: string) => void;
 declare const trackContentView: (contentId: string, contentType: string, properties?: EventProperties) => void;
-declare const identify: (userId: string, traits?: IdentifyTraits) => void;
+declare const identify: (userIdOrIdentifiers: IdentifyInput, traits?: IdentifyTraits) => void;
+declare const setProfileFields: (fields: ProfileFieldsInput) => void;
 declare const trackContentEngagement: (contentId: string, engagementType: "view" | "click" | "dismiss") => void;
 declare const reset: () => void;
 declare const getInstanceId: () => string;
@@ -386,4 +505,4 @@ declare const verifyAWSConnection: () => {
 
 declare const _default: AmplifyUpSDK;
 
-export { AmplifyUpConfig, AmplifyUpSDK, AmplifyUpTarget, CDPAdapter, EventProperties, EventTrackingConfig$1 as EventTrackingConfig, IdentifyTraits, buildLayoutProviderUrl, buildPageRenderUrl, cleanupEventTracking, _default as default, fetchPageConfig, getDiagnostics, getInstanceId, getOrchestratorUrl, getSDK, getStatus, getTarget, getTrackingId, getUserId, identify, init, page, refreshEventTracking, reset, routeChange, setupComponentViewTracking, setupEventTracking, testTracking, track, trackClick, trackContentEngagement, trackContentView, trackFormFieldInteraction, trackFormSubmit, verifyAWSConnection };
+export { AmplifyContentMeta, AmplifyUpConfig, AmplifyUpSDK, AmplifyUpTarget, CDPAdapter, ContentSource, EdgeResolveError, EventProperties, EventTrackingConfig$1 as EventTrackingConfig, type FetchContentOptions, type FetchContentResult, IdentifyInput, IdentifyTraits, PageConfig, ProfileFieldsInput, SESSION_IDLE_GAP_MS, buildLayoutProviderUrl, buildPageRenderUrl, cleanupEventTracking, _default as default, fetchContent, fetchEdgeResolve, fetchPageConfig, getDiagnostics, getInstanceId, getOrchestratorUrl, getSDK, getStatus, getTarget, getTrackingId, getUserId, identify, init, mapResolvedToPageConfig, normalizeRoute, page, refreshEventTracking, reset, routeChange, setProfileFields, setupComponentViewTracking, setupEventTracking, testTracking, track, trackClick, trackContentEngagement, trackContentView, trackFormFieldInteraction, trackFormSubmit, verifyAWSConnection };