@storyblok/schema 0.1.0-alpha.0

package/dist/helpers/define-field.d.mts

@@ -0,0 +1,99 @@
+import { AssetFieldValue, Field, MultilinkFieldValue, PluginFieldValue, RichtextFieldValue, TableFieldValue } from "../generated/overlay/_internal.gen.mjs";
+import { Block } from "../generated/types/block.mjs";
+import { Prettify } from "../utils/prettify.mjs";
+
+//#region src/helpers/define-field.d.ts
+/** Loose variant of the generated `BlokContent` with `_uid` optional — used as the fallback for write operations when no block union is provided. */
+type BlokContentLoose = {
+  _uid?: string;
+  component: string;
+  _editable?: string | undefined;
+} & {
+  [key: string]: string | number | boolean | Array<string | AssetFieldValue | BlokContentLoose> | AssetFieldValue | MultilinkFieldValue | TableFieldValue | RichtextFieldValue | PluginFieldValue | undefined;
+};
+/** Keys in a schema record that have `required: true`. */
+type RequiredFieldKeys<T> = { [K in keyof T]: T[K] extends {
+  required: true;
+} ? K : never }[keyof T];
+/** Keys in a schema record that do NOT have `required: true`. */
+type OptionalFieldKeys<T> = Exclude<keyof T, RequiredFieldKeys<T>>;
+/**
+ * Builds the content object for a single block instance as returned by the
+ * Storyblok Content Delivery API. Includes `_uid` (always present in API
+ * responses) and respects required/optional field semantics.
+ *
+ * For write operations (creating/updating stories), use {@link BlockContentInput}
+ * instead, which omits `_uid` since Storyblok generates it automatically.
+ */
+type BlockContent<TBlock extends Block = Block, TBlocks = false> = TBlock extends any ? {
+  _uid: string;
+  component: TBlock['name'];
+} & { [K in RequiredFieldKeys<TBlock['schema']>]: FieldValue<NonNullable<TBlock['schema'][K]>, TBlocks> } & { [K in OptionalFieldKeys<TBlock['schema']>]?: FieldValue<NonNullable<TBlock['schema'][K]>, TBlocks> | null } : never;
+/**
+ * Input variant of {@link BlockContent} for write operations (creating/updating
+ * stories via the MAPI). `_uid` is optional — Storyblok generates it
+ * automatically when omitted. Nested bloks fields also use this input variant
+ * so that deeply nested blocks do not require `_uid` either.
+ */
+type BlockContentInput<TBlock extends Block = Block, TBlocks = false> = TBlock extends any ? {
+  _uid?: string;
+  component: TBlock['name'];
+} & { [K in RequiredFieldKeys<TBlock['schema']>]: FieldValueInput<NonNullable<TBlock['schema'][K]>, TBlocks> } & { [K in OptionalFieldKeys<TBlock['schema']>]?: FieldValueInput<NonNullable<TBlock['schema'][K]>, TBlocks> | null } : never;
+type BlocksFieldValue<TBlock extends Block = Block, TBlocks = false> = BlockContent<TBlock, TBlocks>[];
+/** Union of all valid Storyblok field type discriminants (e.g., `text`, `bloks`). */
+type FieldType = Field['type'];
+/** Maps each field type discriminant to its runtime content value type. */
+interface FieldTypeValueMap {
+  text: string;
+  textarea: string;
+  richtext: RichtextFieldValue;
+  markdown: string;
+  number: number;
+  datetime: string;
+  boolean: boolean;
+  option: string;
+  options: string[];
+  asset: AssetFieldValue;
+  multiasset: AssetFieldValue[];
+  multilink: MultilinkFieldValue;
+  bloks: BlockContent[];
+  table: TableFieldValue;
+  section: never;
+  tab: never;
+  custom: PluginFieldValue;
+}
+/**
+ * Checks whether a block is nestable, defaulting to `true` when
+ * `is_nestable` is absent or undefined.
+ */
+type IsNestable<T> = T extends {
+  is_nestable: false;
+} ? false : T extends {
+  is_nestable: true;
+} ? true : true;
+type ApplyWhitelist<TField, TBlocks> = TField extends {
+  component_whitelist: ReadonlyArray<infer TWhitelisted extends string>;
+} ? TBlocks extends {
+  name: TWhitelisted;
+} ? TBlocks : never : TBlocks extends any ? IsNestable<TBlocks> extends true ? TBlocks : never : never;
+/** Resolves a field definition to its runtime content value type (read). */
+type FieldValue<TField extends Field = Field, TBlocks = false> = Prettify<TField extends {
+  type: 'bloks';
+} ? [TBlocks] extends [never] ? BlockContent[] : [TBlocks] extends [Block] ? BlockContent<ApplyWhitelist<TField, TBlocks>, TBlocks>[] : BlockContent[] : FieldTypeValueMap[TField['type']]>;
+/** Resolves a field definition to its input value type (write). Nested bloks use {@link BlockContentInput}. */
+type FieldValueInput<TField extends Field = Field, TBlocks = false> = Prettify<TField extends {
+  type: 'bloks';
+} ? [TBlocks] extends [never] ? BlokContentLoose[] : [TBlocks] extends [Block] ? BlockContentInput<ApplyWhitelist<TField, TBlocks>, TBlocks>[] : BlokContentLoose[] : FieldTypeValueMap[TField['type']]>;
+/**
+ * Returns a {@link Field} stamped with the given `name`. Use inside a
+ * {@link defineBlock} `schema` array — `pos` is inferred from array index.
+ *
+ * @example
+ * defineField('headline', { type: 'text', max_length: 100, required: true });
+ */
+declare const defineField: <const TName extends string, const TField extends Field>(name: TName, field: TField) => Omit<TField, "name"> & {
+  name: TName;
+};
+//#endregion
+export { BlockContent, BlockContentInput, BlocksFieldValue, FieldType, FieldValue, FieldValueInput, defineField };
+//# sourceMappingURL=define-field.d.mts.map

