@amplifyup/sdk 0.1.33 → 0.1.35

package/dist/server.d.mts

@@ -1,13 +1,24 @@
-import { f as AmplifyUpTarget, P as PageConfig, A as AmplifyContentMeta } from './types-npF_lNoq.mjs';
-export { r as resolveAmplifyUpTarget, g as resolveAmplifyUpUrls } from './types-npF_lNoq.mjs';
+import { f as AmplifyUpTarget, P as PageConfig, A as AmplifyContentMeta } from './types-CBoVIFI8.mjs';
+export { r as resolveAmplifyUpTarget, g as resolveAmplifyUpUrls } from './types-CBoVIFI8.mjs';
+export { g as FetchEdgeQueryOptions, F as FetchEdgeSelectOptions, 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, c as fetchEdgeQuery, f as fetchEdgeSelect, n as nextPageSpec, q as queryContent, d as searchSpec, s as selectVariants } from './query-6BmINKLR.mjs';
+
+/**
+ * Compact variant-key codec for URLs and Edge `variants` query params.
+ * Default variants are omitted so equivalent assignments share one cache entry.
+ */
+declare function serializeVariantKeys(keys: Record<string, string> | null | undefined): string;
+declare function parseVariantKeys(raw: string | null | undefined): Record<string, string>;
+declare function isDefaultVariantKeys(keys: Record<string, string> | null | undefined): boolean;
 
 /**
  * Server-side utilities for AmplifyUp SDK
  *
- * Provides functions for fetching page config on the server
- * for SSR/SSG support (Composer preview → orchestrator; production → Edge).
+ * Production: SSG at build (Edge /v1/routes + /v1/resolve), then ISR for
+ * unknown routes (SSR once → static). Composer preview stays dynamic.
  */
 
+/** Default ISR window for published Edge pages (seconds). */
+declare const AMPLIFY_DEFAULT_REVALIDATE = 60;
 /**
  * Fetch page configuration on the server.
  * Production visitors resolve via Edge; Composer preview uses the orchestrator.
@@ -23,6 +34,10 @@ declare function fetchPageConfigServer(route: string, trackingId: string, previe
     siteId?: string | null;
     /** Raw search params — used to detect Composer preview when preview flag omitted. */
     searchParams?: URLSearchParams | Record<string, string | string[] | undefined>;
+    /** Next.js ISR for Edge resolve. Ignored in preview. Default 60s. */
+    revalidate?: number | false;
+    /** Cacheable variant combo (personalized ISR). Do not pass anonId with this. */
+    variantKeys?: Record<string, string> | null;
 }): Promise<PageConfig | null>;
 /**
  * Same as fetchPageConfigServer but also returns content source meta
@@ -34,10 +49,32 @@ declare function fetchContentServer(route: string, trackingId: string, options?:
     anonId?: string | null;
     siteId?: string | null;
     searchParams?: URLSearchParams | Record<string, string | string[] | undefined>;
+    revalidate?: number | false;
+    variantKeys?: Record<string, string> | null;
 }): Promise<{
     pageConfig: PageConfig | null;
     meta: AmplifyContentMeta | null;
     error: string | null;
 }>;
+/**
+ * Published routes for a tracking id (Edge KV). Soft-fails to [] if Edge is down.
+ */
+declare function listPublishedRoutes(trackingId: string, options?: {
+    target?: AmplifyUpTarget;
+    siteId?: string | null;
+}): Promise<string[]>;
+/**
+ * Use from Next.js `generateStaticParams` on a catch-all page.
+ * Always includes `/`. Soft-fails to home-only if Edge is unreachable at build.
+ *
+ * Skips the Edge route list during `next dev` unless `generateStaticPaths: true`.
+ */
+declare function generateAmplifyStaticParams(trackingId: string, options?: {
+    target?: AmplifyUpTarget;
+    siteId?: string | null;
+    generateStaticPaths?: boolean;
+}): Promise<{
+    slug: string[];
+}[]>;
 
-export { fetchContentServer, fetchPageConfigServer };
+export { AMPLIFY_DEFAULT_REVALIDATE, fetchContentServer, fetchPageConfigServer, generateAmplifyStaticParams, isDefaultVariantKeys, listPublishedRoutes, parseVariantKeys, serializeVariantKeys };

