@storyblok/management-api-client 0.2.4 → 1.0.0-alpha.1
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/client.cjs +190 -0
- package/dist/client.cjs.map +1 -0
- package/dist/client.d.cts +624 -0
- package/dist/client.d.mts +624 -0
- package/dist/client.mjs +189 -0
- package/dist/client.mjs.map +1 -0
- package/dist/error.cjs.map +1 -1
- package/dist/error.d.cts +12 -2
- package/dist/error.d.mts +12 -2
- package/dist/error.mjs.map +1 -1
- package/dist/generated/asset_folders/types.gen.d.cts +5 -31
- package/dist/generated/asset_folders/types.gen.d.mts +5 -31
- package/dist/generated/assets/types.gen.d.cts +1 -73
- package/dist/generated/assets/types.gen.d.mts +1 -73
- package/dist/generated/component_folders/types.gen.d.cts +29 -45
- package/dist/generated/component_folders/types.gen.d.mts +29 -45
- package/dist/generated/components/types.gen.d.cts +636 -465
- package/dist/generated/components/types.gen.d.mts +636 -465
- package/dist/generated/datasource_entries/types.gen.d.cts +6 -32
- package/dist/generated/datasource_entries/types.gen.d.mts +6 -32
- package/dist/generated/datasources/types.gen.d.cts +18 -39
- package/dist/generated/datasources/types.gen.d.mts +18 -39
- package/dist/generated/internal_tags/types.gen.d.cts +28 -32
- package/dist/generated/internal_tags/types.gen.d.mts +28 -32
- package/dist/generated/presets/types.gen.d.cts +53 -58
- package/dist/generated/presets/types.gen.d.mts +53 -58
- package/dist/generated/spaces/types.gen.d.cts +1 -41
- package/dist/generated/spaces/types.gen.d.mts +1 -41
- package/dist/generated/stories/types.gen.d.cts +206 -198
- package/dist/generated/stories/types.gen.d.mts +206 -198
- package/dist/generated/users/types.gen.d.cts +13 -112
- package/dist/generated/users/types.gen.d.mts +13 -112
- package/dist/index.cjs +3 -178
- package/dist/index.d.cts +8 -425
- package/dist/index.d.mts +8 -425
- package/dist/index.mjs +2 -176
- package/dist/resources/asset-folders.cjs.map +1 -1
- package/dist/resources/asset-folders.mjs.map +1 -1
- package/dist/resources/assets.cjs +11 -2
- package/dist/resources/assets.cjs.map +1 -1
- package/dist/resources/assets.d.cts +3 -2
- package/dist/resources/assets.d.mts +3 -2
- package/dist/resources/assets.mjs +11 -2
- package/dist/resources/assets.mjs.map +1 -1
- package/dist/resources/component-folders.cjs.map +1 -1
- package/dist/resources/component-folders.mjs.map +1 -1
- package/dist/resources/components.cjs.map +1 -1
- package/dist/resources/components.mjs.map +1 -1
- package/dist/resources/datasource-entries.cjs.map +1 -1
- package/dist/resources/datasource-entries.mjs.map +1 -1
- package/dist/resources/datasources.cjs.map +1 -1
- package/dist/resources/datasources.mjs.map +1 -1
- package/dist/resources/internal-tags.cjs.map +1 -1
- package/dist/resources/internal-tags.mjs.map +1 -1
- package/dist/resources/presets.cjs.map +1 -1
- package/dist/resources/presets.mjs.map +1 -1
- package/dist/resources/spaces.cjs.map +1 -1
- package/dist/resources/spaces.mjs.map +1 -1
- package/dist/resources/stories.cjs.map +1 -1
- package/dist/resources/stories.d.cts +105 -0
- package/dist/resources/stories.d.mts +105 -0
- package/dist/resources/stories.mjs.map +1 -1
- package/dist/resources/users.cjs.map +1 -1
- package/dist/resources/users.mjs.map +1 -1
- package/package.json +13 -10
- package/test/GUIDE.md +59 -0
- package/test/setup.e2e.ts +11 -0
- package/test/specs/mapi-round-trip.spec.e2e.ts +520 -0
- package/vitest.config.e2e.ts +26 -0
- package/vitest.config.ts +3 -0
- package/dist/index.cjs.map +0 -1
- package/dist/index.mjs.map +0 -1
- package/dist/types.d.cts +0 -130
- package/dist/types.d.mts +0 -130
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
//#region src/generated/presets/types.gen.d.ts
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Input for creating a preset.
|
|
4
4
|
*/
|
|
5
|
-
type
|
|
6
|
-
/**
|
|
7
|
-
* Numeric ID of your preset
|
|
8
|
-
*/
|
|
9
|
-
readonly id: number;
|
|
5
|
+
type PresetCreate = {
|
|
10
6
|
/**
|
|
11
7
|
* Given name of your preset
|
|
12
8
|
*/
|
|
13
9
|
name: string;
|
|
10
|
+
/**
|
|
11
|
+
* The ID of the component the preset is for
|
|
12
|
+
*/
|
|
13
|
+
component_id: number;
|
|
14
14
|
/**
|
|
15
15
|
* Fields of the component filled with content
|
|
16
16
|
*/
|
|
@@ -18,21 +18,40 @@ type Preset = {
|
|
|
18
18
|
[key: string]: unknown;
|
|
19
19
|
};
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* Screenshot or other preview image for your editor
|
|
22
22
|
*/
|
|
23
|
-
|
|
23
|
+
image?: string;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* Color of the preset icon
|
|
26
26
|
*/
|
|
27
|
-
|
|
27
|
+
color?: string;
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* Icon of the preset
|
|
30
30
|
*/
|
|
31
|
-
|
|
31
|
+
icon?: string;
|
|
32
32
|
/**
|
|
33
|
-
*
|
|
33
|
+
* A description of the preset for the editors
|
|
34
34
|
*/
|
|
35
|
-
|
|
35
|
+
description?: string;
|
|
36
|
+
};
|
|
37
|
+
/**
|
|
38
|
+
* Input for updating a preset.
|
|
39
|
+
*/
|
|
40
|
+
type PresetUpdate = {
|
|
41
|
+
/**
|
|
42
|
+
* Given name of your preset
|
|
43
|
+
*/
|
|
44
|
+
name?: string;
|
|
45
|
+
/**
|
|
46
|
+
* The ID of the component the preset is for
|
|
47
|
+
*/
|
|
48
|
+
component_id?: number;
|
|
49
|
+
/**
|
|
50
|
+
* Fields of the component filled with content
|
|
51
|
+
*/
|
|
52
|
+
preset?: {
|
|
53
|
+
[key: string]: unknown;
|
|
54
|
+
};
|
|
36
55
|
/**
|
|
37
56
|
* Screenshot or other preview image for your editor
|
|
38
57
|
*/
|
|
@@ -53,7 +72,11 @@ type Preset = {
|
|
|
53
72
|
/**
|
|
54
73
|
* A Preset Object representing a content preset
|
|
55
74
|
*/
|
|
56
|
-
type
|
|
75
|
+
type Preset = {
|
|
76
|
+
/**
|
|
77
|
+
* Numeric ID of your preset
|
|
78
|
+
*/
|
|
79
|
+
readonly id: number;
|
|
57
80
|
/**
|
|
58
81
|
* Given name of your preset
|
|
59
82
|
*/
|
|
@@ -68,6 +91,18 @@ type PresetWritable = {
|
|
|
68
91
|
* The ID of the component the preset is for
|
|
69
92
|
*/
|
|
70
93
|
component_id: number;
|
|
94
|
+
/**
|
|
95
|
+
* Numeric ID of a space
|
|
96
|
+
*/
|
|
97
|
+
readonly space_id?: number;
|
|
98
|
+
/**
|
|
99
|
+
* Creation date
|
|
100
|
+
*/
|
|
101
|
+
readonly created_at?: string;
|
|
102
|
+
/**
|
|
103
|
+
* Latest update date
|
|
104
|
+
*/
|
|
105
|
+
readonly updated_at?: string;
|
|
71
106
|
/**
|
|
72
107
|
* Screenshot or other preview image for your editor
|
|
73
108
|
*/
|
|
@@ -101,17 +136,9 @@ type ListData = {
|
|
|
101
136
|
};
|
|
102
137
|
url: '/v1/spaces/{space_id}/presets';
|
|
103
138
|
};
|
|
104
|
-
type ListResponses = {
|
|
105
|
-
/**
|
|
106
|
-
* Successfully retrieved presets
|
|
107
|
-
*/
|
|
108
|
-
200: {
|
|
109
|
-
presets: Array<Preset>;
|
|
110
|
-
};
|
|
111
|
-
};
|
|
112
139
|
type CreateData = {
|
|
113
140
|
body: {
|
|
114
|
-
preset?:
|
|
141
|
+
preset?: PresetCreate;
|
|
115
142
|
};
|
|
116
143
|
path: {
|
|
117
144
|
/**
|
|
@@ -122,33 +149,9 @@ type CreateData = {
|
|
|
122
149
|
query?: never;
|
|
123
150
|
url: '/v1/spaces/{space_id}/presets';
|
|
124
151
|
};
|
|
125
|
-
type CreateResponses = {
|
|
126
|
-
/**
|
|
127
|
-
* Successfully created preset
|
|
128
|
-
*/
|
|
129
|
-
201: {
|
|
130
|
-
preset?: Preset;
|
|
131
|
-
};
|
|
132
|
-
};
|
|
133
|
-
type DeleteResponses = {
|
|
134
|
-
/**
|
|
135
|
-
* Successfully deleted preset
|
|
136
|
-
*/
|
|
137
|
-
200: {
|
|
138
|
-
preset?: Preset;
|
|
139
|
-
};
|
|
140
|
-
};
|
|
141
|
-
type GetResponses = {
|
|
142
|
-
/**
|
|
143
|
-
* Successfully retrieved preset
|
|
144
|
-
*/
|
|
145
|
-
200: {
|
|
146
|
-
preset?: Preset;
|
|
147
|
-
};
|
|
148
|
-
};
|
|
149
152
|
type UpdateData = {
|
|
150
153
|
body: {
|
|
151
|
-
preset?:
|
|
154
|
+
preset?: PresetUpdate;
|
|
152
155
|
};
|
|
153
156
|
path: {
|
|
154
157
|
/**
|
|
@@ -163,14 +166,6 @@ type UpdateData = {
|
|
|
163
166
|
query?: never;
|
|
164
167
|
url: '/v1/spaces/{space_id}/presets/{preset_id}';
|
|
165
168
|
};
|
|
166
|
-
type UpdateResponses = {
|
|
167
|
-
/**
|
|
168
|
-
* Successfully updated preset
|
|
169
|
-
*/
|
|
170
|
-
200: {
|
|
171
|
-
preset?: Preset;
|
|
172
|
-
};
|
|
173
|
-
};
|
|
174
169
|
//#endregion
|
|
175
|
-
export { CreateData,
|
|
170
|
+
export { CreateData, ListData, Preset, UpdateData };
|
|
176
171
|
//# sourceMappingURL=types.gen.d.cts.map
|
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
//#region src/generated/presets/types.gen.d.ts
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Input for creating a preset.
|
|
4
4
|
*/
|
|
5
|
-
type
|
|
6
|
-
/**
|
|
7
|
-
* Numeric ID of your preset
|
|
8
|
-
*/
|
|
9
|
-
readonly id: number;
|
|
5
|
+
type PresetCreate = {
|
|
10
6
|
/**
|
|
11
7
|
* Given name of your preset
|
|
12
8
|
*/
|
|
13
9
|
name: string;
|
|
10
|
+
/**
|
|
11
|
+
* The ID of the component the preset is for
|
|
12
|
+
*/
|
|
13
|
+
component_id: number;
|
|
14
14
|
/**
|
|
15
15
|
* Fields of the component filled with content
|
|
16
16
|
*/
|
|
@@ -18,21 +18,40 @@ type Preset = {
|
|
|
18
18
|
[key: string]: unknown;
|
|
19
19
|
};
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* Screenshot or other preview image for your editor
|
|
22
22
|
*/
|
|
23
|
-
|
|
23
|
+
image?: string;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* Color of the preset icon
|
|
26
26
|
*/
|
|
27
|
-
|
|
27
|
+
color?: string;
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* Icon of the preset
|
|
30
30
|
*/
|
|
31
|
-
|
|
31
|
+
icon?: string;
|
|
32
32
|
/**
|
|
33
|
-
*
|
|
33
|
+
* A description of the preset for the editors
|
|
34
34
|
*/
|
|
35
|
-
|
|
35
|
+
description?: string;
|
|
36
|
+
};
|
|
37
|
+
/**
|
|
38
|
+
* Input for updating a preset.
|
|
39
|
+
*/
|
|
40
|
+
type PresetUpdate = {
|
|
41
|
+
/**
|
|
42
|
+
* Given name of your preset
|
|
43
|
+
*/
|
|
44
|
+
name?: string;
|
|
45
|
+
/**
|
|
46
|
+
* The ID of the component the preset is for
|
|
47
|
+
*/
|
|
48
|
+
component_id?: number;
|
|
49
|
+
/**
|
|
50
|
+
* Fields of the component filled with content
|
|
51
|
+
*/
|
|
52
|
+
preset?: {
|
|
53
|
+
[key: string]: unknown;
|
|
54
|
+
};
|
|
36
55
|
/**
|
|
37
56
|
* Screenshot or other preview image for your editor
|
|
38
57
|
*/
|
|
@@ -53,7 +72,11 @@ type Preset = {
|
|
|
53
72
|
/**
|
|
54
73
|
* A Preset Object representing a content preset
|
|
55
74
|
*/
|
|
56
|
-
type
|
|
75
|
+
type Preset = {
|
|
76
|
+
/**
|
|
77
|
+
* Numeric ID of your preset
|
|
78
|
+
*/
|
|
79
|
+
readonly id: number;
|
|
57
80
|
/**
|
|
58
81
|
* Given name of your preset
|
|
59
82
|
*/
|
|
@@ -68,6 +91,18 @@ type PresetWritable = {
|
|
|
68
91
|
* The ID of the component the preset is for
|
|
69
92
|
*/
|
|
70
93
|
component_id: number;
|
|
94
|
+
/**
|
|
95
|
+
* Numeric ID of a space
|
|
96
|
+
*/
|
|
97
|
+
readonly space_id?: number;
|
|
98
|
+
/**
|
|
99
|
+
* Creation date
|
|
100
|
+
*/
|
|
101
|
+
readonly created_at?: string;
|
|
102
|
+
/**
|
|
103
|
+
* Latest update date
|
|
104
|
+
*/
|
|
105
|
+
readonly updated_at?: string;
|
|
71
106
|
/**
|
|
72
107
|
* Screenshot or other preview image for your editor
|
|
73
108
|
*/
|
|
@@ -101,17 +136,9 @@ type ListData = {
|
|
|
101
136
|
};
|
|
102
137
|
url: '/v1/spaces/{space_id}/presets';
|
|
103
138
|
};
|
|
104
|
-
type ListResponses = {
|
|
105
|
-
/**
|
|
106
|
-
* Successfully retrieved presets
|
|
107
|
-
*/
|
|
108
|
-
200: {
|
|
109
|
-
presets: Array<Preset>;
|
|
110
|
-
};
|
|
111
|
-
};
|
|
112
139
|
type CreateData = {
|
|
113
140
|
body: {
|
|
114
|
-
preset?:
|
|
141
|
+
preset?: PresetCreate;
|
|
115
142
|
};
|
|
116
143
|
path: {
|
|
117
144
|
/**
|
|
@@ -122,33 +149,9 @@ type CreateData = {
|
|
|
122
149
|
query?: never;
|
|
123
150
|
url: '/v1/spaces/{space_id}/presets';
|
|
124
151
|
};
|
|
125
|
-
type CreateResponses = {
|
|
126
|
-
/**
|
|
127
|
-
* Successfully created preset
|
|
128
|
-
*/
|
|
129
|
-
201: {
|
|
130
|
-
preset?: Preset;
|
|
131
|
-
};
|
|
132
|
-
};
|
|
133
|
-
type DeleteResponses = {
|
|
134
|
-
/**
|
|
135
|
-
* Successfully deleted preset
|
|
136
|
-
*/
|
|
137
|
-
200: {
|
|
138
|
-
preset?: Preset;
|
|
139
|
-
};
|
|
140
|
-
};
|
|
141
|
-
type GetResponses = {
|
|
142
|
-
/**
|
|
143
|
-
* Successfully retrieved preset
|
|
144
|
-
*/
|
|
145
|
-
200: {
|
|
146
|
-
preset?: Preset;
|
|
147
|
-
};
|
|
148
|
-
};
|
|
149
152
|
type UpdateData = {
|
|
150
153
|
body: {
|
|
151
|
-
preset?:
|
|
154
|
+
preset?: PresetUpdate;
|
|
152
155
|
};
|
|
153
156
|
path: {
|
|
154
157
|
/**
|
|
@@ -163,14 +166,6 @@ type UpdateData = {
|
|
|
163
166
|
query?: never;
|
|
164
167
|
url: '/v1/spaces/{space_id}/presets/{preset_id}';
|
|
165
168
|
};
|
|
166
|
-
type UpdateResponses = {
|
|
167
|
-
/**
|
|
168
|
-
* Successfully updated preset
|
|
169
|
-
*/
|
|
170
|
-
200: {
|
|
171
|
-
preset?: Preset;
|
|
172
|
-
};
|
|
173
|
-
};
|
|
174
169
|
//#endregion
|
|
175
|
-
export { CreateData,
|
|
170
|
+
export { CreateData, ListData, Preset, UpdateData };
|
|
176
171
|
//# sourceMappingURL=types.gen.d.mts.map
|
|
@@ -462,14 +462,6 @@ type ListData = {
|
|
|
462
462
|
};
|
|
463
463
|
url: '/v1/spaces';
|
|
464
464
|
};
|
|
465
|
-
type ListResponses = {
|
|
466
|
-
/**
|
|
467
|
-
* List of spaces
|
|
468
|
-
*/
|
|
469
|
-
200: {
|
|
470
|
-
spaces?: Array<Space>;
|
|
471
|
-
};
|
|
472
|
-
};
|
|
473
465
|
type CreateData = {
|
|
474
466
|
body: {
|
|
475
467
|
space: SpaceCreate;
|
|
@@ -494,30 +486,6 @@ type CreateData = {
|
|
|
494
486
|
query?: never;
|
|
495
487
|
url: '/v1/spaces';
|
|
496
488
|
};
|
|
497
|
-
type CreateResponses = {
|
|
498
|
-
/**
|
|
499
|
-
* Space created
|
|
500
|
-
*/
|
|
501
|
-
201: {
|
|
502
|
-
space?: Space;
|
|
503
|
-
};
|
|
504
|
-
};
|
|
505
|
-
type DeleteResponses = {
|
|
506
|
-
/**
|
|
507
|
-
* Space deleted
|
|
508
|
-
*/
|
|
509
|
-
200: {
|
|
510
|
-
space?: Space;
|
|
511
|
-
};
|
|
512
|
-
};
|
|
513
|
-
type GetResponses = {
|
|
514
|
-
/**
|
|
515
|
-
* Space details
|
|
516
|
-
*/
|
|
517
|
-
200: {
|
|
518
|
-
space?: Space;
|
|
519
|
-
};
|
|
520
|
-
};
|
|
521
489
|
type UpdateData = {
|
|
522
490
|
body: {
|
|
523
491
|
space: SpaceUpdate;
|
|
@@ -531,14 +499,6 @@ type UpdateData = {
|
|
|
531
499
|
query?: never;
|
|
532
500
|
url: '/v1/spaces/{space_id}';
|
|
533
501
|
};
|
|
534
|
-
type UpdateResponses = {
|
|
535
|
-
/**
|
|
536
|
-
* Space updated
|
|
537
|
-
*/
|
|
538
|
-
200: {
|
|
539
|
-
space?: Space;
|
|
540
|
-
};
|
|
541
|
-
};
|
|
542
502
|
//#endregion
|
|
543
|
-
export { CreateData,
|
|
503
|
+
export { CreateData, ListData, Space, UpdateData };
|
|
544
504
|
//# sourceMappingURL=types.gen.d.cts.map
|
|
@@ -462,14 +462,6 @@ type ListData = {
|
|
|
462
462
|
};
|
|
463
463
|
url: '/v1/spaces';
|
|
464
464
|
};
|
|
465
|
-
type ListResponses = {
|
|
466
|
-
/**
|
|
467
|
-
* List of spaces
|
|
468
|
-
*/
|
|
469
|
-
200: {
|
|
470
|
-
spaces?: Array<Space>;
|
|
471
|
-
};
|
|
472
|
-
};
|
|
473
465
|
type CreateData = {
|
|
474
466
|
body: {
|
|
475
467
|
space: SpaceCreate;
|
|
@@ -494,30 +486,6 @@ type CreateData = {
|
|
|
494
486
|
query?: never;
|
|
495
487
|
url: '/v1/spaces';
|
|
496
488
|
};
|
|
497
|
-
type CreateResponses = {
|
|
498
|
-
/**
|
|
499
|
-
* Space created
|
|
500
|
-
*/
|
|
501
|
-
201: {
|
|
502
|
-
space?: Space;
|
|
503
|
-
};
|
|
504
|
-
};
|
|
505
|
-
type DeleteResponses = {
|
|
506
|
-
/**
|
|
507
|
-
* Space deleted
|
|
508
|
-
*/
|
|
509
|
-
200: {
|
|
510
|
-
space?: Space;
|
|
511
|
-
};
|
|
512
|
-
};
|
|
513
|
-
type GetResponses = {
|
|
514
|
-
/**
|
|
515
|
-
* Space details
|
|
516
|
-
*/
|
|
517
|
-
200: {
|
|
518
|
-
space?: Space;
|
|
519
|
-
};
|
|
520
|
-
};
|
|
521
489
|
type UpdateData = {
|
|
522
490
|
body: {
|
|
523
491
|
space: SpaceUpdate;
|
|
@@ -531,14 +499,6 @@ type UpdateData = {
|
|
|
531
499
|
query?: never;
|
|
532
500
|
url: '/v1/spaces/{space_id}';
|
|
533
501
|
};
|
|
534
|
-
type UpdateResponses = {
|
|
535
|
-
/**
|
|
536
|
-
* Space updated
|
|
537
|
-
*/
|
|
538
|
-
200: {
|
|
539
|
-
space?: Space;
|
|
540
|
-
};
|
|
541
|
-
};
|
|
542
502
|
//#endregion
|
|
543
|
-
export { CreateData,
|
|
503
|
+
export { CreateData, ListData, Space, UpdateData };
|
|
544
504
|
//# sourceMappingURL=types.gen.d.mts.map
|