@uniformdev/canvas-next-rsc 19.61.1-alpha.10 → 19.61.1-alpha.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (21) hide show
  1. package/README.md +2 -2
  2. package/dist/UniformComposition-38e22896.d.ts +61 -0
  3. package/dist/UniformComposition-d178d865.d.ts +64 -0
  4. package/dist/component.d.mts +76 -0
  5. package/dist/component.d.ts +76 -0
  6. package/dist/component.js +218 -0
  7. package/dist/component.mjs +182 -0
  8. package/dist/config.d.mts +6 -0
  9. package/dist/config.d.ts +6 -1
  10. package/dist/config.js +56 -29
  11. package/dist/config.mjs +41 -0
  12. package/dist/handler.d.mts +12 -0
  13. package/dist/handler.d.ts +12 -2
  14. package/dist/handler.js +703 -2
  15. package/dist/handler.mjs +682 -0
  16. package/dist/index.d.mts +245 -0
  17. package/dist/index.d.ts +245 -23
  18. package/dist/index.esm.js +974 -0
  19. package/dist/index.js +1011 -29
  20. package/dist/index.mjs +974 -0
  21. package/package.json +24 -16
package/dist/index.d.mts ADDED
@@ -0,0 +1,245 @@
1
+ import { CanvasClient, RouteClient, ResolvedRouteGetResponse } from '@uniformdev/canvas';
2
+ import { CacheMode, PageParameters, AppDirectoryContextState, AppDirectoryServerContext, PlaygroundParameters } from '@uniformdev/canvas-next-rsc-shared';
3
+ export { PageParameters, PlaygroundParameters } from '@uniformdev/canvas-next-rsc-shared';
4
+ import { ManifestClient } from '@uniformdev/context/api';
5
+ import { ProjectMapClient, ProjectMapNode } from '@uniformdev/project-map';
6
+ import { ContextState, ContextOptions } from '@uniformdev/context';
7
+ import React__default, { PropsWithChildren } from 'react';
8
+ import { U as UniformCompositionProps } from './UniformComposition-d178d865.js';
9
+ export { a as UniformComposition, r as resolveComposition } from './UniformComposition-d178d865.js';
10
+ import { ClientContextComponent } from '@uniformdev/canvas-next-rsc-client';
11
+
12
+ type GetCanvasClientOptions = {
13
+ cache: CacheMode;
14
+ };
15
+ declare const getCanvasClient: (options: GetCanvasClientOptions) => CanvasClient;
16
+ declare const getDefaultCanvasClient: ({ searchParams, }: {
17
+ searchParams: PageParameters['searchParams'];
18
+ }) => CanvasClient;
19
+
20
+ type GetManifestClientOptions = {
21
+ cache: CacheMode;
22
+ };
23
+ declare const getManifestClient: (options: GetManifestClientOptions) => ManifestClient;
24
+ declare const getDefaultManifestClient: ({ searchParams, }: {
25
+ searchParams?: PageParameters['searchParams'];
26
+ }) => ManifestClient;
27
+ declare const getManifest: ({ searchParams }: {
28
+ searchParams: PageParameters['searchParams'];
29
+ }) => Promise<{
30
+ project: {
31
+ id?: string | undefined;
32
+ name?: string | undefined;
33
+ ui_version?: number | undefined;
34
+ pz?: {
35
+ sig?: {
36
+ [key: string]: {
37
+ str: number;
38
+ cap: number;
39
+ dur: "p" | "s" | "t";
40
+ crit: {
41
+ type: "G";
42
+ op?: "&" | "|" | undefined;
43
+ clauses: ({
44
+ type: "G";
45
+ op?: "&" | "|" | undefined;
46
+ clauses: (any | {
47
+ type: "CK";
48
+ cookieName: string;
49
+ match: {
50
+ rhs: string;
51
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
52
+ cs?: boolean | undefined;
53
+ } | {
54
+ op: "*" | "!*";
55
+ };
56
+ } | {
57
+ type: "QS";
58
+ queryName: string;
59
+ match: {
60
+ rhs: string;
61
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
62
+ cs?: boolean | undefined;
63
+ } | {
64
+ op: "*" | "!*";
65
+ };
66
+ } | {
67
+ type: "QK";
68
+ key: string;
69
+ match: {
70
+ rhs: string;
71
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
72
+ cs?: boolean | undefined;
73
+ } | {
74
+ op: "*" | "!*";
75
+ };
76
+ } | {
77
+ type: "EVT";
78
+ event: {
79
+ rhs: string;
80
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
81
+ cs?: boolean | undefined;
82
+ } | {
83
+ op: "*" | "!*";
84
+ };
85
+ } | {
86
+ type: "PV";
87
+ path: {
88
+ rhs: string;
89
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
90
+ cs?: boolean | undefined;
91
+ } | {
92
+ op: "*" | "!*";
93
+ };
94
+ } | {
95
+ type: "PVC";
96
+ match: {
97
+ rhs: number;
98
+ op: "=" | "!=" | "<" | ">";
99
+ };
100
+ })[];
101
+ } | {
102
+ type: "CK";
103
+ cookieName: string;
104
+ match: {
105
+ rhs: string;
106
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
107
+ cs?: boolean | undefined;
108
+ } | {
109
+ op: "*" | "!*";
110
+ };
111
+ } | {
112
+ type: "QS";
113
+ queryName: string;
114
+ match: {
115
+ rhs: string;
116
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
117
+ cs?: boolean | undefined;
118
+ } | {
119
+ op: "*" | "!*";
120
+ };
121
+ } | {
122
+ type: "QK";
123
+ key: string;
124
+ match: {
125
+ rhs: string;
126
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
127
+ cs?: boolean | undefined;
128
+ } | {
129
+ op: "*" | "!*";
130
+ };
131
+ } | {
132
+ type: "EVT";
133
+ event: {
134
+ rhs: string;
135
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
136
+ cs?: boolean | undefined;
137
+ } | {
138
+ op: "*" | "!*";
139
+ };
140
+ } | {
141
+ type: "PV";
142
+ path: {
143
+ rhs: string;
144
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
145
+ cs?: boolean | undefined;
146
+ } | {
147
+ op: "*" | "!*";
148
+ };
149
+ } | {
150
+ type: "PVC";
151
+ match: {
152
+ rhs: number;
153
+ op: "=" | "!=" | "<" | ">";
154
+ };
155
+ })[];
156
+ };
157
+ };
158
+ } | undefined;
159
+ enr?: {
160
+ [key: string]: {
161
+ cap: number;
162
+ };
163
+ } | undefined;
164
+ agg?: {
165
+ [key: string]: {
166
+ inputs: {
167
+ dim: string;
168
+ sign?: "+" | "-" | "c" | undefined;
169
+ }[];
170
+ };
171
+ } | undefined;
172
+ control?: number | undefined;
173
+ } | undefined;
174
+ test?: {
175
+ [key: string]: {
176
+ wv?: string | undefined;
177
+ };
178
+ } | undefined;
179
+ };
180
+ }>;
181
+
182
+ type GetProjectMapClientOptions = {
183
+ cache: CacheMode;
184
+ };
185
+ declare const getProjectMapClient: (options: GetProjectMapClientOptions) => ProjectMapClient;
186
+ declare const getDefaultProjectMapClient: ({ searchParams, }: {
187
+ searchParams: PageParameters['searchParams'];
188
+ }) => ProjectMapClient;
189
+
190
+ type GetRouteClientOptions = {
191
+ cache: CacheMode;
192
+ };
193
+ declare const getRouteClient: (options: GetRouteClientOptions) => RouteClient;
194
+ declare const getDefaultRouteClient: ({ searchParams }: {
195
+ searchParams: PageParameters['searchParams'];
196
+ }) => RouteClient;
197
+
198
+ type ContextUpdateTransferProps = {
199
+ update: Partial<AppDirectoryContextState> | (() => Promise<Partial<ContextState> | undefined>);
200
+ serverContext: AppDirectoryServerContext | undefined;
201
+ };
202
+ declare const ContextUpdateTransfer: React__default.FC<ContextUpdateTransferProps>;
203
+
204
+ type CreateStaticParamsOptions = {
205
+ expand?: (node: ProjectMapNode) => Promise<string[] | undefined> | string[] | undefined;
206
+ };
207
+ declare const createStaticParams: (options?: CreateStaticParamsOptions) => Promise<{
208
+ path: string[];
209
+ }[]>;
210
+ declare function generateStaticParams(): Promise<{
211
+ path: string[];
212
+ }[]>;
213
+
214
+ type UniformContextProps = {
215
+ /**
216
+ * Component to initialize Uniform context on the client.
217
+ */
218
+ clientContextComponent?: ClientContextComponent;
219
+ };
220
+ declare const UniformContext: React__default.FC<PropsWithChildren<UniformContextProps>>;
221
+
222
+ type UniformPlaygroundProps = PlaygroundParameters & Omit<UniformCompositionProps, 'params' | 'searchParams' | 'route' | 'mode'>;
223
+ declare const UniformPlayground: ({ searchParams, ...rest }: UniformPlaygroundProps) => Promise<React__default.JSX.Element>;
224
+
225
+ type CreateServerUniformContextProps = Omit<ContextOptions, 'transitionStore' | 'manifest'> & {
226
+ searchParams: PageParameters['searchParams'];
227
+ };
228
+ declare const createServerUniformContext: (options: CreateServerUniformContextProps) => Promise<AppDirectoryServerContext>;
229
+
230
+ declare const isDraftModeEnabled: ({ searchParams, }: {
231
+ searchParams: {
232
+ [key: string]: string | undefined;
233
+ } | undefined;
234
+ }) => boolean;
235
+ declare const isIncontextEditingEnabled: ({ searchParams, }: {
236
+ searchParams: {
237
+ [key: string]: string | undefined;
238
+ } | undefined;
239
+ }) => boolean;
240
+ declare const isOnVercelPreviewEnvironment: () => boolean;
241
+ declare const isDevelopmentEnvironment: () => boolean;
242
+
243
+ declare const retrieveRoute: ({ params, searchParams, }: Pick<PageParameters, 'params' | 'searchParams'>) => Promise<ResolvedRouteGetResponse>;
244
+
245
+ 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, retrieveRoute };
package/dist/index.d.ts CHANGED
@@ -1,23 +1,245 @@
1
- import { UniformCompositionProps as BaseUniformCompositionProps } from './components/UniformComposition';
2
- export { GoogleTagManagerAnalytics } from './components/GoogleTagManagerAnalytics';
3
- export { type ComponentProps, type CompositionContext } from './components/UniformComponent';
4
- export { type UniformCompositionProps } from './components/UniformComposition';
5
- export { UniformSlot, type UniformSlotProps } from './components/UniformSlot';
6
- export { UniformText, type UniformTextProps } from './components/UniformText';
7
- export { useForgetMe } from './hooks/useForgetMe';
8
- export { useToggleConsent } from './hooks/useToggleConsent';
9
- export { useUniformContext } from './hooks/useUniformContext';
10
- export { componentStore } from './register/componentStore';
11
- export { registerUniformComponent } from './register/registerUniformComponent';
12
- export { getUniformContext } from './components/getUniformContext';
13
- export { getCanvasClient } from './client/canvasClient';
14
- export { getManifestClient } from './client/manifestClient';
15
- export { getProjectMapClient } from './client/projectMapClient';
16
- export { getRouteClient } from './client/routeClient';
17
- export { resolveComposition } from './components/retrieveRoute';
18
- export { updateContextAction } from './actions/updateContext';
19
- export declare const UniformComposition: (props: Omit<BaseUniformCompositionProps, 'suspense' | 'children' | 'update'>) => import("react/jsx-runtime").JSX.Element;
20
- export declare const UniformCompositionCustom: (props: BaseUniformCompositionProps) => import("react/jsx-runtime").JSX.Element;
21
- export { UniformRichText } from './components/UniformRichText';
22
- export { isDraftModeEnabled, isIncontextEditingEnabled, isOnVercelPreviewEnvironment } from './utils/draft';
23
- export { CANVAS_DRAFT_STATE, CANVAS_PUBLISHED_STATE, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, } from '@uniformdev/canvas';
1
+ import { CanvasClient, RouteClient, ResolvedRouteGetResponse } from '@uniformdev/canvas';
2
+ import { CacheMode, PageParameters, AppDirectoryContextState, AppDirectoryServerContext, PlaygroundParameters } from '@uniformdev/canvas-next-rsc-shared';
3
+ export { PageParameters, PlaygroundParameters } from '@uniformdev/canvas-next-rsc-shared';
4
+ import { ManifestClient } from '@uniformdev/context/api';
5
+ import { ProjectMapClient, ProjectMapNode } from '@uniformdev/project-map';
6
+ import { ContextState, ContextOptions } from '@uniformdev/context';
7
+ import React__default, { PropsWithChildren } from 'react';
8
+ import { U as UniformCompositionProps } from './UniformComposition-d178d865.js';
9
+ export { a as UniformComposition, r as resolveComposition } from './UniformComposition-d178d865.js';
10
+ import { ClientContextComponent } from '@uniformdev/canvas-next-rsc-client';
11
+
12
+ type GetCanvasClientOptions = {
13
+ cache: CacheMode;
14
+ };
15
+ declare const getCanvasClient: (options: GetCanvasClientOptions) => CanvasClient;
16
+ declare const getDefaultCanvasClient: ({ searchParams, }: {
17
+ searchParams: PageParameters['searchParams'];
18
+ }) => CanvasClient;
19
+
20
+ type GetManifestClientOptions = {
21
+ cache: CacheMode;
22
+ };
23
+ declare const getManifestClient: (options: GetManifestClientOptions) => ManifestClient;
24
+ declare const getDefaultManifestClient: ({ searchParams, }: {
25
+ searchParams?: PageParameters['searchParams'];
26
+ }) => ManifestClient;
27
+ declare const getManifest: ({ searchParams }: {
28
+ searchParams: PageParameters['searchParams'];
29
+ }) => Promise<{
30
+ project: {
31
+ id?: string | undefined;
32
+ name?: string | undefined;
33
+ ui_version?: number | undefined;
34
+ pz?: {
35
+ sig?: {
36
+ [key: string]: {
37
+ str: number;
38
+ cap: number;
39
+ dur: "p" | "s" | "t";
40
+ crit: {
41
+ type: "G";
42
+ op?: "&" | "|" | undefined;
43
+ clauses: ({
44
+ type: "G";
45
+ op?: "&" | "|" | undefined;
46
+ clauses: (any | {
47
+ type: "CK";
48
+ cookieName: string;
49
+ match: {
50
+ rhs: string;
51
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
52
+ cs?: boolean | undefined;
53
+ } | {
54
+ op: "*" | "!*";
55
+ };
56
+ } | {
57
+ type: "QS";
58
+ queryName: string;
59
+ match: {
60
+ rhs: string;
61
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
62
+ cs?: boolean | undefined;
63
+ } | {
64
+ op: "*" | "!*";
65
+ };
66
+ } | {
67
+ type: "QK";
68
+ key: string;
69
+ match: {
70
+ rhs: string;
71
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
72
+ cs?: boolean | undefined;
73
+ } | {
74
+ op: "*" | "!*";
75
+ };
76
+ } | {
77
+ type: "EVT";
78
+ event: {
79
+ rhs: string;
80
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
81
+ cs?: boolean | undefined;
82
+ } | {
83
+ op: "*" | "!*";
84
+ };
85
+ } | {
86
+ type: "PV";
87
+ path: {
88
+ rhs: string;
89
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
90
+ cs?: boolean | undefined;
91
+ } | {
92
+ op: "*" | "!*";
93
+ };
94
+ } | {
95
+ type: "PVC";
96
+ match: {
97
+ rhs: number;
98
+ op: "=" | "!=" | "<" | ">";
99
+ };
100
+ })[];
101
+ } | {
102
+ type: "CK";
103
+ cookieName: string;
104
+ match: {
105
+ rhs: string;
106
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
107
+ cs?: boolean | undefined;
108
+ } | {
109
+ op: "*" | "!*";
110
+ };
111
+ } | {
112
+ type: "QS";
113
+ queryName: string;
114
+ match: {
115
+ rhs: string;
116
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
117
+ cs?: boolean | undefined;
118
+ } | {
119
+ op: "*" | "!*";
120
+ };
121
+ } | {
122
+ type: "QK";
123
+ key: string;
124
+ match: {
125
+ rhs: string;
126
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
127
+ cs?: boolean | undefined;
128
+ } | {
129
+ op: "*" | "!*";
130
+ };
131
+ } | {
132
+ type: "EVT";
133
+ event: {
134
+ rhs: string;
135
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
136
+ cs?: boolean | undefined;
137
+ } | {
138
+ op: "*" | "!*";
139
+ };
140
+ } | {
141
+ type: "PV";
142
+ path: {
143
+ rhs: string;
144
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
145
+ cs?: boolean | undefined;
146
+ } | {
147
+ op: "*" | "!*";
148
+ };
149
+ } | {
150
+ type: "PVC";
151
+ match: {
152
+ rhs: number;
153
+ op: "=" | "!=" | "<" | ">";
154
+ };
155
+ })[];
156
+ };
157
+ };
158
+ } | undefined;
159
+ enr?: {
160
+ [key: string]: {
161
+ cap: number;
162
+ };
163
+ } | undefined;
164
+ agg?: {
165
+ [key: string]: {
166
+ inputs: {
167
+ dim: string;
168
+ sign?: "+" | "-" | "c" | undefined;
169
+ }[];
170
+ };
171
+ } | undefined;
172
+ control?: number | undefined;
173
+ } | undefined;
174
+ test?: {
175
+ [key: string]: {
176
+ wv?: string | undefined;
177
+ };
178
+ } | undefined;
179
+ };
180
+ }>;
181
+
182
+ type GetProjectMapClientOptions = {
183
+ cache: CacheMode;
184
+ };
185
+ declare const getProjectMapClient: (options: GetProjectMapClientOptions) => ProjectMapClient;
186
+ declare const getDefaultProjectMapClient: ({ searchParams, }: {
187
+ searchParams: PageParameters['searchParams'];
188
+ }) => ProjectMapClient;
189
+
190
+ type GetRouteClientOptions = {
191
+ cache: CacheMode;
192
+ };
193
+ declare const getRouteClient: (options: GetRouteClientOptions) => RouteClient;
194
+ declare const getDefaultRouteClient: ({ searchParams }: {
195
+ searchParams: PageParameters['searchParams'];
196
+ }) => RouteClient;
197
+
198
+ type ContextUpdateTransferProps = {
199
+ update: Partial<AppDirectoryContextState> | (() => Promise<Partial<ContextState> | undefined>);
200
+ serverContext: AppDirectoryServerContext | undefined;
201
+ };
202
+ declare const ContextUpdateTransfer: React__default.FC<ContextUpdateTransferProps>;
203
+
204
+ type CreateStaticParamsOptions = {
205
+ expand?: (node: ProjectMapNode) => Promise<string[] | undefined> | string[] | undefined;
206
+ };
207
+ declare const createStaticParams: (options?: CreateStaticParamsOptions) => Promise<{
208
+ path: string[];
209
+ }[]>;
210
+ declare function generateStaticParams(): Promise<{
211
+ path: string[];
212
+ }[]>;
213
+
214
+ type UniformContextProps = {
215
+ /**
216
+ * Component to initialize Uniform context on the client.
217
+ */
218
+ clientContextComponent?: ClientContextComponent;
219
+ };
220
+ declare const UniformContext: React__default.FC<PropsWithChildren<UniformContextProps>>;
221
+
222
+ type UniformPlaygroundProps = PlaygroundParameters & Omit<UniformCompositionProps, 'params' | 'searchParams' | 'route' | 'mode'>;
223
+ declare const UniformPlayground: ({ searchParams, ...rest }: UniformPlaygroundProps) => Promise<React__default.JSX.Element>;
224
+
225
+ type CreateServerUniformContextProps = Omit<ContextOptions, 'transitionStore' | 'manifest'> & {
226
+ searchParams: PageParameters['searchParams'];
227
+ };
228
+ declare const createServerUniformContext: (options: CreateServerUniformContextProps) => Promise<AppDirectoryServerContext>;
229
+
230
+ declare const isDraftModeEnabled: ({ searchParams, }: {
231
+ searchParams: {
232
+ [key: string]: string | undefined;
233
+ } | undefined;
234
+ }) => boolean;
235
+ declare const isIncontextEditingEnabled: ({ searchParams, }: {
236
+ searchParams: {
237
+ [key: string]: string | undefined;
238
+ } | undefined;
239
+ }) => boolean;
240
+ declare const isOnVercelPreviewEnvironment: () => boolean;
241
+ declare const isDevelopmentEnvironment: () => boolean;
242
+
243
+ declare const retrieveRoute: ({ params, searchParams, }: Pick<PageParameters, 'params' | 'searchParams'>) => Promise<ResolvedRouteGetResponse>;
244
+
245
+ 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, retrieveRoute };