@storyblok/schema 0.1.0-alpha.0

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

@@ -0,0 +1,683 @@
+//#region src/generated/mapi/_internal.gen.d.ts
+type Component = {
+  /**
+   * Unique identifier for the component
+   */
+  readonly id: number;
+  /**
+   * Technical name of the component.
+   */
+  name: string;
+  /**
+   * Human-readable display name
+   */
+  display_name?: string | null;
+  /**
+   * Component description
+   */
+  description?: string | null;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  readonly created_at: string;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at: string;
+  /**
+   * Component field schema definition
+   */
+  schema: {
+    [key: string]: {
+      type?: 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group';
+      /**
+       * Field ID
+       */
+      id?: string;
+      [key: string]: unknown | 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group' | string | undefined;
+    };
+  };
+  /**
+   * Component image URL
+   */
+  image?: string | null;
+  /**
+   * Field used for preview.
+   */
+  preview_field?: string | null;
+  /**
+   * Whether this component can be used as a root component.
+   */
+  is_root: boolean;
+  /**
+   * Preview template HTML.
+   */
+  preview_tmpl?: string | null;
+  /**
+   * Whether this component can be nested inside other components.
+   */
+  is_nestable: boolean;
+  /**
+   * All presets associated with this component.
+   */
+  all_presets?: Array<{
+    /**
+     * Preset ID
+     */
+    id?: number;
+    /**
+     * Preset name
+     */
+    name?: string;
+    /**
+     * Preset schema
+     */
+    preset?: {
+      [key: string]: unknown;
+    };
+    /**
+     * ID of the component this preset belongs to
+     */
+    component_id?: number;
+    /**
+     * Image URL for the preset preview
+     */
+    image?: string | null;
+    /**
+     * Icon name for the preset
+     */
+    icon?: string | null;
+    /**
+     * Color for the preset display
+     */
+    color?: string | null;
+    /**
+     * Description of the preset
+     */
+    description?: string | null;
+  }>;
+  /**
+   * Default preset ID.
+   */
+  preset_id?: number | null;
+  /**
+   * Display name if available, otherwise technical name.
+   */
+  real_name?: string;
+  /**
+   * UUID of the component group this component belongs to.
+   */
+  component_group_uuid?: string | null;
+  /**
+   * Component color for UI display
+   */
+  color?: string | null;
+  /**
+   * Component icon name
+   */
+  icon?: string | null;
+  internal_tags_list?: Array<{
+    /**
+     * ID
+     */
+    id?: number;
+    /**
+     * Name
+     */
+    name?: string;
+  }>;
+  /**
+   * List of internal tag IDs
+   */
+  internal_tag_ids?: Array<string>;
+  /**
+   * Content Type Asset preview.
+   */
+  content_type_asset_preview?: string | null;
+  /**
+   * Component metadata.
+   */
+  metadata?: {
+    [key: string]: unknown;
+  } | null;
+};
+type ComponentCreate = {
+  /**
+   * Name of the component
+   */
+  name: string;
+  /**
+   * Human-readable display name
+   */
+  display_name?: string;
+  /**
+   * Component description
+   */
+  description?: string;
+  /**
+   * Preview template HTML
+   */
+  preview_tmpl?: string;
+  /**
+   * Component image URL
+   */
+  image?: string;
+  /**
+   * Field used for preview
+   */
+  preview_field?: string;
+  /**
+   * Whether this component can be used as a root component
+   */
+  is_root?: boolean;
+  /**
+   * Whether this component can be nested inside other components
+   */
+  is_nestable?: boolean;
+  /**
+   * Default preset ID
+   */
+  preset_id?: number;
+  /**
+   * UUID
+   */
+  component_group_uuid?: string;
+  /**
+   * Component color for UI display
+   */
+  color?: string;
+  /**
+   * Component icon name
+   */
+  icon?: string;
+  /**
+   * Asset preview URL for content type
+   */
+  content_type_asset_preview?: string;
+  /**
+   * List of internal tag IDs
+   */
+  internal_tag_ids?: Array<number>;
+  /**
+   * Component field schema definition
+   */
+  schema?: {
+    [key: string]: {
+      type?: 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group';
+      /**
+       * Human-readable field name
+       */
+      display_name?: string;
+      /**
+       * Whether this field is required
+       */
+      required?: boolean;
+      /**
+       * Whether this field is translatable
+       */
+      translatable?: boolean;
+      [key: string]: unknown | 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group' | string | boolean | undefined;
+    };
+  };
+  /**
+   * Component metadata
+   */
+  metadata?: {
+    [key: string]: unknown;
+  };
+};
+type ComponentUpdate = {
+  /**
+   * Name of the component
+   */
+  name?: string;
+  /**
+   * Human-readable display name
+   */
+  display_name?: string;
+  /**
+   * Component description
+   */
+  description?: string;
+  /**
+   * Preview template HTML
+   */
+  preview_tmpl?: string;
+  /**
+   * Component image URL
+   */
+  image?: string;
+  /**
+   * Field used for preview
+   */
+  preview_field?: string;
+  /**
+   * Whether this component can be used as a root component
+   */
+  is_root?: boolean;
+  /**
+   * Whether this component can be nested inside other components
+   */
+  is_nestable?: boolean;
+  /**
+   * Default preset ID
+   */
+  preset_id?: number;
+  /**
+   * UUID
+   */
+  component_group_uuid?: string;
+  /**
+   * Component color for UI display
+   */
+  color?: string;
+  /**
+   * Component icon name
+   */
+  icon?: string;
+  /**
+   * Asset preview URL for content type
+   */
+  content_type_asset_preview?: string;
+  /**
+   * List of internal tag IDs
+   */
+  internal_tag_ids?: Array<number>;
+  /**
+   * Component field schema definition
+   */
+  schema?: {
+    [key: string]: {
+      type?: 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group';
+      /**
+       * Human-readable field name
+       */
+      display_name?: string;
+      /**
+       * Whether this field is required
+       */
+      required?: boolean;
+      /**
+       * Whether this field is translatable
+       */
+      translatable?: boolean;
+      [key: string]: unknown | 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group' | string | boolean | undefined;
+    };
+  };
+  /**
+   * Component metadata
+   */
+  metadata?: {
+    [key: string]: unknown;
+  };
+};
+type MapiStory = {
+  name: string;
+  /**
+   * ID of parent space if this is a child space.
+   */
+  parent_id: number | null;
+  group_id: string;
+  alternates: Array<Alternate>;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  readonly created_at: string;
+  deleted_at: string | null;
+  sort_by_date: string | null;
+  tag_list: Array<string>;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at: string;
+  /**
+   * Latest publication timestamp (format is ISO 8601 standard in UTC).
+   */
+  published_at: string | null;
+  readonly id: number;
+  /**
+   * Unique UUID identifier for the discussion.
+   */
+  readonly uuid: string;
+  /**
+   * true if the instance constitutes a folder.
+   */
+  is_folder: boolean;
+  /**
+   * Dynamic component data rendered by Storyblok, structure varies by component
+   */
+  content: {
+    _uid?: string;
+    component?: string;
+    [key: string]: unknown | string | undefined;
+  };
+  published: boolean | null;
+  /**
+   * URL-friendly identifier for the app category.
+   */
+  slug: string;
+  path: string | null;
+  full_slug: string;
+  /**
+   * The default root
+   */
+  default_root: string | null;
+  disble_fe_editor: boolean;
+  disable_fe_editor: boolean;
+  /**
+   * Parent story object (for nested stories).
+   */
+  parent: {
+    id?: number;
+    uuid?: string;
+    name?: string;
+    slug?: string;
+    disble_fe_editor?: boolean;
+  } | null;
+  /**
+   * true if the story is defined as the startpage for its parent folder.
+   */
+  is_startpage: boolean;
+  unpublished_changes: boolean | null;
+  /**
+   * Custom metadata for the story
+   */
+  meta_data: {
+    [key: string]: unknown;
+  } | null;
+  /**
+   * Base version ID(common ancestor) for the story, used for three-way merge operations)
+   */
+  base_version_id?: number | null;
+  /**
+   * Main version ID, current version in main
+   */
+  main_version_id?: number | null;
+  /**
+   * Current version ID, current version in release or main
+   */
+  current_version_id?: number | null;
+  imported_at: string | null;
+  /**
+   * Preview token for the story.
+   */
+  preview_token: {
+    token: string;
+    timestamp: string;
+  };
+  pinned: boolean;
+  /**
+   * List of breadcrumbs for the story.
+   */
+  breadcrumbs: Array<Breadcrumb>;
+  publish_at: string | null;
+  expire_at: string | null;
+  first_published_at: string | null;
+  last_author: {
+    id?: number;
+    userid: string;
+    friendly_name: string;
+    avatar?: string;
+  } | null;
+  last_author_id: number | null;
+  /**
+   * List of user IDs this story belongs to (read-only, set automatically via workflow or workflow stage changes)
+   */
+  user_ids: Array<number>;
+  /**
+   * Space role IDs (read-only, set automatically via workflow or workflow stage changes)
+   */
+  space_role_ids: Array<number>;
+  /**
+   * List of translated slugs for the story
+   */
+  translated_slugs: Array<StoryTranslatedSlug>;
+  /**
+   * List of translated versions of this story
+   */
+  translated_stories: Array<{
+    /**
+     * First published time for this translation
+     */
+    first_published_at: string;
+    /**
+     * published time
+     */
+    published_at: string;
+    /**
+     * Language code for this translation
+     */
+    lang: string;
+    /**
+     * Whether this translation has unpublished changes
+     */
+    unpublished_changes: boolean;
+  }>;
+  /**
+   * List of localized paths for the story.
+   */
+  localized_paths: Array<StoryLocalizedPath>;
+  /**
+   * Numeric representation of the story's position in the folder.
+   */
+  position: number;
+  can_not_view: boolean | null;
+  is_scheduled: boolean | null;
+  scheduled_dates: string | null;
+  /**
+   * List of ideas associated with this story.
+   */
+  ideas: Array<{
+    /**
+     * Idea ID
+     */
+    id: string;
+    /**
+     * Idea name
+     */
+    name: string;
+    /**
+     * Author ID
+     */
+    author_id: number;
+    /**
+     * Whether idea is private
+     */
+    is_private: boolean;
+  }>;
+  /**
+   * Workflow stage information (only included when show_stage is true)
+   */
+  stage?: Stage | null;
+  /**
+   * List of user IDs
+   */
+  favourite_for_user_ids: Array<number>;
+  /**
+   * Variant type (null for regular stories, 'experiment' for A/B test variants).
+   */
+  variant_type?: string | null;
+  /**
+   * IDs of experiments this story participates in (only included on show, not index).
+   */
+  experiment_ids?: Array<number>;
+};
+type StoryCreate = {
+  name?: string;
+  disble_fe_editor?: boolean;
+  disable_fe_editor?: boolean;
+  /**
+   * The default root
+   */
+  default_root?: string | null;
+  is_folder?: boolean;
+  group_id?: string;
+  path?: string | null;
+  slug?: string;
+  is_startpage?: boolean;
+  /**
+   * ID of the parent folder. Can be null or 0 for root-level stories.
+   */
+  parent_id?: number | null;
+  sort_by_date?: string | null;
+  meta_data?: {
+    [key: string]: unknown;
+  } | null;
+  publish_at?: string | null;
+  expire_at?: string | null;
+  first_published_at?: string | null;
+  pinned?: boolean;
+  position?: number;
+  tag_list?: Array<string>;
+  base_version_id?: number | null;
+  /**
+   * Array of translated slug attributes for creating or updating translated slugs.
+   */
+  translated_slugs_attributes?: Array<{
+    /**
+     * ID of the translated slug (required for updates, omit for new records)
+     */
+    id?: number;
+    /**
+     * The slug for this translated slug (required)
+     */
+    slug?: string;
+    /**
+     * The name for this translated slug
+     */
+    name?: string | null;
+    /**
+     * The language code for this translation
+     */
+    lang?: string;
+    /**
+     * Set to true to mark this translated slug for deletion when the story is saved
+     */
+    _destroy?: boolean | null;
+  }> | null;
+  /**
+   * Dynamic component data rendered by Storyblok, structure varies by component
+   */
+  content?: {
+    [key: string]: unknown;
+  };
+};
+type StoryUpdate = StoryCreate;
+type Alternate = {
+  id: number;
+  name: string;
+  /**
+   * URL-friendly identifier for the app category.
+   */
+  slug: string;
+  published: boolean | null;
+  full_slug: string;
+  /**
+   * true if the instance constitutes a folder.
+   */
+  is_folder: boolean;
+  /**
+   * ID of parent space if this is a child space.
+   */
+  parent_id: number;
+};
+type Breadcrumb = {
+  /**
+   * Breadcrumb ID
+   */
+  id: number;
+  /**
+   * Name of the breadcrumb
+   */
+  name: string;
+  /**
+   * ID of parent space if this is a child space.
+   */
+  parent_id: number | null;
+  /**
+   * Disable frontend editor (legacy typo field). Deprecated: use disable_fe_editor instead of disble_fe_editor.
+   */
+  disble_fe_editor: boolean;
+  /**
+   * Disable frontend editor
+   */
+  disable_fe_editor: boolean;
+  /**
+   * Path of the breadcrumb
+   */
+  path: string | null;
+  /**
+   * URL-friendly identifier for the app category.
+   */
+  slug: string;
+  /**
+   * List of translated slugs for the breadcrumb
+   */
+  translated_slugs: Array<StoryTranslatedSlug>;
+};
+type StoryTranslatedSlug = {
+  /**
+   * id
+   */
+  id: number;
+  /**
+   * The name for this translated slug
+   */
+  name: string | null;
+  /**
+   * URL-friendly identifier for the app category.
+   */
+  slug: string;
+  /**
+   * The language code for this translation.
+   */
+  lang: string;
+  published: boolean | null;
+};
+type StoryLocalizedPath = {
+  /**
+   * The localized path
+   */
+  path: string;
+  /**
+   * The translated name
+   */
+  name: string | null;
+  /**
+   * The language code for this translation.
+   */
+  lang: string;
+  /**
+   * Published status or date
+   */
+  published: boolean | string | null;
+  /**
+   * The translated slug (only present when folders are used).
+   */
+  translated_slug?: string;
+};
+type Stage = {
+  /**
+   * The workflow ID
+   */
+  workflow_id: number | null;
+  /**
+   * The workflow stage ID
+   */
+  workflow_stage_id: number;
+  /**
+   * The story ID
+   */
+  story_id: number;
+  /**
+   * The due date for this workflow stage
+   */
+  due_date: string | null;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  created_at: string;
+};
+//#endregion
+export { Component, ComponentCreate, ComponentUpdate, MapiStory, StoryCreate, StoryUpdate };
+//# sourceMappingURL=_internal.gen.d.mts.map