@datocms/cma-client 5.1.3 → 5.1.4

package/src/generated/resources/ScheduledPublication.ts

@@ -1,8 +1,16 @@
 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 ScheduledPublication extends BaseResource {
   static readonly TYPE = 'scheduled_publication' as const;
 
@@ -64,11 +72,15 @@ export default class ScheduledPublication extends BaseResource {
    * @throws {ApiError}
    * @throws {TimeoutError}
    */
-  destroy(itemId: string | ApiTypes.ItemData) {
-    return this.rawDestroy(Utils.toId(itemId)).then((body) =>
-      Utils.deserializeResponseBody<ApiTypes.ScheduledPublicationDestroyTargetSchema>(
-        body,
-      ),
+  destroy<D extends ItemTypeDefinition = ItemTypeDefinition>(
+    itemId: string | ApiTypes.ItemData,
+  ) {
+    return this.rawDestroy<D>(Utils.toId(itemId)).then((body) =>
+      Utils.deserializeResponseBody<
+        ApiTypes.ScheduledPublicationDestroyTargetSchema<
+          ItemTypeDefinitionToItemDefinition<NoInfer<D>>
+        >
+      >(body),
     );
   }
 
@@ -80,14 +92,22 @@ export default class ScheduledPublication extends BaseResource {
    * @throws {ApiError}
    * @throws {TimeoutError}
    */
-  rawDestroy(
+  rawDestroy<D extends ItemTypeDefinition = ItemTypeDefinition>(
     itemId: string,
-  ): Promise<RawApiTypes.ScheduledPublicationDestroyTargetSchema> {
-    return this.client.request<RawApiTypes.ScheduledPublicationDestroyTargetSchema>(
-      {
+  ): Promise<
+    RawApiTypes.ScheduledPublicationDestroyTargetSchema<
+      ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>
+    >
+  > {
+    return this.client
+      .request({
         method: 'DELETE',
         url: `/items/${itemId}/scheduled-publication`,
-      },
-    );
+      })
+      .then<
+        RawApiTypes.ScheduledPublicationDestroyTargetSchema<
+          ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>
+        >
+      >(Utils.deserializeRawResponseBodyWithItems);
   }
 }

package/src/generated/resources/ScheduledUnpublishing.ts

@@ -1,8 +1,16 @@
 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 ScheduledUnpublishing extends BaseResource {
   static readonly TYPE = 'scheduled_unpublishing' as const;
 
@@ -64,11 +72,15 @@ export default class ScheduledUnpublishing extends BaseResource {
    * @throws {ApiError}
    * @throws {TimeoutError}
    */
-  destroy(itemId: string | ApiTypes.ItemData) {
-    return this.rawDestroy(Utils.toId(itemId)).then((body) =>
-      Utils.deserializeResponseBody<ApiTypes.ScheduledUnpublishingDestroyTargetSchema>(
-        body,
-      ),
+  destroy<D extends ItemTypeDefinition = ItemTypeDefinition>(
+    itemId: string | ApiTypes.ItemData,
+  ) {
+    return this.rawDestroy<D>(Utils.toId(itemId)).then((body) =>
+      Utils.deserializeResponseBody<
+        ApiTypes.ScheduledUnpublishingDestroyTargetSchema<
+          ItemTypeDefinitionToItemDefinition<NoInfer<D>>
+        >
+      >(body),
     );
   }
 
@@ -80,14 +92,22 @@ export default class ScheduledUnpublishing extends BaseResource {
    * @throws {ApiError}
    * @throws {TimeoutError}
    */
-  rawDestroy(
+  rawDestroy<D extends ItemTypeDefinition = ItemTypeDefinition>(
     itemId: string,
-  ): Promise<RawApiTypes.ScheduledUnpublishingDestroyTargetSchema> {
-    return this.client.request<RawApiTypes.ScheduledUnpublishingDestroyTargetSchema>(
-      {
+  ): Promise<
+    RawApiTypes.ScheduledUnpublishingDestroyTargetSchema<
+      ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>
+    >
+  > {
+    return this.client
+      .request({
         method: 'DELETE',
         url: `/items/${itemId}/scheduled-unpublishing`,
-      },
-    );
+      })
+      .then<
+        RawApiTypes.ScheduledUnpublishingDestroyTargetSchema<
+          ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>
+        >
+      >(Utils.deserializeRawResponseBodyWithItems);
   }
 }

package/src/generated/resources/Upload.ts

@@ -1,8 +1,16 @@
 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 Upload extends BaseResource {
   static readonly TYPE = 'upload' as const;
 
@@ -256,14 +264,38 @@ export default class Upload extends BaseResource {
    * @throws {ApiError}
    * @throws {TimeoutError}
    */
-  references(
+  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
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/upload/references
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  references<D extends ItemTypeDefinition = ItemTypeDefinition>(
     uploadId: string | ApiTypes.UploadData,
     queryParams?: ApiTypes.UploadReferencesHrefSchema,
   ) {
-    return this.rawReferences(Utils.toId(uploadId), queryParams).then((body) =>
-      Utils.deserializeResponseBody<ApiTypes.UploadReferencesTargetSchema>(
-        body,
-      ),
+    return this.rawReferences<D>(Utils.toId(uploadId), queryParams).then(
+      (body) => Utils.deserializeResponseBody(body),
     );
   }
 
@@ -275,15 +307,25 @@ export default class Upload extends BaseResource {
    * @throws {ApiError}
    * @throws {TimeoutError}
    */
-  rawReferences(
+  rawReferences<D extends ItemTypeDefinition = ItemTypeDefinition>(
     uploadId: string,
     queryParams?: RawApiTypes.UploadReferencesHrefSchema,
-  ): Promise<RawApiTypes.UploadReferencesTargetSchema> {
-    return this.client.request<RawApiTypes.UploadReferencesTargetSchema>({
-      method: 'GET',
-      url: `/uploads/${uploadId}/references`,
-      queryParams,
-    });
+  ): Promise<
+    RawApiTypes.UploadReferencesTargetSchema<
+      ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>
+    >
+  > {
+    return this.client
+      .request({
+        method: 'GET',
+        url: `/uploads/${uploadId}/references`,
+        queryParams,
+      })
+      .then<
+        RawApiTypes.UploadReferencesTargetSchema<
+          ItemTypeDefinitionToItemDefinitionWithNestedBlocks<NoInfer<D>>
+        >
+      >(Utils.deserializeRawResponseBodyWithItems);
   }
 
   /**

package/src/index.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 };
 // Legacy names

package/src/utilities/buildBlockRecord.ts

@@ -1,10 +1,26 @@
 import * as Utils from '@datocms/rest-client-utils';
+import type { NewBlockInARequest } from '../fieldTypes';
 import type * as ApiTypes from '../generated/ApiTypes';
-import type * as RawApiTypes from '../generated/RawApiTypes';
 import { Item } from '../generated/resources';
+import type {
+  ItemTypeDefinition,
+  ItemTypeDefinitionToItemDefinitionAsRequest,
+} from './itemDefinition';
 
-export function buildBlockRecord(body: ApiTypes.ItemUpdateSchema) {
-  return Utils.serializeRequestBody<RawApiTypes.ItemUpdateSchema>(body, {
+type NoInfer<T> = [T][T extends any ? 0 : never];
+
+export function buildBlockRecord<
+  D extends ItemTypeDefinition = ItemTypeDefinition,
+>(
+  body: ApiTypes.ItemUpdateSchema<
+    ItemTypeDefinitionToItemDefinitionAsRequest<NoInfer<D>>
+  >,
+): NewBlockInARequest<ItemTypeDefinitionToItemDefinitionAsRequest<NoInfer<D>>> {
+  return Utils.serializeRequestBody<{
+    data: NewBlockInARequest<
+      ItemTypeDefinitionToItemDefinitionAsRequest<NoInfer<D>>
+    >;
+  }>(body, {
     type: Item.TYPE,
     attributes: '*',
     relationships: ['item_type'],

package/src/utilities/itemDefinition.ts

@@ -0,0 +1,229 @@
+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>;