@datocms/cma-client 5.4.13 → 5.4.14

package/dist/cjs/fieldTypes/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/fieldTypes/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAsDA,wDAAsC;AACtC,+CAA6B;AAC7B,6CAA2B;AAC3B,4CAA0B;AAC1B,iDAA+B;AAC/B,4CAA0B;AAC1B,6CAA2B;AAC3B,+CAA6B;AAC7B,+CAA6B;AAC7B,4CAA0B;AAC1B,+CAA6B;AAC7B,4CAA0B;AAC1B,6CAA2B;AAC3B,iDAA+B;AAC/B,2CAAyB;AACzB,oDAAkC;AAClC,4CAA0B;AAC1B,8CAA4B;AAC5B,uDAAqC;AACrC,4CAA0B;AAC1B,wDAAsC;AACtC,6CAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/fieldTypes/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAwGA,wDAAsC;AACtC,+CAA6B;AAC7B,6CAA2B;AAC3B,4CAA0B;AAC1B,iDAA+B;AAC/B,4CAA0B;AAC1B,6CAA2B;AAC3B,+CAA6B;AAC7B,+CAA6B;AAC7B,4CAA0B;AAC1B,+CAA6B;AAC7B,4CAA0B;AAC1B,6CAA2B;AAC3B,iDAA+B;AAC/B,2CAAyB;AACzB,oDAAkC;AAClC,4CAA0B;AAC1B,8CAA4B;AAC5B,uDAAqC;AACrC,4CAA0B;AAC1B,wDAAsC;AACtC,6CAA2B"}

package/dist/cjs/generated/Client.js

