@storyblok/api-client 0.3.1 → 1.0.0-alpha.2

package/dist/generated/overlay/_internal.gen.d.mts

@@ -0,0 +1,831 @@
+//#region src/generated/overlay/_internal.gen.d.ts
+/**
+ * A component schema field. Discriminated by the literal `type` enum on each variant.
+ */
+type Field = TextFieldRoot | TextareaFieldRoot | RichtextFieldRoot | MarkdownFieldRoot | NumberFieldRoot | DatetimeFieldRoot | BooleanFieldRoot | OptionFieldRoot | OptionsFieldRoot | AssetFieldRoot | MultiassetFieldRoot | MultilinkFieldRoot | BloksFieldRoot | TableFieldRoot | SectionFieldRoot | TabFieldRoot | CustomFieldRoot;
+type AssetFieldValue = AssetFieldValueRoot;
+type BlockContentBase = BlockContentRoot;
+type MultilinkFieldValue = MultilinkFieldValueRoot;
+type PluginFieldValue = PluginFieldValueRoot;
+type RichtextFieldValue = RichtextFieldValueRoot;
+type TableFieldValue = TableFieldValueRoot;
+type TextFieldRoot = BaseFieldRoot & ValueFieldRoot & {
+  /**
+   * Field type discriminant
+   */
+  type: 'text';
+  /**
+   * Maximum length of the input string
+   */
+  max_length?: number;
+  /**
+   * Maximum length for text fields (legacy alias for max_length)
+   */
+  maxlength?: number;
+  /**
+   * Minimum length for text fields
+   */
+  minlength?: number;
+  /**
+   * Field size (small, medium, large)
+   */
+  size?: string;
+  /**
+   * Whether to enable right-to-left text direction
+   */
+  rtl?: boolean;
+};
+type TextareaFieldRoot = BaseFieldRoot & ValueFieldRoot & {
+  /**
+   * Field type discriminant
+   */
+  type: 'textarea';
+  /**
+   * Maximum length of the input string
+   */
+  max_length?: number;
+  /**
+   * Maximum length for text fields (legacy alias for max_length)
+   */
+  maxlength?: number;
+  /**
+   * Minimum length for text fields
+   */
+  minlength?: number;
+  /**
+   * Field size (small, medium, large)
+   */
+  size?: string;
+  /**
+   * Whether to enable right-to-left text direction
+   */
+  rtl?: boolean;
+  /**
+   * Whether rich text is enabled
+   */
+  rich_text?: boolean;
+  /**
+   * Whether markdown is enabled
+   */
+  markdown?: boolean;
+};
+type RichtextFieldRoot = BaseFieldRoot & ValueFieldRoot & {
+  /**
+   * Field type discriminant
+   */
+  type: 'richtext';
+  /**
+   * Whether to allow toolbar customization
+   */
+  customize_toolbar?: boolean;
+  /**
+   * Array of enabled toolbar elements
+   */
+  toolbar?: Array<'ai-complete' | 'ai-shorten' | 'ai-extend' | 'ai-rephrase' | 'ai-summarize' | 'ai-simplify' | 'ai-tone' | 'ai-emoji' | 'ai-translate' | 'ai-tldr' | 'ai-spelling' | 'blok' | 'ltr' | 'rtl' | 'export' | 'import' | 'bold' | 'list' | 'inlinecode' | 'code' | 'color' | 'copy' | 'cut' | 'emoji' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'highlight' | 'unset' | 'hrule' | 'image' | 'italic' | 'link' | 'anchor' | 'olist' | 'paragraph' | 'paste-action' | 'paste' | 'quote' | 'redo' | 'strike' | 'subscript' | 'superscript' | 'underline' | 'undo' | 'align-left' | 'align-center' | 'align-right' | 'align-justify'>;
+  /**
+   * Custom CSS styles for the richtext field
+   */
+  style_options?: Array<{
+    _uid?: string;
+    name?: string;
+    value?: string;
+  }>;
+  /**
+   * Restriction type for component selection (groups, tags, or empty for specific blocks)
+   */
+  restrict_type?: string;
+  /**
+   * Whether to restrict which components can be inserted
+   */
+  restrict_components?: boolean;
+  /**
+   * List of allowed component names
+   */
+  component_whitelist?: Array<string>;
+  /**
+   * List of denied component names
+   */
+  component_denylist?: Array<string>;
+  /**
+   * List of allowed tag IDs for component filtering
+   */
+  component_tag_whitelist?: Array<number>;
+  /**
+   * List of denied tag IDs for component filtering
+   */
+  component_tag_denylist?: Array<number>;
+  /**
+   * List of allowed component group UUIDs
+   */
+  component_group_whitelist?: Array<string>;
+  /**
+   * List of denied component group UUIDs
+   */
+  component_group_denylist?: Array<string>;
+  /**
+   * Whether to allow links to open in a new tab
+   */
+  allow_target_blank?: boolean;
+  /**
+   * Whether to allow custom link attributes
+   */
+  allow_custom_attributes?: boolean;
+};
+type MarkdownFieldRoot = BaseFieldRoot & ValueFieldRoot & {
+  /**
+   * Field type discriminant
+   */
+  type: 'markdown';
+  /**
+   * Whether to display markdown as rich text
+   */
+  rich_markdown?: boolean;
+  /**
+   * Whether to enable right-to-left text direction
+   */
+  rtl?: boolean;
+  /**
+   * Whether to enable a customized toolbar
+   */
+  customize_toolbar?: boolean;
+  /**
+   * Array of enabled toolbar elements
+   */
+  toolbar?: Array<'bold' | 'italic' | 'inlinecode' | 'code' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'list' | 'olist' | 'quote' | 'hrule' | 'link' | 'image' | 'paragraph' | 'help' | 'toggle-richtext' | 'auto' | 'ltr' | 'rtl'>;
+  /**
+   * Whether to allow empty paragraphs
+   */
+  allow_multiline?: boolean;
+  /**
+   * Maximum length of the input string
+   */
+  max_length?: number;
+};
+type NumberFieldRoot = BaseFieldRoot & ValueFieldRoot & {
+  /**
+   * Field type discriminant
+   */
+  type: 'number';
+  /**
+   * Minimum value allowed
+   */
+  min_value?: number;
+  /**
+   * Maximum value allowed
+   */
+  max_value?: number;
+  /**
+   * Number of decimal places
+   */
+  decimals?: number;
+  /**
+   * Step size for the number input
+   */
+  steps?: number;
+};
+type DatetimeFieldRoot = BaseFieldRoot & ValueFieldRoot & {
+  /**
+   * Field type discriminant
+   */
+  type: 'datetime';
+  /**
+   * Whether to disable time selection (date-only mode)
+   */
+  disable_time?: boolean;
+};
+type BooleanFieldRoot = BaseFieldRoot & ValueFieldRoot & {
+  /**
+   * Field type discriminant
+   */
+  type: 'boolean';
+  /**
+   * Whether to display the label next to the toggle
+   */
+  inline_label?: boolean;
+};
+type OptionFieldRoot = BaseFieldRoot & ValueFieldRoot & {
+  /**
+   * Field type discriminant
+   */
+  type: 'option';
+  /**
+   * Array of selectable options
+   */
+  options?: Array<{
+    _uid?: string;
+    name?: string;
+    value?: string;
+  }>;
+  /**
+   * Source of the options (undefined=self, internal_stories, internal_languages, external, internal)
+   */
+  source?: string;
+  /**
+   * Datasource slug when source is internal
+   */
+  datasource_slug?: string;
+  /**
+   * External datasource JSON URL when source is external
+   */
+  external_datasource?: string;
+  /**
+   * Path of allowed stories folder when source is internal_stories
+   */
+  folder_slug?: string;
+  /**
+   * Allowed content type blocks when source is internal_stories
+   */
+  filter_content_type?: Array<string>;
+  /**
+   * Whether to exclude the empty option
+   */
+  exclude_empty_option?: boolean;
+  /**
+   * Whether to include an empty option
+   */
+  include_empty_option?: boolean;
+  /**
+   * Whether to use UUID for the option value
+   */
+  use_uuid?: boolean;
+  /**
+   * Display appearance (link or card) when source is internal_stories
+   */
+  entry_appearance?: string;
+  /**
+   * Whether to allow advanced search in a modal when source is internal_stories
+   */
+  allow_advanced_search?: boolean;
+  /**
+   * Maximum number of selectable options
+   */
+  max_options?: string;
+  /**
+   * Minimum number of selectable options
+   */
+  min_options?: string;
+  /**
+   * Whether multiple values are allowed
+   */
+  multiple?: boolean;
+};
+type OptionsFieldRoot = BaseFieldRoot & ValueFieldRoot & {
+  /**
+   * Field type discriminant
+   */
+  type: 'options';
+  /**
+   * Array of selectable options
+   */
+  options?: Array<{
+    _uid?: string;
+    name?: string;
+    value?: string;
+  }>;
+  /**
+   * Source of the options (undefined=self, internal_stories, internal_languages, external, internal)
+   */
+  source?: string;
+  /**
+   * Datasource slug when source is internal
+   */
+  datasource_slug?: string;
+  /**
+   * External datasource JSON URL when source is external
+   */
+  external_datasource?: string;
+  /**
+   * Path of allowed stories folder when source is internal_stories
+   */
+  folder_slug?: string;
+  /**
+   * Allowed content type blocks when source is internal_stories
+   */
+  filter_content_type?: Array<string>;
+  /**
+   * Whether to use UUID for the option values
+   */
+  use_uuid?: boolean;
+  /**
+   * Whether this Multi-Options field is a References field
+   */
+  is_reference_type?: boolean;
+  /**
+   * Display appearance (link or card) when source is internal_stories
+   */
+  entry_appearance?: string;
+  /**
+   * Whether to allow advanced search in a modal when source is internal_stories
+   */
+  allow_advanced_search?: boolean;
+  /**
+   * Maximum number of selectable options
+   */
+  max_options?: string;
+  /**
+   * Minimum number of selectable options
+   */
+  min_options?: string;
+  /**
+   * Whether multiple values are allowed
+   */
+  multiple?: boolean;
+};
+type AssetFieldRoot = BaseFieldRoot & ValueFieldRoot & {
+  /**
+   * Field type discriminant
+   */
+  type: 'asset';
+  /**
+   * Allowed file types (images, videos, audios, texts)
+   */
+  filetypes?: Array<string>;
+  /**
+   * Numeric ID of the allowed asset folder
+   */
+  asset_folder_id?: number;
+  /**
+   * Whether to allow external URLs
+   */
+  allow_external_url?: boolean;
+  /**
+   * Field height in pixels
+   */
+  height?: number;
+  /**
+   * Field width in pixels
+   */
+  width?: number;
+  /**
+   * Whether to restrict assets
+   */
+  restrict_assets?: boolean;
+  /**
+   * List of allowed asset types
+   */
+  asset_whitelist?: Array<string>;
+};
+type MultiassetFieldRoot = BaseFieldRoot & ValueFieldRoot & {
+  /**
+   * Field type discriminant
+   */
+  type: 'multiasset';
+  /**
+   * Allowed file types (images, videos, audios, texts)
+   */
+  filetypes?: Array<string>;
+  /**
+   * Numeric ID of the allowed asset folder
+   */
+  asset_folder_id?: number;
+  /**
+   * Whether to allow external URLs
+   */
+  allow_external_url?: boolean;
+  /**
+   * Field height in pixels
+   */
+  height?: number;
+  /**
+   * Field width in pixels
+   */
+  width?: number;
+  /**
+   * Whether to restrict assets
+   */
+  restrict_assets?: boolean;
+  /**
+   * List of allowed asset types
+   */
+  asset_whitelist?: Array<string>;
+  /**
+   * Maximum number of entries
+   */
+  maximum_entries?: number;
+  /**
+   * Minimum number of entries
+   */
+  minimum_entries?: number;
+};
+type MultilinkFieldRoot = BaseFieldRoot & ValueFieldRoot & {
+  /**
+   * Field type discriminant
+   */
+  type: 'multilink';
+  /**
+   * Whether to restrict linkable content types
+   */
+  restrict_content_types?: boolean;
+  /**
+   * List of allowed content type blocks for internal links
+   */
+  component_whitelist?: Array<string>;
+  /**
+   * Whether to allow opening links in a new tab
+   */
+  allow_target_blank?: boolean;
+  /**
+   * Whether to allow setting custom link attributes
+   */
+  allow_custom_attributes?: boolean;
+  /**
+   * Whether to restrict to a specific folder
+   */
+  force_link_scope?: boolean;
+  /**
+   * Path of the allowed folder when force_link_scope is true
+   */
+  link_scope?: string;
+  /**
+   * Whether to allow defining an anchor ID for internal links
+   */
+  show_anchor?: boolean;
+  /**
+   * Whether to allow specifying an email address
+   */
+  email_link_type?: boolean;
+  /**
+   * Whether to allow specifying an asset URL
+   */
+  asset_link_type?: boolean;
+};
+type BloksFieldRoot = BaseFieldRoot & ValueFieldRoot & {
+  /**
+   * Field type discriminant
+   */
+  type: 'bloks';
+  /**
+   * Restriction type for component selection (groups, tags, or empty for specific blocks)
+   */
+  restrict_type?: string;
+  /**
+   * Whether to restrict which components can be inserted
+   */
+  restrict_components?: boolean;
+  /**
+   * List of allowed component names
+   */
+  component_whitelist?: Array<string>;
+  /**
+   * List of denied component names
+   */
+  component_denylist?: Array<string>;
+  /**
+   * List of allowed tag IDs for component filtering
+   */
+  component_tag_whitelist?: Array<number>;
+  /**
+   * List of denied tag IDs for component filtering
+   */
+  component_tag_denylist?: Array<number>;
+  /**
+   * List of allowed component group UUIDs
+   */
+  component_group_whitelist?: Array<string>;
+  /**
+   * List of denied component group UUIDs
+   */
+  component_group_denylist?: Array<string>;
+  /**
+   * Minimum number of bloks
+   */
+  minimum?: number;
+  /**
+   * Maximum number of bloks
+   */
+  maximum?: number;
+  /**
+   * Maximum number of entries
+   */
+  maximum_entries?: number;
+  /**
+   * Minimum number of entries
+   */
+  minimum_entries?: number;
+};
+type TableFieldRoot = BaseFieldRoot & ValueFieldRoot & {
+  /**
+   * Field type discriminant
+   */
+  type: 'table';
+};
+type SectionFieldRoot = BaseFieldRoot & {
+  /**
+   * Field type discriminant
+   */
+  type: 'section';
+  /**
+   * Field keys that belong to this section
+   */
+  keys?: Array<string>;
+  /**
+   * Fieldset configuration
+   */
+  fieldset?: {
+    /**
+     * Fieldset title
+     */
+    title?: string;
+    /**
+     * Fieldset description
+     */
+    description?: string;
+    /**
+     * Whether the fieldset is collapsible
+     */
+    collapsible?: boolean;
+    /**
+     * Whether the fieldset is collapsed by default
+     */
+    collapsed?: boolean;
+  };
+};
+type TabFieldRoot = BaseFieldRoot & {
+  /**
+   * Field type discriminant
+   */
+  type: 'tab';
+  /**
+   * Field keys that belong to this tab
+   */
+  keys?: Array<string>;
+};
+type CustomFieldRoot = BaseFieldRoot & ValueFieldRoot & {
+  /**
+   * Field type discriminant
+   */
+  type: 'custom';
+  /**
+   * Technical name of the field plugin
+   */
+  field_type?: string;
+  /**
+   * Plugin-specific options
+   */
+  options?: Array<{
+    name?: string;
+    value?: string;
+  }>;
+  /**
+   * Comma-separated list of required field names in the plugin
+   */
+  required_fields?: string;
+  /**
+   * Source for plugin-provided options (`self` or `internal` for datasource)
+   */
+  source?: 'self' | 'internal';
+  /**
+   * Slug of the internal datasource when `source` is `internal`
+   */
+  datasource_slug?: string;
+  /**
+   * URL to an external datasource when `source` is set accordingly
+   */
+  external_datasource?: string;
+};
+/**
+ * Asset field type - single asset (image, video, audio, or document)
+ */
+type AssetFieldValueRoot = {
+  /**
+   * Identifies this as an asset field
+   */
+  fieldtype: 'asset';
+  /**
+   * Numeric ID of the asset
+   */
+  id: number | null;
+  /**
+   * Alternative text for the asset
+   */
+  alt: string | null;
+  /**
+   * Name of the asset
+   */
+  name?: string;
+  /**
+   * Focal point coordinates for cropping (format "123x456:789x1011")
+   */
+  focus?: string | null;
+  /**
+   * Title of the asset
+   */
+  title?: string | null;
+  /**
+   * Source attribution for the asset
+   */
+  source?: string | null;
+  /**
+   * URL to the asset file
+   */
+  filename: string;
+  /**
+   * Copyright information
+   */
+  copyright?: string | null;
+  /**
+   * Additional metadata for the asset
+   */
+  meta_data?: {
+    [key: string]: unknown;
+  };
+  /**
+   * Whether the asset is hosted externally
+   */
+  is_external_url?: boolean;
+};
+/**
+ * Content object representing a component instance. Contains a _uid, a component technical name, and dynamic fields whose values depend on the component's schema field types (text, textarea, richtext, markdown, number, datetime, boolean, option, options, asset, multiasset, multilink, bloks, table, section, custom/plugin).
+ */
+type BlockContentRoot = {
+  /**
+   * Unique identifier for this component instance
+   */
+  _uid: string;
+  /**
+   * Technical name of the component (content type or nestable block)
+   */
+  component: string;
+  /**
+   * Storyblok editor markup string for inline editing (present in draft/preview mode)
+   */
+  _editable?: string;
+  [key: string]: string | number | boolean | Array<string | AssetFieldValueRoot | BlockContentRoot> | AssetFieldValueRoot | MultilinkFieldValueRoot | TableFieldValueRoot | RichtextFieldValueRoot | PluginFieldValueRoot | string | undefined;
+};
+/**
+ * Multilink field type - link to internal stories, external URLs, emails, etc.
+ */
+type MultilinkFieldValueRoot = {
+  /**
+   * Identifies this as a multilink field
+   */
+  fieldtype: 'multilink';
+  /**
+   * UUID of the linked story (for internal links)
+   */
+  id: string;
+  /**
+   * URL for external links or email addresses
+   */
+  url: string;
+  /**
+   * Type of link
+   */
+  linktype: 'story' | 'url' | 'email' | 'asset';
+  /**
+   * Cached URL path for the linked story
+   */
+  cached_url: string;
+  /**
+   * Anchor/fragment identifier for the link
+   */
+  anchor?: string | null;
+  /**
+   * Link target attribute
+   */
+  target?: '_self' | '_blank' | null;
+};
+/**
+ * Plugin/Custom field type - field plugin with custom structure
+ */
+type PluginFieldValueRoot = {
+  /**
+   * Technical name of the field plugin
+   */
+  plugin: string;
+  /**
+   * Unique identifier for this plugin field instance
+   */
+  _uid?: string;
+  [key: string]: unknown | string | undefined;
+};
+/**
+ * Richtext field type - structured rich text document (ProseMirror format)
+ */
+type RichtextFieldValueRoot = {
+  /**
+   * Root node type for richtext documents
+   */
+  type: 'doc';
+  /**
+   * Array of richtext nodes (paragraphs, headings, lists, bloks, etc.)
+   */
+  content?: Array<{
+    [key: string]: unknown;
+  }>;
+};
+/**
+ * Table field type - structured table data
+ */
+type TableFieldValueRoot = {
+  /**
+   * Table header cells
+   */
+  thead: Array<{
+    _uid: string;
+    component: '_table_head';
+    /**
+     * Header cell content
+     */
+    value?: string;
+  }>;
+  /**
+   * Table body rows
+   */
+  tbody: Array<{
+    _uid: string;
+    component: '_table_row';
+    /**
+     * Cells in this row
+     */
+    body?: Array<{
+      _uid: string;
+      component: '_table_col';
+      /**
+       * Cell content
+       */
+      value?: string;
+    }>;
+  }>;
+};
+/**
+ * Universal identity and display properties shared by every field type
+ */
+type BaseFieldRoot = {
+  /**
+   * Field type discriminant
+   */
+  type?: string;
+  /**
+   * The ID of the field
+   */
+  id?: string;
+  /**
+   * Human-readable display name
+   */
+  display_name?: string;
+  /**
+   * Field description displayed in the editor
+   */
+  description?: string;
+  /**
+   * Whether to display the description as a tooltip
+   */
+  tooltip?: boolean;
+  /**
+   * Position of the field within the block
+   */
+  pos?: number;
+  /**
+   * Conditions set on the field for conditional visibility
+   */
+  conditional_settings?: Array<{
+    [key: string]: unknown;
+  }>;
+};
+/**
+ * Properties shared by content-bearing fields (i.e. fields that hold a value).
+ * Layout-only field types like `section` and `tab` do not include these.
+ *
+ */
+type ValueFieldRoot = {
+  /**
+   * Whether the field is required
+   */
+  required?: boolean;
+  /**
+   * Regular expression for validation
+   */
+  regex?: string;
+  /**
+   * Default value for the field (can be escaped JSON)
+   */
+  default_value?: string;
+  /**
+   * Whether the field is translatable
+   */
+  translatable?: boolean;
+  /**
+   * Exclude the field from translation exports
+   */
+  no_translate?: boolean;
+  /**
+   * Exclude the field from AI translations
+   */
+  exclude_from_ai_translation?: boolean;
+  /**
+   * Exclude the field when merging (Dimensions App)
+   */
+  exclude_from_merge?: boolean;
+  /**
+   * Exclude the field when overwriting (Dimensions App)
+   */
+  exclude_from_overwrite?: boolean;
+  /**
+   * Overwrite the field when merging (Dimensions App)
+   */
+  force_merge?: boolean;
+};
+//#endregion
+export { AssetFieldValue, AssetFieldValueRoot, BlockContentBase, BlockContentRoot, Field, MultilinkFieldValue, PluginFieldValue, RichtextFieldValue, TableFieldValue };
+//# sourceMappingURL=_internal.gen.d.mts.map