@uniformdev/next-app-router 20.80.2 → 20.81.1-alpha.10.sha-def425616f

package/dist/models-C8OdCO44.d.mts

@@ -0,0 +1,72 @@
+import { PageState } from '@uniformdev/next-app-router-shared';
+import { ManifestV2 } from '@uniformdev/context';
+
+type ManifestProviderOptions = {
+    /**
+     * Extends the request's lifetime until the promise settles, for work like writing the manifest
+     * to a cache after the response is sent. The edge middleware passes the proxy's
+     * `event.waitUntil`.
+     */
+    waitUntil: (promise: Promise<unknown>) => void;
+};
+/**
+ * Loads the Context manifest the edge middleware chooses variants with. Called once per HTML
+ * document request. Resolves to the manifest or throws.
+ */
+type ManifestProvider = (options: ManifestProviderOptions) => Promise<ManifestV2>;
+/**
+ * A platform's shared cache, which a cached manifest provider stores the manifest in between
+ * instances. Vercel's runtime cache from `getCache()` in `@vercel/functions` matches this shape.
+ */
+type ManifestCache = {
+    /** Resolves to the stored value, or `null` or `undefined` when there is none. */
+    get: (key: string) => Promise<unknown>;
+    set: (key: string, value: ManifestV2, options: {
+        ttl: number;
+        tags: string[];
+    }) => Promise<void>;
+};
+
+type EdgeRouteFilterOptions = {
+    /** The page state of the published request, before `edgeMode` is set on it. */
+    pageState: PageState;
+    /**
+     * Extends the request's lifetime until the promise settles, for work like writing to a cache
+     * after the response is sent. The edge middleware passes the proxy's `event.waitUntil`.
+     */
+    waitUntil: ManifestProviderOptions['waitUntil'];
+};
+/**
+ * Decides which published pages `uniformEdgeMiddleware` fetches and transforms at the edge. A page
+ * the filter skips is rewritten to its code without `edgeMode`, so it stays cacheable by the CDN
+ * and its personalizations and tests are chosen in the browser.
+ */
+type EdgeRouteFilter = {
+    /** Whether the page may contain personalization or test placements to process at the edge. */
+    shouldProcess: (options: EdgeRouteFilterOptions) => boolean | Promise<boolean>;
+    /**
+     * Called after the edge middleware transformed a page that answered 200, with whether the page
+     * contained placements. Not called when the transform failed or the visitor disconnected.
+     */
+    observe?: (options: EdgeRouteFilterOptions & {
+        hasPlacements: boolean;
+    }) => void;
+};
+/** What a learned edge route filter remembers about a page. */
+type EdgeRouteRecord = {
+    hasPlacements: boolean;
+};
+/**
+ * A platform's shared cache, which a learned edge route filter stores its records in between
+ * instances. Vercel's runtime cache from `getCache()` in `@vercel/functions` matches this shape.
+ */
+type EdgeRouteFilterCache = {
+    /** Resolves to the stored value, or `null` or `undefined` when there is none. */
+    get: (key: string) => Promise<unknown>;
+    set: (key: string, value: EdgeRouteRecord, options: {
+        ttl: number;
+        tags: string[];
+    }) => Promise<void>;
+};
+
+export type { EdgeRouteFilter as E, ManifestProvider as M, ManifestProviderOptions as a, EdgeRouteFilterCache as b, EdgeRouteFilterOptions as c, EdgeRouteRecord as d, ManifestCache as e };

package/dist/models-C8OdCO44.d.ts

