@measured/puck 0.21.0-canary.a3dabae1 → 0.21.0-canary.a62292fd
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-O447AVCX.mjs +204 -0
- package/dist/Render-OFE6QLI2.mjs +55 -0
- package/dist/Render-QEMDIDQC.css +101 -0
- package/dist/{walk-tree-Cvtjzg9C.d.mts → actions-ONhOkrvf.d.mts} +270 -95
- package/dist/{walk-tree-Cvtjzg9C.d.ts → actions-ONhOkrvf.d.ts} +270 -95
- package/dist/chunk-2Q4PACDA.mjs +111 -0
- package/dist/chunk-62AAYNXG.mjs +63 -0
- package/dist/{chunk-V2FU5KB6.mjs → chunk-7GESFTRA.mjs} +5544 -8012
- package/dist/chunk-BSDEIOEK.mjs +706 -0
- package/dist/chunk-CSSRLPHM.mjs +11 -0
- package/dist/chunk-DAQLMM2T.mjs +1722 -0
- package/dist/chunk-M6W7YEVX.mjs +95 -0
- package/dist/chunk-NLUHDYVR.mjs +416 -0
- package/dist/chunk-PLXSMBAA.mjs +53 -0
- package/dist/chunk-QAWJTCV5.mjs +33 -0
- package/dist/chunk-QBGM4ELA.mjs +528 -0
- package/dist/chunk-T3WX7XJ6.mjs +132 -0
- package/dist/chunk-V5I7CVLT.mjs +103 -0
- package/dist/chunk-Y2EFNT5P.mjs +108 -0
- package/dist/chunk-Y656T6AQ.mjs +419 -0
- package/dist/full-2GJTAAZE.css +301 -0
- package/dist/full-BEMDJKDS.mjs +93 -0
- package/dist/index-BEoNHRI1.d.ts +116 -0
- package/dist/index-DfxZ7tZF.d.mts +116 -0
- package/dist/index.css +640 -761
- package/dist/index.d.mts +95 -123
- package/dist/index.d.ts +95 -123
- package/dist/index.js +8032 -5511
- package/dist/index.mjs +28 -15
- package/dist/internal.d.mts +27 -0
- package/dist/internal.d.ts +27 -0
- package/dist/internal.js +908 -0
- package/dist/internal.mjs +13 -0
- package/dist/loaded-JU3A7Y4L.mjs +57 -0
- package/dist/loaded-N3FYGF2Y.mjs +57 -0
- package/dist/loaded-OBY7OMS6.mjs +60 -0
- package/dist/loaded-RVWBFK7L.css +87 -0
- package/dist/no-external.css +640 -761
- package/dist/no-external.d.mts +19 -2
- package/dist/no-external.d.ts +19 -2
- package/dist/no-external.js +8023 -5502
- package/dist/no-external.mjs +28 -15
- package/dist/rsc.css +101 -0
- package/dist/rsc.d.mts +17 -2
- package/dist/rsc.d.ts +17 -2
- package/dist/rsc.js +437 -57
- package/dist/rsc.mjs +18 -9
- package/dist/walk-tree-CdriEzFJ.d.mts +29 -0
- package/dist/walk-tree-DHbAZ4wF.d.ts +29 -0
- package/package.json +31 -4
- package/dist/chunk-C24EBUN6.mjs +0 -971
|
@@ -1,72 +1,269 @@
|
|
|
1
|
-
import { ReactElement, CSSProperties, ReactNode, JSX } from 'react';
|
|
1
|
+
import { ReactElement, CSSProperties, ReactNode, ElementType, 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,12 +277,16 @@ 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;
|
|
281
|
+
};
|
|
282
|
+
type CacheOpts = {
|
|
283
|
+
enabled?: boolean;
|
|
84
284
|
};
|
|
85
|
-
|
|
285
|
+
interface ExternalField<Props extends any = {
|
|
86
286
|
[key: string]: any;
|
|
87
|
-
}>
|
|
287
|
+
}> extends BaseField {
|
|
88
288
|
type: "external";
|
|
289
|
+
cache?: CacheOpts;
|
|
89
290
|
placeholder?: string;
|
|
90
291
|
fetchList: (params: {
|
|
91
292
|
query: string;
|
|
@@ -93,7 +294,7 @@ type ExternalField<Props extends any = {
|
|
|
93
294
|
}) => Promise<any[] | null>;
|
|
94
295
|
mapProp?: (value: any) => Props;
|
|
95
296
|
mapRow?: (value: any) => Record<string, string | number | ReactElement>;
|
|
96
|
-
getItemSummary?: (item: NotUndefined<Props>, index?: number) =>
|
|
297
|
+
getItemSummary?: (item: NotUndefined<Props>, index?: number) => ReactNode;
|
|
97
298
|
showSearch?: boolean;
|
|
98
299
|
renderFooter?: (props: {
|
|
99
300
|
items: any[];
|
|
@@ -101,7 +302,7 @@ type ExternalField<Props extends any = {
|
|
|
101
302
|
initialQuery?: string;
|
|
102
303
|
filterFields?: Record<string, Field>;
|
|
103
304
|
initialFilters?: Record<string, any>;
|
|
104
|
-
}
|
|
305
|
+
}
|
|
105
306
|
type CustomFieldRender<Value extends any> = (props: {
|
|
106
307
|
field: CustomField<Value>;
|
|
107
308
|
name: string;
|
|
@@ -110,17 +311,18 @@ type CustomFieldRender<Value extends any> = (props: {
|
|
|
110
311
|
onChange: (value: Value) => void;
|
|
111
312
|
readOnly?: boolean;
|
|
112
313
|
}) => ReactElement;
|
|
113
|
-
|
|
314
|
+
interface CustomField<Value extends any> extends BaseField {
|
|
114
315
|
type: "custom";
|
|
115
316
|
render: CustomFieldRender<Value>;
|
|
116
317
|
contentEditable?: boolean;
|
|
117
|
-
|
|
118
|
-
|
|
318
|
+
key?: string;
|
|
319
|
+
}
|
|
320
|
+
interface SlotField extends BaseField {
|
|
119
321
|
type: "slot";
|
|
120
322
|
allow?: string[];
|
|
121
323
|
disallow?: string[];
|
|
122
|
-
}
|
|
123
|
-
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 {
|
|
124
326
|
[key: string]: any;
|
|
125
327
|
}[] ? ValueType : never, UserField> | ObjectField<ValueType, UserField> | ExternalField<ValueType> | ExternalFieldWithAdaptor<ValueType> | CustomField<ValueType> | SlotField;
|
|
126
328
|
type Fields<ComponentProps extends DefaultComponentProps = DefaultComponentProps, UserField extends {} = {}> = {
|
|
@@ -141,13 +343,14 @@ type DropZoneProps = {
|
|
|
141
343
|
allow?: string[];
|
|
142
344
|
disallow?: string[];
|
|
143
345
|
style?: CSSProperties;
|
|
144
|
-
minEmptyHeight?: number;
|
|
346
|
+
minEmptyHeight?: CSSProperties["minHeight"] | number;
|
|
145
347
|
className?: string;
|
|
146
348
|
collisionAxis?: DragAxis;
|
|
349
|
+
as?: ElementType;
|
|
147
350
|
};
|
|
148
351
|
|
|
149
352
|
type PuckContext = {
|
|
150
|
-
renderDropZone: React.
|
|
353
|
+
renderDropZone: (props: DropZoneProps) => React.ReactNode;
|
|
151
354
|
metadata: Metadata;
|
|
152
355
|
isEditing: boolean;
|
|
153
356
|
dragRef: ((element: Element | null) => void) | null;
|
|
@@ -197,6 +400,8 @@ type ResolveDataTrigger = "insert" | "replace" | "load" | "force";
|
|
|
197
400
|
type WithPartialProps<T, Props extends DefaultComponentProps> = Omit<T, "props"> & {
|
|
198
401
|
props?: Partial<Props>;
|
|
199
402
|
};
|
|
403
|
+
interface ComponentConfigExtensions {
|
|
404
|
+
}
|
|
200
405
|
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.
|
|
201
406
|
UserField extends BaseField = {}> = {
|
|
202
407
|
render: PuckComponent<RenderProps>;
|
|
@@ -212,7 +417,7 @@ UserField extends BaseField = {}> = {
|
|
|
212
417
|
fields: Fields<FieldProps>;
|
|
213
418
|
lastFields: Fields<FieldProps>;
|
|
214
419
|
lastData: DataShape | null;
|
|
215
|
-
metadata:
|
|
420
|
+
metadata: ComponentMetadata;
|
|
216
421
|
appState: AppState;
|
|
217
422
|
parent: ComponentData | null;
|
|
218
423
|
}) => Promise<Fields<FieldProps>> | Fields<FieldProps>;
|
|
@@ -221,7 +426,7 @@ UserField extends BaseField = {}> = {
|
|
|
221
426
|
id: string;
|
|
222
427
|
}>;
|
|
223
428
|
lastData: DataShape | null;
|
|
224
|
-
metadata:
|
|
429
|
+
metadata: ComponentMetadata;
|
|
225
430
|
trigger: ResolveDataTrigger;
|
|
226
431
|
}) => Promise<WithPartialProps<DataShape, FieldProps>> | WithPartialProps<DataShape, FieldProps>;
|
|
227
432
|
resolvePermissions?: (data: DataShape, params: {
|
|
@@ -232,9 +437,10 @@ UserField extends BaseField = {}> = {
|
|
|
232
437
|
permissions: Partial<Permissions>;
|
|
233
438
|
appState: AppState;
|
|
234
439
|
lastData: DataShape | null;
|
|
440
|
+
parent: ComponentData | null;
|
|
235
441
|
}) => Promise<Partial<Permissions>> | Partial<Permissions>;
|
|
236
|
-
metadata?:
|
|
237
|
-
};
|
|
442
|
+
metadata?: ComponentMetadata;
|
|
443
|
+
} & ComponentConfigExtensions;
|
|
238
444
|
type ComponentConfig<RenderPropsOrParams extends LeftOrExactRight<RenderPropsOrParams, DefaultComponentProps, ComponentConfigParams> = DefaultComponentProps, FieldProps extends DefaultComponentProps = RenderPropsOrParams extends {
|
|
239
445
|
props: any;
|
|
240
446
|
} ? 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>;
|
|
@@ -265,6 +471,16 @@ type ExtractConfigParams<UserConfig extends ConfigInternal> = UserConfig extends
|
|
|
265
471
|
type: string;
|
|
266
472
|
} ? UserField : Field;
|
|
267
473
|
} : never;
|
|
474
|
+
type ConfigParams<Components extends DefaultComponents = DefaultComponents, RootProps extends DefaultComponentProps = any, CategoryNames extends string[] = string[], UserFields extends FieldsExtension = FieldsExtension> = {
|
|
475
|
+
components?: Components;
|
|
476
|
+
root?: RootProps;
|
|
477
|
+
categories?: CategoryNames;
|
|
478
|
+
fields?: AssertHasValue<UserFields>;
|
|
479
|
+
};
|
|
480
|
+
type ComponentConfigParams<Props extends DefaultComponentProps = DefaultComponentProps, UserFields extends FieldsExtension = never> = {
|
|
481
|
+
props: Props;
|
|
482
|
+
fields?: AssertHasValue<UserFields>;
|
|
483
|
+
};
|
|
268
484
|
|
|
269
485
|
type BaseData<Props extends {
|
|
270
486
|
[key: string]: any;
|
|
@@ -305,11 +521,16 @@ type Data<Components extends DefaultComponents = DefaultComponents, RootProps ex
|
|
|
305
521
|
type Metadata = {
|
|
306
522
|
[key: string]: any;
|
|
307
523
|
};
|
|
524
|
+
interface PuckMetadata extends Metadata {
|
|
525
|
+
}
|
|
526
|
+
interface ComponentMetadata extends PuckMetadata {
|
|
527
|
+
}
|
|
528
|
+
interface FieldMetadata extends Metadata {
|
|
529
|
+
}
|
|
308
530
|
|
|
309
531
|
type ItemWithId = {
|
|
310
532
|
_arrayId: string;
|
|
311
533
|
_originalIndex: number;
|
|
312
|
-
_currentIndex: number;
|
|
313
534
|
};
|
|
314
535
|
type ArrayState = {
|
|
315
536
|
items: ItemWithId[];
|
|
@@ -320,7 +541,6 @@ type UiState = {
|
|
|
320
541
|
rightSideBarVisible: boolean;
|
|
321
542
|
leftSideBarWidth?: number | null;
|
|
322
543
|
rightSideBarWidth?: number | null;
|
|
323
|
-
mobilePanelExpanded?: boolean;
|
|
324
544
|
itemSelector: ItemSelector | null;
|
|
325
545
|
arrayState: Record<string, ArrayState | undefined>;
|
|
326
546
|
previewMode: "interactive" | "edit";
|
|
@@ -333,7 +553,7 @@ type UiState = {
|
|
|
333
553
|
isDragging: boolean;
|
|
334
554
|
viewports: {
|
|
335
555
|
current: {
|
|
336
|
-
width: number
|
|
556
|
+
width: number;
|
|
337
557
|
height: number | "auto";
|
|
338
558
|
};
|
|
339
559
|
controlsVisible: boolean;
|
|
@@ -341,9 +561,7 @@ type UiState = {
|
|
|
341
561
|
};
|
|
342
562
|
field: {
|
|
343
563
|
focus?: string | null;
|
|
344
|
-
|
|
345
|
-
plugin: {
|
|
346
|
-
current: string | null;
|
|
564
|
+
metadata?: Record<string, any>;
|
|
347
565
|
};
|
|
348
566
|
};
|
|
349
567
|
type AppState<UserData extends Data = Data> = {
|
|
@@ -378,34 +596,16 @@ type BuiltinTypes = Date | RegExp | Error | Function | symbol | null | undefined
|
|
|
378
596
|
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 ? {
|
|
379
597
|
[K in keyof T]: WithDeepSlots<T[K], SlotType>;
|
|
380
598
|
} : T;
|
|
381
|
-
type ConfigParams<Components extends DefaultComponents = DefaultComponents, RootProps extends DefaultComponentProps = any, CategoryNames extends string[] = string[], UserFields extends FieldsExtension = FieldsExtension> = {
|
|
382
|
-
components?: Components;
|
|
383
|
-
root?: RootProps;
|
|
384
|
-
categories?: CategoryNames;
|
|
385
|
-
fields?: AssertHasValue<UserFields>;
|
|
386
|
-
};
|
|
387
599
|
type FieldsExtension = {
|
|
388
600
|
[Type in string]: {
|
|
389
601
|
type: Type;
|
|
390
602
|
};
|
|
391
603
|
};
|
|
392
|
-
type ComponentConfigParams<Props extends DefaultComponentProps = DefaultComponentProps, UserFields extends FieldsExtension = never> = {
|
|
393
|
-
props: Props;
|
|
394
|
-
fields?: AssertHasValue<UserFields>;
|
|
395
|
-
};
|
|
396
604
|
type Exact<T, Target> = Record<Exclude<keyof T, keyof Target>, never>;
|
|
397
605
|
type LeftOrExactRight<Union, Left, Right> = (Left & Union extends Right ? Exact<Union, Right> : Left) | (Right & Exact<Union, Right>);
|
|
398
606
|
type AssertHasValue<T, True = T, False = never> = [keyof T] extends [
|
|
399
607
|
never
|
|
400
608
|
] ? False : True;
|
|
401
|
-
type RenderFunc<Props extends {
|
|
402
|
-
[key: string]: any;
|
|
403
|
-
} = {
|
|
404
|
-
children: ReactNode;
|
|
405
|
-
}> = (props: Props) => ReactElement;
|
|
406
|
-
type PluginInternal = Plugin & {
|
|
407
|
-
mobileOnly?: boolean;
|
|
408
|
-
};
|
|
409
609
|
|
|
410
610
|
type MapFnParams<ThisField = Field> = {
|
|
411
611
|
value: any;
|
|
@@ -429,6 +629,11 @@ G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>, UserField extends
|
|
|
429
629
|
[Type in UserField["type"]]: FieldTransformFn<ExtractField<UserField, Type>>;
|
|
430
630
|
}>;
|
|
431
631
|
|
|
632
|
+
type RenderFunc<Props extends {
|
|
633
|
+
[key: string]: any;
|
|
634
|
+
} = {
|
|
635
|
+
children: ReactNode;
|
|
636
|
+
}> = (props: Props) => ReactElement;
|
|
432
637
|
declare const overrideKeys: readonly ["header", "headerActions", "fields", "fieldLabel", "drawer", "drawerItem", "componentOverlay", "outline", "puck", "preview"];
|
|
433
638
|
type OverrideKey = (typeof overrideKeys)[number];
|
|
434
639
|
type OverridesGeneric<Shape extends {
|
|
@@ -500,7 +705,7 @@ type DragAxis = "dynamic" | "y" | "x";
|
|
|
500
705
|
|
|
501
706
|
type iconTypes = "Smartphone" | "Monitor" | "Tablet";
|
|
502
707
|
type Viewport = {
|
|
503
|
-
width: number
|
|
708
|
+
width: number;
|
|
504
709
|
height?: number | "auto";
|
|
505
710
|
label?: string;
|
|
506
711
|
icon?: iconTypes | ReactNode;
|
|
@@ -520,13 +725,8 @@ type IframeConfig = {
|
|
|
520
725
|
};
|
|
521
726
|
type OnAction<UserData extends Data = Data> = (action: PuckAction, appState: AppState<UserData>, prevAppState: AppState<UserData>) => void;
|
|
522
727
|
type Plugin<UserConfig extends Config = Config> = {
|
|
523
|
-
name?: string;
|
|
524
|
-
label?: string;
|
|
525
|
-
icon?: ReactNode;
|
|
526
|
-
render?: () => ReactElement;
|
|
527
728
|
overrides?: Partial<Overrides<UserConfig>>;
|
|
528
729
|
fieldTransforms?: FieldTransforms<UserConfig>;
|
|
529
|
-
mobilePanelHeight?: "toggle" | "min-content";
|
|
530
730
|
};
|
|
531
731
|
type History<D = any> = {
|
|
532
732
|
state: D;
|
|
@@ -551,6 +751,7 @@ type Slot<Props extends {
|
|
|
551
751
|
[K in keyof Props]: ComponentDataOptionalId<Props[K], K extends string ? K : never>;
|
|
552
752
|
}[keyof Props][];
|
|
553
753
|
type WithSlotProps<Target extends Record<string, any>, Components extends DefaultComponents = DefaultComponents, SlotType extends Content<Components> = Content<Components>> = WithDeepSlots<Target, SlotType>;
|
|
754
|
+
type RichText = string | ReactNode;
|
|
554
755
|
|
|
555
756
|
type InsertAction = {
|
|
556
757
|
type: "insert";
|
|
@@ -618,30 +819,4 @@ type PuckAction = {
|
|
|
618
819
|
recordHistory?: boolean;
|
|
619
820
|
} & (ReorderAction | InsertAction | MoveAction | ReplaceAction | ReplaceRootAction | RemoveAction | DuplicateAction | SetAction | SetDataAction | SetUiAction | RegisterZoneAction | UnregisterZoneAction);
|
|
620
821
|
|
|
621
|
-
type
|
|
622
|
-
migrateDynamicZonesForComponent?: {
|
|
623
|
-
[ComponentName in keyof UserConfig["components"]]: (props: WithId<UserGenerics<UserConfig>["UserProps"][ComponentName]>, zones: Record<string, Content>) => ComponentData["props"];
|
|
624
|
-
};
|
|
625
|
-
};
|
|
626
|
-
declare function migrate<UserConfig extends Config = Config>(data: Data, config?: UserConfig, migrationOptions?: MigrationOptions<UserConfig>): Data;
|
|
627
|
-
|
|
628
|
-
type PropTransform<Components extends DefaultComponents = DefaultComponents, RootProps extends DefaultComponentProps = DefaultRootFieldProps> = Partial<{
|
|
629
|
-
[ComponentName in keyof Components]: (props: Components[ComponentName] & {
|
|
630
|
-
[key: string]: any;
|
|
631
|
-
}) => Components[ComponentName];
|
|
632
|
-
} & {
|
|
633
|
-
root: (props: RootProps & {
|
|
634
|
-
[key: string]: any;
|
|
635
|
-
}) => RootProps;
|
|
636
|
-
}>;
|
|
637
|
-
declare function transformProps<Components extends DefaultComponents = DefaultComponents, RootProps extends DefaultComponentProps = DefaultRootFieldProps>(data: Partial<Data>, propTransforms: PropTransform<Components, RootProps>, config?: Config): Data;
|
|
638
|
-
|
|
639
|
-
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>>;
|
|
640
|
-
|
|
641
|
-
type WalkTreeOptions = {
|
|
642
|
-
parentId: string;
|
|
643
|
-
propName: string;
|
|
644
|
-
};
|
|
645
|
-
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;
|
|
646
|
-
|
|
647
|
-
export { type Content as $, type AppState as A, type ItemWithId as B, type Config as C, type DropZoneProps as D, type ArrayState as E, type Fields as F, type SlotComponent as G, type History as H, type IframeConfig as I, type PuckComponent as J, type RootConfig as K, type DefaultComponents as L, type Metadata as M, type ExtractConfigParams as N, type Overrides as O, type Permissions as P, type BaseData as Q, type RootDataWithProps as R, type Slot as S, type RootDataWithoutProps as T, type UserGenerics as U, type Viewports as V, type WithSlotProps as W, type RootData as X, type ComponentDataOptionalId as Y, type MappedItem as Z, type ComponentDataMap as _, type ComponentData as a, type BaseField as a0, type TextField as a1, type NumberField as a2, type TextareaField as a3, type SelectField as a4, type RadioField as a5, type ArrayField as a6, type ObjectField as a7, type Adaptor as a8, type ExternalFieldWithAdaptor 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 PluginInternal as o, type Direction as p, type DragAxis as q, resolveAllData as r, type Viewport as s, transformProps as t, type FieldTransformFnParams as u, type FieldTransformFn as v, walkTree as w, overrideKeys as x, type OverrideKey as y, type FieldRenderFunctions as z };
|
|
822
|
+
export { type BaseData as $, type AppState as A, type FieldTransformFn as B, type Config as C, type Data as D, overrideKeys as E, type Fields as F, type OverrideKey as G, type History as H, type IframeConfig as I, type FieldRenderFunctions as J, type ItemWithId as K, type ArrayState as L, type Metadata as M, type SlotComponent as N, type OnAction as O, type PrivateAppState as P, type PuckComponent as Q, type RootData as R, type Slot as S, type ComponentConfigExtensions as T, type UserGenerics as U, type Viewports as V, type WithId as W, type RootConfig as X, type ExtractConfigParams as Y, type ConfigParams as Z, type ComponentConfigParams as _, type PuckAction as a, type RootDataWithoutProps as a0, type ComponentDataOptionalId as a1, type MappedItem as a2, type ComponentDataMap as a3, type PuckMetadata as a4, type ComponentMetadata as a5, type FieldMetadata as a6, type BaseField as a7, type TextField as a8, type NumberField as a9, type TextareaField as aa, type SelectField as ab, type RadioField as ac, type ArrayField as ad, type ObjectField as ae, type Adaptor as af, type ExternalFieldWithAdaptor as ag, type CacheOpts as ah, type ExternalField as ai, type CustomFieldRender as aj, type CustomField as ak, type SlotField as al, type PuckContext as am, type DefaultRootRenderProps as an, type DefaultRootProps as ao, type WithPuckProps as ap, type AsFieldProps as aq, type WithChildren as ar, type ExtractField as as, 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 WithSlotProps as u, type RichText as v, type Direction as w, type DragAxis as x, type Viewport as y, type FieldTransformFnParams as z };
|