@storyblok/schema 0.1.0-alpha.0

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

@@ -0,0 +1,31 @@
+import { Space, SpaceCreate, SpaceUpdate } from "../generated/mapi/types.gen.cjs";
+
+//#region src/helpers/define-space.d.ts
+type SpaceInput = {
+  name: string;
+} & Partial<Omit<Space, 'name'>>;
+/**
+ * Defines a space for the MAPI.
+ * `name` is required; API-assigned fields (`id`) default to safe values.
+ *
+ * @example
+ * const space = defineSpace({ name: 'My Space' });
+ */
+declare const defineSpace: (space: SpaceInput) => Space;
+/**
+ * Defines a space creation payload for the MAPI.
+ *
+ * @example
+ * const payload = defineSpaceCreate({ name: 'My New Space' });
+ */
+declare const defineSpaceCreate: (space: SpaceCreate) => SpaceCreate;
+/**
+ * Defines a space update payload for the MAPI.
+ *
+ * @example
+ * const payload = defineSpaceUpdate({ name: 'Updated Space Name' });
+ */
+declare const defineSpaceUpdate: (space: SpaceUpdate) => SpaceUpdate;
+//#endregion
+export { defineSpace, defineSpaceCreate, defineSpaceUpdate };
+//# sourceMappingURL=define-space.d.cts.map

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

@@ -0,0 +1,31 @@
+import { Space, SpaceCreate, SpaceUpdate } from "../generated/mapi/types.gen.mjs";
+
+//#region src/helpers/define-space.d.ts
+type SpaceInput = {
+  name: string;
+} & Partial<Omit<Space, 'name'>>;
+/**
+ * Defines a space for the MAPI.
+ * `name` is required; API-assigned fields (`id`) default to safe values.
+ *
+ * @example
+ * const space = defineSpace({ name: 'My Space' });
+ */
+declare const defineSpace: (space: SpaceInput) => Space;
+/**
+ * Defines a space creation payload for the MAPI.
+ *
+ * @example
+ * const payload = defineSpaceCreate({ name: 'My New Space' });
+ */
+declare const defineSpaceCreate: (space: SpaceCreate) => SpaceCreate;
+/**
+ * Defines a space update payload for the MAPI.
+ *
+ * @example
+ * const payload = defineSpaceUpdate({ name: 'Updated Space Name' });
+ */
+declare const defineSpaceUpdate: (space: SpaceUpdate) => SpaceUpdate;
+//#endregion
+export { defineSpace, defineSpaceCreate, defineSpaceUpdate };
+//# sourceMappingURL=define-space.d.mts.map

package/dist/helpers/define-space.mjs

@@ -0,0 +1,44 @@
+//#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
+export { defineSpace, defineSpaceCreate, defineSpaceUpdate };
+//# sourceMappingURL=define-space.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"define-space.mjs","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"}

package/dist/helpers/define-story.cjs

