@storyblok/management-api-client 1.0.0-alpha.2 → 1.0.0-alpha.4

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 (54) hide show
  1. package/dist/client.cjs +6 -0
  2. package/dist/client.cjs.map +1 -1
  3. package/dist/client.d.cts +133 -7
  4. package/dist/client.d.mts +133 -7
  5. package/dist/client.mjs +6 -0
  6. package/dist/client.mjs.map +1 -1
  7. package/dist/generated/mapi/_internal.gen.d.cts +1 -171
  8. package/dist/generated/mapi/_internal.gen.d.mts +1 -171
  9. package/dist/generated/mapi/types-aliased.gen.d.cts +171 -1
  10. package/dist/generated/mapi/types-aliased.gen.d.mts +171 -1
  11. package/dist/generated/types/block.d.cts +27 -8
  12. package/dist/generated/types/block.d.mts +27 -8
  13. package/dist/generated/types/field.d.cts +45 -17
  14. package/dist/generated/types/field.d.mts +45 -17
  15. package/dist/generated/types/mapi-story.d.cts +6 -6
  16. package/dist/generated/types/mapi-story.d.mts +6 -6
  17. package/dist/index.d.cts +6 -4
  18. package/dist/index.d.mts +6 -4
  19. package/dist/resources/assets.cjs +1 -0
  20. package/dist/resources/assets.cjs.map +1 -1
  21. package/dist/resources/assets.mjs +1 -1
  22. package/dist/resources/assets.mjs.map +1 -1
  23. package/dist/resources/components.cjs.map +1 -1
  24. package/dist/resources/components.d.cts +17 -17
  25. package/dist/resources/components.d.mts +17 -17
  26. package/dist/resources/components.mjs.map +1 -1
  27. package/dist/resources/shared-asset-folders.cjs +81 -0
  28. package/dist/resources/shared-asset-folders.cjs.map +1 -0
  29. package/dist/resources/shared-asset-folders.d.cts +41 -0
  30. package/dist/resources/shared-asset-folders.d.mts +41 -0
  31. package/dist/resources/shared-asset-folders.mjs +81 -0
  32. package/dist/resources/shared-asset-folders.mjs.map +1 -0
  33. package/dist/resources/shared-assets.cjs +197 -0
  34. package/dist/resources/shared-assets.cjs.map +1 -0
  35. package/dist/resources/shared-assets.d.cts +29 -0
  36. package/dist/resources/shared-assets.d.mts +28 -0
  37. package/dist/resources/shared-assets.mjs +197 -0
  38. package/dist/resources/shared-assets.mjs.map +1 -0
  39. package/dist/resources/shared-internal-tags.cjs +73 -0
  40. package/dist/resources/shared-internal-tags.cjs.map +1 -0
  41. package/dist/resources/shared-internal-tags.d.cts +32 -0
  42. package/dist/resources/shared-internal-tags.d.mts +32 -0
  43. package/dist/resources/shared-internal-tags.mjs +73 -0
  44. package/dist/resources/shared-internal-tags.mjs.map +1 -0
  45. package/dist/resources/stories.cjs.map +1 -1
  46. package/dist/resources/stories.d.cts +26 -26
  47. package/dist/resources/stories.d.mts +26 -26
  48. package/dist/resources/stories.mjs.map +1 -1
  49. package/package.json +3 -3
  50. package/playground/integration-tests/test/specs/mapi-round-trip.spec.e2e.ts +30 -40
  51. package/playground/integration-tests/test/types/components.test-d.ts +7 -46
  52. package/playground/integration-tests/test/types/resources.test-d.ts +0 -152
  53. package/playground/integration-tests/test/types/stories.test-d.ts +47 -43
  54. package/test/GUIDE.md +2 -2
@@ -1,174 +1,4 @@
1
1
  //#region src/generated/mapi/_internal.gen.d.ts