@@ -0,0 +1,72 @@
+import { PageState } from '@uniformdev/next-app-router-shared';
+import { ManifestV2 } from '@uniformdev/context';
+
+type ManifestProviderOptions = {
+    /**
+     * Extends the request's lifetime until the promise settles, for work like writing the manifest
+     * to a cache after the response is sent. The edge middleware passes the proxy's
+     * `event.waitUntil`.
+     */
+    waitUntil: (promise: Promise<unknown>) => void;
+};
+/**
+ * Loads the Context manifest the edge middleware chooses variants with. Called once per HTML
+ * document request. Resolves to the manifest or throws.
+ */
+type ManifestProvider = (options: ManifestProviderOptions) => Promise<ManifestV2>;
+/**
+ * A platform's shared cache, which a cached manifest provider stores the manifest in between
+ * instances. Vercel's runtime cache from `getCache()` in `@vercel/functions` matches this shape.
+ */
+type ManifestCache = {
+    /** Resolves to the stored value, or `null` or `undefined` when there is none. */
+    get: (key: string) => Promise<unknown>;
+    set: (key: string, value: ManifestV2, options: {
+        ttl: number;
+        tags: string[];
+    }) => Promise<void>;
+};
+
+type EdgeRouteFilterOptions = {
+    /** The page state of the published request, before `edgeMode` is set on it. */
+    pageState: PageState;
+    /**
+     * Extends the request's lifetime until the promise settles, for work like writing to a cache
+     * after the response is sent. The edge middleware passes the proxy's `event.waitUntil`.
+     */
+    waitUntil: ManifestProviderOptions['waitUntil'];
+};
+/**
+ * Decides which published pages `uniformEdgeMiddleware` fetches and transforms at the edge. A page
+ * the filter skips is rewritten to its code without `edgeMode`, so it stays cacheable by the CDN
+ * and its personalizations and tests are chosen in the browser.
+ */
+type EdgeRouteFilter = {
+    /** Whether the page may contain personalization or test placements to process at the edge. */
+    shouldProcess: (options: EdgeRouteFilterOptions) => boolean | Promise<boolean>;
+    /**
+     * Called after the edge middleware transformed a page that answered 200, with whether the page
+     * contained placements. Not called when the transform failed or the visitor disconnected.
+     */
+    observe?: (options: EdgeRouteFilterOptions & {
+        hasPlacements: boolean;
+    }) => void;
+};
+/** What a learned edge route filter remembers about a page. */
+type EdgeRouteRecord = {
+    hasPlacements: boolean;
+};
+/**
+ * A platform's shared cache, which a learned edge route filter stores its records in between
+ * instances. Vercel's runtime cache from `getCache()` in `@vercel/functions` matches this shape.
+ */
+type EdgeRouteFilterCache = {
+    /** Resolves to the stored value, or `null` or `undefined` when there is none. */
+    get: (key: string) => Promise<unknown>;
+    set: (key: string, value: EdgeRouteRecord, options: {
+        ttl: number;
+        tags: string[];
+    }) => Promise<void>;
+};
+
+export type { EdgeRouteFilter as E, ManifestProvider as M, ManifestProviderOptions as a, EdgeRouteFilterCache as b, EdgeRouteFilterOptions as c, EdgeRouteRecord as d, ManifestCache as e };

package/dist/resolveRouteFromPath-CnfnaxY2.d.ts

