@datocms/cma-client 5.0.0 → 5.1.0

package/dist/esm/fieldTypes/gallery.js

@@ -0,0 +1,7 @@
+export function isGalleryFieldValue(value) {
+    if (value === null)
+        return true;
+    return (Array.isArray(value) &&
+        value.every((item) => typeof item === 'object' && item !== null && 'upload_id' in item));
+}
+//# sourceMappingURL=gallery.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"gallery.js","sourceRoot":"","sources":["../../../src/fieldTypes/gallery.ts"],"names":[],"mappings":"AAmBA,MAAM,UAAU,mBAAmB,CACjC,KAAc;IAEd,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAChC,OAAO,CACL,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACpB,KAAK,CAAC,KAAK,CACT,CAAC,IAAI,EAAE,EAAE,CACP,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,WAAW,IAAI,IAAI,CACnE,CACF,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,22 @@
+export * from './boolean';
+export * from './color';
+export * from './date';
+export * from './date_time';
+export * from './file';
+export * from './float';
+export * from './gallery';
+export * from './integer';
+export * from './json';
+export * from './lat_lon';
+export * from './link';
+export * from './links';
+export * from './rich_text';
+export * from './seo';
+export * from './single_block';
+export * from './slug';
+export * from './string';
+export * from './structured_text';
+export * from './text';
+export * from './video';
+export * from './appearance';
+export * from './validators';

package/dist/esm/fieldTypes/index.js

@@ -0,0 +1,23 @@
+export * from './boolean';
+export * from './color';
+export * from './date';
+export * from './date_time';
+export * from './file';
+export * from './float';
+export * from './gallery';
+export * from './integer';
+export * from './json';
+export * from './lat_lon';
+export * from './link';
+export * from './links';
+export * from './rich_text';
+export * from './seo';
+export * from './single_block';
+export * from './slug';
+export * from './string';
+export * from './structured_text';
+export * from './text';
+export * from './video';
+export * from './appearance';
+export * from './validators';
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/fieldTypes/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,OAAO,CAAC;AACtB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AAExB,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC"}

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

@@ -0,0 +1,20 @@
+import type { IntegerEditorConfiguration } from './appearance/integer';
+import type { NumberRangeValidator } from './validators/number_range';
+import type { RequiredValidator } from './validators/required';
+export type IntegerFieldValue = number | null;
+export declare function isIntegerFieldValue(value: unknown): value is IntegerFieldValue;
+export type IntegerFieldValidators = {
+    /** Value must be specified or it won't be valid */
+    required?: RequiredValidator;
+    /** Accept numbers only inside a specified range */
+    number_range?: NumberRangeValidator;
+};
+export type IntegerFieldAppearance = {
+    editor: 'integer';
+    parameters: IntegerEditorConfiguration;
+} | {
+    /** Plugin ID */
+    editor: string;
+    /** Plugin configuration */
+    parameters: Record<string, unknown>;
+};

package/dist/esm/fieldTypes/integer.js

@@ -0,0 +1,4 @@
+export function isIntegerFieldValue(value) {
+    return typeof value === 'number' || value === null;
+}
+//# sourceMappingURL=integer.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"integer.js","sourceRoot":"","sources":["../../../src/fieldTypes/integer.ts"],"names":[],"mappings":"AAMA,MAAM,UAAU,mBAAmB,CACjC,KAAc;IAEd,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;AACrD,CAAC"}

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

@@ -0,0 +1,25 @@
+import type { JsonEditorConfiguration } from './appearance/json';
+import type { StringCheckboxGroupEditorConfiguration } from './appearance/string_checkbox_group';
+import type { StringMultiSelectEditorConfiguration } from './appearance/string_multi_select';
+import type { RequiredValidator } from './validators/required';
+export type JsonFieldValue = string | null;
+export declare function isJsonFieldValue(value: unknown): value is JsonFieldValue;
+export type JsonFieldValidators = {
+    /** Value must be specified or it won't be valid */
+    required?: RequiredValidator;
+};
+export type JsonFieldAppearance = {
+    editor: 'json';
+    parameters: JsonEditorConfiguration;
+} | {
+    editor: 'string_multi_select';
+    parameters: StringMultiSelectEditorConfiguration;
+} | {
+    editor: 'string_checkbox_group';
+    parameters: StringCheckboxGroupEditorConfiguration;
+} | {
+    /** Plugin ID */
+    editor: string;
+    /** Plugin configuration */
+    parameters: Record<string, unknown>;
+};

