@amplifyup/sdk 0.1.33 → 0.1.35

package/dist/query-6BmINKLR.d.mts

@@ -0,0 +1,157 @@
+import { f as AmplifyUpTarget } from './types-CBoVIFI8.mjs';
+
+/**
+ * On-request variant selection (tier 3).
+ *
+ * Decisions happen on AmplifyUp Edge. The client asks after the view has
+ * rendered; the Worker returns variant keys only. Profile data never leaves
+ * the edge. This helper is the JS wrapper around POST /v1/select — the same
+ * wire format is the contract for Flutter / native / .NET clients. No DOM
+ * or Next.js assumptions.
+ */
+
+interface SelectVariantsResult {
+    siteId: string;
+    view: string;
+    variantKeys: Record<string, string>;
+    meta?: Record<string, unknown>;
+}
+declare class SelectVariantsError extends Error {
+    status: number;
+    body: unknown;
+    constructor(message: string, status: number, body?: unknown);
+}
+interface FetchEdgeSelectOptions {
+    edgeUrl: string;
+    trackingId?: string;
+    site?: string;
+    view: string;
+    anonId: string;
+    zones?: string[];
+    /** Request-local facts the edge cannot observe (app version, screen class). */
+    context?: Record<string, unknown>;
+    fetch?: typeof fetch;
+    signal?: AbortSignal;
+}
+declare function fetchEdgeSelect(options: FetchEdgeSelectOptions): Promise<SelectVariantsResult>;
+interface SelectVariantsOptions {
+    trackingId?: string;
+    site?: string;
+    view: string;
+    anonId: string;
+    zones?: string[];
+    context?: Record<string, unknown>;
+    target?: AmplifyUpTarget;
+    edgeUrl?: string;
+    fetch?: typeof fetch;
+    signal?: AbortSignal;
+}
+/**
+ * Ask Edge to decide deferred rules for a view. Returns variant keys to pass
+ * to `/v1/resolve?variants=`.
+ */
+declare function selectVariants(options: SelectVariantsOptions): Promise<SelectVariantsResult>;
+
+/**
+ * Runtime content queries.
+ *
+ * Page resolve covers data known at Deploy. Visitor-triggered data — search,
+ * load more, pickers — runs here: the browser asks AmplifyUp, AmplifyUp asks
+ * the CMS. Only entities published with the page can be queried.
+ */
+
+type QueryFilterOp = 'eq' | 'neq' | 'in' | 'nin' | 'gt' | 'gte' | 'lt' | 'lte' | 'contains' | 'exists';
+interface QueryFilter {
+    field: string;
+    op: QueryFilterOp;
+    value?: unknown;
+}
+interface QuerySort {
+    field: string;
+    dir: 'asc' | 'desc';
+}
+/**
+ * Provider-neutral query. AmplifyUp compiles this for the connected CMS —
+ * it never contains CMS query syntax. Same shape Composer saves on a
+ * query connection, and the shape returned in `{field}Pagination.spec`.
+ */
+interface QuerySpec {
+    providerId: string;
+    entity: string;
+    filter: QueryFilter[];
+    sort: QuerySort[];
+    limit: number;
+    offset: number;
+}
+/** Pagination meta added to list props when a query connection is paginated. */
+interface QueryPagination {
+    hasMore: boolean;
+    limit: number;
+    offset: number;
+    nextOffset: number;
+    spec: QuerySpec;
+}
+interface QueryResult<T = Record<string, unknown>> {
+    results: T[];
+    count: number;
+    hasMore: boolean;
+    limit: number;
+    offset: number;
+    nextOffset: number;
+    /** True when a content source failed and results may be incomplete. */
+    degraded?: boolean;
+}
+declare class QueryContentError extends Error {
+    status: number;
+    body: unknown;
+    constructor(message: string, status: number, body?: unknown);
+}
+interface FetchEdgeQueryOptions {
+    edgeUrl: string;
+    trackingId: string;
+    /** Published route the query belongs to (provides sources + entity mapping). */
+    route: string;
+    spec: QuerySpec;
+    siteId?: string | null;
+    fetch?: typeof fetch;
+    signal?: AbortSignal;
+}
+/**
+ * Low-level runtime query against a known Edge URL.
+ * Most callers should use `queryContent`, which resolves the URL for them.
+ */
+declare function fetchEdgeQuery<T = Record<string, unknown>>(options: FetchEdgeQueryOptions): Promise<QueryResult<T>>;
+interface QueryContentOptions {
+    trackingId: string;
+    /** Published route the query belongs to, e.g. '/insights'. */
+    route: string;
+    spec: QuerySpec;
+    siteId?: string | null;
+    target?: AmplifyUpTarget;
+    fetch?: typeof fetch;
+    signal?: AbortSignal;
+}
+/**
+ * Run a content query at request time (search, load more, pickers).
+ *
+ * Start from the published spec on a paginated list prop so filters and sort
+ * stay owned by Composer:
+ *
+ * ```ts
+ * const next = await queryContent({
+ *   trackingId,
+ *   route: '/insights',
+ *   spec: { ...postsPagination.spec, offset: postsPagination.nextOffset },
+ * });
+ * ```
+ */
+declare function queryContent<T = Record<string, unknown>>(options: QueryContentOptions): Promise<QueryResult<T>>;
+/** Convenience: next page from pagination meta on a list prop. */
+declare function nextPageSpec(pagination: QueryPagination): QuerySpec;
+/**
+ * Convenience: same published query, filtered by a visitor's search term.
+ * Resets to the first page. Empty terms return the unfiltered spec.
+ */
+declare function searchSpec(pagination: QueryPagination, field: string, term: string): QuerySpec;
+
+export { type FetchEdgeSelectOptions as F, QueryContentError as Q, SelectVariantsError as S, type SelectVariantsOptions as a, type SelectVariantsResult as b, fetchEdgeQuery as c, searchSpec as d, type QueryContentOptions as e, fetchEdgeSelect as f, type FetchEdgeQueryOptions as g, type QueryResult as h, type QueryPagination as i, type QuerySpec as j, type QueryFilter as k, type QueryFilterOp as l, type QuerySort as m, nextPageSpec as n, queryContent as q, selectVariants as s };