package/dist/helpers/define-field.mjs

@@ -0,0 +1,16 @@
+//#region src/helpers/define-field.ts
+/**
+* Returns a {@link Field} stamped with the given `name`. Use inside a
+* {@link defineBlock} `schema` array — `pos` is inferred from array index.
+*
+* @example
+* defineField('headline', { type: 'text', max_length: 100, required: true });
+*/
+const defineField = (name, field) => ({
+	...field,
+	name
+});
+
+//#endregion
+export { defineField };
+//# sourceMappingURL=define-field.mjs.map

package/dist/helpers/define-field.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-field.mjs","names":[],"sources":["../../src/helpers/define-field.ts"],"sourcesContent":["import type {\n  AssetFieldValue,\n  Field,\n  MultilinkFieldValue,\n  PluginFieldValue,\n  RichtextFieldValue,\n  TableFieldValue,\n} from '../generated/types/field';\nimport type { Block } from './define-block';\nimport type { Prettify } from '../utils/prettify';\n\nexport type { Field };\n\n/** Loose variant of the generated `BlokContent` with `_uid` optional — used as the fallback for write operations when no block union is provided. */\ntype BlokContentLoose = {\n  _uid?: string;\n  component: string;\n  _editable?: string | undefined;\n} & {\n  [key: string]:\n    | string\n    | number\n    | boolean\n    | Array<string | AssetFieldValue | BlokContentLoose>\n    | AssetFieldValue\n    | MultilinkFieldValue\n    | TableFieldValue\n    | RichtextFieldValue\n    | PluginFieldValue\n    | undefined;\n};\n\n/** Keys in a schema record that have `required: true`. */\ntype RequiredFieldKeys<T> = {\n  [K in keyof T]: T[K] extends { required: true } ? K : never\n}[keyof T];\n\n/** Keys in a schema record that do NOT have `required: true`. */\ntype OptionalFieldKeys<T> = Exclude<keyof T, RequiredFieldKeys<T>>;\n\n/**\n * Builds the content object for a single block instance as returned by the\n * Storyblok Content Delivery API. Includes `_uid` (always present in API\n * responses) and respects required/optional field semantics.\n *\n * For write operations (creating/updating stories), use {@link BlockContentInput}\n * instead, which omits `_uid` since Storyblok generates it automatically.\n */\nexport type BlockContent<TBlock extends Block = Block, TBlocks = false> = TBlock extends any\n  ? { _uid: string; component: TBlock['name'] }\n  & {\n    [K in RequiredFieldKeys<TBlock['schema']>]: FieldValue<NonNullable<TBlock['schema'][K]>, TBlocks>\n  }\n  & {\n    [K in OptionalFieldKeys<TBlock['schema']>]?: FieldValue<NonNullable<TBlock['schema'][K]>, TBlocks> | null\n  }\n  : never;\n\n/**\n * Input variant of {@link BlockContent} for write operations (creating/updating\n * stories via the MAPI). `_uid` is optional — Storyblok generates it\n * automatically when omitted. Nested bloks fields also use this input variant\n * so that deeply nested blocks do not require `_uid` either.\n */\nexport type BlockContentInput<TBlock extends Block = Block, TBlocks = false> = TBlock extends any\n  ? { _uid?: string; component: TBlock['name'] }\n  & {\n    [K in RequiredFieldKeys<TBlock['schema']>]: FieldValueInput<NonNullable<TBlock['schema'][K]>, TBlocks>\n  }\n  & {\n    [K in OptionalFieldKeys<TBlock['schema']>]?: FieldValueInput<NonNullable<TBlock['schema'][K]>, TBlocks> | null\n  }\n  : never;\n\nexport type BlocksFieldValue<\n  TBlock extends Block = Block,\n  TBlocks = false,\n> = BlockContent<TBlock, TBlocks>[];\n\nexport type { AssetFieldValue, MultilinkFieldValue, PluginFieldValue, RichtextFieldValue, TableFieldValue };\n\n/** Union of all valid Storyblok field type discriminants (e.g., `text`, `bloks`). */\nexport type FieldType = Field['type'];\n\n/** Maps each field type discriminant to its runtime content value type. */\ninterface FieldTypeValueMap {\n  text: string;\n  textarea: string;\n  richtext: RichtextFieldValue;\n  markdown: string;\n  number: number;\n  datetime: string;\n  boolean: boolean;\n  option: string;\n  options: string[];\n  asset: AssetFieldValue;\n  multiasset: AssetFieldValue[];\n  multilink: MultilinkFieldValue;\n  bloks: BlockContent[];\n  table: TableFieldValue;\n  section: never;\n  tab: never;\n  custom: PluginFieldValue;\n}\n\n/**\n * Checks whether a block is nestable, defaulting to `true` when\n * `is_nestable` is absent or undefined.\n */\ntype IsNestable<T> =\n  T extends { is_nestable: false } ? false\n    : T extends { is_nestable: true } ? true\n      : true; // default: nestable when is_nestable is not specified\n\ntype ApplyWhitelist<TField, TBlocks> = TField extends { component_whitelist: ReadonlyArray<infer TWhitelisted extends string> }\n  // With whitelist: filter by block name (distributive over TBlocks)\n  ? TBlocks extends { name: TWhitelisted } ? TBlocks : never\n  // No whitelist: filter by nestability (distributive over TBlocks)\n  : TBlocks extends any\n    ? IsNestable<TBlocks> extends true ? TBlocks : never\n    : never;\n\n/** Resolves a field definition to its runtime content value type (read). */\nexport type FieldValue<\n  TField extends Field = Field,\n  TBlocks = false,\n> = Prettify<\n  TField extends { type: 'bloks' }\n    // Bloks field — guard against `never` first (it satisfies `[never] extends [X]`\n    // for all X, which would incorrectly enter the typed path with empty results).\n    ? [TBlocks] extends [never]\n        ? BlockContent[]\n        : [TBlocks] extends [Block]\n            ? BlockContent<ApplyWhitelist<TField, TBlocks>, TBlocks>[]\n            : BlockContent[]\n    // No bloks field\n    : FieldTypeValueMap[TField['type']]\n>;\n\n/** Resolves a field definition to its input value type (write). Nested bloks use {@link BlockContentInput}. */\nexport type FieldValueInput<\n  TField extends Field = Field,\n  TBlocks = false,\n> = Prettify<\n  TField extends { type: 'bloks' }\n    ? [TBlocks] extends [never]\n        ? BlokContentLoose[]\n        : [TBlocks] extends [Block]\n            ? BlockContentInput<ApplyWhitelist<TField, TBlocks>, TBlocks>[]\n            : BlokContentLoose[]\n    : FieldTypeValueMap[TField['type']]\n>;\n\n/**\n * Returns a {@link Field} stamped with the given `name`. Use inside a\n * {@link defineBlock} `schema` array — `pos` is inferred from array index.\n *\n * @example\n * defineField('headline', { type: 'text', max_length: 100, required: true });\n */\nexport const defineField = <\n  const TName extends string,\n  const TField extends Field,\n>(\n  name: TName,\n  field: TField,\n): Omit<TField, 'name'> & { name: TName } => ({ ...field, name });\n"],"mappings":";;;;;;;;AAgKA,MAAa,eAIX,MACA,WAC4C;CAAE,GAAG;CAAO;CAAM"}