package/dist/esm/fieldTypes/json.js

@@ -0,0 +1,14 @@
+export function isJsonFieldValue(value) {
+    if (value === null)
+        return true;
+    if (typeof value !== 'string')
+        return false;
+    try {
+        JSON.parse(value);
+        return true;
+    }
+    catch (_a) {
+        return false;
+    }
+}
+//# sourceMappingURL=json.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"json.js","sourceRoot":"","sources":["../../../src/fieldTypes/json.ts"],"names":[],"mappings":"AAOA,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAChC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC5C,IAAI;QACF,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAClB,OAAO,IAAI,CAAC;KACb;IAAC,WAAM;QACN,OAAO,KAAK,CAAC;KACd;AACH,CAAC"}

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

@@ -0,0 +1,20 @@
+import type { MapEditorConfiguration } from './appearance/map';
+import type { RequiredValidator } from './validators/required';
+export type LocationFieldValue = {
+    latitude: number;
+    longitude: number;
+} | null;
+export declare function isLocationFieldValue(value: unknown): value is LocationFieldValue;
+export type LocationFieldValidators = {
+    /** Value must be specified or it won't be valid */
+    required?: RequiredValidator;
+};
+export type LocationFieldAppearance = {
+    editor: 'map';
+    parameters: MapEditorConfiguration;
+} | {
+    /** Plugin ID */
+    editor: string;
+    /** Plugin configuration */
+    parameters: Record<string, unknown>;
+};

package/dist/esm/fieldTypes/lat_lon.js

@@ -0,0 +1,9 @@
+export function isLocationFieldValue(value) {
+    if (value === null)
+        return true;
+    return (typeof value === 'object' &&
+        value !== null &&
+        'latitude' in value &&
+        'longitude' in value);
+}
+//# sourceMappingURL=lat_lon.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"lat_lon.js","sourceRoot":"","sources":["../../../src/fieldTypes/lat_lon.ts"],"names":[],"mappings":"AAQA,MAAM,UAAU,oBAAoB,CAClC,KAAc;IAEd,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAChC,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,UAAU,IAAI,KAAK;QACnB,WAAW,IAAI,KAAK,CACrB,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,27 @@
+import type { LinkEmbedEditorConfiguration } from './appearance/link_embed';
+import type { LinkSelectEditorConfiguration } from './appearance/link_select';
+import type { ItemItemTypeValidator } from './validators/item_item_type';
+import type { RequiredValidator } from './validators/required';
+import type { UniqueValidator } from './validators/unique';
+export type LinkFieldValue = string | null;
+export declare function isLinkFieldValue(value: unknown): value is LinkFieldValue;
+export type LinkFieldValidators = {
+    /** Only accept references to records of the specified models */
+    item_item_type: ItemItemTypeValidator;
+    /** Value must be specified or it won't be valid */
+    required?: RequiredValidator;
+    /** The value must be unique across the whole collection of records */
+    unique?: UniqueValidator;
+};
+export type LinkFieldAppearance = {
+    editor: 'link_select';
+    parameters: LinkSelectEditorConfiguration;
+} | {
+    editor: 'link_embed';
+    parameters: LinkEmbedEditorConfiguration;
+} | {
+    /** Plugin ID */
+    editor: string;
+    /** Plugin configuration */
+    parameters: Record<string, unknown>;
+};

package/dist/esm/fieldTypes/link.js

@@ -0,0 +1,4 @@
+export function isLinkFieldValue(value) {
+    return typeof value === 'string' || value === null;
+}
+//# sourceMappingURL=link.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"link.js","sourceRoot":"","sources":["../../../src/fieldTypes/link.ts"],"names":[],"mappings":"AAQA,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;AACrD,CAAC"}

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