package/dist/query-DjIuJ71C.d.ts

@@ -0,0 +1,157 @@
+import { f as AmplifyUpTarget } from './types-CBoVIFI8.js';
+
+/**
+ * On-request variant selection (tier 3).
+ *
+ * Decisions happen on AmplifyUp Edge. The client asks after the view has
+ * rendered; the Worker returns variant keys only. Profile data never leaves
+ * the edge. This helper is the JS wrapper around POST /v1/select — the same
+ * wire format is the contract for Flutter / native / .NET clients. No DOM
+ * or Next.js assumptions.
+ */
+
+interface SelectVariantsResult {
+    siteId: string;
+    view: string;
+    variantKeys: Record<string, string>;
+    meta?: Record<string, unknown>;
+}
+declare class SelectVariantsError extends Error {
+    status: number;
+    body: unknown;
+    constructor(message: string, status: number, body?: unknown);
+}
+interface FetchEdgeSelectOptions {
+    edgeUrl: string;
+    trackingId?: string;
+    site?: string;
+    view: string;
+    anonId: string;
+    zones?: string[];
+    /** Request-local facts the edge cannot observe (app version, screen class). */
+    context?: Record<string, unknown>;
+    fetch?: typeof fetch;
+    signal?: AbortSignal;
+}
+declare function fetchEdgeSelect(options: FetchEdgeSelectOptions): Promise<SelectVariantsResult>;
+interface SelectVariantsOptions {
+    trackingId?: string;
+    site?: string;
+    view: string;
+    anonId: string;
+    zones?: string[];
+    context?: Record<string, unknown>;
+    target?: AmplifyUpTarget;
+    edgeUrl?: string;
+    fetch?: typeof fetch;
+    signal?: AbortSignal;
+}
+/**
+ * Ask Edge to decide deferred rules for a view. Returns variant keys to pass
+ * to `/v1/resolve?variants=`.
+ */
+declare function selectVariants(options: SelectVariantsOptions): Promise<SelectVariantsResult>;
+
+/**
+ * Runtime content queries.
+ *
+ * Page resolve covers data known at Deploy. Visitor-triggered data — search,
+ * load more, pickers — runs here: the browser asks AmplifyUp, AmplifyUp asks
+ * the CMS. Only entities published with the page can be queried.
+ */
+
+type QueryFilterOp = 'eq' | 'neq' | 'in' | 'nin' | 'gt' | 'gte' | 'lt' | 'lte' | 'contains' | 'exists';
+interface QueryFilter {
+    field: string;
+    op: QueryFilterOp;
+    value?: unknown;
+}
+interface QuerySort {
+    field: string;
+    dir: 'asc' | 'desc';
+}
+/**
+ * Provider-neutral query. AmplifyUp compiles this for the connected CMS —
+ * it never contains CMS query syntax. Same shape Composer saves on a
+ * query connection, and the shape returned in `{field}Pagination.spec`.
+ */
+interface QuerySpec {
+    providerId: string;
+    entity: string;
+    filter: QueryFilter[];
+    sort: QuerySort[];
+    limit: number;
+    offset: number;
+}
+/** Pagination meta added to list props when a query connection is paginated. */
+interface QueryPagination {
+    hasMore: boolean;
+    limit: number;
+    offset: number;
+    nextOffset: number;
+    spec: QuerySpec;
+}
+interface QueryResult<T = Record<string, unknown>> {
+    results: T[];
+    count: number;
+    hasMore: boolean;
+    limit: number;
+    offset: number;
+    nextOffset: number;
+    /** True when a content source failed and results may be incomplete. */
+    degraded?: boolean;
+}
+declare class QueryContentError extends Error {
+    status: number;
+    body: unknown;
+    constructor(message: string, status: number, body?: unknown);
+}
+interface FetchEdgeQueryOptions {
+    edgeUrl: string;
+    trackingId: string;
+    /** Published route the query belongs to (provides sources + entity mapping). */
+    route: string;
+    spec: QuerySpec;
+    siteId?: string | null;
+    fetch?: typeof fetch;
+    signal?: AbortSignal;
+}
+/**
+ * Low-level runtime query against a known Edge URL.
+ * Most callers should use `queryContent`, which resolves the URL for them.
+ */
+declare function fetchEdgeQuery<T = Record<string, unknown>>(options: FetchEdgeQueryOptions): Promise<QueryResult<T>>;
+interface QueryContentOptions {
+    trackingId: string;
+    /** Published route the query belongs to, e.g. '/insights'. */
+    route: string;
+    spec: QuerySpec;
+    siteId?: string | null;
+    target?: AmplifyUpTarget;
+    fetch?: typeof fetch;
+    signal?: AbortSignal;
+}
+/**
+ * Run a content query at request time (search, load more, pickers).
+ *
+ * Start from the published spec on a paginated list prop so filters and sort
+ * stay owned by Composer:
+ *
+ * ```ts
+ * const next = await queryContent({
+ *   trackingId,
+ *   route: '/insights',
+ *   spec: { ...postsPagination.spec, offset: postsPagination.nextOffset },
+ * });
+ * ```
+ */
+declare function queryContent<T = Record<string, unknown>>(options: QueryContentOptions): Promise<QueryResult<T>>;
+/** Convenience: next page from pagination meta on a list prop. */
+declare function nextPageSpec(pagination: QueryPagination): QuerySpec;
+/**
+ * Convenience: same published query, filtered by a visitor's search term.
+ * Resets to the first page. Empty terms return the unfiltered spec.
+ */
+declare function searchSpec(pagination: QueryPagination, field: string, term: string): QuerySpec;
+
+export { type FetchEdgeSelectOptions as F, QueryContentError as Q, SelectVariantsError as S, type SelectVariantsOptions as a, type SelectVariantsResult as b, fetchEdgeQuery as c, searchSpec as d, type QueryContentOptions as e, fetchEdgeSelect as f, type FetchEdgeQueryOptions as g, type QueryResult as h, type QueryPagination as i, type QuerySpec as j, type QueryFilter as k, type QueryFilterOp as l, type QuerySort as m, nextPageSpec as n, queryContent as q, selectVariants as s };