package/dist/helpers/define-internal-tag.cjs

@@ -0,0 +1,41 @@
+
+//#region src/helpers/define-internal-tag.ts
+const INTERNAL_TAG_DEFAULTS = {
+	id: 1,
+	object_type: "asset"
+};
+/**
+* Defines an internal tag for the MAPI.
+* API-assigned fields (`id`) are optional and filled with safe defaults.
+*
+* @example
+* import { defineInternalTag } from '@storyblok/schema';
+* const tag = defineInternalTag({ name: 'hero' });
+*/
+const defineInternalTag = (internalTag) => ({
+	...INTERNAL_TAG_DEFAULTS,
+	...internalTag,
+	object_type: internalTag.object_type ?? INTERNAL_TAG_DEFAULTS.object_type
+});
+/**
+* Defines an internal tag creation payload for the MAPI.
+*
+* @example
+* import { defineInternalTagCreate } from '@storyblok/schema';
+* const payload = defineInternalTagCreate({ name: 'hero', object_type: 'asset' });
+*/
+const defineInternalTagCreate = (internalTag) => internalTag;
+/**
+* Defines an internal tag update payload for the MAPI.
+*
+* @example
+* import { defineInternalTagUpdate } from '@storyblok/schema';
+* const payload = defineInternalTagUpdate({ name: 'hero-image' });
+*/
+const defineInternalTagUpdate = (internalTag) => internalTag;
+
+//#endregion
+exports.defineInternalTag = defineInternalTag;
+exports.defineInternalTagCreate = defineInternalTagCreate;
+exports.defineInternalTagUpdate = defineInternalTagUpdate;
+//# sourceMappingURL=define-internal-tag.cjs.map