2
- type ComponentCreate = {
3
- /**
4
- * Name of the component
5
- */
6
- name: string;
7
- /**
8
- * Human-readable display name
9
- */
10
- display_name?: string;
11
- /**
12
- * Component description
13
- */
14
- description?: string;
15
- /**
16
- * Preview template HTML
17
- */
18
- preview_tmpl?: string;
19
- /**
20
- * Component image URL
21
- */
22
- image?: string;
23
- /**
24
- * Field used for preview
25
- */
26
- preview_field?: string;
27
- /**
28
- * Whether this component can be used as a root component
29
- */
30
- is_root?: boolean;
31
- /**
32
- * Whether this component can be nested inside other components
33
- */
34
- is_nestable?: boolean;
35
- /**
36
- * Default preset ID
37
- */
38
- preset_id?: number;
39
- /**
40
- * UUID
41
- */
42
- component_group_uuid?: string;
43
- /**
44
- * Component color for UI display
45
- */
46
- color?: string;
47
- /**
48
- * Component icon name
49
- */
50
- icon?: string;
51
- /**
52
- * Asset preview URL for content type
53
- */
54
- content_type_asset_preview?: string;
55
- /**
56
- * List of internal tag IDs
57
- */
58
- internal_tag_ids?: Array<number>;
59
- /**
60
- * Component field schema definition
61
- */
62
- schema?: {
63
- [key: string]: {
64
- type?: 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group';
65
- /**
66
- * Human-readable field name
67
- */
68
- display_name?: string;
69
- /**
70
- * Whether this field is required
71
- */
72
- required?: boolean;
73
- /**
74
- * Whether this field is translatable
75
- */
76
- translatable?: boolean;
77
- [key: string]: unknown | 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group' | string | boolean | undefined;
78
- };
79
- };
80
- /**
81
- * Component metadata
82
- */
83
- metadata?: {
84
- [key: string]: unknown;
85
- };
86
- };
87
- type ComponentUpdate = {
88
- /**
89
- * Name of the component
90
- */
91
- name?: string;
92
- /**
93
- * Human-readable display name
94
- */
95
- display_name?: string;
96
- /**
97
- * Component description
98
- */
99
- description?: string;
100
- /**
101
- * Preview template HTML
102
- */
103
- preview_tmpl?: string;
104
- /**
105
- * Component image URL
106
- */
107
- image?: string;
108
- /**
109
- * Field used for preview
110
- */
111
- preview_field?: string;
112
- /**
113
- * Whether this component can be used as a root component
114
- */
115
- is_root?: boolean;
116
- /**
117
- * Whether this component can be nested inside other components
118
- */
119
- is_nestable?: boolean;
120
- /**
121
- * Default preset ID
122
- */
123
- preset_id?: number;
124
- /**
125
- * UUID
126
- */
127
- component_group_uuid?: string;
128
- /**
129
- * Component color for UI display
130
- */
131
- color?: string;
132
- /**
133
- * Component icon name
134
- */
135
- icon?: string;
136
- /**
137
- * Asset preview URL for content type
138
- */
139
- content_type_asset_preview?: string;
140
- /**
141
- * List of internal tag IDs
142
- */
143
- internal_tag_ids?: Array<number>;
144
- /**
145
- * Component field schema definition
146
- */
147
- schema?: {
148
- [key: string]: {
149
- type?: 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group';
150
- /**
151
- * Human-readable field name
152
- */
153
- display_name?: string;
154
- /**
155
- * Whether this field is required
156
- */
157
- required?: boolean;
158
- /**
159
- * Whether this field is translatable
160
- */
161
- translatable?: boolean;
162
- [key: string]: unknown | 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group' | string | boolean | undefined;
163
- };
164
- };
165
- /**
166
- * Component metadata
167
- */
168
- metadata?: {
169
- [key: string]: unknown;
170
- };
171
- };
172
2
  type MapiStory = {
173
3
  name: string;
174
4
  /**
@@ -537,5 +367,5 @@ type Stage = {
537
367
  created_at: string;
538
368
  };
539
369
  //#endregion
540
- export { ComponentCreate, ComponentUpdate, MapiStory, StoryCreate, StoryUpdate };
370
+ export { MapiStory, StoryCreate, StoryUpdate };
541
371
  //# sourceMappingURL=_internal.gen.d.cts.map
@@ -1,174 +1,4 @@
1
1
  //#region src/generated/mapi/_internal.gen.d.ts
2
- type ComponentCreate = {
3
- /**
4
- * Name of the component
5
- */
6
- name: string;
7
- /**
8
- * Human-readable display name
9
- */
10
- display_name?: string;
11
- /**
12
- * Component description
13
- */
14
- description?: string;
15
- /**
16
- * Preview template HTML
17
- */
18
- preview_tmpl?: string;
19
- /**
20
- * Component image URL
21
- */
22
- image?: string;
23
- /**
24
- * Field used for preview
25
- */
26
- preview_field?: string;
27
- /**
28
- * Whether this component can be used as a root component
29
- */
30
- is_root?: boolean;
31
- /**
32
- * Whether this component can be nested inside other components
33
- */
34
- is_nestable?: boolean;
35
- /**
36
- * Default preset ID
37
- */
38
- preset_id?: number;
39
- /**
40
- * UUID
41
- */
42
- component_group_uuid?: string;
43
- /**
44
- * Component color for UI display
45
- */
46
- color?: string;
47
- /**
48
- * Component icon name
49
- */
50
- icon?: string;
51
- /**
52
- * Asset preview URL for content type
53
- */
54
- content_type_asset_preview?: string;
55
- /**
56
- * List of internal tag IDs
57
- */
58
- internal_tag_ids?: Array<number>;
59
- /**
60
- * Component field schema definition
61
- */
62
- schema?: {
63
- [key: string]: {
64
- type?: 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group';
65
- /**
66
- * Human-readable field name
67
- */
68
- display_name?: string;
69
- /**
70
- * Whether this field is required
71
- */
72
- required?: boolean;
73
- /**
74
- * Whether this field is translatable
75
- */
76
- translatable?: boolean;
77
- [key: string]: unknown | 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group' | string | boolean | undefined;
78
- };
79
- };
80
- /**
81
- * Component metadata
82
- */
83
- metadata?: {
84
- [key: string]: unknown;
85
- };
86
- };
87
- type ComponentUpdate = {
88
- /**
89
- * Name of the component
90
- */
91
- name?: string;
92
- /**
93
- * Human-readable display name
94
- */
95
- display_name?: string;
96
- /**
97
- * Component description
98
- */
99
- description?: string;
100
- /**
101
- * Preview template HTML
102
- */
103
- preview_tmpl?: string;
104
- /**
105
- * Component image URL
106
- */
107
- image?: string;
108
- /**
109
- * Field used for preview
110
- */
111
- preview_field?: string;
112
- /**
113
- * Whether this component can be used as a root component
114
- */
115
- is_root?: boolean;
116
- /**
117
- * Whether this component can be nested inside other components
118
- */
119
- is_nestable?: boolean;
120
- /**
121
- * Default preset ID
122
- */
123
- preset_id?: number;
124
- /**
125
- * UUID
126
- */
127
- component_group_uuid?: string;
128
- /**
129
- * Component color for UI display
130
- */
131
- color?: string;
132
- /**
133
- * Component icon name
134
- */
135
- icon?: string;
136
- /**
137
- * Asset preview URL for content type
138
- */
139
- content_type_asset_preview?: string;
140
- /**
141
- * List of internal tag IDs
142
- */
143
- internal_tag_ids?: Array<number>;
144
- /**
145
- * Component field schema definition
146
- */
147
- schema?: {
148
- [key: string]: {
149
- type?: 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group';
150
- /**
151
- * Human-readable field name
152
- */
153
- display_name?: string;
154
- /**
155
- * Whether this field is required
156
- */
157
- required?: boolean;
158
- /**
159
- * Whether this field is translatable
160
- */
161
- translatable?: boolean;
162
- [key: string]: unknown | 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group' | string | boolean | undefined;
163
- };
164
- };
165
- /**
166
- * Component metadata
167
- */
168
- metadata?: {
169
- [key: string]: unknown;
170
- };
171
- };
172
2
  type MapiStory = {
173
3
  name: string;
174
4
  /**
@@ -537,5 +367,5 @@ type Stage = {
537
367
  created_at: string;
538
368
  };
539
369
  //#endregion
540
- export { ComponentCreate, ComponentUpdate, MapiStory, StoryCreate, StoryUpdate };
370
+ export { MapiStory, StoryCreate, StoryUpdate };
541
371
  //# sourceMappingURL=_internal.gen.d.mts.map
@@ -141,6 +141,176 @@ type Component = {
141
141
  [key: string]: unknown;
142
142
  } | null;
143
143
  };
144
+ type ComponentCreate = {
145
+ /**
146
+ * Name of the component
147
+ */
148
+ name: string;
149
+ /**
150
+ * Human-readable display name
151
+ */
152
+ display_name?: string;
153
+ /**
154
+ * Component description
155
+ */
156
+ description?: string;
157
+ /**
158
+ * Preview template HTML
159
+ */
160
+ preview_tmpl?: string;
161
+ /**
162
+ * Component image URL
163
+ */
164
+ image?: string;
165
+ /**
166
+ * Field used for preview
167
+ */
168
+ preview_field?: string;
169
+ /**
170
+ * Whether this component can be used as a root component
171
+ */
172
+ is_root?: boolean;
173
+ /**
174
+ * Whether this component can be nested inside other components
175
+ */
176
+ is_nestable?: boolean;
177
+ /**
178
+ * Default preset ID
179
+ */
180
+ preset_id?: number;
181
+ /**
182
+ * UUID
183
+ */
184
+ component_group_uuid?: string;
185
+ /**
186
+ * Component color for UI display
187
+ */
188
+ color?: string;
189
+ /**
190
+ * Component icon name
191
+ */
192
+ icon?: string;
193
+ /**
194
+ * Asset preview URL for content type
195
+ */
196
+ content_type_asset_preview?: string;
197
+ /**
198
+ * List of internal tag IDs
199
+ */
200
+ internal_tag_ids?: Array<number>;
201
+ /**
202
+ * Component field schema definition
203
+ */
204
+ schema?: {
205
+ [key: string]: {
206
+ type?: 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group';
207
+ /**
208
+ * Human-readable field name
209
+ */
210
+ display_name?: string;
211
+ /**
212
+ * Whether this field is required
213
+ */
214
+ required?: boolean;
215
+ /**
216
+ * Whether this field is translatable
217
+ */
218
+ translatable?: boolean;
219
+ [key: string]: unknown | 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group' | string | boolean | undefined;
220
+ };
221
+ };
222
+ /**
223
+ * Component metadata
224
+ */
225
+ metadata?: {
226
+ [key: string]: unknown;
227
+ };
228
+ };
229
+ type ComponentUpdate = {
230
+ /**
231
+ * Name of the component
232
+ */
233
+ name?: string;
234
+ /**
235
+ * Human-readable display name
236
+ */
237
+ display_name?: string;
238
+ /**
239
+ * Component description
240
+ */
241
+ description?: string;
242
+ /**
243
+ * Preview template HTML
244
+ */
245
+ preview_tmpl?: string;
246
+ /**
247
+ * Component image URL
248
+ */
249
+ image?: string;
250
+ /**
251
+ * Field used for preview
252
+ */
253
+ preview_field?: string;
254
+ /**
255
+ * Whether this component can be used as a root component
256
+ */
257
+ is_root?: boolean;
258
+ /**
259
+ * Whether this component can be nested inside other components
260
+ */
261
+ is_nestable?: boolean;
262
+ /**
263
+ * Default preset ID
264
+ */
265
+ preset_id?: number;
266
+ /**
267
+ * UUID
268
+ */
269
+ component_group_uuid?: string;
270
+ /**
271
+ * Component color for UI display
272
+ */
273
+ color?: string;
274
+ /**
275
+ * Component icon name
276
+ */
277
+ icon?: string;
278
+ /**
279
+ * Asset preview URL for content type
280
+ */
281
+ content_type_asset_preview?: string;
282
+ /**
283
+ * List of internal tag IDs
284
+ */
285
+ internal_tag_ids?: Array<number>;
286
+ /**
287
+ * Component field schema definition
288
+ */
289
+ schema?: {
290
+ [key: string]: {
291
+ type?: 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group';
292
+ /**
293
+ * Human-readable field name
294
+ */
295
+ display_name?: string;
296
+ /**
297
+ * Whether this field is required
298
+ */
299
+ required?: boolean;
300
+ /**
301
+ * Whether this field is translatable
302
+ */
303
+ translatable?: boolean;
304
+ [key: string]: unknown | 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group' | string | boolean | undefined;
305
+ };
306
+ };
307
+ /**
308
+ * Component metadata
309
+ */
310
+ metadata?: {
311
+ [key: string]: unknown;
312
+ };
313
+ };
144
314
  type Asset = {
145
315
  /**
146
316
  * Id of the asset.
@@ -1424,5 +1594,5 @@ type SpaceRole = {
1424
1594
  blocked_asset_folder_ids: Array<number>;
1425
1595
  };
1426
1596
  //#endregion
1427
- export { Asset, AssetCreate, AssetFolder, AssetFolderCreate, AssetFolderUpdate, AssetUpdate, Component, ComponentFolder, ComponentFolderCreate, ComponentFolderUpdate, DatasourceCreate, DatasourceUpdate, InternalTag, InternalTagCreate, InternalTagUpdate, MapiDatasource, MapiDatasourceEntry, Preset, PresetCreate, PresetUpdate, Space, SpaceCreate, SpaceUpdate, StoryLocalizedPath, StoryTranslatedSlug, User, UserUpdate };
1597
+ export { Asset, AssetCreate, AssetFolder, AssetFolderCreate, AssetFolderUpdate, AssetUpdate, Component, ComponentCreate, ComponentFolder, ComponentFolderCreate, ComponentFolderUpdate, ComponentUpdate, DatasourceCreate, DatasourceUpdate, InternalTag, InternalTagCreate, InternalTagUpdate, MapiDatasource, MapiDatasourceEntry, Preset, PresetCreate, PresetUpdate, Space, SpaceCreate, SpaceUpdate, StoryLocalizedPath, StoryTranslatedSlug, User, UserUpdate };
1428
1598
  //# sourceMappingURL=types-aliased.gen.d.cts.map