@measured/puck-plugin-heading-analyzer 0.20.0-canary.6760121f → 0.20.0-canary.6a211610

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/index.d.mts +42 -3
  2. package/dist/index.d.ts +42 -3
  3. package/dist/index.js +234 -345
  4. package/dist/index.mjs +213 -324
  5. package/package.json +2 -2
package/dist/index.d.mts CHANGED
@@ -7,7 +7,7 @@ type ItemSelector = {
7
7
 
8
8
  type FieldOption = {
9
9
  label: string;
10
- value: string | number | boolean;
10
+ value: string | number | boolean | undefined | null | object;
11
11
  };
12
12
  type FieldOptions = Array<FieldOption> | ReadonlyArray<FieldOption>;
13
13
  type BaseField = {
@@ -19,6 +19,7 @@ type BaseField = {
19
19
  type TextField = BaseField & {
20
20
  type: "text";
21
21
  placeholder?: string;
22
+ contentEditable?: boolean;
22
23
  };
23
24
  type NumberField = BaseField & {
24
25
  type: "number";
@@ -30,6 +31,7 @@ type NumberField = BaseField & {
30
31
  type TextareaField = BaseField & {
31
32
  type: "textarea";
32
33
  placeholder?: string;
34
+ contentEditable?: boolean;
33
35
  };
34
36
  type SelectField = BaseField & {
35
37
  type: "select";
@@ -107,6 +109,7 @@ type CustomFieldRender<Value extends any> = (props: {
107
109
  type CustomField<Value extends any> = BaseField & {
108
110
  type: "custom";
109
111
  render: CustomFieldRender<Value>;
112
+ contentEditable?: boolean;
110
113
  };
111
114
  type SlotField = BaseField & {
112
115
  type: "slot";
@@ -122,6 +125,10 @@ type FieldProps<F = Field<any>, ValueType = any> = {
122
125
  readOnly?: boolean;
123
126
  };
124
127
 
128
+ type ExtractField<T extends Field["type"]> = Extract<Field, {
129
+ type: T;
130
+ }>;
131
+
125
132
  type Metadata = {
126
133
  [key: string]: any;
127
134
  };
@@ -137,6 +144,8 @@ type ArrayState = {
137
144
  type UiState = {
138
145
  leftSideBarVisible: boolean;
139
146
  rightSideBarVisible: boolean;
147
+ leftSideBarWidth?: number | null;
148
+ rightSideBarWidth?: number | null;
140
149
  itemSelector: ItemSelector | null;
141
150
  arrayState: Record<string, ArrayState | undefined>;
142
151
  previewMode: "interactive" | "edit";
@@ -160,12 +169,29 @@ type UiState = {
160
169
  };
161
170
  };
162
171
 
172
+ type MapFnParams<ThisField = Field> = {
173
+ value: any;
174
+ parentId: string;
175
+ propName: string;
176
+ field: ThisField;
177
+ propPath: string;
178
+ };
179
+
180
+ type FieldTransformFnParams<T> = Omit<MapFnParams<T>, "parentId"> & {
181
+ isReadOnly: boolean;
182
+ componentId: string;
183
+ };
184
+ type FieldTransformFn<T = any> = (params: FieldTransformFnParams<T>) => any;
185
+ type FieldTransforms = Partial<{
186
+ [FieldType in Field["type"]]: FieldTransformFn<ExtractField<FieldType>>;
187
+ }>;
188
+
163
189
  type RenderFunc<Props extends {
164
190
  [key: string]: any;
165
191
  } = {
166
192
  children: ReactNode;
167
193
  }> = (props: Props) => ReactElement;
168
- declare const overrideKeys: readonly ["header", "headerActions", "fields", "fieldLabel", "components", "componentItem", "outline", "puck", "preview"];
194
+ declare const overrideKeys: readonly ["header", "headerActions", "fields", "fieldLabel", "drawer", "drawerItem", "componentOverlay", "outline", "puck", "preview"];
169
195
  type OverrideKey = (typeof overrideKeys)[number];
170
196
  type OverridesGeneric<Shape extends {
171
197
  [key in OverrideKey]: any;
@@ -203,11 +229,23 @@ type Overrides = OverridesGeneric<{
203
229
  children: ReactNode;
204
230
  name: string;
205
231
  }>;
232
+ drawer: RenderFunc;
233
+ drawerItem: RenderFunc<{
234
+ children: ReactNode;
235
+ name: string;
236
+ }>;
206
237
  iframe: RenderFunc<{
207
238
  children: ReactNode;
208
239
  document?: Document;
209
240
  }>;
210
241
  outline: RenderFunc;
242
+ componentOverlay: RenderFunc<{
243
+ children: ReactNode;
244
+ hover: boolean;
245
+ isSelected: boolean;
246
+ componentId: string;
247
+ componentType: string;
248
+ }>;
211
249
  puck: RenderFunc;
212
250
  }>;
213
251
  type FieldRenderFunctions = Omit<{
@@ -233,7 +271,8 @@ type Viewport = {
233
271
  };
234
272
 
235
273
  type Plugin = {
236
- overrides: Partial<Overrides>;
274
+ overrides?: Partial<Overrides>;
275
+ fieldTransforms?: FieldTransforms;
237
276
  };
238
277
 
239
278
  declare const headingAnalyzer: Plugin;
package/dist/index.d.ts CHANGED
@@ -7,7 +7,7 @@ type ItemSelector = {
7
7
 
8
8
  type FieldOption = {
9
9
  label: string;
10
- value: string | number | boolean;
10
+ value: string | number | boolean | undefined | null | object;
11
11
  };
12
12
  type FieldOptions = Array<FieldOption> | ReadonlyArray<FieldOption>;
13
13
  type BaseField = {
@@ -19,6 +19,7 @@ type BaseField = {
19
19
  type TextField = BaseField & {
20
20
  type: "text";
21
21
  placeholder?: string;
22
+ contentEditable?: boolean;
22
23
  };
23
24
  type NumberField = BaseField & {
24
25
  type: "number";
@@ -30,6 +31,7 @@ type NumberField = BaseField & {
30
31
  type TextareaField = BaseField & {
31
32
  type: "textarea";
32
33
  placeholder?: string;
34
+ contentEditable?: boolean;
33
35
  };
34
36
  type SelectField = BaseField & {
35
37
  type: "select";
@@ -107,6 +109,7 @@ type CustomFieldRender<Value extends any> = (props: {
107
109
  type CustomField<Value extends any> = BaseField & {
108
110
  type: "custom";
109
111
  render: CustomFieldRender<Value>;
112
+ contentEditable?: boolean;
110
113
  };
111
114
  type SlotField = BaseField & {
112
115
  type: "slot";
@@ -122,6 +125,10 @@ type FieldProps<F = Field<any>, ValueType = any> = {
122
125
  readOnly?: boolean;
123
126
  };
124
127
 
128
+ type ExtractField<T extends Field["type"]> = Extract<Field, {
129
+ type: T;
130
+ }>;
131
+
125
132
  type Metadata = {
126
133
  [key: string]: any;
127
134
  };
@@ -137,6 +144,8 @@ type ArrayState = {
137
144
  type UiState = {
138
145
  leftSideBarVisible: boolean;
139
146
  rightSideBarVisible: boolean;
147
+ leftSideBarWidth?: number | null;
148
+ rightSideBarWidth?: number | null;
140
149
  itemSelector: ItemSelector | null;
141
150
  arrayState: Record<string, ArrayState | undefined>;
142
151
  previewMode: "interactive" | "edit";
@@ -160,12 +169,29 @@ type UiState = {
160
169
  };
161
170
  };
162
171
 
172
+ type MapFnParams<ThisField = Field> = {
173
+ value: any;
174
+ parentId: string;
175
+ propName: string;
176
+ field: ThisField;
177
+ propPath: string;
178
+ };
179
+
180
+ type FieldTransformFnParams<T> = Omit<MapFnParams<T>, "parentId"> & {
181
+ isReadOnly: boolean;
182
+ componentId: string;
183
+ };
184
+ type FieldTransformFn<T = any> = (params: FieldTransformFnParams<T>) => any;
185
+ type FieldTransforms = Partial<{
186
+ [FieldType in Field["type"]]: FieldTransformFn<ExtractField<FieldType>>;
187
+ }>;
188
+
163
189
  type RenderFunc<Props extends {
164
190
  [key: string]: any;
165
191
  } = {
166
192
  children: ReactNode;
167
193
  }> = (props: Props) => ReactElement;
168
- declare const overrideKeys: readonly ["header", "headerActions", "fields", "fieldLabel", "components", "componentItem", "outline", "puck", "preview"];
194
+ declare const overrideKeys: readonly ["header", "headerActions", "fields", "fieldLabel", "drawer", "drawerItem", "componentOverlay", "outline", "puck", "preview"];
169
195
  type OverrideKey = (typeof overrideKeys)[number];
170
196
  type OverridesGeneric<Shape extends {
171
197
  [key in OverrideKey]: any;
@@ -203,11 +229,23 @@ type Overrides = OverridesGeneric<{
203
229
  children: ReactNode;
204
230
  name: string;
205
231
  }>;
232
+ drawer: RenderFunc;
233
+ drawerItem: RenderFunc<{
234
+ children: ReactNode;
235
+ name: string;
236
+ }>;
206
237
  iframe: RenderFunc<{
207
238
  children: ReactNode;
208
239
  document?: Document;
209
240
  }>;
210
241
  outline: RenderFunc;
242
+ componentOverlay: RenderFunc<{
243
+ children: ReactNode;
244
+ hover: boolean;
245
+ isSelected: boolean;
246
+ componentId: string;
247
+ componentType: string;
248
+ }>;
211
249
  puck: RenderFunc;
212
250
  }>;
213
251
  type FieldRenderFunctions = Omit<{
@@ -233,7 +271,8 @@ type Viewport = {
233
271
  };
234
272
 
235
273
  type Plugin = {
236
- overrides: Partial<Overrides>;
274
+ overrides?: Partial<Overrides>;
275
+ fieldTransforms?: FieldTransforms;
237
276
  };
238
277
 
239
278
  declare const headingAnalyzer: Plugin;