@datocms/cma-client 5.1.3 → 5.1.4

package/dist/types/generated/resources/Item.d.ts

@@ -1,7 +1,9 @@
 import * as Utils from '@datocms/rest-client-utils';
 import BaseResource from '../../BaseResource';
+import type { ItemTypeDefinition, ItemTypeDefinitionToItemDefinition, ItemTypeDefinitionToItemDefinitionAsRequest, ItemTypeDefinitionToItemDefinitionWithNestedBlocks } from '../../utilities/itemDefinition';
 import type * as ApiTypes from '../ApiTypes';
 import type * as RawApiTypes from '../RawApiTypes';
+type NoInfer<T> = [T][T extends any ? 0 : never];
 export default class Item extends BaseResource {
     static readonly TYPE: "item";
     /**
@@ -12,7 +14,12 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    list(queryParams?: ApiTypes.ItemInstancesHrefSchema): Promise<ApiTypes.ItemInstancesTargetSchema>;
+    list<D extends ItemTypeDefinition = ItemTypeDefinition>(queryParams: ApiTypes.ItemInstancesHrefSchema & {
+        nested: true;
+    }): Promise<ApiTypes.ItemInstancesTargetSchema<ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
+    list<D extends ItemTypeDefinition = ItemTypeDefinition>(queryParams?: ApiTypes.ItemInstancesHrefSchema & {
+        nested?: false | undefined;
+    }): Promise<ApiTypes.ItemInstancesTargetSchema<ItemTypeDefinitionToItemDefinition<NoInfer<D>>>>;
     /**
      * List all records
      *
@@ -21,7 +28,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    rawList(queryParams?: RawApiTypes.ItemInstancesHrefSchema): Promise<RawApiTypes.ItemInstancesTargetSchema>;
+    rawList<D extends ItemTypeDefinition = ItemTypeDefinition>(queryParams?: RawApiTypes.ItemInstancesHrefSchema): Promise<RawApiTypes.ItemInstancesTargetSchema<ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
     /**
      * Async iterator to auto-paginate over elements returned by list()
      *
@@ -30,7 +37,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    listPagedIterator(queryParams?: Utils.OmitFromKnownKeys<ApiTypes.ItemInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<ApiTypes.Item, void, unknown>;
+    listPagedIterator<D extends ItemTypeDefinition = ItemTypeDefinition>(queryParams?: Utils.OmitFromKnownKeys<ApiTypes.ItemInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem, ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>>, void, unknown>;
     /**
      * Async iterator to auto-paginate over elements returned by rawList()
      *
@@ -39,7 +46,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    rawListPagedIterator(queryParams?: Utils.OmitFromKnownKeys<RawApiTypes.ItemInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<RawApiTypes.Item, void, unknown>;
+    rawListPagedIterator<D extends ItemTypeDefinition = ItemTypeDefinition>(queryParams?: Utils.OmitFromKnownKeys<RawApiTypes.ItemInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<Awaited<RawApiTypes.ApplyItemDefinitionToSchema<RawApiTypes.RawItem, ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>>>, void, unknown>;
     /**
      * Validates an existing record field
      *
@@ -50,7 +57,7 @@ export default class Item extends BaseResource {
      *
      * @deprecated This API call is to be considered private and might change without notice
      */
-    validateExisting(itemId: string | ApiTypes.ItemData, body: ApiTypes.ItemValidateExistingSchema): Promise<void>;
+    validateExisting<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData, body: ApiTypes.ItemValidateExistingSchema<ItemTypeDefinitionToItemDefinitionAsRequest<NoInfer<D>>>): Promise<void>;
     /**
      * Validates an existing record field
      *
@@ -61,7 +68,7 @@ export default class Item extends BaseResource {
      *
      * @deprecated This API call is to be considered private and might change without notice
      */
-    rawValidateExisting(itemId: string, body: RawApiTypes.ItemValidateExistingSchema): Promise<void>;
+    rawValidateExisting<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, body: RawApiTypes.ItemValidateExistingSchema<ItemTypeDefinitionToItemDefinitionAsRequest<NoInfer<D>>>): Promise<void>;
     /**
      * Validates a record field
      *
@@ -72,7 +79,7 @@ export default class Item extends BaseResource {
      *
      * @deprecated This API call is to be considered private and might change without notice
      */
