@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.
- package/README.md +72 -0
- package/dist/generated/mapi-types.d.cts +732 -0
- package/dist/generated/mapi-types.d.mts +732 -0
- package/dist/generated/types.d.cts +155 -0
- package/dist/generated/types.d.mts +155 -0
- package/dist/helpers/create-story-helpers.cjs +42 -0
- package/dist/helpers/create-story-helpers.cjs.map +1 -0
- package/dist/helpers/create-story-helpers.d.cts +48 -0
- package/dist/helpers/create-story-helpers.d.mts +48 -0
- package/dist/helpers/create-story-helpers.mjs +42 -0
- package/dist/helpers/create-story-helpers.mjs.map +1 -0
- package/dist/helpers/define-asset-folder.cjs +40 -0
- package/dist/helpers/define-asset-folder.cjs.map +1 -0
- package/dist/helpers/define-asset-folder.d.cts +33 -0
- package/dist/helpers/define-asset-folder.d.mts +33 -0
- package/dist/helpers/define-asset-folder.mjs +37 -0
- package/dist/helpers/define-asset-folder.mjs.map +1 -0
- package/dist/helpers/define-asset.cjs +43 -0
- package/dist/helpers/define-asset.cjs.map +1 -0
- package/dist/helpers/define-asset.d.cts +32 -0
- package/dist/helpers/define-asset.d.mts +32 -0
- package/dist/helpers/define-asset.mjs +40 -0
- package/dist/helpers/define-asset.mjs.map +1 -0
- package/dist/helpers/define-block-folder.cjs +40 -0
- package/dist/helpers/define-block-folder.cjs.map +1 -0
- package/dist/helpers/define-block-folder.d.cts +34 -0
- package/dist/helpers/define-block-folder.d.mts +34 -0
- package/dist/helpers/define-block-folder.mjs +37 -0
- package/dist/helpers/define-block-folder.mjs.map +1 -0
- package/dist/helpers/define-block.cjs +51 -0
- package/dist/helpers/define-block.cjs.map +1 -0
- package/dist/helpers/define-block.d.cts +90 -0
- package/dist/helpers/define-block.d.mts +90 -0
- package/dist/helpers/define-block.mjs +48 -0
- package/dist/helpers/define-block.mjs.map +1 -0
- package/dist/helpers/define-datasource-entry.cjs +41 -0
- package/dist/helpers/define-datasource-entry.cjs.map +1 -0
- package/dist/helpers/define-datasource-entry.d.cts +48 -0
- package/dist/helpers/define-datasource-entry.d.mts +48 -0
- package/dist/helpers/define-datasource-entry.mjs +37 -0
- package/dist/helpers/define-datasource-entry.mjs.map +1 -0
- package/dist/helpers/define-datasource.cjs +33 -0
- package/dist/helpers/define-datasource.cjs.map +1 -0
- package/dist/helpers/define-datasource.d.cts +41 -0
- package/dist/helpers/define-datasource.d.mts +41 -0
- package/dist/helpers/define-datasource.mjs +30 -0
- package/dist/helpers/define-datasource.mjs.map +1 -0
- package/dist/helpers/define-field.cjs +17 -0
- package/dist/helpers/define-field.cjs.map +1 -0
- package/dist/helpers/define-field.d.cts +100 -0
- package/dist/helpers/define-field.d.mts +100 -0
- package/dist/helpers/define-field.mjs +16 -0
- package/dist/helpers/define-field.mjs.map +1 -0
- package/dist/helpers/define-internal-tag.cjs +37 -0
- package/dist/helpers/define-internal-tag.cjs.map +1 -0
- package/dist/helpers/define-internal-tag.d.cts +34 -0
- package/dist/helpers/define-internal-tag.d.mts +34 -0
- package/dist/helpers/define-internal-tag.mjs +34 -0
- package/dist/helpers/define-internal-tag.mjs.map +1 -0
- package/dist/helpers/define-link.cjs +22 -0
- package/dist/helpers/define-link.cjs.map +1 -0
- package/dist/helpers/define-link.d.cts +31 -0
- package/dist/helpers/define-link.d.mts +31 -0
- package/dist/helpers/define-link.mjs +21 -0
- package/dist/helpers/define-link.mjs.map +1 -0
- package/dist/helpers/define-preset.cjs +37 -0
- package/dist/helpers/define-preset.cjs.map +1 -0
- package/dist/helpers/define-preset.d.cts +35 -0
- package/dist/helpers/define-preset.d.mts +35 -0
- package/dist/helpers/define-preset.mjs +34 -0
- package/dist/helpers/define-preset.mjs.map +1 -0
- package/dist/helpers/define-space.cjs +34 -0
- package/dist/helpers/define-space.cjs.map +1 -0
- package/dist/helpers/define-space.d.cts +31 -0
- package/dist/helpers/define-space.d.mts +31 -0
- package/dist/helpers/define-space.mjs +31 -0
- package/dist/helpers/define-space.mjs.map +1 -0
- package/dist/helpers/define-story.cjs +94 -0
- package/dist/helpers/define-story.cjs.map +1 -0
- package/dist/helpers/define-story.d.cts +127 -0
- package/dist/helpers/define-story.d.mts +127 -0
- package/dist/helpers/define-story.mjs +90 -0
- package/dist/helpers/define-story.mjs.map +1 -0
- package/dist/helpers/define-tag.cjs +13 -0
- package/dist/helpers/define-tag.cjs.map +1 -0
- package/dist/helpers/define-tag.d.cts +23 -0
- package/dist/helpers/define-tag.d.mts +23 -0
- package/dist/helpers/define-tag.mjs +12 -0
- package/dist/helpers/define-tag.mjs.map +1 -0
- package/dist/helpers/define-user.cjs +32 -0
- package/dist/helpers/define-user.cjs.map +1 -0
- package/dist/helpers/define-user.d.cts +26 -0
- package/dist/helpers/define-user.d.mts +26 -0
- package/dist/helpers/define-user.mjs +30 -0
- package/dist/helpers/define-user.mjs.map +1 -0
- package/dist/helpers/schema-type.d.cts +40 -0
- package/dist/helpers/schema-type.d.mts +40 -0
- package/dist/index.cjs +55 -0
- package/dist/index.d.cts +19 -0
- package/dist/index.d.mts +19 -0
- package/dist/index.mjs +17 -0
- package/dist/utils/prettify.d.cts +9 -0
- package/dist/utils/prettify.d.mts +9 -0
- package/package.json +85 -0
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
//#region src/helpers/define-user.ts
|
|
2
|
+
const USER_DEFAULTS = {
|
|
3
|
+
id: 1,
|
|
4
|
+
created_at: "",
|
|
5
|
+
updated_at: ""
|
|
6
|
+
};
|
|
7
|
+
/**
|
|
8
|
+
* Defines a user object for the MAPI.
|
|
9
|
+
* API-assigned fields (`id`, `created_at`, `updated_at`) are optional and filled with safe defaults.
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* import { defineUser } from '@storyblok/schema';
|
|
13
|
+
* const user = defineUser({ email: 'dev@example.com' });
|
|
14
|
+
*/
|
|
15
|
+
const defineUser = (user) => ({
|
|
16
|
+
...USER_DEFAULTS,
|
|
17
|
+
...user
|
|
18
|
+
});
|
|
19
|
+
/**
|
|
20
|
+
* Defines a user update payload for the MAPI (updateMe endpoint).
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* import { defineUserUpdate } from '@storyblok/schema';
|
|
24
|
+
* const payload = defineUserUpdate({ firstname: 'Jane', lastname: 'Doe' });
|
|
25
|
+
*/
|
|
26
|
+
const defineUserUpdate = (user) => user;
|
|
27
|
+
|
|
28
|
+
//#endregion
|
|
29
|
+
export { defineUser, defineUserUpdate };
|
|
30
|
+
//# sourceMappingURL=define-user.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"define-user.mjs","names":[],"sources":["../../src/helpers/define-user.ts"],"sourcesContent":["import type { User, UserUpdate } from '../generated/mapi-types';\n\nexport type { User, UserUpdate };\n\nconst USER_DEFAULTS = {\n id: 1,\n created_at: '',\n updated_at: '',\n};\n\ntype UserInput = { email: string } & Partial<Omit<User, 'email'>>;\n\n/**\n * Defines a user object for the MAPI.\n * API-assigned fields (`id`, `created_at`, `updated_at`) are optional and filled with safe defaults.\n *\n * @example\n * import { defineUser } from '@storyblok/schema';\n * const user = defineUser({ email: 'dev@example.com' });\n */\nexport const defineUser = (user: UserInput): User => ({ ...USER_DEFAULTS, ...user });\n\n/**\n * Defines a user update payload for the MAPI (updateMe endpoint).\n *\n * @example\n * import { defineUserUpdate } from '@storyblok/schema';\n * const payload = defineUserUpdate({ firstname: 'Jane', lastname: 'Doe' });\n */\nexport const defineUserUpdate = (user: UserUpdate): UserUpdate => user;\n"],"mappings":";AAIA,MAAM,gBAAgB;CACpB,IAAI;CACJ,YAAY;CACZ,YAAY;CACb;;;;;;;;;AAYD,MAAa,cAAc,UAA2B;CAAE,GAAG;CAAe,GAAG;CAAM;;;;;;;;AASnF,MAAa,oBAAoB,SAAiC"}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { Datasource } from "../generated/types.cjs";
|
|
2
|
+
import { ComponentFolder } from "../generated/mapi-types.cjs";
|
|
3
|
+
import { Block } from "./define-block.cjs";
|
|
4
|
+
|
|
5
|
+
//#region src/helpers/schema-type.d.ts
|
|
6
|
+
/**
|
|
7
|
+
* Derives a schema types interface from a schema object.
|
|
8
|
+
*
|
|
9
|
+
* Accepts the `typeof` a schema object whose `blocks` property is a
|
|
10
|
+
* record of `defineBlock()` results, and optionally `blockFolders`
|
|
11
|
+
* and `datasources` records, and produces a type with unions of those types.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* import type { Schema as InferSchema } from '@storyblok/schema';
|
|
16
|
+
*
|
|
17
|
+
* export const schema = {
|
|
18
|
+
* blocks: { pageBlock, heroBlock },
|
|
19
|
+
* blockFolders: { layoutFolder },
|
|
20
|
+
* datasources: { colorsDatasource },
|
|
21
|
+
* };
|
|
22
|
+
*
|
|
23
|
+
* export type Schema = InferSchema<typeof schema>;
|
|
24
|
+
* export type Blocks = Schema['blocks'];
|
|
25
|
+
* export type BlockFolders = Schema['blockFolders'];
|
|
26
|
+
* export type Datasources = Schema['datasources'];
|
|
27
|
+
* ```
|
|
28
|
+
*/
|
|
29
|
+
interface Schema<T extends {
|
|
30
|
+
blocks: Record<string, Block>;
|
|
31
|
+
blockFolders?: Record<string, ComponentFolder>;
|
|
32
|
+
datasources?: Record<string, Datasource>;
|
|
33
|
+
}> {
|
|
34
|
+
blocks: T['blocks'][keyof T['blocks']];
|
|
35
|
+
blockFolders: T['blockFolders'] extends Record<string, ComponentFolder> ? T['blockFolders'][keyof T['blockFolders']] : never;
|
|
36
|
+
datasources: T['datasources'] extends Record<string, Datasource> ? T['datasources'][keyof T['datasources']] : never;
|
|
37
|
+
}
|
|
38
|
+
//#endregion
|
|
39
|
+
export { Schema };
|
|
40
|
+
//# sourceMappingURL=schema-type.d.cts.map
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { Datasource } from "../generated/types.mjs";
|
|
2
|
+
import { ComponentFolder } from "../generated/mapi-types.mjs";
|
|
3
|
+
import { Block } from "./define-block.mjs";
|
|
4
|
+
|
|
5
|
+
//#region src/helpers/schema-type.d.ts
|
|
6
|
+
/**
|
|
7
|
+
* Derives a schema types interface from a schema object.
|
|
8
|
+
*
|
|
9
|
+
* Accepts the `typeof` a schema object whose `blocks` property is a
|
|
10
|
+
* record of `defineBlock()` results, and optionally `blockFolders`
|
|
11
|
+
* and `datasources` records, and produces a type with unions of those types.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* import type { Schema as InferSchema } from '@storyblok/schema';
|
|
16
|
+
*
|
|
17
|
+
* export const schema = {
|
|
18
|
+
* blocks: { pageBlock, heroBlock },
|
|
19
|
+
* blockFolders: { layoutFolder },
|
|
20
|
+
* datasources: { colorsDatasource },
|
|
21
|
+
* };
|
|
22
|
+
*
|
|
23
|
+
* export type Schema = InferSchema<typeof schema>;
|
|
24
|
+
* export type Blocks = Schema['blocks'];
|
|
25
|
+
* export type BlockFolders = Schema['blockFolders'];
|
|
26
|
+
* export type Datasources = Schema['datasources'];
|
|
27
|
+
* ```
|
|
28
|
+
*/
|
|
29
|
+
interface Schema<T extends {
|
|
30
|
+
blocks: Record<string, Block>;
|
|
31
|
+
blockFolders?: Record<string, ComponentFolder>;
|
|
32
|
+
datasources?: Record<string, Datasource>;
|
|
33
|
+
}> {
|
|
34
|
+
blocks: T['blocks'][keyof T['blocks']];
|
|
35
|
+
blockFolders: T['blockFolders'] extends Record<string, ComponentFolder> ? T['blockFolders'][keyof T['blockFolders']] : never;
|
|
36
|
+
datasources: T['datasources'] extends Record<string, Datasource> ? T['datasources'][keyof T['datasources']] : never;
|
|
37
|
+
}
|
|
38
|
+
//#endregion
|
|
39
|
+
export { Schema };
|
|
40
|
+
//# sourceMappingURL=schema-type.d.mts.map
|
package/dist/index.cjs
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
|
|
2
|
+
const require_define_story = require('./helpers/define-story.cjs');
|
|
3
|
+
const require_create_story_helpers = require('./helpers/create-story-helpers.cjs');
|
|
4
|
+
const require_define_asset = require('./helpers/define-asset.cjs');
|
|
5
|
+
const require_define_asset_folder = require('./helpers/define-asset-folder.cjs');
|
|
6
|
+
const require_define_block = require('./helpers/define-block.cjs');
|
|
7
|
+
const require_define_block_folder = require('./helpers/define-block-folder.cjs');
|
|
8
|
+
const require_define_datasource = require('./helpers/define-datasource.cjs');
|
|
9
|
+
const require_define_datasource_entry = require('./helpers/define-datasource-entry.cjs');
|
|
10
|
+
const require_define_field = require('./helpers/define-field.cjs');
|
|
11
|
+
const require_define_internal_tag = require('./helpers/define-internal-tag.cjs');
|
|
12
|
+
const require_define_link = require('./helpers/define-link.cjs');
|
|
13
|
+
const require_define_preset = require('./helpers/define-preset.cjs');
|
|
14
|
+
const require_define_space = require('./helpers/define-space.cjs');
|
|
15
|
+
const require_define_tag = require('./helpers/define-tag.cjs');
|
|
16
|
+
const require_define_user = require('./helpers/define-user.cjs');
|
|
17
|
+
|
|
18
|
+
exports.createStoryHelpers = require_create_story_helpers.createStoryHelpers;
|
|
19
|
+
exports.defineAssetCreate = require_define_asset.defineAssetCreate;
|
|
20
|
+
exports.defineAssetFolder = require_define_asset_folder.defineAssetFolder;
|
|
21
|
+
exports.defineAssetFolderCreate = require_define_asset_folder.defineAssetFolderCreate;
|
|
22
|
+
exports.defineAssetFolderUpdate = require_define_asset_folder.defineAssetFolderUpdate;
|
|
23
|
+
exports.defineAssetUpdate = require_define_asset.defineAssetUpdate;
|
|
24
|
+
exports.defineBlock = require_define_block.defineBlock;
|
|
25
|
+
exports.defineBlockCreate = require_define_block.defineBlockCreate;
|
|
26
|
+
exports.defineBlockFolder = require_define_block_folder.defineBlockFolder;
|
|
27
|
+
exports.defineBlockFolderCreate = require_define_block_folder.defineBlockFolderCreate;
|
|
28
|
+
exports.defineBlockFolderUpdate = require_define_block_folder.defineBlockFolderUpdate;
|
|
29
|
+
exports.defineBlockUpdate = require_define_block.defineBlockUpdate;
|
|
30
|
+
exports.defineDatasource = require_define_datasource.defineDatasource;
|
|
31
|
+
exports.defineDatasourceCreate = require_define_datasource.defineDatasourceCreate;
|
|
32
|
+
exports.defineDatasourceEntry = require_define_datasource_entry.defineDatasourceEntry;
|
|
33
|
+
exports.defineDatasourceEntryCreate = require_define_datasource_entry.defineDatasourceEntryCreate;
|
|
34
|
+
exports.defineDatasourceEntryUpdate = require_define_datasource_entry.defineDatasourceEntryUpdate;
|
|
35
|
+
exports.defineDatasourceUpdate = require_define_datasource.defineDatasourceUpdate;
|
|
36
|
+
exports.defineField = require_define_field.defineField;
|
|
37
|
+
exports.defineInternalTag = require_define_internal_tag.defineInternalTag;
|
|
38
|
+
exports.defineInternalTagCreate = require_define_internal_tag.defineInternalTagCreate;
|
|
39
|
+
exports.defineInternalTagUpdate = require_define_internal_tag.defineInternalTagUpdate;
|
|
40
|
+
exports.defineLink = require_define_link.defineLink;
|
|
41
|
+
exports.defineMapiAsset = require_define_asset.defineMapiAsset;
|
|
42
|
+
exports.defineMapiDatasourceEntry = require_define_datasource_entry.defineMapiDatasourceEntry;
|
|
43
|
+
exports.defineMapiStory = require_define_story.defineMapiStory;
|
|
44
|
+
exports.definePreset = require_define_preset.definePreset;
|
|
45
|
+
exports.definePresetCreate = require_define_preset.definePresetCreate;
|
|
46
|
+
exports.definePresetUpdate = require_define_preset.definePresetUpdate;
|
|
47
|
+
exports.defineSpace = require_define_space.defineSpace;
|
|
48
|
+
exports.defineSpaceCreate = require_define_space.defineSpaceCreate;
|
|
49
|
+
exports.defineSpaceUpdate = require_define_space.defineSpaceUpdate;
|
|
50
|
+
exports.defineStory = require_define_story.defineStory;
|
|
51
|
+
exports.defineStoryCreate = require_define_story.defineStoryCreate;
|
|
52
|
+
exports.defineStoryUpdate = require_define_story.defineStoryUpdate;
|
|
53
|
+
exports.defineTag = require_define_tag.defineTag;
|
|
54
|
+
exports.defineUser = require_define_user.defineUser;
|
|
55
|
+
exports.defineUserUpdate = require_define_user.defineUserUpdate;
|
package/dist/index.d.cts
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { AssetFieldValue, Datasource, Link, MultilinkFieldValue, PluginFieldValue, RichtextFieldValue, StoryAlternate, StoryLocalizedPath, StoryTranslatedSlug, TableFieldValue, Tag } from "./generated/types.cjs";
|
|
2
|
+
import { AssetCreate, AssetFolder, AssetFolderCreate, AssetFolderUpdate, AssetUpdate, ComponentCreate, ComponentFolder, ComponentFolderCreate, ComponentFolderUpdate, ComponentSchemaField, ComponentUpdate, DatasourceCreate, DatasourceEntryCreate, DatasourceEntryUpdate, DatasourceUpdate, InternalTag, InternalTagCreate, InternalTagUpdate, Preset, PresetCreate, PresetUpdate, Space, SpaceCreate, SpaceUpdate, User, UserUpdate } from "./generated/mapi-types.cjs";
|
|
3
|
+
import { Block, BlockSchema, NestableBlocks, RootBlocks, defineBlock, defineBlockCreate, defineBlockUpdate } from "./helpers/define-block.cjs";
|
|
4
|
+
import { BlockContent, BlockContentInput, BlocksFieldValue, FieldType, FieldValue, FieldValueInput, defineField } from "./helpers/define-field.cjs";
|
|
5
|
+
import { MapiStory, Story, StoryComponent, StoryCreate, StoryUpdate, defineMapiStory, defineStory, defineStoryCreate, defineStoryUpdate } from "./helpers/define-story.cjs";
|
|
6
|
+
import { createStoryHelpers } from "./helpers/create-story-helpers.cjs";
|
|
7
|
+
import { MapiAsset, defineAssetCreate, defineAssetUpdate, defineMapiAsset } from "./helpers/define-asset.cjs";
|
|
8
|
+
import { defineAssetFolder, defineAssetFolderCreate, defineAssetFolderUpdate } from "./helpers/define-asset-folder.cjs";
|
|
9
|
+
import { defineBlockFolder, defineBlockFolderCreate, defineBlockFolderUpdate } from "./helpers/define-block-folder.cjs";
|
|
10
|
+
import { defineDatasource, defineDatasourceCreate, defineDatasourceUpdate } from "./helpers/define-datasource.cjs";
|
|
11
|
+
import { DatasourceEntry, MapiDatasourceEntry, defineDatasourceEntry, defineDatasourceEntryCreate, defineDatasourceEntryUpdate, defineMapiDatasourceEntry } from "./helpers/define-datasource-entry.cjs";
|
|
12
|
+
import { defineInternalTag, defineInternalTagCreate, defineInternalTagUpdate } from "./helpers/define-internal-tag.cjs";
|
|
13
|
+
import { defineLink } from "./helpers/define-link.cjs";
|
|
14
|
+
import { definePreset, definePresetCreate, definePresetUpdate } from "./helpers/define-preset.cjs";
|
|
15
|
+
import { defineSpace, defineSpaceCreate, defineSpaceUpdate } from "./helpers/define-space.cjs";
|
|
16
|
+
import { defineTag } from "./helpers/define-tag.cjs";
|
|
17
|
+
import { defineUser, defineUserUpdate } from "./helpers/define-user.cjs";
|
|
18
|
+
import { Schema } from "./helpers/schema-type.cjs";
|
|
19
|
+
export { type AssetCreate, type AssetFieldValue, type AssetFolder, type AssetFolderCreate, type AssetFolderUpdate, type AssetUpdate, type Block, type BlockContent, type BlockContentInput, type BlockSchema, type BlocksFieldValue, type ComponentCreate, type ComponentFolder, type ComponentFolderCreate, type ComponentFolderUpdate, type ComponentUpdate, type Datasource, type DatasourceCreate, type DatasourceEntry, type DatasourceEntryCreate, type DatasourceEntryUpdate, type DatasourceUpdate, type ComponentSchemaField as Field, type FieldType, type FieldValue, type FieldValueInput, type InternalTag, type InternalTagCreate, type InternalTagUpdate, type Link, type MapiAsset, type MapiDatasourceEntry, type MapiStory, type MultilinkFieldValue, type NestableBlocks, type PluginFieldValue, type Preset, type PresetCreate, type PresetUpdate, type RichtextFieldValue, type RootBlocks, type Schema, type Space, type SpaceCreate, type SpaceUpdate, type Story, type StoryAlternate, type StoryComponent, type StoryCreate, type StoryLocalizedPath, type StoryTranslatedSlug, type StoryUpdate, type TableFieldValue, type Tag, type User, type UserUpdate, createStoryHelpers, defineAssetCreate, defineAssetFolder, defineAssetFolderCreate, defineAssetFolderUpdate, defineAssetUpdate, defineBlock, defineBlockCreate, defineBlockFolder, defineBlockFolderCreate, defineBlockFolderUpdate, defineBlockUpdate, defineDatasource, defineDatasourceCreate, defineDatasourceEntry, defineDatasourceEntryCreate, defineDatasourceEntryUpdate, defineDatasourceUpdate, defineField, defineInternalTag, defineInternalTagCreate, defineInternalTagUpdate, defineLink, defineMapiAsset, defineMapiDatasourceEntry, defineMapiStory, definePreset, definePresetCreate, definePresetUpdate, defineSpace, defineSpaceCreate, defineSpaceUpdate, defineStory, defineStoryCreate, defineStoryUpdate, defineTag, defineUser, defineUserUpdate };
|
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { AssetFieldValue, Datasource, Link, MultilinkFieldValue, PluginFieldValue, RichtextFieldValue, StoryAlternate, StoryLocalizedPath, StoryTranslatedSlug, TableFieldValue, Tag } from "./generated/types.mjs";
|
|
2
|
+
import { AssetCreate, AssetFolder, AssetFolderCreate, AssetFolderUpdate, AssetUpdate, ComponentCreate, ComponentFolder, ComponentFolderCreate, ComponentFolderUpdate, ComponentSchemaField, ComponentUpdate, DatasourceCreate, DatasourceEntryCreate, DatasourceEntryUpdate, DatasourceUpdate, InternalTag, InternalTagCreate, InternalTagUpdate, Preset, PresetCreate, PresetUpdate, Space, SpaceCreate, SpaceUpdate, User, UserUpdate } from "./generated/mapi-types.mjs";
|
|
3
|
+
import { Block, BlockSchema, NestableBlocks, RootBlocks, defineBlock, defineBlockCreate, defineBlockUpdate } from "./helpers/define-block.mjs";
|
|
4
|
+
import { BlockContent, BlockContentInput, BlocksFieldValue, FieldType, FieldValue, FieldValueInput, defineField } from "./helpers/define-field.mjs";
|
|
5
|
+
import { MapiStory, Story, StoryComponent, StoryCreate, StoryUpdate, defineMapiStory, defineStory, defineStoryCreate, defineStoryUpdate } from "./helpers/define-story.mjs";
|
|
6
|
+
import { createStoryHelpers } from "./helpers/create-story-helpers.mjs";
|
|
7
|
+
import { MapiAsset, defineAssetCreate, defineAssetUpdate, defineMapiAsset } from "./helpers/define-asset.mjs";
|
|
8
|
+
import { defineAssetFolder, defineAssetFolderCreate, defineAssetFolderUpdate } from "./helpers/define-asset-folder.mjs";
|
|
9
|
+
import { defineBlockFolder, defineBlockFolderCreate, defineBlockFolderUpdate } from "./helpers/define-block-folder.mjs";
|
|
10
|
+
import { defineDatasource, defineDatasourceCreate, defineDatasourceUpdate } from "./helpers/define-datasource.mjs";
|
|
11
|
+
import { DatasourceEntry, MapiDatasourceEntry, defineDatasourceEntry, defineDatasourceEntryCreate, defineDatasourceEntryUpdate, defineMapiDatasourceEntry } from "./helpers/define-datasource-entry.mjs";
|
|
12
|
+
import { defineInternalTag, defineInternalTagCreate, defineInternalTagUpdate } from "./helpers/define-internal-tag.mjs";
|
|
13
|
+
import { defineLink } from "./helpers/define-link.mjs";
|
|
14
|
+
import { definePreset, definePresetCreate, definePresetUpdate } from "./helpers/define-preset.mjs";
|
|
15
|
+
import { defineSpace, defineSpaceCreate, defineSpaceUpdate } from "./helpers/define-space.mjs";
|
|
16
|
+
import { defineTag } from "./helpers/define-tag.mjs";
|
|
17
|
+
import { defineUser, defineUserUpdate } from "./helpers/define-user.mjs";
|
|
18
|
+
import { Schema } from "./helpers/schema-type.mjs";
|
|
19
|
+
export { type AssetCreate, type AssetFieldValue, type AssetFolder, type AssetFolderCreate, type AssetFolderUpdate, type AssetUpdate, type Block, type BlockContent, type BlockContentInput, type BlockSchema, type BlocksFieldValue, type ComponentCreate, type ComponentFolder, type ComponentFolderCreate, type ComponentFolderUpdate, type ComponentUpdate, type Datasource, type DatasourceCreate, type DatasourceEntry, type DatasourceEntryCreate, type DatasourceEntryUpdate, type DatasourceUpdate, type ComponentSchemaField as Field, type FieldType, type FieldValue, type FieldValueInput, type InternalTag, type InternalTagCreate, type InternalTagUpdate, type Link, type MapiAsset, type MapiDatasourceEntry, type MapiStory, type MultilinkFieldValue, type NestableBlocks, type PluginFieldValue, type Preset, type PresetCreate, type PresetUpdate, type RichtextFieldValue, type RootBlocks, type Schema, type Space, type SpaceCreate, type SpaceUpdate, type Story, type StoryAlternate, type StoryComponent, type StoryCreate, type StoryLocalizedPath, type StoryTranslatedSlug, type StoryUpdate, type TableFieldValue, type Tag, type User, type UserUpdate, createStoryHelpers, defineAssetCreate, defineAssetFolder, defineAssetFolderCreate, defineAssetFolderUpdate, defineAssetUpdate, defineBlock, defineBlockCreate, defineBlockFolder, defineBlockFolderCreate, defineBlockFolderUpdate, defineBlockUpdate, defineDatasource, defineDatasourceCreate, defineDatasourceEntry, defineDatasourceEntryCreate, defineDatasourceEntryUpdate, defineDatasourceUpdate, defineField, defineInternalTag, defineInternalTagCreate, defineInternalTagUpdate, defineLink, defineMapiAsset, defineMapiDatasourceEntry, defineMapiStory, definePreset, definePresetCreate, definePresetUpdate, defineSpace, defineSpaceCreate, defineSpaceUpdate, defineStory, defineStoryCreate, defineStoryUpdate, defineTag, defineUser, defineUserUpdate };
|
package/dist/index.mjs
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { defineMapiStory, defineStory, defineStoryCreate, defineStoryUpdate } from "./helpers/define-story.mjs";
|
|
2
|
+
import { createStoryHelpers } from "./helpers/create-story-helpers.mjs";
|
|
3
|
+
import { defineAssetCreate, defineAssetUpdate, defineMapiAsset } from "./helpers/define-asset.mjs";
|
|
4
|
+
import { defineAssetFolder, defineAssetFolderCreate, defineAssetFolderUpdate } from "./helpers/define-asset-folder.mjs";
|
|
5
|
+
import { defineBlock, defineBlockCreate, defineBlockUpdate } from "./helpers/define-block.mjs";
|
|
6
|
+
import { defineBlockFolder, defineBlockFolderCreate, defineBlockFolderUpdate } from "./helpers/define-block-folder.mjs";
|
|
7
|
+
import { defineDatasource, defineDatasourceCreate, defineDatasourceUpdate } from "./helpers/define-datasource.mjs";
|
|
8
|
+
import { defineDatasourceEntry, defineDatasourceEntryCreate, defineDatasourceEntryUpdate, defineMapiDatasourceEntry } from "./helpers/define-datasource-entry.mjs";
|
|
9
|
+
import { defineField } from "./helpers/define-field.mjs";
|
|
10
|
+
import { defineInternalTag, defineInternalTagCreate, defineInternalTagUpdate } from "./helpers/define-internal-tag.mjs";
|
|
11
|
+
import { defineLink } from "./helpers/define-link.mjs";
|
|
12
|
+
import { definePreset, definePresetCreate, definePresetUpdate } from "./helpers/define-preset.mjs";
|
|
13
|
+
import { defineSpace, defineSpaceCreate, defineSpaceUpdate } from "./helpers/define-space.mjs";
|
|
14
|
+
import { defineTag } from "./helpers/define-tag.mjs";
|
|
15
|
+
import { defineUser, defineUserUpdate } from "./helpers/define-user.mjs";
|
|
16
|
+
|
|
17
|
+
export { createStoryHelpers, defineAssetCreate, defineAssetFolder, defineAssetFolderCreate, defineAssetFolderUpdate, defineAssetUpdate, defineBlock, defineBlockCreate, defineBlockFolder, defineBlockFolderCreate, defineBlockFolderUpdate, defineBlockUpdate, defineDatasource, defineDatasourceCreate, defineDatasourceEntry, defineDatasourceEntryCreate, defineDatasourceEntryUpdate, defineDatasourceUpdate, defineField, defineInternalTag, defineInternalTagCreate, defineInternalTagUpdate, defineLink, defineMapiAsset, defineMapiDatasourceEntry, defineMapiStory, definePreset, definePresetCreate, definePresetUpdate, defineSpace, defineSpaceCreate, defineSpaceUpdate, defineStory, defineStoryCreate, defineStoryUpdate, defineTag, defineUser, defineUserUpdate };
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
//#region src/utils/prettify.d.ts
|
|
2
|
+
/**
|
|
3
|
+
* Flattens an intersection type into a single object type for readable IDE display.
|
|
4
|
+
* @example Prettify<{ a: string } & { b: number }> → { a: string; b: number }
|
|
5
|
+
*/
|
|
6
|
+
type Prettify<T> = { [K in keyof T]: T[K] } & {};
|
|
7
|
+
//#endregion
|
|
8
|
+
export { Prettify };
|
|
9
|
+
//# sourceMappingURL=prettify.d.cts.map
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
//#region src/utils/prettify.d.ts
|
|
2
|
+
/**
|
|
3
|
+
* Flattens an intersection type into a single object type for readable IDE display.
|
|
4
|
+
* @example Prettify<{ a: string } & { b: number }> → { a: string; b: number }
|
|
5
|
+
*/
|
|
6
|
+
type Prettify<T> = { [K in keyof T]: T[K] } & {};
|
|
7
|
+
//#endregion
|
|
8
|
+
export { Prettify };
|
|
9
|
+
//# sourceMappingURL=prettify.d.mts.map
|
package/package.json
ADDED
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@storyblok/schema",
|
|
3
|
+
"type": "module",
|
|
4
|
+
"version": "1.0.0-alpha.0",
|
|
5
|
+
"description": "Storyblok schema types and helpers",
|
|
6
|
+
"license": "MIT",
|
|
7
|
+
"homepage": "https://github.com/storyblok/monoblok/tree/main/packages/schema#readme",
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "git+https://github.com/storyblok/monoblok.git",
|
|
11
|
+
"directory": "packages/schema"
|
|
12
|
+
},
|
|
13
|
+
"bugs": {
|
|
14
|
+
"url": "https://github.com/storyblok/monoblok/issues"
|
|
15
|
+
},
|
|
16
|
+
"publishConfig": {
|
|
17
|
+
"access": "public"
|
|
18
|
+
},
|
|
19
|
+
"exports": {
|
|
20
|
+
".": {
|
|
21
|
+
"import": "./dist/index.mjs",
|
|
22
|
+
"require": "./dist/index.cjs"
|
|
23
|
+
},
|
|
24
|
+
"./package.json": "./package.json"
|
|
25
|
+
},
|
|
26
|
+
"main": "./dist/index.cjs",
|
|
27
|
+
"module": "./dist/index.mjs",
|
|
28
|
+
"types": "./dist/index.d.cts",
|
|
29
|
+
"files": [
|
|
30
|
+
"dist"
|
|
31
|
+
],
|
|
32
|
+
"scripts": {
|
|
33
|
+
"generate": "tsx generate.ts",
|
|
34
|
+
"build": "tsdown",
|
|
35
|
+
"test": "vitest run",
|
|
36
|
+
"test:types": "tsc --noEmit --skipLibCheck",
|
|
37
|
+
"coverage": "vitest run --coverage",
|
|
38
|
+
"lint": "eslint .",
|
|
39
|
+
"lint:fix": "eslint . --fix"
|
|
40
|
+
},
|
|
41
|
+
"devDependencies": {
|
|
42
|
+
"@apidevtools/swagger-parser": "^10.1.1",
|
|
43
|
+
"@storyblok/eslint-config": "workspace:*",
|
|
44
|
+
"@storyblok/openapi": "workspace:*",
|
|
45
|
+
"@types/node": "^24.5.2",
|
|
46
|
+
"eslint": "^9.26.0",
|
|
47
|
+
"openapi-zod-client": "^1.18.3",
|
|
48
|
+
"tsdown": "^0.20.3",
|
|
49
|
+
"tsx": "^4.21.0",
|
|
50
|
+
"typescript": "5.8.3",
|
|
51
|
+
"vitest": "^4.1.3"
|
|
52
|
+
},
|
|
53
|
+
"nx": {
|
|
54
|
+
"targets": {
|
|
55
|
+
"generate": {
|
|
56
|
+
"dependsOn": [
|
|
57
|
+
{
|
|
58
|
+
"projects": [
|
|
59
|
+
"@storyblok/openapi"
|
|
60
|
+
],
|
|
61
|
+
"target": "build"
|
|
62
|
+
}
|
|
63
|
+
],
|
|
64
|
+
"inputs": [
|
|
65
|
+
"{projectRoot}/generate.ts",
|
|
66
|
+
"{projectRoot}/templates/**",
|
|
67
|
+
"{projectRoot}/package.json"
|
|
68
|
+
],
|
|
69
|
+
"outputs": [
|
|
70
|
+
"{projectRoot}/src/generated"
|
|
71
|
+
]
|
|
72
|
+
},
|
|
73
|
+
"build": {
|
|
74
|
+
"dependsOn": [
|
|
75
|
+
"generate"
|
|
76
|
+
]
|
|
77
|
+
},
|
|
78
|
+
"test": {
|
|
79
|
+
"dependsOn": [
|
|
80
|
+
"generate"
|
|
81
|
+
]
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
}
|