@@ -0,0 +1,24 @@
+import type { LinksEmbedEditorConfiguration } from './appearance/links_embed';
+import type { LinksSelectEditorConfiguration } from './appearance/links_select';
+import type { ItemsItemTypeValidator } from './validators/items_item_type';
+import type { SizeValidator } from './validators/size';
+export type LinksFieldValue = string[] | null;
+export declare function isLinksFieldValue(value: unknown): value is LinksFieldValue;
+export type LinksFieldValidators = {
+    /** Only accept references to records of the specified models */
+    items_item_type: ItemsItemTypeValidator;
+    /** Only accept a number of items within the specified range */
+    size?: SizeValidator;
+};
+export type LinksFieldAppearance = {
+    editor: 'links_select';
+    parameters: LinksSelectEditorConfiguration;
+} | {
+    editor: 'links_embed';
+    parameters: LinksEmbedEditorConfiguration;
+} | {
+    /** Plugin ID */
+    editor: string;
+    /** Plugin configuration */
+    parameters: Record<string, unknown>;
+};

package/dist/esm/fieldTypes/links.js

@@ -0,0 +1,6 @@
+export function isLinksFieldValue(value) {
+    if (value === null)
+        return true;
+    return (Array.isArray(value) && value.every((item) => typeof item === 'string'));
+}
+//# sourceMappingURL=links.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"links.js","sourceRoot":"","sources":["../../../src/fieldTypes/links.ts"],"names":[],"mappings":"AAOA,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC9C,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAChC,OAAO,CACL,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CACxE,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,100 @@
+import type * as SchemaTypes from '../generated/SchemaTypes';
+import { type BlockItemInARequest } from './single_block';
+/**
+ * MODULAR CONTENT FIELD TYPE SYSTEM FOR DATOCMS
+ *
+ * This module defines a comprehensive type system for handling DatoCMS Modular Content fields,
+ * which are arrays of embedded content blocks.
+ *
+ * The challenge we're solving:
+ * - DatoCMS Modular Content fields contain arrays of "blocks" (embedded content items)
+ * - By default, API responses contain blocks as string IDs (lightweight references)
+ * - With ?nested=true parameter, API responses contain blocks as full block objects
+ *   (which in turn can contain other blocks)
+ * - For API requests, blocks can be represented as:
+ *   1. String IDs (referencing existing blocks)
+ *   2. Full block objects with IDs (for updates)
+ *   3. Block objects without IDs (for creation)
+ *
+ * This creates a need for different type variants for the same conceptual data structure.
+ */
+/**
+ * =============================================================================
+ * BASIC MODULAR CONTENT TYPE - Default API response format
+ * =============================================================================
+ *
+ * The standard Modular Content field value containing block references as string IDs.
+ * This is what you get from regular API responses without ?nested=true.
+ */
+/**
+ * Basic Modular Content field value - array of string block IDs (lightweight references)
+ */
+export type RichTextFieldValue = string[] | null;
+/**
+ * =============================================================================
+ * REQUEST VARIANT - Type for sending data TO the DatoCMS API
+ * =============================================================================
+ *
+ * When making API requests, we need flexibility in how we represent embedded blocks:
+ * - Use string IDs to reference existing blocks that do not need to change
+ * - Include full block objects for updates
+ * - Omit IDs for new blocks being created
+ */
+/**
+ * Modular Content field value for API requests - allows flexible block representations:
+ * - string: Just the block ID (most common case)
+ * - SchemaTypes.Item: Full block object with ID (for updates)
+ * - Omit<SchemaTypes.Item, 'id'>: Block object without ID (for creation)
+ */
+export type RichTextFieldValueAsRequest = BlockItemInARequest[] | null;
+/**
+ * =============================================================================
+ * NESTED VARIANT - Type for API responses with ?nested=true parameter
+ * =============================================================================
+ *
+ * When using the ?nested=true query parameter, the API returns Modular Content data
+ * with embedded blocks fully populated as complete SchemaTypes.Item objects instead
+ * of just string IDs. This provides type safety for working with fully resolved data.
+ */
+/**
+ * Modular Content field value with nested blocks - array of fully populated block objects
+ */
+export type RichTextFieldValueWithResolvedBlocks = SchemaTypes.Item[] | null;
+/**
+ * =============================================================================
+ * TYPE GUARDS - Runtime validation functions
+ * =============================================================================
+ */
+/**
+ * Type guard for basic Modular Content field values (blocks as string IDs only).
+ * Checks for array structure and ensures all blocks are string references.
+ */
+export declare function isRichTextFieldValue(value: unknown): value is RichTextFieldValue;
+/**
+ * Type guard for Modular Content field values in API request format.
+ * Allows blocks as string IDs, full objects with IDs, or objects without IDs.
+ */
+export declare function isRichTextFieldValueAsRequest(value: unknown): value is RichTextFieldValueAsRequest;
+/**
+ * Type guard for Modular Content field values with nested blocks (?nested=true format).
+ * Ensures all blocks are full SchemaTypes.Item objects with complete data.
+ */
+export declare function isRichTextFieldValueWithResolvedBlocks(value: unknown): value is RichTextFieldValueWithResolvedBlocks;
+import type { RichTextEditorConfiguration } from './appearance/rich_text';
+import type { RichTextBlocksValidator } from './validators/rich_text_blocks';
+import type { SizeValidator } from './validators/size';
+export type RichTextFieldValidators = {
+    /** Only accept references to block records of the specified block models */
+    rich_text_blocks: RichTextBlocksValidator;
+    /** Only accept a number of items within the specified range */
+    size?: SizeValidator;
+};
+export type RichTextFieldAppearance = {
+    editor: 'rich_text';
+    parameters: RichTextEditorConfiguration;
+} | {
+    /** Plugin ID */
+    editor: string;
+    /** Plugin configuration */
+    parameters: Record<string, unknown>;
+};