-    validateNew(body: ApiTypes.ItemValidateNewSchema): Promise<void>;
+    validateNew<D extends ItemTypeDefinition = ItemTypeDefinition>(body: ApiTypes.ItemValidateNewSchema<ItemTypeDefinitionToItemDefinitionAsRequest<NoInfer<D>>>): Promise<void>;
     /**
      * Validates a record field
      *
@@ -83,7 +90,7 @@ export default class Item extends BaseResource {
      *
      * @deprecated This API call is to be considered private and might change without notice
      */
-    rawValidateNew(body: RawApiTypes.ItemValidateNewSchema): Promise<void>;
+    rawValidateNew<D extends ItemTypeDefinition = ItemTypeDefinition>(body: RawApiTypes.ItemValidateNewSchema<ItemTypeDefinitionToItemDefinitionAsRequest<NoInfer<D>>>): Promise<void>;
     /**
      * Create a new record
      *
@@ -92,7 +99,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    create(body: ApiTypes.ItemCreateSchema): Promise<ApiTypes.Item>;
+    create<D extends ItemTypeDefinition = ItemTypeDefinition>(body: ApiTypes.ItemCreateSchema<ItemTypeDefinitionToItemDefinitionAsRequest<NoInfer<D>>>): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem, ItemTypeDefinitionToItemDefinition<NoInfer<D>>>>;
     /**
      * Create a new record
      *
@@ -101,7 +108,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    rawCreate(body: RawApiTypes.ItemCreateSchema): Promise<RawApiTypes.ItemCreateTargetSchema>;
+    rawCreate<D extends ItemTypeDefinition = ItemTypeDefinition>(body: RawApiTypes.ItemCreateSchema<ItemTypeDefinitionToItemDefinitionAsRequest<NoInfer<D>>>): Promise<RawApiTypes.ItemCreateTargetSchema<ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
     /**
      * Duplicate a record
      *
@@ -110,7 +117,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    duplicate(itemId: string | ApiTypes.ItemData): Promise<ApiTypes.Item>;
+    duplicate<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem, ItemTypeDefinitionToItemDefinition<NoInfer<D>>>>;
     /**
      * Duplicate a record
      *
@@ -119,7 +126,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    rawDuplicate(itemId: string): Promise<RawApiTypes.ItemDuplicateJobSchema>;
+    rawDuplicate<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string): Promise<RawApiTypes.ItemDuplicateJobSchema<ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
     /**
      * Update a record
      *
@@ -128,7 +135,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    update(itemId: string | ApiTypes.ItemData, body: ApiTypes.ItemUpdateSchema): Promise<ApiTypes.Item>;
+    update<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData, body: ApiTypes.ItemUpdateSchema<ItemTypeDefinitionToItemDefinitionAsRequest<NoInfer<D>>>): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem, ItemTypeDefinitionToItemDefinition<NoInfer<D>>>>;
     /**
      * Update a record
      *
@@ -137,7 +144,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    rawUpdate(itemId: string, body: RawApiTypes.ItemUpdateSchema): Promise<RawApiTypes.ItemUpdateTargetSchema>;
+    rawUpdate<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, body: RawApiTypes.ItemUpdateSchema<ItemTypeDefinitionToItemDefinitionAsRequest<NoInfer<D>>>): Promise<RawApiTypes.ItemUpdateTargetSchema<ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
     /**
      * Referenced records
      *
@@ -146,7 +153,12 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    references(itemId: string | ApiTypes.ItemData, queryParams?: ApiTypes.ItemReferencesHrefSchema): Promise<ApiTypes.ItemReferencesTargetSchema>;
+    references<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData, queryParams: ApiTypes.ItemReferencesHrefSchema & {
+        nested: true;
+    }): Promise<ApiTypes.ItemReferencesTargetSchema<ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
+    references<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData, queryParams?: ApiTypes.ItemReferencesHrefSchema & {
+        nested?: false | undefined;
+    }): Promise<ApiTypes.ItemReferencesTargetSchema<ItemTypeDefinitionToItemDefinition<NoInfer<D>>>>;
     /**
      * Referenced records
      *
@@ -155,7 +167,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    rawReferences(itemId: string, queryParams?: RawApiTypes.ItemReferencesHrefSchema): Promise<RawApiTypes.ItemReferencesTargetSchema>;
+    rawReferences<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, queryParams?: RawApiTypes.ItemReferencesHrefSchema): Promise<RawApiTypes.ItemReferencesTargetSchema<ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
     /**
      * Retrieve a record
      *
@@ -164,7 +176,12 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    find(itemId: string | ApiTypes.ItemData, queryParams?: ApiTypes.ItemSelfHrefSchema): Promise<ApiTypes.Item>;
+    find<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData, queryParams: ApiTypes.ItemSelfHrefSchema & {
+        nested: true;
+    }): Promise<ApiTypes.ItemSelfTargetSchema<ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
+    find<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData, queryParams?: ApiTypes.ItemSelfHrefSchema & {
+        nested?: false | undefined;
+    }): Promise<ApiTypes.ItemSelfTargetSchema<ItemTypeDefinitionToItemDefinition<NoInfer<D>>>>;
     /**
      * Retrieve a record
      *
@@ -173,7 +190,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    rawFind(itemId: string, queryParams?: RawApiTypes.ItemSelfHrefSchema): Promise<RawApiTypes.ItemSelfTargetSchema>;
+    rawFind<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, queryParams?: RawApiTypes.ItemSelfHrefSchema): Promise<RawApiTypes.ItemSelfTargetSchema<ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
     /**
      * Retrieve information regarding changes between current and published versions of the record
      *
@@ -204,7 +221,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    destroy(itemId: string | ApiTypes.ItemData): Promise<ApiTypes.Item>;
+    destroy<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem, ItemTypeDefinitionToItemDefinition<NoInfer<D>>>>;
     /**
      * Delete a record
      *
@@ -213,7 +230,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    rawDestroy(itemId: string): Promise<RawApiTypes.ItemDestroyJobSchema>;
+    rawDestroy<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string): Promise<RawApiTypes.ItemDestroyJobSchema<ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
     /**
      * Publish a record
      *
@@ -222,7 +239,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    publish(itemId: string | ApiTypes.ItemData, body?: ApiTypes.ItemPublishSchema, queryParams?: ApiTypes.ItemPublishHrefSchema): Promise<ApiTypes.Item>;
+    publish<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData, body?: ApiTypes.ItemPublishSchema, queryParams?: ApiTypes.ItemPublishHrefSchema): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem, ItemTypeDefinitionToItemDefinition<NoInfer<D>>>>;
     /**
      * Publish a record
      *
@@ -231,7 +248,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    rawPublish(itemId: string, body?: RawApiTypes.ItemPublishSchema, queryParams?: RawApiTypes.ItemPublishHrefSchema): Promise<RawApiTypes.ItemPublishTargetSchema>;
+    rawPublish<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, body?: RawApiTypes.ItemPublishSchema, queryParams?: RawApiTypes.ItemPublishHrefSchema): Promise<RawApiTypes.ItemPublishTargetSchema<ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
     /**
      * Unpublish a record
      *
@@ -240,7 +257,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    unpublish(itemId: string | ApiTypes.ItemData, body?: ApiTypes.ItemUnpublishSchema, queryParams?: ApiTypes.ItemUnpublishHrefSchema): Promise<ApiTypes.Item>;
+    unpublish<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData, body?: ApiTypes.ItemUnpublishSchema, queryParams?: ApiTypes.ItemUnpublishHrefSchema): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem, ItemTypeDefinitionToItemDefinition<NoInfer<D>>>>;
     /**
      * Unpublish a record
      *
@@ -249,7 +266,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    rawUnpublish(itemId: string, body?: RawApiTypes.ItemUnpublishSchema, queryParams?: RawApiTypes.ItemUnpublishHrefSchema): Promise<RawApiTypes.ItemUnpublishTargetSchema>;
+    rawUnpublish<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, body?: RawApiTypes.ItemUnpublishSchema, queryParams?: RawApiTypes.ItemUnpublishHrefSchema): Promise<RawApiTypes.ItemUnpublishTargetSchema<ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
     /**
      * Publish items in bulk
      *
@@ -323,3 +340,4 @@ export default class Item extends BaseResource {
      */
     rawBulkMoveToStage(body: RawApiTypes.ItemBulkMoveToStageSchema): Promise<RawApiTypes.ItemBulkMoveToStageJobSchema>;
 }
