@measured/puck 0.20.0-canary.f73c8fa0 → 0.20.0

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,20 +1,10 @@
1
- import { CSSProperties, ReactElement, ReactNode, JSX } from 'react';
1
+ import { ReactElement, CSSProperties, ReactNode, JSX } from 'react';
2
2
 
3
3
  type ItemSelector = {
4
4
  index: number;
5
5
  zone?: string;
6
6
  };
7
7
 
8
- type DropZoneProps = {
9
- zone: string;
10
- allow?: string[];
11
- disallow?: string[];
12
- style?: CSSProperties;
13
- minEmptyHeight?: number;
14
- className?: string;
15
- collisionAxis?: DragAxis;
16
- };
17
-
18
8
  type FieldOption = {
19
9
  label: string;
20
10
  value: string | number | boolean | undefined | null | object;
@@ -51,26 +41,30 @@ type RadioField = BaseField & {
51
41
  type: "radio";
52
42
  options: FieldOptions;
53
43
  };
54
- type ArrayField<Props extends any = {
44
+ type ArrayField<Props extends {
55
45
  [key: string]: any;
56
- }> = Props extends {
46
+ }[] = {
57
47
  [key: string]: any;
58
- } ? BaseField & {
48
+ }[], UserField extends {} = {}> = BaseField & {
59
49
  type: "array";
60
50
  arrayFields: {
61
- [SubPropName in keyof Props[0]]: Field<Props[0][SubPropName]>;
51
+ [SubPropName in keyof Props[0]]: UserField extends {
52
+ type: PropertyKey;
53
+ } ? Field<Props[0][SubPropName], UserField> | UserField : Field<Props[0][SubPropName], UserField>;
62
54
  };
63
55
  defaultItemProps?: Props[0];
64
56
  getItemSummary?: (item: Props[0], index?: number) => string;
65
57
  max?: number;
66
58
  min?: number;
67
- } : never;
59
+ };
68
60
  type ObjectField<Props extends any = {
69
61
  [key: string]: any;
70
- }> = BaseField & {
62
+ }, UserField extends {} = {}> = BaseField & {
71
63
  type: "object";
72
64
  objectFields: {
73
- [SubPropName in keyof Props]: Field<Props[SubPropName]>;
65
+ [SubPropName in keyof Props]: UserField extends {
66
+ type: PropertyKey;
67
+ } ? Field<Props[SubPropName]> | UserField : Field<Props[SubPropName]>;
74
68
  };
75
69
  };
76
70
  type Adaptor<AdaptorParams = {}, TableShape extends Record<string, any> = {}, PropShape = TableShape> = {
@@ -126,9 +120,13 @@ type SlotField = BaseField & {
126
120
  allow?: string[];
127
121
  disallow?: string[];
128
122
  };
129
- type Field<ValueType = any> = TextField | NumberField | TextareaField | SelectField | RadioField | ArrayField<ValueType> | ObjectField<ValueType> | ExternalField<ValueType> | ExternalFieldWithAdaptor<ValueType> | CustomField<ValueType> | SlotField;
130
- type Fields<ComponentProps extends DefaultComponentProps = DefaultComponentProps> = {
131
- [PropName in keyof Omit<ComponentProps, "editMode">]: Field<ComponentProps[PropName]>;
123
+ type Field<ValueType = any, UserField extends {} = {}> = TextField | NumberField | TextareaField | SelectField | RadioField | ArrayField<ValueType extends {
124
+ [key: string]: any;
125
+ }[] ? ValueType : {}[], UserField> | ObjectField<ValueType, UserField> | ExternalField<ValueType> | ExternalFieldWithAdaptor<ValueType> | CustomField<ValueType> | SlotField;
126
+ type Fields<ComponentProps extends DefaultComponentProps = DefaultComponentProps, UserField extends {} = {}> = {
127
+ [PropName in keyof Omit<ComponentProps, "editMode">]: UserField extends {
128
+ type: PropertyKey;
129
+ } ? Field<ComponentProps[PropName], UserField> | UserField : Field<ComponentProps[PropName]>;
132
130
  };
133
131
  type FieldProps<F = Field<any>, ValueType = any> = {
134
132
  field: F;
@@ -138,6 +136,59 @@ type FieldProps<F = Field<any>, ValueType = any> = {
138
136
  readOnly?: boolean;
139
137
  };
140
138
 
139
+ type DropZoneProps = {
140
+ zone: string;
141
+ allow?: string[];
142
+ disallow?: string[];
143
+ style?: CSSProperties;
144
+ minEmptyHeight?: number;
145
+ className?: string;
146
+ collisionAxis?: DragAxis;
147
+ };
148
+
149
+ type PuckContext = {
150
+ renderDropZone: React.FC<DropZoneProps>;
151
+ metadata: Metadata;
152
+ isEditing: boolean;
153
+ dragRef: ((element: Element | null) => void) | null;
154
+ };
155
+ type DefaultRootFieldProps = {
156
+ title?: string;
157
+ };
158
+ type DefaultRootRenderProps<Props extends DefaultComponentProps = DefaultRootFieldProps> = WithPuckProps<WithChildren<Props>>;
159
+ type DefaultRootProps = DefaultRootRenderProps;
160
+ type DefaultComponentProps = {
161
+ [key: string]: any;
162
+ };
163
+
164
+ type WithId<Props> = Props & {
165
+ id: string;
166
+ };
167
+ type WithPuckProps<Props> = Props & {
168
+ puck: PuckContext;
169
+ editMode?: boolean;
170
+ };
171
+ type AsFieldProps<Props> = Omit<Props, "children" | "puck" | "editMode">;
172
+ type WithChildren<Props> = Props & {
173
+ children: ReactNode;
174
+ };
175
+ type UserGenerics<UserConfig extends Config = Config, UserParams extends ExtractConfigParams<UserConfig> = ExtractConfigParams<UserConfig>, UserData extends Data<UserParams["props"], UserParams["rootProps"]> | Data = Data<UserParams["props"], UserParams["rootProps"]>, UserAppState extends PrivateAppState<UserData> = PrivateAppState<UserData>, UserPublicAppState extends AppState<UserData> = AppState<UserData>, UserComponentData extends ComponentData = UserData["content"][0]> = {
176
+ UserConfig: UserConfig;
177
+ UserParams: UserParams;
178
+ UserProps: UserParams["props"];
179
+ UserRootProps: UserParams["rootProps"] & DefaultRootFieldProps;
180
+ UserData: UserData;
181
+ UserAppState: UserAppState;
182
+ UserPublicAppState: UserPublicAppState;
183
+ UserComponentData: UserComponentData;
184
+ UserField: UserParams["field"];
185
+ };
186
+ type ExtractField<UserField extends {
187
+ type: PropertyKey;
188
+ }, T extends UserField["type"]> = Extract<UserField, {
189
+ type: T;
190
+ }>;
191
+
141
192
  type SlotComponent = (props?: Omit<DropZoneProps, "zone">) => ReactNode;
142
193
  type PuckComponent<Props> = (props: WithId<WithPuckProps<{
143
194
  [K in keyof Props]: WithDeepSlots<Props[K], SlotComponent>;
@@ -146,11 +197,12 @@ type ResolveDataTrigger = "insert" | "replace" | "load" | "force";
146
197
  type WithPartialProps<T, Props extends DefaultComponentProps> = Omit<T, "props"> & {
147
198
  props?: Partial<Props>;
148
199
  };
149
- type ComponentConfig<RenderProps extends DefaultComponentProps = DefaultComponentProps, FieldProps extends DefaultComponentProps = RenderProps, DataShape = Omit<ComponentData<FieldProps>, "type">> = {
200
+ 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
+ UserField extends BaseField = {}> = {
150
202
  render: PuckComponent<RenderProps>;
151
203
  label?: string;
152
204
  defaultProps?: FieldProps;
153
- fields?: Fields<FieldProps>;
205
+ fields?: Fields<FieldProps, UserField>;
154
206
  permissions?: Partial<Permissions>;
155
207
  inline?: boolean;
156
208
  resolveFields?: (data: DataShape, params: {
@@ -182,64 +234,36 @@ type ComponentConfig<RenderProps extends DefaultComponentProps = DefaultComponen
182
234
  }) => Promise<Partial<Permissions>> | Partial<Permissions>;
183
235
  metadata?: Metadata;
184
236
  };
185
- type RootConfig<RootProps extends DefaultComponentProps = any> = Partial<ComponentConfig<WithChildren<RootProps>, AsFieldProps<RootProps>, RootData<AsFieldProps<RootProps>>>>;
237
+ type ComponentConfig<RenderPropsOrParams extends LeftOrExactRight<RenderPropsOrParams, DefaultComponentProps, ComponentConfigParams> = DefaultComponentProps, FieldProps extends DefaultComponentProps = RenderPropsOrParams extends {
238
+ props: any;
239
+ } ? 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>;
240
+ type RootConfigInternal<RootProps extends DefaultComponentProps = DefaultComponentProps, UserField extends BaseField = {}> = Partial<ComponentConfigInternal<WithChildren<RootProps>, AsFieldProps<RootProps>, RootData<AsFieldProps<RootProps>>, UserField>>;
241
+ type RootConfig<RootPropsOrParams extends LeftOrExactRight<RootPropsOrParams, DefaultComponentProps, ComponentConfigParams> = DefaultComponentProps> = RootPropsOrParams extends ComponentConfigParams<infer Props, never> ? Partial<RootConfigInternal<WithChildren<Props>, {}>> : RootPropsOrParams extends ComponentConfigParams<infer Props, infer UserFields> ? Partial<RootConfigInternal<WithChildren<Props>, UserFields[keyof UserFields] & BaseField>> : Partial<RootConfigInternal<WithChildren<RootPropsOrParams>>>;
186
242
  type Category<ComponentName> = {
187
243
  components?: ComponentName[];
188
244
  title?: string;
189
245
  visible?: boolean;
190
246
  defaultExpanded?: boolean;
191
247
  };
192
- type Config<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends DefaultComponentProps = any, CategoryName extends string = string> = {
248
+ type ConfigInternal<Props extends DefaultComponents = DefaultComponents, RootProps extends DefaultComponentProps = DefaultComponentProps, CategoryName extends string = string, UserField extends {} = {}> = {
193
249
  categories?: Record<CategoryName, Category<keyof Props>> & {
194
250
  other?: Category<keyof Props>;
195
251
  };
196
252
  components: {
197
- [ComponentName in keyof Props]: Omit<ComponentConfig<Props[ComponentName], Props[ComponentName]>, "type">;
253
+ [ComponentName in keyof Props]: Omit<ComponentConfigInternal<Props[ComponentName], Props[ComponentName], Omit<ComponentData<Props[ComponentName]>, "type">, UserField>, "type">;
198
254
  };
199
- root?: RootConfig<RootProps>;
200
- };
201
-
202
- type WithId<Props> = Props & {
203
- id: string;
204
- };
205
- type WithPuckProps<Props> = Props & {
206
- puck: PuckContext;
207
- editMode?: boolean;
208
- };
209
- type AsFieldProps<Props> = Omit<Props, "children" | "puck" | "editMode">;
210
- type WithChildren<Props> = Props & {
211
- children: ReactNode;
212
- };
213
- type ExtractPropsFromConfig<UserConfig> = UserConfig extends Config<infer P, any, any> ? P : never;
214
- type ExtractRootPropsFromConfig<UserConfig> = UserConfig extends Config<any, infer P, any> ? P : never;
215
- type UserGenerics<UserConfig extends Config = Config, UserProps extends ExtractPropsFromConfig<UserConfig> = ExtractPropsFromConfig<UserConfig>, UserRootProps extends ExtractRootPropsFromConfig<UserConfig> = ExtractRootPropsFromConfig<UserConfig>, UserData extends Data<UserProps, UserRootProps> | Data = Data<UserProps, UserRootProps>, UserAppState extends PrivateAppState<UserData> = PrivateAppState<UserData>, UserPublicAppState extends AppState<UserData> = AppState<UserData>, UserComponentData extends ComponentData = UserData["content"][0]> = {
216
- UserConfig: UserConfig;
217
- UserProps: UserProps;
218
- UserRootProps: UserRootProps;
219
- UserData: UserData;
220
- UserAppState: UserAppState;
221
- UserPublicAppState: UserPublicAppState;
222
- UserComponentData: UserComponentData;
223
- };
224
- type ExtractField<T extends Field["type"]> = Extract<Field, {
225
- type: T;
226
- }>;
227
-
228
- type PuckContext = {
229
- renderDropZone: React.FC<DropZoneProps>;
230
- metadata: Metadata;
231
- isEditing: boolean;
232
- dragRef: ((element: Element | null) => void) | null;
233
- };
234
- type DefaultRootFieldProps = {
235
- [key: string]: any;
236
- title?: string;
237
- };
238
- type DefaultRootRenderProps<Props extends DefaultComponentProps = DefaultRootFieldProps> = WithPuckProps<WithChildren<Props>>;
239
- type DefaultRootProps = DefaultRootRenderProps;
240
- type DefaultComponentProps = {
241
- [key: string]: any;
242
- };
255
+ root?: RootConfigInternal<RootProps, UserField>;
256
+ };
257
+ type DefaultComponents = Record<string, any>;
258
+ type Config<PropsOrParams extends LeftOrExactRight<PropsOrParams, DefaultComponents, ConfigParams> = DefaultComponents | ConfigParams, RootProps extends DefaultComponentProps = DefaultComponentProps, CategoryName extends string = string> = PropsOrParams extends ConfigParams<infer ParamComponents, infer ParamRoot, infer ParamCategoryName, never> ? ConfigInternal<ParamComponents, ParamRoot, ParamCategoryName[number]> : PropsOrParams extends ConfigParams<infer ParamComponents, infer ParamRoot, infer ParamCategoryName, infer ParamFields> ? ConfigInternal<ParamComponents, ParamRoot, ParamCategoryName[number], ParamFields[keyof ParamFields] & BaseField> : PropsOrParams extends ConfigParams<infer ParamComponents, infer ParamRoot, infer ParamCategoryName, any> ? ConfigInternal<ParamComponents, ParamRoot, ParamCategoryName[number], {}> : ConfigInternal<PropsOrParams, RootProps, CategoryName>;
259
+ type ExtractConfigParams<UserConfig extends ConfigInternal> = UserConfig extends ConfigInternal<infer PropsOrParams, infer RootProps, infer CategoryName, infer UserField> ? {
260
+ props: PropsOrParams;
261
+ rootProps: RootProps & DefaultRootFieldProps;
262
+ categoryNames: CategoryName;
263
+ field: UserField extends {
264
+ type: string;
265
+ } ? UserField : Field;
266
+ } : never;
243
267
 
244
268
  type BaseData<Props extends {
245
269
  [key: string]: any;
@@ -253,9 +277,9 @@ type RootDataWithProps<Props extends DefaultComponentProps = DefaultRootFieldPro
253
277
  };
254
278
  type RootDataWithoutProps<Props extends DefaultComponentProps = DefaultRootFieldProps> = Props;
255
279
  type RootData<Props extends DefaultComponentProps = DefaultRootFieldProps> = Partial<RootDataWithProps<AsFieldProps<Props>>> & Partial<RootDataWithoutProps<Props>>;
256
- type ComponentData<Props extends DefaultComponentProps = DefaultComponentProps, Name = string, AllProps extends Record<string, DefaultComponentProps> = Record<string, DefaultComponentProps>> = {
280
+ type ComponentData<Props extends DefaultComponentProps = DefaultComponentProps, Name = string, Components extends Record<string, DefaultComponentProps> = Record<string, DefaultComponentProps>> = {
257
281
  type: Name;
258
- props: WithDeepSlots<WithId<Props>, Content<AllProps>>;
282
+ props: WithDeepSlots<WithId<Props>, Content<Components>>;
259
283
  } & BaseData<Props>;
260
284
  type ComponentDataOptionalId<Props extends DefaultComponentProps = DefaultComponentProps, Name = string> = {
261
285
  type: Name;
@@ -264,18 +288,18 @@ type ComponentDataOptionalId<Props extends DefaultComponentProps = DefaultCompon
264
288
  };
265
289
  } & BaseData<Props>;
266
290
  type MappedItem = ComponentData;
267
- type ComponentDataMap<AllProps extends DefaultAllProps = DefaultAllProps> = {
268
- [K in keyof AllProps]: ComponentData<AllProps[K], K extends string ? K : never, AllProps>;
269
- }[keyof AllProps];
291
+ type ComponentDataMap<Components extends DefaultComponents = DefaultComponents> = {
292
+ [K in keyof Components]: ComponentData<Components[K], K extends string ? K : never, Components>;
293
+ }[keyof Components];
270
294
  type Content<PropsMap extends {
271
295
  [key: string]: DefaultComponentProps;
272
296
  } = {
273
297
  [key: string]: DefaultComponentProps;
274
298
  }> = ComponentDataMap<PropsMap>[];
275
- type Data<AllProps extends DefaultAllProps = DefaultAllProps, RootProps extends DefaultComponentProps = DefaultRootFieldProps> = {
276
- root: WithDeepSlots<RootData<RootProps>, Content<AllProps>>;
277
- content: Content<AllProps>;
278
- zones?: Record<string, Content<AllProps>>;
299
+ type Data<Components extends DefaultComponents = DefaultComponents, RootProps extends DefaultComponentProps = DefaultRootFieldProps> = {
300
+ root: WithDeepSlots<RootData<RootProps>, Content<Components>>;
301
+ content: Content<Components>;
302
+ zones?: Record<string, Content<Components>>;
279
303
  };
280
304
  type Metadata = {
281
305
  [key: string]: any;
@@ -284,7 +308,6 @@ type Metadata = {
284
308
  type ItemWithId = {
285
309
  _arrayId: string;
286
310
  _originalIndex: number;
287
- _currentIndex: number;
288
311
  };
289
312
  type ArrayState = {
290
313
  items: ItemWithId[];
@@ -316,9 +339,6 @@ type UiState = {
316
339
  field: {
317
340
  focus?: string | null;
318
341
  };
319
- plugin: {
320
- current: string | null;
321
- };
322
342
  };
323
343
  type AppState<UserData extends Data = Data> = {
324
344
  data: UserData;
@@ -345,7 +365,6 @@ type PrivateAppState<UserData extends Data = Data> = AppState<UserData> & {
345
365
  zones: ZoneIndex;
346
366
  };
347
367
  };
348
- type DefaultAllProps = Record<string, DefaultComponentProps>;
349
368
  type BuiltinTypes = Date | RegExp | Error | Function | symbol | null | undefined;
350
369
  /**
351
370
  * Recursively walk T and replace Slots with SlotComponents
@@ -353,11 +372,26 @@ type BuiltinTypes = Date | RegExp | Error | Function | symbol | null | undefined
353
372
  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 ? {
354
373
  [K in keyof T]: WithDeepSlots<T[K], SlotType>;
355
374
  } : T;
356
- type RenderFunc<Props extends {
357
- [key: string]: any;
358
- } = {
359
- children: ReactNode;
360
- }> = (props: Props) => ReactElement;
375
+ type ConfigParams<Components extends DefaultComponents = DefaultComponents, RootProps extends DefaultComponentProps = DefaultComponentProps, CategoryNames extends string[] = string[], UserFields extends FieldsExtension = FieldsExtension> = {
376
+ components?: Components;
377
+ root?: RootProps;
378
+ categories?: CategoryNames;
379
+ fields?: AssertHasValue<UserFields>;
380
+ };
381
+ type FieldsExtension = {
382
+ [Type in string]: {
383
+ type: Type;
384
+ };
385
+ };
386
+ type ComponentConfigParams<Props extends DefaultComponentProps = DefaultComponentProps, UserFields extends FieldsExtension = never> = {
387
+ props: Props;
388
+ fields?: AssertHasValue<UserFields>;
389
+ };
390
+ type Exact<T, Target> = Record<Exclude<keyof T, keyof Target>, never>;
391
+ type LeftOrExactRight<Union, Left, Right> = (Left & Union extends Right ? Exact<Union, Right> : Left) | (Right & Exact<Union, Right>);
392
+ type AssertHasValue<T, True = T, False = never> = [keyof T] extends [
393
+ never
394
+ ] ? False : True;
361
395
 
362
396
  type MapFnParams<ThisField = Field> = {
363
397
  value: any;
@@ -371,18 +405,28 @@ type FieldTransformFnParams<T> = Omit<MapFnParams<T>, "parentId"> & {
371
405
  isReadOnly: boolean;
372
406
  componentId: string;
373
407
  };
374
- type FieldTransformFn<T = any> = (params: FieldTransformFnParams<T>) => any;
375
- type FieldTransforms = Partial<{
376
- [FieldType in Field["type"]]: FieldTransformFn<ExtractField<FieldType>>;
408
+ type FieldTransformFn<T> = (params: FieldTransformFnParams<T>) => any;
409
+ type FieldTransforms<UserConfig extends Config = Config<{
410
+ fields: {};
411
+ }>, // Setting fields: {} helps TS choose default field types
412
+ G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>, UserField extends {
413
+ type: string;
414
+ } = Field | G["UserField"]> = Partial<{
415
+ [Type in UserField["type"]]: FieldTransformFn<ExtractField<UserField, Type>>;
377
416
  }>;
378
417
 
418
+ type RenderFunc<Props extends {
419
+ [key: string]: any;
420
+ } = {
421
+ children: ReactNode;
422
+ }> = (props: Props) => ReactElement;
379
423
  declare const overrideKeys: readonly ["header", "headerActions", "fields", "fieldLabel", "drawer", "drawerItem", "componentOverlay", "outline", "puck", "preview"];
380
424
  type OverrideKey = (typeof overrideKeys)[number];
381
425
  type OverridesGeneric<Shape extends {
382
426
  [key in OverrideKey]: any;
383
427
  }> = Shape;
384
- type Overrides = OverridesGeneric<{
385
- fieldTypes: Partial<FieldRenderFunctions>;
428
+ type Overrides<UserConfig extends Config = Config> = OverridesGeneric<{
429
+ fieldTypes: Partial<FieldRenderFunctions<UserConfig>>;
386
430
  header: RenderFunc<{
387
431
  actions: ReactNode;
388
432
  children: ReactNode;
@@ -433,19 +477,14 @@ type Overrides = OverridesGeneric<{
433
477
  }>;
434
478
  puck: RenderFunc;
435
479
  }>;
436
- type FieldRenderFunctions = Omit<{
437
- [Type in Field["type"]]: React.FunctionComponent<FieldProps<Extract<Field, {
438
- type: Type;
439
- }>, any> & {
480
+ type FieldRenderFunctions<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>, UserField extends {
481
+ type: string;
482
+ } = Field | G["UserField"]> = Omit<{
483
+ [Type in UserField["type"]]: React.FunctionComponent<FieldProps<ExtractField<UserField, Type>, any> & {
440
484
  children: ReactNode;
441
485
  name: string;
442
486
  }>;
443
- }, "custom"> & {
444
- [key: string]: React.FunctionComponent<FieldProps<any> & {
445
- children: ReactNode;
446
- name: string;
447
- }>;
448
- };
487
+ }, "custom">;
449
488
 
450
489
  type Direction = "left" | "right" | "up" | "down" | null;
451
490
  type DragAxis = "dynamic" | "y" | "x";
@@ -471,13 +510,9 @@ type IframeConfig = {
471
510
  waitForStyles?: boolean;
472
511
  };
473
512
  type OnAction<UserData extends Data = Data> = (action: PuckAction, appState: AppState<UserData>, prevAppState: AppState<UserData>) => void;
474
- type Plugin = {
475
- name?: string;
476
- label?: string;
477
- icon?: ReactNode;
478
- render?: () => ReactElement;
479
- overrides?: Partial<Overrides>;
480
- fieldTransforms?: FieldTransforms;
513
+ type Plugin<UserConfig extends Config = Config> = {
514
+ overrides?: Partial<Overrides<UserConfig>>;
515
+ fieldTransforms?: FieldTransforms<UserConfig>;
481
516
  };
482
517
  type History<D = any> = {
483
518
  state: D;
@@ -501,7 +536,7 @@ type Slot<Props extends {
501
536
  }> = {
502
537
  [K in keyof Props]: ComponentDataOptionalId<Props[K], K extends string ? K : never>;
503
538
  }[keyof Props][];
504
- type WithSlotProps<Target extends Record<string, any>, AllProps extends DefaultAllProps = DefaultAllProps, SlotType extends Content<AllProps> = Content<AllProps>> = WithDeepSlots<Target, SlotType>;
539
+ type WithSlotProps<Target extends Record<string, any>, Components extends DefaultComponents = DefaultComponents, SlotType extends Content<Components> = Content<Components>> = WithDeepSlots<Target, SlotType>;
505
540
 
506
541
  type InsertAction = {
507
542
  type: "insert";
@@ -576,18 +611,18 @@ type MigrationOptions<UserConfig extends Config> = {
576
611
  };
577
612
  declare function migrate<UserConfig extends Config = Config>(data: Data, config?: UserConfig, migrationOptions?: MigrationOptions<UserConfig>): Data;
578
613
 
579
- type PropTransform<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends DefaultComponentProps = DefaultRootFieldProps> = Partial<{
580
- [ComponentName in keyof Props]: (props: Props[ComponentName] & {
614
+ type PropTransform<Components extends DefaultComponents = DefaultComponents, RootProps extends DefaultComponentProps = DefaultRootFieldProps> = Partial<{
615
+ [ComponentName in keyof Components]: (props: Components[ComponentName] & {
581
616
  [key: string]: any;
582
- }) => Props[ComponentName];
617
+ }) => Components[ComponentName];
583
618
  } & {
584
619
  root: (props: RootProps & {
585
620
  [key: string]: any;
586
621
  }) => RootProps;
587
622
  }>;
588
- declare function transformProps<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends DefaultComponentProps = DefaultRootFieldProps>(data: Partial<Data>, propTransforms: PropTransform<Props, RootProps>, config?: Config): Data;
623
+ declare function transformProps<Components extends DefaultComponents = DefaultComponents, RootProps extends DefaultComponentProps = DefaultRootFieldProps>(data: Partial<Data>, propTransforms: PropTransform<Components, RootProps>, config?: Config): Data;
589
624
 
590
- declare function resolveAllData<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends Record<string, any> = DefaultRootFieldProps>(data: Partial<Data>, config: Config, metadata?: Metadata, onResolveStart?: (item: ComponentData) => void, onResolveEnd?: (item: ComponentData) => void): Promise<Data<Props, RootProps>>;
625
+ 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>>;
591
626
 
592
627
  type WalkTreeOptions = {
593
628
  parentId: string;
@@ -595,4 +630,4 @@ type WalkTreeOptions = {
595
630
  };
596
631
  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;
597
632
 
598
- export { type NumberField 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 BaseData as K, type RootDataWithoutProps as L, type Metadata as M, type RootData as N, type Overrides as O, type Permissions as P, type ComponentDataOptionalId as Q, type RootDataWithProps as R, type Slot as S, type MappedItem as T, type UserGenerics as U, type Viewports as V, type WithSlotProps as W, type ComponentDataMap as X, type Content as Y, type BaseField as Z, type TextField as _, type ComponentData as a, type TextareaField as a0, type SelectField as a1, type RadioField as a2, type ArrayField as a3, type ObjectField as a4, type Adaptor as a5, type ExternalFieldWithAdaptor as a6, type ExternalField as a7, type CustomFieldRender as a8, type CustomField as a9, type SlotField as aa, type PuckContext as ab, type DefaultRootFieldProps as ac, type DefaultRootRenderProps as ad, type DefaultRootProps as ae, type DefaultComponentProps as af, type WithId as ag, type WithPuckProps as ah, type AsFieldProps as ai, type WithChildren as aj, type ExtractPropsFromConfig as ak, type ExtractRootPropsFromConfig as al, type ExtractField as am, 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 };
633
+ 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 ExternalField as a9, type CustomFieldRender as aa, type CustomField as ab, type SlotField as ac, type PuckContext as ad, type DefaultRootFieldProps as ae, type DefaultRootRenderProps as af, type DefaultRootProps as ag, type DefaultComponentProps as ah, type WithId as ai, type WithPuckProps as aj, type AsFieldProps as ak, type WithChildren as al, type ExtractField as am, 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 };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@measured/puck",
3
- "version": "0.20.0-canary.f73c8fa0",
3
+ "version": "0.20.0",
4
4
  "author": "Chris Villa <chris@puckeditor.com>",
5
5
  "repository": "measuredco/puck",
6
6
  "bugs": "https://github.com/measuredco/puck/issues",