@uniformdev/next-app-router 20.81.1-alpha.4.sha-de16ebeee7 → 20.81.1

package/dist/index.d.mts

@@ -1,13 +1,15 @@
-import { CanvasClient, CompositionDeliveryClient, RouteClient } from '@uniformdev/canvas';
+import { CanvasClient, CompositionDeliveryClient, RouteClient, ComponentInstance } from '@uniformdev/canvas';
 import { CacheMode, CanvasCacheMode, ManifestCacheMode, ProjectMapCacheMode, RewriteRequestPathResult } from '@uniformdev/next-app-router-shared';
 import { ManifestClient } from '@uniformdev/context/api';
 import { ProjectMapClient } from '@uniformdev/project-map';
-import { U as UniformCompositionProps } from './UniformComposition-fq7Qfhvp.mjs';
-export { C as CompositionCache, a as ResolveComponentFunction, R as ResolveComponentResult, b as UniformComposition, c as createCompositionCache } from './UniformComposition-fq7Qfhvp.mjs';
+import { U as UniformCompositionProps } from './UniformComposition-le6UEB_r.mjs';
+export { C as CompositionCache, a as ResolveComponentFunction, R as ResolveComponentResult, b as UniformComposition, c as createCompositionCache } from './UniformComposition-le6UEB_r.mjs';
 import React from 'react';
-import { a as ResolvedRouteResult } from './resolveRouteFromCode-CId7aItt.mjs';
-export { D as DataClient, b as DefaultDataClient, E as EnhanceRouteOptions, G as GetRouteOptions, c as GetRouteResult, R as ResolveRouteFunction, r as resolveRouteFromCode } from './resolveRouteFromCode-CId7aItt.mjs';
+export { D as DataClient, a as DefaultDataClient, E as EnhanceRouteOptions, G as GetRouteFromMiddlewareOptions, b as GetRouteFromPageStateOptions, c as GetRouteOptions, R as RewriteRouteOptions, d as RewriteRouteResult, e as expireMiddlewareCacheTag } from './client-BElN_CWD.mjs';
+import { a as ResolvedRouteResult } from './resolveRouteFromCode-CuJ4JHeb.mjs';
+export { R as ResolveRouteFunction, r as resolveRouteFromCode } from './resolveRouteFromCode-CuJ4JHeb.mjs';
 import '@uniformdev/next-app-router-client';