package/dist/react.d.mts

@@ -1,8 +1,9 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React, { ReactNode } from 'react';
-import { P as PageConfig, b as AmplifyUpConfig, C as ContentSource, A as AmplifyContentMeta } from './types-npF_lNoq.mjs';
-export { Z as ZoneConfig } from './types-npF_lNoq.mjs';
+import { P as PageConfig, b as AmplifyUpConfig, C as ContentSource, A as AmplifyContentMeta } from './types-CBoVIFI8.mjs';
+export { Z as ZoneConfig } from './types-CBoVIFI8.mjs';
 export { AmplifyRenderer } from './AmplifyRenderer.mjs';
+export { Q as QueryContentError, e as QueryContentOptions, k as QueryFilter, l as QueryFilterOp, i as QueryPagination, h as QueryResult, m as QuerySort, j as QuerySpec, S as SelectVariantsError, a as SelectVariantsOptions, b as SelectVariantsResult, n as nextPageSpec, q as queryContent, d as searchSpec, s as selectVariants } from './query-6BmINKLR.mjs';
 export { i as isComposerPreview, a as isPreviewRequest, b as isWorkingContentRequest } from './preview-_vHmzRen.mjs';
 export { fetchPageConfigServer } from './server.mjs';
 
@@ -19,7 +20,7 @@ interface AmplifyPageContentProps {
     fallback?: ReactNode;
     /** Maps AmplifyUp component IDs to your React components. */
     renderComponent: RenderComponentFn;
-    /** Optional pre-fetched layout (e.g. from server in preview mode). */
+    /** SSG/ISR layout from the server. Client overlay applies only when variants differ. */
     pageConfig?: PageConfig | null;
     /**
      * Force Composer mode (e.g. from SSR `?preview=true`). Ensures the page slot
@@ -37,6 +38,9 @@ interface AmplifyPageContentProps {
 /**
  * Hybrid page wrapper: Composer shows only the AmplifyUp layout canvas;
  * normal visits show the configured layout or your native `fallback`.
+ *
+ * Live pages paint the SSG/ISR layout first. Client Edge resolve (visitor id)
+ * overlays only when the personalized tree differs from that static HTML.
  */
 declare function AmplifyPageContent({ fallback, renderComponent, pageConfig: pageConfigProp, forceComposerPreview, previewLoadingComponent, previewEmptyComponent, loadingComponent, emptyComponent, errorComponent, }: AmplifyPageContentProps): react_jsx_runtime.JSX.Element | null;
 

package/dist/react.d.ts

@@ -1,8 +1,9 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React, { ReactNode } from 'react';
-import { P as PageConfig, b as AmplifyUpConfig, C as ContentSource, A as AmplifyContentMeta } from './types-npF_lNoq.js';
-export { Z as ZoneConfig } from './types-npF_lNoq.js';
+import { P as PageConfig, b as AmplifyUpConfig, C as ContentSource, A as AmplifyContentMeta } from './types-CBoVIFI8.js';
+export { Z as ZoneConfig } from './types-CBoVIFI8.js';
 export { AmplifyRenderer } from './AmplifyRenderer.js';
+export { Q as QueryContentError, e as QueryContentOptions, k as QueryFilter, l as QueryFilterOp, i as QueryPagination, h as QueryResult, m as QuerySort, j as QuerySpec, S as SelectVariantsError, a as SelectVariantsOptions, b as SelectVariantsResult, n as nextPageSpec, q as queryContent, d as searchSpec, s as selectVariants } from './query-DjIuJ71C.js';
 export { i as isComposerPreview, a as isPreviewRequest, b as isWorkingContentRequest } from './preview-_vHmzRen.js';
 export { fetchPageConfigServer } from './server.js';
 
@@ -19,7 +20,7 @@ interface AmplifyPageContentProps {
     fallback?: ReactNode;
     /** Maps AmplifyUp component IDs to your React components. */
     renderComponent: RenderComponentFn;
-    /** Optional pre-fetched layout (e.g. from server in preview mode). */
+    /** SSG/ISR layout from the server. Client overlay applies only when variants differ. */
     pageConfig?: PageConfig | null;
     /**
      * Force Composer mode (e.g. from SSR `?preview=true`). Ensures the page slot
@@ -37,6 +38,9 @@ interface AmplifyPageContentProps {
 /**
  * Hybrid page wrapper: Composer shows only the AmplifyUp layout canvas;
  * normal visits show the configured layout or your native `fallback`.
+ *
+ * Live pages paint the SSG/ISR layout first. Client Edge resolve (visitor id)
+ * overlays only when the personalized tree differs from that static HTML.
  */
 declare function AmplifyPageContent({ fallback, renderComponent, pageConfig: pageConfigProp, forceComposerPreview, previewLoadingComponent, previewEmptyComponent, loadingComponent, emptyComponent, errorComponent, }: AmplifyPageContentProps): react_jsx_runtime.JSX.Element | null;