package/dist/esm/fieldTypes/rich_text.js

@@ -0,0 +1,47 @@
+import { isBlockObject, isBlockObjectWithId, isBlockStringId, } from './single_block';
+/**
+ * =============================================================================
+ * TYPE GUARDS - Runtime validation functions
+ * =============================================================================
+ */
+/**
+ * Type guard for basic Modular Content field values (blocks as string IDs only).
+ * Checks for array structure and ensures all blocks are string references.
+ */
+export function isRichTextFieldValue(value) {
+    if (value === null)
+        return true;
+    return (Array.isArray(value) && value.every((block) => typeof block === 'string'));
+}
+/**
+ * Type guard for Modular Content field values in API request format.
+ * Allows blocks as string IDs, full objects with IDs, or objects without IDs.
+ */
+export function isRichTextFieldValueAsRequest(value) {
+    if (value === null)
+        return true;
+    if (!Array.isArray(value))
+        return false;
+    return value.every((block) => {
+        // String ID - referencing existing block
+        if (isBlockStringId(block))
+            return true;
+        // Object (either with or without ID for updates/creation)
+        return isBlockObject(block);
+    });
+}
+/**
+ * Type guard for Modular Content field values with nested blocks (?nested=true format).
+ * Ensures all blocks are full SchemaTypes.Item objects with complete data.
+ */
+export function isRichTextFieldValueWithResolvedBlocks(value) {
+    if (value === null)
+        return true;
+    if (!Array.isArray(value))
+        return false;
+    return value.every((block) => {
+        // Must be a full object with ID (nested format always includes complete block objects)
+        return isBlockObjectWithId(block);
+    });
+}
+//# sourceMappingURL=rich_text.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rich_text.js","sourceRoot":"","sources":["../../../src/fieldTypes/rich_text.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,aAAa,EACb,mBAAmB,EACnB,eAAe,GAChB,MAAM,gBAAgB,CAAC;AAqExB;;;;GAIG;AAEH;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAClC,KAAc;IAEd,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAEhC,OAAO,CACL,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAC1E,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,6BAA6B,CAC3C,KAAc;IAEd,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAEhC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAExC,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QAC3B,yCAAyC;QACzC,IAAI,eAAe,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAExC,0DAA0D;QAC1D,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sCAAsC,CACpD,KAAc;IAEd,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAEhC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAExC,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QAC3B,uFAAuF;QACvF,OAAO,mBAAmB,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;AACL,CAAC"}

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

