@measured/puck-plugin-heading-analyzer 0.21.0-canary.c6d4e0ec → 0.21.0-canary.cbc526d1
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/index.css +5 -149
- package/dist/index.d.mts +277 -52
- package/dist/index.d.ts +277 -52
- package/dist/index.js +203 -327
- package/dist/index.mjs +197 -321
- package/package.json +3 -2
package/dist/index.css
CHANGED
|
@@ -1,162 +1,18 @@
|
|
|
1
1
|
/* css-module:/home/runner/work/puck/puck/packages/plugin-heading-analyzer/src/HeadingAnalyzer.module.css/#css-module-data */
|
|
2
|
-
.
|
|
2
|
+
._HeadingAnalyzer_yg0s7_1 {
|
|
3
3
|
display: block;
|
|
4
|
+
padding: 16px;
|
|
4
5
|
}
|
|
5
|
-
._HeadingAnalyzer-
|
|
6
|
+
._HeadingAnalyzer-cssWarning_yg0s7_6 {
|
|
6
7
|
display: none !important;
|
|
7
8
|
}
|
|
8
|
-
.
|
|
9
|
+
._HeadingAnalyzerItem_yg0s7_10 {
|
|
9
10
|
display: inline;
|
|
10
11
|
}
|
|
11
|
-
._HeadingAnalyzerItem--
|
|
12
|
+
._HeadingAnalyzerItem--missing_yg0s7_14 {
|
|
12
13
|
color: var(--puck-color-red-04);
|
|
13
14
|
}
|
|
14
15
|
|
|
15
|
-
/* css-module:/home/runner/work/puck/puck/packages/core/components/SidebarSection/styles.module.css/#css-module-data */
|
|
16
|
-
._SidebarSection_8boj8_1 {
|
|
17
|
-
display: flex;
|
|
18
|
-
position: relative;
|
|
19
|
-
flex-direction: column;
|
|
20
|
-
color: var(--puck-color-black);
|
|
21
|
-
}
|
|
22
|
-
._SidebarSection_8boj8_1:last-of-type {
|
|
23
|
-
flex-grow: 1;
|
|
24
|
-
}
|
|
25
|
-
._SidebarSection-title_8boj8_12 {
|
|
26
|
-
background: var(--puck-color-white);
|
|
27
|
-
padding: 16px;
|
|
28
|
-
border-bottom: 1px solid var(--puck-color-grey-09);
|
|
29
|
-
border-top: 1px solid var(--puck-color-grey-09);
|
|
30
|
-
overflow-x: auto;
|
|
31
|
-
}
|
|
32
|
-
._SidebarSection--noBorderTop_8boj8_20 > ._SidebarSection-title_8boj8_12 {
|
|
33
|
-
border-top: 0px;
|
|
34
|
-
}
|
|
35
|
-
._SidebarSection-content_8boj8_24 {
|
|
36
|
-
padding: 16px;
|
|
37
|
-
}
|
|
38
|
-
._SidebarSection--noPadding_8boj8_28 > ._SidebarSection-content_8boj8_24 {
|
|
39
|
-
padding: 0px;
|
|
40
|
-
}
|
|
41
|
-
._SidebarSection--noPadding_8boj8_28 > ._SidebarSection-content_8boj8_24:last-child {
|
|
42
|
-
padding-bottom: 4px;
|
|
43
|
-
}
|
|
44
|
-
._SidebarSection_8boj8_1:last-of-type ._SidebarSection-content_8boj8_24 {
|
|
45
|
-
border-bottom: none;
|
|
46
|
-
flex-grow: 1;
|
|
47
|
-
}
|
|
48
|
-
._SidebarSection-breadcrumbLabel_8boj8_41 {
|
|
49
|
-
background: none;
|
|
50
|
-
border: 0;
|
|
51
|
-
border-radius: 2px;
|
|
52
|
-
color: var(--puck-color-azure-04);
|
|
53
|
-
cursor: pointer;
|
|
54
|
-
font: inherit;
|
|
55
|
-
flex-shrink: 0;
|
|
56
|
-
padding: 0;
|
|
57
|
-
transition: color 50ms ease-in;
|
|
58
|
-
}
|
|
59
|
-
._SidebarSection-breadcrumbLabel_8boj8_41:focus-visible {
|
|
60
|
-
outline: 2px solid var(--puck-color-azure-05);
|
|
61
|
-
outline-offset: 2px;
|
|
62
|
-
}
|
|
63
|
-
@media (hover: hover) and (pointer: fine) {
|
|
64
|
-
._SidebarSection-breadcrumbLabel_8boj8_41:hover {
|
|
65
|
-
color: var(--puck-color-azure-03);
|
|
66
|
-
transition: none;
|
|
67
|
-
}
|
|
68
|
-
}
|
|
69
|
-
._SidebarSection-breadcrumbLabel_8boj8_41:active {
|
|
70
|
-
color: var(--puck-color-azure-02);
|
|
71
|
-
transition: none;
|
|
72
|
-
}
|
|
73
|
-
._SidebarSection-breadcrumbs_8boj8_70 {
|
|
74
|
-
align-items: center;
|
|
75
|
-
display: flex;
|
|
76
|
-
gap: 4px;
|
|
77
|
-
}
|
|
78
|
-
._SidebarSection-breadcrumb_8boj8_41 {
|
|
79
|
-
align-items: center;
|
|
80
|
-
display: flex;
|
|
81
|
-
gap: 4px;
|
|
82
|
-
}
|
|
83
|
-
._SidebarSection-heading_8boj8_82 {
|
|
84
|
-
padding-inline-end: 16px;
|
|
85
|
-
}
|
|
86
|
-
._SidebarSection-loadingOverlay_8boj8_86 {
|
|
87
|
-
background: var(--puck-color-white);
|
|
88
|
-
display: flex;
|
|
89
|
-
justify-content: center;
|
|
90
|
-
align-items: center;
|
|
91
|
-
height: 100%;
|
|
92
|
-
width: 100%;
|
|
93
|
-
top: 0;
|
|
94
|
-
position: absolute;
|
|
95
|
-
z-index: 1;
|
|
96
|
-
pointer-events: all;
|
|
97
|
-
box-sizing: border-box;
|
|
98
|
-
opacity: 0.8;
|
|
99
|
-
}
|
|
100
|
-
|
|
101
|
-
/* css-module:/home/runner/work/puck/puck/packages/core/components/Heading/styles.module.css/#css-module-data */
|
|
102
|
-
._Heading_qxrry_1 {
|
|
103
|
-
display: block;
|
|
104
|
-
color: var(--puck-color-black);
|
|
105
|
-
font-weight: 700;
|
|
106
|
-
margin: 0;
|
|
107
|
-
}
|
|
108
|
-
._Heading_qxrry_1 b {
|
|
109
|
-
font-weight: 700;
|
|
110
|
-
}
|
|
111
|
-
._Heading--xxxxl_qxrry_12 {
|
|
112
|
-
font-size: var(--puck-font-size-xxxxl);
|
|
113
|
-
letter-spacing: 0.08ch;
|
|
114
|
-
font-weight: 800;
|
|
115
|
-
}
|
|
116
|
-
._Heading--xxxl_qxrry_18 {
|
|
117
|
-
font-size: var(--puck-font-size-xxxl);
|
|
118
|
-
}
|
|
119
|
-
._Heading--xxl_qxrry_22 {
|
|
120
|
-
font-size: var(--puck-font-size-xxl);
|
|
121
|
-
}
|
|
122
|
-
._Heading--xl_qxrry_26 {
|
|
123
|
-
font-size: var(--puck-font-size-xl);
|
|
124
|
-
}
|
|
125
|
-
._Heading--l_qxrry_30 {
|
|
126
|
-
font-size: var(--puck-font-size-l);
|
|
127
|
-
}
|
|
128
|
-
._Heading--m_qxrry_34 {
|
|
129
|
-
font-size: var(--puck-font-size-m);
|
|
130
|
-
}
|
|
131
|
-
._Heading--s_qxrry_38 {
|
|
132
|
-
font-size: var(--puck-font-size-s);
|
|
133
|
-
}
|
|
134
|
-
._Heading--xs_qxrry_42 {
|
|
135
|
-
font-size: var(--puck-font-size-xs);
|
|
136
|
-
}
|
|
137
|
-
|
|
138
|
-
/* css-module:/home/runner/work/puck/puck/packages/core/components/Loader/styles.module.css/#css-module-data */
|
|
139
|
-
@keyframes _loader-animation_nacdm_1 {
|
|
140
|
-
0% {
|
|
141
|
-
transform: rotate(0deg) scale(1);
|
|
142
|
-
}
|
|
143
|
-
50% {
|
|
144
|
-
transform: rotate(180deg) scale(0.8);
|
|
145
|
-
}
|
|
146
|
-
100% {
|
|
147
|
-
transform: rotate(360deg) scale(1);
|
|
148
|
-
}
|
|
149
|
-
}
|
|
150
|
-
._Loader_nacdm_13 {
|
|
151
|
-
background: transparent;
|
|
152
|
-
border-radius: 100%;
|
|
153
|
-
border: 2px solid currentColor;
|
|
154
|
-
border-bottom-color: transparent;
|
|
155
|
-
display: inline-block;
|
|
156
|
-
animation: _loader-animation_nacdm_1 1s 0s infinite linear;
|
|
157
|
-
animation-fill-mode: both;
|
|
158
|
-
}
|
|
159
|
-
|
|
160
16
|
/* css-module:/home/runner/work/puck/puck/packages/core/components/OutlineList/styles.module.css/#css-module-data */
|
|
161
17
|
._OutlineList_w4lzv_1 {
|
|
162
18
|
color: var(--puck-color-grey-03);
|
package/dist/index.d.mts
CHANGED
|
@@ -1,72 +1,269 @@
|
|
|
1
|
-
import { ReactElement, CSSProperties, ReactNode, JSX } from 'react';
|
|
1
|
+
import { ReactElement, CSSProperties, ReactNode, ElementType, Ref, JSX } from 'react';
|
|
2
|
+
import { EditorStateSnapshot, Editor, Extensions } from '@tiptap/react';
|
|
3
|
+
import { BlockquoteOptions } from '@tiptap/extension-blockquote';
|
|
4
|
+
import { BoldOptions } from '@tiptap/extension-bold';
|
|
5
|
+
import { CodeOptions } from '@tiptap/extension-code';
|
|
6
|
+
import { CodeBlockOptions } from '@tiptap/extension-code-block';
|
|
7
|
+
import { HardBreakOptions } from '@tiptap/extension-hard-break';
|
|
8
|
+
import { HeadingOptions } from '@tiptap/extension-heading';
|
|
9
|
+
import { HorizontalRuleOptions } from '@tiptap/extension-horizontal-rule';
|
|
10
|
+
import { ItalicOptions } from '@tiptap/extension-italic';
|
|
11
|
+
import { LinkOptions } from '@tiptap/extension-link';
|
|
12
|
+
import { BulletListOptions, ListItemOptions, ListKeymapOptions, OrderedListOptions } from '@tiptap/extension-list';
|
|
13
|
+
import { ParagraphOptions } from '@tiptap/extension-paragraph';
|
|
14
|
+
import { StrikeOptions } from '@tiptap/extension-strike';
|
|
15
|
+
import { TextAlignOptions } from '@tiptap/extension-text-align';
|
|
16
|
+
import { UnderlineOptions } from '@tiptap/extension-underline';
|
|
2
17
|
|
|
3
18
|
type ItemSelector = {
|
|
4
19
|
index: number;
|
|
5
20
|
zone?: string;
|
|
6
21
|
};
|
|
7
22
|
|
|
23
|
+
declare const defaultEditorState: (ctx: EditorStateSnapshot, readOnly: boolean) => {
|
|
24
|
+
isAlignLeft?: undefined;
|
|
25
|
+
canAlignLeft?: undefined;
|
|
26
|
+
isAlignCenter?: undefined;
|
|
27
|
+
canAlignCenter?: undefined;
|
|
28
|
+
isAlignRight?: undefined;
|
|
29
|
+
canAlignRight?: undefined;
|
|
30
|
+
isAlignJustify?: undefined;
|
|
31
|
+
canAlignJustify?: undefined;
|
|
32
|
+
isBold?: undefined;
|
|
33
|
+
canBold?: undefined;
|
|
34
|
+
isItalic?: undefined;
|
|
35
|
+
canItalic?: undefined;
|
|
36
|
+
isUnderline?: undefined;
|
|
37
|
+
canUnderline?: undefined;
|
|
38
|
+
isStrike?: undefined;
|
|
39
|
+
canStrike?: undefined;
|
|
40
|
+
isInlineCode?: undefined;
|
|
41
|
+
canInlineCode?: undefined;
|
|
42
|
+
isBulletList?: undefined;
|
|
43
|
+
canBulletList?: undefined;
|
|
44
|
+
isOrderedList?: undefined;
|
|
45
|
+
canOrderedList?: undefined;
|
|
46
|
+
isCodeBlock?: undefined;
|
|
47
|
+
canCodeBlock?: undefined;
|
|
48
|
+
isBlockquote?: undefined;
|
|
49
|
+
canBlockquote?: undefined;
|
|
50
|
+
canHorizontalRule?: undefined;
|
|
51
|
+
} | {
|
|
52
|
+
isAlignLeft: boolean;
|
|
53
|
+
canAlignLeft: boolean;
|
|
54
|
+
isAlignCenter: boolean;
|
|
55
|
+
canAlignCenter: boolean;
|
|
56
|
+
isAlignRight: boolean;
|
|
57
|
+
canAlignRight: boolean;
|
|
58
|
+
isAlignJustify: boolean;
|
|
59
|
+
canAlignJustify: boolean;
|
|
60
|
+
isBold: boolean;
|
|
61
|
+
canBold: boolean;
|
|
62
|
+
isItalic: boolean;
|
|
63
|
+
canItalic: boolean;
|
|
64
|
+
isUnderline: boolean;
|
|
65
|
+
canUnderline: boolean;
|
|
66
|
+
isStrike: boolean;
|
|
67
|
+
canStrike: boolean;
|
|
68
|
+
isInlineCode: boolean;
|
|
69
|
+
canInlineCode: boolean;
|
|
70
|
+
isBulletList: boolean;
|
|
71
|
+
canBulletList: boolean;
|
|
72
|
+
isOrderedList: boolean;
|
|
73
|
+
canOrderedList: boolean;
|
|
74
|
+
isCodeBlock: boolean;
|
|
75
|
+
canCodeBlock: boolean;
|
|
76
|
+
isBlockquote: boolean;
|
|
77
|
+
canBlockquote: boolean;
|
|
78
|
+
canHorizontalRule: boolean;
|
|
79
|
+
};
|
|
80
|
+
|
|
81
|
+
type RichTextSelector = (ctx: EditorStateSnapshot, readOnly: boolean) => Partial<Record<string, boolean>>;
|
|
82
|
+
type DefaultEditorState = ReturnType<typeof defaultEditorState>;
|
|
83
|
+
type EditorState<Selector extends RichTextSelector = RichTextSelector> = DefaultEditorState & ReturnType<Selector> & Record<string, boolean | undefined>;
|
|
84
|
+
|
|
85
|
+
interface PuckRichTextOptions {
|
|
86
|
+
/**
|
|
87
|
+
* If set to false, the blockquote extension will not be registered
|
|
88
|
+
* @example blockquote: false
|
|
89
|
+
*/
|
|
90
|
+
blockquote: Partial<BlockquoteOptions> | false;
|
|
91
|
+
/**
|
|
92
|
+
* If set to false, the bold extension will not be registered
|
|
93
|
+
* @example bold: false
|
|
94
|
+
*/
|
|
95
|
+
bold: Partial<BoldOptions> | false;
|
|
96
|
+
/**
|
|
97
|
+
* If set to false, the bulletList extension will not be registered
|
|
98
|
+
* @example bulletList: false
|
|
99
|
+
*/
|
|
100
|
+
bulletList: Partial<BulletListOptions> | false;
|
|
101
|
+
/**
|
|
102
|
+
* If set to false, the code extension will not be registered
|
|
103
|
+
* @example code: false
|
|
104
|
+
*/
|
|
105
|
+
code: Partial<CodeOptions> | false;
|
|
106
|
+
/**
|
|
107
|
+
* If set to false, the codeBlock extension will not be registered
|
|
108
|
+
* @example codeBlock: false
|
|
109
|
+
*/
|
|
110
|
+
codeBlock: Partial<CodeBlockOptions> | false;
|
|
111
|
+
/**
|
|
112
|
+
* If set to false, the document extension will not be registered
|
|
113
|
+
* @example document: false
|
|
114
|
+
*/
|
|
115
|
+
document: false;
|
|
116
|
+
/**
|
|
117
|
+
* If set to false, the hardBreak extension will not be registered
|
|
118
|
+
* @example hardBreak: false
|
|
119
|
+
*/
|
|
120
|
+
hardBreak: Partial<HardBreakOptions> | false;
|
|
121
|
+
/**
|
|
122
|
+
* If set to false, the heading extension will not be registered
|
|
123
|
+
* @example heading: false
|
|
124
|
+
*/
|
|
125
|
+
heading: Partial<HeadingOptions> | false;
|
|
126
|
+
/**
|
|
127
|
+
* If set to false, the horizontalRule extension will not be registered
|
|
128
|
+
* @example horizontalRule: false
|
|
129
|
+
*/
|
|
130
|
+
horizontalRule: Partial<HorizontalRuleOptions> | false;
|
|
131
|
+
/**
|
|
132
|
+
* If set to false, the italic extension will not be registered
|
|
133
|
+
* @example italic: false
|
|
134
|
+
*/
|
|
135
|
+
italic: Partial<ItalicOptions> | false;
|
|
136
|
+
/**
|
|
137
|
+
* If set to false, the listItem extension will not be registered
|
|
138
|
+
* @example listItem: false
|
|
139
|
+
*/
|
|
140
|
+
listItem: Partial<ListItemOptions> | false;
|
|
141
|
+
/**
|
|
142
|
+
* If set to false, the listItemKeymap extension will not be registered
|
|
143
|
+
* @example listKeymap: false
|
|
144
|
+
*/
|
|
145
|
+
listKeymap: Partial<ListKeymapOptions> | false;
|
|
146
|
+
/**
|
|
147
|
+
* If set to false, the link extension will not be registered
|
|
148
|
+
* @example link: false
|
|
149
|
+
*/
|
|
150
|
+
link: Partial<LinkOptions> | false;
|
|
151
|
+
/**
|
|
152
|
+
* If set to false, the orderedList extension will not be registered
|
|
153
|
+
* @example orderedList: false
|
|
154
|
+
*/
|
|
155
|
+
orderedList: Partial<OrderedListOptions> | false;
|
|
156
|
+
/**
|
|
157
|
+
* If set to false, the paragraph extension will not be registered
|
|
158
|
+
* @example paragraph: false
|
|
159
|
+
*/
|
|
160
|
+
paragraph: Partial<ParagraphOptions> | false;
|
|
161
|
+
/**
|
|
162
|
+
* If set to false, the strike extension will not be registered
|
|
163
|
+
* @example strike: false
|
|
164
|
+
*/
|
|
165
|
+
strike: Partial<StrikeOptions> | false;
|
|
166
|
+
/**
|
|
167
|
+
* If set to false, the text extension will not be registered
|
|
168
|
+
* @example text: false
|
|
169
|
+
*/
|
|
170
|
+
text: false;
|
|
171
|
+
/**
|
|
172
|
+
* If set to false, the textAlign extension will not be registered
|
|
173
|
+
* @example text: false
|
|
174
|
+
*/
|
|
175
|
+
textAlign: Partial<TextAlignOptions> | false;
|
|
176
|
+
/**
|
|
177
|
+
* If set to false, the underline extension will not be registered
|
|
178
|
+
* @example underline: false
|
|
179
|
+
*/
|
|
180
|
+
underline: Partial<UnderlineOptions> | false;
|
|
181
|
+
}
|
|
182
|
+
|
|
8
183
|
type FieldOption = {
|
|
9
184
|
label: string;
|
|
10
185
|
value: string | number | boolean | undefined | null | object;
|
|
11
186
|
};
|
|
12
187
|
type FieldOptions = Array<FieldOption> | ReadonlyArray<FieldOption>;
|
|
13
|
-
|
|
188
|
+
interface BaseField {
|
|
14
189
|
label?: string;
|
|
15
190
|
labelIcon?: ReactElement;
|
|
16
|
-
metadata?:
|
|
191
|
+
metadata?: FieldMetadata;
|
|
17
192
|
visible?: boolean;
|
|
18
|
-
}
|
|
19
|
-
|
|
193
|
+
}
|
|
194
|
+
interface TextField extends BaseField {
|
|
20
195
|
type: "text";
|
|
21
196
|
placeholder?: string;
|
|
22
197
|
contentEditable?: boolean;
|
|
23
|
-
}
|
|
24
|
-
|
|
198
|
+
}
|
|
199
|
+
interface NumberField extends BaseField {
|
|
25
200
|
type: "number";
|
|
26
201
|
placeholder?: string;
|
|
27
202
|
min?: number;
|
|
28
203
|
max?: number;
|
|
29
204
|
step?: number;
|
|
30
|
-
}
|
|
31
|
-
|
|
205
|
+
}
|
|
206
|
+
interface TextareaField extends BaseField {
|
|
32
207
|
type: "textarea";
|
|
33
208
|
placeholder?: string;
|
|
34
209
|
contentEditable?: boolean;
|
|
35
|
-
}
|
|
36
|
-
|
|
210
|
+
}
|
|
211
|
+
interface SelectField extends BaseField {
|
|
37
212
|
type: "select";
|
|
38
213
|
options: FieldOptions;
|
|
39
|
-
}
|
|
40
|
-
|
|
214
|
+
}
|
|
215
|
+
interface RadioField extends BaseField {
|
|
41
216
|
type: "radio";
|
|
42
217
|
options: FieldOptions;
|
|
43
|
-
}
|
|
44
|
-
|
|
218
|
+
}
|
|
219
|
+
interface RichtextField<UserSelector extends RichTextSelector = RichTextSelector> extends BaseField {
|
|
220
|
+
type: "richtext";
|
|
221
|
+
contentEditable?: boolean;
|
|
222
|
+
initialHeight?: CSSProperties["height"];
|
|
223
|
+
options?: Partial<PuckRichTextOptions>;
|
|
224
|
+
renderMenu?: (props: {
|
|
225
|
+
children: ReactNode;
|
|
226
|
+
editor: Editor | null;
|
|
227
|
+
editorState: EditorState<UserSelector> | null;
|
|
228
|
+
readOnly: boolean;
|
|
229
|
+
}) => ReactNode;
|
|
230
|
+
renderInlineMenu?: (props: {
|
|
231
|
+
children: ReactNode;
|
|
232
|
+
editor: Editor | null;
|
|
233
|
+
editorState: EditorState<UserSelector> | null;
|
|
234
|
+
readOnly: boolean;
|
|
235
|
+
}) => ReactNode;
|
|
236
|
+
tiptap?: {
|
|
237
|
+
selector?: UserSelector;
|
|
238
|
+
extensions?: Extensions;
|
|
239
|
+
};
|
|
240
|
+
}
|
|
241
|
+
interface ArrayField<Props extends {
|
|
45
242
|
[key: string]: any;
|
|
46
243
|
}[] = {
|
|
47
244
|
[key: string]: any;
|
|
48
|
-
}[], UserField extends {} = {}>
|
|
245
|
+
}[], UserField extends {} = {}> extends BaseField {
|
|
49
246
|
type: "array";
|
|
50
247
|
arrayFields: {
|
|
51
248
|
[SubPropName in keyof Props[0]]: UserField extends {
|
|
52
249
|
type: PropertyKey;
|
|
53
250
|
} ? Field<Props[0][SubPropName], UserField> | UserField : Field<Props[0][SubPropName], UserField>;
|
|
54
251
|
};
|
|
55
|
-
defaultItemProps?: Props[0];
|
|
56
|
-
getItemSummary?: (item: Props[0], index?: number) =>
|
|
252
|
+
defaultItemProps?: Props[0] | ((index: number) => Props[0]);
|
|
253
|
+
getItemSummary?: (item: Props[0], index?: number) => ReactNode;
|
|
57
254
|
max?: number;
|
|
58
255
|
min?: number;
|
|
59
|
-
}
|
|
60
|
-
|
|
256
|
+
}
|
|
257
|
+
interface ObjectField<Props extends any = {
|
|
61
258
|
[key: string]: any;
|
|
62
|
-
}, UserField extends {} = {}>
|
|
259
|
+
}, UserField extends {} = {}> extends BaseField {
|
|
63
260
|
type: "object";
|
|
64
261
|
objectFields: {
|
|
65
262
|
[SubPropName in keyof Props]: UserField extends {
|
|
66
263
|
type: PropertyKey;
|
|
67
264
|
} ? Field<Props[SubPropName]> | UserField : Field<Props[SubPropName]>;
|
|
68
265
|
};
|
|
69
|
-
}
|
|
266
|
+
}
|
|
70
267
|
type Adaptor<AdaptorParams = {}, TableShape extends Record<string, any> = {}, PropShape = TableShape> = {
|
|
71
268
|
name: string;
|
|
72
269
|
fetchList: (adaptorParams?: AdaptorParams) => Promise<TableShape[] | null>;
|
|
@@ -80,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,15 @@ 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;
|
|
350
|
+
ref?: Ref<any>;
|
|
147
351
|
};
|
|
148
352
|
|
|
149
353
|
type PuckContext = {
|
|
150
|
-
renderDropZone: React.
|
|
354
|
+
renderDropZone: (props: DropZoneProps) => React.ReactNode;
|
|
151
355
|
metadata: Metadata;
|
|
152
356
|
isEditing: boolean;
|
|
153
357
|
dragRef: ((element: Element | null) => void) | null;
|
|
@@ -191,10 +395,12 @@ type SlotComponent = (props?: Omit<DropZoneProps, "zone">) => ReactNode;
|
|
|
191
395
|
type PuckComponent<Props> = (props: WithId<WithPuckProps<{
|
|
192
396
|
[K in keyof Props]: WithDeepSlots<Props[K], SlotComponent>;
|
|
193
397
|
}>>) => JSX.Element;
|
|
194
|
-
type ResolveDataTrigger = "insert" | "replace" | "load" | "force";
|
|
398
|
+
type ResolveDataTrigger = "insert" | "replace" | "load" | "force" | "move";
|
|
195
399
|
type WithPartialProps<T, Props extends DefaultComponentProps> = Omit<T, "props"> & {
|
|
196
400
|
props?: Partial<Props>;
|
|
197
401
|
};
|
|
402
|
+
interface ComponentConfigExtensions {
|
|
403
|
+
}
|
|
198
404
|
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.
|
|
199
405
|
UserField extends BaseField = {}> = {
|
|
200
406
|
render: PuckComponent<RenderProps>;
|
|
@@ -210,7 +416,7 @@ UserField extends BaseField = {}> = {
|
|
|
210
416
|
fields: Fields<FieldProps>;
|
|
211
417
|
lastFields: Fields<FieldProps>;
|
|
212
418
|
lastData: DataShape | null;
|
|
213
|
-
metadata:
|
|
419
|
+
metadata: ComponentMetadata;
|
|
214
420
|
appState: AppState;
|
|
215
421
|
parent: ComponentData | null;
|
|
216
422
|
}) => Promise<Fields<FieldProps>> | Fields<FieldProps>;
|
|
@@ -219,8 +425,9 @@ UserField extends BaseField = {}> = {
|
|
|
219
425
|
id: string;
|
|
220
426
|
}>;
|
|
221
427
|
lastData: DataShape | null;
|
|
222
|
-
metadata:
|
|
428
|
+
metadata: ComponentMetadata;
|
|
223
429
|
trigger: ResolveDataTrigger;
|
|
430
|
+
parent: ComponentData | null;
|
|
224
431
|
}) => Promise<WithPartialProps<DataShape, FieldProps>> | WithPartialProps<DataShape, FieldProps>;
|
|
225
432
|
resolvePermissions?: (data: DataShape, params: {
|
|
226
433
|
changed: Partial<Record<keyof FieldProps, boolean> & {
|
|
@@ -230,9 +437,10 @@ UserField extends BaseField = {}> = {
|
|
|
230
437
|
permissions: Partial<Permissions>;
|
|
231
438
|
appState: AppState;
|
|
232
439
|
lastData: DataShape | null;
|
|
440
|
+
parent: ComponentData | null;
|
|
233
441
|
}) => Promise<Partial<Permissions>> | Partial<Permissions>;
|
|
234
|
-
metadata?:
|
|
235
|
-
};
|
|
442
|
+
metadata?: ComponentMetadata;
|
|
443
|
+
} & ComponentConfigExtensions;
|
|
236
444
|
type RootConfigInternal<RootProps extends DefaultComponentProps = DefaultComponentProps, UserField extends BaseField = {}> = Partial<ComponentConfigInternal<WithChildren<RootProps>, AsFieldProps<RootProps>, RootData<AsFieldProps<RootProps>>, UserField>>;
|
|
237
445
|
type Category<ComponentName> = {
|
|
238
446
|
components?: ComponentName[];
|
|
@@ -259,6 +467,12 @@ type ExtractConfigParams<UserConfig extends ConfigInternal> = UserConfig extends
|
|
|
259
467
|
type: string;
|
|
260
468
|
} ? UserField : Field;
|
|
261
469
|
} : never;
|
|
470
|
+
type ConfigParams<Components extends DefaultComponents = DefaultComponents, RootProps extends DefaultComponentProps = any, CategoryNames extends string[] = string[], UserFields extends FieldsExtension = FieldsExtension> = {
|
|
471
|
+
components?: Components;
|
|
472
|
+
root?: RootProps;
|
|
473
|
+
categories?: CategoryNames;
|
|
474
|
+
fields?: AssertHasValue<UserFields>;
|
|
475
|
+
};
|
|
262
476
|
|
|
263
477
|
type BaseData<Props extends {
|
|
264
478
|
[key: string]: any;
|
|
@@ -298,10 +512,17 @@ type Data<Components extends DefaultComponents = DefaultComponents, RootProps ex
|
|
|
298
512
|
type Metadata = {
|
|
299
513
|
[key: string]: any;
|
|
300
514
|
};
|
|
515
|
+
interface PuckMetadata extends Metadata {
|
|
516
|
+
}
|
|
517
|
+
interface ComponentMetadata extends PuckMetadata {
|
|
518
|
+
}
|
|
519
|
+
interface FieldMetadata extends Metadata {
|
|
520
|
+
}
|
|
301
521
|
|
|
302
522
|
type ItemWithId = {
|
|
303
523
|
_arrayId: string;
|
|
304
524
|
_originalIndex: number;
|
|
525
|
+
_currentIndex: number;
|
|
305
526
|
};
|
|
306
527
|
type ArrayState = {
|
|
307
528
|
items: ItemWithId[];
|
|
@@ -312,6 +533,7 @@ type UiState = {
|
|
|
312
533
|
rightSideBarVisible: boolean;
|
|
313
534
|
leftSideBarWidth?: number | null;
|
|
314
535
|
rightSideBarWidth?: number | null;
|
|
536
|
+
mobilePanelExpanded?: boolean;
|
|
315
537
|
itemSelector: ItemSelector | null;
|
|
316
538
|
arrayState: Record<string, ArrayState | undefined>;
|
|
317
539
|
previewMode: "interactive" | "edit";
|
|
@@ -324,7 +546,7 @@ type UiState = {
|
|
|
324
546
|
isDragging: boolean;
|
|
325
547
|
viewports: {
|
|
326
548
|
current: {
|
|
327
|
-
width: number;
|
|
549
|
+
width: number | "100%";
|
|
328
550
|
height: number | "auto";
|
|
329
551
|
};
|
|
330
552
|
controlsVisible: boolean;
|
|
@@ -332,6 +554,10 @@ type UiState = {
|
|
|
332
554
|
};
|
|
333
555
|
field: {
|
|
334
556
|
focus?: string | null;
|
|
557
|
+
metadata?: Record<string, any>;
|
|
558
|
+
};
|
|
559
|
+
plugin: {
|
|
560
|
+
current: string | null;
|
|
335
561
|
};
|
|
336
562
|
};
|
|
337
563
|
type AppState<UserData extends Data = Data> = {
|
|
@@ -366,12 +592,6 @@ type BuiltinTypes = Date | RegExp | Error | Function | symbol | null | undefined
|
|
|
366
592
|
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 ? {
|
|
367
593
|
[K in keyof T]: WithDeepSlots<T[K], SlotType>;
|
|
368
594
|
} : T;
|
|
369
|
-
type ConfigParams<Components extends DefaultComponents = DefaultComponents, RootProps extends DefaultComponentProps = any, CategoryNames extends string[] = string[], UserFields extends FieldsExtension = FieldsExtension> = {
|
|
370
|
-
components?: Components;
|
|
371
|
-
root?: RootProps;
|
|
372
|
-
categories?: CategoryNames;
|
|
373
|
-
fields?: AssertHasValue<UserFields>;
|
|
374
|
-
};
|
|
375
595
|
type FieldsExtension = {
|
|
376
596
|
[Type in string]: {
|
|
377
597
|
type: Type;
|
|
@@ -382,6 +602,11 @@ type LeftOrExactRight<Union, Left, Right> = (Left & Union extends Right ? Exact<
|
|
|
382
602
|
type AssertHasValue<T, True = T, False = never> = [keyof T] extends [
|
|
383
603
|
never
|
|
384
604
|
] ? False : True;
|
|
605
|
+
type RenderFunc<Props extends {
|
|
606
|
+
[key: string]: any;
|
|
607
|
+
} = {
|
|
608
|
+
children: ReactNode;
|
|
609
|
+
}> = (props: Props) => ReactElement;
|
|
385
610
|
|
|
386
611
|
type MapFnParams<ThisField = Field> = {
|
|
387
612
|
value: any;
|
|
@@ -405,11 +630,6 @@ G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>, UserField extends
|
|
|
405
630
|
[Type in UserField["type"]]: FieldTransformFn<ExtractField<UserField, Type>>;
|
|
406
631
|
}>;
|
|
407
632
|
|
|
408
|
-
type RenderFunc<Props extends {
|
|
409
|
-
[key: string]: any;
|
|
410
|
-
} = {
|
|
411
|
-
children: ReactNode;
|
|
412
|
-
}> = (props: Props) => ReactElement;
|
|
413
633
|
declare const overrideKeys: readonly ["header", "headerActions", "fields", "fieldLabel", "drawer", "drawerItem", "componentOverlay", "outline", "puck", "preview"];
|
|
414
634
|
type OverrideKey = (typeof overrideKeys)[number];
|
|
415
635
|
type OverridesGeneric<Shape extends {
|
|
@@ -480,7 +700,7 @@ type DragAxis = "dynamic" | "y" | "x";
|
|
|
480
700
|
|
|
481
701
|
type iconTypes = "Smartphone" | "Monitor" | "Tablet";
|
|
482
702
|
type Viewport = {
|
|
483
|
-
width: number;
|
|
703
|
+
width: number | "100%";
|
|
484
704
|
height?: number | "auto";
|
|
485
705
|
label?: string;
|
|
486
706
|
icon?: iconTypes | ReactNode;
|
|
@@ -494,8 +714,13 @@ type Permissions = {
|
|
|
494
714
|
insert: boolean;
|
|
495
715
|
} & Record<string, boolean>;
|
|
496
716
|
type Plugin<UserConfig extends Config = Config> = {
|
|
717
|
+
name?: string;
|
|
718
|
+
label?: string;
|
|
719
|
+
icon?: ReactNode;
|
|
720
|
+
render?: () => ReactElement;
|
|
497
721
|
overrides?: Partial<Overrides<UserConfig>>;
|
|
498
722
|
fieldTransforms?: FieldTransforms<UserConfig>;
|
|
723
|
+
mobilePanelHeight?: "toggle" | "min-content";
|
|
499
724
|
};
|
|
500
725
|
type Slot<Props extends {
|
|
501
726
|
[key: string]: DefaultComponentProps;
|