@@ -0,0 +1,122 @@
+
+//#region src/helpers/define-story.ts
+const CAPI_STORY_DEFAULTS = {
+	id: 1,
+	uuid: "",
+	created_at: "",
+	updated_at: "",
+	published_at: null,
+	first_published_at: null,
+	full_slug: "",
+	group_id: "",
+	alternates: [],
+	default_full_slug: null,
+	release_id: null,
+	lang: "default",
+	slug: "",
+	parent_id: 0,
+	path: null,
+	is_startpage: false,
+	sort_by_date: null,
+	tag_list: [],
+	meta_data: null,
+	translated_slugs: null,
+	position: 0
+};
+const MAPI_STORY_DEFAULTS = {
+	id: 1,
+	uuid: "",
+	created_at: "",
+	updated_at: "",
+	published_at: null,
+	first_published_at: null,
+	full_slug: "",
+	group_id: "",
+	alternates: [],
+	slug: "",
+	parent_id: null,
+	parent: null,
+	path: null,
+	is_folder: false,
+	is_startpage: false,
+	sort_by_date: null,
+	tag_list: [],
+	meta_data: null,
+	translated_slugs: [],
+	translated_stories: [],
+	localized_paths: [],
+	position: 0,
+	deleted_at: null,
+	published: null,
+	default_root: null,
+	disble_fe_editor: false,
+	disable_fe_editor: false,
+	unpublished_changes: null,
+	imported_at: null,
+	preview_token: {
+		token: "",
+		timestamp: ""
+	},
+	pinned: false,
+	breadcrumbs: [],
+	publish_at: null,
+	expire_at: null,
+	last_author: null,
+	last_author_id: null,
+	user_ids: [],
+	space_role_ids: [],
+	can_not_view: null,
+	is_scheduled: null,
+	scheduled_dates: null,
+	ideas: [],
+	favourite_for_user_ids: []
+};
+function defineStory(component, story) {
+	const { content, ...rest } = story;
+	return {
+		...CAPI_STORY_DEFAULTS,
+		...rest,
+		content: {
+			...content,
+			component: component.name
+		}
+	};
+}
+function defineMapiStory(component, story) {
+	const { content, ...rest } = story;
+	return {
+		...MAPI_STORY_DEFAULTS,
+		...rest,
+		content: {
+			...content,
+			component: component.name
+		}
+	};
+}
+function defineStoryCreate(component, story) {
+	const { content, ...rest } = story;
+	return {
+		...rest,
+		content: {
+			...content,
+			component: component.name
+		}
+	};
+}
+function defineStoryUpdate(component, story) {
+	const { content, ...rest } = story;
+	return {
+		...rest,
+		...content && { content: {
+			...content,
+			component: component.name
+		} }
+	};
+}
+
+//#endregion
+exports.defineMapiStory = defineMapiStory;
+exports.defineStory = defineStory;
+exports.defineStoryCreate = defineStoryCreate;
+exports.defineStoryUpdate = defineStoryUpdate;
+//# sourceMappingURL=define-story.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"define-story.cjs","names":[],"sources":["../../src/helpers/define-story.ts"],"sourcesContent":["import type { StoryAlternate } from '../generated/capi/types.gen';\nimport type { StoryLocalizedPath, StoryTranslatedSlug } from '../generated/mapi/types.gen';\nimport type { MapiStory, StoryCreate, StoryUpdate } from '../generated/types/mapi-story';\nimport type { Story } from '../generated/types/story';\nimport type { Block, RootBlock } from './define-block';\nimport type { BlockContentInput } from './define-field';\nimport type { Prettify } from '../utils/prettify';\n\nconst CAPI_STORY_DEFAULTS = {\n  id: 1,\n  uuid: '',\n  created_at: '',\n  updated_at: '',\n  published_at: null,\n  first_published_at: null,\n  full_slug: '',\n  group_id: '',\n  alternates: [],\n  default_full_slug: null,\n  release_id: null,\n  lang: 'default',\n  slug: '',\n  parent_id: 0,\n  path: null,\n  is_startpage: false,\n  sort_by_date: null,\n  tag_list: [],\n  meta_data: null,\n  translated_slugs: null,\n  position: 0,\n};\n\nconst MAPI_STORY_DEFAULTS = {\n  id: 1,\n  uuid: '',\n  created_at: '',\n  updated_at: '',\n  published_at: null,\n  first_published_at: null,\n  full_slug: '',\n  group_id: '',\n  alternates: [],\n  slug: '',\n  parent_id: null,\n  parent: null,\n  path: null,\n  is_folder: false,\n  is_startpage: false,\n  sort_by_date: null,\n  tag_list: [],\n  meta_data: null,\n  translated_slugs: [],\n  translated_stories: [],\n  localized_paths: [],\n  position: 0,\n  deleted_at: null,\n  published: null,\n  default_root: null,\n  // Legacy upstream typo field; keep it alongside `disable_fe_editor`.\n  disble_fe_editor: false,\n  disable_fe_editor: false,\n  unpublished_changes: null,\n  imported_at: null,\n  preview_token: { token: '', timestamp: '' },\n  pinned: false,\n  breadcrumbs: [],\n  publish_at: null,\n  expire_at: null,\n  last_author: null,\n  last_author_id: null,\n  user_ids: [],\n  space_role_ids: [],\n  can_not_view: null,\n  is_scheduled: null,\n  scheduled_dates: null,\n  ideas: [],\n  favourite_for_user_ids: [],\n};\n\nexport type { MapiStory, Story, StoryCreate, StoryUpdate };\nexport type { StoryAlternate, StoryLocalizedPath, StoryTranslatedSlug };\n\ntype CapiStoryOptional = keyof typeof CAPI_STORY_DEFAULTS;\n\ntype CapiStoryInput<\n  TBlock extends RootBlock = RootBlock,\n  TBlocks extends Block = never,\n> = Prettify<\n  Omit<Story<TBlock, TBlocks>, CapiStoryOptional | 'content'>\n  & Partial<Pick<Story<TBlock, TBlocks>, CapiStoryOptional>>\n  & {\n    content: Omit<BlockContentInput<TBlock, TBlocks>, 'component'>;\n  }\n>;\n\n/**\n * Returns a full CDN {@link Story} with all fields populated.\n *\n * @example\n * const myStory = defineStory(pageComponent, {\n *   name: 'Home',\n *   content: { headline: 'Hello World!' },\n * });\n */\nexport function defineStory<\n  TBlock extends RootBlock,\n  TBlocks extends Block,\n>(component: TBlock, story: CapiStoryInput<TBlock, TBlocks>): Story<TBlock, TBlocks>;\n\nexport function defineStory(component: RootBlock, story: any) {\n  const { content, ...rest } = story;\n  return {\n    ...CAPI_STORY_DEFAULTS,\n    ...rest,\n    content: { ...content, component: component.name },\n  };\n}\n\n// ---------------------------------------------------------------------------\n// MAPI Story helpers\n// ---------------------------------------------------------------------------\n\ntype MapiStoryOptional = keyof typeof MAPI_STORY_DEFAULTS;\n\ntype MakeMapiStoryInput<\n  TStory extends MapiStory | StoryCreate | StoryUpdate,\n  TBlock extends RootBlock = RootBlock,\n  TBlocks extends Block = never,\n> = Prettify<\n  Omit<TStory, MapiStoryOptional | 'content'>\n  & Partial<Pick<TStory, Extract<MapiStoryOptional, keyof TStory>>>\n  & {\n    content: Omit<BlockContentInput<TBlock, TBlocks>, 'component'>;\n  }\n>;\n\ntype MapiStoryInput<\n  TBlock extends RootBlock = RootBlock,\n  TBlocks extends Block = never,\n> = MakeMapiStoryInput<MapiStory, TBlock, TBlocks>;\n\ntype StoryCreateInput<\n  TBlock extends RootBlock = RootBlock,\n  TBlocks extends Block = never,\n> = MakeMapiStoryInput<StoryCreate, TBlock, TBlocks>;\n\ntype StoryUpdateInput<\n  TBlock extends RootBlock = RootBlock,\n  TBlocks extends Block = never,\n> = Prettify<\n  Omit<MakeMapiStoryInput<StoryUpdate, TBlock, TBlocks>, 'content'>\n  & {\n    content: Partial<Omit<BlockContentInput<TBlock, TBlocks>, 'component'>>;\n  }\n>;\n\n/**\n * Returns a full MAPI {@link MapiStory} with all fields populated.\n *\n * @example\n * const myStory = defineMapiStory(pageComponent, {\n *   name: 'My Page',\n *   content: { headline: 'Hello World!' },\n * });\n */\nexport function defineMapiStory<\n  const TBlock extends RootBlock,\n  const TBlocks extends Block = never,\n>(component: TBlock, story: MapiStoryInput<TBlock, TBlocks>): MapiStory<TBlock, TBlocks>;\n\nexport function defineMapiStory(component: RootBlock, story: any) {\n  const { content, ...rest } = story;\n  return {\n    ...MAPI_STORY_DEFAULTS,\n    ...rest,\n    content: { ...content, component: component.name },\n  };\n}\n\n/**\n * Defines a story creation payload for the MAPI.\n *\n * @example\n * const payload = defineStoryCreate(pageComponent, {\n *   name: 'My Page',\n *   content: { headline: 'Hello World!' },\n * });\n */\nexport function defineStoryCreate<\n  const TBlock extends RootBlock,\n  const TBlocks extends Block = never,\n>(component: TBlock, story: StoryCreateInput<TBlock, TBlocks>): StoryCreate<TBlock, TBlocks>;\n\nexport function defineStoryCreate(component: RootBlock, story: any) {\n  const { content, ...rest } = story;\n  return {\n    ...rest,\n    content: { ...content, component: component.name },\n  };\n}\n\n/**\n * Defines a story update payload for the MAPI.\n *\n * @example\n * const payload = defineStoryUpdate(pageComponent, {\n *   content: { headline: 'Updated!' },\n * });\n */\nexport function defineStoryUpdate<\n  const TBlock extends RootBlock,\n  const TBlocks extends Block = never,\n>(component: TBlock, story: StoryUpdateInput<TBlock, TBlocks>): StoryUpdate<TBlock, TBlocks>;\n\nexport function defineStoryUpdate(component: RootBlock, story: any) {\n  const { content, ...rest } = story;\n  return {\n    ...rest,\n    ...(content && {\n      content: { ...content, component: component.name },\n    }),\n  };\n}\n"],"mappings":";;AAQA,MAAM,sBAAsB;CAC1B,IAAI;CACJ,MAAM;CACN,YAAY;CACZ,YAAY;CACZ,cAAc;CACd,oBAAoB;CACpB,WAAW;CACX,UAAU;CACV,YAAY,EAAE;CACd,mBAAmB;CACnB,YAAY;CACZ,MAAM;CACN,MAAM;CACN,WAAW;CACX,MAAM;CACN,cAAc;CACd,cAAc;CACd,UAAU,EAAE;CACZ,WAAW;CACX,kBAAkB;CAClB,UAAU;CACX;AAED,MAAM,sBAAsB;CAC1B,IAAI;CACJ,MAAM;CACN,YAAY;CACZ,YAAY;CACZ,cAAc;CACd,oBAAoB;CACpB,WAAW;CACX,UAAU;CACV,YAAY,EAAE;CACd,MAAM;CACN,WAAW;CACX,QAAQ;CACR,MAAM;CACN,WAAW;CACX,cAAc;CACd,cAAc;CACd,UAAU,EAAE;CACZ,WAAW;CACX,kBAAkB,EAAE;CACpB,oBAAoB,EAAE;CACtB,iBAAiB,EAAE;CACnB,UAAU;CACV,YAAY;CACZ,WAAW;CACX,cAAc;CAEd,kBAAkB;CAClB,mBAAmB;CACnB,qBAAqB;CACrB,aAAa;CACb,eAAe;EAAE,OAAO;EAAI,WAAW;EAAI;CAC3C,QAAQ;CACR,aAAa,EAAE;CACf,YAAY;CACZ,WAAW;CACX,aAAa;CACb,gBAAgB;CAChB,UAAU,EAAE;CACZ,gBAAgB,EAAE;CAClB,cAAc;CACd,cAAc;CACd,iBAAiB;CACjB,OAAO,EAAE;CACT,wBAAwB,EAAE;CAC3B;AAgCD,SAAgB,YAAY,WAAsB,OAAY;CAC5D,MAAM,EAAE,SAAS,GAAG,SAAS;AAC7B,QAAO;EACL,GAAG;EACH,GAAG;EACH,SAAS;GAAE,GAAG;GAAS,WAAW,UAAU;GAAM;EACnD;;AAuDH,SAAgB,gBAAgB,WAAsB,OAAY;CAChE,MAAM,EAAE,SAAS,GAAG,SAAS;AAC7B,QAAO;EACL,GAAG;EACH,GAAG;EACH,SAAS;GAAE,GAAG;GAAS,WAAW,UAAU;GAAM;EACnD;;AAiBH,SAAgB,kBAAkB,WAAsB,OAAY;CAClE,MAAM,EAAE,SAAS,GAAG,SAAS;AAC7B,QAAO;EACL,GAAG;EACH,SAAS;GAAE,GAAG;GAAS,WAAW,UAAU;GAAM;EACnD;;AAgBH,SAAgB,kBAAkB,WAAsB,OAAY;CAClE,MAAM,EAAE,SAAS,GAAG,SAAS;AAC7B,QAAO;EACL,GAAG;EACH,GAAI,WAAW,EACb,SAAS;GAAE,GAAG;GAAS,WAAW,UAAU;GAAM,EACnD;EACF"}

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

