@storyblok/schema 1.0.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (104) hide show
  1. package/README.md +72 -0
  2. package/dist/generated/mapi-types.d.cts +732 -0
  3. package/dist/generated/mapi-types.d.mts +732 -0
  4. package/dist/generated/types.d.cts +155 -0
  5. package/dist/generated/types.d.mts +155 -0
  6. package/dist/helpers/create-story-helpers.cjs +42 -0
  7. package/dist/helpers/create-story-helpers.cjs.map +1 -0
  8. package/dist/helpers/create-story-helpers.d.cts +48 -0
  9. package/dist/helpers/create-story-helpers.d.mts +48 -0
  10. package/dist/helpers/create-story-helpers.mjs +42 -0
  11. package/dist/helpers/create-story-helpers.mjs.map +1 -0
  12. package/dist/helpers/define-asset-folder.cjs +40 -0
  13. package/dist/helpers/define-asset-folder.cjs.map +1 -0
  14. package/dist/helpers/define-asset-folder.d.cts +33 -0
  15. package/dist/helpers/define-asset-folder.d.mts +33 -0
  16. package/dist/helpers/define-asset-folder.mjs +37 -0
  17. package/dist/helpers/define-asset-folder.mjs.map +1 -0
  18. package/dist/helpers/define-asset.cjs +43 -0
  19. package/dist/helpers/define-asset.cjs.map +1 -0
  20. package/dist/helpers/define-asset.d.cts +32 -0
  21. package/dist/helpers/define-asset.d.mts +32 -0
  22. package/dist/helpers/define-asset.mjs +40 -0
  23. package/dist/helpers/define-asset.mjs.map +1 -0
  24. package/dist/helpers/define-block-folder.cjs +40 -0
  25. package/dist/helpers/define-block-folder.cjs.map +1 -0
  26. package/dist/helpers/define-block-folder.d.cts +34 -0
  27. package/dist/helpers/define-block-folder.d.mts +34 -0
  28. package/dist/helpers/define-block-folder.mjs +37 -0
  29. package/dist/helpers/define-block-folder.mjs.map +1 -0
  30. package/dist/helpers/define-block.cjs +51 -0
  31. package/dist/helpers/define-block.cjs.map +1 -0
  32. package/dist/helpers/define-block.d.cts +90 -0
  33. package/dist/helpers/define-block.d.mts +90 -0
  34. package/dist/helpers/define-block.mjs +48 -0
  35. package/dist/helpers/define-block.mjs.map +1 -0
  36. package/dist/helpers/define-datasource-entry.cjs +41 -0
  37. package/dist/helpers/define-datasource-entry.cjs.map +1 -0
  38. package/dist/helpers/define-datasource-entry.d.cts +48 -0
  39. package/dist/helpers/define-datasource-entry.d.mts +48 -0
  40. package/dist/helpers/define-datasource-entry.mjs +37 -0
  41. package/dist/helpers/define-datasource-entry.mjs.map +1 -0
  42. package/dist/helpers/define-datasource.cjs +33 -0
  43. package/dist/helpers/define-datasource.cjs.map +1 -0
  44. package/dist/helpers/define-datasource.d.cts +41 -0
  45. package/dist/helpers/define-datasource.d.mts +41 -0
  46. package/dist/helpers/define-datasource.mjs +30 -0
  47. package/dist/helpers/define-datasource.mjs.map +1 -0
  48. package/dist/helpers/define-field.cjs +17 -0
  49. package/dist/helpers/define-field.cjs.map +1 -0
  50. package/dist/helpers/define-field.d.cts +100 -0
  51. package/dist/helpers/define-field.d.mts +100 -0
  52. package/dist/helpers/define-field.mjs +16 -0
  53. package/dist/helpers/define-field.mjs.map +1 -0
  54. package/dist/helpers/define-internal-tag.cjs +37 -0
  55. package/dist/helpers/define-internal-tag.cjs.map +1 -0
  56. package/dist/helpers/define-internal-tag.d.cts +34 -0
  57. package/dist/helpers/define-internal-tag.d.mts +34 -0
  58. package/dist/helpers/define-internal-tag.mjs +34 -0
  59. package/dist/helpers/define-internal-tag.mjs.map +1 -0
  60. package/dist/helpers/define-link.cjs +22 -0
  61. package/dist/helpers/define-link.cjs.map +1 -0
  62. package/dist/helpers/define-link.d.cts +31 -0
  63. package/dist/helpers/define-link.d.mts +31 -0
  64. package/dist/helpers/define-link.mjs +21 -0
  65. package/dist/helpers/define-link.mjs.map +1 -0
  66. package/dist/helpers/define-preset.cjs +37 -0
  67. package/dist/helpers/define-preset.cjs.map +1 -0
  68. package/dist/helpers/define-preset.d.cts +35 -0
  69. package/dist/helpers/define-preset.d.mts +35 -0
  70. package/dist/helpers/define-preset.mjs +34 -0
  71. package/dist/helpers/define-preset.mjs.map +1 -0
  72. package/dist/helpers/define-space.cjs +34 -0
  73. package/dist/helpers/define-space.cjs.map +1 -0
  74. package/dist/helpers/define-space.d.cts +31 -0
  75. package/dist/helpers/define-space.d.mts +31 -0
  76. package/dist/helpers/define-space.mjs +31 -0
  77. package/dist/helpers/define-space.mjs.map +1 -0
  78. package/dist/helpers/define-story.cjs +94 -0
  79. package/dist/helpers/define-story.cjs.map +1 -0
  80. package/dist/helpers/define-story.d.cts +127 -0
  81. package/dist/helpers/define-story.d.mts +127 -0
  82. package/dist/helpers/define-story.mjs +90 -0
  83. package/dist/helpers/define-story.mjs.map +1 -0
  84. package/dist/helpers/define-tag.cjs +13 -0
  85. package/dist/helpers/define-tag.cjs.map +1 -0
  86. package/dist/helpers/define-tag.d.cts +23 -0
  87. package/dist/helpers/define-tag.d.mts +23 -0
  88. package/dist/helpers/define-tag.mjs +12 -0
  89. package/dist/helpers/define-tag.mjs.map +1 -0
  90. package/dist/helpers/define-user.cjs +32 -0
  91. package/dist/helpers/define-user.cjs.map +1 -0
  92. package/dist/helpers/define-user.d.cts +26 -0
  93. package/dist/helpers/define-user.d.mts +26 -0
  94. package/dist/helpers/define-user.mjs +30 -0
  95. package/dist/helpers/define-user.mjs.map +1 -0
  96. package/dist/helpers/schema-type.d.cts +40 -0
  97. package/dist/helpers/schema-type.d.mts +40 -0
  98. package/dist/index.cjs +55 -0
  99. package/dist/index.d.cts +19 -0
  100. package/dist/index.d.mts +19 -0
  101. package/dist/index.mjs +17 -0
  102. package/dist/utils/prettify.d.cts +9 -0
  103. package/dist/utils/prettify.d.mts +9 -0
  104. package/package.json +85 -0
