@measured/puck 0.21.0-canary.a5160e5d → 0.21.0-canary.a7a65997
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.
- package/dist/Editor-F2LSS6SE.css +403 -0
- package/dist/Editor-HG76DBFU.mjs +204 -0
- package/dist/Render-OFE6QLI2.mjs +55 -0
- package/dist/Render-QEMDIDQC.css +101 -0
- package/dist/{walk-tree-DkTSFbz_.d.mts → actions-tsxxcX1z.d.mts} +281 -82
- package/dist/{walk-tree-DkTSFbz_.d.ts → actions-tsxxcX1z.d.ts} +281 -82
- package/dist/chunk-23IZFPL7.mjs +528 -0
- package/dist/chunk-45I5SDOI.mjs +134 -0
- package/dist/chunk-5ZZVX2Z3.mjs +63 -0
- package/dist/chunk-B7REOAA7.mjs +435 -0
- package/dist/chunk-BXQQARCR.mjs +708 -0
- package/dist/chunk-CSSRLPHM.mjs +11 -0
- package/dist/chunk-D2SRL6YA.mjs +1807 -0
- package/dist/chunk-IQKX6A5D.mjs +429 -0
- package/dist/chunk-LJEGWHDD.mjs +53 -0
- package/dist/chunk-LR6HIXPR.mjs +111 -0
- package/dist/chunk-M6W7YEVX.mjs +95 -0
- package/dist/{chunk-LAV6OYHN.mjs → chunk-Q6MNES6D.mjs} +6893 -8161
- package/dist/chunk-U4VSQKO3.mjs +33 -0
- package/dist/chunk-V5I7CVLT.mjs +103 -0
- package/dist/chunk-Y2EFNT5P.mjs +108 -0
- package/dist/full-2GJTAAZE.css +301 -0
- package/dist/full-L7DWVNTZ.mjs +93 -0
- package/dist/index-Ca6V6NQD.d.ts +118 -0
- package/dist/index-mQvUCH3C.d.mts +118 -0
- package/dist/index.css +1031 -385
- package/dist/index.d.mts +116 -114
- package/dist/index.d.ts +116 -114
- package/dist/index.js +9540 -5644
- package/dist/index.mjs +34 -12
- package/dist/internal.d.mts +27 -0
- package/dist/internal.d.ts +27 -0
- package/dist/internal.js +927 -0
- package/dist/internal.mjs +13 -0
- package/dist/loaded-2HLHDP2G.mjs +57 -0
- package/dist/loaded-LZUXYAGW.mjs +60 -0
- package/dist/loaded-RVWBFK7L.css +87 -0
- package/dist/loaded-UHVTB6OD.mjs +57 -0
- package/dist/no-external.css +1120 -470
- package/dist/no-external.d.mts +19 -2
- package/dist/no-external.d.ts +19 -2
- package/dist/no-external.js +9593 -5694
- package/dist/no-external.mjs +36 -9
- package/dist/rsc.css +101 -0
- package/dist/rsc.d.mts +17 -2
- package/dist/rsc.d.ts +17 -2
- package/dist/rsc.js +472 -58
- package/dist/rsc.mjs +18 -9
- package/dist/walk-tree-Bh85NMeo.d.ts +29 -0
- package/dist/walk-tree-CDA3K5S3.d.mts +29 -0
- package/package.json +31 -4
- package/dist/chunk-VBJEDLUM.mjs +0 -965
|
@@ -1,72 +1,269 @@
|
|
|
1
|
-
import { ReactElement, CSSProperties, ReactNode, JSX } from 'react';
|
|
1
|
+
import { ReactElement, CSSProperties, ReactNode, ElementType, Ref, JSX } from 'react';
|
|
2
|
+
import { EditorStateSnapshot, Editor, Extensions } from '@tiptap/react';
|
|
3
|
+
import { BlockquoteOptions } from '@tiptap/extension-blockquote';
|
|
4
|
+
import { BoldOptions } from '@tiptap/extension-bold';
|
|
5
|
+
import { CodeOptions } from '@tiptap/extension-code';
|
|
6
|
+
import { CodeBlockOptions } from '@tiptap/extension-code-block';
|
|
7
|
+
import { HardBreakOptions } from '@tiptap/extension-hard-break';
|
|
8
|
+
import { HeadingOptions } from '@tiptap/extension-heading';
|
|
9
|
+
import { HorizontalRuleOptions } from '@tiptap/extension-horizontal-rule';
|
|
10
|
+
import { ItalicOptions } from '@tiptap/extension-italic';
|
|
11
|
+
import { LinkOptions } from '@tiptap/extension-link';
|
|
12
|
+
import { BulletListOptions, ListItemOptions, ListKeymapOptions, OrderedListOptions } from '@tiptap/extension-list';
|
|
13
|
+
import { ParagraphOptions } from '@tiptap/extension-paragraph';
|
|
14
|
+
import { StrikeOptions } from '@tiptap/extension-strike';
|
|
15
|
+
import { TextAlignOptions } from '@tiptap/extension-text-align';
|
|
16
|
+
import { UnderlineOptions } from '@tiptap/extension-underline';
|
|
2
17
|
|
|
3
18
|
type ItemSelector = {
|
|
4
19
|
index: number;
|
|
5
20
|
zone?: string;
|
|
6
21
|
};
|
|
7
22
|
|
|
23
|
+
declare const defaultEditorState: (ctx: EditorStateSnapshot, readOnly: boolean) => {
|
|
24
|
+
isAlignLeft?: undefined;
|
|
25
|
+
canAlignLeft?: undefined;
|
|
26
|
+
isAlignCenter?: undefined;
|
|
27
|
+
canAlignCenter?: undefined;
|
|
28
|
+
isAlignRight?: undefined;
|
|
29
|
+
canAlignRight?: undefined;
|
|
30
|
+
isAlignJustify?: undefined;
|
|
31
|
+
canAlignJustify?: undefined;
|
|
32
|
+
isBold?: undefined;
|
|
33
|
+
canBold?: undefined;
|
|
34
|
+
isItalic?: undefined;
|
|
35
|
+
canItalic?: undefined;
|
|
36
|
+
isUnderline?: undefined;
|
|
37
|
+
canUnderline?: undefined;
|
|
38
|
+
isStrike?: undefined;
|
|
39
|
+
canStrike?: undefined;
|
|
40
|
+
isInlineCode?: undefined;
|
|
41
|
+
canInlineCode?: undefined;
|
|
42
|
+
isBulletList?: undefined;
|
|
43
|
+
canBulletList?: undefined;
|
|
44
|
+
isOrderedList?: undefined;
|
|
45
|
+
canOrderedList?: undefined;
|
|
46
|
+
isCodeBlock?: undefined;
|
|
47
|
+
canCodeBlock?: undefined;
|
|
48
|
+
isBlockquote?: undefined;
|
|
49
|
+
canBlockquote?: undefined;
|
|
50
|
+
canHorizontalRule?: undefined;
|
|
51
|
+
} | {
|
|
52
|
+
isAlignLeft: boolean;
|
|
53
|
+
canAlignLeft: boolean;
|
|
54
|
+
isAlignCenter: boolean;
|
|
55
|
+
canAlignCenter: boolean;
|
|
56
|
+
isAlignRight: boolean;
|
|
57
|
+
canAlignRight: boolean;
|
|
58
|
+
isAlignJustify: boolean;
|
|
59
|
+
canAlignJustify: boolean;
|
|
60
|
+
isBold: boolean;
|
|
61
|
+
canBold: boolean;
|
|
62
|
+
isItalic: boolean;
|
|
63
|
+
canItalic: boolean;
|
|
64
|
+
isUnderline: boolean;
|
|
65
|
+
canUnderline: boolean;
|
|
66
|
+
isStrike: boolean;
|
|
67
|
+
canStrike: boolean;
|
|
68
|
+
isInlineCode: boolean;
|
|
69
|
+
canInlineCode: boolean;
|
|
70
|
+
isBulletList: boolean;
|
|
71
|
+
canBulletList: boolean;
|
|
72
|
+
isOrderedList: boolean;
|
|
73
|
+
canOrderedList: boolean;
|
|
74
|
+
isCodeBlock: boolean;
|
|
75
|
+
canCodeBlock: boolean;
|
|
76
|
+
isBlockquote: boolean;
|
|
77
|
+
canBlockquote: boolean;
|
|
78
|
+
canHorizontalRule: boolean;
|
|
79
|
+
};
|
|
80
|
+
|
|
81
|
+
type RichTextSelector = (ctx: EditorStateSnapshot, readOnly: boolean) => Partial<Record<string, boolean>>;
|
|
82
|
+
type DefaultEditorState = ReturnType<typeof defaultEditorState>;
|
|
83
|
+
type EditorState<Selector extends RichTextSelector = RichTextSelector> = DefaultEditorState & ReturnType<Selector> & Record<string, boolean | undefined>;
|
|
84
|
+
|
|
85
|
+
interface PuckRichTextOptions {
|
|
86
|
+
/**
|
|
87
|
+
* If set to false, the blockquote extension will not be registered
|
|
88
|
+
* @example blockquote: false
|
|
89
|
+
*/
|
|
90
|
+
blockquote: Partial<BlockquoteOptions> | false;
|
|
91
|
+
/**
|
|
92
|
+
* If set to false, the bold extension will not be registered
|
|
93
|
+
* @example bold: false
|
|
94
|
+
*/
|
|
95
|
+
bold: Partial<BoldOptions> | false;
|
|
96
|
+
/**
|
|
97
|
+
* If set to false, the bulletList extension will not be registered
|
|
98
|
+
* @example bulletList: false
|
|
99
|
+
*/
|
|
100
|
+
bulletList: Partial<BulletListOptions> | false;
|
|
101
|
+
/**
|
|
102
|
+
* If set to false, the code extension will not be registered
|
|
103
|
+
* @example code: false
|
|
104
|
+
*/
|
|
105
|
+
code: Partial<CodeOptions> | false;
|
|
106
|
+
/**
|
|
107
|
+
* If set to false, the codeBlock extension will not be registered
|
|
108
|
+
* @example codeBlock: false
|
|
109
|
+
*/
|
|
110
|
+
codeBlock: Partial<CodeBlockOptions> | false;
|
|
111
|
+
/**
|
|
112
|
+
* If set to false, the document extension will not be registered
|
|
113
|
+
* @example document: false
|
|
114
|
+
*/
|
|
115
|
+
document: false;
|
|
116
|
+
/**
|
|
117
|
+
* If set to false, the hardBreak extension will not be registered
|
|
118
|
+
* @example hardBreak: false
|
|
119
|
+
*/
|
|
120
|
+
hardBreak: Partial<HardBreakOptions> | false;
|
|
121
|
+
/**
|
|
122
|
+
* If set to false, the heading extension will not be registered
|
|
123
|
+
* @example heading: false
|
|
124
|
+
*/
|
|
125
|
+
heading: Partial<HeadingOptions> | false;
|
|
126
|
+
/**
|
|
127
|
+
* If set to false, the horizontalRule extension will not be registered
|
|
128
|
+
* @example horizontalRule: false
|
|
129
|
+
*/
|
|
130
|
+
horizontalRule: Partial<HorizontalRuleOptions> | false;
|
|
131
|
+
/**
|
|
132
|
+
* If set to false, the italic extension will not be registered
|
|
133
|
+
* @example italic: false
|
|
134
|
+
*/
|
|
135
|
+
italic: Partial<ItalicOptions> | false;
|
|
136
|
+
/**
|
|
137
|
+
* If set to false, the listItem extension will not be registered
|
|
138
|
+
* @example listItem: false
|
|
139
|
+
*/
|
|
140
|
+
listItem: Partial<ListItemOptions> | false;
|
|
141
|
+
/**
|
|
142
|
+
* If set to false, the listItemKeymap extension will not be registered
|
|
143
|
+
* @example listKeymap: false
|
|
144
|
+
*/
|
|
145
|
+
listKeymap: Partial<ListKeymapOptions> | false;
|
|
146
|
+
/**
|
|
147
|
+
* If set to false, the link extension will not be registered
|
|
148
|
+
* @example link: false
|
|
149
|
+
*/
|
|
150
|
+
link: Partial<LinkOptions> | false;
|
|
151
|
+
/**
|
|
152
|
+
* If set to false, the orderedList extension will not be registered
|
|
153
|
+
* @example orderedList: false
|
|
154
|
+
*/
|
|
155
|
+
orderedList: Partial<OrderedListOptions> | false;
|
|
156
|
+
/**
|
|
157
|
+
* If set to false, the paragraph extension will not be registered
|
|
158
|
+
* @example paragraph: false
|
|
159
|
+
*/
|
|
160
|
+
paragraph: Partial<ParagraphOptions> | false;
|
|
161
|
+
/**
|
|
162
|
+
* If set to false, the strike extension will not be registered
|
|
163
|
+
* @example strike: false
|
|
164
|
+
*/
|
|
165
|
+
strike: Partial<StrikeOptions> | false;
|
|
166
|
+
/**
|
|
167
|
+
* If set to false, the text extension will not be registered
|
|
168
|
+
* @example text: false
|
|
169
|
+
*/
|
|
170
|
+
text: false;
|
|
171
|
+
/**
|
|
172
|
+
* If set to false, the textAlign extension will not be registered
|
|
173
|
+
* @example text: false
|
|
174
|
+
*/
|
|
175
|
+
textAlign: Partial<TextAlignOptions> | false;
|
|
176
|
+
/**
|
|
177
|
+
* If set to false, the underline extension will not be registered
|
|
178
|
+
* @example underline: false
|
|
179
|
+
*/
|
|
180
|
+
underline: Partial<UnderlineOptions> | false;
|
|
181
|
+
}
|
|
182
|
+
|
|
8
183
|
type FieldOption = {
|
|
9
184
|
label: string;
|
|
10
185
|
value: string | number | boolean | undefined | null | object;
|
|
11
186
|
};
|
|
12
187
|
type FieldOptions = Array<FieldOption> | ReadonlyArray<FieldOption>;
|
|
13
|
-
|
|
188
|
+
interface BaseField {
|
|
14
189
|
label?: string;
|
|
15
190
|
labelIcon?: ReactElement;
|
|
16
|
-
metadata?:
|
|
191
|
+
metadata?: FieldMetadata;
|
|
17
192
|
visible?: boolean;
|
|
18
|
-
}
|
|
19
|
-
|
|
193
|
+
}
|
|
194
|
+
interface TextField extends BaseField {
|
|
20
195
|
type: "text";
|
|
21
196
|
placeholder?: string;
|
|
22
197
|
contentEditable?: boolean;
|
|
23
|
-
}
|
|
24
|
-
|
|
198
|
+
}
|
|
199
|
+
interface NumberField extends BaseField {
|
|
25
200
|
type: "number";
|
|
26
201
|
placeholder?: string;
|
|
27
202
|
min?: number;
|
|
28
203
|
max?: number;
|
|
29
204
|
step?: number;
|
|
30
|
-
}
|
|
31
|
-
|
|
205
|
+
}
|
|
206
|
+
interface TextareaField extends BaseField {
|
|
32
207
|
type: "textarea";
|
|
33
208
|
placeholder?: string;
|
|
34
209
|
contentEditable?: boolean;
|
|
35
|
-
}
|
|
36
|
-
|
|
210
|
+
}
|
|
211
|
+
interface SelectField extends BaseField {
|
|
37
212
|
type: "select";
|
|
38
213
|
options: FieldOptions;
|
|
39
|
-
}
|
|
40
|
-
|
|
214
|
+
}
|
|
215
|
+
interface RadioField extends BaseField {
|
|
41
216
|
type: "radio";
|
|
42
217
|
options: FieldOptions;
|
|
43
|
-
}
|
|
44
|
-
|
|
218
|
+
}
|
|
219
|
+
interface RichtextField<UserSelector extends RichTextSelector = RichTextSelector> extends BaseField {
|
|
220
|
+
type: "richtext";
|
|
221
|
+
contentEditable?: boolean;
|
|
222
|
+
initialHeight?: CSSProperties["height"];
|
|
223
|
+
options?: Partial<PuckRichTextOptions>;
|
|
224
|
+
renderMenu?: (props: {
|
|
225
|
+
children: ReactNode;
|
|
226
|
+
editor: Editor | null;
|
|
227
|
+
editorState: EditorState<UserSelector> | null;
|
|
228
|
+
readOnly: boolean;
|
|
229
|
+
}) => ReactNode;
|
|
230
|
+
renderInlineMenu?: (props: {
|
|
231
|
+
children: ReactNode;
|
|
232
|
+
editor: Editor | null;
|
|
233
|
+
editorState: EditorState<UserSelector> | null;
|
|
234
|
+
readOnly: boolean;
|
|
235
|
+
}) => ReactNode;
|
|
236
|
+
tiptap?: {
|
|
237
|
+
selector?: UserSelector;
|
|
238
|
+
extensions?: Extensions;
|
|
239
|
+
};
|
|
240
|
+
}
|
|
241
|
+
interface ArrayField<Props extends {
|
|
45
242
|
[key: string]: any;
|
|
46
243
|
}[] = {
|
|
47
244
|
[key: string]: any;
|
|
48
|
-
}[], UserField extends {} = {}>
|
|
245
|
+
}[], UserField extends {} = {}> extends BaseField {
|
|
49
246
|
type: "array";
|
|
50
247
|
arrayFields: {
|
|
51
248
|
[SubPropName in keyof Props[0]]: UserField extends {
|
|
52
249
|
type: PropertyKey;
|
|
53
250
|
} ? Field<Props[0][SubPropName], UserField> | UserField : Field<Props[0][SubPropName], UserField>;
|
|
54
251
|
};
|
|
55
|
-
defaultItemProps?: Props[0];
|
|
56
|
-
getItemSummary?: (item: Props[0], index?: number) =>
|
|
252
|
+
defaultItemProps?: Props[0] | ((index: number) => Props[0]);
|
|
253
|
+
getItemSummary?: (item: Props[0], index?: number) => ReactNode;
|
|
57
254
|
max?: number;
|
|
58
255
|
min?: number;
|
|
59
|
-
}
|
|
60
|
-
|
|
256
|
+
}
|
|
257
|
+
interface ObjectField<Props extends any = {
|
|
61
258
|
[key: string]: any;
|
|
62
|
-
}, UserField extends {} = {}>
|
|
259
|
+
}, UserField extends {} = {}> extends BaseField {
|
|
63
260
|
type: "object";
|
|
64
261
|
objectFields: {
|
|
65
262
|
[SubPropName in keyof Props]: UserField extends {
|
|
66
263
|
type: PropertyKey;
|
|
67
264
|
} ? Field<Props[SubPropName]> | UserField : Field<Props[SubPropName]>;
|
|
68
265
|
};
|
|
69
|
-
}
|
|
266
|
+
}
|
|
70
267
|
type Adaptor<AdaptorParams = {}, TableShape extends Record<string, any> = {}, PropShape = TableShape> = {
|
|
71
268
|
name: string;
|
|
72
269
|
fetchList: (adaptorParams?: AdaptorParams) => Promise<TableShape[] | null>;
|
|
@@ -80,14 +277,14 @@ type ExternalFieldWithAdaptor<Props extends any = {
|
|
|
80
277
|
placeholder?: string;
|
|
81
278
|
adaptor: Adaptor<any, any, Props>;
|
|
82
279
|
adaptorParams?: object;
|
|
83
|
-
getItemSummary: (item: NotUndefined<Props>, index?: number) =>
|
|
280
|
+
getItemSummary: (item: NotUndefined<Props>, index?: number) => ReactNode;
|
|
84
281
|
};
|
|
85
282
|
type CacheOpts = {
|
|
86
283
|
enabled?: boolean;
|
|
87
284
|
};
|
|
88
|
-
|
|
285
|
+
interface ExternalField<Props extends any = {
|
|
89
286
|
[key: string]: any;
|
|
90
|
-
}>
|
|
287
|
+
}> extends BaseField {
|
|
91
288
|
type: "external";
|
|
92
289
|
cache?: CacheOpts;
|
|
93
290
|
placeholder?: string;
|
|
@@ -97,7 +294,7 @@ type ExternalField<Props extends any = {
|
|
|
97
294
|
}) => Promise<any[] | null>;
|
|
98
295
|
mapProp?: (value: any) => Props;
|
|
99
296
|
mapRow?: (value: any) => Record<string, string | number | ReactElement>;
|
|
100
|
-
getItemSummary?: (item: NotUndefined<Props>, index?: number) =>
|
|
297
|
+
getItemSummary?: (item: NotUndefined<Props>, index?: number) => ReactNode;
|
|
101
298
|
showSearch?: boolean;
|
|
102
299
|
renderFooter?: (props: {
|
|
103
300
|
items: any[];
|
|
@@ -105,7 +302,7 @@ type ExternalField<Props extends any = {
|
|
|
105
302
|
initialQuery?: string;
|
|
106
303
|
filterFields?: Record<string, Field>;
|
|
107
304
|
initialFilters?: Record<string, any>;
|
|
108
|
-
}
|
|
305
|
+
}
|
|
109
306
|
type CustomFieldRender<Value extends any> = (props: {
|
|
110
307
|
field: CustomField<Value>;
|
|
111
308
|
name: string;
|
|
@@ -114,17 +311,18 @@ type CustomFieldRender<Value extends any> = (props: {
|
|
|
114
311
|
onChange: (value: Value) => void;
|
|
115
312
|
readOnly?: boolean;
|
|
116
313
|
}) => ReactElement;
|
|
117
|
-
|
|
314
|
+
interface CustomField<Value extends any> extends BaseField {
|
|
118
315
|
type: "custom";
|
|
119
316
|
render: CustomFieldRender<Value>;
|
|
120
317
|
contentEditable?: boolean;
|
|
121
|
-
|
|
122
|
-
|
|
318
|
+
key?: string;
|
|
319
|
+
}
|
|
320
|
+
interface SlotField extends BaseField {
|
|
123
321
|
type: "slot";
|
|
124
322
|
allow?: string[];
|
|
125
323
|
disallow?: string[];
|
|
126
|
-
}
|
|
127
|
-
type Field<ValueType = any, UserField extends {} = {}> = TextField | NumberField | TextareaField | SelectField | RadioField | ArrayField<ValueType extends {
|
|
324
|
+
}
|
|
325
|
+
type Field<ValueType = any, UserField extends {} = {}> = TextField | RichtextField | NumberField | TextareaField | SelectField | RadioField | ArrayField<ValueType extends {
|
|
128
326
|
[key: string]: any;
|
|
129
327
|
}[] ? ValueType : never, UserField> | ObjectField<ValueType, UserField> | ExternalField<ValueType> | ExternalFieldWithAdaptor<ValueType> | CustomField<ValueType> | SlotField;
|
|
130
328
|
type Fields<ComponentProps extends DefaultComponentProps = DefaultComponentProps, UserField extends {} = {}> = {
|
|
@@ -145,13 +343,15 @@ type DropZoneProps = {
|
|
|
145
343
|
allow?: string[];
|
|
146
344
|
disallow?: string[];
|
|
147
345
|
style?: CSSProperties;
|
|
148
|
-
minEmptyHeight?: number;
|
|
346
|
+
minEmptyHeight?: CSSProperties["minHeight"] | number;
|
|
149
347
|
className?: string;
|
|
150
348
|
collisionAxis?: DragAxis;
|
|
349
|
+
as?: ElementType;
|
|
350
|
+
ref?: Ref<any>;
|
|
151
351
|
};
|
|
152
352
|
|
|
153
353
|
type PuckContext = {
|
|
154
|
-
renderDropZone: React.
|
|
354
|
+
renderDropZone: (props: DropZoneProps) => React.ReactNode;
|
|
155
355
|
metadata: Metadata;
|
|
156
356
|
isEditing: boolean;
|
|
157
357
|
dragRef: ((element: Element | null) => void) | null;
|
|
@@ -201,6 +401,8 @@ type ResolveDataTrigger = "insert" | "replace" | "load" | "force";
|
|
|
201
401
|
type WithPartialProps<T, Props extends DefaultComponentProps> = Omit<T, "props"> & {
|
|
202
402
|
props?: Partial<Props>;
|
|
203
403
|
};
|
|
404
|
+
interface ComponentConfigExtensions {
|
|
405
|
+
}
|
|
204
406
|
type ComponentConfigInternal<RenderProps extends DefaultComponentProps, FieldProps extends DefaultComponentProps, DataShape = Omit<ComponentData<FieldProps>, "type">, // NB this doesn't include AllProps, so types will not contain deep slot types. To fix, we require a breaking change.
|
|
205
407
|
UserField extends BaseField = {}> = {
|
|
206
408
|
render: PuckComponent<RenderProps>;
|
|
@@ -216,7 +418,7 @@ UserField extends BaseField = {}> = {
|
|
|
216
418
|
fields: Fields<FieldProps>;
|
|
217
419
|
lastFields: Fields<FieldProps>;
|
|
218
420
|
lastData: DataShape | null;
|
|
219
|
-
metadata:
|
|
421
|
+
metadata: ComponentMetadata;
|
|
220
422
|
appState: AppState;
|
|
221
423
|
parent: ComponentData | null;
|
|
222
424
|
}) => Promise<Fields<FieldProps>> | Fields<FieldProps>;
|
|
@@ -225,7 +427,7 @@ UserField extends BaseField = {}> = {
|
|
|
225
427
|
id: string;
|
|
226
428
|
}>;
|
|
227
429
|
lastData: DataShape | null;
|
|
228
|
-
metadata:
|
|
430
|
+
metadata: ComponentMetadata;
|
|
229
431
|
trigger: ResolveDataTrigger;
|
|
230
432
|
}) => Promise<WithPartialProps<DataShape, FieldProps>> | WithPartialProps<DataShape, FieldProps>;
|
|
231
433
|
resolvePermissions?: (data: DataShape, params: {
|
|
@@ -236,9 +438,10 @@ UserField extends BaseField = {}> = {
|
|
|
236
438
|
permissions: Partial<Permissions>;
|
|
237
439
|
appState: AppState;
|
|
238
440
|
lastData: DataShape | null;
|
|
441
|
+
parent: ComponentData | null;
|
|
239
442
|
}) => Promise<Partial<Permissions>> | Partial<Permissions>;
|
|
240
|
-
metadata?:
|
|
241
|
-
};
|
|
443
|
+
metadata?: ComponentMetadata;
|
|
444
|
+
} & ComponentConfigExtensions;
|
|
242
445
|
type ComponentConfig<RenderPropsOrParams extends LeftOrExactRight<RenderPropsOrParams, DefaultComponentProps, ComponentConfigParams> = DefaultComponentProps, FieldProps extends DefaultComponentProps = RenderPropsOrParams extends {
|
|
243
446
|
props: any;
|
|
244
447
|
} ? RenderPropsOrParams["props"] : RenderPropsOrParams, DataShape = Omit<ComponentData<FieldProps>, "type">> = RenderPropsOrParams extends ComponentConfigParams<infer ParamsRenderProps, never> ? ComponentConfigInternal<ParamsRenderProps, FieldProps, DataShape, {}> : RenderPropsOrParams extends ComponentConfigParams<infer ParamsRenderProps, infer ParamsFields> ? ComponentConfigInternal<ParamsRenderProps, FieldProps, DataShape, ParamsFields[keyof ParamsFields] & BaseField> : ComponentConfigInternal<RenderPropsOrParams, FieldProps, DataShape>;
|
|
@@ -269,6 +472,16 @@ type ExtractConfigParams<UserConfig extends ConfigInternal> = UserConfig extends
|
|
|
269
472
|
type: string;
|
|
270
473
|
} ? UserField : Field;
|
|
271
474
|
} : never;
|
|
475
|
+
type ConfigParams<Components extends DefaultComponents = DefaultComponents, RootProps extends DefaultComponentProps = any, CategoryNames extends string[] = string[], UserFields extends FieldsExtension = FieldsExtension> = {
|
|
476
|
+
components?: Components;
|
|
477
|
+
root?: RootProps;
|
|
478
|
+
categories?: CategoryNames;
|
|
479
|
+
fields?: AssertHasValue<UserFields>;
|
|
480
|
+
};
|
|
481
|
+
type ComponentConfigParams<Props extends DefaultComponentProps = DefaultComponentProps, UserFields extends FieldsExtension = never> = {
|
|
482
|
+
props: Props;
|
|
483
|
+
fields?: AssertHasValue<UserFields>;
|
|
484
|
+
};
|
|
272
485
|
|
|
273
486
|
type BaseData<Props extends {
|
|
274
487
|
[key: string]: any;
|
|
@@ -309,10 +522,17 @@ type Data<Components extends DefaultComponents = DefaultComponents, RootProps ex
|
|
|
309
522
|
type Metadata = {
|
|
310
523
|
[key: string]: any;
|
|
311
524
|
};
|
|
525
|
+
interface PuckMetadata extends Metadata {
|
|
526
|
+
}
|
|
527
|
+
interface ComponentMetadata extends PuckMetadata {
|
|
528
|
+
}
|
|
529
|
+
interface FieldMetadata extends Metadata {
|
|
530
|
+
}
|
|
312
531
|
|
|
313
532
|
type ItemWithId = {
|
|
314
533
|
_arrayId: string;
|
|
315
534
|
_originalIndex: number;
|
|
535
|
+
_currentIndex: number;
|
|
316
536
|
};
|
|
317
537
|
type ArrayState = {
|
|
318
538
|
items: ItemWithId[];
|
|
@@ -323,6 +543,7 @@ type UiState = {
|
|
|
323
543
|
rightSideBarVisible: boolean;
|
|
324
544
|
leftSideBarWidth?: number | null;
|
|
325
545
|
rightSideBarWidth?: number | null;
|
|
546
|
+
mobilePanelExpanded?: boolean;
|
|
326
547
|
itemSelector: ItemSelector | null;
|
|
327
548
|
arrayState: Record<string, ArrayState | undefined>;
|
|
328
549
|
previewMode: "interactive" | "edit";
|
|
@@ -335,7 +556,7 @@ type UiState = {
|
|
|
335
556
|
isDragging: boolean;
|
|
336
557
|
viewports: {
|
|
337
558
|
current: {
|
|
338
|
-
width: number;
|
|
559
|
+
width: number | "100%";
|
|
339
560
|
height: number | "auto";
|
|
340
561
|
};
|
|
341
562
|
controlsVisible: boolean;
|
|
@@ -343,6 +564,10 @@ type UiState = {
|
|
|
343
564
|
};
|
|
344
565
|
field: {
|
|
345
566
|
focus?: string | null;
|
|
567
|
+
metadata?: Record<string, any>;
|
|
568
|
+
};
|
|
569
|
+
plugin: {
|
|
570
|
+
current: string | null;
|
|
346
571
|
};
|
|
347
572
|
};
|
|
348
573
|
type AppState<UserData extends Data = Data> = {
|
|
@@ -377,26 +602,25 @@ type BuiltinTypes = Date | RegExp | Error | Function | symbol | null | undefined
|
|
|
377
602
|
type WithDeepSlots<T, SlotType = T> = T extends Slot ? SlotType : T extends (infer U)[] ? Array<WithDeepSlots<U, SlotType>> : T extends (infer U)[] ? WithDeepSlots<U, SlotType>[] : T extends BuiltinTypes ? T : T extends object ? {
|
|
378
603
|
[K in keyof T]: WithDeepSlots<T[K], SlotType>;
|
|
379
604
|
} : T;
|
|
380
|
-
type ConfigParams<Components extends DefaultComponents = DefaultComponents, RootProps extends DefaultComponentProps = any, CategoryNames extends string[] = string[], UserFields extends FieldsExtension = FieldsExtension> = {
|
|
381
|
-
components?: Components;
|
|
382
|
-
root?: RootProps;
|
|
383
|
-
categories?: CategoryNames;
|
|
384
|
-
fields?: AssertHasValue<UserFields>;
|
|
385
|
-
};
|
|
386
605
|
type FieldsExtension = {
|
|
387
606
|
[Type in string]: {
|
|
388
607
|
type: Type;
|
|
389
608
|
};
|
|
390
609
|
};
|
|
391
|
-
type ComponentConfigParams<Props extends DefaultComponentProps = DefaultComponentProps, UserFields extends FieldsExtension = never> = {
|
|
392
|
-
props: Props;
|
|
393
|
-
fields?: AssertHasValue<UserFields>;
|
|
394
|
-
};
|
|
395
610
|
type Exact<T, Target> = Record<Exclude<keyof T, keyof Target>, never>;
|
|
396
611
|
type LeftOrExactRight<Union, Left, Right> = (Left & Union extends Right ? Exact<Union, Right> : Left) | (Right & Exact<Union, Right>);
|
|
397
612
|
type AssertHasValue<T, True = T, False = never> = [keyof T] extends [
|
|
398
613
|
never
|
|
399
614
|
] ? False : True;
|
|
615
|
+
type RenderFunc<Props extends {
|
|
616
|
+
[key: string]: any;
|
|
617
|
+
} = {
|
|
618
|
+
children: ReactNode;
|
|
619
|
+
}> = (props: Props) => ReactElement;
|
|
620
|
+
type PluginInternal = Plugin & {
|
|
621
|
+
mobileOnly?: boolean;
|
|
622
|
+
desktopOnly?: boolean;
|
|
623
|
+
};
|
|
400
624
|
|
|
401
625
|
type MapFnParams<ThisField = Field> = {
|
|
402
626
|
value: any;
|
|
@@ -420,11 +644,6 @@ G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>, UserField extends
|
|
|
420
644
|
[Type in UserField["type"]]: FieldTransformFn<ExtractField<UserField, Type>>;
|
|
421
645
|
}>;
|
|
422
646
|
|
|
423
|
-
type RenderFunc<Props extends {
|
|
424
|
-
[key: string]: any;
|
|
425
|
-
} = {
|
|
426
|
-
children: ReactNode;
|
|
427
|
-
}> = (props: Props) => ReactElement;
|
|
428
647
|
declare const overrideKeys: readonly ["header", "headerActions", "fields", "fieldLabel", "drawer", "drawerItem", "componentOverlay", "outline", "puck", "preview"];
|
|
429
648
|
type OverrideKey = (typeof overrideKeys)[number];
|
|
430
649
|
type OverridesGeneric<Shape extends {
|
|
@@ -496,7 +715,7 @@ type DragAxis = "dynamic" | "y" | "x";
|
|
|
496
715
|
|
|
497
716
|
type iconTypes = "Smartphone" | "Monitor" | "Tablet";
|
|
498
717
|
type Viewport = {
|
|
499
|
-
width: number;
|
|
718
|
+
width: number | "100%";
|
|
500
719
|
height?: number | "auto";
|
|
501
720
|
label?: string;
|
|
502
721
|
icon?: iconTypes | ReactNode;
|
|
@@ -516,8 +735,13 @@ type IframeConfig = {
|
|
|
516
735
|
};
|
|
517
736
|
type OnAction<UserData extends Data = Data> = (action: PuckAction, appState: AppState<UserData>, prevAppState: AppState<UserData>) => void;
|
|
518
737
|
type Plugin<UserConfig extends Config = Config> = {
|
|
738
|
+
name?: string;
|
|
739
|
+
label?: string;
|
|
740
|
+
icon?: ReactNode;
|
|
741
|
+
render?: () => ReactElement;
|
|
519
742
|
overrides?: Partial<Overrides<UserConfig>>;
|
|
520
743
|
fieldTransforms?: FieldTransforms<UserConfig>;
|
|
744
|
+
mobilePanelHeight?: "toggle" | "min-content";
|
|
521
745
|
};
|
|
522
746
|
type History<D = any> = {
|
|
523
747
|
state: D;
|
|
@@ -542,6 +766,7 @@ type Slot<Props extends {
|
|
|
542
766
|
[K in keyof Props]: ComponentDataOptionalId<Props[K], K extends string ? K : never>;
|
|
543
767
|
}[keyof Props][];
|
|
544
768
|
type WithSlotProps<Target extends Record<string, any>, Components extends DefaultComponents = DefaultComponents, SlotType extends Content<Components> = Content<Components>> = WithDeepSlots<Target, SlotType>;
|
|
769
|
+
type RichText = string | ReactNode;
|
|
545
770
|
|
|
546
771
|
type InsertAction = {
|
|
547
772
|
type: "insert";
|
|
@@ -609,30 +834,4 @@ type PuckAction = {
|
|
|
609
834
|
recordHistory?: boolean;
|
|
610
835
|
} & (ReorderAction | InsertAction | MoveAction | ReplaceAction | ReplaceRootAction | RemoveAction | DuplicateAction | SetAction | SetDataAction | SetUiAction | RegisterZoneAction | UnregisterZoneAction);
|
|
611
836
|
|
|
612
|
-
type
|
|
613
|
-
migrateDynamicZonesForComponent?: {
|
|
614
|
-
[ComponentName in keyof UserConfig["components"]]: (props: WithId<UserGenerics<UserConfig>["UserProps"][ComponentName]>, zones: Record<string, Content>) => ComponentData["props"];
|
|
615
|
-
};
|
|
616
|
-
};
|
|
617
|
-
declare function migrate<UserConfig extends Config = Config>(data: Data, config?: UserConfig, migrationOptions?: MigrationOptions<UserConfig>): Data;
|
|
618
|
-
|
|
619
|
-
type PropTransform<Components extends DefaultComponents = DefaultComponents, RootProps extends DefaultComponentProps = DefaultRootFieldProps> = Partial<{
|
|
620
|
-
[ComponentName in keyof Components]: (props: Components[ComponentName] & {
|
|
621
|
-
[key: string]: any;
|
|
622
|
-
}) => Components[ComponentName];
|
|
623
|
-
} & {
|
|
624
|
-
root: (props: RootProps & {
|
|
625
|
-
[key: string]: any;
|
|
626
|
-
}) => RootProps;
|
|
627
|
-
}>;
|
|
628
|
-
declare function transformProps<Components extends DefaultComponents = DefaultComponents, RootProps extends DefaultComponentProps = DefaultRootFieldProps>(data: Partial<Data>, propTransforms: PropTransform<Components, RootProps>, config?: Config): Data;
|
|
629
|
-
|
|
630
|
-
declare function resolveAllData<Components extends DefaultComponents = DefaultComponents, RootProps extends Record<string, any> = DefaultRootFieldProps>(data: Partial<Data>, config: Config, metadata?: Metadata, onResolveStart?: (item: ComponentData) => void, onResolveEnd?: (item: ComponentData) => void): Promise<Data<Components, RootProps>>;
|
|
631
|
-
|
|
632
|
-
type WalkTreeOptions = {
|
|
633
|
-
parentId: string;
|
|
634
|
-
propName: string;
|
|
635
|
-
};
|
|
636
|
-
declare function walkTree<T extends ComponentData | RootData | G["UserData"], UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>>(data: T, config: UserConfig, callbackFn: (data: Content, options: WalkTreeOptions) => Content | null | void): T;
|
|
637
|
-
|
|
638
|
-
export { type BaseField as $, type AppState as A, type ArrayState as B, type Config as C, type DropZoneProps as D, type SlotComponent as E, type Fields as F, type PuckComponent as G, type History as H, type IframeConfig as I, type RootConfig as J, type DefaultComponents as K, type ExtractConfigParams as L, type Metadata as M, type BaseData as N, type Overrides as O, type Permissions as P, type RootDataWithoutProps as Q, type RootDataWithProps as R, type Slot as S, type RootData as T, type UserGenerics as U, type Viewports as V, type WithSlotProps as W, type ComponentDataOptionalId as X, type MappedItem as Y, type ComponentDataMap as Z, type Content as _, type ComponentData as a, type TextField as a0, type NumberField as a1, type TextareaField as a2, type SelectField as a3, type RadioField as a4, type ArrayField as a5, type ObjectField as a6, type Adaptor as a7, type ExternalFieldWithAdaptor as a8, type CacheOpts as a9, type ExternalField as aa, type CustomFieldRender as ab, type CustomField as ac, type SlotField as ad, type PuckContext as ae, type DefaultRootFieldProps as af, type DefaultRootRenderProps as ag, type DefaultRootProps as ah, type DefaultComponentProps as ai, type WithId as aj, type WithPuckProps as ak, type AsFieldProps as al, type WithChildren as am, type ExtractField as an, type PuckAction as b, type ResolveDataTrigger as c, type Plugin as d, type UiState as e, type ComponentConfig as f, type FieldTransforms as g, type Field as h, type FieldProps as i, type Data as j, type OnAction as k, type InitialHistory as l, migrate as m, type ItemSelector as n, type Direction as o, type DragAxis as p, type Viewport as q, resolveAllData as r, type FieldTransformFnParams as s, transformProps as t, type FieldTransformFn as u, overrideKeys as v, walkTree as w, type OverrideKey as x, type FieldRenderFunctions as y, type ItemWithId as z };
|
|
837
|
+
export { type ComponentConfigParams as $, type AppState as A, type FieldTransformFnParams as B, type Config as C, type Data as D, type FieldTransformFn as E, type Fields as F, overrideKeys as G, type History as H, type IframeConfig as I, type OverrideKey as J, type FieldRenderFunctions as K, type ItemWithId as L, type Metadata as M, type ArrayState as N, type OnAction as O, type PrivateAppState as P, type SlotComponent as Q, type RootData as R, type Slot as S, type PuckComponent as T, type UserGenerics as U, type Viewports as V, type WithId as W, type ComponentConfigExtensions as X, type RootConfig as Y, type ExtractConfigParams as Z, type ConfigParams as _, type PuckAction as a, type BaseData as a0, type RootDataWithoutProps as a1, type ComponentDataOptionalId as a2, type MappedItem as a3, type ComponentDataMap as a4, type PuckMetadata as a5, type ComponentMetadata as a6, type FieldMetadata as a7, type BaseField as a8, type TextField as a9, type NumberField as aa, type TextareaField as ab, type SelectField as ac, type RadioField as ad, type ArrayField as ae, type ObjectField as af, type Adaptor as ag, type ExternalFieldWithAdaptor as ah, type CacheOpts as ai, type ExternalField as aj, type CustomFieldRender as ak, type CustomField as al, type SlotField as am, type PuckContext as an, type DefaultRootRenderProps as ao, type DefaultRootProps as ap, type WithPuckProps as aq, type AsFieldProps as ar, type WithChildren as as, type ExtractField as at, type Content as b, type ComponentData as c, type DefaultComponents as d, type DefaultComponentProps as e, type DefaultRootFieldProps as f, type Permissions as g, type RootDataWithProps as h, type ResolveDataTrigger as i, type Plugin as j, type Overrides as k, type UiState as l, type ComponentConfig as m, type FieldTransforms as n, type RichtextField as o, type Field as p, type FieldProps as q, type DropZoneProps as r, type InitialHistory as s, type ItemSelector as t, type PluginInternal as u, type WithSlotProps as v, type RichText as w, type Direction as x, type DragAxis as y, type Viewport as z };
|