package/dist/helpers/define-internal-tag.cjs.map

@@ -0,0 +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.gen';\n\nexport type { InternalTag, InternalTagCreate, InternalTagUpdate };\n\nconst INTERNAL_TAG_DEFAULTS = {\n  id: 1,\n  object_type: 'asset' as const,\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  object_type: internalTag.object_type ?? INTERNAL_TAG_DEFAULTS.object_type,\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;CAC5B,IAAI;CACJ,aAAa;CACd;;;;;;;;;AAYD,MAAa,qBAAqB,iBAAgD;CAChF,GAAG;CACH,GAAG;CACH,aAAa,YAAY,eAAe,sBAAsB;CAC/D;;;;;;;;AASD,MAAa,2BAA2B,gBAAsD;;;;;;;;AAS9F,MAAa,2BAA2B,gBAAsD"}

package/dist/helpers/define-internal-tag.d.cts

@@ -0,0 +1,34 @@
+import { InternalTag, InternalTagCreate, InternalTagUpdate } from "../generated/mapi/types.gen.cjs";
+
+//#region src/helpers/define-internal-tag.d.ts
+type InternalTagInput = {
+  name: string;
+} & Partial<Omit<InternalTag, 'name'>>;
+/**
+ * Defines an internal tag for the MAPI.
+ * API-assigned fields (`id`) are optional and filled with safe defaults.
+ *
+ * @example
+ * import { defineInternalTag } from '@storyblok/schema';
+ * const tag = defineInternalTag({ name: 'hero' });
+ */
+declare const defineInternalTag: (internalTag: InternalTagInput) => InternalTag;
+/**
+ * Defines an internal tag creation payload for the MAPI.
+ *
+ * @example
+ * import { defineInternalTagCreate } from '@storyblok/schema';
+ * const payload = defineInternalTagCreate({ name: 'hero', object_type: 'asset' });
+ */
+declare const defineInternalTagCreate: (internalTag: InternalTagCreate) => InternalTagCreate;
+/**
+ * Defines an internal tag update payload for the MAPI.
+ *
+ * @example
+ * import { defineInternalTagUpdate } from '@storyblok/schema';
+ * const payload = defineInternalTagUpdate({ name: 'hero-image' });
+ */
+declare const defineInternalTagUpdate: (internalTag: InternalTagUpdate) => InternalTagUpdate;
+//#endregion
+export { defineInternalTag, defineInternalTagCreate, defineInternalTagUpdate };
+//# sourceMappingURL=define-internal-tag.d.cts.map

package/dist/helpers/define-internal-tag.d.mts

@@ -0,0 +1,34 @@
+import { InternalTag, InternalTagCreate, InternalTagUpdate } from "../generated/mapi/types.gen.mjs";
+
+//#region src/helpers/define-internal-tag.d.ts
+type InternalTagInput = {
+  name: string;
+} & Partial<Omit<InternalTag, 'name'>>;
+/**
+ * Defines an internal tag for the MAPI.
+ * API-assigned fields (`id`) are optional and filled with safe defaults.
+ *
+ * @example
+ * import { defineInternalTag } from '@storyblok/schema';
+ * const tag = defineInternalTag({ name: 'hero' });
+ */
+declare const defineInternalTag: (internalTag: InternalTagInput) => InternalTag;
+/**
+ * Defines an internal tag creation payload for the MAPI.
+ *
+ * @example
+ * import { defineInternalTagCreate } from '@storyblok/schema';
+ * const payload = defineInternalTagCreate({ name: 'hero', object_type: 'asset' });
+ */
+declare const defineInternalTagCreate: (internalTag: InternalTagCreate) => InternalTagCreate;
+/**
+ * Defines an internal tag update payload for the MAPI.
+ *
+ * @example
+ * import { defineInternalTagUpdate } from '@storyblok/schema';
+ * const payload = defineInternalTagUpdate({ name: 'hero-image' });
+ */
+declare const defineInternalTagUpdate: (internalTag: InternalTagUpdate) => InternalTagUpdate;
+//#endregion
+export { defineInternalTag, defineInternalTagCreate, defineInternalTagUpdate };
+//# sourceMappingURL=define-internal-tag.d.mts.map

