@storyblok/management-api-client 1.0.0-alpha.1 → 1.0.0-alpha.2

package/dist/generated/{components/types.gen.d.cts → overlay/_internal.gen.d.cts}

@@ -1,340 +1,16 @@
-//#region src/generated/components/types.gen.d.ts
+//#region src/generated/overlay/_internal.gen.d.ts
 /**
- * A Storyblok component object representing a content type
+ * A component schema field. Discriminated by the literal `type` enum on each variant.
  */
-type Component = {
-  /**
-   * The numeric ID
-   */
-  readonly id: number;
-  /**
-   * Technical name used for component property in entries
-   */
-  name: string;
-  /**
-   * Name that will be used in the editor interface
-   */
-  display_name?: string | null;
-  /**
-   * Creation date
-   */
-  readonly created_at: string;
-  /**
-   * Latest update date
-   */
-  readonly updated_at: string;
-  /**
-   * Component schema definition containing fields and their configurations
-   */
-  schema: {
-    [key: string]: ComponentSchemaField;
-  };
-  /**
-   * URL to the preview image
-   */
-  image?: string | null;
-  /**
-   * The field that is for preview in the interface (Preview Field)
-   */
-  preview_field?: string | null;
-  /**
-   * Whether the component can be used as a root component
-   */
-  is_root?: boolean;
-  /**
-   * Preview template for the component
-   */
-  preview_tmpl?: string | null;
-  /**
-   * True if the component is nestable (insertable) in block field types
-   */
-  is_nestable?: boolean;
-  /**
-   * An array of presets for this component
-   */
-  all_presets?: Array<{
-    /**
-     * The numeric ID of the preset
-     */
-    id?: number;
-    /**
-     * Name of the preset
-     */
-    name?: string;
-    /**
-     * The ID of the component the preset is for
-     */
-    component_id?: number;
-    /**
-     * Link to the preview image of the preset
-     */
-    image?: string | null;
-    /**
-     * Icon selected for the preset
-     */
-    icon?: string | null;
-    /**
-     * Color of the icon selected for the preset
-     */
-    color?: string | null;
-    /**
-     * The description of the preset
-     */
-    description?: string;
-  }>;
-  /**
-   * ID of the preset currently selected for this component
-   */
-  preset_id?: number | null;
-  /**
-   * Duplicated technical name or display name, used for internal tasks
-   */
-  real_name?: string;
-  /**
-   * The component folder ID of the component
-   */
-  component_group_uuid?: string;
-  /**
-   * The color of the icon selected for the component
-   */
-  color?: string | null;
-  /**
-   * Icon selected for the component
-   */
-  icon?: string | null;
-  /**
-   * List of internal tags assigned to the component
-   */
-  internal_tags_list?: Array<{
-    /**
-     * Tag ID
-     */
-    id?: number;
-    /**
-     * Tag name
-     */
-    name?: string;
-  }>;
-  /**
-   * List of IDs of the tags assigned to the component
-   */
-  internal_tag_ids?: Array<string>;
-  /**
-   * Asset preview field (Preview Card) for a content type component
-   */
-  content_type_asset_preview?: string | null;
-};
-/**
- * A component schema field — discriminated union on `type`.
- */
-type ComponentSchemaField = ({
-  type: 'text';
-} & TextField) | ({
-  type: 'textarea';
-} & TextareaField) | ({
-  type: 'richtext';
-} & RichtextField) | ({
-  type: 'markdown';
-} & MarkdownField) | ({
-  type: 'number';
-} & NumberField) | ({
-  type: 'datetime';
-} & DatetimeField) | ({
-  type: 'boolean';
-} & BooleanField) | ({
-  type: 'option';
-} & OptionField) | ({
-  type: 'options';
-} & OptionsField) | ({
-  type: 'asset';
-} & AssetField) | ({
-  type: 'multiasset';
-} & MultiassetField) | ({
-  type: 'multilink';
-} & MultilinkField) | ({
-  type: 'bloks';
-} & BloksField) | ({
-  type: 'table';
-} & TableField) | ({
-  type: 'section';
-} & SectionField) | ({
-  type: 'tab';
-} & TabField) | ({
-  type: 'custom';
-} & CustomField);
-/**
- * Input for creating a component.
- */
-type ComponentCreate = {
-  /**
-   * Technical name used for component property in entries
-   */
-  name: string;
-  /**
-   * Name that will be used in the editor interface
-   */
-  display_name?: string | null;
-  /**
-   * Component schema definition containing fields and their configurations
-   */
-  schema?: {
-    [key: string]: ComponentSchemaField;
-  };
-  /**
-   * Whether the component can be used as a root component
-   */
-  is_root?: boolean;
-  /**
-   * Whether the component is nestable in block field types
-   */
-  is_nestable?: boolean;
-  /**
-   * The component folder UUID
-   */
-  component_group_uuid?: string;
-  /**
-   * Icon color
-   */
-  color?: string;
-  /**
-   * Icon name
-   */
-  icon?: string;
-  /**
-   * The field used for preview in the interface
-   */
-  preview_field?: string;
-  /**
-   * IDs of internal tags to assign
-   */
-  internal_tag_ids?: Array<string>;
-};
-/**
- * Input for updating a component.
- */
-type ComponentUpdate = {
-  /**
-   * Technical name used for component property in entries
-   */
-  name?: string;
-  /**
-   * Name that will be used in the editor interface
-   */
-  display_name?: string | null;
-  /**
-   * Component schema definition containing fields and their configurations
-   */
-  schema?: {
-    [key: string]: ComponentSchemaField;
-  };
-  /**
-   * Whether the component can be used as a root component
-   */
-  is_root?: boolean;
-  /**
-   * Whether the component is nestable in block field types
-   */
-  is_nestable?: boolean;
-  /**
-   * The component folder UUID
-   */
-  component_group_uuid?: string;
-  /**
-   * Icon color
-   */
-  color?: string;
-  /**
-   * Icon name
-   */
-  icon?: string;
-  /**
-   * The field used for preview in the interface
-   */
-  preview_field?: string;
-  /**
-   * IDs of internal tags to assign
-   */
-  internal_tag_ids?: Array<string>;
-};
-/**
- * Universal identity and display properties shared by every field type
- */
-type BaseField = {
-  /**
-   * 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 ValueField = {
-  /**
-   * 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;
-};
-type TextField = BaseField & ValueField & {
+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 BlockContentInputBase = BlockContentInputRoot;
+type MultilinkFieldValue = MultilinkFieldValueRoot;
+type PluginFieldValue = PluginFieldValueRoot;
+type RichtextFieldValue = RichtextFieldValueRoot;
+type TableFieldValue = TableFieldValueRoot;
+type TextFieldRoot = BaseFieldRoot & ValueFieldRoot & {
   /**
    * Field type discriminant
    */
@@ -360,7 +36,7 @@ type TextField = BaseField & ValueField & {
    */
   rtl?: boolean;
 };
-type TextareaField = BaseField & ValueField & {
+type TextareaFieldRoot = BaseFieldRoot & ValueFieldRoot & {
   /**
    * Field type discriminant
    */
@@ -394,7 +70,7 @@ type TextareaField = BaseField & ValueField & {
    */
   markdown?: boolean;
 };
-type RichtextField = BaseField & ValueField & {
+type RichtextFieldRoot = BaseFieldRoot & ValueFieldRoot & {
   /**
    * Field type discriminant
    */
@@ -456,7 +132,7 @@ type RichtextField = BaseField & ValueField & {
    */
   allow_custom_attributes?: boolean;
 };
-type MarkdownField = BaseField & ValueField & {
+type MarkdownFieldRoot = BaseFieldRoot & ValueFieldRoot & {
   /**
    * Field type discriminant
    */
@@ -486,7 +162,7 @@ type MarkdownField = BaseField & ValueField & {
    */
   max_length?: number;
 };
-type NumberField = BaseField & ValueField & {
+type NumberFieldRoot = BaseFieldRoot & ValueFieldRoot & {
   /**
    * Field type discriminant
    */
@@ -508,7 +184,7 @@ type NumberField = BaseField & ValueField & {
    */
   steps?: number;
 };
-type DatetimeField = BaseField & ValueField & {
+type DatetimeFieldRoot = BaseFieldRoot & ValueFieldRoot & {
   /**
    * Field type discriminant
    */
@@ -518,7 +194,7 @@ type DatetimeField = BaseField & ValueField & {
    */
   disable_time?: boolean;
 };
-type BooleanField = BaseField & ValueField & {
+type BooleanFieldRoot = BaseFieldRoot & ValueFieldRoot & {
   /**
    * Field type discriminant
    */
@@ -528,7 +204,7 @@ type BooleanField = BaseField & ValueField & {
    */
   inline_label?: boolean;
 };
-type OptionField = BaseField & ValueField & {
+type OptionFieldRoot = BaseFieldRoot & ValueFieldRoot & {
   /**
    * Field type discriminant
    */
@@ -594,7 +270,7 @@ type OptionField = BaseField & ValueField & {
    */
   multiple?: boolean;
 };
-type OptionsField = BaseField & ValueField & {
+type OptionsFieldRoot = BaseFieldRoot & ValueFieldRoot & {
   /**
    * Field type discriminant
    */
@@ -656,7 +332,7 @@ type OptionsField = BaseField & ValueField & {
    */
   multiple?: boolean;
 };
-type AssetField = BaseField & ValueField & {
+type AssetFieldRoot = BaseFieldRoot & ValueFieldRoot & {
   /**
    * Field type discriminant
    */
@@ -690,7 +366,7 @@ type AssetField = BaseField & ValueField & {
    */
   asset_whitelist?: Array<string>;
 };
-type MultiassetField = BaseField & ValueField & {
+type MultiassetFieldRoot = BaseFieldRoot & ValueFieldRoot & {
   /**
    * Field type discriminant
    */
@@ -732,7 +408,7 @@ type MultiassetField = BaseField & ValueField & {
    */
   minimum_entries?: number;
 };
-type MultilinkField = BaseField & ValueField & {
+type MultilinkFieldRoot = BaseFieldRoot & ValueFieldRoot & {
   /**
    * Field type discriminant
    */
@@ -774,7 +450,7 @@ type MultilinkField = BaseField & ValueField & {
    */
   asset_link_type?: boolean;
 };
-type BloksField = BaseField & ValueField & {
+type BloksFieldRoot = BaseFieldRoot & ValueFieldRoot & {
   /**
    * Field type discriminant
    */
@@ -828,13 +504,13 @@ type BloksField = BaseField & ValueField & {
    */
   minimum_entries?: number;
 };
-type TableField = BaseField & ValueField & {
+type TableFieldRoot = BaseFieldRoot & ValueFieldRoot & {
   /**
    * Field type discriminant
    */
   type: 'table';
 };
-type SectionField = BaseField & {
+type SectionFieldRoot = BaseFieldRoot & {
   /**
    * Field type discriminant
    */
@@ -865,7 +541,7 @@ type SectionField = BaseField & {
     collapsed?: boolean;
   };
 };
-type TabField = BaseField & {
+type TabFieldRoot = BaseFieldRoot & {
   /**
    * Field type discriminant
    */
@@ -875,7 +551,7 @@ type TabField = BaseField & {
    */
   keys?: Array<string>;
 };
-type CustomField = BaseField & ValueField & {
+type CustomFieldRoot = BaseFieldRoot & ValueFieldRoot & {
   /**
    * Field type discriminant
    */
@@ -908,119 +584,267 @@ type CustomField = BaseField & ValueField & {
    */
   external_datasource?: string;
 };
-type ListData = {
-  body?: never;
-  path: {
-    /**
-     * The ID of the Storyblok space (can be integer or string)
-     */
-    space_id: number | string;
-  };
-  query?: {
-    /**
-     * Filter by ids (comma separated)
-     */
-    by_ids?: string;
-    /**
-     * Components can be sorted in an ascending or descending order by a specific property
-     */
-    sort_by?: string;
-    /**
-     * Retrieve all the components based on is_root property of a component
-     */
-    is_root?: boolean;
-    /**
-     * Search by name or display_name
-     */
-    search?: string;
-    /**
-     * Find components that are present in a specific group with the UUID of the group
-     */
-    in_group?: string;
-    /**
-     * Filter components by tags
-     */
-    with_tags?: string;
-    /**
-     * Filter components by metadata app slug
-     */
-    by_metadata_app_slug?: string;
-    /**
-     * Filter components by metadata frame ID
-     */
-    by_metadata_frame_id?: 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;
   };
-  url: '/v1/spaces/{space_id}/components';
+  /**
+   * Whether the asset is hosted externally
+   */
+  is_external_url?: boolean;
 };
-type VersionsData = {
-  body?: never;
-  path: {
-    /**
-     * The ID of the Storyblok space (can be integer or string)
-     */
-    space_id: number | string;
-  };
-  query?: {
-    /**
-     * Page number
-     */
-    page?: number;
-    /**
-     * Number of items per page. Default is 25.
-     */
-    per_page?: number;
-    /**
-     * Model type. Must be 'components' for component versions.
-     */
-    model?: 'components' | 'stories';
-    /**
-     * Component ID when model is 'components'
-     */
-    model_id?: string;
-    /**
-     * Use version 2 system for retrieving versions
-     */
-    versions_v2?: boolean;
-  };
-  url: '/v1/spaces/{space_id}/versions';
+/**
+ * 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;
 };
-type VersionData = {
-  body?: never;
-  path: {
-    /**
-     * The ID of the Storyblok space (can be integer or string)
-     */
-    space_id: number | string;
-    /**
-     * The ID of the component (can be integer or string)
-     */
-    component_id: number | string;
-    /**
-     * Version ID of the component
-     */
-    version_id: number;
-  };
-  query?: never;
-  url: '/v1/spaces/{space_id}/components/{component_id}/component_versions/{version_id}';
+/**
+ * Content object for creating or updating a component instance. Contains a component technical name and dynamic fields whose values depend on the component's schema field types. The _uid is optional — Storyblok will auto-generate one if not provided.
+ */
+type BlockContentInputRoot = {
+  /**
+   * Unique identifier for this component instance (auto-generated when omitted)
+   */
+  _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]: null | string | number | boolean | Array<string | AssetFieldValueRoot | BlockContentInputRoot> | AssetFieldValueRoot | MultilinkFieldValueRoot | TableFieldValueRoot | RichtextFieldValueRoot | PluginFieldValueRoot | string | undefined;
 };
-type RestoreVersionData = {
-  body: {
-    model?: string;
-    model_id?: string;
-  };
-  path: {
+/**
+ * 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';
     /**
-     * The ID of the Storyblok space (can be integer or string)
+     * Header cell content
      */
-    space_id: number | string;
+    value?: string;
+  }>;
+  /**
+   * Table body rows
+   */
+  tbody: Array<{
+    _uid: string;
+    component: '_table_row';
     /**
-     * ID of the component version
+     * Cells in this row
      */
-    version_id: number;
-  };
-  query?: never;
-  url: '/v1/spaces/{space_id}/versions/{version_id}';
+    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 { Component, ComponentCreate, ComponentSchemaField, ComponentUpdate, ListData, RestoreVersionData, VersionData, VersionsData };
-//# sourceMappingURL=types.gen.d.cts.map
+export { AssetFieldValue, BlockContentBase, BlockContentInputBase, Field, MultilinkFieldValue, PluginFieldValue, RichtextFieldValue, TableFieldValue };
+//# sourceMappingURL=_internal.gen.d.cts.map