+export {};

package/dist/types/generated/resources/ItemVersion.d.ts

@@ -12,7 +12,7 @@ export default class ItemVersion extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    restore(itemVersionId: string | ApiTypes.ItemVersionData): Promise<ApiTypes.ItemVersionRestoreJobSchema>;
+    restore(itemVersionId: string | ApiTypes.ItemVersionData): Promise<ApiTypes.ItemVersionRestoreJobSchema<import("../..").ItemDefinition<string, Record<string, unknown>>>>;
     /**
      * Restore an old record version
      *

package/dist/types/generated/resources/ScheduledPublication.d.ts

@@ -1,6 +1,8 @@
 import BaseResource from '../../BaseResource';
+import type { ItemTypeDefinition, ItemTypeDefinitionToItemDefinition, ItemTypeDefinitionToItemDefinitionWithNestedBlocks } from '../../utilities/itemDefinition';
 import type * as ApiTypes from '../ApiTypes';
 import type * as RawApiTypes from '../RawApiTypes';
+type NoInfer<T> = [T][T extends any ? 0 : never];
 export default class ScheduledPublication extends BaseResource {
     static readonly TYPE: "scheduled_publication";
     /**
@@ -29,7 +31,7 @@ export default class ScheduledPublication extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    destroy(itemId: string | ApiTypes.ItemData): Promise<ApiTypes.Item>;
+    destroy<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem, ItemTypeDefinitionToItemDefinition<NoInfer<D>>>>;
     /**
      * Delete a scheduled publication
      *
@@ -38,5 +40,6 @@ export default class ScheduledPublication extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    rawDestroy(itemId: string): Promise<RawApiTypes.ScheduledPublicationDestroyTargetSchema>;
+    rawDestroy<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string): Promise<RawApiTypes.ScheduledPublicationDestroyTargetSchema<ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
 }
+export {};

package/dist/types/generated/resources/ScheduledUnpublishing.d.ts

@@ -1,6 +1,8 @@
 import BaseResource from '../../BaseResource';
+import type { ItemTypeDefinition, ItemTypeDefinitionToItemDefinition, ItemTypeDefinitionToItemDefinitionWithNestedBlocks } from '../../utilities/itemDefinition';
 import type * as ApiTypes from '../ApiTypes';
 import type * as RawApiTypes from '../RawApiTypes';
+type NoInfer<T> = [T][T extends any ? 0 : never];
 export default class ScheduledUnpublishing extends BaseResource {
     static readonly TYPE: "scheduled_unpublishing";
     /**
@@ -29,7 +31,7 @@ export default class ScheduledUnpublishing extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    destroy(itemId: string | ApiTypes.ItemData): Promise<ApiTypes.Item>;
+    destroy<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData): Promise<ApiTypes.ApplyItemDefinitionToSchema<ApiTypes.RawItem, ItemTypeDefinitionToItemDefinition<NoInfer<D>>>>;
     /**
      * Delete a scheduled unpublishing
      *
@@ -38,5 +40,6 @@ export default class ScheduledUnpublishing extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    rawDestroy(itemId: string): Promise<RawApiTypes.ScheduledUnpublishingDestroyTargetSchema>;
+    rawDestroy<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string): Promise<RawApiTypes.ScheduledUnpublishingDestroyTargetSchema<ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
 }
+export {};

package/dist/types/generated/resources/Upload.d.ts

@@ -1,7 +1,9 @@
 import * as Utils from '@datocms/rest-client-utils';
 import BaseResource from '../../BaseResource';
+import type { ItemTypeDefinition, ItemTypeDefinitionToItemDefinition, ItemTypeDefinitionToItemDefinitionWithNestedBlocks } from '../../utilities/itemDefinition';
 import type * as ApiTypes from '../ApiTypes';
 import type * as RawApiTypes from '../RawApiTypes';
+type NoInfer<T> = [T][T extends any ? 0 : never];
 export default class Upload extends BaseResource {
     static readonly TYPE: "upload";
     /**
@@ -120,7 +122,12 @@ export default class Upload extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    references(uploadId: string | ApiTypes.UploadData, queryParams?: ApiTypes.UploadReferencesHrefSchema): Promise<ApiTypes.UploadReferencesTargetSchema>;
+    references<D extends ItemTypeDefinition = ItemTypeDefinition>(uploadId: string | ApiTypes.UploadData, queryParams: ApiTypes.UploadReferencesHrefSchema & {
+        nested: true;
+    }): Promise<ApiTypes.UploadReferencesTargetSchema<ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
+    references<D extends ItemTypeDefinition = ItemTypeDefinition>(uploadId: string | ApiTypes.UploadData, queryParams?: ApiTypes.UploadReferencesHrefSchema & {
+        nested?: false | undefined;
+    }): Promise<ApiTypes.UploadReferencesTargetSchema<ItemTypeDefinitionToItemDefinition<NoInfer<D>>>>;
     /**
      * Referenced records
      *
@@ -129,7 +136,7 @@ export default class Upload extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    rawReferences(uploadId: string, queryParams?: RawApiTypes.UploadReferencesHrefSchema): Promise<RawApiTypes.UploadReferencesTargetSchema>;
+    rawReferences<D extends ItemTypeDefinition = ItemTypeDefinition>(uploadId: string, queryParams?: RawApiTypes.UploadReferencesHrefSchema): Promise<RawApiTypes.UploadReferencesTargetSchema<ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>>>;
     /**
      * Add tags to assets in bulk
      *
@@ -185,3 +192,4 @@ export default class Upload extends BaseResource {
      */
     rawBulkDestroy(body: RawApiTypes.UploadBulkDestroySchema): Promise<RawApiTypes.UploadBulkDestroyJobSchema>;
 }
