@datocms/cma-client 5.4.12 → 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":";;;;;;;;;;;;;;;;AAAA,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.12', 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,3 +1,72 @@
+import type * as ApiTypes from '../generated/ApiTypes.js';
+import type * as RawApiTypes from '../generated/RawApiTypes.js';
+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,
+ * inside the payload of `client.items.update`.
+ *
+ * Reach for it when you're rebuilding a field value piece-by-piece (typically
+ * an array of blocks or links) and want a type for the variable you're
+ * collecting into, without restating the field's shape by hand.
+ *
+ * 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. 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
+ * // back to the CMA.
+ * const page = await client.items.find<LandingPage>(id, { nested: true });
+ *
+ * const sections: NonNullable<FieldValueInRequest<typeof page, 'sections'>> = [];
+ *
+ * for (const block of page.sections) {
+ *   if (isBlockOfType(HeroBlock.ID, block)) {
+ *     sections.push(buildBlockRecord<HeroBlock>({ id: block.id, title: 'New' }));
+ *   } else {
+ *     sections.push(block.id);
+ *   }
+ * }
+ *
+ * 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":"AAAA,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.12', 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