@uniformdev/next-app-router 20.81.1-alpha.7.sha-91a5b13e0c → 20.81.1

package/dist/{UniformComposition-C00_YDOg.d.ts → UniformComposition-DBO-oo7J.d.ts}

@@ -1,7 +1,9 @@
 import { RootComponentInstance, ComponentInstance } from '@uniformdev/canvas';
 import { ComponentProps } from '@uniformdev/next-app-router-shared';
 import React, { ComponentType } from 'react';
-import { a as ResolvedComposition } from './composition-BvOM-LIW.js';
+import { D as DataClient } from './client-BElN_CWD.js';
+import { a as ResolvedRouteResult, R as ResolveRouteFunction } from './resolveRouteFromCode-BOvjIvM2.js';
+import { ClientContextComponent } from '@uniformdev/next-app-router-client';
 
 type CompositionCache = {
     getUniformComposition: ({ id }: {
@@ -15,6 +17,17 @@ type CompositionCache = {
 };
 declare const createCompositionCache: () => CompositionCache;
 
+type UniformContextProps = {
+    /**
+     * Component to initialize Uniform context on the client.
+     */
+    clientContextComponent?: ClientContextComponent;
+    /**
+     * The result of the route resolution.
+     */
+    result: ResolvedRouteResult | undefined;
+};
+
 type ResolveComponentResult = {
     component: ComponentType<ComponentProps<any, any>> | null;
     includeContext?: boolean;
@@ -37,15 +50,26 @@ type ResolveComponentFunction = (options: {
 type ResolveEmptyPlaceholderFunction = (options: ResolveEmptyPlaceholderOptions) => ResolveEmptyPlaceholderResult;
 type UniformCompositionProps = {
     /**
-     * The composition to render and the page state it resolved for, from `resolveRouteFromCode`,
-     * `resolveCompositionById`, `resolveCompositionBySlug` or a custom resolver, passed through
-     * `requireComposition` or narrowed on `route.type`.
+     * The code to resolve the route from.
      */
-    result: ResolvedComposition;
+    code: string;
+    /**
+     * Function to resolve the route from the code.
+     */
+    resolveRoute: ResolveRouteFunction;
     /**
      * Function to map composition components to React components.
      */
     resolveComponent: ResolveComponentFunction;
+    /**
+     * If provided, the composition will use the data client to retrieve data.
+     *
+     * Pass the same client here that you pass to `handleUniformRoute`. Without it, this component
+     * falls back to `DefaultDataClient` for the route it resolves and, on draft requests,
+     * for the manifest it evaluates personalization against - so a custom manifest source
+     * configured only on the middleware would not apply while the page renders.
+     */
+    dataClient?: DataClient;
     /**
      * Function to map empty placeholders to React components.
      */
@@ -54,11 +78,7 @@ type UniformCompositionProps = {
      * Composition cache, will be used to cache the composition.
      */
     compositionCache?: CompositionCache;
-};
-/**
- * Renders a resolved composition. Render `UniformContext` once on the page as well, which
- * initializes Uniform context on the client and loads the contextual editing script.
- */
-declare function UniformComposition(props: UniformCompositionProps): React.JSX.Element;
+} & Pick<UniformContextProps, 'clientContextComponent'>;
+declare function UniformComposition({ code, ...props }: UniformCompositionProps): React.JSX.Element;
 
 export { type CompositionCache as C, type ResolveComponentResult as R, type UniformCompositionProps as U, type ResolveComponentFunction as a, UniformComposition as b, createCompositionCache as c };

package/dist/{UniformComposition-DiArCpVQ.d.mts → UniformComposition-le6UEB_r.d.mts}

@@ -1,7 +1,9 @@
 import { RootComponentInstance, ComponentInstance } from '@uniformdev/canvas';
 import { ComponentProps } from '@uniformdev/next-app-router-shared';
 import React, { ComponentType } from 'react';
-import { a as ResolvedComposition } from './composition-BvOM-LIW.mjs';
+import { D as DataClient } from './client-BElN_CWD.mjs';
+import { a as ResolvedRouteResult, R as ResolveRouteFunction } from './resolveRouteFromCode-CuJ4JHeb.mjs';
+import { ClientContextComponent } from '@uniformdev/next-app-router-client';
 
 type CompositionCache = {
     getUniformComposition: ({ id }: {
@@ -15,6 +17,17 @@ type CompositionCache = {
 };
 declare const createCompositionCache: () => CompositionCache;
 
+type UniformContextProps = {
+    /**
+     * Component to initialize Uniform context on the client.
+     */
+    clientContextComponent?: ClientContextComponent;
+    /**
+     * The result of the route resolution.
+     */
+    result: ResolvedRouteResult | undefined;
+};
+
 type ResolveComponentResult = {
     component: ComponentType<ComponentProps<any, any>> | null;
     includeContext?: boolean;
@@ -37,15 +50,26 @@ type ResolveComponentFunction = (options: {
 type ResolveEmptyPlaceholderFunction = (options: ResolveEmptyPlaceholderOptions) => ResolveEmptyPlaceholderResult;
 type UniformCompositionProps = {
     /**
-     * The composition to render and the page state it resolved for, from `resolveRouteFromCode`,
-     * `resolveCompositionById`, `resolveCompositionBySlug` or a custom resolver, passed through
-     * `requireComposition` or narrowed on `route.type`.
+     * The code to resolve the route from.
      */
-    result: ResolvedComposition;
+    code: string;
+    /**
+     * Function to resolve the route from the code.
+     */
+    resolveRoute: ResolveRouteFunction;
     /**
      * Function to map composition components to React components.
      */
     resolveComponent: ResolveComponentFunction;
+    /**
+     * If provided, the composition will use the data client to retrieve data.
+     *
+     * Pass the same client here that you pass to `handleUniformRoute`. Without it, this component
+     * falls back to `DefaultDataClient` for the route it resolves and, on draft requests,
+     * for the manifest it evaluates personalization against - so a custom manifest source
+     * configured only on the middleware would not apply while the page renders.
+     */
+    dataClient?: DataClient;
     /**
      * Function to map empty placeholders to React components.
      */
@@ -54,11 +78,7 @@ type UniformCompositionProps = {
      * Composition cache, will be used to cache the composition.
      */
     compositionCache?: CompositionCache;
-};
-/**
- * Renders a resolved composition. Render `UniformContext` once on the page as well, which
- * initializes Uniform context on the client and loads the contextual editing script.
- */
-declare function UniformComposition(props: UniformCompositionProps): React.JSX.Element;
+} & Pick<UniformContextProps, 'clientContextComponent'>;
+declare function UniformComposition({ code, ...props }: UniformCompositionProps): React.JSX.Element;
 
 export { type CompositionCache as C, type ResolveComponentResult as R, type UniformCompositionProps as U, type ResolveComponentFunction as a, UniformComposition as b, createCompositionCache as c };

package/dist/cache.d.mts

@@ -1,27 +1,9 @@
-import { R as ResolveCompositionByIdOptions, a as ResolveCompositionBySlugOptions, b as ResolveRouteFromCodeOptions, c as ResolveRouteFromPathOptions } from './resolveRouteFromPath-BsZUVkRX.mjs';
-import { R as ResolvedRouteResult } from './composition-BvOM-LIW.mjs';
-import '@uniformdev/next-app-router-shared';
+import { R as ResolveRouteFunction } from './resolveRouteFromCode-CuJ4JHeb.mjs';
 import '@uniformdev/canvas';
+import '@uniformdev/next-app-router-shared';
+import './client-BElN_CWD.mjs';
+import '@uniformdev/context';
 
-/**
- * `resolveRouteFromCode` inside a `'use cache'` scope for published content, tagged with the
- * route path and the resolved composition id. Other states resolve uncached.
- */
-declare const resolveRouteFromCode: ({ code, }: ResolveRouteFromCodeOptions) => Promise<ResolvedRouteResult>;
-/**
- * `resolveRouteFromPath` inside a `'use cache'` scope for published content, tagged with the path
- * and the resolved composition id. Other states resolve uncached.
- */
-declare const resolveRouteFromPath: ({ pageState, path, }: ResolveRouteFromPathOptions) => Promise<ResolvedRouteResult>;
-/**
- * `resolveCompositionById` inside a `'use cache'` scope for published content, tagged with the
- * composition id. Other states resolve uncached.
- */
-declare const resolveCompositionById: (options: ResolveCompositionByIdOptions) => Promise<ResolvedRouteResult>;
-/**
- * `resolveCompositionBySlug` inside a `'use cache'` scope for published content, tagged with the
- * slug and the resolved composition id. Other states resolve uncached.
- */
-declare const resolveCompositionBySlug: (options: ResolveCompositionBySlugOptions) => Promise<ResolvedRouteResult>;
+declare const resolveRouteFromCode: ResolveRouteFunction;
 
-export { resolveCompositionById, resolveCompositionBySlug, resolveRouteFromCode, resolveRouteFromPath };
+export { resolveRouteFromCode };

package/dist/cache.d.ts

@@ -1,27 +1,9 @@
-import { R as ResolveCompositionByIdOptions, a as ResolveCompositionBySlugOptions, b as ResolveRouteFromCodeOptions, c as ResolveRouteFromPathOptions } from './resolveRouteFromPath-BHJGOpBN.js';
-import { R as ResolvedRouteResult } from './composition-BvOM-LIW.js';
-import '@uniformdev/next-app-router-shared';
+import { R as ResolveRouteFunction } from './resolveRouteFromCode-BOvjIvM2.js';
 import '@uniformdev/canvas';
+import '@uniformdev/next-app-router-shared';
+import './client-BElN_CWD.js';
+import '@uniformdev/context';
 
-/**
- * `resolveRouteFromCode` inside a `'use cache'` scope for published content, tagged with the
- * route path and the resolved composition id. Other states resolve uncached.
- */
-declare const resolveRouteFromCode: ({ code, }: ResolveRouteFromCodeOptions) => Promise<ResolvedRouteResult>;
-/**
- * `resolveRouteFromPath` inside a `'use cache'` scope for published content, tagged with the path
- * and the resolved composition id. Other states resolve uncached.
- */
-declare const resolveRouteFromPath: ({ pageState, path, }: ResolveRouteFromPathOptions) => Promise<ResolvedRouteResult>;
-/**
- * `resolveCompositionById` inside a `'use cache'` scope for published content, tagged with the
- * composition id. Other states resolve uncached.
- */
-declare const resolveCompositionById: (options: ResolveCompositionByIdOptions) => Promise<ResolvedRouteResult>;
-/**
- * `resolveCompositionBySlug` inside a `'use cache'` scope for published content, tagged with the
- * slug and the resolved composition id. Other states resolve uncached.
- */
-declare const resolveCompositionBySlug: (options: ResolveCompositionBySlugOptions) => Promise<ResolvedRouteResult>;
+declare const resolveRouteFromCode: ResolveRouteFunction;
 
-export { resolveCompositionById, resolveCompositionBySlug, resolveRouteFromCode, resolveRouteFromPath };
+export { resolveRouteFromCode };