@datocms/cma-client 5.1.9 → 5.1.11
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 +575 -0
- package/dist/cjs/fieldTypes/boolean.js +2 -2
- package/dist/cjs/fieldTypes/boolean.js.map +1 -1
- package/dist/cjs/fieldTypes/color.js +2 -2
- package/dist/cjs/fieldTypes/color.js.map +1 -1
- package/dist/cjs/fieldTypes/date.js +2 -3
- package/dist/cjs/fieldTypes/date.js.map +1 -1
- package/dist/cjs/fieldTypes/date_time.js +2 -2
- package/dist/cjs/fieldTypes/date_time.js.map +1 -1
- package/dist/cjs/fieldTypes/file.js +33 -5
- package/dist/cjs/fieldTypes/file.js.map +1 -1
- package/dist/cjs/fieldTypes/float.js +2 -2
- package/dist/cjs/fieldTypes/float.js.map +1 -1
- package/dist/cjs/fieldTypes/gallery.js +20 -5
- package/dist/cjs/fieldTypes/gallery.js.map +1 -1
- package/dist/cjs/fieldTypes/index.js +2 -2
- package/dist/cjs/fieldTypes/index.js.map +1 -1
- package/dist/cjs/fieldTypes/integer.js +2 -2
- package/dist/cjs/fieldTypes/integer.js.map +1 -1
- package/dist/cjs/fieldTypes/json.js +2 -3
- package/dist/cjs/fieldTypes/json.js.map +1 -1
- package/dist/cjs/fieldTypes/lat_lon.js +2 -2
- package/dist/cjs/fieldTypes/lat_lon.js.map +1 -1
- package/dist/cjs/fieldTypes/link.js +4 -4
- package/dist/cjs/fieldTypes/link.js.map +1 -1
- package/dist/cjs/fieldTypes/links.js +5 -3
- package/dist/cjs/fieldTypes/links.js.map +1 -1
- package/dist/cjs/fieldTypes/rich_text.js +4 -6
- package/dist/cjs/fieldTypes/rich_text.js.map +1 -1
- package/dist/cjs/fieldTypes/seo.js +2 -3
- package/dist/cjs/fieldTypes/seo.js.map +1 -1
- package/dist/cjs/fieldTypes/single_block.js +7 -7
- package/dist/cjs/fieldTypes/single_block.js.map +1 -1
- package/dist/cjs/fieldTypes/slug.js +2 -3
- package/dist/cjs/fieldTypes/slug.js.map +1 -1
- package/dist/cjs/fieldTypes/string.js +2 -2
- package/dist/cjs/fieldTypes/string.js.map +1 -1
- package/dist/cjs/fieldTypes/structured_text.js +4 -6
- package/dist/cjs/fieldTypes/structured_text.js.map +1 -1
- package/dist/cjs/fieldTypes/text.js +2 -3
- package/dist/cjs/fieldTypes/text.js.map +1 -1
- package/dist/cjs/fieldTypes/video.js +2 -2
- package/dist/cjs/fieldTypes/video.js.map +1 -1
- package/dist/cjs/generated/Client.js +1 -1
- package/dist/cjs/generated/Client.js.map +1 -1
- package/dist/cjs/generated/resources/Item.js.map +1 -1
- package/dist/cjs/generated/resources/Upload.js.map +1 -1
- package/dist/cjs/index.js +4 -4
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/utilities/buildBlockRecord.js +8 -7
- package/dist/cjs/utilities/buildBlockRecord.js.map +1 -1
- package/dist/cjs/utilities/inspectItem.js +397 -0
- package/dist/cjs/utilities/inspectItem.js.map +1 -0
- package/dist/cjs/utilities/{blocks.js → nonRecursiveBlocks.js} +106 -111
- package/dist/cjs/utilities/nonRecursiveBlocks.js.map +1 -0
- package/dist/cjs/utilities/{fieldValue.js → normalizedFieldValues.js} +53 -41
- package/dist/cjs/utilities/normalizedFieldValues.js.map +1 -0
- package/dist/cjs/utilities/recursiveBlocks.js +121 -80
- package/dist/cjs/utilities/recursiveBlocks.js.map +1 -1
- package/dist/cjs/utilities/schemaRepository.js +2 -2
- package/dist/esm/fieldTypes/boolean.d.ts +1 -1
- package/dist/esm/fieldTypes/boolean.js +2 -2
- package/dist/esm/fieldTypes/boolean.js.map +1 -1
- package/dist/esm/fieldTypes/color.d.ts +1 -1
- package/dist/esm/fieldTypes/color.js +2 -2
- package/dist/esm/fieldTypes/color.js.map +1 -1
- package/dist/esm/fieldTypes/date.d.ts +1 -1
- package/dist/esm/fieldTypes/date.js +2 -3
- package/dist/esm/fieldTypes/date.js.map +1 -1
- package/dist/esm/fieldTypes/date_time.d.ts +1 -1
- package/dist/esm/fieldTypes/date_time.js +2 -2
- package/dist/esm/fieldTypes/date_time.js.map +1 -1
- package/dist/esm/fieldTypes/file.d.ts +68 -1
- package/dist/esm/fieldTypes/file.js +29 -3
- package/dist/esm/fieldTypes/file.js.map +1 -1
- package/dist/esm/fieldTypes/float.d.ts +1 -1
- package/dist/esm/fieldTypes/float.js +2 -2
- package/dist/esm/fieldTypes/float.js.map +1 -1
- package/dist/esm/fieldTypes/gallery.d.ts +27 -11
- package/dist/esm/fieldTypes/gallery.js +17 -4
- package/dist/esm/fieldTypes/gallery.js.map +1 -1
- package/dist/esm/fieldTypes/index.d.ts +2 -2
- package/dist/esm/fieldTypes/index.js +2 -2
- package/dist/esm/fieldTypes/index.js.map +1 -1
- package/dist/esm/fieldTypes/integer.d.ts +1 -1
- package/dist/esm/fieldTypes/integer.js +2 -2
- package/dist/esm/fieldTypes/integer.js.map +1 -1
- package/dist/esm/fieldTypes/json.d.ts +1 -1
- package/dist/esm/fieldTypes/json.js +2 -3
- package/dist/esm/fieldTypes/json.js.map +1 -1
- package/dist/esm/fieldTypes/lat_lon.d.ts +1 -1
- package/dist/esm/fieldTypes/lat_lon.js +2 -2
- package/dist/esm/fieldTypes/lat_lon.js.map +1 -1
- package/dist/esm/fieldTypes/link.d.ts +1 -1
- package/dist/esm/fieldTypes/link.js +4 -4
- package/dist/esm/fieldTypes/link.js.map +1 -1
- package/dist/esm/fieldTypes/links.d.ts +1 -1
- package/dist/esm/fieldTypes/links.js +5 -3
- package/dist/esm/fieldTypes/links.js.map +1 -1
- package/dist/esm/fieldTypes/rich_text.d.ts +1 -1
- package/dist/esm/fieldTypes/rich_text.js +4 -6
- package/dist/esm/fieldTypes/rich_text.js.map +1 -1
- package/dist/esm/fieldTypes/seo.d.ts +1 -1
- package/dist/esm/fieldTypes/seo.js +2 -3
- package/dist/esm/fieldTypes/seo.js.map +1 -1
- package/dist/esm/fieldTypes/single_block.d.ts +3 -3
- package/dist/esm/fieldTypes/single_block.js +7 -7
- package/dist/esm/fieldTypes/single_block.js.map +1 -1
- package/dist/esm/fieldTypes/slug.d.ts +1 -1
- package/dist/esm/fieldTypes/slug.js +2 -3
- package/dist/esm/fieldTypes/slug.js.map +1 -1
- package/dist/esm/fieldTypes/string.d.ts +1 -1
- package/dist/esm/fieldTypes/string.js +2 -2
- package/dist/esm/fieldTypes/string.js.map +1 -1
- package/dist/esm/fieldTypes/structured_text.d.ts +1 -1
- package/dist/esm/fieldTypes/structured_text.js +4 -6
- package/dist/esm/fieldTypes/structured_text.js.map +1 -1
- package/dist/esm/fieldTypes/text.d.ts +1 -1
- package/dist/esm/fieldTypes/text.js +2 -3
- package/dist/esm/fieldTypes/text.js.map +1 -1
- package/dist/esm/fieldTypes/video.d.ts +1 -1
- package/dist/esm/fieldTypes/video.js +2 -2
- package/dist/esm/fieldTypes/video.js.map +1 -1
- package/dist/esm/generated/Client.js +1 -1
- package/dist/esm/generated/Client.js.map +1 -1
- package/dist/esm/generated/resources/Item.d.ts +46 -28
- package/dist/esm/generated/resources/Item.js.map +1 -1
- package/dist/esm/generated/resources/ScheduledPublication.d.ts +3 -3
- package/dist/esm/generated/resources/ScheduledUnpublishing.d.ts +3 -3
- package/dist/esm/generated/resources/Upload.d.ts +10 -4
- package/dist/esm/generated/resources/Upload.js.map +1 -1
- package/dist/esm/index.d.ts +4 -4
- package/dist/esm/index.js +4 -4
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/utilities/buildBlockRecord.d.ts +3 -3
- package/dist/esm/utilities/buildBlockRecord.js +9 -8
- package/dist/esm/utilities/buildBlockRecord.js.map +1 -1
- package/dist/esm/utilities/inspectItem.d.ts +8 -0
- package/dist/esm/utilities/inspectItem.js +393 -0
- package/dist/esm/utilities/inspectItem.js.map +1 -0
- package/dist/esm/utilities/itemDefinition.d.ts +36 -12
- package/dist/esm/utilities/nonRecursiveBlocks.d.ts +179 -0
- package/dist/esm/utilities/{blocks.js → nonRecursiveBlocks.js} +91 -96
- package/dist/esm/utilities/nonRecursiveBlocks.js.map +1 -0
- package/dist/{types/utilities/fieldValue.d.ts → esm/utilities/normalizedFieldValues.d.ts} +15 -14
- package/dist/esm/utilities/{fieldValue.js → normalizedFieldValues.js} +39 -28
- package/dist/esm/utilities/normalizedFieldValues.js.map +1 -0
- package/dist/esm/utilities/recursiveBlocks.d.ts +92 -9
- package/dist/esm/utilities/recursiveBlocks.js +113 -72
- package/dist/esm/utilities/recursiveBlocks.js.map +1 -1
- package/dist/esm/utilities/schemaRepository.d.ts +2 -2
- package/dist/esm/utilities/schemaRepository.js +2 -2
- package/dist/types/fieldTypes/boolean.d.ts +1 -1
- package/dist/types/fieldTypes/color.d.ts +1 -1
- package/dist/types/fieldTypes/date.d.ts +1 -1
- package/dist/types/fieldTypes/date_time.d.ts +1 -1
- package/dist/types/fieldTypes/file.d.ts +68 -1
- package/dist/types/fieldTypes/float.d.ts +1 -1
- package/dist/types/fieldTypes/gallery.d.ts +27 -11
- package/dist/types/fieldTypes/index.d.ts +2 -2
- package/dist/types/fieldTypes/integer.d.ts +1 -1
- package/dist/types/fieldTypes/json.d.ts +1 -1
- package/dist/types/fieldTypes/lat_lon.d.ts +1 -1
- package/dist/types/fieldTypes/link.d.ts +1 -1
- package/dist/types/fieldTypes/links.d.ts +1 -1
- package/dist/types/fieldTypes/rich_text.d.ts +1 -1
- package/dist/types/fieldTypes/seo.d.ts +1 -1
- package/dist/types/fieldTypes/single_block.d.ts +3 -3
- package/dist/types/fieldTypes/slug.d.ts +1 -1
- package/dist/types/fieldTypes/string.d.ts +1 -1
- package/dist/types/fieldTypes/structured_text.d.ts +1 -1
- package/dist/types/fieldTypes/text.d.ts +1 -1
- package/dist/types/fieldTypes/video.d.ts +1 -1
- package/dist/types/generated/resources/Item.d.ts +46 -28
- package/dist/types/generated/resources/ScheduledPublication.d.ts +3 -3
- package/dist/types/generated/resources/ScheduledUnpublishing.d.ts +3 -3
- package/dist/types/generated/resources/Upload.d.ts +10 -4
- package/dist/types/index.d.ts +4 -4
- package/dist/types/utilities/buildBlockRecord.d.ts +3 -3
- package/dist/types/utilities/inspectItem.d.ts +8 -0
- package/dist/types/utilities/itemDefinition.d.ts +36 -12
- package/dist/types/utilities/nonRecursiveBlocks.d.ts +179 -0
- package/dist/{esm/utilities/fieldValue.d.ts → types/utilities/normalizedFieldValues.d.ts} +15 -14
- package/dist/types/utilities/recursiveBlocks.d.ts +92 -9
- package/dist/types/utilities/schemaRepository.d.ts +2 -2
- package/package.json +4 -4
- package/src/fieldTypes/boolean.ts +5 -3
- package/src/fieldTypes/color.ts +5 -3
- package/src/fieldTypes/date.ts +5 -4
- package/src/fieldTypes/date_time.ts +5 -3
- package/src/fieldTypes/file.ts +98 -4
- package/src/fieldTypes/float.ts +5 -3
- package/src/fieldTypes/gallery.ts +53 -20
- package/src/fieldTypes/index.ts +2 -3
- package/src/fieldTypes/integer.ts +5 -3
- package/src/fieldTypes/json.ts +5 -4
- package/src/fieldTypes/lat_lon.ts +5 -3
- package/src/fieldTypes/link.ts +7 -5
- package/src/fieldTypes/links.ts +8 -4
- package/src/fieldTypes/rich_text.ts +7 -7
- package/src/fieldTypes/seo.ts +5 -4
- package/src/fieldTypes/single_block.ts +12 -10
- package/src/fieldTypes/slug.ts +5 -4
- package/src/fieldTypes/string.ts +5 -3
- package/src/fieldTypes/structured_text.ts +7 -7
- package/src/fieldTypes/text.ts +5 -4
- package/src/fieldTypes/video.ts +5 -3
- package/src/generated/Client.ts +1 -1
- package/src/generated/resources/Item.ts +129 -92
- package/src/generated/resources/ScheduledPublication.ts +6 -6
- package/src/generated/resources/ScheduledUnpublishing.ts +6 -6
- package/src/generated/resources/Upload.ts +36 -10
- package/src/index.ts +4 -4
- package/src/utilities/buildBlockRecord.ts +24 -31
- package/src/utilities/inspectItem.ts +590 -0
- package/src/utilities/itemDefinition.ts +53 -35
- package/src/utilities/{blocks.ts → nonRecursiveBlocks.ts} +170 -136
- package/src/utilities/{fieldValue.ts → normalizedFieldValues.ts} +70 -30
- package/src/utilities/recursiveBlocks.ts +186 -171
- package/src/utilities/schemaRepository.ts +2 -2
- package/dist/cjs/utilities/blocks.js.map +0 -1
- package/dist/cjs/utilities/fieldValue.js.map +0 -1
- package/dist/esm/utilities/blocks.d.ts +0 -180
- package/dist/esm/utilities/blocks.js.map +0 -1
- package/dist/esm/utilities/fieldValue.js.map +0 -1
- package/dist/types/utilities/blocks.d.ts +0 -180
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import * as Utils from '@datocms/rest-client-utils';
|
|
2
2
|
import BaseResource from '../../BaseResource';
|
|
3
|
-
import type { ItemTypeDefinition,
|
|
3
|
+
import type { ItemTypeDefinition, ToItemDefinition, ToItemDefinitionAsRequest, ToItemDefinitionWithNestedBlocks } from '../../utilities/itemDefinition';
|
|
4
4
|
import type * as ApiTypes from '../ApiTypes';
|
|
5
5
|
import type * as RawApiTypes from '../RawApiTypes';
|
|
6
6
|
type NoInfer<T> = [T][T extends any ? 0 : never];
|
|
@@ -16,10 +16,10 @@ export default class Item extends BaseResource {
|
|
|
16
16
|
*/
|
|
17
17
|
list<D extends ItemTypeDefinition = ItemTypeDefinition>(queryParams: ApiTypes.ItemInstancesHrefSchema & {
|
|
18
18
|
nested: true;
|
|
19
|
-
}): Promise<ApiTypes.ItemInstancesTargetSchema<
|
|
19
|
+
}): Promise<ApiTypes.ItemInstancesTargetSchema<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
|
|
20
20
|
list<D extends ItemTypeDefinition = ItemTypeDefinition>(queryParams?: ApiTypes.ItemInstancesHrefSchema & {
|
|
21
21
|
nested?: false | undefined;
|
|
22
|
-
}): Promise<ApiTypes.ItemInstancesTargetSchema<
|
|
22
|
+
}): Promise<ApiTypes.ItemInstancesTargetSchema<ToItemDefinition<NoInfer<D>>>>;
|
|
23
23
|
/**
|
|
24
24
|
* List all records
|
|
25
25
|
*
|
|
@@ -28,7 +28,13 @@ export default class Item extends BaseResource {
|
|
|
28
28
|
* @throws {ApiError}
|
|
29
29
|
* @throws {TimeoutError}
|
|
30
30
|
*/
|
|
31
|
-
rawList<D extends ItemTypeDefinition = ItemTypeDefinition>(queryParams
|
|
31
|
+
rawList<D extends ItemTypeDefinition = ItemTypeDefinition>(queryParams: RawApiTypes.ItemInstancesHrefSchema & {
|
|
32
|
+
nested: true;
|
|
33
|
+
}): Promise<RawApiTypes.ItemInstancesTargetSchema<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
|
|
34
|
+
rawList<D extends ItemTypeDefinition = ItemTypeDefinition>(queryParams?: RawApiTypes.ItemInstancesHrefSchema & {
|
|
35
|
+
nested?: false | undefined;
|
|
36
|
+
}): Promise<RawApiTypes.ItemInstancesTargetSchema<ToItemDefinition<NoInfer<D>>>>;
|
|
37
|
+
rawList<D extends ItemTypeDefinition = ItemTypeDefinition>(queryParams?: RawApiTypes.ItemInstancesHrefSchema): Promise<RawApiTypes.ItemInstancesTargetSchema<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
|
|
32
38
|
/**
|
|
33
39
|
* Async iterator to auto-paginate over elements returned by list()
|
|
34
40
|
*
|
|
@@ -37,7 +43,7 @@ export default class Item extends BaseResource {
|
|
|
37
43
|
* @throws {ApiError}
|
|
38
44
|
* @throws {TimeoutError}
|
|
39
45
|
*/
|
|
40
|
-
listPagedIterator<D extends ItemTypeDefinition = ItemTypeDefinition>(queryParams?: Utils.OmitFromKnownKeys<ApiTypes.ItemInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem,
|
|
46
|
+
listPagedIterator<D extends ItemTypeDefinition = ItemTypeDefinition>(queryParams?: Utils.OmitFromKnownKeys<ApiTypes.ItemInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem, ToItemDefinitionWithNestedBlocks<NoInfer<D>>>, void, unknown>;
|
|
41
47
|
/**
|
|
42
48
|
* Async iterator to auto-paginate over elements returned by rawList()
|
|
43
49
|
*
|
|
@@ -46,7 +52,7 @@ export default class Item extends BaseResource {
|
|
|
46
52
|
* @throws {ApiError}
|
|
47
53
|
* @throws {TimeoutError}
|
|
48
54
|
*/
|
|
49
|
-
rawListPagedIterator<D extends ItemTypeDefinition = ItemTypeDefinition>(queryParams?: Utils.OmitFromKnownKeys<RawApiTypes.ItemInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<Awaited<RawApiTypes.ApplyItemDefinitionToSchema<RawApiTypes.RawItem,
|
|
55
|
+
rawListPagedIterator<D extends ItemTypeDefinition = ItemTypeDefinition>(queryParams?: Utils.OmitFromKnownKeys<RawApiTypes.ItemInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<Awaited<RawApiTypes.ApplyItemDefinitionToSchema<RawApiTypes.RawItem, ToItemDefinitionWithNestedBlocks<NoInfer<D>>>>, void, unknown>;
|
|
50
56
|
/**
|
|
51
57
|
* Validates an existing record field
|
|
52
58
|
*
|
|
@@ -57,7 +63,7 @@ export default class Item extends BaseResource {
|
|
|
57
63
|
*
|
|
58
64
|
* @deprecated This API call is to be considered private and might change without notice
|
|
59
65
|
*/
|
|
60
|
-
validateExisting<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData, body: ApiTypes.ItemValidateExistingSchema<
|
|
66
|
+
validateExisting<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData, body: ApiTypes.ItemValidateExistingSchema<ToItemDefinitionAsRequest<NoInfer<D>>>): Promise<void>;
|
|
61
67
|
/**
|
|
62
68
|
* Validates an existing record field
|
|
63
69
|
*
|
|
@@ -68,7 +74,7 @@ export default class Item extends BaseResource {
|
|
|
68
74
|
*
|
|
69
75
|
* @deprecated This API call is to be considered private and might change without notice
|
|
70
76
|
*/
|
|
71
|
-
rawValidateExisting<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, body: RawApiTypes.ItemValidateExistingSchema<
|
|
77
|
+
rawValidateExisting<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, body: RawApiTypes.ItemValidateExistingSchema<ToItemDefinitionAsRequest<NoInfer<D>>>): Promise<void>;
|
|
72
78
|
/**
|
|
73
79
|
* Validates a record field
|
|
74
80
|
*
|
|
@@ -79,7 +85,7 @@ export default class Item extends BaseResource {
|
|
|
79
85
|
*
|
|
80
86
|
* @deprecated This API call is to be considered private and might change without notice
|
|
81
87
|
*/
|
|
82
|
-
validateNew<D extends ItemTypeDefinition = ItemTypeDefinition>(body: ApiTypes.ItemValidateNewSchema<
|
|
88
|
+
validateNew<D extends ItemTypeDefinition = ItemTypeDefinition>(body: ApiTypes.ItemValidateNewSchema<ToItemDefinitionAsRequest<NoInfer<D>>>): Promise<void>;
|
|
83
89
|
/**
|
|
84
90
|
* Validates a record field
|
|
85
91
|
*
|
|
@@ -90,7 +96,7 @@ export default class Item extends BaseResource {
|
|
|
90
96
|
*
|
|
91
97
|
* @deprecated This API call is to be considered private and might change without notice
|
|
92
98
|
*/
|
|
93
|
-
rawValidateNew<D extends ItemTypeDefinition = ItemTypeDefinition>(body: RawApiTypes.ItemValidateNewSchema<
|
|
99
|
+
rawValidateNew<D extends ItemTypeDefinition = ItemTypeDefinition>(body: RawApiTypes.ItemValidateNewSchema<ToItemDefinitionAsRequest<NoInfer<D>>>): Promise<void>;
|
|
94
100
|
/**
|
|
95
101
|
* Create a new record
|
|
96
102
|
*
|
|
@@ -99,7 +105,7 @@ export default class Item extends BaseResource {
|
|
|
99
105
|
* @throws {ApiError}
|
|
100
106
|
* @throws {TimeoutError}
|
|
101
107
|
*/
|
|
102
|
-
create<D extends ItemTypeDefinition = ItemTypeDefinition>(body: ApiTypes.ItemCreateSchema<
|
|
108
|
+
create<D extends ItemTypeDefinition = ItemTypeDefinition>(body: ApiTypes.ItemCreateSchema<ToItemDefinitionAsRequest<NoInfer<D>>>): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem, ToItemDefinition<NoInfer<D>>>>;
|
|
103
109
|
/**
|
|
104
110
|
* Create a new record
|
|
105
111
|
*
|
|
@@ -108,7 +114,7 @@ export default class Item extends BaseResource {
|
|
|
108
114
|
* @throws {ApiError}
|
|
109
115
|
* @throws {TimeoutError}
|
|
110
116
|
*/
|
|
111
|
-
rawCreate<D extends ItemTypeDefinition = ItemTypeDefinition>(body: RawApiTypes.ItemCreateSchema<
|
|
117
|
+
rawCreate<D extends ItemTypeDefinition = ItemTypeDefinition>(body: RawApiTypes.ItemCreateSchema<ToItemDefinitionAsRequest<NoInfer<D>>>): Promise<RawApiTypes.ItemCreateTargetSchema<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
|
|
112
118
|
/**
|
|
113
119
|
* Duplicate a record
|
|
114
120
|
*
|
|
@@ -117,7 +123,7 @@ export default class Item extends BaseResource {
|
|
|
117
123
|
* @throws {ApiError}
|
|
118
124
|
* @throws {TimeoutError}
|
|
119
125
|
*/
|
|
120
|
-
duplicate<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem,
|
|
126
|
+
duplicate<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem, ToItemDefinition<NoInfer<D>>>>;
|
|
121
127
|
/**
|
|
122
128
|
* Duplicate a record
|
|
123
129
|
*
|
|
@@ -126,7 +132,7 @@ export default class Item extends BaseResource {
|
|
|
126
132
|
* @throws {ApiError}
|
|
127
133
|
* @throws {TimeoutError}
|
|
128
134
|
*/
|
|
129
|
-
rawDuplicate<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string): Promise<RawApiTypes.ItemDuplicateJobSchema<
|
|
135
|
+
rawDuplicate<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string): Promise<RawApiTypes.ItemDuplicateJobSchema<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
|
|
130
136
|
/**
|
|
131
137
|
* Update a record
|
|
132
138
|
*
|
|
@@ -135,7 +141,7 @@ export default class Item extends BaseResource {
|
|
|
135
141
|
* @throws {ApiError}
|
|
136
142
|
* @throws {TimeoutError}
|
|
137
143
|
*/
|
|
138
|
-
update<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData, body: ApiTypes.ItemUpdateSchema<
|
|
144
|
+
update<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData, body: ApiTypes.ItemUpdateSchema<ToItemDefinitionAsRequest<NoInfer<D>>>): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem, ToItemDefinition<NoInfer<D>>>>;
|
|
139
145
|
/**
|
|
140
146
|
* Update a record
|
|
141
147
|
*
|
|
@@ -144,7 +150,7 @@ export default class Item extends BaseResource {
|
|
|
144
150
|
* @throws {ApiError}
|
|
145
151
|
* @throws {TimeoutError}
|
|
146
152
|
*/
|
|
147
|
-
rawUpdate<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, body: RawApiTypes.ItemUpdateSchema<
|
|
153
|
+
rawUpdate<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, body: RawApiTypes.ItemUpdateSchema<ToItemDefinitionAsRequest<NoInfer<D>>>): Promise<RawApiTypes.ItemUpdateTargetSchema<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
|
|
148
154
|
/**
|
|
149
155
|
* Referenced records
|
|
150
156
|
*
|
|
@@ -155,10 +161,10 @@ export default class Item extends BaseResource {
|
|
|
155
161
|
*/
|
|
156
162
|
references<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData, queryParams: ApiTypes.ItemReferencesHrefSchema & {
|
|
157
163
|
nested: true;
|
|
158
|
-
}): Promise<ApiTypes.ItemReferencesTargetSchema<
|
|
164
|
+
}): Promise<ApiTypes.ItemReferencesTargetSchema<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
|
|
159
165
|
references<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData, queryParams?: ApiTypes.ItemReferencesHrefSchema & {
|
|
160
166
|
nested?: false | undefined;
|
|
161
|
-
}): Promise<ApiTypes.ItemReferencesTargetSchema<
|
|
167
|
+
}): Promise<ApiTypes.ItemReferencesTargetSchema<ToItemDefinition<NoInfer<D>>>>;
|
|
162
168
|
/**
|
|
163
169
|
* Referenced records
|
|
164
170
|
*
|
|
@@ -167,7 +173,13 @@ export default class Item extends BaseResource {
|
|
|
167
173
|
* @throws {ApiError}
|
|
168
174
|
* @throws {TimeoutError}
|
|
169
175
|
*/
|
|
170
|
-
rawReferences<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, queryParams
|
|
176
|
+
rawReferences<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, queryParams: RawApiTypes.ItemReferencesHrefSchema & {
|
|
177
|
+
nested: true;
|
|
178
|
+
}): Promise<RawApiTypes.ItemReferencesTargetSchema<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
|
|
179
|
+
rawReferences<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, queryParams?: RawApiTypes.ItemReferencesHrefSchema & {
|
|
180
|
+
nested?: false | undefined;
|
|
181
|
+
}): Promise<RawApiTypes.ItemReferencesTargetSchema<ToItemDefinition<NoInfer<D>>>>;
|
|
182
|
+
rawReferences<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, queryParams?: RawApiTypes.ItemReferencesHrefSchema): Promise<RawApiTypes.ItemReferencesTargetSchema<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
|
|
171
183
|
/**
|
|
172
184
|
* Retrieve a record
|
|
173
185
|
*
|
|
@@ -178,10 +190,10 @@ export default class Item extends BaseResource {
|
|
|
178
190
|
*/
|
|
179
191
|
find<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData, queryParams: ApiTypes.ItemSelfHrefSchema & {
|
|
180
192
|
nested: true;
|
|
181
|
-
}): Promise<ApiTypes.ItemSelfTargetSchema<
|
|
193
|
+
}): Promise<ApiTypes.ItemSelfTargetSchema<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
|
|
182
194
|
find<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData, queryParams?: ApiTypes.ItemSelfHrefSchema & {
|
|
183
195
|
nested?: false | undefined;
|
|
184
|
-
}): Promise<ApiTypes.ItemSelfTargetSchema<
|
|
196
|
+
}): Promise<ApiTypes.ItemSelfTargetSchema<ToItemDefinition<NoInfer<D>>>>;
|
|
185
197
|
/**
|
|
186
198
|
* Retrieve a record
|
|
187
199
|
*
|
|
@@ -190,7 +202,13 @@ export default class Item extends BaseResource {
|
|
|
190
202
|
* @throws {ApiError}
|
|
191
203
|
* @throws {TimeoutError}
|
|
192
204
|
*/
|
|
193
|
-
rawFind<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, queryParams
|
|
205
|
+
rawFind<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, queryParams: RawApiTypes.ItemSelfHrefSchema & {
|
|
206
|
+
nested: true;
|
|
207
|
+
}): Promise<RawApiTypes.ItemSelfTargetSchema<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
|
|
208
|
+
rawFind<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, queryParams?: RawApiTypes.ItemSelfHrefSchema & {
|
|
209
|
+
nested?: false | undefined;
|
|
210
|
+
}): Promise<RawApiTypes.ItemSelfTargetSchema<ToItemDefinition<NoInfer<D>>>>;
|
|
211
|
+
rawFind<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, queryParams?: RawApiTypes.ItemSelfHrefSchema): Promise<RawApiTypes.ItemSelfTargetSchema<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
|
|
194
212
|
/**
|
|
195
213
|
* Retrieve information regarding changes between current and published versions of the record
|
|
196
214
|
*
|
|
@@ -221,7 +239,7 @@ export default class Item extends BaseResource {
|
|
|
221
239
|
* @throws {ApiError}
|
|
222
240
|
* @throws {TimeoutError}
|
|
223
241
|
*/
|
|
224
|
-
destroy<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem,
|
|
242
|
+
destroy<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem, ToItemDefinition<NoInfer<D>>>>;
|
|
225
243
|
/**
|
|
226
244
|
* Delete a record
|
|
227
245
|
*
|
|
@@ -230,7 +248,7 @@ export default class Item extends BaseResource {
|
|
|
230
248
|
* @throws {ApiError}
|
|
231
249
|
* @throws {TimeoutError}
|
|
232
250
|
*/
|
|
233
|
-
rawDestroy<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string): Promise<RawApiTypes.ItemDestroyJobSchema<
|
|
251
|
+
rawDestroy<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string): Promise<RawApiTypes.ItemDestroyJobSchema<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
|
|
234
252
|
/**
|
|
235
253
|
* Publish a record
|
|
236
254
|
*
|
|
@@ -239,7 +257,7 @@ export default class Item extends BaseResource {
|
|
|
239
257
|
* @throws {ApiError}
|
|
240
258
|
* @throws {TimeoutError}
|
|
241
259
|
*/
|
|
242
|
-
publish<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData, body?: ApiTypes.ItemPublishSchema, queryParams?: ApiTypes.ItemPublishHrefSchema): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem,
|
|
260
|
+
publish<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData, body?: ApiTypes.ItemPublishSchema, queryParams?: ApiTypes.ItemPublishHrefSchema): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem, ToItemDefinition<NoInfer<D>>>>;
|
|
243
261
|
/**
|
|
244
262
|
* Publish a record
|
|
245
263
|
*
|
|
@@ -248,7 +266,7 @@ export default class Item extends BaseResource {
|
|
|
248
266
|
* @throws {ApiError}
|
|
249
267
|
* @throws {TimeoutError}
|
|
250
268
|
*/
|
|
251
|
-
rawPublish<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, body?: RawApiTypes.ItemPublishSchema, queryParams?: RawApiTypes.ItemPublishHrefSchema): Promise<RawApiTypes.ItemPublishTargetSchema<
|
|
269
|
+
rawPublish<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, body?: RawApiTypes.ItemPublishSchema, queryParams?: RawApiTypes.ItemPublishHrefSchema): Promise<RawApiTypes.ItemPublishTargetSchema<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
|
|
252
270
|
/**
|
|
253
271
|
* Unpublish a record
|
|
254
272
|
*
|
|
@@ -257,7 +275,7 @@ export default class Item extends BaseResource {
|
|
|
257
275
|
* @throws {ApiError}
|
|
258
276
|
* @throws {TimeoutError}
|
|
259
277
|
*/
|
|
260
|
-
unpublish<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData, body?: ApiTypes.ItemUnpublishSchema, queryParams?: ApiTypes.ItemUnpublishHrefSchema): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem,
|
|
278
|
+
unpublish<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData, body?: ApiTypes.ItemUnpublishSchema, queryParams?: ApiTypes.ItemUnpublishHrefSchema): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem, ToItemDefinition<NoInfer<D>>>>;
|
|
261
279
|
/**
|
|
262
280
|
* Unpublish a record
|
|
263
281
|
*
|
|
@@ -266,7 +284,7 @@ export default class Item extends BaseResource {
|
|
|
266
284
|
* @throws {ApiError}
|
|
267
285
|
* @throws {TimeoutError}
|
|
268
286
|
*/
|
|
269
|
-
rawUnpublish<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, body?: RawApiTypes.ItemUnpublishSchema, queryParams?: RawApiTypes.ItemUnpublishHrefSchema): Promise<RawApiTypes.ItemUnpublishTargetSchema<
|
|
287
|
+
rawUnpublish<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, body?: RawApiTypes.ItemUnpublishSchema, queryParams?: RawApiTypes.ItemUnpublishHrefSchema): Promise<RawApiTypes.ItemUnpublishTargetSchema<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
|
|
270
288
|
/**
|
|
271
289
|
* Publish items in bulk
|
|
272
290
|
*
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import BaseResource from '../../BaseResource';
|
|
2
|
-
import type { ItemTypeDefinition,
|
|
2
|
+
import type { ItemTypeDefinition, ToItemDefinition, ToItemDefinitionWithNestedBlocks } from '../../utilities/itemDefinition';
|
|
3
3
|
import type * as ApiTypes from '../ApiTypes';
|
|
4
4
|
import type * as RawApiTypes from '../RawApiTypes';
|
|
5
5
|
type NoInfer<T> = [T][T extends any ? 0 : never];
|
|
@@ -31,7 +31,7 @@ export default class ScheduledPublication extends BaseResource {
|
|
|
31
31
|
* @throws {ApiError}
|
|
32
32
|
* @throws {TimeoutError}
|
|
33
33
|
*/
|
|
34
|
-
destroy<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem,
|
|
34
|
+
destroy<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem, ToItemDefinition<NoInfer<D>>>>;
|
|
35
35
|
/**
|
|
36
36
|
* Delete a scheduled publication
|
|
37
37
|
*
|
|
@@ -40,6 +40,6 @@ export default class ScheduledPublication extends BaseResource {
|
|
|
40
40
|
* @throws {ApiError}
|
|
41
41
|
* @throws {TimeoutError}
|
|
42
42
|
*/
|
|
43
|
-
rawDestroy<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string): Promise<RawApiTypes.ScheduledPublicationDestroyTargetSchema<
|
|
43
|
+
rawDestroy<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string): Promise<RawApiTypes.ScheduledPublicationDestroyTargetSchema<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
|
|
44
44
|
}
|
|
45
45
|
export {};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import BaseResource from '../../BaseResource';
|
|
2
|
-
import type { ItemTypeDefinition,
|
|
2
|
+
import type { ItemTypeDefinition, ToItemDefinition, ToItemDefinitionWithNestedBlocks } from '../../utilities/itemDefinition';
|
|
3
3
|
import type * as ApiTypes from '../ApiTypes';
|
|
4
4
|
import type * as RawApiTypes from '../RawApiTypes';
|
|
5
5
|
type NoInfer<T> = [T][T extends any ? 0 : never];
|
|
@@ -31,7 +31,7 @@ export default class ScheduledUnpublishing extends BaseResource {
|
|
|
31
31
|
* @throws {ApiError}
|
|
32
32
|
* @throws {TimeoutError}
|
|
33
33
|
*/
|
|
34
|
-
destroy<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem,
|
|
34
|
+
destroy<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem, ToItemDefinition<NoInfer<D>>>>;
|
|
35
35
|
/**
|
|
36
36
|
* Delete a scheduled unpublishing
|
|
37
37
|
*
|
|
@@ -40,6 +40,6 @@ export default class ScheduledUnpublishing extends BaseResource {
|
|
|
40
40
|
* @throws {ApiError}
|
|
41
41
|
* @throws {TimeoutError}
|
|
42
42
|
*/
|
|
43
|
-
rawDestroy<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string): Promise<RawApiTypes.ScheduledUnpublishingDestroyTargetSchema<
|
|
43
|
+
rawDestroy<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string): Promise<RawApiTypes.ScheduledUnpublishingDestroyTargetSchema<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
|
|
44
44
|
}
|
|
45
45
|
export {};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import * as Utils from '@datocms/rest-client-utils';
|
|
2
2
|
import BaseResource from '../../BaseResource';
|
|
3
|
-
import type { ItemTypeDefinition,
|
|
3
|
+
import type { ItemTypeDefinition, ToItemDefinition, ToItemDefinitionWithNestedBlocks } from '../../utilities/itemDefinition';
|
|
4
4
|
import type * as ApiTypes from '../ApiTypes';
|
|
5
5
|
import type * as RawApiTypes from '../RawApiTypes';
|
|
6
6
|
type NoInfer<T> = [T][T extends any ? 0 : never];
|
|
@@ -124,10 +124,10 @@ export default class Upload extends BaseResource {
|
|
|
124
124
|
*/
|
|
125
125
|
references<D extends ItemTypeDefinition = ItemTypeDefinition>(uploadId: string | ApiTypes.UploadData, queryParams: ApiTypes.UploadReferencesHrefSchema & {
|
|
126
126
|
nested: true;
|
|
127
|
-
}): Promise<ApiTypes.UploadReferencesTargetSchema<
|
|
127
|
+
}): Promise<ApiTypes.UploadReferencesTargetSchema<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
|
|
128
128
|
references<D extends ItemTypeDefinition = ItemTypeDefinition>(uploadId: string | ApiTypes.UploadData, queryParams?: ApiTypes.UploadReferencesHrefSchema & {
|
|
129
129
|
nested?: false | undefined;
|
|
130
|
-
}): Promise<ApiTypes.UploadReferencesTargetSchema<
|
|
130
|
+
}): Promise<ApiTypes.UploadReferencesTargetSchema<ToItemDefinition<NoInfer<D>>>>;
|
|
131
131
|
/**
|
|
132
132
|
* Referenced records
|
|
133
133
|
*
|
|
@@ -136,7 +136,13 @@ export default class Upload extends BaseResource {
|
|
|
136
136
|
* @throws {ApiError}
|
|
137
137
|
* @throws {TimeoutError}
|
|
138
138
|
*/
|
|
139
|
-
rawReferences<D extends ItemTypeDefinition = ItemTypeDefinition>(uploadId: string, queryParams
|
|
139
|
+
rawReferences<D extends ItemTypeDefinition = ItemTypeDefinition>(uploadId: string, queryParams: RawApiTypes.UploadReferencesHrefSchema & {
|
|
140
|
+
nested: true;
|
|
141
|
+
}): Promise<RawApiTypes.UploadReferencesTargetSchema<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
|
|
142
|
+
rawReferences<D extends ItemTypeDefinition = ItemTypeDefinition>(uploadId: string, queryParams?: RawApiTypes.UploadReferencesHrefSchema & {
|
|
143
|
+
nested?: false | undefined;
|
|
144
|
+
}): Promise<RawApiTypes.UploadReferencesTargetSchema<ToItemDefinition<NoInfer<D>>>>;
|
|
145
|
+
rawReferences<D extends ItemTypeDefinition = ItemTypeDefinition>(uploadId: string, queryParams?: RawApiTypes.UploadReferencesHrefSchema): Promise<RawApiTypes.UploadReferencesTargetSchema<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
|
|
140
146
|
/**
|
|
141
147
|
* Add tags to assets in bulk
|
|
142
148
|
*
|
package/dist/types/index.d.ts
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
export { ApiError, LogLevel, TimeoutError } from '@datocms/rest-client-utils';
|
|
2
2
|
export * from './buildClient';
|
|
3
|
+
export * from './fieldTypes';
|
|
3
4
|
export { Client } from './generated/Client';
|
|
4
5
|
export type { ClientConfigOptions } from './generated/Client';
|
|
5
6
|
export * as Resources from './generated/resources';
|
|
6
|
-
export * from './utilities/blocks';
|
|
7
7
|
export * from './utilities/buildBlockRecord';
|
|
8
8
|
export * from './utilities/fieldsContainingReferences';
|
|
9
|
-
export * from './utilities/fieldValue';
|
|
10
9
|
export * from './utilities/id';
|
|
10
|
+
export * from './utilities/inspectItem';
|
|
11
|
+
export * from './utilities/itemDefinition';
|
|
12
|
+
export * from './utilities/normalizedFieldValues';
|
|
11
13
|
export * from './utilities/recursiveBlocks';
|
|
12
14
|
export * from './utilities/schemaRepository';
|
|
13
|
-
export * from './utilities/itemDefinition';
|
|
14
|
-
export * from './fieldTypes';
|
|
15
15
|
export type { ApiTypes, RawApiTypes };
|
|
16
16
|
export type { ApiTypes as SchemaTypes, RawApiTypes as SimpleSchemaTypes };
|
|
17
17
|
import type * as ApiTypes from './generated/ApiTypes';
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import type { ItemWithOptionalIdAndMeta, NewBlockInARequest } from '../fieldTypes';
|
|
2
2
|
import type * as ApiTypes from '../generated/ApiTypes';
|
|
3
|
-
import type { ItemTypeDefinition,
|
|
3
|
+
import type { ItemTypeDefinition, ToItemDefinitionAsRequest, ToItemDefinitionWithNestedBlocks } from './itemDefinition';
|
|
4
4
|
import type { SchemaRepository } from './schemaRepository';
|
|
5
5
|
type NoInfer<T> = [T][T extends any ? 0 : never];
|
|
6
|
-
export declare function buildBlockRecord<D extends ItemTypeDefinition = ItemTypeDefinition>(body: ApiTypes.ItemUpdateSchema<
|
|
7
|
-
export declare function duplicateBlockRecord<D extends ItemTypeDefinition = ItemTypeDefinition>(existingBlock: ItemWithOptionalIdAndMeta<
|
|
6
|
+
export declare function buildBlockRecord<D extends ItemTypeDefinition = ItemTypeDefinition>(body: ApiTypes.ItemUpdateSchema<ToItemDefinitionAsRequest<NoInfer<D>>>): NewBlockInARequest<ToItemDefinitionAsRequest<NoInfer<D>>>;
|
|
7
|
+
export declare function duplicateBlockRecord<D extends ItemTypeDefinition = ItemTypeDefinition>(existingBlock: ItemWithOptionalIdAndMeta<ToItemDefinitionWithNestedBlocks<NoInfer<D>>>, schemaRepository: SchemaRepository): Promise<NewBlockInARequest<ToItemDefinitionAsRequest<NoInfer<D>>>>;
|
|
8
8
|
export {};
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { type NewBlockInARequest, type UpdatedBlockInARequest } from '../fieldTypes';
|
|
2
|
+
import { type ApiTypes, type RawApiTypes } from '../index';
|
|
3
|
+
type Item = ApiTypes.Item | RawApiTypes.Item | NewBlockInARequest | UpdatedBlockInARequest | RawApiTypes.ItemCreateSchema | RawApiTypes.ItemUpdateSchema | ApiTypes.ItemCreateSchema | ApiTypes.ItemUpdateSchema;
|
|
4
|
+
export type InspectItemOptions = {
|
|
5
|
+
maxWidth?: number;
|
|
6
|
+
};
|
|
7
|
+
export declare function inspectItem(item: Item, options?: InspectItemOptions): string;
|
|
8
|
+
export {};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { BooleanFieldValue, ColorFieldValue, DateFieldValue, DateTimeFieldValue, FileFieldValue, FloatFieldValue, GalleryFieldValue, IntegerFieldValue, JsonFieldValue, LatLonFieldValue, LinkFieldValue, LinksFieldValue, RichTextFieldValue, RichTextFieldValueAsRequest, RichTextFieldValueWithNestedBlocks, SeoFieldValue, SingleBlockFieldValue, SingleBlockFieldValueAsRequest, SingleBlockFieldValueWithNestedBlocks, SlugFieldValue, StringFieldValue, StructuredTextFieldValue, StructuredTextFieldValueAsRequest, StructuredTextFieldValueWithNestedBlocks, TextFieldValue, VideoFieldValue } from '../fieldTypes';
|
|
2
|
-
import type { LocalizedFieldValue } from './
|
|
1
|
+
import type { BooleanFieldValue, ColorFieldValue, DateFieldValue, DateTimeFieldValue, FileFieldValue, FileFieldValueAsRequest, FloatFieldValue, GalleryFieldValue, GalleryFieldValueAsRequest, IntegerFieldValue, JsonFieldValue, LatLonFieldValue, LinkFieldValue, LinksFieldValue, RichTextFieldValue, RichTextFieldValueAsRequest, RichTextFieldValueWithNestedBlocks, SeoFieldValue, SingleBlockFieldValue, SingleBlockFieldValueAsRequest, SingleBlockFieldValueWithNestedBlocks, SlugFieldValue, StringFieldValue, StructuredTextFieldValue, StructuredTextFieldValueAsRequest, StructuredTextFieldValueWithNestedBlocks, TextFieldValue, VideoFieldValue } from '../fieldTypes';
|
|
2
|
+
import type { LocalizedFieldValue } from './normalizedFieldValues';
|
|
3
3
|
/** Base field definition */
|
|
4
4
|
type BaseFieldDefinition<Type extends string> = {
|
|
5
5
|
type: Type;
|
|
@@ -32,7 +32,7 @@ export type ItemDefinition<ItemTypeId extends string = string, FieldValues exten
|
|
|
32
32
|
itemTypeId: ItemTypeId;
|
|
33
33
|
fields: FieldValues;
|
|
34
34
|
};
|
|
35
|
-
/** Standard field values */
|
|
35
|
+
/** Standard field values (response format) */
|
|
36
36
|
type FieldTypeToValue = {
|
|
37
37
|
boolean: BooleanFieldValue;
|
|
38
38
|
color: ColorFieldValue;
|
|
@@ -56,6 +56,30 @@ type FieldTypeToValue = {
|
|
|
56
56
|
video: VideoFieldValue;
|
|
57
57
|
unknown: unknown;
|
|
58
58
|
};
|
|
59
|
+
/** Request field values (request format with optional metadata) */
|
|
60
|
+
type FieldTypeToValueAsRequest = {
|
|
61
|
+
boolean: BooleanFieldValue;
|
|
62
|
+
color: ColorFieldValue;
|
|
63
|
+
date: DateFieldValue;
|
|
64
|
+
date_time: DateTimeFieldValue;
|
|
65
|
+
file: FileFieldValueAsRequest;
|
|
66
|
+
float: FloatFieldValue;
|
|
67
|
+
gallery: GalleryFieldValueAsRequest;
|
|
68
|
+
integer: IntegerFieldValue;
|
|
69
|
+
json: JsonFieldValue;
|
|
70
|
+
lat_lon: LatLonFieldValue;
|
|
71
|
+
link: LinkFieldValue;
|
|
72
|
+
links: LinksFieldValue;
|
|
73
|
+
rich_text: RichTextFieldValueAsRequest;
|
|
74
|
+
seo: SeoFieldValue;
|
|
75
|
+
single_block: SingleBlockFieldValueAsRequest;
|
|
76
|
+
slug: SlugFieldValue;
|
|
77
|
+
string: StringFieldValue;
|
|
78
|
+
structured_text: StructuredTextFieldValueAsRequest;
|
|
79
|
+
text: TextFieldValue;
|
|
80
|
+
video: VideoFieldValue;
|
|
81
|
+
unknown: unknown;
|
|
82
|
+
};
|
|
59
83
|
/** Localized wrapper */
|
|
60
84
|
type LocalizeIfNeeded<T extends FieldDefinition, Value, Locales extends string> = T extends {
|
|
61
85
|
localized: true;
|
|
@@ -63,24 +87,24 @@ type LocalizeIfNeeded<T extends FieldDefinition, Value, Locales extends string>
|
|
|
63
87
|
/** Standard mapping */
|
|
64
88
|
type FieldDefinitionToFieldValue<T extends FieldDefinition, Locales extends string> = LocalizeIfNeeded<T, FieldTypeToValue[T['type']], Locales>;
|
|
65
89
|
/** AsRequest mapping (block fields become generic over allowed blocks) */
|
|
66
|
-
type FieldDefinitionToFieldValueAsRequest<T extends FieldDefinition, Locales extends string> = T extends RichTextFieldDefinition<infer B> ? LocalizeIfNeeded<T, RichTextFieldValueAsRequest<
|
|
90
|
+
type FieldDefinitionToFieldValueAsRequest<T extends FieldDefinition, Locales extends string> = T extends RichTextFieldDefinition<infer B> ? LocalizeIfNeeded<T, RichTextFieldValueAsRequest<ToItemDefinitionAsRequest<B>>, Locales> : T extends SingleBlockFieldDefinition<infer B> ? LocalizeIfNeeded<T, SingleBlockFieldValueAsRequest<ToItemDefinitionAsRequest<B>>, Locales> : T extends StructuredTextFieldDefinition<infer B, infer I> ? LocalizeIfNeeded<T, StructuredTextFieldValueAsRequest<T extends {
|
|
67
91
|
blocks: any;
|
|
68
|
-
} ?
|
|
92
|
+
} ? ToItemDefinitionAsRequest<B> : never, T extends {
|
|
69
93
|
inline_blocks: any;
|
|
70
|
-
} ?
|
|
71
|
-
type FieldDefinitionToFieldValueWithNestedBlocks<T extends FieldDefinition, Locales extends string> = T extends RichTextFieldDefinition<infer B> ? LocalizeIfNeeded<T, RichTextFieldValueWithNestedBlocks<
|
|
94
|
+
} ? ToItemDefinitionAsRequest<I> : never>, Locales> : LocalizeIfNeeded<T, FieldTypeToValueAsRequest[T['type']], Locales>;
|
|
95
|
+
type FieldDefinitionToFieldValueWithNestedBlocks<T extends FieldDefinition, Locales extends string> = T extends RichTextFieldDefinition<infer B> ? LocalizeIfNeeded<T, RichTextFieldValueWithNestedBlocks<ToItemDefinitionWithNestedBlocks<B>>, Locales> : T extends SingleBlockFieldDefinition<infer B> ? LocalizeIfNeeded<T, SingleBlockFieldValueWithNestedBlocks<ToItemDefinitionWithNestedBlocks<B>>, Locales> : T extends StructuredTextFieldDefinition<infer B, infer I> ? LocalizeIfNeeded<T, StructuredTextFieldValueWithNestedBlocks<T extends {
|
|
72
96
|
blocks: any;
|
|
73
|
-
} ?
|
|
97
|
+
} ? ToItemDefinitionWithNestedBlocks<B> : never, T extends {
|
|
74
98
|
inline_blocks: any;
|
|
75
|
-
} ?
|
|
99
|
+
} ? ToItemDefinitionWithNestedBlocks<I> : never>, Locales> : LocalizeIfNeeded<T, FieldTypeToValue[T['type']], Locales>;
|
|
76
100
|
/** Transformers */
|
|
77
|
-
export type
|
|
101
|
+
export type ToItemDefinition<T extends ItemTypeDefinition<any, any, any>> = T extends ItemTypeDefinition<infer Settings, infer ItemTypeId, infer Fields> ? keyof Fields extends never ? ItemDefinition<ItemTypeId> : ItemDefinition<ItemTypeId, {
|
|
78
102
|
[K in keyof Fields]: Fields[K] extends FieldDefinition ? FieldDefinitionToFieldValue<Fields[K], Settings['locales']> : never;
|
|
79
103
|
}> : never;
|
|
80
|
-
export type
|
|
104
|
+
export type ToItemDefinitionAsRequest<T extends ItemTypeDefinition<any, any, any>> = T extends ItemTypeDefinition<infer Settings, infer ItemTypeId, infer Fields> ? keyof Fields extends never ? ItemDefinition<ItemTypeId> : ItemDefinition<ItemTypeId, Partial<{
|
|
81
105
|
[K in keyof Fields]: Fields[K] extends FieldDefinition ? FieldDefinitionToFieldValueAsRequest<Fields[K], Settings['locales']> : never;
|
|
82
106
|
}>> : never;
|
|
83
|
-
export type
|
|
107
|
+
export type ToItemDefinitionWithNestedBlocks<T extends ItemTypeDefinition<any, any, any>> = T extends ItemTypeDefinition<infer Settings, infer ItemTypeId, infer Fields> ? keyof Fields extends never ? ItemDefinition<ItemTypeId> : ItemDefinition<ItemTypeId, {
|
|
84
108
|
[K in keyof Fields]: Fields[K] extends FieldDefinition ? FieldDefinitionToFieldValueWithNestedBlocks<Fields[K], Settings['locales']> : never;
|
|
85
109
|
}> : never;
|
|
86
110
|
export type UnknownField = Record<string, unknown>;
|