@@ -0,0 +1,80 @@
+import { R as ResolvedCompositionResult, a as ResolvedRouteResult } from './composition-CGU7iH-k.js';
+import { PageState } from '@uniformdev/next-app-router-shared';
+
+/**
+ * The page state a resolver runs for, which sets the composition state, release and locale. Pass
+ * the page's `code` path segment, or a page state from `deserializePageState` or an earlier
+ * resolver's result.
+ */
+type PageStateSource = {
+    code: string;
+    pageState?: never;
+} | {
+    pageState: PageState;
+    code?: never;
+};
+
+type ResolveCompositionByIdOptions = PageStateSource & {
+    compositionId: string;
+    /**
+     * Reported to analytics as the composition's matched route.
+     *
+     * @defaultValue the page state's `routePath`
+     */
+    matchedRoute?: string;
+};
+/**
+ * Resolves a composition by id for a page state or a page's code, without the Route API. The
+ * editor state falls back to the draft state, and the returned page state carries the state that
+ * resolved. `route` is undefined when no composition has the id.
+ */
+declare const resolveCompositionById: ({ compositionId, matchedRoute, ...source }: ResolveCompositionByIdOptions) => Promise<ResolvedCompositionResult>;
+
+type ResolveCompositionBySlugOptions = PageStateSource & {
+    slug: string;
+    /**
+     * Reported to analytics as the composition's matched route.
+     *
+     * @defaultValue the page state's `routePath`
+     */
+    matchedRoute?: string;
+};
+/**
+ * Resolves a composition by slug for a page state or a page's code, without the Route API. The
+ * editor state falls back to the draft state, and the returned page state carries the state that
+ * resolved. `route` is undefined when no composition has the slug. Publishing a composition
+ * revalidates its current slug, so a renamed slug serves the cached composition until it expires.
+ */
+declare const resolveCompositionBySlug: ({ slug, matchedRoute, ...source }: ResolveCompositionBySlugOptions) => Promise<ResolvedCompositionResult>;
+
+type ResolveRouteFunction = (options: ResolveRouteFromCodeOptions) => Promise<ResolvedRouteResult>;
+type ResolveRouteFromCodeOptions = {
+    code: string;
+};
+/**
+ * Resolves the route of a `[code]` path segment through the Route API, returning a composition, a
+ * redirect, or no `route` when the path matches neither. Pass the result to `requireComposition`
+ * to apply redirects and not found. A code in the editor state falls back to the draft state when
+ * the composition has no editor state, and the returned page state carries the state that
+ * resolved.
+ */
+declare const resolveRouteFromCode: ResolveRouteFunction;
+
+type ResolveRouteFromPathOptions = PageStateSource & {
+    /**
+     * Project map path to resolve, for example `/site-settings` or `/en/404`. Replaces the page
+     * state's route path on the result.
+     */
+    path: string;
+};
+/**
+ * Resolves a project map path through the Route API for a page state or a page's code, returning
+ * a composition, a redirect, or no `route` when the path matches neither. Unlike
+ * `resolveCompositionBySlug` and `resolveCompositionById`, it evaluates redirects, resolves dynamic
+ * segments into `dynamicInputs` and matches the locale against the project map. The editor state
+ * falls back to the draft state, and the returned page state carries the path and the state that
+ * resolved.
+ */
+declare const resolveRouteFromPath: ({ path, ...source }: ResolveRouteFromPathOptions) => Promise<ResolvedRouteResult>;
+
+export { type PageStateSource as P, type ResolveCompositionByIdOptions as R, type ResolveCompositionBySlugOptions as a, type ResolveRouteFromCodeOptions as b, type ResolveRouteFromPathOptions as c, type ResolveRouteFunction as d, resolveCompositionBySlug as e, resolveRouteFromCode as f, resolveRouteFromPath as g, resolveCompositionById as r };

package/dist/resolveRouteFromPath-_rauUskz.d.mts