@@ -0,0 +1,38 @@
+import type { SeoEditorConfiguration } from './appearance/seo';
+import type { DescriptionLengthValidator } from './validators/description_length';
+import type { FileSizeValidator } from './validators/file_size';
+import type { ImageAspectRatioValidator } from './validators/image_aspect_ratio';
+import type { ImageDimensionsValidator } from './validators/image_dimensions';
+import type { RequiredSeoFieldsValidator } from './validators/required_seo_fields';
+import type { TitleLengthValidator } from './validators/title_length';
+export type SeoFieldValue = {
+    title?: string | null;
+    description?: string | null;
+    image?: string | null;
+    twitter_card?: 'summary' | 'summary_large_image' | null;
+    no_index?: boolean;
+} | null;
+export declare function isSeoFieldValue(value: unknown): value is SeoFieldValue;
+export type SeoFieldValidators = {
+    /** SEO field has to specify one or more properties, or it won't be valid */
+    required_seo_fields?: RequiredSeoFieldsValidator;
+    /** Accept assets only within a specified file size range */
+    file_size?: FileSizeValidator;
+    /** Accept assets only within a specified height and width range */
+    image_dimensions?: ImageDimensionsValidator;
+    /** Accept assets only within a specified aspect ratio range */
+    image_aspect_ratio?: ImageAspectRatioValidator;
+    /** Limits the length of the title for a SEO field */
+    title_length?: TitleLengthValidator;
+    /** Limits the length of the description for a SEO field */
+    description_length?: DescriptionLengthValidator;
+};
+export type SeoFieldAppearance = {
+    editor: 'seo';
+    parameters: SeoEditorConfiguration;
+} | {
+    /** Plugin ID */
+    editor: string;
+    /** Plugin configuration */
+    parameters: Record<string, unknown>;
+};

package/dist/esm/fieldTypes/seo.js