package/dist/helpers/define-internal-tag.mjs

@@ -0,0 +1,38 @@
+//#region src/helpers/define-internal-tag.ts
+const INTERNAL_TAG_DEFAULTS = {
+	id: 1,
+	object_type: "asset"
+};
+/**
+* Defines an internal tag for the MAPI.
+* API-assigned fields (`id`) are optional and filled with safe defaults.
+*
+* @example
+* import { defineInternalTag } from '@storyblok/schema';
+* const tag = defineInternalTag({ name: 'hero' });
+*/
+const defineInternalTag = (internalTag) => ({
+	...INTERNAL_TAG_DEFAULTS,
+	...internalTag,
+	object_type: internalTag.object_type ?? INTERNAL_TAG_DEFAULTS.object_type
+});
+/**
+* Defines an internal tag creation payload for the MAPI.
+*
+* @example
+* import { defineInternalTagCreate } from '@storyblok/schema';
+* const payload = defineInternalTagCreate({ name: 'hero', object_type: 'asset' });
+*/
+const defineInternalTagCreate = (internalTag) => internalTag;
+/**
+* Defines an internal tag update payload for the MAPI.
+*
+* @example
+* import { defineInternalTagUpdate } from '@storyblok/schema';
+* const payload = defineInternalTagUpdate({ name: 'hero-image' });
+*/
+const defineInternalTagUpdate = (internalTag) => internalTag;
+
+//#endregion
+export { defineInternalTag, defineInternalTagCreate, defineInternalTagUpdate };
+//# sourceMappingURL=define-internal-tag.mjs.map

package/dist/helpers/define-internal-tag.mjs.map

@@ -0,0 +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.gen';\n\nexport type { InternalTag, InternalTagCreate, InternalTagUpdate };\n\nconst INTERNAL_TAG_DEFAULTS = {\n  id: 1,\n  object_type: 'asset' as const,\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  object_type: internalTag.object_type ?? INTERNAL_TAG_DEFAULTS.object_type,\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;CAC5B,IAAI;CACJ,aAAa;CACd;;;;;;;;;AAYD,MAAa,qBAAqB,iBAAgD;CAChF,GAAG;CACH,GAAG;CACH,aAAa,YAAY,eAAe,sBAAsB;CAC/D;;;;;;;;AASD,MAAa,2BAA2B,gBAAsD;;;;;;;;AAS9F,MAAa,2BAA2B,gBAAsD"}

package/dist/helpers/define-link.cjs

@@ -0,0 +1,23 @@
+
+//#region src/helpers/define-link.ts
+const LINK_DEFAULTS = {
+	id: 1,
+	uuid: "",
+	path: null,
+	real_path: "",
+	is_folder: false,
+	published: false,
+	parent_id: 0,
+	is_startpage: false,
+	position: 0
+};
+function defineLink(link) {
+	return {
+		...LINK_DEFAULTS,
+		...link
+	};
+}
+
+//#endregion
+exports.defineLink = defineLink;
+//# sourceMappingURL=define-link.cjs.map

package/dist/helpers/define-link.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-link.cjs","names":[],"sources":["../../src/helpers/define-link.ts"],"sourcesContent":["import type { Link } from '../generated/capi/types.gen';\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  parent_id: 0,\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,WAAW;CACX,cAAc;CACd,UAAU;CACX;AAyBD,SAAgB,WAAW,MAAW;AACpC,QAAO;EAAE,GAAG;EAAe,GAAG;EAAM"}

package/dist/helpers/define-link.d.cts