package/dist/server.d.ts

@@ -1,13 +1,24 @@
-import { f as AmplifyUpTarget, P as PageConfig, A as AmplifyContentMeta } from './types-npF_lNoq.js';
-export { r as resolveAmplifyUpTarget, g as resolveAmplifyUpUrls } from './types-npF_lNoq.js';
+import { f as AmplifyUpTarget, P as PageConfig, A as AmplifyContentMeta } from './types-CBoVIFI8.js';
+export { r as resolveAmplifyUpTarget, g as resolveAmplifyUpUrls } from './types-CBoVIFI8.js';
+export { g as FetchEdgeQueryOptions, F as FetchEdgeSelectOptions, 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, c as fetchEdgeQuery, f as fetchEdgeSelect, n as nextPageSpec, q as queryContent, d as searchSpec, s as selectVariants } from './query-DjIuJ71C.js';
+
+/**
+ * Compact variant-key codec for URLs and Edge `variants` query params.
+ * Default variants are omitted so equivalent assignments share one cache entry.
+ */
+declare function serializeVariantKeys(keys: Record<string, string> | null | undefined): string;
+declare function parseVariantKeys(raw: string | null | undefined): Record<string, string>;
+declare function isDefaultVariantKeys(keys: Record<string, string> | null | undefined): boolean;
 
 /**
  * Server-side utilities for AmplifyUp SDK
  *
- * Provides functions for fetching page config on the server
- * for SSR/SSG support (Composer preview → orchestrator; production → Edge).
+ * Production: SSG at build (Edge /v1/routes + /v1/resolve), then ISR for
+ * unknown routes (SSR once → static). Composer preview stays dynamic.
  */
 
+/** Default ISR window for published Edge pages (seconds). */
+declare const AMPLIFY_DEFAULT_REVALIDATE = 60;
 /**
  * Fetch page configuration on the server.
  * Production visitors resolve via Edge; Composer preview uses the orchestrator.
@@ -23,6 +34,10 @@ declare function fetchPageConfigServer(route: string, trackingId: string, previe
     siteId?: string | null;
     /** Raw search params — used to detect Composer preview when preview flag omitted. */
     searchParams?: URLSearchParams | Record<string, string | string[] | undefined>;
+    /** Next.js ISR for Edge resolve. Ignored in preview. Default 60s. */
+    revalidate?: number | false;
+    /** Cacheable variant combo (personalized ISR). Do not pass anonId with this. */
+    variantKeys?: Record<string, string> | null;
 }): Promise<PageConfig | null>;
 /**
  * Same as fetchPageConfigServer but also returns content source meta
@@ -34,10 +49,32 @@ declare function fetchContentServer(route: string, trackingId: string, options?:
     anonId?: string | null;
     siteId?: string | null;
     searchParams?: URLSearchParams | Record<string, string | string[] | undefined>;
+    revalidate?: number | false;
+    variantKeys?: Record<string, string> | null;
 }): Promise<{
     pageConfig: PageConfig | null;
     meta: AmplifyContentMeta | null;
     error: string | null;
 }>;
+/**
+ * Published routes for a tracking id (Edge KV). Soft-fails to [] if Edge is down.
+ */
+declare function listPublishedRoutes(trackingId: string, options?: {
+    target?: AmplifyUpTarget;
+    siteId?: string | null;
+}): Promise<string[]>;
+/**
+ * Use from Next.js `generateStaticParams` on a catch-all page.
+ * Always includes `/`. Soft-fails to home-only if Edge is unreachable at build.
+ *
+ * Skips the Edge route list during `next dev` unless `generateStaticPaths: true`.
+ */
+declare function generateAmplifyStaticParams(trackingId: string, options?: {
+    target?: AmplifyUpTarget;
+    siteId?: string | null;
+    generateStaticPaths?: boolean;
+}): Promise<{
+    slug: string[];
+}[]>;
 
-export { fetchContentServer, fetchPageConfigServer };
+export { AMPLIFY_DEFAULT_REVALIDATE, fetchContentServer, fetchPageConfigServer, generateAmplifyStaticParams, isDefaultVariantKeys, listPublishedRoutes, parseVariantKeys, serializeVariantKeys };

package/dist/server.js

