@uniformdev/canvas-next-rsc 19.69.0 → 19.73.0

package/dist/{client/manifestClient.d.ts → index.d.mts}

@@ -1,12 +1,31 @@
+import { CanvasClient, RouteClient } from '@uniformdev/canvas';
+import { CacheMode, PageParameters, AppDirectoryContextState, AppDirectoryServerContext, PlaygroundParameters } from '@uniformdev/canvas-next-rsc-shared';
+export { PageParameters, PlaygroundParameters } from '@uniformdev/canvas-next-rsc-shared';
 import { ManifestClient } from '@uniformdev/context/api';
-export type GetManifestClientOptions = {
-    revalidate?: number;
+import { ProjectMapClient, ProjectMapNode } from '@uniformdev/project-map';
+import { ContextState, ContextOptions } from '@uniformdev/context';
+import React__default, { PropsWithChildren } from 'react';
+import { U as UniformCompositionProps } from './UniformComposition-38e22896.js';
+export { a as UniformComposition, r as resolveComposition } from './UniformComposition-38e22896.js';
+import { ClientContextComponent } from '@uniformdev/canvas-next-rsc-client';
+
+type GetCanvasClientOptions = {
+    cache: CacheMode;
 };
-export declare const getManifestClient: (options?: GetManifestClientOptions) => ManifestClient;
-export declare const getManifestFromApi: (options: {
-    searchParams: {
-        [key: string]: string | undefined;
-    } | undefined;
+declare const getCanvasClient: (options: GetCanvasClientOptions) => CanvasClient;
+declare const getDefaultCanvasClient: ({ searchParams, }: {
+    searchParams: PageParameters['searchParams'];
+}) => CanvasClient;
+
+type GetManifestClientOptions = {
+    cache: CacheMode;
+};
+declare const getManifestClient: (options: GetManifestClientOptions) => ManifestClient;
+declare const getDefaultManifestClient: ({ searchParams, }: {
+    searchParams?: PageParameters['searchParams'];
+}) => ManifestClient;
+declare const getManifest: ({ searchParams }: {
+    searchParams: PageParameters['searchParams'];
 }) => Promise<{
     project: {
         id?: string | undefined;
@@ -29,7 +48,7 @@ export declare const getManifestFromApi: (options: {
                                 cookieName: string;
                                 match: {
                                     rhs: string;
-                                    op: "~" | "=" | "//" | "!=" | "!~" | "!//";
+                                    op: "=" | "~" | "//" | "!=" | "!~" | "!//";
                                     cs?: boolean | undefined;
                                 } | {
                                     op: "*" | "!*";
@@ -39,7 +58,7 @@ export declare const getManifestFromApi: (options: {
                                 queryName: string;
                                 match: {
                                     rhs: string;
-                                    op: "~" | "=" | "//" | "!=" | "!~" | "!//";
+                                    op: "=" | "~" | "//" | "!=" | "!~" | "!//";
                                     cs?: boolean | undefined;
                                 } | {
                                     op: "*" | "!*";
@@ -49,7 +68,7 @@ export declare const getManifestFromApi: (options: {
                                 key: string;
                                 match: {
                                     rhs: string;
-                                    op: "~" | "=" | "//" | "!=" | "!~" | "!//";
+                                    op: "=" | "~" | "//" | "!=" | "!~" | "!//";
                                     cs?: boolean | undefined;
                                 } | {
                                     op: "*" | "!*";
@@ -58,7 +77,7 @@ export declare const getManifestFromApi: (options: {
                                 type: "EVT";
                                 event: {
                                     rhs: string;
-                                    op: "~" | "=" | "//" | "!=" | "!~" | "!//";
+                                    op: "=" | "~" | "//" | "!=" | "!~" | "!//";
                                     cs?: boolean | undefined;
                                 } | {
                                     op: "*" | "!*";
@@ -67,7 +86,7 @@ export declare const getManifestFromApi: (options: {
                                 type: "PV";
                                 path: {
                                     rhs: string;
-                                    op: "~" | "=" | "//" | "!=" | "!~" | "!//";
+                                    op: "=" | "~" | "//" | "!=" | "!~" | "!//";
                                     cs?: boolean | undefined;
                                 } | {
                                     op: "*" | "!*";
@@ -84,7 +103,7 @@ export declare const getManifestFromApi: (options: {
                             cookieName: string;
                             match: {
                                 rhs: string;
-                                op: "~" | "=" | "//" | "!=" | "!~" | "!//";
+                                op: "=" | "~" | "//" | "!=" | "!~" | "!//";
                                 cs?: boolean | undefined;
                             } | {
                                 op: "*" | "!*";
@@ -94,7 +113,7 @@ export declare const getManifestFromApi: (options: {
                             queryName: string;
                             match: {
                                 rhs: string;
-                                op: "~" | "=" | "//" | "!=" | "!~" | "!//";
+                                op: "=" | "~" | "//" | "!=" | "!~" | "!//";
                                 cs?: boolean | undefined;
                             } | {
                                 op: "*" | "!*";
@@ -104,7 +123,7 @@ export declare const getManifestFromApi: (options: {
                             key: string;
                             match: {
                                 rhs: string;
-                                op: "~" | "=" | "//" | "!=" | "!~" | "!//";
+                                op: "=" | "~" | "//" | "!=" | "!~" | "!//";
                                 cs?: boolean | undefined;
                             } | {
                                 op: "*" | "!*";
@@ -113,7 +132,7 @@ export declare const getManifestFromApi: (options: {
                             type: "EVT";
                             event: {
                                 rhs: string;
-                                op: "~" | "=" | "//" | "!=" | "!~" | "!//";
+                                op: "=" | "~" | "//" | "!=" | "!~" | "!//";
                                 cs?: boolean | undefined;
                             } | {
                                 op: "*" | "!*";
@@ -122,7 +141,7 @@ export declare const getManifestFromApi: (options: {
                             type: "PV";
                             path: {
                                 rhs: string;
-                                op: "~" | "=" | "//" | "!=" | "!~" | "!//";
+                                op: "=" | "~" | "//" | "!=" | "!~" | "!//";
                                 cs?: boolean | undefined;
                             } | {
                                 op: "*" | "!*";
@@ -146,7 +165,7 @@ export declare const getManifestFromApi: (options: {
                 [key: string]: {
                     inputs: {
                         dim: string;
-                        sign?: "-" | "+" | "c" | undefined;
+                        sign?: "+" | "-" | "c" | undefined;
                     }[];
                 };
             } | undefined;
@@ -159,3 +178,66 @@ export declare const getManifestFromApi: (options: {
         } | undefined;
     };
 }>;
+
+type GetProjectMapClientOptions = {
+    cache: CacheMode;
+};
+declare const getProjectMapClient: (options: GetProjectMapClientOptions) => ProjectMapClient;
+declare const getDefaultProjectMapClient: ({ searchParams, }: {
+    searchParams: PageParameters['searchParams'];
+}) => ProjectMapClient;
+
+type GetRouteClientOptions = {
+    cache: CacheMode;
+};
+declare const getRouteClient: (options: GetRouteClientOptions) => RouteClient;
+declare const getDefaultRouteClient: ({ searchParams }: {
+    searchParams: PageParameters['searchParams'];
+}) => RouteClient;
+
+type ContextUpdateTransferProps = {
+    update: Partial<AppDirectoryContextState> | (() => Promise<Partial<ContextState> | undefined>);
+    serverContext: AppDirectoryServerContext | undefined;
+};
+declare const ContextUpdateTransfer: React__default.FC<ContextUpdateTransferProps>;
+
+type CreateStaticParamsOptions = {
+    expand?: (node: ProjectMapNode) => Promise<string[] | undefined> | string[] | undefined;
+};
+declare const createStaticParams: (options?: CreateStaticParamsOptions) => Promise<{
+    path: string[];
+}[]>;
+declare function generateStaticParams(): Promise<{
+    path: string[];
+}[]>;
+
+type UniformContextProps = {
+    /**
+     * Component to initialize Uniform context on the client.
+     */
+    clientContextComponent?: ClientContextComponent;
+};
+declare const UniformContext: React__default.FC<PropsWithChildren<UniformContextProps>>;
+
+type UniformPlaygroundProps = PlaygroundParameters & Omit<UniformCompositionProps, 'params' | 'searchParams' | 'composition' | 'mode'>;
+declare const UniformPlayground: ({ searchParams, ...rest }: UniformPlaygroundProps) => Promise<React__default.JSX.Element>;
+
+type CreateServerUniformContextProps = Omit<ContextOptions, 'transitionStore' | 'manifest'> & {
+    searchParams: PageParameters['searchParams'];
+};
+declare const createServerUniformContext: (options: CreateServerUniformContextProps) => Promise<AppDirectoryServerContext>;
+
+declare const isDraftModeEnabled: ({ searchParams, }: {
+    searchParams: {
+        [key: string]: string | undefined;
+    } | undefined;
+}) => boolean;
+declare const isIncontextEditingEnabled: ({ searchParams, }: {
+    searchParams: {
+        [key: string]: string | undefined;
+    } | undefined;
+}) => boolean;
+declare const isOnVercelPreviewEnvironment: () => boolean;
+declare const isDevelopmentEnvironment: () => boolean;
+
+export { ContextUpdateTransfer, ContextUpdateTransferProps, CreateServerUniformContextProps, CreateStaticParamsOptions, GetCanvasClientOptions, GetManifestClientOptions, GetProjectMapClientOptions, GetRouteClientOptions, UniformCompositionProps, UniformContext, UniformContextProps, UniformPlayground, UniformPlaygroundProps, createServerUniformContext, createStaticParams, generateStaticParams, getCanvasClient, getDefaultCanvasClient, getDefaultManifestClient, getDefaultProjectMapClient, getDefaultRouteClient, getManifest, getManifestClient, getProjectMapClient, getRouteClient, isDevelopmentEnvironment, isDraftModeEnabled, isIncontextEditingEnabled, isOnVercelPreviewEnvironment };

package/dist/index.d.ts

@@ -1,23 +1,243 @@
-import { UniformCompositionProps as BaseUniformCompositionProps } from './components/UniformComposition';
-export { GoogleTagManagerAnalytics } from './components/GoogleTagManagerAnalytics';
-export { type ComponentProps, type CompositionContext } from './components/UniformComponent';
-export { type UniformCompositionProps } from './components/UniformComposition';
-export { UniformSlot, type UniformSlotProps } from './components/UniformSlot';
-export { UniformText, type UniformTextProps } from './components/UniformText';
-export { useForgetMe } from './hooks/useForgetMe';
-export { useToggleConsent } from './hooks/useToggleConsent';
-export { useUniformContext } from './hooks/useUniformContext';
-export { componentStore } from './register/componentStore';
-export { registerUniformComponent } from './register/registerUniformComponent';
-export { getUniformContext } from './components/getUniformContext';
-export { getCanvasClient } from './client/canvasClient';
-export { getManifestClient } from './client/manifestClient';
-export { getProjectMapClient } from './client/projectMapClient';
-export { getRouteClient } from './client/routeClient';
-export { resolveComposition } from './components/retrieveRoute';
-export { updateContextAction } from './actions/updateContext';
-export declare const UniformComposition: (props: Omit<BaseUniformCompositionProps, 'suspense' | 'children' | 'update'>) => import("react/jsx-runtime").JSX.Element;
-export declare const UniformCompositionCustom: (props: BaseUniformCompositionProps) => import("react/jsx-runtime").JSX.Element;
-export { UniformRichText } from './components/UniformRichText';
-export { isDraftModeEnabled, isIncontextEditingEnabled, isOnVercelPreviewEnvironment } from './utils/draft';
-export { CANVAS_DRAFT_STATE, CANVAS_PUBLISHED_STATE, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, } from '@uniformdev/canvas';
+import { CanvasClient, RouteClient } from '@uniformdev/canvas';
+import { CacheMode, PageParameters, AppDirectoryContextState, AppDirectoryServerContext, PlaygroundParameters } from '@uniformdev/canvas-next-rsc-shared';
+export { PageParameters, PlaygroundParameters } from '@uniformdev/canvas-next-rsc-shared';
+import { ManifestClient } from '@uniformdev/context/api';
+import { ProjectMapClient, ProjectMapNode } from '@uniformdev/project-map';
+import { ContextState, ContextOptions } from '@uniformdev/context';
+import React__default, { PropsWithChildren } from 'react';
+import { U as UniformCompositionProps } from './UniformComposition-38e22896.js';
+export { a as UniformComposition, r as resolveComposition } from './UniformComposition-38e22896.js';
+import { ClientContextComponent } from '@uniformdev/canvas-next-rsc-client';
+
+type GetCanvasClientOptions = {
+    cache: CacheMode;
+};
+declare const getCanvasClient: (options: GetCanvasClientOptions) => CanvasClient;
+declare const getDefaultCanvasClient: ({ searchParams, }: {
+    searchParams: PageParameters['searchParams'];
+}) => CanvasClient;
+
+type GetManifestClientOptions = {
+    cache: CacheMode;
+};
+declare const getManifestClient: (options: GetManifestClientOptions) => ManifestClient;
+declare const getDefaultManifestClient: ({ searchParams, }: {
+    searchParams?: PageParameters['searchParams'];
+}) => ManifestClient;
+declare const getManifest: ({ searchParams }: {
+    searchParams: PageParameters['searchParams'];
+}) => Promise<{
+    project: {
+        id?: string | undefined;
+        name?: string | undefined;
+        ui_version?: number | undefined;
+        pz?: {
+            sig?: {
+                [key: string]: {
+                    str: number;
+                    cap: number;
+                    dur: "p" | "s" | "t";
+                    crit: {
+                        type: "G";
+                        op?: "&" | "|" | undefined;
+                        clauses: ({
+                            type: "G";
+                            op?: "&" | "|" | undefined;
+                            clauses: (any | {
+                                type: "CK";
+                                cookieName: string;
+                                match: {
+                                    rhs: string;
+                                    op: "=" | "~" | "//" | "!=" | "!~" | "!//";
+                                    cs?: boolean | undefined;
+                                } | {
+                                    op: "*" | "!*";
+                                };
+                            } | {
+                                type: "QS";
+                                queryName: string;
+                                match: {
+                                    rhs: string;
+                                    op: "=" | "~" | "//" | "!=" | "!~" | "!//";
+                                    cs?: boolean | undefined;
+                                } | {
+                                    op: "*" | "!*";
+                                };
+                            } | {
+                                type: "QK";
+                                key: string;
+                                match: {
+                                    rhs: string;
+                                    op: "=" | "~" | "//" | "!=" | "!~" | "!//";
+                                    cs?: boolean | undefined;
+                                } | {
+                                    op: "*" | "!*";
+                                };
+                            } | {
+                                type: "EVT";
+                                event: {
+                                    rhs: string;
+                                    op: "=" | "~" | "//" | "!=" | "!~" | "!//";
+                                    cs?: boolean | undefined;
+                                } | {
+                                    op: "*" | "!*";
+                                };
+                            } | {
+                                type: "PV";
+                                path: {
+                                    rhs: string;
+                                    op: "=" | "~" | "//" | "!=" | "!~" | "!//";
+                                    cs?: boolean | undefined;
+                                } | {
+                                    op: "*" | "!*";
+                                };
+                            } | {
+                                type: "PVC";
+                                match: {
+                                    rhs: number;
+                                    op: "=" | "!=" | "<" | ">";
+                                };
+                            })[];
+                        } | {
+                            type: "CK";
+                            cookieName: string;
+                            match: {
+                                rhs: string;
+                                op: "=" | "~" | "//" | "!=" | "!~" | "!//";
+                                cs?: boolean | undefined;
+                            } | {
+                                op: "*" | "!*";
+                            };
+                        } | {
+                            type: "QS";
+                            queryName: string;
+                            match: {
+                                rhs: string;
+                                op: "=" | "~" | "//" | "!=" | "!~" | "!//";
+                                cs?: boolean | undefined;
+                            } | {
+                                op: "*" | "!*";
+                            };
+                        } | {
+                            type: "QK";
+                            key: string;
+                            match: {
+                                rhs: string;
+                                op: "=" | "~" | "//" | "!=" | "!~" | "!//";
+                                cs?: boolean | undefined;
+                            } | {
+                                op: "*" | "!*";
+                            };
+                        } | {
+                            type: "EVT";
+                            event: {
+                                rhs: string;
+                                op: "=" | "~" | "//" | "!=" | "!~" | "!//";
+                                cs?: boolean | undefined;
+                            } | {
+                                op: "*" | "!*";
+                            };
+                        } | {
+                            type: "PV";
+                            path: {
+                                rhs: string;
+                                op: "=" | "~" | "//" | "!=" | "!~" | "!//";
+                                cs?: boolean | undefined;
+                            } | {
+                                op: "*" | "!*";
+                            };
+                        } | {
+                            type: "PVC";
+                            match: {
+                                rhs: number;
+                                op: "=" | "!=" | "<" | ">";
+                            };
+                        })[];
+                    };
+                };
+            } | undefined;
+            enr?: {
+                [key: string]: {
+                    cap: number;
+                };
+            } | undefined;
+            agg?: {
+                [key: string]: {
+                    inputs: {
+                        dim: string;
+                        sign?: "+" | "-" | "c" | undefined;
+                    }[];
+                };
+            } | undefined;
+            control?: number | undefined;
+        } | undefined;
+        test?: {
+            [key: string]: {
+                wv?: string | undefined;
+            };
+        } | undefined;
+    };
+}>;
+
+type GetProjectMapClientOptions = {
+    cache: CacheMode;
+};
+declare const getProjectMapClient: (options: GetProjectMapClientOptions) => ProjectMapClient;
+declare const getDefaultProjectMapClient: ({ searchParams, }: {
+    searchParams: PageParameters['searchParams'];
+}) => ProjectMapClient;
+
+type GetRouteClientOptions = {
+    cache: CacheMode;
+};
+declare const getRouteClient: (options: GetRouteClientOptions) => RouteClient;
+declare const getDefaultRouteClient: ({ searchParams }: {
+    searchParams: PageParameters['searchParams'];
+}) => RouteClient;
+
+type ContextUpdateTransferProps = {
+    update: Partial<AppDirectoryContextState> | (() => Promise<Partial<ContextState> | undefined>);
+    serverContext: AppDirectoryServerContext | undefined;
+};
+declare const ContextUpdateTransfer: React__default.FC<ContextUpdateTransferProps>;
+
+type CreateStaticParamsOptions = {
+    expand?: (node: ProjectMapNode) => Promise<string[] | undefined> | string[] | undefined;
+};
+declare const createStaticParams: (options?: CreateStaticParamsOptions) => Promise<{
+    path: string[];
+}[]>;
+declare function generateStaticParams(): Promise<{
+    path: string[];
+}[]>;
+
+type UniformContextProps = {
+    /**
+     * Component to initialize Uniform context on the client.
+     */
+    clientContextComponent?: ClientContextComponent;
+};
+declare const UniformContext: React__default.FC<PropsWithChildren<UniformContextProps>>;
+
+type UniformPlaygroundProps = PlaygroundParameters & Omit<UniformCompositionProps, 'params' | 'searchParams' | 'composition' | 'mode'>;
+declare const UniformPlayground: ({ searchParams, ...rest }: UniformPlaygroundProps) => Promise<React__default.JSX.Element>;
+
+type CreateServerUniformContextProps = Omit<ContextOptions, 'transitionStore' | 'manifest'> & {
+    searchParams: PageParameters['searchParams'];
+};
+declare const createServerUniformContext: (options: CreateServerUniformContextProps) => Promise<AppDirectoryServerContext>;
+
+declare const isDraftModeEnabled: ({ searchParams, }: {
+    searchParams: {
+        [key: string]: string | undefined;
+    } | undefined;
+}) => boolean;
+declare const isIncontextEditingEnabled: ({ searchParams, }: {
+    searchParams: {
+        [key: string]: string | undefined;
+    } | undefined;
+}) => boolean;
+declare const isOnVercelPreviewEnvironment: () => boolean;
+declare const isDevelopmentEnvironment: () => boolean;
+
+export { ContextUpdateTransfer, ContextUpdateTransferProps, CreateServerUniformContextProps, CreateStaticParamsOptions, GetCanvasClientOptions, GetManifestClientOptions, GetProjectMapClientOptions, GetRouteClientOptions, UniformCompositionProps, UniformContext, UniformContextProps, UniformPlayground, UniformPlaygroundProps, createServerUniformContext, createStaticParams, generateStaticParams, getCanvasClient, getDefaultCanvasClient, getDefaultManifestClient, getDefaultProjectMapClient, getDefaultRouteClient, getManifest, getManifestClient, getProjectMapClient, getRouteClient, isDevelopmentEnvironment, isDraftModeEnabled, isIncontextEditingEnabled, isOnVercelPreviewEnvironment };