@@ -0,0 +1,32 @@
+import { Prettify } from "../utils/prettify.cjs";
+import { Link } from "../generated/capi/types.gen.cjs";
+
+//#region src/helpers/define-link.d.ts
+declare const LINK_DEFAULTS: {
+  id: number;
+  uuid: string;
+  path: null;
+  real_path: string;
+  is_folder: boolean;
+  published: boolean;
+  parent_id: number;
+  is_startpage: boolean;
+  position: number;
+};
+/** Fields that have safe defaults and may be omitted from link input. */
+type LinkOptional = keyof typeof LINK_DEFAULTS;
+type LinkInput = Prettify<Omit<Link, LinkOptional> & Partial<Pick<Link, LinkOptional>>>;
+/**
+ * Returns a full {@link Link} with all fields populated. API-assigned
+ * fields are optional and default to safe values.
+ *
+ * @example
+ * const link = defineLink({
+ *   name: 'Home',
+ *   slug: 'home',
+ * });
+ */
+declare function defineLink(link: LinkInput): Link;
+//#endregion
+export { defineLink };
+//# sourceMappingURL=define-link.d.cts.map

package/dist/helpers/define-link.d.mts

@@ -0,0 +1,32 @@
+import { Prettify } from "../utils/prettify.mjs";
+import { Link } from "../generated/capi/types.gen.mjs";
+
+//#region src/helpers/define-link.d.ts
+declare const LINK_DEFAULTS: {
+  id: number;
+  uuid: string;
+  path: null;
+  real_path: string;
+  is_folder: boolean;
+  published: boolean;
+  parent_id: number;
+  is_startpage: boolean;
+  position: number;
+};
+/** Fields that have safe defaults and may be omitted from link input. */
+type LinkOptional = keyof typeof LINK_DEFAULTS;
+type LinkInput = Prettify<Omit<Link, LinkOptional> & Partial<Pick<Link, LinkOptional>>>;
+/**
+ * Returns a full {@link Link} with all fields populated. API-assigned
+ * fields are optional and default to safe values.
+ *
+ * @example
+ * const link = defineLink({
+ *   name: 'Home',
+ *   slug: 'home',
+ * });
+ */
+declare function defineLink(link: LinkInput): Link;
+//#endregion
+export { defineLink };
+//# sourceMappingURL=define-link.d.mts.map

package/dist/helpers/define-link.mjs

@@ -0,0 +1,22 @@
+//#region src/helpers/define-link.ts
+const LINK_DEFAULTS = {
+	id: 1,
+	uuid: "",
+	path: null,
+	real_path: "",
+	is_folder: false,
+	published: false,
+	parent_id: 0,
+	is_startpage: false,
+	position: 0
+};
+function defineLink(link) {
+	return {
+		...LINK_DEFAULTS,
+		...link
+	};
+}
+
+//#endregion
+export { defineLink };
+//# sourceMappingURL=define-link.mjs.map

package/dist/helpers/define-link.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-link.mjs","names":[],"sources":["../../src/helpers/define-link.ts"],"sourcesContent":["import type { Link } from '../generated/capi/types.gen';\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  parent_id: 0,\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,WAAW;CACX,cAAc;CACd,UAAU;CACX;AAyBD,SAAgB,WAAW,MAAW;AACpC,QAAO;EAAE,GAAG;EAAe,GAAG;EAAM"}

package/dist/helpers/define-preset.cjs

@@ -0,0 +1,44 @@
+
+//#region src/helpers/define-preset.ts
+const PRESET_DEFAULTS = {
+	id: 1,
+	space_id: 1,
+	preset: null,
+	created_at: "",
+	updated_at: ""
+};
+/**
+* Defines a preset for the MAPI.
+* API-assigned fields (`id`) are optional and filled with safe defaults.
+*
+* @example
+* import { definePreset } from '@storyblok/schema';
+* const preset = definePreset({ name: 'Hero Dark', component_id: 42 });
+*/
+const definePreset = (preset) => ({
+	...PRESET_DEFAULTS,
+	...preset,
+	preset: preset.preset ?? PRESET_DEFAULTS.preset
+});
+/**
+* Defines a preset creation payload for the MAPI.
+*
+* @example
+* import { definePresetCreate } from '@storyblok/schema';
+* const payload = definePresetCreate({ name: 'Hero Dark', component_id: 42 });
+*/
+const definePresetCreate = (preset) => preset;
+/**
+* Defines a preset update payload for the MAPI.
+*
+* @example
+* import { definePresetUpdate } from '@storyblok/schema';
+* const payload = definePresetUpdate({ name: 'Hero Light' });
+*/
+const definePresetUpdate = (preset) => preset;
+
+//#endregion
+exports.definePreset = definePreset;
+exports.definePresetCreate = definePresetCreate;
+exports.definePresetUpdate = definePresetUpdate;
+//# sourceMappingURL=define-preset.cjs.map