@@ -0,0 +1,135 @@
+import { Block, RootBlock } from "../generated/types/block.cjs";
+import { Prettify } from "../utils/prettify.cjs";
+import { StoryAlternate } from "../generated/capi/types.gen.cjs";
+import { StoryLocalizedPath, StoryTranslatedSlug } from "../generated/mapi/types.gen.cjs";
+import { MapiStory, StoryCreate, StoryUpdate } from "../generated/types/mapi-story.cjs";
+import { Story } from "../generated/types/story.cjs";
+import { BlockContentInput } from "./define-field.cjs";
+
+//#region src/helpers/define-story.d.ts
+declare const CAPI_STORY_DEFAULTS: {
+  id: number;
+  uuid: string;
+  created_at: string;
+  updated_at: string;
+  published_at: null;
+  first_published_at: null;
+  full_slug: string;
+  group_id: string;
+  alternates: never[];
+  default_full_slug: null;
+  release_id: null;
+  lang: string;
+  slug: string;
+  parent_id: number;
+  path: null;
+  is_startpage: boolean;
+  sort_by_date: null;
+  tag_list: never[];
+  meta_data: null;
+  translated_slugs: null;
+  position: number;
+};
+declare const MAPI_STORY_DEFAULTS: {
+  id: number;
+  uuid: string;
+  created_at: string;
+  updated_at: string;
+  published_at: null;
+  first_published_at: null;
+  full_slug: string;
+  group_id: string;
+  alternates: never[];
+  slug: string;
+  parent_id: null;
+  parent: null;
+  path: null;
+  is_folder: boolean;
+  is_startpage: boolean;
+  sort_by_date: null;
+  tag_list: never[];
+  meta_data: null;
+  translated_slugs: never[];
+  translated_stories: never[];
+  localized_paths: never[];
+  position: number;
+  deleted_at: null;
+  published: null;
+  default_root: null;
+  disble_fe_editor: boolean;
+  disable_fe_editor: boolean;
+  unpublished_changes: null;
+  imported_at: null;
+  preview_token: {
+    token: string;
+    timestamp: string;
+  };
+  pinned: boolean;
+  breadcrumbs: never[];
+  publish_at: null;
+  expire_at: null;
+  last_author: null;
+  last_author_id: null;
+  user_ids: never[];
+  space_role_ids: never[];
+  can_not_view: null;
+  is_scheduled: null;
+  scheduled_dates: null;
+  ideas: never[];
+  favourite_for_user_ids: never[];
+};
+type CapiStoryOptional = keyof typeof CAPI_STORY_DEFAULTS;
+type CapiStoryInput<TBlock extends RootBlock = RootBlock, TBlocks extends Block = never> = Prettify<Omit<Story<TBlock, TBlocks>, CapiStoryOptional | 'content'> & Partial<Pick<Story<TBlock, TBlocks>, CapiStoryOptional>> & {
+  content: Omit<BlockContentInput<TBlock, TBlocks>, 'component'>;
+}>;
+/**
+ * Returns a full CDN {@link Story} with all fields populated.
+ *
+ * @example
+ * const myStory = defineStory(pageComponent, {
+ *   name: 'Home',
+ *   content: { headline: 'Hello World!' },
+ * });
+ */
+declare function defineStory<TBlock extends RootBlock, TBlocks extends Block>(component: TBlock, story: CapiStoryInput<TBlock, TBlocks>): Story<TBlock, TBlocks>;
+type MapiStoryOptional = keyof typeof MAPI_STORY_DEFAULTS;
+type MakeMapiStoryInput<TStory extends MapiStory | StoryCreate | StoryUpdate, TBlock extends RootBlock = RootBlock, TBlocks extends Block = never> = Prettify<Omit<TStory, MapiStoryOptional | 'content'> & Partial<Pick<TStory, Extract<MapiStoryOptional, keyof TStory>>> & {
+  content: Omit<BlockContentInput<TBlock, TBlocks>, 'component'>;
+}>;
+type MapiStoryInput<TBlock extends RootBlock = RootBlock, TBlocks extends Block = never> = MakeMapiStoryInput<MapiStory, TBlock, TBlocks>;
+type StoryCreateInput<TBlock extends RootBlock = RootBlock, TBlocks extends Block = never> = MakeMapiStoryInput<StoryCreate, TBlock, TBlocks>;
+type StoryUpdateInput<TBlock extends RootBlock = RootBlock, TBlocks extends Block = never> = Prettify<Omit<MakeMapiStoryInput<StoryUpdate, TBlock, TBlocks>, 'content'> & {
+  content: Partial<Omit<BlockContentInput<TBlock, TBlocks>, 'component'>>;
+}>;
+/**
+ * Returns a full MAPI {@link MapiStory} with all fields populated.
+ *
+ * @example
+ * const myStory = defineMapiStory(pageComponent, {
+ *   name: 'My Page',
+ *   content: { headline: 'Hello World!' },
+ * });
+ */
+declare function defineMapiStory<const TBlock extends RootBlock, const TBlocks extends Block = never>(component: TBlock, story: MapiStoryInput<TBlock, TBlocks>): MapiStory<TBlock, TBlocks>;
+/**
+ * Defines a story creation payload for the MAPI.
+ *
+ * @example
+ * const payload = defineStoryCreate(pageComponent, {
+ *   name: 'My Page',
+ *   content: { headline: 'Hello World!' },
+ * });
+ */
+declare function defineStoryCreate<const TBlock extends RootBlock, const TBlocks extends Block = never>(component: TBlock, story: StoryCreateInput<TBlock, TBlocks>): StoryCreate<TBlock, TBlocks>;
+/**
+ * Defines a story update payload for the MAPI.
+ *
+ * @example
+ * const payload = defineStoryUpdate(pageComponent, {
+ *   content: { headline: 'Updated!' },
+ * });
+ */
+declare function defineStoryUpdate<const TBlock extends RootBlock, const TBlocks extends Block = never>(component: TBlock, story: StoryUpdateInput<TBlock, TBlocks>): StoryUpdate<TBlock, TBlocks>;
+//#endregion
+export { defineMapiStory, defineStory, defineStoryCreate, defineStoryUpdate };
+//# sourceMappingURL=define-story.d.cts.map

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