@@ -90,7 +90,7 @@ class Client {
         return this.config.baseUrl || Client.defaultBaseUrl;
     }
     request(options) {
-        return (0, rest_client_utils_1.request)(Object.assign(Object.assign(Object.assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v5.4.13', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: Object.assign(Object.assign(Object.assign({}, (this.config.extraHeaders || {})), (this.config.environment
+        return (0, rest_client_utils_1.request)(Object.assign(Object.assign(Object.assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v5.4.14', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: Object.assign(Object.assign(Object.assign({}, (this.config.extraHeaders || {})), (this.config.environment
                 ? { 'X-Environment': this.config.environment }
                 : {})), { 'X-API-Version': '3' }), fetchJobResult: (jobId) => {
                 return this.jobResultsFetcher

package/dist/esm/fieldTypes/index.d.ts

@@ -1,7 +1,7 @@
 import type * as ApiTypes from '../generated/ApiTypes.js';
 import type * as RawApiTypes from '../generated/RawApiTypes.js';
-import type { ToItemAttributesInRequest } from '../utilities/itemDefinition.js';
-type ItemTypeDefinitionOf<T> = T extends ApiTypes.Item<infer D> ? D : T extends ApiTypes.ItemInNestedResponse<infer D> ? D : T extends RawApiTypes.Item<infer D> ? D : T extends RawApiTypes.ItemInNestedResponse<infer D> ? D : never;
+import type { ItemTypeDefinition, ToItemAttributes, ToItemAttributesInNestedResponse, ToItemAttributesInRequest } from '../utilities/itemDefinition.js';
+type ItemTypeDefinitionOf<T> = T extends ItemTypeDefinition<any, any, any> ? T : T extends ApiTypes.Item<infer D> ? D : T extends ApiTypes.ItemInNestedResponse<infer D> ? D : T extends RawApiTypes.Item<infer D> ? D : T extends RawApiTypes.ItemInNestedResponse<infer D> ? D : never;
 /**
  * Given a record or block you've read from the CMA and one of its field keys,
  * resolves to the type you'd send back when writing that field — for example,
@@ -13,10 +13,9 @@ type ItemTypeDefinitionOf<T> = T extends ApiTypes.Item<infer D> ? D : T extends
  *
  * The first parameter accepts any item-shaped value the CMA produces:
  * top-level records as well as nested blocks inside a parent record's
- * modular-content / structured-text / single-block field.
- *
- * The resulting type preserves `null`. Every CMA field can be cleared by
- * sending `null`, so the type reflects that.
+ * modular-content / structured-text / single-block field. You can also pass
+ * an `ItemTypeDefinition` directly when you already have the definition type
+ * in hand and don't need to round-trip through an `ApiTypes.Item<…>` shape.
  *
  * @example
  * // Read a record with nested blocks, edit one block, write the whole field
@@ -36,6 +35,38 @@ type ItemTypeDefinitionOf<T> = T extends ApiTypes.Item<infer D> ? D : T extends
  * await client.items.update<LandingPage>(page.id, { sections });
  */
 export type FieldValueInRequest<T, K extends keyof ToItemAttributesInRequest<ItemTypeDefinitionOf<T>>> = K extends keyof ToItemAttributesInRequest<ItemTypeDefinitionOf<T>> ? Required<ToItemAttributesInRequest<ItemTypeDefinitionOf<T>>>[K] : never;
+/**
+ * Given a record or block you've read from the CMA and one of its field keys,
+ * resolves to the field's value type as it appears in a standard (non-nested)
+ * response — for example, what you'd read off `record.attributes[fieldKey]`
+ * after `client.items.find(id)`.
+ *
+ * The first parameter accepts any item-shaped value the CMA produces, or an
+ * `ItemTypeDefinition` directly.
+ *
+ * @example
+ * // Read nested, then collect just the block IDs for an outline view.
+ * const page = await client.items.find<LandingPage>(id, { nested: true });
+ * const sectionIds: FieldValue<typeof page, 'sections'> = page.sections.map(
+ *   (block) => block.id,
+ * );
+ */
+export type FieldValue<T, K extends keyof ToItemAttributes<ItemTypeDefinitionOf<T>>> = K extends keyof ToItemAttributes<ItemTypeDefinitionOf<T>> ? ToItemAttributes<ItemTypeDefinitionOf<T>>[K] : never;
+/**
+ * Given a record or block you've read from the CMA and one of its field keys,
+ * resolves to the field's value type in a nested response — i.e. what you'd
+ * read off the field after `client.items.find(id, { nested: true })`, where
+ * blocks are inlined as full objects instead of ID strings.
+ *
+ * The first parameter accepts any item-shaped value the CMA produces, or an
+ * `ItemTypeDefinition` directly.
+ *
+ * @example
+ * const page = await client.items.find<LandingPage>(id, { nested: true });
+ * const sections: FieldValueInNestedResponse<typeof page, 'sections'> = page.sections;
+ * // sections elements are full block objects, not ID strings.
+ */
+export type FieldValueInNestedResponse<T, K extends keyof ToItemAttributesInNestedResponse<ItemTypeDefinitionOf<T>>> = K extends keyof ToItemAttributesInNestedResponse<ItemTypeDefinitionOf<T>> ? ToItemAttributesInNestedResponse<ItemTypeDefinitionOf<T>>[K] : never;
 export * from './appearance/index.js';
 export * from './boolean.js';
 export * from './color.js';

package/dist/esm/fieldTypes/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/fieldTypes/index.ts"],"names":[],"mappings":"AAsDA,cAAc,uBAAuB,CAAC;AACtC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,WAAW,CAAC;AAC1B,cAAc,uBAAuB,CAAC;AACtC,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/fieldTypes/index.ts"],"names":[],"mappings":"AAwGA,cAAc,uBAAuB,CAAC;AACtC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,WAAW,CAAC;AAC1B,cAAc,uBAAuB,CAAC;AACtC,cAAc,YAAY,CAAC"}

package/dist/esm/generated/Client.js

@@ -64,7 +64,7 @@ export class Client {
         return this.config.baseUrl || Client.defaultBaseUrl;
     }
     request(options) {
-        return request(Object.assign(Object.assign(Object.assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v5.4.13', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: Object.assign(Object.assign(Object.assign({}, (this.config.extraHeaders || {})), (this.config.environment
+        return request(Object.assign(Object.assign(Object.assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v5.4.14', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: Object.assign(Object.assign(Object.assign({}, (this.config.extraHeaders || {})), (this.config.environment
                 ? { 'X-Environment': this.config.environment }
                 : {})), { 'X-API-Version': '3' }), fetchJobResult: (jobId) => {
                 return this.jobResultsFetcher

package/dist/types/fieldTypes/index.d.ts

@@ -1,7 +1,7 @@
 import type * as ApiTypes from '../generated/ApiTypes.js';
 import type * as RawApiTypes from '../generated/RawApiTypes.js';
-import type { ToItemAttributesInRequest } from '../utilities/itemDefinition.js';
-type ItemTypeDefinitionOf<T> = T extends ApiTypes.Item<infer D> ? D : T extends ApiTypes.ItemInNestedResponse<infer D> ? D : T extends RawApiTypes.Item<infer D> ? D : T extends RawApiTypes.ItemInNestedResponse<infer D> ? D : never;
+import type { ItemTypeDefinition, ToItemAttributes, ToItemAttributesInNestedResponse, ToItemAttributesInRequest } from '../utilities/itemDefinition.js';
+type ItemTypeDefinitionOf<T> = T extends ItemTypeDefinition<any, any, any> ? T : T extends ApiTypes.Item<infer D> ? D : T extends ApiTypes.ItemInNestedResponse<infer D> ? D : T extends RawApiTypes.Item<infer D> ? D : T extends RawApiTypes.ItemInNestedResponse<infer D> ? D : never;
 /**
  * Given a record or block you've read from the CMA and one of its field keys,
  * resolves to the type you'd send back when writing that field — for example,
@@ -13,10 +13,9 @@ type ItemTypeDefinitionOf<T> = T extends ApiTypes.Item<infer D> ? D : T extends
  *
  * The first parameter accepts any item-shaped value the CMA produces:
  * top-level records as well as nested blocks inside a parent record's
- * modular-content / structured-text / single-block field.
- *
- * The resulting type preserves `null`. Every CMA field can be cleared by
- * sending `null`, so the type reflects that.
+ * modular-content / structured-text / single-block field. You can also pass
+ * an `ItemTypeDefinition` directly when you already have the definition type
+ * in hand and don't need to round-trip through an `ApiTypes.Item<…>` shape.
  *
  * @example
  * // Read a record with nested blocks, edit one block, write the whole field
@@ -36,6 +35,38 @@ type ItemTypeDefinitionOf<T> = T extends ApiTypes.Item<infer D> ? D : T extends
  * await client.items.update<LandingPage>(page.id, { sections });
  */
 export type FieldValueInRequest<T, K extends keyof ToItemAttributesInRequest<ItemTypeDefinitionOf<T>>> = K extends keyof ToItemAttributesInRequest<ItemTypeDefinitionOf<T>> ? Required<ToItemAttributesInRequest<ItemTypeDefinitionOf<T>>>[K] : never;
+/**
+ * Given a record or block you've read from the CMA and one of its field keys,
+ * resolves to the field's value type as it appears in a standard (non-nested)
+ * response — for example, what you'd read off `record.attributes[fieldKey]`
+ * after `client.items.find(id)`.
+ *
+ * The first parameter accepts any item-shaped value the CMA produces, or an
+ * `ItemTypeDefinition` directly.
+ *
+ * @example
+ * // Read nested, then collect just the block IDs for an outline view.
+ * const page = await client.items.find<LandingPage>(id, { nested: true });
+ * const sectionIds: FieldValue<typeof page, 'sections'> = page.sections.map(
+ *   (block) => block.id,
+ * );
+ */
+export type FieldValue<T, K extends keyof ToItemAttributes<ItemTypeDefinitionOf<T>>> = K extends keyof ToItemAttributes<ItemTypeDefinitionOf<T>> ? ToItemAttributes<ItemTypeDefinitionOf<T>>[K] : never;
+/**
+ * Given a record or block you've read from the CMA and one of its field keys,
+ * resolves to the field's value type in a nested response — i.e. what you'd
+ * read off the field after `client.items.find(id, { nested: true })`, where
+ * blocks are inlined as full objects instead of ID strings.
+ *
+ * The first parameter accepts any item-shaped value the CMA produces, or an
+ * `ItemTypeDefinition` directly.
+ *
+ * @example
+ * const page = await client.items.find<LandingPage>(id, { nested: true });
+ * const sections: FieldValueInNestedResponse<typeof page, 'sections'> = page.sections;
+ * // sections elements are full block objects, not ID strings.
+ */
+export type FieldValueInNestedResponse<T, K extends keyof ToItemAttributesInNestedResponse<ItemTypeDefinitionOf<T>>> = K extends keyof ToItemAttributesInNestedResponse<ItemTypeDefinitionOf<T>> ? ToItemAttributesInNestedResponse<ItemTypeDefinitionOf<T>>[K] : never;
 export * from './appearance/index.js';
 export * from './boolean.js';
 export * from './color.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datocms/cma-client",
-  "version": "5.4.13",
+  "version": "5.4.14",
   "description": "JS client for DatoCMS REST Content Management API",
   "keywords": [
     "datocms",
@@ -45,5 +45,5 @@
     "@datocms/dashboard-client": "^5.4.9",
     "@types/uuid": "^9.0.7"
   },
-  "gitHead": "e2ccb5d21e7c5b25525568581f1b8e1db18cc3b8"
+  "gitHead": "aad77038aa0c91a6439c46f836199d129f88f70f"
 }

package/src/fieldTypes/index.ts

@@ -1,16 +1,23 @@
 import type * as ApiTypes from '../generated/ApiTypes.js';
 import type * as RawApiTypes from '../generated/RawApiTypes.js';
-import type { ToItemAttributesInRequest } from '../utilities/itemDefinition.js';
+import type {
+  ItemTypeDefinition,
+  ToItemAttributes,
+  ToItemAttributesInNestedResponse,
+  ToItemAttributesInRequest,
+} from '../utilities/itemDefinition.js';
 
-type ItemTypeDefinitionOf<T> = T extends ApiTypes.Item<infer D>
-  ? D
-  : T extends ApiTypes.ItemInNestedResponse<infer D>
+type ItemTypeDefinitionOf<T> = T extends ItemTypeDefinition<any, any, any>
+  ? T
+  : T extends ApiTypes.Item<infer D>
     ? D
-    : T extends RawApiTypes.Item<infer D>
+    : T extends ApiTypes.ItemInNestedResponse<infer D>
       ? D
-      : T extends RawApiTypes.ItemInNestedResponse<infer D>
+      : T extends RawApiTypes.Item<infer D>
         ? D
-        : never;
+        : T extends RawApiTypes.ItemInNestedResponse<infer D>
+          ? D
+          : never;
 
 /**
  * Given a record or block you've read from the CMA and one of its field keys,
@@ -23,10 +30,9 @@ type ItemTypeDefinitionOf<T> = T extends ApiTypes.Item<infer D>
  *
  * The first parameter accepts any item-shaped value the CMA produces:
  * top-level records as well as nested blocks inside a parent record's
- * modular-content / structured-text / single-block field.
- *
- * The resulting type preserves `null`. Every CMA field can be cleared by
- * sending `null`, so the type reflects that.
+ * modular-content / structured-text / single-block field. You can also pass
+ * an `ItemTypeDefinition` directly when you already have the definition type
+ * in hand and don't need to round-trip through an `ApiTypes.Item<…>` shape.
  *
  * @example
  * // Read a record with nested blocks, edit one block, write the whole field
@@ -52,6 +58,50 @@ export type FieldValueInRequest<
   ? Required<ToItemAttributesInRequest<ItemTypeDefinitionOf<T>>>[K]
   : never;
 
+/**
+ * Given a record or block you've read from the CMA and one of its field keys,
+ * resolves to the field's value type as it appears in a standard (non-nested)
+ * response — for example, what you'd read off `record.attributes[fieldKey]`
+ * after `client.items.find(id)`.
+ *
+ * The first parameter accepts any item-shaped value the CMA produces, or an
+ * `ItemTypeDefinition` directly.
+ *
+ * @example
+ * // Read nested, then collect just the block IDs for an outline view.
+ * const page = await client.items.find<LandingPage>(id, { nested: true });
+ * const sectionIds: FieldValue<typeof page, 'sections'> = page.sections.map(
+ *   (block) => block.id,
+ * );
+ */
+export type FieldValue<
+  T,
+  K extends keyof ToItemAttributes<ItemTypeDefinitionOf<T>>,
+> = K extends keyof ToItemAttributes<ItemTypeDefinitionOf<T>>
+  ? ToItemAttributes<ItemTypeDefinitionOf<T>>[K]
+  : never;
+
+/**
+ * Given a record or block you've read from the CMA and one of its field keys,
+ * resolves to the field's value type in a nested response — i.e. what you'd
+ * read off the field after `client.items.find(id, { nested: true })`, where
+ * blocks are inlined as full objects instead of ID strings.
+ *
+ * The first parameter accepts any item-shaped value the CMA produces, or an
+ * `ItemTypeDefinition` directly.
+ *
+ * @example
+ * const page = await client.items.find<LandingPage>(id, { nested: true });
+ * const sections: FieldValueInNestedResponse<typeof page, 'sections'> = page.sections;
+ * // sections elements are full block objects, not ID strings.
+ */
+export type FieldValueInNestedResponse<
+  T,
+  K extends keyof ToItemAttributesInNestedResponse<ItemTypeDefinitionOf<T>>,
+> = K extends keyof ToItemAttributesInNestedResponse<ItemTypeDefinitionOf<T>>
+  ? ToItemAttributesInNestedResponse<ItemTypeDefinitionOf<T>>[K]
+  : never;
+
 export * from './appearance/index.js';
 export * from './boolean.js';
 export * from './color.js';

package/src/generated/Client.ts

@@ -151,7 +151,7 @@ export class Client {
       ...this.config,
       ...options,
       logFn: this.config.logFn || console.log,
-      userAgent: '@datocms/cma-client v5.4.13',
+      userAgent: '@datocms/cma-client v5.4.14',
       baseUrl: this.baseUrl,
       preCallStack: new Error().stack,
       extraHeaders: {