@storyblok/schema 1.0.0-alpha.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.
- package/README.md +72 -0
- package/dist/generated/mapi-types.d.cts +732 -0
- package/dist/generated/mapi-types.d.mts +732 -0
- package/dist/generated/types.d.cts +155 -0
- package/dist/generated/types.d.mts +155 -0
- package/dist/helpers/create-story-helpers.cjs +42 -0
- package/dist/helpers/create-story-helpers.cjs.map +1 -0
- package/dist/helpers/create-story-helpers.d.cts +48 -0
- package/dist/helpers/create-story-helpers.d.mts +48 -0
- package/dist/helpers/create-story-helpers.mjs +42 -0
- package/dist/helpers/create-story-helpers.mjs.map +1 -0
- package/dist/helpers/define-asset-folder.cjs +40 -0
- package/dist/helpers/define-asset-folder.cjs.map +1 -0
- package/dist/helpers/define-asset-folder.d.cts +33 -0
- package/dist/helpers/define-asset-folder.d.mts +33 -0
- package/dist/helpers/define-asset-folder.mjs +37 -0
- package/dist/helpers/define-asset-folder.mjs.map +1 -0
- package/dist/helpers/define-asset.cjs +43 -0
- package/dist/helpers/define-asset.cjs.map +1 -0
- package/dist/helpers/define-asset.d.cts +32 -0
- package/dist/helpers/define-asset.d.mts +32 -0
- package/dist/helpers/define-asset.mjs +40 -0
- package/dist/helpers/define-asset.mjs.map +1 -0
- package/dist/helpers/define-block-folder.cjs +40 -0
- package/dist/helpers/define-block-folder.cjs.map +1 -0
- package/dist/helpers/define-block-folder.d.cts +34 -0
- package/dist/helpers/define-block-folder.d.mts +34 -0
- package/dist/helpers/define-block-folder.mjs +37 -0
- package/dist/helpers/define-block-folder.mjs.map +1 -0
- package/dist/helpers/define-block.cjs +51 -0
- package/dist/helpers/define-block.cjs.map +1 -0
- package/dist/helpers/define-block.d.cts +90 -0
- package/dist/helpers/define-block.d.mts +90 -0
- package/dist/helpers/define-block.mjs +48 -0
- package/dist/helpers/define-block.mjs.map +1 -0
- package/dist/helpers/define-datasource-entry.cjs +41 -0
- package/dist/helpers/define-datasource-entry.cjs.map +1 -0
- package/dist/helpers/define-datasource-entry.d.cts +48 -0
- package/dist/helpers/define-datasource-entry.d.mts +48 -0
- package/dist/helpers/define-datasource-entry.mjs +37 -0
- package/dist/helpers/define-datasource-entry.mjs.map +1 -0
- package/dist/helpers/define-datasource.cjs +33 -0
- package/dist/helpers/define-datasource.cjs.map +1 -0
- package/dist/helpers/define-datasource.d.cts +41 -0
- package/dist/helpers/define-datasource.d.mts +41 -0
- package/dist/helpers/define-datasource.mjs +30 -0
- package/dist/helpers/define-datasource.mjs.map +1 -0
- package/dist/helpers/define-field.cjs +17 -0
- package/dist/helpers/define-field.cjs.map +1 -0
- package/dist/helpers/define-field.d.cts +100 -0
- package/dist/helpers/define-field.d.mts +100 -0
- package/dist/helpers/define-field.mjs +16 -0
- package/dist/helpers/define-field.mjs.map +1 -0
- package/dist/helpers/define-internal-tag.cjs +37 -0
- package/dist/helpers/define-internal-tag.cjs.map +1 -0
- package/dist/helpers/define-internal-tag.d.cts +34 -0
- package/dist/helpers/define-internal-tag.d.mts +34 -0
- package/dist/helpers/define-internal-tag.mjs +34 -0
- package/dist/helpers/define-internal-tag.mjs.map +1 -0
- package/dist/helpers/define-link.cjs +22 -0
- package/dist/helpers/define-link.cjs.map +1 -0
- package/dist/helpers/define-link.d.cts +31 -0
- package/dist/helpers/define-link.d.mts +31 -0
- package/dist/helpers/define-link.mjs +21 -0
- package/dist/helpers/define-link.mjs.map +1 -0
- package/dist/helpers/define-preset.cjs +37 -0
- package/dist/helpers/define-preset.cjs.map +1 -0
- package/dist/helpers/define-preset.d.cts +35 -0
- package/dist/helpers/define-preset.d.mts +35 -0
- package/dist/helpers/define-preset.mjs +34 -0
- package/dist/helpers/define-preset.mjs.map +1 -0
- package/dist/helpers/define-space.cjs +34 -0
- package/dist/helpers/define-space.cjs.map +1 -0
- package/dist/helpers/define-space.d.cts +31 -0
- package/dist/helpers/define-space.d.mts +31 -0
- package/dist/helpers/define-space.mjs +31 -0
- package/dist/helpers/define-space.mjs.map +1 -0
- package/dist/helpers/define-story.cjs +94 -0
- package/dist/helpers/define-story.cjs.map +1 -0
- package/dist/helpers/define-story.d.cts +127 -0
- package/dist/helpers/define-story.d.mts +127 -0
- package/dist/helpers/define-story.mjs +90 -0
- package/dist/helpers/define-story.mjs.map +1 -0
- package/dist/helpers/define-tag.cjs +13 -0
- package/dist/helpers/define-tag.cjs.map +1 -0
- package/dist/helpers/define-tag.d.cts +23 -0
- package/dist/helpers/define-tag.d.mts +23 -0
- package/dist/helpers/define-tag.mjs +12 -0
- package/dist/helpers/define-tag.mjs.map +1 -0
- package/dist/helpers/define-user.cjs +32 -0
- package/dist/helpers/define-user.cjs.map +1 -0
- package/dist/helpers/define-user.d.cts +26 -0
- package/dist/helpers/define-user.d.mts +26 -0
- package/dist/helpers/define-user.mjs +30 -0
- package/dist/helpers/define-user.mjs.map +1 -0
- package/dist/helpers/schema-type.d.cts +40 -0
- package/dist/helpers/schema-type.d.mts +40 -0
- package/dist/index.cjs +55 -0
- package/dist/index.d.cts +19 -0
- package/dist/index.d.mts +19 -0
- package/dist/index.mjs +17 -0
- package/dist/utils/prettify.d.cts +9 -0
- package/dist/utils/prettify.d.mts +9 -0
- package/package.json +85 -0
|
@@ -0,0 +1,732 @@
|
|
|
1
|
+
import { AssetFieldValue, MultilinkFieldValue, PluginFieldValue, RichtextFieldValue, StoryBase, StoryTranslatedSlug, TableFieldValue } from "./types.mjs";
|
|
2
|
+
|
|
3
|
+
//#region src/generated/mapi-types.d.ts
|
|
4
|
+
type Story = StoryBase & Partial<{
|
|
5
|
+
deleted_at: string | null;
|
|
6
|
+
is_folder: boolean;
|
|
7
|
+
published: boolean;
|
|
8
|
+
default_root: string | null;
|
|
9
|
+
disable_fe_editor: boolean;
|
|
10
|
+
parent: {} | null;
|
|
11
|
+
unpublished_changes: boolean;
|
|
12
|
+
imported_at: string | null;
|
|
13
|
+
preview_token: Partial<{
|
|
14
|
+
token: string;
|
|
15
|
+
timestamp: string;
|
|
16
|
+
}>;
|
|
17
|
+
pinned: boolean;
|
|
18
|
+
breadcrumbs: Array<Partial<{
|
|
19
|
+
id: number;
|
|
20
|
+
name: string;
|
|
21
|
+
parent_id: number;
|
|
22
|
+
disable_fe_editor: boolean;
|
|
23
|
+
path: string;
|
|
24
|
+
slug: string;
|
|
25
|
+
translated_slugs: Array<StoryTranslatedSlug>;
|
|
26
|
+
}>>;
|
|
27
|
+
last_author: Partial<{
|
|
28
|
+
id: number;
|
|
29
|
+
userid: string;
|
|
30
|
+
friendly_name: string;
|
|
31
|
+
}>;
|
|
32
|
+
last_author_id: number;
|
|
33
|
+
translated_slugs_attributes: Array<Partial<{
|
|
34
|
+
id: number;
|
|
35
|
+
lang: string;
|
|
36
|
+
slug: string;
|
|
37
|
+
name: string;
|
|
38
|
+
published: boolean;
|
|
39
|
+
}>>;
|
|
40
|
+
scheduled_dates: string | null;
|
|
41
|
+
favourite_for_user_ids: Array<number>;
|
|
42
|
+
user_ids: Array<number>;
|
|
43
|
+
space_role_ids: Array<number>;
|
|
44
|
+
release_ids: Array<number>;
|
|
45
|
+
current_version_id: number;
|
|
46
|
+
base_version_id: number;
|
|
47
|
+
main_version_id: number;
|
|
48
|
+
stage: Partial<{
|
|
49
|
+
workflow_id: number;
|
|
50
|
+
workflow_stage_id: number;
|
|
51
|
+
story_id: number;
|
|
52
|
+
due_date: string;
|
|
53
|
+
created_at: string;
|
|
54
|
+
}> | null;
|
|
55
|
+
}>;
|
|
56
|
+
type StoryCreate = {
|
|
57
|
+
id?: number | undefined;
|
|
58
|
+
name: string;
|
|
59
|
+
slug?: string | undefined;
|
|
60
|
+
content?: BlokContentInput | undefined;
|
|
61
|
+
parent_id?: number | undefined;
|
|
62
|
+
path?: (string | null) | undefined;
|
|
63
|
+
is_startpage?: boolean | undefined;
|
|
64
|
+
tag_list?: Array<string> | undefined;
|
|
65
|
+
sort_by_date?: (string | null) | undefined;
|
|
66
|
+
position?: number | undefined;
|
|
67
|
+
meta_data?: ({} | null) | undefined;
|
|
68
|
+
is_folder?: boolean | undefined;
|
|
69
|
+
default_root?: (string | null) | undefined;
|
|
70
|
+
disable_fe_editor?: boolean | undefined;
|
|
71
|
+
translated_slugs_attributes?: Array<Partial<{
|
|
72
|
+
id: number;
|
|
73
|
+
lang: string;
|
|
74
|
+
slug: string;
|
|
75
|
+
name: string;
|
|
76
|
+
published: boolean;
|
|
77
|
+
}>> | undefined;
|
|
78
|
+
};
|
|
79
|
+
type StoryUpdate = Partial<{
|
|
80
|
+
id: number;
|
|
81
|
+
name: string;
|
|
82
|
+
slug: string;
|
|
83
|
+
content: BlokContentInput;
|
|
84
|
+
parent_id: number;
|
|
85
|
+
path: string | null;
|
|
86
|
+
is_startpage: boolean;
|
|
87
|
+
tag_list: Array<string>;
|
|
88
|
+
sort_by_date: string | null;
|
|
89
|
+
position: number;
|
|
90
|
+
meta_data: {} | null;
|
|
91
|
+
is_folder: boolean;
|
|
92
|
+
default_root: string | null;
|
|
93
|
+
disable_fe_editor: boolean;
|
|
94
|
+
translated_slugs_attributes: Array<Partial<{
|
|
95
|
+
id: number;
|
|
96
|
+
lang: string;
|
|
97
|
+
slug: string;
|
|
98
|
+
name: string;
|
|
99
|
+
published: boolean;
|
|
100
|
+
}>>;
|
|
101
|
+
}>;
|
|
102
|
+
type BlokContentInput = {
|
|
103
|
+
_uid?: string | undefined;
|
|
104
|
+
component: string;
|
|
105
|
+
_editable?: string | undefined;
|
|
106
|
+
} & {
|
|
107
|
+
[key: string]: null | string | number | boolean | Array<string | AssetFieldValue | BlokContentInput> | AssetFieldValue | MultilinkFieldValue | TableFieldValue | RichtextFieldValue | PluginFieldValue | undefined;
|
|
108
|
+
};
|
|
109
|
+
type Component = {
|
|
110
|
+
id: number;
|
|
111
|
+
name: string;
|
|
112
|
+
display_name?: (string | null) | undefined;
|
|
113
|
+
created_at: string;
|
|
114
|
+
updated_at: string;
|
|
115
|
+
schema: Partial<{
|
|
116
|
+
_uid: {};
|
|
117
|
+
component: {};
|
|
118
|
+
} & {
|
|
119
|
+
[key: string]: ComponentSchemaField | undefined;
|
|
120
|
+
}>;
|
|
121
|
+
image?: (string | null) | undefined;
|
|
122
|
+
preview_field?: (string | null) | undefined;
|
|
123
|
+
is_root?: boolean | undefined;
|
|
124
|
+
preview_tmpl?: (string | null) | undefined;
|
|
125
|
+
is_nestable?: boolean | undefined;
|
|
126
|
+
all_presets?: Array<Partial<{
|
|
127
|
+
id: number;
|
|
128
|
+
name: string;
|
|
129
|
+
component_id: number;
|
|
130
|
+
image: string | null;
|
|
131
|
+
icon: string | null;
|
|
132
|
+
color: string | null;
|
|
133
|
+
description: string;
|
|
134
|
+
}>> | undefined;
|
|
135
|
+
preset_id?: (number | null) | undefined;
|
|
136
|
+
real_name?: string | undefined;
|
|
137
|
+
component_group_uuid?: string | undefined;
|
|
138
|
+
color?: (string | null) | undefined;
|
|
139
|
+
icon?: (string | null) | undefined;
|
|
140
|
+
internal_tags_list?: Array<Partial<{
|
|
141
|
+
id: number;
|
|
142
|
+
name: string;
|
|
143
|
+
}>> | undefined;
|
|
144
|
+
internal_tag_ids?: Array<string> | undefined;
|
|
145
|
+
content_type_asset_preview?: (string | null) | undefined;
|
|
146
|
+
};
|
|
147
|
+
type ComponentSchemaField = TextField | TextareaField | RichtextField | MarkdownField | NumberField | DatetimeField | BooleanField | OptionField | OptionsField | AssetField | MultiassetField | MultilinkField | BloksField | TableField | SectionField | TabField | CustomField;
|
|
148
|
+
type TextField = BaseField & ValueField & {
|
|
149
|
+
type: "text";
|
|
150
|
+
max_length?: number | undefined;
|
|
151
|
+
maxlength?: number | undefined;
|
|
152
|
+
minlength?: number | undefined;
|
|
153
|
+
size?: string | undefined;
|
|
154
|
+
rtl?: boolean | undefined;
|
|
155
|
+
};
|
|
156
|
+
type BaseField = Partial<{
|
|
157
|
+
type: string;
|
|
158
|
+
id: string;
|
|
159
|
+
display_name: string;
|
|
160
|
+
description: string;
|
|
161
|
+
tooltip: boolean;
|
|
162
|
+
pos: number;
|
|
163
|
+
conditional_settings: Array<{}>;
|
|
164
|
+
}>;
|
|
165
|
+
type ValueField = Partial<{
|
|
166
|
+
required: boolean;
|
|
167
|
+
regex: string;
|
|
168
|
+
default_value: string;
|
|
169
|
+
translatable: boolean;
|
|
170
|
+
no_translate: boolean;
|
|
171
|
+
exclude_from_ai_translation: boolean;
|
|
172
|
+
exclude_from_merge: boolean;
|
|
173
|
+
exclude_from_overwrite: boolean;
|
|
174
|
+
force_merge: boolean;
|
|
175
|
+
}>;
|
|
176
|
+
type TextareaField = BaseField & ValueField & {
|
|
177
|
+
type: "textarea";
|
|
178
|
+
max_length?: number | undefined;
|
|
179
|
+
maxlength?: number | undefined;
|
|
180
|
+
minlength?: number | undefined;
|
|
181
|
+
size?: string | undefined;
|
|
182
|
+
rtl?: boolean | undefined;
|
|
183
|
+
rich_text?: boolean | undefined;
|
|
184
|
+
markdown?: boolean | undefined;
|
|
185
|
+
};
|
|
186
|
+
type RichtextField = BaseField & ValueField & {
|
|
187
|
+
type: "richtext";
|
|
188
|
+
customize_toolbar?: boolean | undefined;
|
|
189
|
+
toolbar?: Array<"ai-complete" | "ai-shorten" | "ai-extend" | "ai-rephrase" | "ai-summarize" | "ai-simplify" | "ai-tone" | "ai-emoji" | "ai-translate" | "ai-tldr" | "ai-spelling" | "blok" | "ltr" | "rtl" | "export" | "import" | "bold" | "list" | "inlinecode" | "code" | "color" | "copy" | "cut" | "emoji" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "highlight" | "unset" | "hrule" | "image" | "italic" | "link" | "anchor" | "olist" | "paragraph" | "paste-action" | "paste" | "quote" | "redo" | "strike" | "subscript" | "superscript" | "underline" | "undo" | "align-left" | "align-center" | "align-right" | "align-justify"> | undefined;
|
|
190
|
+
style_options?: Array<Partial<{
|
|
191
|
+
_uid: string;
|
|
192
|
+
name: string;
|
|
193
|
+
value: string;
|
|
194
|
+
}>> | undefined;
|
|
195
|
+
restrict_type?: string | undefined;
|
|
196
|
+
restrict_components?: boolean | undefined;
|
|
197
|
+
component_whitelist?: Array<string> | undefined;
|
|
198
|
+
component_denylist?: Array<string> | undefined;
|
|
199
|
+
component_tag_whitelist?: Array<number> | undefined;
|
|
200
|
+
component_tag_denylist?: Array<number> | undefined;
|
|
201
|
+
component_group_whitelist?: Array<string> | undefined;
|
|
202
|
+
component_group_denylist?: Array<string> | undefined;
|
|
203
|
+
allow_target_blank?: boolean | undefined;
|
|
204
|
+
allow_custom_attributes?: boolean | undefined;
|
|
205
|
+
};
|
|
206
|
+
type MarkdownField = BaseField & ValueField & {
|
|
207
|
+
type: "markdown";
|
|
208
|
+
rich_markdown?: boolean | undefined;
|
|
209
|
+
rtl?: boolean | undefined;
|
|
210
|
+
customize_toolbar?: boolean | undefined;
|
|
211
|
+
toolbar?: Array<"bold" | "italic" | "inlinecode" | "code" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "list" | "olist" | "quote" | "hrule" | "link" | "image" | "paragraph" | "help" | "toggle-richtext" | "auto" | "ltr" | "rtl"> | undefined;
|
|
212
|
+
allow_multiline?: boolean | undefined;
|
|
213
|
+
max_length?: number | undefined;
|
|
214
|
+
};
|
|
215
|
+
type NumberField = BaseField & ValueField & {
|
|
216
|
+
type: "number";
|
|
217
|
+
min_value?: number | undefined;
|
|
218
|
+
max_value?: number | undefined;
|
|
219
|
+
decimals?: number | undefined;
|
|
220
|
+
steps?: number | undefined;
|
|
221
|
+
};
|
|
222
|
+
type DatetimeField = BaseField & ValueField & {
|
|
223
|
+
type: "datetime";
|
|
224
|
+
disable_time?: boolean | undefined;
|
|
225
|
+
};
|
|
226
|
+
type BooleanField = BaseField & ValueField & {
|
|
227
|
+
type: "boolean";
|
|
228
|
+
inline_label?: boolean | undefined;
|
|
229
|
+
};
|
|
230
|
+
type OptionField = BaseField & ValueField & {
|
|
231
|
+
type: "option";
|
|
232
|
+
options?: Array<Partial<{
|
|
233
|
+
_uid: string;
|
|
234
|
+
name: string;
|
|
235
|
+
value: string;
|
|
236
|
+
}>> | undefined;
|
|
237
|
+
source?: string | undefined;
|
|
238
|
+
datasource_slug?: string | undefined;
|
|
239
|
+
external_datasource?: string | undefined;
|
|
240
|
+
folder_slug?: string | undefined;
|
|
241
|
+
filter_content_type?: Array<string> | undefined;
|
|
242
|
+
exclude_empty_option?: boolean | undefined;
|
|
243
|
+
include_empty_option?: boolean | undefined;
|
|
244
|
+
use_uuid?: boolean | undefined;
|
|
245
|
+
entry_appearance?: string | undefined;
|
|
246
|
+
allow_advanced_search?: boolean | undefined;
|
|
247
|
+
max_options?: string | undefined;
|
|
248
|
+
min_options?: string | undefined;
|
|
249
|
+
multiple?: boolean | undefined;
|
|
250
|
+
};
|
|
251
|
+
type OptionsField = BaseField & ValueField & {
|
|
252
|
+
type: "options";
|
|
253
|
+
options?: Array<Partial<{
|
|
254
|
+
_uid: string;
|
|
255
|
+
name: string;
|
|
256
|
+
value: string;
|
|
257
|
+
}>> | undefined;
|
|
258
|
+
source?: string | undefined;
|
|
259
|
+
datasource_slug?: string | undefined;
|
|
260
|
+
external_datasource?: string | undefined;
|
|
261
|
+
folder_slug?: string | undefined;
|
|
262
|
+
filter_content_type?: Array<string> | undefined;
|
|
263
|
+
use_uuid?: boolean | undefined;
|
|
264
|
+
is_reference_type?: boolean | undefined;
|
|
265
|
+
entry_appearance?: string | undefined;
|
|
266
|
+
allow_advanced_search?: boolean | undefined;
|
|
267
|
+
max_options?: string | undefined;
|
|
268
|
+
min_options?: string | undefined;
|
|
269
|
+
multiple?: boolean | undefined;
|
|
270
|
+
};
|
|
271
|
+
type AssetField = BaseField & ValueField & {
|
|
272
|
+
type: "asset";
|
|
273
|
+
filetypes?: Array<string> | undefined;
|
|
274
|
+
asset_folder_id?: number | undefined;
|
|
275
|
+
allow_external_url?: boolean | undefined;
|
|
276
|
+
height?: number | undefined;
|
|
277
|
+
width?: number | undefined;
|
|
278
|
+
restrict_assets?: boolean | undefined;
|
|
279
|
+
asset_whitelist?: Array<string> | undefined;
|
|
280
|
+
};
|
|
281
|
+
type MultiassetField = BaseField & ValueField & {
|
|
282
|
+
type: "multiasset";
|
|
283
|
+
filetypes?: Array<string> | undefined;
|
|
284
|
+
asset_folder_id?: number | undefined;
|
|
285
|
+
allow_external_url?: boolean | undefined;
|
|
286
|
+
height?: number | undefined;
|
|
287
|
+
width?: number | undefined;
|
|
288
|
+
restrict_assets?: boolean | undefined;
|
|
289
|
+
asset_whitelist?: Array<string> | undefined;
|
|
290
|
+
maximum_entries?: number | undefined;
|
|
291
|
+
minimum_entries?: number | undefined;
|
|
292
|
+
};
|
|
293
|
+
type MultilinkField = BaseField & ValueField & {
|
|
294
|
+
type: "multilink";
|
|
295
|
+
restrict_content_types?: boolean | undefined;
|
|
296
|
+
component_whitelist?: Array<string> | undefined;
|
|
297
|
+
allow_target_blank?: boolean | undefined;
|
|
298
|
+
allow_custom_attributes?: boolean | undefined;
|
|
299
|
+
force_link_scope?: boolean | undefined;
|
|
300
|
+
link_scope?: string | undefined;
|
|
301
|
+
show_anchor?: boolean | undefined;
|
|
302
|
+
email_link_type?: boolean | undefined;
|
|
303
|
+
asset_link_type?: boolean | undefined;
|
|
304
|
+
};
|
|
305
|
+
type BloksField = BaseField & ValueField & {
|
|
306
|
+
type: "bloks";
|
|
307
|
+
restrict_type?: string | undefined;
|
|
308
|
+
restrict_components?: boolean | undefined;
|
|
309
|
+
component_whitelist?: Array<string> | undefined;
|
|
310
|
+
component_denylist?: Array<string> | undefined;
|
|
311
|
+
component_tag_whitelist?: Array<number> | undefined;
|
|
312
|
+
component_tag_denylist?: Array<number> | undefined;
|
|
313
|
+
component_group_whitelist?: Array<string> | undefined;
|
|
314
|
+
component_group_denylist?: Array<string> | undefined;
|
|
315
|
+
minimum?: number | undefined;
|
|
316
|
+
maximum?: number | undefined;
|
|
317
|
+
maximum_entries?: number | undefined;
|
|
318
|
+
minimum_entries?: number | undefined;
|
|
319
|
+
};
|
|
320
|
+
type TableField = BaseField & ValueField & {
|
|
321
|
+
type: "table";
|
|
322
|
+
};
|
|
323
|
+
type SectionField = BaseField & {
|
|
324
|
+
type: "section";
|
|
325
|
+
keys?: Array<string> | undefined;
|
|
326
|
+
fieldset?: Partial<{
|
|
327
|
+
title: string;
|
|
328
|
+
description: string;
|
|
329
|
+
collapsible: boolean;
|
|
330
|
+
collapsed: boolean;
|
|
331
|
+
}> | undefined;
|
|
332
|
+
};
|
|
333
|
+
type TabField = BaseField & {
|
|
334
|
+
type: "tab";
|
|
335
|
+
keys?: Array<string> | undefined;
|
|
336
|
+
};
|
|
337
|
+
type CustomField = BaseField & ValueField & {
|
|
338
|
+
type: "custom";
|
|
339
|
+
field_type?: string | undefined;
|
|
340
|
+
options?: Array<Partial<{
|
|
341
|
+
name: string;
|
|
342
|
+
value: string;
|
|
343
|
+
}>> | undefined;
|
|
344
|
+
required_fields?: string | undefined;
|
|
345
|
+
source?: ("self" | "internal") | undefined;
|
|
346
|
+
datasource_slug?: string | undefined;
|
|
347
|
+
external_datasource?: string | undefined;
|
|
348
|
+
};
|
|
349
|
+
type AssetUpdate = {
|
|
350
|
+
asset_folder_id?: number | undefined;
|
|
351
|
+
alt?: string | undefined;
|
|
352
|
+
copyright?: string | undefined;
|
|
353
|
+
title?: string | undefined;
|
|
354
|
+
source?: string | undefined;
|
|
355
|
+
expire_at?: string | undefined;
|
|
356
|
+
focus?: string | undefined;
|
|
357
|
+
internal_tag_ids?: Array<string> | undefined;
|
|
358
|
+
publish_at?: string | undefined;
|
|
359
|
+
is_private?: boolean | undefined;
|
|
360
|
+
meta_data?: {} | undefined;
|
|
361
|
+
};
|
|
362
|
+
type Space = {
|
|
363
|
+
name?: string | undefined;
|
|
364
|
+
domain?: string | undefined;
|
|
365
|
+
uniq_domain?: string | undefined;
|
|
366
|
+
plan?: string | undefined;
|
|
367
|
+
plan_level?: number | undefined;
|
|
368
|
+
limits?: {} | undefined;
|
|
369
|
+
created_at?: string | undefined;
|
|
370
|
+
id: number;
|
|
371
|
+
role?: string | undefined;
|
|
372
|
+
owner_id?: number | undefined;
|
|
373
|
+
story_published_hook?: string | undefined;
|
|
374
|
+
environments?: Array<{
|
|
375
|
+
name?: string | undefined;
|
|
376
|
+
location?: string | undefined;
|
|
377
|
+
}> | undefined;
|
|
378
|
+
stories_count?: number | undefined;
|
|
379
|
+
parent_id?: number | undefined;
|
|
380
|
+
assets_count?: number | undefined;
|
|
381
|
+
searchblok_id?: number | undefined;
|
|
382
|
+
duplicatable?: boolean | undefined;
|
|
383
|
+
request_count_today?: number | undefined;
|
|
384
|
+
exceeded_requests?: number | undefined;
|
|
385
|
+
billing_address?: {} | undefined;
|
|
386
|
+
routes?: Array<string> | undefined;
|
|
387
|
+
trial?: boolean | undefined;
|
|
388
|
+
default_root?: string | undefined;
|
|
389
|
+
has_slack_webhook?: boolean | undefined;
|
|
390
|
+
has_pending_tasks?: boolean | undefined;
|
|
391
|
+
ai_translation_disabled?: boolean | undefined;
|
|
392
|
+
first_token?: string | undefined;
|
|
393
|
+
options?: {} | undefined;
|
|
394
|
+
collaborator?: Array<Collaborator> | undefined;
|
|
395
|
+
owner?: {} | undefined;
|
|
396
|
+
org?: {
|
|
397
|
+
name?: string | undefined;
|
|
398
|
+
ai_text_generator_disabled_in_org?: boolean | undefined;
|
|
399
|
+
custom_upload_limit_in_mb?: number | null | undefined;
|
|
400
|
+
} | undefined;
|
|
401
|
+
in_org?: boolean | undefined;
|
|
402
|
+
assign_partner?: boolean | undefined;
|
|
403
|
+
languages?: Array<{
|
|
404
|
+
code?: string | undefined;
|
|
405
|
+
name?: string | undefined;
|
|
406
|
+
ai_translation_code?: string | null | undefined;
|
|
407
|
+
}> | undefined;
|
|
408
|
+
default_lang_name?: string | undefined;
|
|
409
|
+
};
|
|
410
|
+
type Collaborator = {
|
|
411
|
+
user?: {
|
|
412
|
+
id?: number | undefined;
|
|
413
|
+
firstname?: string | undefined;
|
|
414
|
+
lastname?: string | undefined;
|
|
415
|
+
alt_email?: string | undefined;
|
|
416
|
+
avatar?: string | undefined;
|
|
417
|
+
userid?: string | undefined;
|
|
418
|
+
friendly_name?: string | undefined;
|
|
419
|
+
} | undefined;
|
|
420
|
+
role?: string | undefined;
|
|
421
|
+
user_id?: number | undefined;
|
|
422
|
+
permissions?: Array<"read_stories" | "save_stories" | "publish_stories" | "unpublish_stories" | "publish_folders" | "unpublish_folders" | "deploy_stories" | "delete_stories" | "edit_image" | "view_composer" | "change_alternate_group" | "move_story" | "edit_story_slug" | "view_content" | "view_folders" | "view_draft_json" | "view_published_json" | "manage_tags" | "edit_datasources" | "edit_datasource_keys" | "access_commerce" | "manage_block_library" | "hide_asset_folders"> | undefined;
|
|
423
|
+
allowed_paths?: Array<number> | undefined;
|
|
424
|
+
field_permissions?: Array<string> | undefined;
|
|
425
|
+
id?: number | undefined;
|
|
426
|
+
space_role_id?: number | undefined;
|
|
427
|
+
space_role_ids?: Array<number> | undefined;
|
|
428
|
+
space_id?: number | undefined;
|
|
429
|
+
};
|
|
430
|
+
type DatasourceEntry = {
|
|
431
|
+
id: number;
|
|
432
|
+
name: string;
|
|
433
|
+
value?: string | undefined;
|
|
434
|
+
datasource_id?: number | undefined;
|
|
435
|
+
dimension_value?: string | undefined;
|
|
436
|
+
};
|
|
437
|
+
type Asset = {
|
|
438
|
+
id: number;
|
|
439
|
+
filename: string;
|
|
440
|
+
space_id: number;
|
|
441
|
+
created_at: string;
|
|
442
|
+
updated_at: string;
|
|
443
|
+
file?: {} | undefined;
|
|
444
|
+
asset_folder_id?: number | undefined;
|
|
445
|
+
deleted_at?: string | undefined;
|
|
446
|
+
short_filename: string;
|
|
447
|
+
content_type: string;
|
|
448
|
+
content_length: number;
|
|
449
|
+
alt?: string | undefined;
|
|
450
|
+
copyright?: string | undefined;
|
|
451
|
+
title?: string | undefined;
|
|
452
|
+
source?: string | undefined;
|
|
453
|
+
expire_at?: string | undefined;
|
|
454
|
+
focus?: string | undefined;
|
|
455
|
+
internal_tag_ids?: Array<string> | undefined;
|
|
456
|
+
internal_tags_list?: Array<{
|
|
457
|
+
id?: number | undefined;
|
|
458
|
+
name?: string | undefined;
|
|
459
|
+
}> | undefined;
|
|
460
|
+
locked?: boolean | undefined;
|
|
461
|
+
publish_at?: string | undefined;
|
|
462
|
+
is_private?: boolean | undefined;
|
|
463
|
+
meta_data?: Record<string, unknown> | undefined;
|
|
464
|
+
};
|
|
465
|
+
type DatasourceCreate = {
|
|
466
|
+
name: string;
|
|
467
|
+
slug: string;
|
|
468
|
+
dimensions_attributes?: Array<{
|
|
469
|
+
name: string;
|
|
470
|
+
entry_value: string;
|
|
471
|
+
}> | undefined;
|
|
472
|
+
};
|
|
473
|
+
type DatasourceUpdate = {
|
|
474
|
+
name?: string | undefined;
|
|
475
|
+
slug?: string | undefined;
|
|
476
|
+
dimensions_attributes?: Array<{
|
|
477
|
+
name: string;
|
|
478
|
+
entry_value: string;
|
|
479
|
+
}> | undefined;
|
|
480
|
+
};
|
|
481
|
+
type AssetFolder = {
|
|
482
|
+
id: number;
|
|
483
|
+
name: string;
|
|
484
|
+
parent_id?: number | null | undefined;
|
|
485
|
+
uuid: string;
|
|
486
|
+
parent_uuid?: string | null | undefined;
|
|
487
|
+
};
|
|
488
|
+
type ComponentFolder = {
|
|
489
|
+
id: number;
|
|
490
|
+
name: string;
|
|
491
|
+
uuid: string;
|
|
492
|
+
parent_id?: number | undefined;
|
|
493
|
+
parent_uuid?: string | undefined;
|
|
494
|
+
};
|
|
495
|
+
type InternalTag = {
|
|
496
|
+
name: string;
|
|
497
|
+
id?: number | undefined;
|
|
498
|
+
object_type?: "asset" | "component" | undefined;
|
|
499
|
+
};
|
|
500
|
+
type Preset = {
|
|
501
|
+
id: number;
|
|
502
|
+
name: string;
|
|
503
|
+
preset?: Record<string, unknown> | undefined;
|
|
504
|
+
component_id: number;
|
|
505
|
+
space_id?: number | undefined;
|
|
506
|
+
created_at?: string | undefined;
|
|
507
|
+
updated_at?: string | undefined;
|
|
508
|
+
image?: string | undefined;
|
|
509
|
+
color?: string | undefined;
|
|
510
|
+
icon?: string | undefined;
|
|
511
|
+
description?: string | undefined;
|
|
512
|
+
};
|
|
513
|
+
type User = {
|
|
514
|
+
id: number;
|
|
515
|
+
email: string;
|
|
516
|
+
alt_email?: string | undefined;
|
|
517
|
+
firstname?: string | undefined;
|
|
518
|
+
lastname?: string | undefined;
|
|
519
|
+
username?: string | undefined;
|
|
520
|
+
avatar?: string | undefined;
|
|
521
|
+
lang?: string | undefined;
|
|
522
|
+
timezone?: string | undefined;
|
|
523
|
+
phone?: string | undefined;
|
|
524
|
+
is_editor?: boolean | undefined;
|
|
525
|
+
job_role?: string | undefined;
|
|
526
|
+
job_title?: string | undefined;
|
|
527
|
+
company_name?: string | undefined;
|
|
528
|
+
company_size?: string | undefined;
|
|
529
|
+
usage_type?: string | undefined;
|
|
530
|
+
framework_used?: string | undefined;
|
|
531
|
+
beta_user?: boolean | undefined;
|
|
532
|
+
track_statistics?: boolean | undefined;
|
|
533
|
+
ui_theme?: {} | undefined;
|
|
534
|
+
favourite_spaces?: Array<number> | undefined;
|
|
535
|
+
favourite_ideas?: Array<number> | undefined;
|
|
536
|
+
notified?: Array<string> | undefined;
|
|
537
|
+
disclaimer_ids?: Array<number> | undefined;
|
|
538
|
+
has_org?: boolean | undefined;
|
|
539
|
+
has_partner?: boolean | undefined;
|
|
540
|
+
partner_status?: string | undefined;
|
|
541
|
+
org_role?: string | undefined;
|
|
542
|
+
partner_role?: string | undefined;
|
|
543
|
+
org?: {
|
|
544
|
+
settings?: {} | undefined;
|
|
545
|
+
name?: string | undefined;
|
|
546
|
+
status?: string | undefined;
|
|
547
|
+
} | undefined;
|
|
548
|
+
role?: string | undefined;
|
|
549
|
+
sso?: boolean | undefined;
|
|
550
|
+
totp_factor_verified?: boolean | undefined;
|
|
551
|
+
configured_2fa_options?: Array<string> | undefined;
|
|
552
|
+
live_chat_enabled?: boolean | undefined;
|
|
553
|
+
friendly_name?: string | undefined;
|
|
554
|
+
created_at: string;
|
|
555
|
+
updated_at: string;
|
|
556
|
+
};
|
|
557
|
+
type AssetCreate = {
|
|
558
|
+
filename: string;
|
|
559
|
+
id?: number | undefined;
|
|
560
|
+
asset_folder_id?: number | undefined;
|
|
561
|
+
is_private?: boolean | undefined;
|
|
562
|
+
size?: string | undefined;
|
|
563
|
+
validate_upload?: 0 | 1 | undefined;
|
|
564
|
+
alt?: string | undefined;
|
|
565
|
+
copyright?: string | undefined;
|
|
566
|
+
title?: string | undefined;
|
|
567
|
+
source?: string | undefined;
|
|
568
|
+
expire_at?: string | undefined;
|
|
569
|
+
focus?: string | undefined;
|
|
570
|
+
internal_tag_ids?: Array<string> | undefined;
|
|
571
|
+
publish_at?: string | undefined;
|
|
572
|
+
meta_data?: Record<string, unknown> | undefined;
|
|
573
|
+
};
|
|
574
|
+
type AssetFolderCreate = {
|
|
575
|
+
name: string;
|
|
576
|
+
parent_id?: number | null | undefined;
|
|
577
|
+
};
|
|
578
|
+
type AssetFolderUpdate = {
|
|
579
|
+
name?: string | undefined;
|
|
580
|
+
parent_id?: number | null | undefined;
|
|
581
|
+
};
|
|
582
|
+
type ComponentFolderCreate = {
|
|
583
|
+
name: string;
|
|
584
|
+
parent_id?: number | undefined;
|
|
585
|
+
};
|
|
586
|
+
type ComponentFolderUpdate = {
|
|
587
|
+
name?: string | undefined;
|
|
588
|
+
parent_id?: number | undefined;
|
|
589
|
+
};
|
|
590
|
+
type DatasourceEntryCreate = {
|
|
591
|
+
name: string;
|
|
592
|
+
value: string;
|
|
593
|
+
datasource_id: number;
|
|
594
|
+
dimension_value?: string | undefined;
|
|
595
|
+
};
|
|
596
|
+
type DatasourceEntryUpdate = {
|
|
597
|
+
name?: string | undefined;
|
|
598
|
+
value?: string | undefined;
|
|
599
|
+
datasource_id?: number | undefined;
|
|
600
|
+
dimension_value?: string | undefined;
|
|
601
|
+
};
|
|
602
|
+
type InternalTagCreate = {
|
|
603
|
+
name: string;
|
|
604
|
+
object_type?: "asset" | "component" | undefined;
|
|
605
|
+
};
|
|
606
|
+
type InternalTagUpdate = {
|
|
607
|
+
name?: string | undefined;
|
|
608
|
+
object_type?: "asset" | "component" | undefined;
|
|
609
|
+
};
|
|
610
|
+
type PresetCreate = {
|
|
611
|
+
name: string;
|
|
612
|
+
component_id: number;
|
|
613
|
+
preset?: Record<string, unknown> | undefined;
|
|
614
|
+
image?: string | undefined;
|
|
615
|
+
color?: string | undefined;
|
|
616
|
+
icon?: string | undefined;
|
|
617
|
+
description?: string | undefined;
|
|
618
|
+
};
|
|
619
|
+
type PresetUpdate = {
|
|
620
|
+
name?: string | undefined;
|
|
621
|
+
component_id?: number | undefined;
|
|
622
|
+
preset?: Record<string, unknown> | undefined;
|
|
623
|
+
image?: string | undefined;
|
|
624
|
+
color?: string | undefined;
|
|
625
|
+
icon?: string | undefined;
|
|
626
|
+
description?: string | undefined;
|
|
627
|
+
};
|
|
628
|
+
type SpaceCreate = {
|
|
629
|
+
name: string;
|
|
630
|
+
domain?: string | undefined;
|
|
631
|
+
story_published_hook?: string | undefined;
|
|
632
|
+
environments?: Array<{
|
|
633
|
+
name?: string | undefined;
|
|
634
|
+
location?: string | undefined;
|
|
635
|
+
}> | undefined;
|
|
636
|
+
searchblok_id?: number | undefined;
|
|
637
|
+
parent_id?: number | undefined;
|
|
638
|
+
is_demo?: boolean | undefined;
|
|
639
|
+
blueprint_reference?: string | undefined;
|
|
640
|
+
org?: {
|
|
641
|
+
name?: string | undefined;
|
|
642
|
+
ai_text_generator_disabled_in_org?: boolean | undefined;
|
|
643
|
+
custom_upload_limit_in_mb?: number | null | undefined;
|
|
644
|
+
} | undefined;
|
|
645
|
+
in_org?: boolean | undefined;
|
|
646
|
+
assign_partner?: boolean | undefined;
|
|
647
|
+
};
|
|
648
|
+
type SpaceUpdate = {
|
|
649
|
+
name?: string | undefined;
|
|
650
|
+
domain?: string | undefined;
|
|
651
|
+
uniq_domain?: string | undefined;
|
|
652
|
+
owner_id?: number | undefined;
|
|
653
|
+
story_published_hook?: string | undefined;
|
|
654
|
+
environments?: Array<{
|
|
655
|
+
name?: string | undefined;
|
|
656
|
+
location?: string | undefined;
|
|
657
|
+
}> | undefined;
|
|
658
|
+
parent_id?: number | undefined;
|
|
659
|
+
searchblok_id?: number | undefined;
|
|
660
|
+
duplicatable?: boolean | undefined;
|
|
661
|
+
billing_address?: {} | undefined;
|
|
662
|
+
routes?: Array<string> | undefined;
|
|
663
|
+
default_root?: string | undefined;
|
|
664
|
+
languages?: Array<{
|
|
665
|
+
code?: string | undefined;
|
|
666
|
+
name?: string | undefined;
|
|
667
|
+
ai_translation_code?: string | undefined;
|
|
668
|
+
}> | undefined;
|
|
669
|
+
crawl_config?: {
|
|
670
|
+
base_url?: string | undefined;
|
|
671
|
+
enabled?: boolean | undefined;
|
|
672
|
+
} | undefined;
|
|
673
|
+
required_assest_fields?: Array<string> | undefined;
|
|
674
|
+
asset_custom_meta_data_schema?: Array<{
|
|
675
|
+
key?: string | undefined;
|
|
676
|
+
display_name?: string | undefined;
|
|
677
|
+
regex?: string | undefined;
|
|
678
|
+
regex_message?: string | undefined;
|
|
679
|
+
required?: boolean | undefined;
|
|
680
|
+
translatable?: boolean | undefined;
|
|
681
|
+
filetypes?: Array<string> | undefined;
|
|
682
|
+
}> | undefined;
|
|
683
|
+
translatable_asset_fields?: Array<string> | undefined;
|
|
684
|
+
dimensions_app_folder_ids?: Array<number> | undefined;
|
|
685
|
+
disclaimer_id?: number | undefined;
|
|
686
|
+
};
|
|
687
|
+
type UserUpdate = {
|
|
688
|
+
email?: string | undefined;
|
|
689
|
+
alt_email?: string | undefined;
|
|
690
|
+
firstname?: string | undefined;
|
|
691
|
+
lastname?: string | undefined;
|
|
692
|
+
username?: string | undefined;
|
|
693
|
+
avatar?: string | undefined;
|
|
694
|
+
lang?: string | undefined;
|
|
695
|
+
timezone?: string | undefined;
|
|
696
|
+
phone?: string | undefined;
|
|
697
|
+
job_role?: string | undefined;
|
|
698
|
+
job_title?: string | undefined;
|
|
699
|
+
company_name?: string | undefined;
|
|
700
|
+
company_size?: string | undefined;
|
|
701
|
+
usage_type?: string | undefined;
|
|
702
|
+
framework_used?: string | undefined;
|
|
703
|
+
track_statistics?: boolean | undefined;
|
|
704
|
+
ui_theme?: {} | undefined;
|
|
705
|
+
};
|
|
706
|
+
type ComponentCreate = {
|
|
707
|
+
name: string;
|
|
708
|
+
display_name?: string | null | undefined;
|
|
709
|
+
schema?: Record<string, ComponentSchemaField> | undefined;
|
|
710
|
+
is_root?: boolean | undefined;
|
|
711
|
+
is_nestable?: boolean | undefined;
|
|
712
|
+
component_group_uuid?: string | undefined;
|
|
713
|
+
color?: string | undefined;
|
|
714
|
+
icon?: string | undefined;
|
|
715
|
+
preview_field?: string | undefined;
|
|
716
|
+
internal_tag_ids?: Array<string> | undefined;
|
|
717
|
+
};
|
|
718
|
+
type ComponentUpdate = {
|
|
719
|
+
name?: string | undefined;
|
|
720
|
+
display_name?: string | null | undefined;
|
|
721
|
+
schema?: Record<string, ComponentSchemaField> | undefined;
|
|
722
|
+
is_root?: boolean | undefined;
|
|
723
|
+
is_nestable?: boolean | undefined;
|
|
724
|
+
component_group_uuid?: string | undefined;
|
|
725
|
+
color?: string | undefined;
|
|
726
|
+
icon?: string | undefined;
|
|
727
|
+
preview_field?: string | undefined;
|
|
728
|
+
internal_tag_ids?: Array<string> | undefined;
|
|
729
|
+
};
|
|
730
|
+
//#endregion
|
|
731
|
+
export { Asset, AssetCreate, AssetFolder, AssetFolderCreate, AssetFolderUpdate, AssetUpdate, Component, ComponentCreate, ComponentFolder, ComponentFolderCreate, ComponentFolderUpdate, ComponentSchemaField, ComponentUpdate, DatasourceCreate, DatasourceEntry, DatasourceEntryCreate, DatasourceEntryUpdate, DatasourceUpdate, InternalTag, InternalTagCreate, InternalTagUpdate, Preset, PresetCreate, PresetUpdate, Space, SpaceCreate, SpaceUpdate, Story, StoryCreate, StoryUpdate, User, UserUpdate };
|
|
732
|
+
//# sourceMappingURL=mapi-types.d.mts.map
|