@@ -0,0 +1,80 @@
+import { R as ResolvedCompositionResult, a as ResolvedRouteResult } from './composition-CGU7iH-k.mjs';
+import { PageState } from '@uniformdev/next-app-router-shared';
+
+/**
+ * The page state a resolver runs for, which sets the composition state, release and locale. Pass
+ * the page's `code` path segment, or a page state from `deserializePageState` or an earlier
+ * resolver's result.
+ */
+type PageStateSource = {
+    code: string;
+    pageState?: never;
+} | {
+    pageState: PageState;
+    code?: never;
+};
+
+type ResolveCompositionByIdOptions = PageStateSource & {
+    compositionId: string;
+    /**
+     * Reported to analytics as the composition's matched route.
+     *
+     * @defaultValue the page state's `routePath`
+     */
+    matchedRoute?: string;
+};
+/**
+ * Resolves a composition by id for a page state or a page's code, without the Route API. The
+ * editor state falls back to the draft state, and the returned page state carries the state that
+ * resolved. `route` is undefined when no composition has the id.
+ */
+declare const resolveCompositionById: ({ compositionId, matchedRoute, ...source }: ResolveCompositionByIdOptions) => Promise<ResolvedCompositionResult>;
+
+type ResolveCompositionBySlugOptions = PageStateSource & {
+    slug: string;
+    /**
+     * Reported to analytics as the composition's matched route.
+     *
+     * @defaultValue the page state's `routePath`
+     */
+    matchedRoute?: string;
+};
+/**
+ * Resolves a composition by slug for a page state or a page's code, without the Route API. The
+ * editor state falls back to the draft state, and the returned page state carries the state that
+ * resolved. `route` is undefined when no composition has the slug. Publishing a composition
+ * revalidates its current slug, so a renamed slug serves the cached composition until it expires.
+ */
+declare const resolveCompositionBySlug: ({ slug, matchedRoute, ...source }: ResolveCompositionBySlugOptions) => Promise<ResolvedCompositionResult>;
+
+type ResolveRouteFunction = (options: ResolveRouteFromCodeOptions) => Promise<ResolvedRouteResult>;
+type ResolveRouteFromCodeOptions = {
+    code: string;
+};
+/**
+ * Resolves the route of a `[code]` path segment through the Route API, returning a composition, a
+ * redirect, or no `route` when the path matches neither. Pass the result to `requireComposition`
+ * to apply redirects and not found. A code in the editor state falls back to the draft state when
+ * the composition has no editor state, and the returned page state carries the state that
+ * resolved.
+ */
+declare const resolveRouteFromCode: ResolveRouteFunction;
+
+type ResolveRouteFromPathOptions = PageStateSource & {
+    /**
+     * Project map path to resolve, for example `/site-settings` or `/en/404`. Replaces the page
+     * state's route path on the result.
+     */
+    path: string;
+};
+/**
+ * Resolves a project map path through the Route API for a page state or a page's code, returning
+ * a composition, a redirect, or no `route` when the path matches neither. Unlike
+ * `resolveCompositionBySlug` and `resolveCompositionById`, it evaluates redirects, resolves dynamic
+ * segments into `dynamicInputs` and matches the locale against the project map. The editor state
+ * falls back to the draft state, and the returned page state carries the path and the state that
+ * resolved.
+ */
+declare const resolveRouteFromPath: ({ path, ...source }: ResolveRouteFromPathOptions) => Promise<ResolvedRouteResult>;
+
+export { type PageStateSource as P, type ResolveCompositionByIdOptions as R, type ResolveCompositionBySlugOptions as a, type ResolveRouteFromCodeOptions as b, type ResolveRouteFromPathOptions as c, type ResolveRouteFunction as d, resolveCompositionBySlug as e, resolveRouteFromCode as f, resolveRouteFromPath as g, resolveCompositionById as r };

package/dist/vercel.d.mts