package/dist/helpers/define-preset.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-preset.cjs","names":[],"sources":["../../src/helpers/define-preset.ts"],"sourcesContent":["import type { Preset, PresetCreate, PresetUpdate } from '../generated/mapi/types.gen';\n\nexport type { Preset, PresetCreate, PresetUpdate };\n\nconst PRESET_DEFAULTS = {\n  id: 1,\n  space_id: 1,\n  preset: null,\n  created_at: '',\n  updated_at: '',\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 => ({\n  ...PRESET_DEFAULTS,\n  ...preset,\n  preset: preset.preset ?? PRESET_DEFAULTS.preset,\n});\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;CACtB,IAAI;CACJ,UAAU;CACV,QAAQ;CACR,YAAY;CACZ,YAAY;CACb;;;;;;;;;AAYD,MAAa,gBAAgB,YAAiC;CAC5D,GAAG;CACH,GAAG;CACH,QAAQ,OAAO,UAAU,gBAAgB;CAC1C;;;;;;;;AASD,MAAa,sBAAsB,WAAuC;;;;;;;;AAS1E,MAAa,sBAAsB,WAAuC"}

package/dist/helpers/define-preset.d.cts

@@ -0,0 +1,35 @@
+import { Preset, PresetCreate, PresetUpdate } from "../generated/mapi/types.gen.cjs";
+
+//#region src/helpers/define-preset.d.ts
+type PresetInput = {
+  name: string;
+  component_id: number;
+} & Partial<Omit<Preset, 'name' | 'component_id'>>;
+/**
+ * Defines a preset for the MAPI.
+ * API-assigned fields (`id`) are optional and filled with safe defaults.
+ *
+ * @example
+ * import { definePreset } from '@storyblok/schema';
+ * const preset = definePreset({ name: 'Hero Dark', component_id: 42 });
+ */
+declare const definePreset: (preset: PresetInput) => Preset;
+/**
+ * Defines a preset creation payload for the MAPI.
+ *
+ * @example
+ * import { definePresetCreate } from '@storyblok/schema';
+ * const payload = definePresetCreate({ name: 'Hero Dark', component_id: 42 });
+ */
+declare const definePresetCreate: (preset: PresetCreate) => PresetCreate;
+/**
+ * Defines a preset update payload for the MAPI.
+ *
+ * @example
+ * import { definePresetUpdate } from '@storyblok/schema';
+ * const payload = definePresetUpdate({ name: 'Hero Light' });
+ */
+declare const definePresetUpdate: (preset: PresetUpdate) => PresetUpdate;
+//#endregion
+export { definePreset, definePresetCreate, definePresetUpdate };
+//# sourceMappingURL=define-preset.d.cts.map

package/dist/helpers/define-preset.d.mts

@@ -0,0 +1,35 @@
+import { Preset, PresetCreate, PresetUpdate } from "../generated/mapi/types.gen.mjs";
+
+//#region src/helpers/define-preset.d.ts
+type PresetInput = {
+  name: string;
+  component_id: number;
+} & Partial<Omit<Preset, 'name' | 'component_id'>>;
+/**
+ * Defines a preset for the MAPI.
+ * API-assigned fields (`id`) are optional and filled with safe defaults.
+ *
+ * @example
+ * import { definePreset } from '@storyblok/schema';
+ * const preset = definePreset({ name: 'Hero Dark', component_id: 42 });
+ */
+declare const definePreset: (preset: PresetInput) => Preset;
+/**
+ * Defines a preset creation payload for the MAPI.
+ *
+ * @example
+ * import { definePresetCreate } from '@storyblok/schema';
+ * const payload = definePresetCreate({ name: 'Hero Dark', component_id: 42 });
+ */
+declare const definePresetCreate: (preset: PresetCreate) => PresetCreate;
+/**
+ * Defines a preset update payload for the MAPI.
+ *
+ * @example
+ * import { definePresetUpdate } from '@storyblok/schema';
+ * const payload = definePresetUpdate({ name: 'Hero Light' });
+ */
+declare const definePresetUpdate: (preset: PresetUpdate) => PresetUpdate;
+//#endregion
+export { definePreset, definePresetCreate, definePresetUpdate };
+//# sourceMappingURL=define-preset.d.mts.map

package/dist/helpers/define-preset.mjs

@@ -0,0 +1,41 @@
+//#region src/helpers/define-preset.ts
+const PRESET_DEFAULTS = {
+	id: 1,
+	space_id: 1,
+	preset: null,
+	created_at: "",
+	updated_at: ""
+};
+/**
+* Defines a preset for the MAPI.
+* API-assigned fields (`id`) are optional and filled with safe defaults.
+*
+* @example
+* import { definePreset } from '@storyblok/schema';
+* const preset = definePreset({ name: 'Hero Dark', component_id: 42 });
+*/
+const definePreset = (preset) => ({
+	...PRESET_DEFAULTS,
+	...preset,
+	preset: preset.preset ?? PRESET_DEFAULTS.preset
+});
+/**
+* Defines a preset creation payload for the MAPI.
+*
+* @example
+* import { definePresetCreate } from '@storyblok/schema';
+* const payload = definePresetCreate({ name: 'Hero Dark', component_id: 42 });
+*/
+const definePresetCreate = (preset) => preset;
+/**
+* Defines a preset update payload for the MAPI.
+*
+* @example
+* import { definePresetUpdate } from '@storyblok/schema';
+* const payload = definePresetUpdate({ name: 'Hero Light' });
+*/
+const definePresetUpdate = (preset) => preset;
+
+//#endregion
+export { definePreset, definePresetCreate, definePresetUpdate };
+//# sourceMappingURL=define-preset.mjs.map

package/dist/helpers/define-preset.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-preset.mjs","names":[],"sources":["../../src/helpers/define-preset.ts"],"sourcesContent":["import type { Preset, PresetCreate, PresetUpdate } from '../generated/mapi/types.gen';\n\nexport type { Preset, PresetCreate, PresetUpdate };\n\nconst PRESET_DEFAULTS = {\n  id: 1,\n  space_id: 1,\n  preset: null,\n  created_at: '',\n  updated_at: '',\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 => ({\n  ...PRESET_DEFAULTS,\n  ...preset,\n  preset: preset.preset ?? PRESET_DEFAULTS.preset,\n});\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;CACtB,IAAI;CACJ,UAAU;CACV,QAAQ;CACR,YAAY;CACZ,YAAY;CACb;;;;;;;;;AAYD,MAAa,gBAAgB,YAAiC;CAC5D,GAAG;CACH,GAAG;CACH,QAAQ,OAAO,UAAU,gBAAgB;CAC1C;;;;;;;;AASD,MAAa,sBAAsB,WAAuC;;;;;;;;AAS1E,MAAa,sBAAsB,WAAuC"}

package/dist/helpers/define-space.cjs

@@ -0,0 +1,47 @@
+
+//#region src/helpers/define-space.ts
+const SPACE_DEFAULTS = {
+	id: 1,
+	region: "",
+	owner_id: 1,
+	updated_at: "",
+	created_at: "",
+	plan: "",
+	plan_level: 0,
+	trial: false,
+	requires_2fa: false,
+	org_requires_2fa: false,
+	development_mode: false,
+	feature_limit_exceeded_flags: {}
+};
+/**
+* Defines a space for the MAPI.
+* `name` is required; API-assigned fields (`id`) default to safe values.
+*
+* @example
+* const space = defineSpace({ name: 'My Space' });
+*/
+const defineSpace = (space) => ({
+	...SPACE_DEFAULTS,
+	...space
+});
+/**
+* Defines a space creation payload for the MAPI.
+*
+* @example
+* const payload = defineSpaceCreate({ name: 'My New Space' });
+*/
+const defineSpaceCreate = (space) => space;
+/**
+* Defines a space update payload for the MAPI.
+*
+* @example
+* const payload = defineSpaceUpdate({ name: 'Updated Space Name' });
+*/
+const defineSpaceUpdate = (space) => space;
+
+//#endregion
+exports.defineSpace = defineSpace;
+exports.defineSpaceCreate = defineSpaceCreate;
+exports.defineSpaceUpdate = defineSpaceUpdate;
+//# sourceMappingURL=define-space.cjs.map

package/dist/helpers/define-space.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-space.cjs","names":[],"sources":["../../src/helpers/define-space.ts"],"sourcesContent":["import type { Space, SpaceCreate, SpaceUpdate } from '../generated/mapi/types.gen';\n\nexport type { Space, SpaceCreate, SpaceUpdate };\n\nconst SPACE_DEFAULTS = {\n  id: 1,\n  region: '',\n  owner_id: 1,\n  updated_at: '',\n  created_at: '',\n  plan: '',\n  plan_level: 0,\n  trial: false,\n  requires_2fa: false,\n  org_requires_2fa: false,\n  development_mode: false,\n  feature_limit_exceeded_flags: {},\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;CACrB,IAAI;CACJ,QAAQ;CACR,UAAU;CACV,YAAY;CACZ,YAAY;CACZ,MAAM;CACN,YAAY;CACZ,OAAO;CACP,cAAc;CACd,kBAAkB;CAClB,kBAAkB;CAClB,8BAA8B,EAAE;CACjC;;;;;;;;AAWD,MAAa,eAAe,WAA8B;CAAE,GAAG;CAAgB,GAAG;CAAO;;;;;;;AAQzF,MAAa,qBAAqB,UAAoC;;;;;;;AAQtE,MAAa,qBAAqB,UAAoC"}