@@ -0,0 +1,135 @@
+import { Block, RootBlock } from "../generated/types/block.mjs";
+import { Prettify } from "../utils/prettify.mjs";
+import { StoryAlternate } from "../generated/capi/types.gen.mjs";
+import { StoryLocalizedPath, StoryTranslatedSlug } from "../generated/mapi/types.gen.mjs";
+import { MapiStory, StoryCreate, StoryUpdate } from "../generated/types/mapi-story.mjs";
+import { Story } from "../generated/types/story.mjs";
+import { BlockContentInput } from "./define-field.mjs";
+
+//#region src/helpers/define-story.d.ts
+declare const CAPI_STORY_DEFAULTS: {
+  id: number;
+  uuid: string;
+  created_at: string;
+  updated_at: string;
+  published_at: null;
+  first_published_at: null;
+  full_slug: string;
+  group_id: string;
+  alternates: never[];
+  default_full_slug: null;
+  release_id: null;
+  lang: string;
+  slug: string;
+  parent_id: number;
+  path: null;
+  is_startpage: boolean;
+  sort_by_date: null;
+  tag_list: never[];
+  meta_data: null;
+  translated_slugs: null;
+  position: number;
+};
+declare const MAPI_STORY_DEFAULTS: {
+  id: number;
+  uuid: string;
+  created_at: string;
+  updated_at: string;
+  published_at: null;
+  first_published_at: null;
+  full_slug: string;
+  group_id: string;
+  alternates: never[];
+  slug: string;
+  parent_id: null;
+  parent: null;
+  path: null;
+  is_folder: boolean;
+  is_startpage: boolean;
+  sort_by_date: null;
+  tag_list: never[];
+  meta_data: null;
+  translated_slugs: never[];
+  translated_stories: never[];
+  localized_paths: never[];
+  position: number;
+  deleted_at: null;
+  published: null;
+  default_root: null;
+  disble_fe_editor: boolean;
+  disable_fe_editor: boolean;
+  unpublished_changes: null;
+  imported_at: null;
+  preview_token: {
+    token: string;
+    timestamp: string;
+  };
+  pinned: boolean;
+  breadcrumbs: never[];
+  publish_at: null;
+  expire_at: null;
+  last_author: null;
+  last_author_id: null;
+  user_ids: never[];
+  space_role_ids: never[];
+  can_not_view: null;
+  is_scheduled: null;
+  scheduled_dates: null;
+  ideas: never[];
+  favourite_for_user_ids: never[];
+};
+type CapiStoryOptional = keyof typeof CAPI_STORY_DEFAULTS;
+type CapiStoryInput<TBlock extends RootBlock = RootBlock, TBlocks extends Block = never> = Prettify<Omit<Story<TBlock, TBlocks>, CapiStoryOptional | 'content'> & Partial<Pick<Story<TBlock, TBlocks>, CapiStoryOptional>> & {
+  content: Omit<BlockContentInput<TBlock, TBlocks>, 'component'>;
+}>;
+/**
+ * Returns a full CDN {@link Story} with all fields populated.
+ *
+ * @example
+ * const myStory = defineStory(pageComponent, {
+ *   name: 'Home',
+ *   content: { headline: 'Hello World!' },
+ * });
+ */
+declare function defineStory<TBlock extends RootBlock, TBlocks extends Block>(component: TBlock, story: CapiStoryInput<TBlock, TBlocks>): Story<TBlock, TBlocks>;
+type MapiStoryOptional = keyof typeof MAPI_STORY_DEFAULTS;
+type MakeMapiStoryInput<TStory extends MapiStory | StoryCreate | StoryUpdate, TBlock extends RootBlock = RootBlock, TBlocks extends Block = never> = Prettify<Omit<TStory, MapiStoryOptional | 'content'> & Partial<Pick<TStory, Extract<MapiStoryOptional, keyof TStory>>> & {
+  content: Omit<BlockContentInput<TBlock, TBlocks>, 'component'>;
+}>;
+type MapiStoryInput<TBlock extends RootBlock = RootBlock, TBlocks extends Block = never> = MakeMapiStoryInput<MapiStory, TBlock, TBlocks>;
+type StoryCreateInput<TBlock extends RootBlock = RootBlock, TBlocks extends Block = never> = MakeMapiStoryInput<StoryCreate, TBlock, TBlocks>;
+type StoryUpdateInput<TBlock extends RootBlock = RootBlock, TBlocks extends Block = never> = Prettify<Omit<MakeMapiStoryInput<StoryUpdate, TBlock, TBlocks>, 'content'> & {
+  content: Partial<Omit<BlockContentInput<TBlock, TBlocks>, 'component'>>;
+}>;
+/**
+ * Returns a full MAPI {@link MapiStory} with all fields populated.
+ *
+ * @example
+ * const myStory = defineMapiStory(pageComponent, {
+ *   name: 'My Page',
+ *   content: { headline: 'Hello World!' },
+ * });
+ */
+declare function defineMapiStory<const TBlock extends RootBlock, const TBlocks extends Block = never>(component: TBlock, story: MapiStoryInput<TBlock, TBlocks>): MapiStory<TBlock, TBlocks>;
+/**
+ * Defines a story creation payload for the MAPI.
+ *
+ * @example
+ * const payload = defineStoryCreate(pageComponent, {
+ *   name: 'My Page',
+ *   content: { headline: 'Hello World!' },
+ * });
+ */
+declare function defineStoryCreate<const TBlock extends RootBlock, const TBlocks extends Block = never>(component: TBlock, story: StoryCreateInput<TBlock, TBlocks>): StoryCreate<TBlock, TBlocks>;
+/**
+ * Defines a story update payload for the MAPI.
+ *
+ * @example
+ * const payload = defineStoryUpdate(pageComponent, {
+ *   content: { headline: 'Updated!' },
+ * });
+ */
+declare function defineStoryUpdate<const TBlock extends RootBlock, const TBlocks extends Block = never>(component: TBlock, story: StoryUpdateInput<TBlock, TBlocks>): StoryUpdate<TBlock, TBlocks>;
+//#endregion
+export { defineMapiStory, defineStory, defineStoryCreate, defineStoryUpdate };
+//# sourceMappingURL=define-story.d.mts.map