+export {};

package/dist/types/index.d.ts

@@ -10,6 +10,7 @@ export * from './utilities/fieldValue';
 export * from './utilities/id';
 export * from './utilities/recursiveBlocks';
 export * from './utilities/schemaRepository';
+export * from './utilities/itemDefinition';
 export * from './fieldTypes';
 export type { ApiTypes, RawApiTypes };
 export type { ApiTypes as SchemaTypes, RawApiTypes as SimpleSchemaTypes };

package/dist/types/utilities/buildBlockRecord.d.ts

@@ -1,32 +1,6 @@
+import type { NewBlockInARequest } from '../fieldTypes';
 import type * as ApiTypes from '../generated/ApiTypes';
-import type * as RawApiTypes from '../generated/RawApiTypes';
-export declare function buildBlockRecord(body: ApiTypes.ItemUpdateSchema): {
-    type: "item";
-    id: string;
-    attributes?: {
-        [k: string]: unknown;
-    } | undefined;
-    meta?: {
-        created_at?: string | undefined;
-        updated_at?: string | undefined;
-        published_at?: string | null | undefined;
-        first_published_at?: string | null | undefined;
-        publication_scheduled_at?: string | null | undefined;
-        unpublishing_scheduled_at?: string | null | undefined;
-        status?: "published" | "draft" | "updated" | null | undefined;
-        is_valid?: boolean | undefined;
-        current_version?: string | undefined;
-        is_current_version_valid?: boolean | null | undefined;
-        is_published_version_valid?: boolean | null | undefined;
-        stage?: string | null | undefined;
-        has_children?: boolean | null | undefined;
-    } | undefined;
-    relationships?: {
-        item_type?: {
-            data: RawApiTypes.ItemTypeData;
-        } | undefined;
-        creator?: {
-            data: RawApiTypes.UserData | RawApiTypes.SsoUserData | RawApiTypes.AccessTokenData | RawApiTypes.AccountData | RawApiTypes.OrganizationData;
-        } | undefined;
-    } | undefined;
-};
+import type { ItemTypeDefinition, ItemTypeDefinitionToItemDefinitionAsRequest } from './itemDefinition';
+type NoInfer<T> = [T][T extends any ? 0 : never];
+export declare function buildBlockRecord<D extends ItemTypeDefinition = ItemTypeDefinition>(body: ApiTypes.ItemUpdateSchema<ItemTypeDefinitionToItemDefinitionAsRequest<NoInfer<D>>>): NewBlockInARequest<ItemTypeDefinitionToItemDefinitionAsRequest<NoInfer<D>>>;
+export {};