@@ -119,6 +119,43 @@ function normalizeRoute(route) {
   return path || "/";
 }
 
+// src/edge/variantKeys.ts
+function serializeVariantKeys(keys) {
+  if (!keys) return "";
+  const parts = [];
+  const zoneIds = Object.keys(keys).sort();
+  for (const zoneId of zoneIds) {
+    const variant = keys[zoneId];
+    if (!variant || variant === "default") continue;
+    parts.push(`${zoneId}:${variant}`);
+  }
+  return parts.join(",");
+}
+function parseVariantKeys(raw) {
+  const out = {};
+  const text = (raw || "").trim();
+  if (!text) return out;
+  const decoded = safeDecode(text);
+  for (const part of decoded.split(",")) {
+    const i = part.indexOf(":");
+    if (i <= 0) continue;
+    const zoneId = part.slice(0, i).trim();
+    const variant = part.slice(i + 1).trim();
+    if (zoneId && variant) out[zoneId] = variant;
+  }
+  return out;
+}
+function isDefaultVariantKeys(keys) {
+  return serializeVariantKeys(keys) === "";
+}
+function safeDecode(value) {
+  try {
+    return decodeURIComponent(value);
+  } catch {
+    return value;
+  }
+}
+
 // src/edge/resolve.ts
 var EdgeResolveError = class extends Error {
   constructor(message, status, body) {
@@ -136,12 +173,23 @@ async function fetchEdgeResolve(options) {
     trackingId: options.trackingId
   });
   if (options.siteId) params.set("site", options.siteId);
-  if (options.anonId) params.set("anonId", options.anonId);
+  const variantParam = serializeVariantKeys(options.variantKeys);
+  if (variantParam) {
+    params.set("variants", variantParam);
+  } else if (options.anonId) {
+    params.set("anonId", options.anonId);
+  }
   const fetchFn = options.fetch ?? globalThis.fetch.bind(globalThis);
-  const res = await fetchFn(`${base}/v1/resolve?${params.toString()}`, {
+  const init = {
     method: "GET",
     headers: { Accept: "application/json" }
-  });
+  };
+  if (options.revalidate !== void 0) {
+    init.next = { revalidate: options.revalidate };
+  } else {
+    init.cache = "no-store";
+  }
+  const res = await fetchFn(`${base}/v1/resolve?${params.toString()}`, init);
   const body = await res.json().catch(() => ({}));
   if (!res.ok) {
     throw new EdgeResolveError(
@@ -230,9 +278,11 @@ async function fetchContent(options) {
       edgeUrl: options.edgeUrl,
       trackingId: options.trackingId,
       route: options.route,
-      anonId: options.anonId,
+      anonId: options.variantKeys ? void 0 : options.anonId,
       siteId: options.siteId,
-      fetch: options.fetchFn
+      fetch: options.fetchFn,
+      revalidate: options.revalidate,
+      variantKeys: options.variantKeys
     });
     const pageConfig = mapResolvedToPageConfig(payload);
     const degraded = collectDegraded(payload);
@@ -270,7 +320,176 @@ async function fetchContent(options) {
   }
 }
 
+// src/edge/routes.ts
+async function fetchEdgeRoutes(options) {
+  const base = options.edgeUrl.replace(/\/+$/, "");
+  const params = new URLSearchParams();
+  if (options.trackingId) params.set("trackingId", options.trackingId);
+  if (options.siteId) params.set("site", options.siteId);
+  const fetchFn = options.fetch ?? globalThis.fetch.bind(globalThis);
+  const controller = new AbortController();
+  const timer = setTimeout(() => controller.abort(), 8e3);
+  try {
+    const res = await fetchFn(`${base}/v1/routes?${params.toString()}`, {
+      method: "GET",
+      headers: { Accept: "application/json" },
+      cache: "no-store",
+      signal: controller.signal
+    });
+    const body = await res.json().catch(() => ({}));
+    if (!res.ok) {
+      throw new Error(body.error || `Edge routes failed (${res.status})`);
+    }
+    return {
+      siteId: body.siteId || "",
+      routes: Array.isArray(body.routes) ? body.routes : []
+    };
+  } finally {
+    clearTimeout(timer);
+  }
+}
+
+// src/edge/select.ts
+var SelectVariantsError = class extends Error {
+  constructor(message, status, body) {
+    super(message);
+    this.name = "SelectVariantsError";
+    this.status = status;
+    this.body = body;
+  }
+};
+async function fetchEdgeSelect(options) {
+  const base = options.edgeUrl.replace(/\/+$/, "");
+  const fetchFn = options.fetch ?? globalThis.fetch.bind(globalThis);
+  if (!options.trackingId && !options.site) {
+    throw new SelectVariantsError("trackingId or site is required", 400);
+  }
+  const res = await fetchFn(`${base}/v1/select`, {
+    method: "POST",
+    headers: {
+      Accept: "application/json",
+      "Content-Type": "application/json"
+    },
+    cache: "no-store",
+    signal: options.signal,
+    body: JSON.stringify({
+      view: normalizeRoute(options.view),
+      ...options.trackingId ? { trackingId: options.trackingId } : {},
+      ...options.site ? { site: options.site } : {},
+      anonId: options.anonId,
+      ...options.zones?.length ? { zones: options.zones } : {},
+      ...options.context ? { context: options.context } : {}
+    })
+  });
+  const body = await res.json().catch(() => ({}));
+  if (!res.ok) {
+    throw new SelectVariantsError(
+      body.error || `Select failed (${res.status})`,
+      res.status,
+      body
+    );
+  }
+  return {
+    siteId: String(body.siteId || ""),
+    view: String(body.view || normalizeRoute(options.view)),
+    variantKeys: body.variantKeys && typeof body.variantKeys === "object" ? body.variantKeys : {},
+    meta: body.meta
+  };
+}
+async function selectVariants(options) {
+  const target = resolveAmplifyUpTarget({ configTarget: options.target });
+  const { edgeUrl } = resolveAmplifyUpUrls(target);
+  return fetchEdgeSelect({
+    edgeUrl: options.edgeUrl || edgeUrl,
+    trackingId: options.trackingId,
+    site: options.site,
+    view: options.view,
+    anonId: options.anonId,
+    zones: options.zones,
+    context: options.context,
+    fetch: options.fetch,
+    signal: options.signal
+  });
+}
+
+// src/edge/query.ts
+var QueryContentError = class extends Error {
+  constructor(message, status, body) {
+    super(message);
+    this.name = "QueryContentError";
+    this.status = status;
+    this.body = body;
+  }
+};
+async function fetchEdgeQuery(options) {
+  const base = options.edgeUrl.replace(/\/+$/, "");
+  const fetchFn = options.fetch ?? globalThis.fetch.bind(globalThis);
+  const limit = Math.max(1, Number(options.spec.limit) || 10);
+  const offset = Math.max(0, Number(options.spec.offset) || 0);
+  const res = await fetchFn(`${base}/v1/query`, {
+    method: "POST",
+    headers: {
+      Accept: "application/json",
+      "Content-Type": "application/json"
+    },
+    cache: "no-store",
+    signal: options.signal,
+    body: JSON.stringify({
+      route: normalizeRoute(options.route),
+      trackingId: options.trackingId,
+      ...options.siteId ? { site: options.siteId } : {},
+      spec: { ...options.spec, limit, offset }
+    })
+  });
+  const body = await res.json().catch(() => ({}));
+  if (!res.ok) {
+    throw new QueryContentError(
+      body.error || `Content query failed (${res.status})`,
+      res.status,
+      body
+    );
+  }
+  const results = Array.isArray(body.results) ? body.results : [];
+  const resolvedLimit = Number(body.limit) || limit;
+  const resolvedOffset = Number.isFinite(Number(body.offset)) ? Number(body.offset) : offset;
+  return {
+    results,
+    count: Number(body.count) || results.length,
+    hasMore: !!body.hasMore,
+    limit: resolvedLimit,
+    offset: resolvedOffset,
+    nextOffset: Number(body.nextOffset) || resolvedOffset + resolvedLimit,
+    degraded: body.degraded
+  };
+}
+async function queryContent(options) {
+  const target = resolveAmplifyUpTarget({ configTarget: options.target });
+  const { edgeUrl } = resolveAmplifyUpUrls(target);
+  return fetchEdgeQuery({
+    edgeUrl,
+    trackingId: options.trackingId,
+    route: options.route,
+    spec: options.spec,
+    siteId: options.siteId,
+    fetch: options.fetch,
+    signal: options.signal
+  });
+}
+function nextPageSpec(pagination) {
+  return { ...pagination.spec, offset: pagination.nextOffset };
+}
+function searchSpec(pagination, field, term) {
+  const value = String(term || "").trim();
+  const base = { ...pagination.spec, offset: 0 };
+  if (!value) return base;
+  return {
+    ...base,
+    filter: [...base.filter || [], { field, op: "contains", value }]
+  };
+}
+
 // src/server.tsx
+var AMPLIFY_DEFAULT_REVALIDATE = 60;
 async function fetchPageConfigServer(route, trackingId, preview = false, options) {
   const target = resolveAmplifyUpTarget({
     configTarget: options?.target
@@ -306,7 +525,9 @@ async function fetchPageConfigServer(route, trackingId, preview = false, options
     preview: previewFlag,
     orchestratorUrl,
     edgeUrl,
-    fetchOrchestratorPage
+    fetchOrchestratorPage,
+    revalidate: previewFlag ? void 0 : options?.revalidate ?? AMPLIFY_DEFAULT_REVALIDATE,
+    variantKeys: previewFlag ? void 0 : options?.variantKeys
   });
   return result.pageConfig;
 }
@@ -344,7 +565,9 @@ async function fetchContentServer(route, trackingId, options) {
       } catch {
         return null;
       }
-    }
+    },
+    revalidate: previewFlag ? void 0 : options?.revalidate ?? AMPLIFY_DEFAULT_REVALIDATE,
+    variantKeys: previewFlag ? void 0 : options?.variantKeys
   });
   return {
     pageConfig: result.pageConfig,
@@ -352,10 +575,58 @@ async function fetchContentServer(route, trackingId, options) {
     error: result.error
   };
 }