+import '@uniformdev/context';
 
 type SpecificCacheMode<TCacheMode extends CacheMode> = {
     cache: TCacheMode;
@@ -220,25 +222,44 @@ type CreateStaticParamsOptions = {
     locale?: string;
 };
 /**
- * Generates the playground code for the first of the given paths. Playground requests are drafts,
- * which evaluate while the page renders, so there is one code per composition.
+ * Function to generate all possible page states for the given paths in playground mode.
+ * @param options
+ * @returns
  */
 declare const createUniformPlaygroundStaticParams: (options: CreateStaticParamsOptions) => Promise<{
     code: string;
 }[]>;
 /**
- * Generates one code per published composition among the given paths, for `generateStaticParams`
- * of the `[code]` route. Codes carry the route, not an evaluation, so each path has one static page
- * whose variants are chosen in the browser or at the edge.
+ * Function to generate all possible page states for the given paths.
+ * @param options
+ * @returns
  */
 declare const createUniformStaticParams: (options: CreateStaticParamsOptions) => Promise<{
     code: string;
 }[]>;
 
-/**
- * Resolves the composition of a playground code. The code carries the composition id, and the
- * composition resolves in the editor state, falling back to the draft state.
- */
+type EvaluateTestsFunction = (test: {
+    name: string;
+    component: ComponentInstance;
+}) => boolean;
+type EvaluatePersonalizationsFunction = (personalization: {
+    name: string;
+    component: ComponentInstance;
+}) => boolean;
+type PrecomputeCompositionOptions = Pick<ResolvedRouteResult, 'pageState' | 'route'> & {
+    /**
+     * Whether to evaluate tests
+     * @defaultValue true
+     */
+    evaluateTests?: boolean | EvaluateTestsFunction;
+    /**
+     * Whether to evaluate personalizations
+     * @defaultValue true
+     */
+    evaluatePersonalizations?: boolean | EvaluatePersonalizationsFunction;
+};
+declare const precomputeComposition: ({ pageState, route, evaluatePersonalizations, evaluateTests, }: PrecomputeCompositionOptions) => Promise<void>;
+
 declare const resolvePlaygroundRoute: ({ code }: {
     code: string;
 }) => Promise<ResolvedRouteResult>;
@@ -255,4 +276,4 @@ declare const findRouteMatch: (routes: CustomRoute[], path: string) => RouteMatc
 
 declare const serverContext: <T>(defaultValue?: T) => [() => T | undefined, (v: T) => void];
 
-export { type AwaitedUniformPageParameters, type CreateStaticParamsOptions, type CustomRoute, type GetCanvasClientOptions, type GetCompositionDeliveryClientOptions, type GetManifestClientOptions, type GetProjectMapClientOptions, type GetRouteClientOptions, type PlaygroundParameters, type RouteMatch, UniformCompositionProps, type UniformPageParameters, UniformPlayground, createUniformPlaygroundStaticParams, createUniformStaticParams, findRouteMatch, getCanvasClient, getCompositionDeliveryClient, getManifest, getManifestClient, getProjectMapClient, getRouteClient, resolvePlaygroundRoute, serverContext };
+export { type AwaitedUniformPageParameters, type CreateStaticParamsOptions, type CustomRoute, type GetCanvasClientOptions, type GetCompositionDeliveryClientOptions, type GetManifestClientOptions, type GetProjectMapClientOptions, type GetRouteClientOptions, type PlaygroundParameters, type RouteMatch, UniformCompositionProps, type UniformPageParameters, UniformPlayground, createUniformPlaygroundStaticParams, createUniformStaticParams, findRouteMatch, getCanvasClient, getCompositionDeliveryClient, getManifest, getManifestClient, getProjectMapClient, getRouteClient, precomputeComposition, resolvePlaygroundRoute, serverContext };

package/dist/index.d.ts

@@ -1,13 +1,15 @@
-import { CanvasClient, CompositionDeliveryClient, RouteClient } from '@uniformdev/canvas';
+import { CanvasClient, CompositionDeliveryClient, RouteClient, ComponentInstance } from '@uniformdev/canvas';
 import { CacheMode, CanvasCacheMode, ManifestCacheMode, ProjectMapCacheMode, RewriteRequestPathResult } from '@uniformdev/next-app-router-shared';
 import { ManifestClient } from '@uniformdev/context/api';
 import { ProjectMapClient } from '@uniformdev/project-map';
-import { U as UniformCompositionProps } from './UniformComposition-T7CRvU1H.js';
-export { C as CompositionCache, a as ResolveComponentFunction, R as ResolveComponentResult, b as UniformComposition, c as createCompositionCache } from './UniformComposition-T7CRvU1H.js';
+import { U as UniformCompositionProps } from './UniformComposition-DBO-oo7J.js';
+export { C as CompositionCache, a as ResolveComponentFunction, R as ResolveComponentResult, b as UniformComposition, c as createCompositionCache } from './UniformComposition-DBO-oo7J.js';
 import React from 'react';
-import { a as ResolvedRouteResult } from './resolveRouteFromCode-CId7aItt.js';
-export { D as DataClient, b as DefaultDataClient, E as EnhanceRouteOptions, G as GetRouteOptions, c as GetRouteResult, R as ResolveRouteFunction, r as resolveRouteFromCode } from './resolveRouteFromCode-CId7aItt.js';
+export { D as DataClient, a as DefaultDataClient, E as EnhanceRouteOptions, G as GetRouteFromMiddlewareOptions, b as GetRouteFromPageStateOptions, c as GetRouteOptions, R as RewriteRouteOptions, d as RewriteRouteResult, e as expireMiddlewareCacheTag } from './client-BElN_CWD.js';
+import { a as ResolvedRouteResult } from './resolveRouteFromCode-BOvjIvM2.js';
+export { R as ResolveRouteFunction, r as resolveRouteFromCode } from './resolveRouteFromCode-BOvjIvM2.js';
 import '@uniformdev/next-app-router-client';
+import '@uniformdev/context';
 
 type SpecificCacheMode<TCacheMode extends CacheMode> = {
     cache: TCacheMode;
@@ -220,25 +222,44 @@ type CreateStaticParamsOptions = {
     locale?: string;
 };
 /**
- * Generates the playground code for the first of the given paths. Playground requests are drafts,
- * which evaluate while the page renders, so there is one code per composition.
+ * Function to generate all possible page states for the given paths in playground mode.
+ * @param options
+ * @returns
  */
 declare const createUniformPlaygroundStaticParams: (options: CreateStaticParamsOptions) => Promise<{
     code: string;
 }[]>;
 /**
- * Generates one code per published composition among the given paths, for `generateStaticParams`
- * of the `[code]` route. Codes carry the route, not an evaluation, so each path has one static page
- * whose variants are chosen in the browser or at the edge.
+ * Function to generate all possible page states for the given paths.
+ * @param options
+ * @returns
  */
 declare const createUniformStaticParams: (options: CreateStaticParamsOptions) => Promise<{
     code: string;
 }[]>;
 
-/**
- * Resolves the composition of a playground code. The code carries the composition id, and the
- * composition resolves in the editor state, falling back to the draft state.
- */
+type EvaluateTestsFunction = (test: {
+    name: string;
+    component: ComponentInstance;
+}) => boolean;
+type EvaluatePersonalizationsFunction = (personalization: {
+    name: string;
+    component: ComponentInstance;
+}) => boolean;
+type PrecomputeCompositionOptions = Pick<ResolvedRouteResult, 'pageState' | 'route'> & {
+    /**
+     * Whether to evaluate tests
+     * @defaultValue true
+     */
+    evaluateTests?: boolean | EvaluateTestsFunction;
+    /**
+     * Whether to evaluate personalizations
+     * @defaultValue true
+     */
+    evaluatePersonalizations?: boolean | EvaluatePersonalizationsFunction;
+};
+declare const precomputeComposition: ({ pageState, route, evaluatePersonalizations, evaluateTests, }: PrecomputeCompositionOptions) => Promise<void>;
+
 declare const resolvePlaygroundRoute: ({ code }: {
     code: string;
 }) => Promise<ResolvedRouteResult>;
@@ -255,4 +276,4 @@ declare const findRouteMatch: (routes: CustomRoute[], path: string) => RouteMatc
 
 declare const serverContext: <T>(defaultValue?: T) => [() => T | undefined, (v: T) => void];
 
-export { type AwaitedUniformPageParameters, type CreateStaticParamsOptions, type CustomRoute, type GetCanvasClientOptions, type GetCompositionDeliveryClientOptions, type GetManifestClientOptions, type GetProjectMapClientOptions, type GetRouteClientOptions, type PlaygroundParameters, type RouteMatch, UniformCompositionProps, type UniformPageParameters, UniformPlayground, createUniformPlaygroundStaticParams, createUniformStaticParams, findRouteMatch, getCanvasClient, getCompositionDeliveryClient, getManifest, getManifestClient, getProjectMapClient, getRouteClient, resolvePlaygroundRoute, serverContext };
+export { type AwaitedUniformPageParameters, type CreateStaticParamsOptions, type CustomRoute, type GetCanvasClientOptions, type GetCompositionDeliveryClientOptions, type GetManifestClientOptions, type GetProjectMapClientOptions, type GetRouteClientOptions, type PlaygroundParameters, type RouteMatch, UniformCompositionProps, type UniformPageParameters, UniformPlayground, createUniformPlaygroundStaticParams, createUniformStaticParams, findRouteMatch, getCanvasClient, getCompositionDeliveryClient, getManifest, getManifestClient, getProjectMapClient, getRouteClient, precomputeComposition, resolvePlaygroundRoute, serverContext };