package/dist/types/utilities/itemDefinition.d.ts

@@ -0,0 +1,74 @@
+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';
+import type { LocalizedFieldValue } from './fieldValue';
+/** Base field definition */
+type BaseFieldDefinition<Type extends string> = {
+    type: Type;
+    localized?: boolean;
+};
+type RichTextFieldDefinition<AllowedBlocks extends ItemTypeDefinition = ItemTypeDefinition> = BaseFieldDefinition<'rich_text'> & {
+    blocks: AllowedBlocks;
+};
+type SingleBlockFieldDefinition<AllowedBlocks extends ItemTypeDefinition = ItemTypeDefinition> = BaseFieldDefinition<'single_block'> & {
+    blocks: AllowedBlocks;
+};
+type StructuredTextFieldDefinition<AllowedBlocks extends ItemTypeDefinition = ItemTypeDefinition, AllowedInlineBlocks extends ItemTypeDefinition = ItemTypeDefinition> = BaseFieldDefinition<'structured_text'> & {
+    blocks: AllowedBlocks;
+    inline_blocks: AllowedInlineBlocks;
+};
+/** Field definition union */
+export type FieldDefinition = BaseFieldDefinition<'boolean' | 'color' | 'date' | 'date_time' | 'file' | 'float' | 'gallery' | 'integer' | 'json' | 'lat_lon' | 'link' | 'links' | 'seo' | 'slug' | 'string' | 'text' | 'video' | 'unknown'> | RichTextFieldDefinition | SingleBlockFieldDefinition | StructuredTextFieldDefinition;
+/** Item type definition */
+export type ItemTypeDefinition<ItemTypeId extends string = string, FieldDefinitions extends Record<string, FieldDefinition> = {}> = {
+    itemTypeId: ItemTypeId;
+    fields: FieldDefinitions;
+};
+/** Item definition */
+export type ItemDefinition<ItemTypeId extends string = string, FieldValues extends Record<string, unknown> = Record<string, unknown>> = {
+    itemTypeId: ItemTypeId;
+    fields: FieldValues;
+};
+/** Standard field values */
+type FieldTypeToValue = {
+    boolean: BooleanFieldValue;
+    color: ColorFieldValue;
+    date: DateFieldValue;
+    date_time: DateTimeFieldValue;
+    file: FileFieldValue;
+    float: FloatFieldValue;
+    gallery: GalleryFieldValue;
+    integer: IntegerFieldValue;
+    json: JsonFieldValue;
+    lat_lon: LatLonFieldValue;
+    link: LinkFieldValue;
+    links: LinksFieldValue;
+    rich_text: RichTextFieldValue;
+    seo: SeoFieldValue;
+    single_block: SingleBlockFieldValue;
+    slug: SlugFieldValue;
+    string: StringFieldValue;
+    structured_text: StructuredTextFieldValue;
+    text: TextFieldValue;
+    video: VideoFieldValue;
+    unknown: unknown;
+};
+/** Localized wrapper */
+type LocalizeIfNeeded<T extends FieldDefinition, Value> = T extends {
+    localized: true;
+} ? LocalizedFieldValue<Value> : Value;
+/** Standard mapping */
+type FieldDefinitionToFieldValue<T extends FieldDefinition> = LocalizeIfNeeded<T, FieldTypeToValue[T['type']]>;
+/** AsRequest mapping (block fields become generic over allowed blocks) */
+type FieldDefinitionToFieldValueAsRequest<T extends FieldDefinition> = T extends RichTextFieldDefinition<infer B> ? LocalizeIfNeeded<T, RichTextFieldValueAsRequest<ItemTypeDefinitionToItemDefinitionAsRequest<B>>> : T extends SingleBlockFieldDefinition<infer B> ? LocalizeIfNeeded<T, SingleBlockFieldValueAsRequest<ItemTypeDefinitionToItemDefinitionAsRequest<B>>> : T extends StructuredTextFieldDefinition<infer B, infer I> ? LocalizeIfNeeded<T, StructuredTextFieldValueAsRequest<ItemTypeDefinitionToItemDefinitionAsRequest<B>, ItemTypeDefinitionToItemDefinitionAsRequest<I>>> : LocalizeIfNeeded<T, FieldTypeToValue[T['type']]>;
+type FieldDefinitionToFieldValueWithNestedBlocks<T extends FieldDefinition> = T extends RichTextFieldDefinition<infer B> ? LocalizeIfNeeded<T, RichTextFieldValueWithNestedBlocks<ItemTypeDefinitionToItemDefinitionWithNestedBlocks<B>>> : T extends SingleBlockFieldDefinition<infer B> ? LocalizeIfNeeded<T, SingleBlockFieldValueWithNestedBlocks<ItemTypeDefinitionToItemDefinitionWithNestedBlocks<B>>> : T extends StructuredTextFieldDefinition<infer B, infer I> ? LocalizeIfNeeded<T, StructuredTextFieldValueWithNestedBlocks<ItemTypeDefinitionToItemDefinitionWithNestedBlocks<B>, ItemTypeDefinitionToItemDefinitionWithNestedBlocks<I>>> : LocalizeIfNeeded<T, FieldTypeToValue[T['type']]>;
+/** Transformers */
+export type ItemTypeDefinitionToItemDefinition<T extends ItemTypeDefinition> = T extends ItemTypeDefinition ? keyof T['fields'] extends never ? ItemDefinition<T['itemTypeId']> : ItemDefinition<T['itemTypeId'], {
+    [K in keyof T['fields']]: T['fields'][K] extends FieldDefinition ? FieldDefinitionToFieldValue<T['fields'][K]> : never;
+}> : never;
+export type ItemTypeDefinitionToItemDefinitionAsRequest<T extends ItemTypeDefinition> = T extends ItemTypeDefinition ? keyof T['fields'] extends never ? ItemDefinition<T['itemTypeId']> : ItemDefinition<T['itemTypeId'], Partial<{
+    [K in keyof T['fields']]: T['fields'][K] extends FieldDefinition ? FieldDefinitionToFieldValueAsRequest<T['fields'][K]> : never;
+}>> : never;
+export type ItemTypeDefinitionToItemDefinitionWithNestedBlocks<T extends ItemTypeDefinition> = T extends ItemTypeDefinition ? keyof T['fields'] extends never ? ItemDefinition<T['itemTypeId']> : ItemDefinition<T['itemTypeId'], {
+    [K in keyof T['fields']]: T['fields'][K] extends FieldDefinition ? FieldDefinitionToFieldValueWithNestedBlocks<T['fields'][K]> : never;
+}> : never;
+export type UnknownField = Record<string, unknown>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datocms/cma-client",
-  "version": "5.1.3",
+  "version": "5.1.4",
   "description": "JS client for DatoCMS REST Content Management API",
   "keywords": [
     "datocms",
@@ -37,13 +37,13 @@
     "url": "https://github.com/datocms/js-rest-api-clients/issues"
   },
   "dependencies": {
-    "@datocms/rest-client-utils": "^5.1.2",
-    "datocms-structured-text-utils": "^5.1.0",
+    "@datocms/rest-client-utils": "^5.1.4",
+    "datocms-structured-text-utils": "^5.1.1",
     "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@datocms/dashboard-client": "^5.1.2",
+    "@datocms/dashboard-client": "^5.1.4",
     "@types/uuid": "^9.0.7"
   },
-  "gitHead": "69bf5360c450dc20913dbafd63c12e1306c230b3"
+  "gitHead": "b9b3aee7d6c78acdfef811fa42a84bc42abc36f7"
 }