@datocms/cma-client/src/fieldTypes/text.ts

JS client for DatoCMS REST Content Management API

import {
  type LocalizedFieldValue,
  isLocalizedFieldValue,
} from '../utilities/normalizedFieldValues';
import type { MarkdownEditorConfiguration } from './appearance/markdown';
import type { TextareaEditorConfiguration } from './appearance/textarea';
import type { WysiwygEditorConfiguration } from './appearance/wysiwyg';
import type { SanitizedHtmlValidator } from './validators';
import type { FormatValidator } from './validators/format';
import type { LengthValidator } from './validators/length';
import type { RequiredValidator } from './validators/required';

export type TextFieldValue = string | null;

export function isTextFieldValue(value: unknown): value is TextFieldValue {
  return typeof value === 'string' || value === null;
}

export function isLocalizedTextFieldValue(
  value: unknown,
): value is LocalizedFieldValue<TextFieldValue> {
  return (
    isLocalizedFieldValue(value) && Object.values(value).every(isTextFieldValue)
  );
}

export type TextFieldValidators = {
  /** Value must be specified or it won't be valid */
  required?: RequiredValidator;
  /** Accept strings only with a specified number of characters */
  length?: LengthValidator;
  /** Accepts only strings that match a specified format */
  format?: FormatValidator;
  /** Checks for the presence of malicious code in HTML fields */
  sanitized_html?: SanitizedHtmlValidator;
};

export type TextFieldAppearance =
  | { editor: 'markdown'; parameters: MarkdownEditorConfiguration }
  | { editor: 'wysiwyg'; parameters: WysiwygEditorConfiguration }
  | { editor: 'textarea'; parameters: TextareaEditorConfiguration }
  | {
      /** Plugin ID */
      editor: string;
      /** Plugin configuration */
      parameters: Record<string, unknown>;
    };