@@ -0,0 +1,37 @@
+import { a as CreateLearnedEdgeRouteFilterOptions, C as CreateCachedManifestProviderOptions } from './createCachedManifestProvider-2-2u3PYd.mjs';
+import { E as EdgeRouteFilter, M as ManifestProvider } from './models-C8OdCO44.mjs';
+import '@uniformdev/context';
+import '@uniformdev/next-app-router-shared';
+
+/**
+ * Expires Vercel runtime cache entries with any of the given tags. Pass it as `onRevalidateTags`
+ * to `createPreviewPOSTRouteHandler`, so publishing the manifest expires the copy
+ * `vercelManifestProvider` stored. Does nothing under `next dev` without `RUNTIME_CACHE_ENDPOINT`.
+ *
+ * Requires the optional peer dependency `@vercel/functions`.
+ */
+declare const expireVercelRuntimeCacheTags: (tags: string[]) => Promise<void>;
+
+/**
+ * Creates a learned edge route filter for `uniformEdgeMiddleware` that stores what it learns in
+ * Vercel's runtime cache, tagged with each page's `path:` tag. Pair it with
+ * `expireVercelRuntimeCacheTags` in the preview route handler so publishing a composition or
+ * changing the project map expires the records of its paths. Under `next dev` without
+ * `RUNTIME_CACHE_ENDPOINT`, each instance remembers on its own.
+ *
+ * Requires the optional peer dependency `@vercel/functions`.
+ */
+declare const vercelEdgeRouteFilter: (options?: Omit<CreateLearnedEdgeRouteFilterOptions, "cache">) => EdgeRouteFilter;
+
+/**
+ * Creates a manifest provider for `uniformEdgeMiddleware` that stores the published manifest in
+ * Vercel's runtime cache, tagged `manifest`, and loads it from the Uniform API on a miss. Pair it
+ * with `expireVercelRuntimeCacheTags` in the preview route handler so publishing the manifest
+ * expires the cached copy. Under `next dev` without `RUNTIME_CACHE_ENDPOINT`, it skips the
+ * runtime cache and loads from the API.
+ *
+ * Requires the optional peer dependency `@vercel/functions`.
+ */
+declare const vercelManifestProvider: (options?: Omit<CreateCachedManifestProviderOptions, "cache">) => ManifestProvider;
+
+export { expireVercelRuntimeCacheTags, vercelEdgeRouteFilter, vercelManifestProvider };

package/dist/vercel.d.ts

@@ -0,0 +1,37 @@
+import { a as CreateLearnedEdgeRouteFilterOptions, C as CreateCachedManifestProviderOptions } from './createCachedManifestProvider-BoorKD15.js';
+import { E as EdgeRouteFilter, M as ManifestProvider } from './models-C8OdCO44.js';
+import '@uniformdev/context';
+import '@uniformdev/next-app-router-shared';
+
+/**
+ * Expires Vercel runtime cache entries with any of the given tags. Pass it as `onRevalidateTags`
+ * to `createPreviewPOSTRouteHandler`, so publishing the manifest expires the copy
+ * `vercelManifestProvider` stored. Does nothing under `next dev` without `RUNTIME_CACHE_ENDPOINT`.
+ *
+ * Requires the optional peer dependency `@vercel/functions`.
+ */
+declare const expireVercelRuntimeCacheTags: (tags: string[]) => Promise<void>;
+
+/**
+ * Creates a learned edge route filter for `uniformEdgeMiddleware` that stores what it learns in
+ * Vercel's runtime cache, tagged with each page's `path:` tag. Pair it with
+ * `expireVercelRuntimeCacheTags` in the preview route handler so publishing a composition or
+ * changing the project map expires the records of its paths. Under `next dev` without
+ * `RUNTIME_CACHE_ENDPOINT`, each instance remembers on its own.
+ *
+ * Requires the optional peer dependency `@vercel/functions`.
+ */
+declare const vercelEdgeRouteFilter: (options?: Omit<CreateLearnedEdgeRouteFilterOptions, "cache">) => EdgeRouteFilter;
+
+/**
+ * Creates a manifest provider for `uniformEdgeMiddleware` that stores the published manifest in
+ * Vercel's runtime cache, tagged `manifest`, and loads it from the Uniform API on a miss. Pair it
+ * with `expireVercelRuntimeCacheTags` in the preview route handler so publishing the manifest
+ * expires the cached copy. Under `next dev` without `RUNTIME_CACHE_ENDPOINT`, it skips the
+ * runtime cache and loads from the API.
+ *
+ * Requires the optional peer dependency `@vercel/functions`.
+ */
+declare const vercelManifestProvider: (options?: Omit<CreateCachedManifestProviderOptions, "cache">) => ManifestProvider;
+
+export { expireVercelRuntimeCacheTags, vercelEdgeRouteFilter, vercelManifestProvider };