package/dist/helpers/define-story.mjs

@@ -0,0 +1,118 @@
+//#region src/helpers/define-story.ts
+const CAPI_STORY_DEFAULTS = {
+	id: 1,
+	uuid: "",
+	created_at: "",
+	updated_at: "",
+	published_at: null,
+	first_published_at: null,
+	full_slug: "",
+	group_id: "",
+	alternates: [],
+	default_full_slug: null,
+	release_id: null,
+	lang: "default",
+	slug: "",
+	parent_id: 0,
+	path: null,
+	is_startpage: false,
+	sort_by_date: null,
+	tag_list: [],
+	meta_data: null,
+	translated_slugs: null,
+	position: 0
+};
+const MAPI_STORY_DEFAULTS = {
+	id: 1,
+	uuid: "",
+	created_at: "",
+	updated_at: "",
+	published_at: null,
+	first_published_at: null,
+	full_slug: "",
+	group_id: "",
+	alternates: [],
+	slug: "",
+	parent_id: null,
+	parent: null,
+	path: null,
+	is_folder: false,
+	is_startpage: false,
+	sort_by_date: null,
+	tag_list: [],
+	meta_data: null,
+	translated_slugs: [],
+	translated_stories: [],
+	localized_paths: [],
+	position: 0,
+	deleted_at: null,
+	published: null,
+	default_root: null,
+	disble_fe_editor: false,
+	disable_fe_editor: false,
+	unpublished_changes: null,
+	imported_at: null,
+	preview_token: {
+		token: "",
+		timestamp: ""
+	},
+	pinned: false,
+	breadcrumbs: [],
+	publish_at: null,
+	expire_at: null,
+	last_author: null,
+	last_author_id: null,
+	user_ids: [],
+	space_role_ids: [],
+	can_not_view: null,
+	is_scheduled: null,
+	scheduled_dates: null,
+	ideas: [],
+	favourite_for_user_ids: []
+};
+function defineStory(component, story) {
+	const { content, ...rest } = story;
+	return {
+		...CAPI_STORY_DEFAULTS,
+		...rest,
+		content: {
+			...content,
+			component: component.name
+		}
+	};
+}
+function defineMapiStory(component, story) {
+	const { content, ...rest } = story;
+	return {
+		...MAPI_STORY_DEFAULTS,
+		...rest,
+		content: {
+			...content,
+			component: component.name
+		}
+	};
+}
+function defineStoryCreate(component, story) {
+	const { content, ...rest } = story;
+	return {
+		...rest,
+		content: {
+			...content,
+			component: component.name
+		}
+	};
+}
+function defineStoryUpdate(component, story) {
+	const { content, ...rest } = story;
+	return {
+		...rest,
+		...content && { content: {
+			...content,
+			component: component.name
+		} }
+	};
+}
+
+//#endregion
+export { defineMapiStory, defineStory, defineStoryCreate, defineStoryUpdate };
+//# sourceMappingURL=define-story.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"define-story.mjs","names":[],"sources":["../../src/helpers/define-story.ts"],"sourcesContent":["import type { StoryAlternate } from '../generated/capi/types.gen';\nimport type { StoryLocalizedPath, StoryTranslatedSlug } from '../generated/mapi/types.gen';\nimport type { MapiStory, StoryCreate, StoryUpdate } from '../generated/types/mapi-story';\nimport type { Story } from '../generated/types/story';\nimport type { Block, RootBlock } from './define-block';\nimport type { BlockContentInput } from './define-field';\nimport type { Prettify } from '../utils/prettify';\n\nconst CAPI_STORY_DEFAULTS = {\n  id: 1,\n  uuid: '',\n  created_at: '',\n  updated_at: '',\n  published_at: null,\n  first_published_at: null,\n  full_slug: '',\n  group_id: '',\n  alternates: [],\n  default_full_slug: null,\n  release_id: null,\n  lang: 'default',\n  slug: '',\n  parent_id: 0,\n  path: null,\n  is_startpage: false,\n  sort_by_date: null,\n  tag_list: [],\n  meta_data: null,\n  translated_slugs: null,\n  position: 0,\n};\n\nconst MAPI_STORY_DEFAULTS = {\n  id: 1,\n  uuid: '',\n  created_at: '',\n  updated_at: '',\n  published_at: null,\n  first_published_at: null,\n  full_slug: '',\n  group_id: '',\n  alternates: [],\n  slug: '',\n  parent_id: null,\n  parent: null,\n  path: null,\n  is_folder: false,\n  is_startpage: false,\n  sort_by_date: null,\n  tag_list: [],\n  meta_data: null,\n  translated_slugs: [],\n  translated_stories: [],\n  localized_paths: [],\n  position: 0,\n  deleted_at: null,\n  published: null,\n  default_root: null,\n  // Legacy upstream typo field; keep it alongside `disable_fe_editor`.\n  disble_fe_editor: false,\n  disable_fe_editor: false,\n  unpublished_changes: null,\n  imported_at: null,\n  preview_token: { token: '', timestamp: '' },\n  pinned: false,\n  breadcrumbs: [],\n  publish_at: null,\n  expire_at: null,\n  last_author: null,\n  last_author_id: null,\n  user_ids: [],\n  space_role_ids: [],\n  can_not_view: null,\n  is_scheduled: null,\n  scheduled_dates: null,\n  ideas: [],\n  favourite_for_user_ids: [],\n};\n\nexport type { MapiStory, Story, StoryCreate, StoryUpdate };\nexport type { StoryAlternate, StoryLocalizedPath, StoryTranslatedSlug };\n\ntype CapiStoryOptional = keyof typeof CAPI_STORY_DEFAULTS;\n\ntype CapiStoryInput<\n  TBlock extends RootBlock = RootBlock,\n  TBlocks extends Block = never,\n> = Prettify<\n  Omit<Story<TBlock, TBlocks>, CapiStoryOptional | 'content'>\n  & Partial<Pick<Story<TBlock, TBlocks>, CapiStoryOptional>>\n  & {\n    content: Omit<BlockContentInput<TBlock, TBlocks>, 'component'>;\n  }\n>;\n\n/**\n * Returns a full CDN {@link Story} with all fields populated.\n *\n * @example\n * const myStory = defineStory(pageComponent, {\n *   name: 'Home',\n *   content: { headline: 'Hello World!' },\n * });\n */\nexport function defineStory<\n  TBlock extends RootBlock,\n  TBlocks extends Block,\n>(component: TBlock, story: CapiStoryInput<TBlock, TBlocks>): Story<TBlock, TBlocks>;\n\nexport function defineStory(component: RootBlock, story: any) {\n  const { content, ...rest } = story;\n  return {\n    ...CAPI_STORY_DEFAULTS,\n    ...rest,\n    content: { ...content, component: component.name },\n  };\n}\n\n// ---------------------------------------------------------------------------\n// MAPI Story helpers\n// ---------------------------------------------------------------------------\n\ntype MapiStoryOptional = keyof typeof MAPI_STORY_DEFAULTS;\n\ntype MakeMapiStoryInput<\n  TStory extends MapiStory | StoryCreate | StoryUpdate,\n  TBlock extends RootBlock = RootBlock,\n  TBlocks extends Block = never,\n> = Prettify<\n  Omit<TStory, MapiStoryOptional | 'content'>\n  & Partial<Pick<TStory, Extract<MapiStoryOptional, keyof TStory>>>\n  & {\n    content: Omit<BlockContentInput<TBlock, TBlocks>, 'component'>;\n  }\n>;\n\ntype MapiStoryInput<\n  TBlock extends RootBlock = RootBlock,\n  TBlocks extends Block = never,\n> = MakeMapiStoryInput<MapiStory, TBlock, TBlocks>;\n\ntype StoryCreateInput<\n  TBlock extends RootBlock = RootBlock,\n  TBlocks extends Block = never,\n> = MakeMapiStoryInput<StoryCreate, TBlock, TBlocks>;\n\ntype StoryUpdateInput<\n  TBlock extends RootBlock = RootBlock,\n  TBlocks extends Block = never,\n> = Prettify<\n  Omit<MakeMapiStoryInput<StoryUpdate, TBlock, TBlocks>, 'content'>\n  & {\n    content: Partial<Omit<BlockContentInput<TBlock, TBlocks>, 'component'>>;\n  }\n>;\n\n/**\n * Returns a full MAPI {@link MapiStory} with all fields populated.\n *\n * @example\n * const myStory = defineMapiStory(pageComponent, {\n *   name: 'My Page',\n *   content: { headline: 'Hello World!' },\n * });\n */\nexport function defineMapiStory<\n  const TBlock extends RootBlock,\n  const TBlocks extends Block = never,\n>(component: TBlock, story: MapiStoryInput<TBlock, TBlocks>): MapiStory<TBlock, TBlocks>;\n\nexport function defineMapiStory(component: RootBlock, story: any) {\n  const { content, ...rest } = story;\n  return {\n    ...MAPI_STORY_DEFAULTS,\n    ...rest,\n    content: { ...content, component: component.name },\n  };\n}\n\n/**\n * Defines a story creation payload for the MAPI.\n *\n * @example\n * const payload = defineStoryCreate(pageComponent, {\n *   name: 'My Page',\n *   content: { headline: 'Hello World!' },\n * });\n */\nexport function defineStoryCreate<\n  const TBlock extends RootBlock,\n  const TBlocks extends Block = never,\n>(component: TBlock, story: StoryCreateInput<TBlock, TBlocks>): StoryCreate<TBlock, TBlocks>;\n\nexport function defineStoryCreate(component: RootBlock, story: any) {\n  const { content, ...rest } = story;\n  return {\n    ...rest,\n    content: { ...content, component: component.name },\n  };\n}\n\n/**\n * Defines a story update payload for the MAPI.\n *\n * @example\n * const payload = defineStoryUpdate(pageComponent, {\n *   content: { headline: 'Updated!' },\n * });\n */\nexport function defineStoryUpdate<\n  const TBlock extends RootBlock,\n  const TBlocks extends Block = never,\n>(component: TBlock, story: StoryUpdateInput<TBlock, TBlocks>): StoryUpdate<TBlock, TBlocks>;\n\nexport function defineStoryUpdate(component: RootBlock, story: any) {\n  const { content, ...rest } = story;\n  return {\n    ...rest,\n    ...(content && {\n      content: { ...content, component: component.name },\n    }),\n  };\n}\n"],"mappings":";AAQA,MAAM,sBAAsB;CAC1B,IAAI;CACJ,MAAM;CACN,YAAY;CACZ,YAAY;CACZ,cAAc;CACd,oBAAoB;CACpB,WAAW;CACX,UAAU;CACV,YAAY,EAAE;CACd,mBAAmB;CACnB,YAAY;CACZ,MAAM;CACN,MAAM;CACN,WAAW;CACX,MAAM;CACN,cAAc;CACd,cAAc;CACd,UAAU,EAAE;CACZ,WAAW;CACX,kBAAkB;CAClB,UAAU;CACX;AAED,MAAM,sBAAsB;CAC1B,IAAI;CACJ,MAAM;CACN,YAAY;CACZ,YAAY;CACZ,cAAc;CACd,oBAAoB;CACpB,WAAW;CACX,UAAU;CACV,YAAY,EAAE;CACd,MAAM;CACN,WAAW;CACX,QAAQ;CACR,MAAM;CACN,WAAW;CACX,cAAc;CACd,cAAc;CACd,UAAU,EAAE;CACZ,WAAW;CACX,kBAAkB,EAAE;CACpB,oBAAoB,EAAE;CACtB,iBAAiB,EAAE;CACnB,UAAU;CACV,YAAY;CACZ,WAAW;CACX,cAAc;CAEd,kBAAkB;CAClB,mBAAmB;CACnB,qBAAqB;CACrB,aAAa;CACb,eAAe;EAAE,OAAO;EAAI,WAAW;EAAI;CAC3C,QAAQ;CACR,aAAa,EAAE;CACf,YAAY;CACZ,WAAW;CACX,aAAa;CACb,gBAAgB;CAChB,UAAU,EAAE;CACZ,gBAAgB,EAAE;CAClB,cAAc;CACd,cAAc;CACd,iBAAiB;CACjB,OAAO,EAAE;CACT,wBAAwB,EAAE;CAC3B;AAgCD,SAAgB,YAAY,WAAsB,OAAY;CAC5D,MAAM,EAAE,SAAS,GAAG,SAAS;AAC7B,QAAO;EACL,GAAG;EACH,GAAG;EACH,SAAS;GAAE,GAAG;GAAS,WAAW,UAAU;GAAM;EACnD;;AAuDH,SAAgB,gBAAgB,WAAsB,OAAY;CAChE,MAAM,EAAE,SAAS,GAAG,SAAS;AAC7B,QAAO;EACL,GAAG;EACH,GAAG;EACH,SAAS;GAAE,GAAG;GAAS,WAAW,UAAU;GAAM;EACnD;;AAiBH,SAAgB,kBAAkB,WAAsB,OAAY;CAClE,MAAM,EAAE,SAAS,GAAG,SAAS;AAC7B,QAAO;EACL,GAAG;EACH,SAAS;GAAE,GAAG;GAAS,WAAW,UAAU;GAAM;EACnD;;AAgBH,SAAgB,kBAAkB,WAAsB,OAAY;CAClE,MAAM,EAAE,SAAS,GAAG,SAAS;AAC7B,QAAO;EACL,GAAG;EACH,GAAI,WAAW,EACb,SAAS;GAAE,GAAG;GAAS,WAAW,UAAU;GAAM,EACnD;EACF"}