package/README.md ADDED
@@ -0,0 +1,72 @@
1
+ <div align="center">
2
+
3
+ ![Storyblok ImagoType](https://raw.githubusercontent.com/storyblok/.github/refs/heads/main/profile/public/github-banner.png)
4
+
5
+ <h1 align="center">@storyblok/schema</h1>
6
+ <p>
7
+ Shared Storyblok schema types generated from the Management and Content API specifications
8
+ </p>
9
+ <br />
10
+ </div>
11
+
12
+ <p align="center">
13
+ <a href="https://npmjs.com/package/@storyblok/schema">
14
+ <img src="https://img.shields.io/npm/v/@storyblok/schema/latest.svg?style=flat-square&color=8d60ff" alt="@storyblok/schema" />
15
+ </a>
16
+ <a href="https://npmjs.com/package/@storyblok/schema" rel="nofollow">
17
+ <img src="https://img.shields.io/npm/dt/@storyblok/schema.svg?style=appveyor&color=8d60ff" alt="npm">
18
+ </a>
19
+ <a href="https://storyblok.com/join-discord">
20
+ <img src="https://img.shields.io/discord/700316478792138842?label=Join%20Our%20Discord%20Community&style=appveyor&logo=discord&color=8d60ff">
21
+ </a>
22
+ <a href="https://twitter.com/intent/follow?screen_name=storyblok">
23
+ <img src="https://img.shields.io/badge/Follow-%40storyblok-8d60ff?style=appveyor&logo=twitter" alt="Follow @Storyblok" />
24
+ </a><br/>
25
+ <a href="https://app.storyblok.com/#!/signup?utm_source=github.com&utm_medium=readme&utm_campaign=@storyblok/schema">
26
+ <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" />
27
+ </a>
28
+ </p>
29
+
30
+ ## Features
31
+
32
+ - **Generated Types**: TypeScript types generated from Storyblok Management and Content API OpenAPI specifications
33
+ - **Shared Schema Layer**: Reuse the same Storyblok content shapes across packages and integrations
34
+ - **Framework Agnostic**: Use the package in any TypeScript project without framework-specific dependencies
35
+ - **Monorepo Aligned**: Built from the same source specifications used throughout the Storyblok monoblok repository
36
+
37
+ ## Documentation
38
+
39
+ For complete documentation, please visit [package reference](https://www.storyblok.com/docs/packages/storyblok-schema)
40
+
41
+ ## Contributing
42
+
43
+ If you'd like to contribute, please refer to the [contributing guidelines](../../CONTRIBUTING.md).
44
+
45
+ ## Community
46
+
47
+ For help, discussion about best practices, or any other conversation that would benefit from being searchable:
48
+
49
+ - [Discuss Storyblok on GitHub Discussions](https://github.com/storyblok/monoblok/discussions)
50
+
51
+ For community support, chatting with other users, please visit:
52
+
53
+ - [Discuss Storyblok on Discord](https://storyblok.com/join-discord)
54
+
55
+ ## Support
56
+
57
+ For bugs or feature requests, please [submit an issue](https://github.com/storyblok/monoblok/issues/new/choose).
58
+
59
+ > [!IMPORTANT]
60
+ > 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).
61
+
62
+ ### I can't share my company project code
63
+
64
+ 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.
65
+
66
+ ### Feedback
67
+
68
+ If you have a question, please ask in the [Discuss Storyblok on Discord](https://storyblok.com/join-discord) channel.
69
+
70
+ ## License
71
+
72
+ [License](/LICENSE)