+async function listPublishedRoutes(trackingId, options) {
+  if (!trackingId && !options?.siteId) return [];
+  const target = resolveAmplifyUpTarget({
+    configTarget: options?.target
+  });
+  const { edgeUrl } = resolveAmplifyUpUrls(target);
+  try {
+    const listed = await fetchEdgeRoutes({
+      edgeUrl,
+      trackingId: trackingId || void 0,
+      siteId: options?.siteId
+    });
+    return listed.routes;
+  } catch {
+    return [];
+  }
+}
+function routeToStaticParam(route) {
+  const normalized = normalizeRoute(route);
+  if (normalized === "/") return { slug: [] };
+  return { slug: normalized.replace(/^\//, "").split("/") };
+}
+async function generateAmplifyStaticParams(trackingId, options) {
+  const generateStaticPaths = options?.generateStaticPaths ?? process.env.NODE_ENV !== "development";
+  if (!generateStaticPaths) {
+    return [{ slug: [] }];
+  }
+  const routes = await listPublishedRoutes(trackingId, options);
+  const params = routes.map(routeToStaticParam);
+  if (!params.some((p) => p.slug.length === 0)) {
+    params.unshift({ slug: [] });
+  }
+  return params;
+}
 
+exports.AMPLIFY_DEFAULT_REVALIDATE = AMPLIFY_DEFAULT_REVALIDATE;
+exports.QueryContentError = QueryContentError;
+exports.SelectVariantsError = SelectVariantsError;
 exports.fetchContentServer = fetchContentServer;
+exports.fetchEdgeQuery = fetchEdgeQuery;
+exports.fetchEdgeSelect = fetchEdgeSelect;
 exports.fetchPageConfigServer = fetchPageConfigServer;
+exports.generateAmplifyStaticParams = generateAmplifyStaticParams;
+exports.isDefaultVariantKeys = isDefaultVariantKeys;
+exports.listPublishedRoutes = listPublishedRoutes;
+exports.nextPageSpec = nextPageSpec;
+exports.parseVariantKeys = parseVariantKeys;
+exports.queryContent = queryContent;
 exports.resolveAmplifyUpTarget = resolveAmplifyUpTarget;
 exports.resolveAmplifyUpUrls = resolveAmplifyUpUrls;
+exports.searchSpec = searchSpec;
+exports.selectVariants = selectVariants;
+exports.serializeVariantKeys = serializeVariantKeys;
 //# sourceMappingURL=server.js.map
 //# sourceMappingURL=server.js.map