package/dist/helpers/define-tag.cjs

@@ -0,0 +1,13 @@
+
+//#region src/helpers/define-tag.ts
+const TAG_DEFAULTS = { taggings_count: 0 };
+function defineTag(tag) {
+	return {
+		...TAG_DEFAULTS,
+		...tag
+	};
+}
+
+//#endregion
+exports.defineTag = defineTag;
+//# sourceMappingURL=define-tag.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"define-tag.cjs","names":[],"sources":["../../src/helpers/define-tag.ts"],"sourcesContent":["import type { Tag } from '../generated/capi/types.gen';\nimport type { Prettify } from '../utils/prettify';\n\nconst TAG_DEFAULTS = {\n  taggings_count: 0,\n};\n\nexport type { Tag };\n\n/** Fields that have safe defaults and may be omitted from tag input. */\ntype TagOptional = keyof typeof TAG_DEFAULTS;\n\ntype TagInput = Prettify<Omit<Tag, TagOptional> & Partial<Pick<Tag, TagOptional>>>;\n\n/**\n * Returns a full {@link Tag} with all fields populated. API-assigned\n * fields are optional and default to safe values.\n *\n * @example\n * const tag = defineTag({\n *   name: 'featured',\n * });\n */\n// Overload: provides the strict public signature for callers.\nexport function defineTag(tag: TagInput): Tag;\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 defineTag(tag: any) {\n  return { ...TAG_DEFAULTS, ...tag };\n}\n"],"mappings":";;AAGA,MAAM,eAAe,EACnB,gBAAgB,GACjB;AAwBD,SAAgB,UAAU,KAAU;AAClC,QAAO;EAAE,GAAG;EAAc,GAAG;EAAK"}