@measured/puck 0.21.0-canary.bd7b613d → 0.21.0-canary.c0db75c1

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.
@@ -1,4 +1,4 @@
1
- import { ReactElement, CSSProperties, ReactNode, JSX } from 'react';
1
+ import { ReactElement, ReactNode, CSSProperties, ElementType, JSX } from 'react';
2
2
 
3
3
  type ItemSelector = {
4
4
  index: number;
@@ -10,63 +10,63 @@ type FieldOption = {
10
10
  value: string | number | boolean | undefined | null | object;
11
11
  };
12
12
  type FieldOptions = Array<FieldOption> | ReadonlyArray<FieldOption>;
13
- type BaseField = {
13
+ interface BaseField {
14
14
  label?: string;
15
15
  labelIcon?: ReactElement;
16
- metadata?: Metadata;
16
+ metadata?: FieldMetadata;
17
17
  visible?: boolean;
18
- };
19
- type TextField = BaseField & {
18
+ }
19
+ interface TextField extends BaseField {
20
20
  type: "text";
21
21
  placeholder?: string;
22
22
  contentEditable?: boolean;
23
- };
24
- type NumberField = BaseField & {
23
+ }
24
+ interface NumberField extends BaseField {
25
25
  type: "number";
26
26
  placeholder?: string;
27
27
  min?: number;
28
28
  max?: number;
29
29
  step?: number;
30
- };
31
- type TextareaField = BaseField & {
30
+ }
31
+ interface TextareaField extends BaseField {
32
32
  type: "textarea";
33
33
  placeholder?: string;
34
34
  contentEditable?: boolean;
35
- };
36
- type SelectField = BaseField & {
35
+ }
36
+ interface SelectField extends BaseField {
37
37
  type: "select";
38
38
  options: FieldOptions;
39
- };
40
- type RadioField = BaseField & {
39
+ }
40
+ interface RadioField extends BaseField {
41
41
  type: "radio";
42
42
  options: FieldOptions;
43
- };
44
- type ArrayField<Props extends {
43
+ }
44
+ interface ArrayField<Props extends {
45
45
  [key: string]: any;
46
46
  }[] = {
47
47
  [key: string]: any;
48
- }[], UserField extends {} = {}> = BaseField & {
48
+ }[], UserField extends {} = {}> extends BaseField {
49
49
  type: "array";
50
50
  arrayFields: {
51
51
  [SubPropName in keyof Props[0]]: UserField extends {
52
52
  type: PropertyKey;
53
53
  } ? Field<Props[0][SubPropName], UserField> | UserField : Field<Props[0][SubPropName], UserField>;
54
54
  };
55
- defaultItemProps?: Props[0];
56
- getItemSummary?: (item: Props[0], index?: number) => string;
55
+ defaultItemProps?: Props[0] | ((index: number) => Props[0]);
56
+ getItemSummary?: (item: Props[0], index?: number) => ReactNode;
57
57
  max?: number;
58
58
  min?: number;
59
- };
60
- type ObjectField<Props extends any = {
59
+ }
60
+ interface ObjectField<Props extends any = {
61
61
  [key: string]: any;
62
- }, UserField extends {} = {}> = BaseField & {
62
+ }, UserField extends {} = {}> extends BaseField {
63
63
  type: "object";
64
64
  objectFields: {
65
65
  [SubPropName in keyof Props]: UserField extends {
66
66
  type: PropertyKey;
67
67
  } ? Field<Props[SubPropName]> | UserField : Field<Props[SubPropName]>;
68
68
  };
69
- };
69
+ }
70
70
  type Adaptor<AdaptorParams = {}, TableShape extends Record<string, any> = {}, PropShape = TableShape> = {
71
71
  name: string;
72
72
  fetchList: (adaptorParams?: AdaptorParams) => Promise<TableShape[] | null>;
@@ -80,12 +80,16 @@ type ExternalFieldWithAdaptor<Props extends any = {
80
80
  placeholder?: string;
81
81
  adaptor: Adaptor<any, any, Props>;
82
82
  adaptorParams?: object;
83
- getItemSummary: (item: NotUndefined<Props>, index?: number) => string;
83
+ getItemSummary: (item: NotUndefined<Props>, index?: number) => ReactNode;
84
+ };
85
+ type CacheOpts = {
86
+ enabled?: boolean;
84
87
  };
85
- type ExternalField<Props extends any = {
88
+ interface ExternalField<Props extends any = {
86
89
  [key: string]: any;
87
- }> = BaseField & {
90
+ }> extends BaseField {
88
91
  type: "external";
92
+ cache?: CacheOpts;
89
93
  placeholder?: string;
90
94
  fetchList: (params: {
91
95
  query: string;
@@ -93,7 +97,7 @@ type ExternalField<Props extends any = {
93
97
  }) => Promise<any[] | null>;
94
98
  mapProp?: (value: any) => Props;
95
99
  mapRow?: (value: any) => Record<string, string | number | ReactElement>;
96
- getItemSummary?: (item: NotUndefined<Props>, index?: number) => string;
100
+ getItemSummary?: (item: NotUndefined<Props>, index?: number) => ReactNode;
97
101
  showSearch?: boolean;
98
102
  renderFooter?: (props: {
99
103
  items: any[];
@@ -101,7 +105,7 @@ type ExternalField<Props extends any = {
101
105
  initialQuery?: string;
102
106
  filterFields?: Record<string, Field>;
103
107
  initialFilters?: Record<string, any>;
104
- };
108
+ }
105
109
  type CustomFieldRender<Value extends any> = (props: {
106
110
  field: CustomField<Value>;
107
111
  name: string;
@@ -110,16 +114,17 @@ type CustomFieldRender<Value extends any> = (props: {
110
114
  onChange: (value: Value) => void;
111
115
  readOnly?: boolean;
112
116
  }) => ReactElement;
113
- type CustomField<Value extends any> = BaseField & {
117
+ interface CustomField<Value extends any> extends BaseField {
114
118
  type: "custom";
115
119
  render: CustomFieldRender<Value>;
116
120
  contentEditable?: boolean;
117
- };
118
- type SlotField = BaseField & {
121
+ key?: string;
122
+ }
123
+ interface SlotField extends BaseField {
119
124
  type: "slot";
120
125
  allow?: string[];
121
126
  disallow?: string[];
122
- };
127
+ }
123
128
  type Field<ValueType = any, UserField extends {} = {}> = TextField | NumberField | TextareaField | SelectField | RadioField | ArrayField<ValueType extends {
124
129
  [key: string]: any;
125
130
  }[] ? ValueType : never, UserField> | ObjectField<ValueType, UserField> | ExternalField<ValueType> | ExternalFieldWithAdaptor<ValueType> | CustomField<ValueType> | SlotField;
@@ -141,13 +146,14 @@ type DropZoneProps = {
141
146
  allow?: string[];
142
147
  disallow?: string[];
143
148
  style?: CSSProperties;
144
- minEmptyHeight?: number;
149
+ minEmptyHeight?: CSSProperties["minHeight"] | number;
145
150
  className?: string;
146
151
  collisionAxis?: DragAxis;
152
+ as?: ElementType;
147
153
  };
148
154
 
149
155
  type PuckContext = {
150
- renderDropZone: React.FC<DropZoneProps>;
156
+ renderDropZone: (props: DropZoneProps) => React.ReactNode;
151
157
  metadata: Metadata;
152
158
  isEditing: boolean;
153
159
  dragRef: ((element: Element | null) => void) | null;
@@ -197,6 +203,8 @@ type ResolveDataTrigger = "insert" | "replace" | "load" | "force";
197
203
  type WithPartialProps<T, Props extends DefaultComponentProps> = Omit<T, "props"> & {
198
204
  props?: Partial<Props>;
199
205
  };
206
+ interface ComponentConfigExtensions {
207
+ }
200
208
  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
209
  UserField extends BaseField = {}> = {
202
210
  render: PuckComponent<RenderProps>;
@@ -212,7 +220,7 @@ UserField extends BaseField = {}> = {
212
220
  fields: Fields<FieldProps>;
213
221
  lastFields: Fields<FieldProps>;
214
222
  lastData: DataShape | null;
215
- metadata: Metadata;
223
+ metadata: ComponentMetadata;
216
224
  appState: AppState;
217
225
  parent: ComponentData | null;
218
226
  }) => Promise<Fields<FieldProps>> | Fields<FieldProps>;
@@ -221,7 +229,7 @@ UserField extends BaseField = {}> = {
221
229
  id: string;
222
230
  }>;
223
231
  lastData: DataShape | null;
224
- metadata: Metadata;
232
+ metadata: ComponentMetadata;
225
233
  trigger: ResolveDataTrigger;
226
234
  }) => Promise<WithPartialProps<DataShape, FieldProps>> | WithPartialProps<DataShape, FieldProps>;
227
235
  resolvePermissions?: (data: DataShape, params: {
@@ -232,9 +240,10 @@ UserField extends BaseField = {}> = {
232
240
  permissions: Partial<Permissions>;
233
241
  appState: AppState;
234
242
  lastData: DataShape | null;
243
+ parent: ComponentData | null;
235
244
  }) => Promise<Partial<Permissions>> | Partial<Permissions>;
236
- metadata?: Metadata;
237
- };
245
+ metadata?: ComponentMetadata;
246
+ } & ComponentConfigExtensions;
238
247
  type ComponentConfig<RenderPropsOrParams extends LeftOrExactRight<RenderPropsOrParams, DefaultComponentProps, ComponentConfigParams> = DefaultComponentProps, FieldProps extends DefaultComponentProps = RenderPropsOrParams extends {
239
248
  props: any;
240
249
  } ? 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 +274,16 @@ type ExtractConfigParams<UserConfig extends ConfigInternal> = UserConfig extends
265
274
  type: string;
266
275
  } ? UserField : Field;
267
276
  } : never;
277
+ type ConfigParams<Components extends DefaultComponents = DefaultComponents, RootProps extends DefaultComponentProps = any, CategoryNames extends string[] = string[], UserFields extends FieldsExtension = FieldsExtension> = {
278
+ components?: Components;
279
+ root?: RootProps;
280
+ categories?: CategoryNames;
281
+ fields?: AssertHasValue<UserFields>;
282
+ };
283
+ type ComponentConfigParams<Props extends DefaultComponentProps = DefaultComponentProps, UserFields extends FieldsExtension = never> = {
284
+ props: Props;
285
+ fields?: AssertHasValue<UserFields>;
286
+ };
268
287
 
269
288
  type BaseData<Props extends {
270
289
  [key: string]: any;
@@ -305,6 +324,12 @@ type Data<Components extends DefaultComponents = DefaultComponents, RootProps ex
305
324
  type Metadata = {
306
325
  [key: string]: any;
307
326
  };
327
+ interface PuckMetadata extends Metadata {
328
+ }
329
+ interface ComponentMetadata extends PuckMetadata {
330
+ }
331
+ interface FieldMetadata extends Metadata {
332
+ }
308
333
 
309
334
  type ItemWithId = {
310
335
  _arrayId: string;
@@ -378,21 +403,11 @@ type BuiltinTypes = Date | RegExp | Error | Function | symbol | null | undefined
378
403
  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
404
  [K in keyof T]: WithDeepSlots<T[K], SlotType>;
380
405
  } : 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
406
  type FieldsExtension = {
388
407
  [Type in string]: {
389
408
  type: Type;
390
409
  };
391
410
  };
392
- type ComponentConfigParams<Props extends DefaultComponentProps = DefaultComponentProps, UserFields extends FieldsExtension = never> = {
393
- props: Props;
394
- fields?: AssertHasValue<UserFields>;
395
- };
396
411
  type Exact<T, Target> = Record<Exclude<keyof T, keyof Target>, never>;
397
412
  type LeftOrExactRight<Union, Left, Right> = (Left & Union extends Right ? Exact<Union, Right> : Left) | (Right & Exact<Union, Right>);
398
413
  type AssertHasValue<T, True = T, False = never> = [keyof T] extends [
@@ -618,30 +633,4 @@ type PuckAction = {
618
633
  recordHistory?: boolean;
619
634
  } & (ReorderAction | InsertAction | MoveAction | ReplaceAction | ReplaceRootAction | RemoveAction | DuplicateAction | SetAction | SetDataAction | SetUiAction | RegisterZoneAction | UnregisterZoneAction);
620
635
 
621
- type MigrationOptions<UserConfig extends Config> = {
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 };
636
+ export { type RootDataWithoutProps as $, type AppState as A, overrideKeys as B, type Config as C, type Data as D, type OverrideKey as E, type Fields as F, type FieldRenderFunctions as G, type History as H, type IframeConfig as I, type ItemWithId as J, type ArrayState as K, type SlotComponent as L, type Metadata as M, type PuckComponent as N, type OnAction as O, type PrivateAppState as P, type ComponentConfigExtensions as Q, type RootData as R, type Slot as S, type RootConfig as T, type UserGenerics as U, type Viewports as V, type WithId as W, type ExtractConfigParams as X, type ConfigParams as Y, type ComponentConfigParams as Z, type BaseData as _, type PuckAction as a, type ComponentDataOptionalId as a0, type MappedItem as a1, type ComponentDataMap as a2, type PuckMetadata as a3, type ComponentMetadata as a4, type FieldMetadata as a5, type BaseField as a6, type TextField as a7, type NumberField as a8, type TextareaField as a9, type SelectField as aa, type RadioField as ab, type ArrayField as ac, type ObjectField as ad, type Adaptor as ae, type ExternalFieldWithAdaptor as af, type CacheOpts as ag, type ExternalField as ah, type CustomFieldRender as ai, type CustomField as aj, type SlotField as ak, type PuckContext as al, type DefaultRootRenderProps as am, type DefaultRootProps as an, type WithPuckProps as ao, type AsFieldProps as ap, type WithChildren as aq, type ExtractField as ar, 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 Field as o, type FieldProps as p, type DropZoneProps as q, type InitialHistory as r, type ItemSelector as s, type PluginInternal as t, type WithSlotProps as u, type Direction as v, type DragAxis as w, type Viewport as x, type FieldTransformFnParams as y, type FieldTransformFn as z };
@@ -1,4 +1,4 @@
1
- import { ReactElement, CSSProperties, ReactNode, JSX } from 'react';
1
+ import { ReactElement, ReactNode, CSSProperties, ElementType, JSX } from 'react';
2
2
 
3
3
  type ItemSelector = {
4
4
  index: number;
@@ -10,63 +10,63 @@ type FieldOption = {
10
10
  value: string | number | boolean | undefined | null | object;
11
11
  };
12
12
  type FieldOptions = Array<FieldOption> | ReadonlyArray<FieldOption>;
13
- type BaseField = {
13
+ interface BaseField {
14
14
  label?: string;
15
15
  labelIcon?: ReactElement;
16
- metadata?: Metadata;
16
+ metadata?: FieldMetadata;
17
17
  visible?: boolean;
18
- };
19
- type TextField = BaseField & {
18
+ }
19
+ interface TextField extends BaseField {
20
20
  type: "text";
21
21
  placeholder?: string;
22
22
  contentEditable?: boolean;
23
- };
24
- type NumberField = BaseField & {
23
+ }
24
+ interface NumberField extends BaseField {
25
25
  type: "number";
26
26
  placeholder?: string;
27
27
  min?: number;
28
28
  max?: number;
29
29
  step?: number;
30
- };
31
- type TextareaField = BaseField & {
30
+ }
31
+ interface TextareaField extends BaseField {
32
32
  type: "textarea";
33
33
  placeholder?: string;
34
34
  contentEditable?: boolean;
35
- };
36
- type SelectField = BaseField & {
35
+ }
36
+ interface SelectField extends BaseField {
37
37
  type: "select";
38
38
  options: FieldOptions;
39
- };
40
- type RadioField = BaseField & {
39
+ }
40
+ interface RadioField extends BaseField {
41
41
  type: "radio";
42
42
  options: FieldOptions;
43
- };
44
- type ArrayField<Props extends {
43
+ }
44
+ interface ArrayField<Props extends {
45
45
  [key: string]: any;
46
46
  }[] = {
47
47
  [key: string]: any;
48
- }[], UserField extends {} = {}> = BaseField & {
48
+ }[], UserField extends {} = {}> extends BaseField {
49
49
  type: "array";
50
50
  arrayFields: {
51
51
  [SubPropName in keyof Props[0]]: UserField extends {
52
52
  type: PropertyKey;
53
53
  } ? Field<Props[0][SubPropName], UserField> | UserField : Field<Props[0][SubPropName], UserField>;
54
54
  };
55
- defaultItemProps?: Props[0];
56
- getItemSummary?: (item: Props[0], index?: number) => string;
55
+ defaultItemProps?: Props[0] | ((index: number) => Props[0]);
56
+ getItemSummary?: (item: Props[0], index?: number) => ReactNode;
57
57
  max?: number;
58
58
  min?: number;
59
- };
60
- type ObjectField<Props extends any = {
59
+ }
60
+ interface ObjectField<Props extends any = {
61
61
  [key: string]: any;
62
- }, UserField extends {} = {}> = BaseField & {
62
+ }, UserField extends {} = {}> extends BaseField {
63
63
  type: "object";
64
64
  objectFields: {
65
65
  [SubPropName in keyof Props]: UserField extends {
66
66
  type: PropertyKey;
67
67
  } ? Field<Props[SubPropName]> | UserField : Field<Props[SubPropName]>;
68
68
  };
69
- };
69
+ }
70
70
  type Adaptor<AdaptorParams = {}, TableShape extends Record<string, any> = {}, PropShape = TableShape> = {
71
71
  name: string;
72
72
  fetchList: (adaptorParams?: AdaptorParams) => Promise<TableShape[] | null>;
@@ -80,12 +80,16 @@ type ExternalFieldWithAdaptor<Props extends any = {
80
80
  placeholder?: string;
81
81
  adaptor: Adaptor<any, any, Props>;
82
82
  adaptorParams?: object;
83
- getItemSummary: (item: NotUndefined<Props>, index?: number) => string;
83
+ getItemSummary: (item: NotUndefined<Props>, index?: number) => ReactNode;
84
+ };
85
+ type CacheOpts = {
86
+ enabled?: boolean;
84
87
  };
85
- type ExternalField<Props extends any = {
88
+ interface ExternalField<Props extends any = {
86
89
  [key: string]: any;
87
- }> = BaseField & {
90
+ }> extends BaseField {
88
91
  type: "external";
92
+ cache?: CacheOpts;
89
93
  placeholder?: string;
90
94
  fetchList: (params: {
91
95
  query: string;
@@ -93,7 +97,7 @@ type ExternalField<Props extends any = {
93
97
  }) => Promise<any[] | null>;
94
98
  mapProp?: (value: any) => Props;
95
99
  mapRow?: (value: any) => Record<string, string | number | ReactElement>;
96
- getItemSummary?: (item: NotUndefined<Props>, index?: number) => string;
100
+ getItemSummary?: (item: NotUndefined<Props>, index?: number) => ReactNode;
97
101
  showSearch?: boolean;
98
102
  renderFooter?: (props: {
99
103
  items: any[];
@@ -101,7 +105,7 @@ type ExternalField<Props extends any = {
101
105
  initialQuery?: string;
102
106
  filterFields?: Record<string, Field>;
103
107
  initialFilters?: Record<string, any>;
104
- };
108
+ }
105
109
  type CustomFieldRender<Value extends any> = (props: {
106
110
  field: CustomField<Value>;
107
111
  name: string;
@@ -110,16 +114,17 @@ type CustomFieldRender<Value extends any> = (props: {
110
114
  onChange: (value: Value) => void;
111
115
  readOnly?: boolean;
112
116
  }) => ReactElement;
113
- type CustomField<Value extends any> = BaseField & {
117
+ interface CustomField<Value extends any> extends BaseField {
114
118
  type: "custom";
115
119
  render: CustomFieldRender<Value>;
116
120
  contentEditable?: boolean;
117
- };
118
- type SlotField = BaseField & {
121
+ key?: string;
122
+ }
123
+ interface SlotField extends BaseField {
119
124
  type: "slot";
120
125
  allow?: string[];
121
126
  disallow?: string[];
122
- };
127
+ }
123
128
  type Field<ValueType = any, UserField extends {} = {}> = TextField | NumberField | TextareaField | SelectField | RadioField | ArrayField<ValueType extends {
124
129
  [key: string]: any;
125
130
  }[] ? ValueType : never, UserField> | ObjectField<ValueType, UserField> | ExternalField<ValueType> | ExternalFieldWithAdaptor<ValueType> | CustomField<ValueType> | SlotField;
@@ -141,13 +146,14 @@ type DropZoneProps = {
141
146
  allow?: string[];
142
147
  disallow?: string[];
143
148
  style?: CSSProperties;
144
- minEmptyHeight?: number;
149
+ minEmptyHeight?: CSSProperties["minHeight"] | number;
145
150
  className?: string;
146
151
  collisionAxis?: DragAxis;
152
+ as?: ElementType;
147
153
  };
148
154
 
149
155
  type PuckContext = {
150
- renderDropZone: React.FC<DropZoneProps>;
156
+ renderDropZone: (props: DropZoneProps) => React.ReactNode;
151
157
  metadata: Metadata;
152
158
  isEditing: boolean;
153
159
  dragRef: ((element: Element | null) => void) | null;
@@ -197,6 +203,8 @@ type ResolveDataTrigger = "insert" | "replace" | "load" | "force";
197
203
  type WithPartialProps<T, Props extends DefaultComponentProps> = Omit<T, "props"> & {
198
204
  props?: Partial<Props>;
199
205
  };
206
+ interface ComponentConfigExtensions {
207
+ }
200
208
  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
209
  UserField extends BaseField = {}> = {
202
210
  render: PuckComponent<RenderProps>;
@@ -212,7 +220,7 @@ UserField extends BaseField = {}> = {
212
220
  fields: Fields<FieldProps>;
213
221
  lastFields: Fields<FieldProps>;
214
222
  lastData: DataShape | null;
215
- metadata: Metadata;
223
+ metadata: ComponentMetadata;
216
224
  appState: AppState;
217
225
  parent: ComponentData | null;
218
226
  }) => Promise<Fields<FieldProps>> | Fields<FieldProps>;
@@ -221,7 +229,7 @@ UserField extends BaseField = {}> = {
221
229
  id: string;
222
230
  }>;
223
231
  lastData: DataShape | null;
224
- metadata: Metadata;
232
+ metadata: ComponentMetadata;
225
233
  trigger: ResolveDataTrigger;
226
234
  }) => Promise<WithPartialProps<DataShape, FieldProps>> | WithPartialProps<DataShape, FieldProps>;
227
235
  resolvePermissions?: (data: DataShape, params: {
@@ -232,9 +240,10 @@ UserField extends BaseField = {}> = {
232
240
  permissions: Partial<Permissions>;
233
241
  appState: AppState;
234
242
  lastData: DataShape | null;
243
+ parent: ComponentData | null;
235
244
  }) => Promise<Partial<Permissions>> | Partial<Permissions>;
236
- metadata?: Metadata;
237
- };
245
+ metadata?: ComponentMetadata;
246
+ } & ComponentConfigExtensions;
238
247
  type ComponentConfig<RenderPropsOrParams extends LeftOrExactRight<RenderPropsOrParams, DefaultComponentProps, ComponentConfigParams> = DefaultComponentProps, FieldProps extends DefaultComponentProps = RenderPropsOrParams extends {
239
248
  props: any;
240
249
  } ? 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 +274,16 @@ type ExtractConfigParams<UserConfig extends ConfigInternal> = UserConfig extends
265
274
  type: string;
266
275
  } ? UserField : Field;
267
276
  } : never;
277
+ type ConfigParams<Components extends DefaultComponents = DefaultComponents, RootProps extends DefaultComponentProps = any, CategoryNames extends string[] = string[], UserFields extends FieldsExtension = FieldsExtension> = {
278
+ components?: Components;
279
+ root?: RootProps;
280
+ categories?: CategoryNames;
281
+ fields?: AssertHasValue<UserFields>;
282
+ };
283
+ type ComponentConfigParams<Props extends DefaultComponentProps = DefaultComponentProps, UserFields extends FieldsExtension = never> = {
284
+ props: Props;
285
+ fields?: AssertHasValue<UserFields>;
286
+ };
268
287
 
269
288
  type BaseData<Props extends {
270
289
  [key: string]: any;
@@ -305,6 +324,12 @@ type Data<Components extends DefaultComponents = DefaultComponents, RootProps ex
305
324
  type Metadata = {
306
325
  [key: string]: any;
307
326
  };
327
+ interface PuckMetadata extends Metadata {
328
+ }
329
+ interface ComponentMetadata extends PuckMetadata {
330
+ }
331
+ interface FieldMetadata extends Metadata {
332
+ }
308
333
 
309
334
  type ItemWithId = {
310
335
  _arrayId: string;
@@ -378,21 +403,11 @@ type BuiltinTypes = Date | RegExp | Error | Function | symbol | null | undefined
378
403
  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
404
  [K in keyof T]: WithDeepSlots<T[K], SlotType>;
380
405
  } : 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
406
  type FieldsExtension = {
388
407
  [Type in string]: {
389
408
  type: Type;
390
409
  };
391
410
  };
392
- type ComponentConfigParams<Props extends DefaultComponentProps = DefaultComponentProps, UserFields extends FieldsExtension = never> = {
393
- props: Props;
394
- fields?: AssertHasValue<UserFields>;
395
- };
396
411
  type Exact<T, Target> = Record<Exclude<keyof T, keyof Target>, never>;
397
412
  type LeftOrExactRight<Union, Left, Right> = (Left & Union extends Right ? Exact<Union, Right> : Left) | (Right & Exact<Union, Right>);
398
413
  type AssertHasValue<T, True = T, False = never> = [keyof T] extends [
@@ -618,30 +633,4 @@ type PuckAction = {
618
633
  recordHistory?: boolean;
619
634
  } & (ReorderAction | InsertAction | MoveAction | ReplaceAction | ReplaceRootAction | RemoveAction | DuplicateAction | SetAction | SetDataAction | SetUiAction | RegisterZoneAction | UnregisterZoneAction);
620
635
 
621
- type MigrationOptions<UserConfig extends Config> = {
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 };
636
+ export { type RootDataWithoutProps as $, type AppState as A, overrideKeys as B, type Config as C, type Data as D, type OverrideKey as E, type Fields as F, type FieldRenderFunctions as G, type History as H, type IframeConfig as I, type ItemWithId as J, type ArrayState as K, type SlotComponent as L, type Metadata as M, type PuckComponent as N, type OnAction as O, type PrivateAppState as P, type ComponentConfigExtensions as Q, type RootData as R, type Slot as S, type RootConfig as T, type UserGenerics as U, type Viewports as V, type WithId as W, type ExtractConfigParams as X, type ConfigParams as Y, type ComponentConfigParams as Z, type BaseData as _, type PuckAction as a, type ComponentDataOptionalId as a0, type MappedItem as a1, type ComponentDataMap as a2, type PuckMetadata as a3, type ComponentMetadata as a4, type FieldMetadata as a5, type BaseField as a6, type TextField as a7, type NumberField as a8, type TextareaField as a9, type SelectField as aa, type RadioField as ab, type ArrayField as ac, type ObjectField as ad, type Adaptor as ae, type ExternalFieldWithAdaptor as af, type CacheOpts as ag, type ExternalField as ah, type CustomFieldRender as ai, type CustomField as aj, type SlotField as ak, type PuckContext as al, type DefaultRootRenderProps as am, type DefaultRootProps as an, type WithPuckProps as ao, type AsFieldProps as ap, type WithChildren as aq, type ExtractField as ar, 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 Field as o, type FieldProps as p, type DropZoneProps as q, type InitialHistory as r, type ItemSelector as s, type PluginInternal as t, type WithSlotProps as u, type Direction as v, type DragAxis as w, type Viewport as x, type FieldTransformFnParams as y, type FieldTransformFn as z };