@storyblok/schema 0.1.0-alpha.0

package/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2025 Storyblok GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,74 @@
+<div align="center">
+
+![Storyblok ImagoType](https://raw.githubusercontent.com/storyblok/.github/refs/heads/main/profile/public/github-banner.png)
+
+<h1 align="center">@storyblok/schema</h1>
+ <p>
+    Shared Storyblok schema types generated from the Management and Content API specifications
+  </p>
+  <br />
+</div>
+
+<p align="center">
+  <a href="https://npmjs.com/package/@storyblok/schema">
+    <img src="https://img.shields.io/npm/v/@storyblok/schema/latest.svg?style=flat-square&color=8d60ff" alt="@storyblok/schema" />
+  </a>
+  <a href="https://npmjs.com/package/@storyblok/schema" rel="nofollow">
+    <img src="https://img.shields.io/npm/dt/@storyblok/schema.svg?style=appveyor&color=8d60ff" alt="npm">
+  </a>
+  <a href="https://storyblok.com/join-discord">
+   <img src="https://img.shields.io/discord/700316478792138842?label=Join%20Our%20Discord%20Community&style=appveyor&logo=discord&color=8d60ff">
+   </a>
+  <a href="https://twitter.com/intent/follow?screen_name=storyblok">
+    <img src="https://img.shields.io/badge/Follow-%40storyblok-8d60ff?style=appveyor&logo=twitter" alt="Follow @Storyblok" />
+  </a><br/>
+  <a href="https://app.storyblok.com/#!/signup?utm_source=github.com&utm_medium=readme&utm_campaign=@storyblok/schema">
+    <img src="https://img.shields.io/badge/Try%20Storyblok-Free-8d60ff?style=appveyor&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAB4AAAAeCAYAAAA7MK6iAAAABGdBTUEAALGPC/xhBQAAADhlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAAqACAAQAAAABAAAAHqADAAQAAAABAAAAHgAAAADpiRU/AAACRElEQVRIDWNgGGmAEd3D3Js3LPrP8D8WXZwSPiMjw6qvPoHhyGYwIXNAbGpbCjbzP0MYuj0YFqMroBV/wCxmIeSju64eDNzMBJUxvP/9i2Hnq5cM1devMnz984eQsQwETeRhYWHgIcJiXqC6VHlFBjUeXgav40cIWkz1oLYXFmGwFBImaDFBHyObcOzdW4aSq5eRhRiE2dgYlpuYoYSKJi8vw3GgWnyAJIs/AuPu4scPGObd/fqVQZ+PHy7+6udPOBsXgySLDfn5GRYYmaKYJcXBgWLpsx8/GPa8foWiBhuHJIsl2DkYQqWksZkDFgP5PObcKYYff//iVAOTIDlx/QPqRMb/YSYBaWlOToZIaVkGZmAZSQiQ5OPtwHwacuo4iplMQEu6tXUZMhSUGDiYmBjylFQYvv/7x9B04xqKOnQOyT5GN+Df//8M59ASXKyMHLoyDD5JPtbj42OYrm+EYgg70JfuYuIoYmLs7AwMjIzA+uY/zjAnyWJpDk6GOFnCvrn86SOwmsNtKciVFAc1ileBHFDC67lzG10Yg0+SjzF0ownsf/OaofvOLYaDQJoQIGix94ljv1gIZI8Pv38zPvj2lQWYf3HGKbpDCFp85v07NnRN1OBTPY6JdRSGxcCw2k6sZuLVMZ5AV4s1TozPnGGFKbz+/PE7IJsHmC//MDMyhXBw8e6FyRFLv3Z0/IKuFqvFyIqAzd1PwBzJw8jAGPfVx38JshwlbIygxmYY43/GQmpais0ODDHuzevLMARHBcgIAQAbOJHZW0/EyQAAAABJRU5ErkJggg==" alt="Follow @Storyblok" />
+  </a>
+</p>
+
+## Features
+
+- **Generated Types**: TypeScript types generated from Storyblok Management and Content API OpenAPI specifications
+- **Shared Schema Layer**: Reuse the same Storyblok content shapes across packages and integrations
+- **Framework Agnostic**: Use the package in any TypeScript project without framework-specific dependencies
+- **Monorepo Aligned**: Built from the same source specifications used throughout the Storyblok monoblok repository
+
+## Documentation
+
+<!-- TODO: restore docs link once live — https://www.storyblok.com/docs/packages/storyblok-schema (docs #536/#548) -->
+
+Full package documentation is coming soon. For now, browse the [package source on GitHub](https://github.com/storyblok/monoblok/tree/alpha/packages/schema) or explore a runnable example in the [Astro playground](https://github.com/storyblok/monoblok/tree/alpha/packages/schema/playground/astro).
+
+## Contributing
+
+If you'd like to contribute, please refer to the [contributing guidelines](../../CONTRIBUTING.md).
+
+## Community
+
+For help, discussion about best practices, or any other conversation that would benefit from being searchable:
+
+- [Discuss Storyblok on GitHub Discussions](https://github.com/storyblok/monoblok/discussions)
+
+For community support, chatting with other users, please visit:
+
+- [Discuss Storyblok on Discord](https://storyblok.com/join-discord)
+
+## Support
+
+For bugs or feature requests, please [submit an issue](https://github.com/storyblok/monoblok/issues/new/choose).
+
+> [!IMPORTANT]
+> Please search existing issues before submitting a new one. Issues without a minimal reproducible example will be closed. [Why reproductions are Required](https://antfu.me/posts/why-reproductions-are-required).
+
+### I can't share my company project code
+
+We understand that you might not be able to share your company's project code. Please provide a minimal reproducible example that demonstrates the issue by using tools like [Stackblitz](https://stackblitz.com) or a link to a GitHub repo. Please make sure you include a README file with the instructions to build and run the project, important not to include any access token, password or personal information of any kind.
+
+### Feedback
+
+If you have a question, please ask in the [Discuss Storyblok on Discord](https://storyblok.com/join-discord) channel.
+
+## License
+
+[License](/LICENSE)

package/dist/generated/capi/_internal.gen.d.cts

@@ -0,0 +1,120 @@
+//#region src/generated/capi/_internal.gen.d.ts
+type CapiStory = ({
+  version?: 'draft';
+} & DraftStory) | ({
+  version?: 'published';
+} & PublishedStory);
+type DraftStory = {
+  name: string;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  created_at: string;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at?: string | null;
+  /**
+   * Latest publication timestamp (format is ISO 8601 standard in UTC).
+   */
+  published_at: string | null;
+  alternates: Array<StoryAlternate>;
+  id: number;
+  uuid: string;
+  /**
+   * Dynamic component data rendered by Storyblok, structure varies by component.
+   */
+  content: {
+    _uid?: string;
+    component?: string;
+    [key: string]: unknown | string | undefined;
+  };
+  slug: string;
+  full_slug: string;
+  default_full_slug: string | null;
+  sort_by_date: string | null;
+  position: number;
+  tag_list: Array<string>;
+  is_startpage: boolean;
+  parent_id: number;
+  /**
+   * Custom metadata for the story.
+   */
+  meta_data: {
+    [key: string]: unknown;
+  } | null;
+  group_id: string;
+  first_published_at: string | null;
+  release_id: number | null;
+  lang: string;
+  path: string | null;
+  translated_slugs: Array<{
+    path: string;
+    name: string | null;
+    lang: string;
+    published: string | null;
+  }> | null;
+};
+type PublishedStory = {
+  name: string;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  created_at: string;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at?: string | null;
+  /**
+   * Latest publication timestamp (format is ISO 8601 standard in UTC).
+   */
+  published_at: string | null;
+  id: number;
+  uuid: string;
+  /**
+   * Dynamic component data rendered by Storyblok, structure varies by component.
+   */
+  content: {
+    _uid?: string;
+    component?: string;
+    [key: string]: unknown | string | undefined;
+  };
+  slug: string;
+  full_slug: string;
+  sort_by_date: string | null;
+  position: number;
+  tag_list: Array<string>;
+  is_startpage: boolean;
+  parent_id: number;
+  /**
+   * Custom metadata for the story.
+   */
+  meta_data: {
+    [key: string]: unknown;
+  } | null;
+  group_id: string;
+  first_published_at: string | null;
+  release_id?: number | null;
+  lang: string;
+  path: string | null;
+  alternates: Array<StoryAlternate>;
+  default_full_slug: string | null;
+  translated_slugs: Array<{
+    path: string;
+    name: string | null;
+    lang: string;
+    published: string | null;
+  }> | null;
+};
+type StoryAlternate = {
+  id: number;
+  name: string;
+  slug: string;
+  published: boolean | null;
+  full_slug: string;
+  is_folder: boolean;
+  parent_id: number;
+};
+//#endregion
+export { CapiStory };
+//# sourceMappingURL=_internal.gen.d.cts.map

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

@@ -0,0 +1,120 @@
+//#region src/generated/capi/_internal.gen.d.ts
+type CapiStory = ({
+  version?: 'draft';
+} & DraftStory) | ({
+  version?: 'published';
+} & PublishedStory);
+type DraftStory = {
+  name: string;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  created_at: string;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at?: string | null;
+  /**
+   * Latest publication timestamp (format is ISO 8601 standard in UTC).
+   */
+  published_at: string | null;
+  alternates: Array<StoryAlternate>;
+  id: number;
+  uuid: string;
+  /**
+   * Dynamic component data rendered by Storyblok, structure varies by component.
+   */
+  content: {
+    _uid?: string;
+    component?: string;
+    [key: string]: unknown | string | undefined;
+  };
+  slug: string;
+  full_slug: string;
+  default_full_slug: string | null;
+  sort_by_date: string | null;
+  position: number;
+  tag_list: Array<string>;
+  is_startpage: boolean;
+  parent_id: number;
+  /**
+   * Custom metadata for the story.
+   */
+  meta_data: {
+    [key: string]: unknown;
+  } | null;
+  group_id: string;
+  first_published_at: string | null;
+  release_id: number | null;
+  lang: string;
+  path: string | null;
+  translated_slugs: Array<{
+    path: string;
+    name: string | null;
+    lang: string;
+    published: string | null;
+  }> | null;
+};
+type PublishedStory = {
+  name: string;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  created_at: string;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at?: string | null;
+  /**
+   * Latest publication timestamp (format is ISO 8601 standard in UTC).
+   */
+  published_at: string | null;
+  id: number;
+  uuid: string;
+  /**
+   * Dynamic component data rendered by Storyblok, structure varies by component.
+   */
+  content: {
+    _uid?: string;
+    component?: string;
+    [key: string]: unknown | string | undefined;
+  };
+  slug: string;
+  full_slug: string;
+  sort_by_date: string | null;
+  position: number;
+  tag_list: Array<string>;
+  is_startpage: boolean;
+  parent_id: number;
+  /**
+   * Custom metadata for the story.
+   */
+  meta_data: {
+    [key: string]: unknown;
+  } | null;
+  group_id: string;
+  first_published_at: string | null;
+  release_id?: number | null;
+  lang: string;
+  path: string | null;
+  alternates: Array<StoryAlternate>;
+  default_full_slug: string | null;
+  translated_slugs: Array<{
+    path: string;
+    name: string | null;
+    lang: string;
+    published: string | null;
+  }> | null;
+};
+type StoryAlternate = {
+  id: number;
+  name: string;
+  slug: string;
+  published: boolean | null;
+  full_slug: string;
+  is_folder: boolean;
+  parent_id: number;
+};
+//#endregion
+export { CapiStory };
+//# sourceMappingURL=_internal.gen.d.mts.map

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

@@ -0,0 +1,181 @@
+//#region src/generated/capi/types.gen.d.ts
+type StoryAlternate = {
+  id: number;
+  name: string;
+  slug: string;
+  published: boolean | null;
+  full_slug: string;
+  is_folder: boolean;
+  parent_id: number;
+};
+type Datasource = {
+  /**
+   * ID.
+   */
+  id: number;
+  /**
+   * Name.
+   */
+  name: string;
+  /**
+   * The unique slug of the datasource.
+   */
+  slug: string;
+  /**
+   * Dimensions of the datasource.
+   */
+  dimensions: Array<Dimension>;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  created_at?: string;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at?: string;
+};
+type DatasourceEntry = {
+  /**
+   * ID.
+   */
+  id: number;
+  /**
+   * Name.
+   */
+  name: string;
+  /**
+   * Given value in default dimension.
+   */
+  value: string;
+  /**
+   * Given value in the requested dimension.
+   */
+  dimension_value: string | null;
+};
+type Link = {
+  /**
+   * ID.
+   */
+  id: number;
+  uuid: string;
+  /**
+   * The full slug of the story or folder.
+   */
+  slug: string;
+  /**
+   * Real path defined in the story's entry configuration.
+   */
+  path?: string | null;
+  /**
+   * Either the full slug of the story or folder with a leading /, or, if existent, the value of the real path defined in the story's entry configuration with a leading /.
+   */
+  real_path?: string | null;
+  /**
+   * The complete name of the story or folder.
+   */
+  name: string;
+  /**
+   * true if a story is currently published, even if it has unpublished changes.
+   */
+  published: boolean;
+  /**
+   * ID of the parent folder.
+   */
+  parent_id: number;
+  /**
+   * true if the instance constitutes a folder.
+   */
+  is_folder: boolean;
+  /**
+   * true if the story is defined as root for the folder.
+   */
+  is_startpage: boolean;
+  /**
+   * Numeric representation of the story's position in the folder.
+   */
+  position: number;
+  /**
+   * Latest publication timestamp (format is ISO 8601 standard in UTC).
+   */
+  published_at?: string | null;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  created_at?: string | null;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at?: string | null;
+  /**
+   * Alternate language variants.
+   */
+  alternates?: Array<Alternate>;
+};
+type Tag = {
+  /**
+   * The name of the tag.
+   */
+  name: string;
+  /**
+   * The minimum value of `taggings_count` is 1, not 0.
+   * - The number of tags with this name that exist in the space, or
+   * - The number of draft or published stories with this tag, or
+   * - The number of deleted stories with this tag.
+   */
+  taggings_count?: number;
+  /**
+   * Only visible when passing the `all_tags` parameter. The number of stories currently associated with the tag, corresponding to the <strong>Assigned items</strong> column in the <a href='https://www.storyblok.com/docs/manuals/stories#tags'>Tags tab</a>.
+   */
+  tag_on_stories?: number;
+};
+type Dimension = {
+  /**
+   * ID.
+   */
+  id: number;
+  /**
+   * Name.
+   */
+  name: string;
+  /**
+   * The value provided for the datasource dimension.
+   */
+  entry_value: string;
+  /**
+   * The numeric ID of the datasource that the dimension belongs to.
+   */
+  datasource_id?: number;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  created_at?: string;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at?: string;
+};
+type Alternate = {
+  /**
+   * Translated slug (or parent slug if not installed).
+   */
+  path: string;
+  /**
+   * Translated name of the story or folder.
+   */
+  name: string;
+  /**
+   * Language code of this story variant.
+   */
+  lang: string;
+  /**
+   * True if this variant is published.
+   */
+  published: boolean;
+  /**
+   * Translated slug of the story.
+   */
+  translated_slug: string;
+};
+//#endregion
+export { Datasource, DatasourceEntry, Link, StoryAlternate, Tag };
+//# sourceMappingURL=types.gen.d.cts.map

package/dist/generated/capi/types.gen.d.mts

@@ -0,0 +1,181 @@
+//#region src/generated/capi/types.gen.d.ts
+type StoryAlternate = {
+  id: number;
+  name: string;
+  slug: string;
+  published: boolean | null;
+  full_slug: string;
+  is_folder: boolean;
+  parent_id: number;
+};
+type Datasource = {
+  /**
+   * ID.
+   */
+  id: number;
+  /**
+   * Name.
+   */
+  name: string;
+  /**
+   * The unique slug of the datasource.
+   */
+  slug: string;
+  /**
+   * Dimensions of the datasource.
+   */
+  dimensions: Array<Dimension>;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  created_at?: string;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at?: string;
+};
+type DatasourceEntry = {
+  /**
+   * ID.
+   */
+  id: number;
+  /**
+   * Name.
+   */
+  name: string;
+  /**
+   * Given value in default dimension.
+   */
+  value: string;
+  /**
+   * Given value in the requested dimension.
+   */
+  dimension_value: string | null;
+};
+type Link = {
+  /**
+   * ID.
+   */
+  id: number;
+  uuid: string;
+  /**
+   * The full slug of the story or folder.
+   */
+  slug: string;
+  /**
+   * Real path defined in the story's entry configuration.
+   */
+  path?: string | null;
+  /**
+   * Either the full slug of the story or folder with a leading /, or, if existent, the value of the real path defined in the story's entry configuration with a leading /.
+   */
+  real_path?: string | null;
+  /**
+   * The complete name of the story or folder.
+   */
+  name: string;
+  /**
+   * true if a story is currently published, even if it has unpublished changes.
+   */
+  published: boolean;
+  /**
+   * ID of the parent folder.
+   */
+  parent_id: number;
+  /**
+   * true if the instance constitutes a folder.
+   */
+  is_folder: boolean;
+  /**
+   * true if the story is defined as root for the folder.
+   */
+  is_startpage: boolean;
+  /**
+   * Numeric representation of the story's position in the folder.
+   */
+  position: number;
+  /**
+   * Latest publication timestamp (format is ISO 8601 standard in UTC).
+   */
+  published_at?: string | null;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  created_at?: string | null;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at?: string | null;
+  /**
+   * Alternate language variants.
+   */
+  alternates?: Array<Alternate>;
+};
+type Tag = {
+  /**
+   * The name of the tag.
+   */
+  name: string;
+  /**
+   * The minimum value of `taggings_count` is 1, not 0.
+   * - The number of tags with this name that exist in the space, or
+   * - The number of draft or published stories with this tag, or
+   * - The number of deleted stories with this tag.
+   */
+  taggings_count?: number;
+  /**
+   * Only visible when passing the `all_tags` parameter. The number of stories currently associated with the tag, corresponding to the <strong>Assigned items</strong> column in the <a href='https://www.storyblok.com/docs/manuals/stories#tags'>Tags tab</a>.
+   */
+  tag_on_stories?: number;
+};
+type Dimension = {
+  /**
+   * ID.
+   */
+  id: number;
+  /**
+   * Name.
+   */
+  name: string;
+  /**
+   * The value provided for the datasource dimension.
+   */
+  entry_value: string;
+  /**
+   * The numeric ID of the datasource that the dimension belongs to.
+   */
+  datasource_id?: number;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  created_at?: string;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at?: string;
+};
+type Alternate = {
+  /**
+   * Translated slug (or parent slug if not installed).
+   */
+  path: string;
+  /**
+   * Translated name of the story or folder.
+   */
+  name: string;
+  /**
+   * Language code of this story variant.
+   */
+  lang: string;
+  /**
+   * True if this variant is published.
+   */
+  published: boolean;
+  /**
+   * Translated slug of the story.
+   */
+  translated_slug: string;
+};
+//#endregion
+export { Datasource, DatasourceEntry, Link, StoryAlternate, Tag };
+//# sourceMappingURL=types.gen.d.mts.map