@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,37 @@
|
|
|
1
|
+
|
|
2
|
+
//#region src/helpers/define-internal-tag.ts
|
|
3
|
+
const INTERNAL_TAG_DEFAULTS = { id: 1 };
|
|
4
|
+
/**
|
|
5
|
+
* Defines an internal tag for the MAPI.
|
|
6
|
+
* API-assigned fields (`id`) are optional and filled with safe defaults.
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* import { defineInternalTag } from '@storyblok/schema';
|
|
10
|
+
* const tag = defineInternalTag({ name: 'hero' });
|
|
11
|
+
*/
|
|
12
|
+
const defineInternalTag = (internalTag) => ({
|
|
13
|
+
...INTERNAL_TAG_DEFAULTS,
|
|
14
|
+
...internalTag
|
|
15
|
+
});
|
|
16
|
+
/**
|
|
17
|
+
* Defines an internal tag creation payload for the MAPI.
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* import { defineInternalTagCreate } from '@storyblok/schema';
|
|
21
|
+
* const payload = defineInternalTagCreate({ name: 'hero', object_type: 'asset' });
|
|
22
|
+
*/
|
|
23
|
+
const defineInternalTagCreate = (internalTag) => internalTag;
|
|
24
|
+
/**
|
|
25
|
+
* Defines an internal tag update payload for the MAPI.
|
|
26
|
+
*
|
|
27
|
+
* @example
|
|
28
|
+
* import { defineInternalTagUpdate } from '@storyblok/schema';
|
|
29
|
+
* const payload = defineInternalTagUpdate({ name: 'hero-image' });
|
|
30
|
+
*/
|
|
31
|
+
const defineInternalTagUpdate = (internalTag) => internalTag;
|
|
32
|
+
|
|
33
|
+
//#endregion
|
|
34
|
+
exports.defineInternalTag = defineInternalTag;
|
|
35
|
+
exports.defineInternalTagCreate = defineInternalTagCreate;
|
|
36
|
+
exports.defineInternalTagUpdate = defineInternalTagUpdate;
|
|
37
|
+
//# sourceMappingURL=define-internal-tag.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"define-internal-tag.cjs","names":[],"sources":["../../src/helpers/define-internal-tag.ts"],"sourcesContent":["import type { InternalTag, InternalTagCreate, InternalTagUpdate } from '../generated/mapi-types';\n\nexport type { InternalTag, InternalTagCreate, InternalTagUpdate };\n\nconst INTERNAL_TAG_DEFAULTS = {\n id: 1,\n};\n\ntype InternalTagInput = { name: string } & Partial<Omit<InternalTag, 'name'>>;\n\n/**\n * Defines an internal tag for the MAPI.\n * API-assigned fields (`id`) are optional and filled with safe defaults.\n *\n * @example\n * import { defineInternalTag } from '@storyblok/schema';\n * const tag = defineInternalTag({ name: 'hero' });\n */\nexport const defineInternalTag = (internalTag: InternalTagInput): InternalTag => ({\n ...INTERNAL_TAG_DEFAULTS,\n ...internalTag,\n});\n\n/**\n * Defines an internal tag creation payload for the MAPI.\n *\n * @example\n * import { defineInternalTagCreate } from '@storyblok/schema';\n * const payload = defineInternalTagCreate({ name: 'hero', object_type: 'asset' });\n */\nexport const defineInternalTagCreate = (internalTag: InternalTagCreate): InternalTagCreate => internalTag;\n\n/**\n * Defines an internal tag update payload for the MAPI.\n *\n * @example\n * import { defineInternalTagUpdate } from '@storyblok/schema';\n * const payload = defineInternalTagUpdate({ name: 'hero-image' });\n */\nexport const defineInternalTagUpdate = (internalTag: InternalTagUpdate): InternalTagUpdate => internalTag;\n"],"mappings":";;AAIA,MAAM,wBAAwB,EAC5B,IAAI,GACL;;;;;;;;;AAYD,MAAa,qBAAqB,iBAAgD;CAChF,GAAG;CACH,GAAG;CACJ;;;;;;;;AASD,MAAa,2BAA2B,gBAAsD;;;;;;;;AAS9F,MAAa,2BAA2B,gBAAsD"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { InternalTag, InternalTagCreate, InternalTagUpdate } from "../generated/mapi-types.cjs";
|
|
2
|
+
|
|
3
|
+
//#region src/helpers/define-internal-tag.d.ts
|
|
4
|
+
type InternalTagInput = {
|
|
5
|
+
name: string;
|
|
6
|
+
} & Partial<Omit<InternalTag, 'name'>>;
|
|
7
|
+
/**
|
|
8
|
+
* Defines an internal tag for the MAPI.
|
|
9
|
+
* API-assigned fields (`id`) are optional and filled with safe defaults.
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* import { defineInternalTag } from '@storyblok/schema';
|
|
13
|
+
* const tag = defineInternalTag({ name: 'hero' });
|
|
14
|
+
*/
|
|
15
|
+
declare const defineInternalTag: (internalTag: InternalTagInput) => InternalTag;
|
|
16
|
+
/**
|
|
17
|
+
* Defines an internal tag creation payload for the MAPI.
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* import { defineInternalTagCreate } from '@storyblok/schema';
|
|
21
|
+
* const payload = defineInternalTagCreate({ name: 'hero', object_type: 'asset' });
|
|
22
|
+
*/
|
|
23
|
+
declare const defineInternalTagCreate: (internalTag: InternalTagCreate) => InternalTagCreate;
|
|
24
|
+
/**
|
|
25
|
+
* Defines an internal tag update payload for the MAPI.
|
|
26
|
+
*
|
|
27
|
+
* @example
|
|
28
|
+
* import { defineInternalTagUpdate } from '@storyblok/schema';
|
|
29
|
+
* const payload = defineInternalTagUpdate({ name: 'hero-image' });
|
|
30
|
+
*/
|
|
31
|
+
declare const defineInternalTagUpdate: (internalTag: InternalTagUpdate) => InternalTagUpdate;
|
|
32
|
+
//#endregion
|
|
33
|
+
export { defineInternalTag, defineInternalTagCreate, defineInternalTagUpdate };
|
|
34
|
+
//# sourceMappingURL=define-internal-tag.d.cts.map
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { InternalTag, InternalTagCreate, InternalTagUpdate } from "../generated/mapi-types.mjs";
|
|
2
|
+
|
|
3
|
+
//#region src/helpers/define-internal-tag.d.ts
|
|
4
|
+
type InternalTagInput = {
|
|
5
|
+
name: string;
|
|
6
|
+
} & Partial<Omit<InternalTag, 'name'>>;
|
|
7
|
+
/**
|
|
8
|
+
* Defines an internal tag for the MAPI.
|
|
9
|
+
* API-assigned fields (`id`) are optional and filled with safe defaults.
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* import { defineInternalTag } from '@storyblok/schema';
|
|
13
|
+
* const tag = defineInternalTag({ name: 'hero' });
|
|
14
|
+
*/
|
|
15
|
+
declare const defineInternalTag: (internalTag: InternalTagInput) => InternalTag;
|
|
16
|
+
/**
|
|
17
|
+
* Defines an internal tag creation payload for the MAPI.
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* import { defineInternalTagCreate } from '@storyblok/schema';
|
|
21
|
+
* const payload = defineInternalTagCreate({ name: 'hero', object_type: 'asset' });
|
|
22
|
+
*/
|
|
23
|
+
declare const defineInternalTagCreate: (internalTag: InternalTagCreate) => InternalTagCreate;
|
|
24
|
+
/**
|
|
25
|
+
* Defines an internal tag update payload for the MAPI.
|
|
26
|
+
*
|
|
27
|
+
* @example
|
|
28
|
+
* import { defineInternalTagUpdate } from '@storyblok/schema';
|
|
29
|
+
* const payload = defineInternalTagUpdate({ name: 'hero-image' });
|
|
30
|
+
*/
|
|
31
|
+
declare const defineInternalTagUpdate: (internalTag: InternalTagUpdate) => InternalTagUpdate;
|
|
32
|
+
//#endregion
|
|
33
|
+
export { defineInternalTag, defineInternalTagCreate, defineInternalTagUpdate };
|
|
34
|
+
//# sourceMappingURL=define-internal-tag.d.mts.map
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
//#region src/helpers/define-internal-tag.ts
|
|
2
|
+
const INTERNAL_TAG_DEFAULTS = { id: 1 };
|
|
3
|
+
/**
|
|
4
|
+
* Defines an internal tag for the MAPI.
|
|
5
|
+
* API-assigned fields (`id`) are optional and filled with safe defaults.
|
|
6
|
+
*
|
|
7
|
+
* @example
|
|
8
|
+
* import { defineInternalTag } from '@storyblok/schema';
|
|
9
|
+
* const tag = defineInternalTag({ name: 'hero' });
|
|
10
|
+
*/
|
|
11
|
+
const defineInternalTag = (internalTag) => ({
|
|
12
|
+
...INTERNAL_TAG_DEFAULTS,
|
|
13
|
+
...internalTag
|
|
14
|
+
});
|
|
15
|
+
/**
|
|
16
|
+
* Defines an internal tag creation payload for the MAPI.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* import { defineInternalTagCreate } from '@storyblok/schema';
|
|
20
|
+
* const payload = defineInternalTagCreate({ name: 'hero', object_type: 'asset' });
|
|
21
|
+
*/
|
|
22
|
+
const defineInternalTagCreate = (internalTag) => internalTag;
|
|
23
|
+
/**
|
|
24
|
+
* Defines an internal tag update payload for the MAPI.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* import { defineInternalTagUpdate } from '@storyblok/schema';
|
|
28
|
+
* const payload = defineInternalTagUpdate({ name: 'hero-image' });
|
|
29
|
+
*/
|
|
30
|
+
const defineInternalTagUpdate = (internalTag) => internalTag;
|
|
31
|
+
|
|
32
|
+
//#endregion
|
|
33
|
+
export { defineInternalTag, defineInternalTagCreate, defineInternalTagUpdate };
|
|
34
|
+
//# sourceMappingURL=define-internal-tag.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"define-internal-tag.mjs","names":[],"sources":["../../src/helpers/define-internal-tag.ts"],"sourcesContent":["import type { InternalTag, InternalTagCreate, InternalTagUpdate } from '../generated/mapi-types';\n\nexport type { InternalTag, InternalTagCreate, InternalTagUpdate };\n\nconst INTERNAL_TAG_DEFAULTS = {\n id: 1,\n};\n\ntype InternalTagInput = { name: string } & Partial<Omit<InternalTag, 'name'>>;\n\n/**\n * Defines an internal tag for the MAPI.\n * API-assigned fields (`id`) are optional and filled with safe defaults.\n *\n * @example\n * import { defineInternalTag } from '@storyblok/schema';\n * const tag = defineInternalTag({ name: 'hero' });\n */\nexport const defineInternalTag = (internalTag: InternalTagInput): InternalTag => ({\n ...INTERNAL_TAG_DEFAULTS,\n ...internalTag,\n});\n\n/**\n * Defines an internal tag creation payload for the MAPI.\n *\n * @example\n * import { defineInternalTagCreate } from '@storyblok/schema';\n * const payload = defineInternalTagCreate({ name: 'hero', object_type: 'asset' });\n */\nexport const defineInternalTagCreate = (internalTag: InternalTagCreate): InternalTagCreate => internalTag;\n\n/**\n * Defines an internal tag update payload for the MAPI.\n *\n * @example\n * import { defineInternalTagUpdate } from '@storyblok/schema';\n * const payload = defineInternalTagUpdate({ name: 'hero-image' });\n */\nexport const defineInternalTagUpdate = (internalTag: InternalTagUpdate): InternalTagUpdate => internalTag;\n"],"mappings":";AAIA,MAAM,wBAAwB,EAC5B,IAAI,GACL;;;;;;;;;AAYD,MAAa,qBAAqB,iBAAgD;CAChF,GAAG;CACH,GAAG;CACJ;;;;;;;;AASD,MAAa,2BAA2B,gBAAsD;;;;;;;;AAS9F,MAAa,2BAA2B,gBAAsD"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
|
|
2
|
+
//#region src/helpers/define-link.ts
|
|
3
|
+
const LINK_DEFAULTS = {
|
|
4
|
+
id: 1,
|
|
5
|
+
uuid: "",
|
|
6
|
+
path: null,
|
|
7
|
+
real_path: "",
|
|
8
|
+
is_folder: false,
|
|
9
|
+
published: false,
|
|
10
|
+
is_startpage: false,
|
|
11
|
+
position: 0
|
|
12
|
+
};
|
|
13
|
+
function defineLink(link) {
|
|
14
|
+
return {
|
|
15
|
+
...LINK_DEFAULTS,
|
|
16
|
+
...link
|
|
17
|
+
};
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
//#endregion
|
|
21
|
+
exports.defineLink = defineLink;
|
|
22
|
+
//# sourceMappingURL=define-link.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"define-link.cjs","names":[],"sources":["../../src/helpers/define-link.ts"],"sourcesContent":["import type { Link } from '../generated/types';\nimport type { Prettify } from '../utils/prettify';\n\nconst LINK_DEFAULTS = {\n id: 1,\n uuid: '',\n path: null,\n real_path: '',\n is_folder: false,\n published: false,\n is_startpage: false,\n position: 0,\n};\n\nexport type { Link };\n\n/** Fields that have safe defaults and may be omitted from link input. */\ntype LinkOptional = keyof typeof LINK_DEFAULTS;\n\ntype LinkInput = Prettify<Omit<Link, LinkOptional> & Partial<Pick<Link, LinkOptional>>>;\n\n/**\n * Returns a full {@link Link} with all fields populated. API-assigned\n * fields are optional and default to safe values.\n *\n * @example\n * const link = defineLink({\n * name: 'Home',\n * slug: 'home',\n * });\n */\n// Overload: provides the strict public signature for callers.\nexport function defineLink(link: LinkInput): Link;\n\n// Implementation signature: uses a loose parameter type because\n// TypeScript requires the implementation signature to be assignable\n// to all overloads. Not visible to callers.\nexport function defineLink(link: any) {\n return { ...LINK_DEFAULTS, ...link };\n}\n"],"mappings":";;AAGA,MAAM,gBAAgB;CACpB,IAAI;CACJ,MAAM;CACN,MAAM;CACN,WAAW;CACX,WAAW;CACX,WAAW;CACX,cAAc;CACd,UAAU;CACX;AAyBD,SAAgB,WAAW,MAAW;AACpC,QAAO;EAAE,GAAG;EAAe,GAAG;EAAM"}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { Link } from "../generated/types.cjs";
|
|
2
|
+
import { Prettify } from "../utils/prettify.cjs";
|
|
3
|
+
|
|
4
|
+
//#region src/helpers/define-link.d.ts
|
|
5
|
+
declare const LINK_DEFAULTS: {
|
|
6
|
+
id: number;
|
|
7
|
+
uuid: string;
|
|
8
|
+
path: null;
|
|
9
|
+
real_path: string;
|
|
10
|
+
is_folder: boolean;
|
|
11
|
+
published: boolean;
|
|
12
|
+
is_startpage: boolean;
|
|
13
|
+
position: number;
|
|
14
|
+
};
|
|
15
|
+
/** Fields that have safe defaults and may be omitted from link input. */
|
|
16
|
+
type LinkOptional = keyof typeof LINK_DEFAULTS;
|
|
17
|
+
type LinkInput = Prettify<Omit<Link, LinkOptional> & Partial<Pick<Link, LinkOptional>>>;
|
|
18
|
+
/**
|
|
19
|
+
* Returns a full {@link Link} with all fields populated. API-assigned
|
|
20
|
+
* fields are optional and default to safe values.
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* const link = defineLink({
|
|
24
|
+
* name: 'Home',
|
|
25
|
+
* slug: 'home',
|
|
26
|
+
* });
|
|
27
|
+
*/
|
|
28
|
+
declare function defineLink(link: LinkInput): Link;
|
|
29
|
+
//#endregion
|
|
30
|
+
export { defineLink };
|
|
31
|
+
//# sourceMappingURL=define-link.d.cts.map
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { Link } from "../generated/types.mjs";
|
|
2
|
+
import { Prettify } from "../utils/prettify.mjs";
|
|
3
|
+
|
|
4
|
+
//#region src/helpers/define-link.d.ts
|
|
5
|
+
declare const LINK_DEFAULTS: {
|
|
6
|
+
id: number;
|
|
7
|
+
uuid: string;
|
|
8
|
+
path: null;
|
|
9
|
+
real_path: string;
|
|
10
|
+
is_folder: boolean;
|
|
11
|
+
published: boolean;
|
|
12
|
+
is_startpage: boolean;
|
|
13
|
+
position: number;
|
|
14
|
+
};
|
|
15
|
+
/** Fields that have safe defaults and may be omitted from link input. */
|
|
16
|
+
type LinkOptional = keyof typeof LINK_DEFAULTS;
|
|
17
|
+
type LinkInput = Prettify<Omit<Link, LinkOptional> & Partial<Pick<Link, LinkOptional>>>;
|
|
18
|
+
/**
|
|
19
|
+
* Returns a full {@link Link} with all fields populated. API-assigned
|
|
20
|
+
* fields are optional and default to safe values.
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* const link = defineLink({
|
|
24
|
+
* name: 'Home',
|
|
25
|
+
* slug: 'home',
|
|
26
|
+
* });
|
|
27
|
+
*/
|
|
28
|
+
declare function defineLink(link: LinkInput): Link;
|
|
29
|
+
//#endregion
|
|
30
|
+
export { defineLink };
|
|
31
|
+
//# sourceMappingURL=define-link.d.mts.map
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
//#region src/helpers/define-link.ts
|
|
2
|
+
const LINK_DEFAULTS = {
|
|
3
|
+
id: 1,
|
|
4
|
+
uuid: "",
|
|
5
|
+
path: null,
|
|
6
|
+
real_path: "",
|
|
7
|
+
is_folder: false,
|
|
8
|
+
published: false,
|
|
9
|
+
is_startpage: false,
|
|
10
|
+
position: 0
|
|
11
|
+
};
|
|
12
|
+
function defineLink(link) {
|
|
13
|
+
return {
|
|
14
|
+
...LINK_DEFAULTS,
|
|
15
|
+
...link
|
|
16
|
+
};
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
//#endregion
|
|
20
|
+
export { defineLink };
|
|
21
|
+
//# sourceMappingURL=define-link.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"define-link.mjs","names":[],"sources":["../../src/helpers/define-link.ts"],"sourcesContent":["import type { Link } from '../generated/types';\nimport type { Prettify } from '../utils/prettify';\n\nconst LINK_DEFAULTS = {\n id: 1,\n uuid: '',\n path: null,\n real_path: '',\n is_folder: false,\n published: false,\n is_startpage: false,\n position: 0,\n};\n\nexport type { Link };\n\n/** Fields that have safe defaults and may be omitted from link input. */\ntype LinkOptional = keyof typeof LINK_DEFAULTS;\n\ntype LinkInput = Prettify<Omit<Link, LinkOptional> & Partial<Pick<Link, LinkOptional>>>;\n\n/**\n * Returns a full {@link Link} with all fields populated. API-assigned\n * fields are optional and default to safe values.\n *\n * @example\n * const link = defineLink({\n * name: 'Home',\n * slug: 'home',\n * });\n */\n// Overload: provides the strict public signature for callers.\nexport function defineLink(link: LinkInput): Link;\n\n// Implementation signature: uses a loose parameter type because\n// TypeScript requires the implementation signature to be assignable\n// to all overloads. Not visible to callers.\nexport function defineLink(link: any) {\n return { ...LINK_DEFAULTS, ...link };\n}\n"],"mappings":";AAGA,MAAM,gBAAgB;CACpB,IAAI;CACJ,MAAM;CACN,MAAM;CACN,WAAW;CACX,WAAW;CACX,WAAW;CACX,cAAc;CACd,UAAU;CACX;AAyBD,SAAgB,WAAW,MAAW;AACpC,QAAO;EAAE,GAAG;EAAe,GAAG;EAAM"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
|
|
2
|
+
//#region src/helpers/define-preset.ts
|
|
3
|
+
const PRESET_DEFAULTS = { id: 1 };
|
|
4
|
+
/**
|
|
5
|
+
* Defines a preset for the MAPI.
|
|
6
|
+
* API-assigned fields (`id`) are optional and filled with safe defaults.
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* import { definePreset } from '@storyblok/schema';
|
|
10
|
+
* const preset = definePreset({ name: 'Hero Dark', component_id: 42 });
|
|
11
|
+
*/
|
|
12
|
+
const definePreset = (preset) => ({
|
|
13
|
+
...PRESET_DEFAULTS,
|
|
14
|
+
...preset
|
|
15
|
+
});
|
|
16
|
+
/**
|
|
17
|
+
* Defines a preset creation payload for the MAPI.
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* import { definePresetCreate } from '@storyblok/schema';
|
|
21
|
+
* const payload = definePresetCreate({ name: 'Hero Dark', component_id: 42 });
|
|
22
|
+
*/
|
|
23
|
+
const definePresetCreate = (preset) => preset;
|
|
24
|
+
/**
|
|
25
|
+
* Defines a preset update payload for the MAPI.
|
|
26
|
+
*
|
|
27
|
+
* @example
|
|
28
|
+
* import { definePresetUpdate } from '@storyblok/schema';
|
|
29
|
+
* const payload = definePresetUpdate({ name: 'Hero Light' });
|
|
30
|
+
*/
|
|
31
|
+
const definePresetUpdate = (preset) => preset;
|
|
32
|
+
|
|
33
|
+
//#endregion
|
|
34
|
+
exports.definePreset = definePreset;
|
|
35
|
+
exports.definePresetCreate = definePresetCreate;
|
|
36
|
+
exports.definePresetUpdate = definePresetUpdate;
|
|
37
|
+
//# sourceMappingURL=define-preset.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"define-preset.cjs","names":[],"sources":["../../src/helpers/define-preset.ts"],"sourcesContent":["import type { Preset, PresetCreate, PresetUpdate } from '../generated/mapi-types';\n\nexport type { Preset, PresetCreate, PresetUpdate };\n\nconst PRESET_DEFAULTS = {\n id: 1,\n};\n\ntype PresetInput = { name: string; component_id: number } & Partial<Omit<Preset, 'name' | 'component_id'>>;\n\n/**\n * Defines a preset for the MAPI.\n * API-assigned fields (`id`) are optional and filled with safe defaults.\n *\n * @example\n * import { definePreset } from '@storyblok/schema';\n * const preset = definePreset({ name: 'Hero Dark', component_id: 42 });\n */\nexport const definePreset = (preset: PresetInput): Preset => ({ ...PRESET_DEFAULTS, ...preset });\n\n/**\n * Defines a preset creation payload for the MAPI.\n *\n * @example\n * import { definePresetCreate } from '@storyblok/schema';\n * const payload = definePresetCreate({ name: 'Hero Dark', component_id: 42 });\n */\nexport const definePresetCreate = (preset: PresetCreate): PresetCreate => preset;\n\n/**\n * Defines a preset update payload for the MAPI.\n *\n * @example\n * import { definePresetUpdate } from '@storyblok/schema';\n * const payload = definePresetUpdate({ name: 'Hero Light' });\n */\nexport const definePresetUpdate = (preset: PresetUpdate): PresetUpdate => preset;\n"],"mappings":";;AAIA,MAAM,kBAAkB,EACtB,IAAI,GACL;;;;;;;;;AAYD,MAAa,gBAAgB,YAAiC;CAAE,GAAG;CAAiB,GAAG;CAAQ;;;;;;;;AAS/F,MAAa,sBAAsB,WAAuC;;;;;;;;AAS1E,MAAa,sBAAsB,WAAuC"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { Preset, PresetCreate, PresetUpdate } from "../generated/mapi-types.cjs";
|
|
2
|
+
|
|
3
|
+
//#region src/helpers/define-preset.d.ts
|
|
4
|
+
type PresetInput = {
|
|
5
|
+
name: string;
|
|
6
|
+
component_id: number;
|
|
7
|
+
} & Partial<Omit<Preset, 'name' | 'component_id'>>;
|
|
8
|
+
/**
|
|
9
|
+
* Defines a preset for the MAPI.
|
|
10
|
+
* API-assigned fields (`id`) are optional and filled with safe defaults.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* import { definePreset } from '@storyblok/schema';
|
|
14
|
+
* const preset = definePreset({ name: 'Hero Dark', component_id: 42 });
|
|
15
|
+
*/
|
|
16
|
+
declare const definePreset: (preset: PresetInput) => Preset;
|
|
17
|
+
/**
|
|
18
|
+
* Defines a preset creation payload for the MAPI.
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* import { definePresetCreate } from '@storyblok/schema';
|
|
22
|
+
* const payload = definePresetCreate({ name: 'Hero Dark', component_id: 42 });
|
|
23
|
+
*/
|
|
24
|
+
declare const definePresetCreate: (preset: PresetCreate) => PresetCreate;
|
|
25
|
+
/**
|
|
26
|
+
* Defines a preset update payload for the MAPI.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* import { definePresetUpdate } from '@storyblok/schema';
|
|
30
|
+
* const payload = definePresetUpdate({ name: 'Hero Light' });
|
|
31
|
+
*/
|
|
32
|
+
declare const definePresetUpdate: (preset: PresetUpdate) => PresetUpdate;
|
|
33
|
+
//#endregion
|
|
34
|
+
export { definePreset, definePresetCreate, definePresetUpdate };
|
|
35
|
+
//# sourceMappingURL=define-preset.d.cts.map
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { Preset, PresetCreate, PresetUpdate } from "../generated/mapi-types.mjs";
|
|
2
|
+
|
|
3
|
+
//#region src/helpers/define-preset.d.ts
|
|
4
|
+
type PresetInput = {
|
|
5
|
+
name: string;
|
|
6
|
+
component_id: number;
|
|
7
|
+
} & Partial<Omit<Preset, 'name' | 'component_id'>>;
|
|
8
|
+
/**
|
|
9
|
+
* Defines a preset for the MAPI.
|
|
10
|
+
* API-assigned fields (`id`) are optional and filled with safe defaults.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* import { definePreset } from '@storyblok/schema';
|
|
14
|
+
* const preset = definePreset({ name: 'Hero Dark', component_id: 42 });
|
|
15
|
+
*/
|
|
16
|
+
declare const definePreset: (preset: PresetInput) => Preset;
|
|
17
|
+
/**
|
|
18
|
+
* Defines a preset creation payload for the MAPI.
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* import { definePresetCreate } from '@storyblok/schema';
|
|
22
|
+
* const payload = definePresetCreate({ name: 'Hero Dark', component_id: 42 });
|
|
23
|
+
*/
|
|
24
|
+
declare const definePresetCreate: (preset: PresetCreate) => PresetCreate;
|
|
25
|
+
/**
|
|
26
|
+
* Defines a preset update payload for the MAPI.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* import { definePresetUpdate } from '@storyblok/schema';
|
|
30
|
+
* const payload = definePresetUpdate({ name: 'Hero Light' });
|
|
31
|
+
*/
|
|
32
|
+
declare const definePresetUpdate: (preset: PresetUpdate) => PresetUpdate;
|
|
33
|
+
//#endregion
|
|
34
|
+
export { definePreset, definePresetCreate, definePresetUpdate };
|
|
35
|
+
//# sourceMappingURL=define-preset.d.mts.map
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
//#region src/helpers/define-preset.ts
|
|
2
|
+
const PRESET_DEFAULTS = { id: 1 };
|
|
3
|
+
/**
|
|
4
|
+
* Defines a preset for the MAPI.
|
|
5
|
+
* API-assigned fields (`id`) are optional and filled with safe defaults.
|
|
6
|
+
*
|
|
7
|
+
* @example
|
|
8
|
+
* import { definePreset } from '@storyblok/schema';
|
|
9
|
+
* const preset = definePreset({ name: 'Hero Dark', component_id: 42 });
|
|
10
|
+
*/
|
|
11
|
+
const definePreset = (preset) => ({
|
|
12
|
+
...PRESET_DEFAULTS,
|
|
13
|
+
...preset
|
|
14
|
+
});
|
|
15
|
+
/**
|
|
16
|
+
* Defines a preset creation payload for the MAPI.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* import { definePresetCreate } from '@storyblok/schema';
|
|
20
|
+
* const payload = definePresetCreate({ name: 'Hero Dark', component_id: 42 });
|
|
21
|
+
*/
|
|
22
|
+
const definePresetCreate = (preset) => preset;
|
|
23
|
+
/**
|
|
24
|
+
* Defines a preset update payload for the MAPI.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* import { definePresetUpdate } from '@storyblok/schema';
|
|
28
|
+
* const payload = definePresetUpdate({ name: 'Hero Light' });
|
|
29
|
+
*/
|
|
30
|
+
const definePresetUpdate = (preset) => preset;
|
|
31
|
+
|
|
32
|
+
//#endregion
|
|
33
|
+
export { definePreset, definePresetCreate, definePresetUpdate };
|
|
34
|
+
//# sourceMappingURL=define-preset.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"define-preset.mjs","names":[],"sources":["../../src/helpers/define-preset.ts"],"sourcesContent":["import type { Preset, PresetCreate, PresetUpdate } from '../generated/mapi-types';\n\nexport type { Preset, PresetCreate, PresetUpdate };\n\nconst PRESET_DEFAULTS = {\n id: 1,\n};\n\ntype PresetInput = { name: string; component_id: number } & Partial<Omit<Preset, 'name' | 'component_id'>>;\n\n/**\n * Defines a preset for the MAPI.\n * API-assigned fields (`id`) are optional and filled with safe defaults.\n *\n * @example\n * import { definePreset } from '@storyblok/schema';\n * const preset = definePreset({ name: 'Hero Dark', component_id: 42 });\n */\nexport const definePreset = (preset: PresetInput): Preset => ({ ...PRESET_DEFAULTS, ...preset });\n\n/**\n * Defines a preset creation payload for the MAPI.\n *\n * @example\n * import { definePresetCreate } from '@storyblok/schema';\n * const payload = definePresetCreate({ name: 'Hero Dark', component_id: 42 });\n */\nexport const definePresetCreate = (preset: PresetCreate): PresetCreate => preset;\n\n/**\n * Defines a preset update payload for the MAPI.\n *\n * @example\n * import { definePresetUpdate } from '@storyblok/schema';\n * const payload = definePresetUpdate({ name: 'Hero Light' });\n */\nexport const definePresetUpdate = (preset: PresetUpdate): PresetUpdate => preset;\n"],"mappings":";AAIA,MAAM,kBAAkB,EACtB,IAAI,GACL;;;;;;;;;AAYD,MAAa,gBAAgB,YAAiC;CAAE,GAAG;CAAiB,GAAG;CAAQ;;;;;;;;AAS/F,MAAa,sBAAsB,WAAuC;;;;;;;;AAS1E,MAAa,sBAAsB,WAAuC"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
//#region src/helpers/define-space.ts
|
|
3
|
+
const SPACE_DEFAULTS = { id: 1 };
|
|
4
|
+
/**
|
|
5
|
+
* Defines a space for the MAPI.
|
|
6
|
+
* `name` is required; API-assigned fields (`id`) default to safe values.
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* const space = defineSpace({ name: 'My Space' });
|
|
10
|
+
*/
|
|
11
|
+
const defineSpace = (space) => ({
|
|
12
|
+
...SPACE_DEFAULTS,
|
|
13
|
+
...space
|
|
14
|
+
});
|
|
15
|
+
/**
|
|
16
|
+
* Defines a space creation payload for the MAPI.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* const payload = defineSpaceCreate({ name: 'My New Space' });
|
|
20
|
+
*/
|
|
21
|
+
const defineSpaceCreate = (space) => space;
|
|
22
|
+
/**
|
|
23
|
+
* Defines a space update payload for the MAPI.
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* const payload = defineSpaceUpdate({ name: 'Updated Space Name' });
|
|
27
|
+
*/
|
|
28
|
+
const defineSpaceUpdate = (space) => space;
|
|
29
|
+
|
|
30
|
+
//#endregion
|
|
31
|
+
exports.defineSpace = defineSpace;
|
|
32
|
+
exports.defineSpaceCreate = defineSpaceCreate;
|
|
33
|
+
exports.defineSpaceUpdate = defineSpaceUpdate;
|
|
34
|
+
//# sourceMappingURL=define-space.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"define-space.cjs","names":[],"sources":["../../src/helpers/define-space.ts"],"sourcesContent":["import type { Space, SpaceCreate, SpaceUpdate } from '../generated/mapi-types';\n\nexport type { Space, SpaceCreate, SpaceUpdate };\n\nconst SPACE_DEFAULTS = {\n id: 1,\n};\n\ntype SpaceInput = { name: string } & Partial<Omit<Space, 'name'>>;\n\n/**\n * Defines a space for the MAPI.\n * `name` is required; API-assigned fields (`id`) default to safe values.\n *\n * @example\n * const space = defineSpace({ name: 'My Space' });\n */\nexport const defineSpace = (space: SpaceInput): Space => ({ ...SPACE_DEFAULTS, ...space });\n\n/**\n * Defines a space creation payload for the MAPI.\n *\n * @example\n * const payload = defineSpaceCreate({ name: 'My New Space' });\n */\nexport const defineSpaceCreate = (space: SpaceCreate): SpaceCreate => space;\n\n/**\n * Defines a space update payload for the MAPI.\n *\n * @example\n * const payload = defineSpaceUpdate({ name: 'Updated Space Name' });\n */\nexport const defineSpaceUpdate = (space: SpaceUpdate): SpaceUpdate => space;\n"],"mappings":";;AAIA,MAAM,iBAAiB,EACrB,IAAI,GACL;;;;;;;;AAWD,MAAa,eAAe,WAA8B;CAAE,GAAG;CAAgB,GAAG;CAAO;;;;;;;AAQzF,MAAa,qBAAqB,UAAoC;;;;;;;AAQtE,MAAa,qBAAqB,UAAoC"}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { Space, SpaceCreate, SpaceUpdate } from "../generated/mapi-types.cjs";
|
|
2
|
+
|
|
3
|
+
//#region src/helpers/define-space.d.ts
|
|
4
|
+
type SpaceInput = {
|
|
5
|
+
name: string;
|
|
6
|
+
} & Partial<Omit<Space, 'name'>>;
|
|
7
|
+
/**
|
|
8
|
+
* Defines a space for the MAPI.
|
|
9
|
+
* `name` is required; API-assigned fields (`id`) default to safe values.
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* const space = defineSpace({ name: 'My Space' });
|
|
13
|
+
*/
|
|
14
|
+
declare const defineSpace: (space: SpaceInput) => Space;
|
|
15
|
+
/**
|
|
16
|
+
* Defines a space creation payload for the MAPI.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* const payload = defineSpaceCreate({ name: 'My New Space' });
|
|
20
|
+
*/
|
|
21
|
+
declare const defineSpaceCreate: (space: SpaceCreate) => SpaceCreate;
|
|
22
|
+
/**
|
|
23
|
+
* Defines a space update payload for the MAPI.
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* const payload = defineSpaceUpdate({ name: 'Updated Space Name' });
|
|
27
|
+
*/
|
|
28
|
+
declare const defineSpaceUpdate: (space: SpaceUpdate) => SpaceUpdate;
|
|
29
|
+
//#endregion
|
|
30
|
+
export { defineSpace, defineSpaceCreate, defineSpaceUpdate };
|
|
31
|
+
//# sourceMappingURL=define-space.d.cts.map
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { Space, SpaceCreate, SpaceUpdate } from "../generated/mapi-types.mjs";
|
|
2
|
+
|
|
3
|
+
//#region src/helpers/define-space.d.ts
|
|
4
|
+
type SpaceInput = {
|
|
5
|
+
name: string;
|
|
6
|
+
} & Partial<Omit<Space, 'name'>>;
|
|
7
|
+
/**
|
|
8
|
+
* Defines a space for the MAPI.
|
|
9
|
+
* `name` is required; API-assigned fields (`id`) default to safe values.
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* const space = defineSpace({ name: 'My Space' });
|
|
13
|
+
*/
|
|
14
|
+
declare const defineSpace: (space: SpaceInput) => Space;
|
|
15
|
+
/**
|
|
16
|
+
* Defines a space creation payload for the MAPI.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* const payload = defineSpaceCreate({ name: 'My New Space' });
|
|
20
|
+
*/
|
|
21
|
+
declare const defineSpaceCreate: (space: SpaceCreate) => SpaceCreate;
|
|
22
|
+
/**
|
|
23
|
+
* Defines a space update payload for the MAPI.
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* const payload = defineSpaceUpdate({ name: 'Updated Space Name' });
|
|
27
|
+
*/
|
|
28
|
+
declare const defineSpaceUpdate: (space: SpaceUpdate) => SpaceUpdate;
|
|
29
|
+
//#endregion
|
|
30
|
+
export { defineSpace, defineSpaceCreate, defineSpaceUpdate };
|
|
31
|
+
//# sourceMappingURL=define-space.d.mts.map
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
//#region src/helpers/define-space.ts
|
|
2
|
+
const SPACE_DEFAULTS = { id: 1 };
|
|
3
|
+
/**
|
|
4
|
+
* Defines a space for the MAPI.
|
|
5
|
+
* `name` is required; API-assigned fields (`id`) default to safe values.
|
|
6
|
+
*
|
|
7
|
+
* @example
|
|
8
|
+
* const space = defineSpace({ name: 'My Space' });
|
|
9
|
+
*/
|
|
10
|
+
const defineSpace = (space) => ({
|
|
11
|
+
...SPACE_DEFAULTS,
|
|
12
|
+
...space
|
|
13
|
+
});
|
|
14
|
+
/**
|
|
15
|
+
* Defines a space creation payload for the MAPI.
|
|
16
|
+
*
|
|
17
|
+
* @example
|
|
18
|
+
* const payload = defineSpaceCreate({ name: 'My New Space' });
|
|
19
|
+
*/
|
|
20
|
+
const defineSpaceCreate = (space) => space;
|
|
21
|
+
/**
|
|
22
|
+
* Defines a space update payload for the MAPI.
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* const payload = defineSpaceUpdate({ name: 'Updated Space Name' });
|
|
26
|
+
*/
|
|
27
|
+
const defineSpaceUpdate = (space) => space;
|
|
28
|
+
|
|
29
|
+
//#endregion
|
|
30
|
+
export { defineSpace, defineSpaceCreate, defineSpaceUpdate };
|
|
31
|
+
//# sourceMappingURL=define-space.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"define-space.mjs","names":[],"sources":["../../src/helpers/define-space.ts"],"sourcesContent":["import type { Space, SpaceCreate, SpaceUpdate } from '../generated/mapi-types';\n\nexport type { Space, SpaceCreate, SpaceUpdate };\n\nconst SPACE_DEFAULTS = {\n id: 1,\n};\n\ntype SpaceInput = { name: string } & Partial<Omit<Space, 'name'>>;\n\n/**\n * Defines a space for the MAPI.\n * `name` is required; API-assigned fields (`id`) default to safe values.\n *\n * @example\n * const space = defineSpace({ name: 'My Space' });\n */\nexport const defineSpace = (space: SpaceInput): Space => ({ ...SPACE_DEFAULTS, ...space });\n\n/**\n * Defines a space creation payload for the MAPI.\n *\n * @example\n * const payload = defineSpaceCreate({ name: 'My New Space' });\n */\nexport const defineSpaceCreate = (space: SpaceCreate): SpaceCreate => space;\n\n/**\n * Defines a space update payload for the MAPI.\n *\n * @example\n * const payload = defineSpaceUpdate({ name: 'Updated Space Name' });\n */\nexport const defineSpaceUpdate = (space: SpaceUpdate): SpaceUpdate => space;\n"],"mappings":";AAIA,MAAM,iBAAiB,EACrB,IAAI,GACL;;;;;;;;AAWD,MAAa,eAAe,WAA8B;CAAE,GAAG;CAAgB,GAAG;CAAO;;;;;;;AAQzF,MAAa,qBAAqB,UAAoC;;;;;;;AAQtE,MAAa,qBAAqB,UAAoC"}
|