@@ -0,0 +1,12 @@
+export function isSeoFieldValue(value) {
+    if (value === null)
+        return true;
+    return (typeof value === 'object' &&
+        value !== null &&
+        ('title' in value ||
+            'description' in value ||
+            'image' in value ||
+            'twitter_card' in value ||
+            'no_index' in value));
+}
+//# sourceMappingURL=seo.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"seo.js","sourceRoot":"","sources":["../../../src/fieldTypes/seo.ts"],"names":[],"mappings":"AAgBA,MAAM,UAAU,eAAe,CAAC,KAAc;IAC5C,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAChC,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,CAAC,OAAO,IAAI,KAAK;YACf,aAAa,IAAI,KAAK;YACtB,OAAO,IAAI,KAAK;YAChB,cAAc,IAAI,KAAK;YACvB,UAAU,IAAI,KAAK,CAAC,CACvB,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,134 @@
+import type * as SchemaTypes from '../generated/SchemaTypes';
+/**
+ * SINGLE BLOCK FIELD TYPE SYSTEM FOR DATOCMS
+ *
+ * This module defines a comprehensive type system for handling DatoCMS Single Block fields,
+ * which contain a single embedded content block.
+ *
+ * The challenge we're solving:
+ * - DatoCMS Single Block fields contain a single "block" (embedded content item)
+ * - By default, API responses contain blocks as string IDs (lightweight references)
+ * - With ?nested=true parameter, API responses contain blocks as full block objects
+ *   (which in turn can contain other blocks)
+ * - For API requests, blocks can be represented as:
+ *   1. String IDs (referencing existing blocks)
+ *   2. Full block objects with IDs (for updates)
+ *   3. Block objects without IDs (for creation)
+ *
+ * This creates a need for different type variants for the same conceptual data structure.
+ */
+/**
+ * =============================================================================
+ * BASIC SINGLE BLOCK TYPE - Default API response format
+ * =============================================================================
+ *
+ * The standard Single Block field value containing a block reference as string ID.
+ * This is what you get from regular API responses without ?nested=true.
+ */
+/**
+ * Basic Single Block field value - string block ID (lightweight reference)
+ */
+export type SingleBlockFieldValue = string | null;
+/**
+ * =============================================================================
+ * REQUEST VARIANT - Type for sending data TO the DatoCMS API
+ * =============================================================================
+ *
+ * When making API requests, we need flexibility in how we represent embedded blocks:
+ * - Use string ID to reference existing block that does not need to change
+ * - Include full block object for updates
+ * - Omit ID for new blocks being created
+ */
+/**
+ * Union type representing the different ways a block can be specified in API requests:
+ * - string: Just the block ID (most common case)
+ * - Full block object with ID (for updates)
+ * - Block object without ID (for creation)
+ *
+ * Also, 'meta' can always be omitted
+ */
+export type BlockItemInARequest = string | OptionalFields<SchemaTypes.Item, 'id' | 'meta'>;
+/**
+ * Single Block field value for API requests - allows flexible block representations:
+ * - string: Just the block ID (most common case)
+ * - SchemaTypes.Item: Full block object with ID (for updates)
+ * - Omit<SchemaTypes.Item, 'id'>: Block object without ID (for creation)
+ */
+export type SingleBlockFieldValueAsRequest = BlockItemInARequest | null;
+/**
+ * =============================================================================
+ * NESTED VARIANT - Type for API responses with ?nested=true parameter
+ * =============================================================================
+ *
+ * When using the ?nested=true query parameter, the API returns Single Block data
+ * with embedded block fully populated as complete SchemaTypes.Item object instead
+ * of just string ID. This provides type safety for working with fully resolved data.
+ */
+/**
+ * Single Block field value with nested block - fully populated block object
+ */
+export type SingleBlockFieldValueWithResolvedBlocks = SchemaTypes.Item | null;
+/**
+ * =============================================================================
+ * SHARED UTILITY FUNCTIONS
+ * =============================================================================
+ * These functions are used internally and can be imported by other modules
+ */
+/**
+ * Validates if a single block item is a string ID
+ */
+export declare function isBlockStringId(block: unknown): block is string;
+export type ItemWithOptionalIdAndMeta = OptionalFields<SchemaTypes.Item, 'id' | 'meta'>;
+/**
+ * Validates if a single block item is a SchemaTypes.Item object (with or without ID)
+ */
+export declare function isBlockObject(block: unknown): block is ItemWithOptionalIdAndMeta;
+export type ItemWithOptionalMeta = OptionalFields<SchemaTypes.Item, 'meta'>;
+/**
+ * Validates if a single block item is a complete SchemaTypes.Item object with ID
+ */
+export declare function isBlockObjectWithId(block: unknown): block is ItemWithOptionalMeta;
+/**
+ * =============================================================================
+ * TYPE GUARDS - Runtime validation functions
+ * =============================================================================
+ */
+/**
+ * Type guard for basic Single Block field values (block as string ID only).
+ * Checks for string structure and ensures block is a string reference.
+ */
+export declare function isSingleBlockFieldValue(value: unknown): value is SingleBlockFieldValue;
+/**
+ * Type guard for Single Block field values in API request format.
+ * Allows block as string ID, full object with ID, or object without ID.
+ */
+export declare function isSingleBlockFieldValueAsRequest(value: unknown): value is SingleBlockFieldValueAsRequest;
+/**
+ * Type guard for Single Block field values with nested blocks (?nested=true format).
+ * Ensures block is a full SchemaTypes.Item object with complete data.
+ */
+export declare function isSingleBlockFieldValueWithResolvedBlocks(value: unknown): value is SingleBlockFieldValueWithResolvedBlocks;
+import type { FramedSingleBlockEditorConfiguration } from './appearance/framed_single_block';
+import type { FramelessSingleBlockEditorConfiguration } from './appearance/frameless_single_block';
+import type { RequiredValidator } from './validators/required';
+import type { SingleBlockBlocksValidator } from './validators/single_block_blocks';
+export type SingleBlockFieldValidators = {
+    /** Only accept references to block records of the specified block models */
+    single_block_blocks: SingleBlockBlocksValidator;
+    /** Value must be specified or it won't be valid */
+    required?: RequiredValidator;
+};
+export type SingleBlockFieldAppearance = {
+    editor: 'framed_single_block';
+    parameters: FramedSingleBlockEditorConfiguration;
+} | {
+    editor: 'frameless_single_block';
+    parameters: FramelessSingleBlockEditorConfiguration;
+} | {
+    /** Plugin ID */
+    editor: string;
+    /** Plugin configuration */
+    parameters: Record<string, unknown>;
+};
+type OptionalFields<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+export {};