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

package/dist/generated/stories/types.gen.d.cts

@@ -1,607 +0,0 @@
-//#region src/generated/stories/types.gen.d.ts
-/**
- * Minimal story object for alternates
- */
-type StoryAlternate = {
-  /**
-   * The numeric ID
-   */
-  id: number;
-  /**
-   * The complete name provided for the story
-   */
-  name: string;
-  /**
-   * The slug specific for the story
-   */
-  slug: string;
-  /**
-   * true if a story is currently published, even if it has unpublished changes
-   */
-  published: boolean;
-  /**
-   * The full slug of the story, combining the parent folder(s) and the designated story slug
-   */
-  full_slug: string;
-  /**
-   * true if the instance constitutes a folder
-   */
-  is_folder: boolean;
-  /**
-   * ID of the parent folder. 0 for root-level stories.
-   */
-  parent_id: number;
-};
-/**
- * Asset field type - single asset (image, video, audio, or document)
- */
-type AssetFieldValue = {
-  /**
-   * 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 BlokContent = {
-  /**
-   * 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 | AssetFieldValue | BlokContent> | AssetFieldValue | MultilinkFieldValue | TableFieldValue | RichtextFieldValue | PluginFieldValue | string | undefined;
-};
-/**
- * Multilink field type - link to internal stories, external URLs, emails, etc.
- */
-type MultilinkFieldValue = {
-  /**
-   * 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;
-};
-/**
- * Table field type - structured table data
- */
-type TableFieldValue = {
-  /**
-   * 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;
-    }>;
-  }>;
-};
-/**
- * Richtext field type - structured rich text document (ProseMirror format)
- */
-type RichtextFieldValue = {
-  /**
-   * Root node type for richtext documents
-   */
-  type: 'doc';
-  /**
-   * Array of richtext nodes (paragraphs, headings, lists, bloks, etc.)
-   */
-  content?: Array<{
-    [key: string]: unknown;
-  }>;
-};
-/**
- * Plugin/Custom field type - field plugin with custom structure
- */
-type PluginFieldValue = {
-  /**
-   * Technical name of the field plugin
-   */
-  plugin: string;
-  /**
-   * Unique identifier for this plugin field instance
-   */
-  _uid?: string;
-  [key: string]: unknown | string | undefined;
-};
-/**
- * Translated slug object (from Translatable Slugs app)
- */
-type StoryTranslatedSlug = {
-  /**
-   * Translated slug path
-   */
-  path: string | null;
-  /**
-   * Language code of the current language
-   */
-  lang: string;
-  /**
-   * The complete name provided for the story
-   */
-  name?: string | null;
-  /**
-   * true if a story is currently published, even if it has unpublished changes
-   */
-  published?: boolean | null;
-};
-/**
- * Localized path object (from Translatable Slugs app)
- */
-type StoryLocalizedPath = {
-  /**
-   * Value of the real path defined in the story's entry configuration
-   */
-  path: string;
-  /**
-   * The complete name provided for the story
-   */
-  name?: string | null;
-  /**
-   * Language code of the current language
-   */
-  lang: string;
-  /**
-   * true if a story is currently published, even if it has unpublished changes
-   */
-  published?: boolean | null;
-};
-/**
- * Common Storyblok story fields shared by Content Delivery and Management APIs
- */
-type StoryBase = {
-  /**
-   * Numeric id of the story
-   */
-  readonly id: number;
-  /**
-   * The complete name provided for the story
-   */
-  name: string;
-  /**
-   * ID of the parent folder. 0 for root-level stories.
-   */
-  parent_id: number;
-  /**
-   * Group ID (UUID string), shared between stories defined as alternates
-   */
-  group_id: string;
-  /**
-   * An array containing objects that provide basic data of the stories defined as alternates of the current story
-   */
-  alternates: Array<StoryAlternate>;
-  /**
-   * Creation date yyyy-MM-dd'T'HH:mm:ssZ
-   */
-  created_at: string;
-  /**
-   * Date defined in the story's entry configuration YYYY-mm-dd
-   */
-  sort_by_date: string | null;
-  /**
-   * Array of tag names
-   */
-  tag_list: Array<string>;
-  /**
-   * Latest update date yyyy-MM-dd'T'HH:mm:ssZ
-   */
-  updated_at: string;
-  /**
-   * Latest publishing date yyyy-MM-dd'T'HH:mm:ssZ
-   */
-  published_at: string | null;
-  /**
-   * Generated UUID string
-   */
-  readonly uuid: string;
-  content: BlokContent;
-  /**
-   * The slug specific for the story
-   */
-  slug: string;
-  /**
-   * Value of the real path defined in the story's entry configuration (usually required for the Visual Editor)
-   */
-  path: string | null;
-  /**
-   * The full slug of the story, combining the parent folder(s) and the designated story slug
-   */
-  full_slug: string;
-  /**
-   * true if the story is defined as root for the folder
-   */
-  is_startpage: boolean;
-  /**
-   * Object to store non-editable data that is exclusively maintained with the Management API
-   */
-  meta_data: {
-    [key: string]: unknown;
-  } | null;
-  /**
-   * First publishing date yyyy-MM-dd'T'HH:mm:ssZ
-   */
-  first_published_at: string | null;
-  /**
-   * Array of translated slug objects (if the app Translatable Slugs is installed)
-   */
-  translated_slugs: Array<StoryTranslatedSlug> | null;
-  /**
-   * An array of translated path objects
-   */
-  localized_paths?: Array<StoryLocalizedPath>;
-  /**
-   * Numeric representation of the story's position in the folder
-   */
-  position: number;
-};
-/**
- * Storyblok story object for the Content Delivery API
- */
-type StoryCapi = StoryBase & {
-  /**
-   * Contains the complete slug of the default language (if the Translatable Slugs app is installed)
-   */
-  default_full_slug: string | null;
-  /**
-   * ID of the current release (can be requested with the from_release API parameter)
-   */
-  release_id: number | null;
-  /**
-   * Language code of the current language version (if requested via the language parameter)
-   */
-  lang: string;
-};
-type ListData = {
-  body?: never;
-  path?: never;
-  query?: {
-    /**
-     * Version to retrieve
-     */
-    version?: 'published' | 'draft';
-    /**
-     * Cached version Unix timestamp for cache invalidation
-     */
-    cv?: number;
-    /**
-     * Filter by full_slug to only return stories starting with the given value (e.g., "blog/posts")
-     */
-    starts_with?: string;
-    /**
-     * Access a story version in a specific release by providing the release ID
-     */
-    from_release?: string;
-    /**
-     * Search for any string in stories (name, slug/full slug, or content object)
-     */
-    search_term?: string;
-    /**
-     * Number of stories per page (default 25, max 100)
-     */
-    per_page?: number;
-    /**
-     * Page number for pagination
-     */
-    page?: number;
-    /**
-     * Resolve link fields (story, url, or link)
-     */
-    resolve_links?: 'story' | 'url' | 'link';
-    /**
-     * Resolve up to specified levels of links (1 or 2)
-     */
-    resolve_links_level?: 1 | 2;
-    /**
-     * Resolve referenced stories (comma-separated list, e.g., "page.author,page.categories")
-     */
-    resolve_relations?: string;
-    /**
-     * Force resolve second-level relations when first level reaches limit
-     */
-    resolve_level?: 2;
-    /**
-     * Resolve asset metadata including custom metadata (1 to enable)
-     */
-    resolve_assets?: 0 | 1;
-    /**
-     * Define custom fallback language for untranslated fields (e.g., "es_co")
-     */
-    fallback_lang?: string;
-    /**
-     * Retrieve translated story version (language code)
-     */
-    language?: string;
-    /**
-     * Retrieve stories of a specific content type (e.g., "page")
-     */
-    content_type?: string;
-    /**
-     * Retrieve stories by comma-separated full_slug. Use wildcards with * (e.g., "posts/my-third-post,posts/my-second-post" or "posts*")
-     */
-    by_slugs?: string;
-    /**
-     * Exclude stories by comma-separated full_slug. Use wildcards with * (e.g., "posts/my-third-post,posts/my-second-post" or "posts*")
-     */
-    excluding_slugs?: string;
-    /**
-     * Retrieve specific stories by providing their UUIDs as a comma-separated string
-     */
-    by_uuids?: string;
-    /**
-     * Retrieve specific stories by providing their UUIDs as a comma-separated string (response order matches UUID order)
-     */
-    by_uuids_ordered?: string;
-    /**
-     * Exclude specific stories by providing their IDs as a comma-separated string
-     */
-    excluding_ids?: string;
-    /**
-     * Filter by specific tag(s) by providing their slug(s). Multiple tags can be provided as a comma-separated string (OR operator)
-     */
-    with_tag?: string;
-    /**
-     * Sort stories by a specific property (e.g., "created_at:desc", "content.price:asc:float")
-     */
-    sort_by?: string;
-    /**
-     * Retrieve stories in particular workflow stages by providing a comma-separated list of workflow stage IDs
-     */
-    in_workflow_stages?: string;
-    /**
-     * Filter queries to filter stories by specific attributes
-     */
-    filter_query?: string;
-    /**
-     * Retrieve stories located in the specified folder level (1 = root folder, 2 = top-level folders, etc.)
-     */
-    level?: number;
-    /**
-     * Filter by stories defined as root for the folder
-     */
-    is_startpage?: 0 | 1;
-    /**
-     * Retrieve stories first published after the specified date (Format yyyy-MM-dd HH:mm)
-     */
-    first_published_at_gt?: string;
-    /**
-     * Retrieve stories first published before the specified date (Format yyyy-MM-dd HH:mm)
-     */
-    first_published_at_lt?: string;
-    /**
-     * Retrieve stories published after the specified date (Format yyyy-MM-dd HH:mm)
-     */
-    published_at_gt?: string;
-    /**
-     * Retrieve stories published before the specified date (Format yyyy-MM-dd HH:mm)
-     */
-    published_at_lt?: string;
-    /**
-     * Retrieve stories updated after the specified date (Format yyyy-MM-dd HH:mm)
-     */
-    updated_at_gt?: string;
-    /**
-     * Retrieve stories updated before the specified date (Format yyyy-MM-dd HH:mm)
-     */
-    updated_at_lt?: string;
-    /**
-     * Exclude specific fields of a content type by providing the field names as a comma-separated string (e.g., "body,meta_description")
-     */
-    excluding_fields?: string;
-  };
-  url: '/v2/cdn/stories';
-};
-type ListResponses = {
-  /**
-   * Array of stories
-   */
-  200: {
-    /**
-     * Array of story objects
-     */
-    stories: Array<StoryCapi>;
-    /**
-     * Cache version Unix timestamp
-     */
-    cv?: number;
-    /**
-     * Array of resolved stories (when resolve_relations is used)
-     */
-    rels?: Array<StoryCapi>;
-    /**
-     * Array of resolved links (when resolve_links is used)
-     */
-    links?: Array<{
-      [key: string]: unknown;
-    }>;
-    /**
-     * Array of UUIDs of referenced stories (if limit exceeded)
-     */
-    rel_uuids?: Array<string>;
-    /**
-     * Array of UUIDs of linked stories (if limit exceeded)
-     */
-    link_uuids?: Array<string>;
-  };
-};
-type GetData = {
-  body?: never;
-  path: {
-    /**
-     * Story identifier - can be full_slug (string), id (number), or uuid (string). When using uuid, the find_by=uuid query parameter is required.
-     */
-    identifier: number | string;
-  };
-  query?: {
-    /**
-     * Required when using the story UUID as a path parameter
-     */
-    find_by?: 'uuid';
-    /**
-     * Version to retrieve
-     */
-    version?: 'published' | 'draft';
-    /**
-     * Cached version Unix timestamp for cache invalidation
-     */
-    cv?: number;
-    /**
-     * Access a story version in a specific release by providing the release ID
-     */
-    from_release?: string;
-    /**
-     * Resolve link fields (story, url, or link)
-     */
-    resolve_links?: 'story' | 'url' | 'link';
-    /**
-     * Resolve up to specified levels of links (1 or 2)
-     */
-    resolve_links_level?: 1 | 2;
-    /**
-     * Resolve referenced stories (comma-separated list, e.g., "page.author,page.categories")
-     */
-    resolve_relations?: string;
-    /**
-     * Force resolve second-level relations when first level reaches limit
-     */
-    resolve_level?: 2;
-    /**
-     * Resolve asset metadata including custom metadata (1 to enable)
-     */
-    resolve_assets?: 0 | 1;
-    /**
-     * Define custom fallback language for untranslated fields (e.g., "es_co")
-     */
-    fallback_lang?: string;
-    /**
-     * Retrieve translated story version (language code)
-     */
-    language?: string;
-  };
-  url: '/v2/cdn/stories/{identifier}';
-};
-type GetResponses = {
-  /**
-   * Story details
-   */
-  200: {
-    story: StoryCapi;
-    /**
-     * Cache version Unix timestamp
-     */
-    cv?: number;
-    /**
-     * Array of resolved stories (when resolve_relations is used)
-     */
-    rels?: Array<StoryCapi>;
-    /**
-     * Array of resolved links (when resolve_links is used)
-     */
-    links?: Array<{
-      [key: string]: unknown;
-    }>;
-    /**
-     * Array of UUIDs of referenced stories (if limit exceeded)
-     */
-    rel_uuids?: Array<string>;
-    /**
-     * Array of UUIDs of linked stories (if limit exceeded)
-     */
-    link_uuids?: Array<string>;
-  };
-};
-//#endregion
-export { AssetFieldValue, BlokContent, GetData, GetResponses, ListData, ListResponses, MultilinkFieldValue, PluginFieldValue, RichtextFieldValue, StoryCapi, TableFieldValue };
-//# sourceMappingURL=types.gen.d.cts.map