@ecsplico/editor 3.5.1 → 4.0.0

package/dist/vue/AdvancedEditor.vue.d.ts

@@ -3,10 +3,10 @@ import { CommandDef } from "../core/command-types.js";
 import { AbilitiesOptions, BlockAction, BlockUiOptions } from "../core/extension-points.js";
 import { EditorMetadata, MetadataItem } from "../core/metadata-types.js";
 import { CollaborationSession, EditorFeature } from "../core/feature.js";
+import { Basket } from "../features/composites/baskets.js";
+import { BlockType } from "../features/composites/block-types.js";
 import { CoreContentOptions } from "../core/schema/index.js";
 import "../core/commands.js";
-import { CompositeKind } from "../features/composites/kinds.js";
-import { Basket } from "../features/composites/baskets.js";
 import "../features/composites/index.js";
 import { ComposedEditor, ContentLevel, FeatureId, InteractionLevel } from "../presets/compose.js";
 import "./advanced.js";
@@ -29,9 +29,9 @@ type __VLS_Props = {
   extensions?: AnyExtension[];
   /** Hover actions shown after the defaults (AI, convert, duplicate, delete, composite actions), on blocks with their `ability`. */
   blockActions?: BlockAction[];
-  /** Composite kinds („Bausteine“) offered in the editor (default: `defaultCompositeKinds(t)`); read once at setup. */
-  compositeKinds?: CompositeKind[];
-  /** Colour baskets a Baustein can sit in (default: `defaultBaskets(t)`); read once at setup. */
+  /** Block types offered in the editor (default: `defaultBlockTypes(t)`); read once at setup. */
+  blockTypes?: BlockType[];
+  /** Colour baskets a Typed block can sit in (default: `defaultBaskets(t)`); read once at setup. */
   compositeBaskets?: Basket[];
   /** Which surfaces render block actions: the hover bar (default), the selected-block toolbar, `'both'` or `'none'` (`BlockUiOptions`); read once at setup. */
   blockUi?: BlockUiOptions;
@@ -50,7 +50,7 @@ type __VLS_Props = {
   /** The backend the composition is pruned by (default: the editor context's backend); read once at setup. */
   backend?: EditorBackend;
   /**
-   * Builds the final commands (toolbar, `/` menu) from the default ones (incl. one per composite kind); absent = the
+   * Builds the final commands (toolbar, `/` menu) from the default ones (incl. one per Block type); absent = the
    * defaults. Host commands with an `ability` are enabled only where the caret has it, like the defaults. Read once at setup.
    */
   commands?: (defaults: CommandDef[]) => CommandDef[];
@@ -71,21 +71,21 @@ declare const __VLS_export: import("vue").DefineComponent<__VLS_PublicProps, {
   editor: import("vue").ComputedRef<Editor | undefined>;
   preset: ComposedEditor<Component>;
 }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+  settingsOpen: (tab?: string | undefined) => any;
   "update:sidebarOpen": (value: boolean) => any;
   "update:commentsOpen": (value: boolean) => any;
-  ready: (editor: Editor) => any;
   "update:modelValue": (content: JSONContent) => any;
+  ready: (editor: Editor) => any;
   metadataCreate: (list: string, item: MetadataItem) => any;
   contentError: (error: Error) => any;
-  settingsOpen: (tab?: string | undefined) => any;
 }, string, import("vue").PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+  onSettingsOpen?: ((tab?: string | undefined) => any) | undefined;
   "onUpdate:sidebarOpen"?: ((value: boolean) => any) | undefined;
   "onUpdate:commentsOpen"?: ((value: boolean) => any) | undefined;
-  onReady?: ((editor: Editor) => any) | undefined;
   "onUpdate:modelValue"?: ((content: JSONContent) => any) | undefined;
+  onReady?: ((editor: Editor) => any) | undefined;
   onMetadataCreate?: ((list: string, item: MetadataItem) => any) | undefined;
   onContentError?: ((error: Error) => any) | undefined;
-  onSettingsOpen?: ((tab?: string | undefined) => any) | undefined;
 }>, {
   content: ContentLevel | readonly FeatureId[];
   ai: boolean;

package/dist/vue/SimpleEditor.vue.d.ts

@@ -41,21 +41,21 @@ declare const __VLS_export: import("vue").DefineComponent<__VLS_PublicProps, {
   editor: import("vue").ComputedRef<Editor | undefined>;
   preset: EditorPreset<Component>;
 }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+  settingsOpen: (tab?: string | undefined) => any;
   "update:sidebarOpen": (value: boolean) => any;
   "update:commentsOpen": (value: boolean) => any;
-  ready: (editor: Editor) => any;
   "update:modelValue": (content: JSONContent) => any;
+  ready: (editor: Editor) => any;
   metadataCreate: (list: string, item: MetadataItem) => any;
   contentError: (error: Error) => any;
-  settingsOpen: (tab?: string | undefined) => any;
 }, string, import("vue").PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+  onSettingsOpen?: ((tab?: string | undefined) => any) | undefined;
   "onUpdate:sidebarOpen"?: ((value: boolean) => any) | undefined;
   "onUpdate:commentsOpen"?: ((value: boolean) => any) | undefined;
-  onReady?: ((editor: Editor) => any) | undefined;
   "onUpdate:modelValue"?: ((content: JSONContent) => any) | undefined;
+  onReady?: ((editor: Editor) => any) | undefined;
   onMetadataCreate?: ((list: string, item: MetadataItem) => any) | undefined;
   onContentError?: ((error: Error) => any) | undefined;
-  onSettingsOpen?: ((tab?: string | undefined) => any) | undefined;
 }>, {
   editable: boolean;
   settingsUi: "internal" | "external";

package/dist/vue/components/EditorSurface.vue.d.ts

@@ -43,21 +43,21 @@ declare const __VLS_export: import("vue").DefineComponent<__VLS_PublicProps, {
   settingsOpen: import("vue").Ref<boolean, boolean>;
   settingsTab: import("vue").Ref<string | undefined, string | undefined>;
 }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+  settingsOpen: (tab?: string | undefined) => any;
   "update:sidebarOpen": (value: boolean) => any;
   "update:commentsOpen": (value: boolean) => any;
-  ready: (editor: Editor) => any;
   "update:modelValue": (content: JSONContent) => any;
+  ready: (editor: Editor) => any;
   metadataCreate: (list: string, item: MetadataItem) => any;
   contentError: (error: Error) => any;
-  settingsOpen: (tab?: string | undefined) => any;
 }, string, import("vue").PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+  onSettingsOpen?: ((tab?: string | undefined) => any) | undefined;
   "onUpdate:sidebarOpen"?: ((value: boolean) => any) | undefined;
   "onUpdate:commentsOpen"?: ((value: boolean) => any) | undefined;
-  onReady?: ((editor: Editor) => any) | undefined;
   "onUpdate:modelValue"?: ((content: JSONContent) => any) | undefined;
+  onReady?: ((editor: Editor) => any) | undefined;
   onMetadataCreate?: ((list: string, item: MetadataItem) => any) | undefined;
   onContentError?: ((error: Error) => any) | undefined;
-  onSettingsOpen?: ((tab?: string | undefined) => any) | undefined;
 }>, {
   editable: boolean;
   settingsUi: "internal" | "external";

package/dist/vue/compose.d.ts

@@ -9,7 +9,7 @@ import { Component } from "vue";
 export declare const composeEditor: (options: ComposeOptions<Component>) => ComposedEditor<Component>;
 /**
  * The advanced editor on the Vue surface: `{ content: 'rich', interaction: 'full', ai: true }`, every dimension option
- * overridable (`compositeKinds`, `backend`, `add`, `remove`, ...). Collaboration is active only when a session is passed
+ * overridable (`blockTypes`, `backend`, `add`, `remove`, ...). Collaboration is active only when a session is passed
  * to the surface.
  */
 export declare const advancedEditor: (options?: Partial<ComposeOptions<Component>>) => ComposedEditor<Component>;

package/dist/vue/compose.js

@@ -1,8 +1,8 @@
 import { coreUiFeature } from "../core/core-feature.js";
-import { composeEditor as composeEditor$1 } from "../presets/compose.js";
 import { bulletsTransform, summaryTransform } from "../integrations/composite-ai/transfer-transforms.js";
 import { compositeAiFeature } from "../integrations/composite-ai/index.js";
 import { transcriptAiFeature } from "../integrations/transcript-ai/index.js";
+import { composeEditor as composeEditor$1 } from "../presets/compose.js";
 import { mediaFeature } from "../features/media/vue.js";
 import _sfc_main from "./components/EditorCommandPalette.js";
 import { aiFeature } from "../features/ai/vue.js";
@@ -40,7 +40,7 @@ const VUE_BINDINGS = {
 const composeEditor = (options) => composeEditor$1(VUE_BINDINGS, options);
 /**
 * The advanced editor on the Vue surface: `{ content: 'rich', interaction: 'full', ai: true }`, every dimension option
-* overridable (`compositeKinds`, `backend`, `add`, `remove`, ...). Collaboration is active only when a session is passed
+* overridable (`blockTypes`, `backend`, `add`, `remove`, ...). Collaboration is active only when a session is passed
 * to the surface.
 */
 const advancedEditor = (options = {}) => composeEditor({

package/dist/vue/compose.js.map

@@ -1 +1 @@
-{"version":3,"file":"compose.js","names":["EditorCommandPalette","compose"],"sources":["../../src/vue/compose.ts"],"sourcesContent":["import type { Component } from 'vue'\nimport { coreUiFeature } from '../core/core-feature'\nimport EditorCommandPalette from './components/EditorCommandPalette.vue'\nimport { aiFeature } from '../features/ai/vue'\nimport { authorsFeature } from '../features/authors/vue'\nimport { blockUiFeature } from '../features/block-ui/vue'\nimport { collabFeature } from '../features/collab/vue'\nimport { commentsFeature } from '../features/comments/vue'\nimport { compositeFeature } from '../features/composites/vue'\nimport { mediaFeature } from '../features/media/vue'\nimport { themesFeature } from '../features/themes/vue'\nimport { transferFeature } from '../features/transfer/vue'\nimport { transcriptFeature } from '../features/transcript/vue'\nimport { bulletsTransform, compositeAiFeature, summaryTransform } from '../integrations/composite-ai'\nimport { transcriptAiFeature } from '../integrations/transcript-ai'\nimport { type ComposedEditor, type ComposeOptions, composeEditor as compose, type UiBindings } from '../presets/compose'\n\n/** The Vue bindings of every UI-bound catalog feature. */\nconst VUE_BINDINGS = {\n  'core-ui': () => coreUiFeature<Component>({ palette: EditorCommandPalette }),\n  'media': mediaFeature,\n  'transcript': transcriptFeature,\n  'composites': compositeFeature,\n  'authors': authorsFeature,\n  'comments': commentsFeature,\n  'ai': aiFeature,\n  'composite-ai': compositeAiFeature,\n  'transcript-ai': transcriptAiFeature,\n  'collab': collabFeature,\n  'block-ui': blockUiFeature,\n  'themes': themesFeature,\n  'transfer': transferFeature,\n  'transfer-ai': () => [summaryTransform, bulletsTransform],\n} satisfies UiBindings<Component>\n\n/**\n * `composeEditor` of `presets/compose` over the Vue bindings: the editor of the three dimensions (`content`,\n * `interaction`, `ai`), pruned by the capabilities of `options.backend`. Call during component setup (`themesFeature()`\n * reads the current Vue app to stop the theme runtime when it unmounts).\n */\nexport const composeEditor = (options: ComposeOptions<Component>): ComposedEditor<Component> => compose(VUE_BINDINGS, options)\n\n/**\n * The advanced editor on the Vue surface: `{ content: 'rich', interaction: 'full', ai: true }`, every dimension option\n * overridable (`compositeKinds`, `backend`, `add`, `remove`, ...). Collaboration is active only when a session is passed\n * to the surface.\n */\nexport const advancedEditor = (options: Partial<ComposeOptions<Component>> = {}): ComposedEditor<Component> => composeEditor({ content: 'rich', interaction: 'full', ai: true, ...options })\n"],"mappings":";;;;;;;;;;;;;;;;;;AAkBA,MAAM,eAAe;CACnB,iBAAiB,cAAyB,EAAE,SAASA,UAAqB,CAAC;CAC3E,SAAS;CACT,cAAc;CACd,cAAc;CACd,WAAW;CACX,YAAY;CACZ,MAAM;CACN,gBAAgB;CAChB,iBAAiB;CACjB,UAAU;CACV,YAAY;CACZ,UAAU;CACV,YAAY;CACZ,qBAAqB,CAAC,kBAAkB,gBAAgB;AAC1D;;;;;;AAOA,MAAa,iBAAiB,YAAkEC,gBAAQ,cAAc,OAAO;;;;;;AAO7H,MAAa,kBAAkB,UAA8C,CAAC,MAAiC,cAAc;CAAE,SAAS;CAAQ,aAAa;CAAQ,IAAI;CAAM,GAAG;AAAQ,CAAC"}
+{"version":3,"file":"compose.js","names":["EditorCommandPalette","compose"],"sources":["../../src/vue/compose.ts"],"sourcesContent":["import type { Component } from 'vue'\nimport { coreUiFeature } from '../core/core-feature'\nimport EditorCommandPalette from './components/EditorCommandPalette.vue'\nimport { aiFeature } from '../features/ai/vue'\nimport { authorsFeature } from '../features/authors/vue'\nimport { blockUiFeature } from '../features/block-ui/vue'\nimport { collabFeature } from '../features/collab/vue'\nimport { commentsFeature } from '../features/comments/vue'\nimport { compositeFeature } from '../features/composites/vue'\nimport { mediaFeature } from '../features/media/vue'\nimport { themesFeature } from '../features/themes/vue'\nimport { transferFeature } from '../features/transfer/vue'\nimport { transcriptFeature } from '../features/transcript/vue'\nimport { bulletsTransform, compositeAiFeature, summaryTransform } from '../integrations/composite-ai'\nimport { transcriptAiFeature } from '../integrations/transcript-ai'\nimport { type ComposedEditor, type ComposeOptions, composeEditor as compose, type UiBindings } from '../presets/compose'\n\n/** The Vue bindings of every UI-bound catalog feature. */\nconst VUE_BINDINGS = {\n  'core-ui': () => coreUiFeature<Component>({ palette: EditorCommandPalette }),\n  'media': mediaFeature,\n  'transcript': transcriptFeature,\n  'composites': compositeFeature,\n  'authors': authorsFeature,\n  'comments': commentsFeature,\n  'ai': aiFeature,\n  'composite-ai': compositeAiFeature,\n  'transcript-ai': transcriptAiFeature,\n  'collab': collabFeature,\n  'block-ui': blockUiFeature,\n  'themes': themesFeature,\n  'transfer': transferFeature,\n  'transfer-ai': () => [summaryTransform, bulletsTransform],\n} satisfies UiBindings<Component>\n\n/**\n * `composeEditor` of `presets/compose` over the Vue bindings: the editor of the three dimensions (`content`,\n * `interaction`, `ai`), pruned by the capabilities of `options.backend`. Call during component setup (`themesFeature()`\n * reads the current Vue app to stop the theme runtime when it unmounts).\n */\nexport const composeEditor = (options: ComposeOptions<Component>): ComposedEditor<Component> => compose(VUE_BINDINGS, options)\n\n/**\n * The advanced editor on the Vue surface: `{ content: 'rich', interaction: 'full', ai: true }`, every dimension option\n * overridable (`blockTypes`, `backend`, `add`, `remove`, ...). Collaboration is active only when a session is passed\n * to the surface.\n */\nexport const advancedEditor = (options: Partial<ComposeOptions<Component>> = {}): ComposedEditor<Component> => composeEditor({ content: 'rich', interaction: 'full', ai: true, ...options })\n"],"mappings":";;;;;;;;;;;;;;;;;;AAkBA,MAAM,eAAe;CACnB,iBAAiB,cAAyB,EAAE,SAASA,UAAqB,CAAC;CAC3E,SAAS;CACT,cAAc;CACd,cAAc;CACd,WAAW;CACX,YAAY;CACZ,MAAM;CACN,gBAAgB;CAChB,iBAAiB;CACjB,UAAU;CACV,YAAY;CACZ,UAAU;CACV,YAAY;CACZ,qBAAqB,CAAC,kBAAkB,gBAAgB;AAC1D;;;;;;AAOA,MAAa,iBAAiB,YAAkEC,gBAAQ,cAAc,OAAO;;;;;;AAO7H,MAAa,kBAAkB,UAA8C,CAAC,MAAiC,cAAc;CAAE,SAAS;CAAQ,aAAa;CAAQ,IAAI;CAAM,GAAG;AAAQ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ecsplico/editor",
-  "version": "3.5.1",
+  "version": "4.0.0",
   "type": "module",
   "description": "Vue and React editor library on TipTap v3 (Vue: Nuxt UI; React: shadcn/ui): framework-free features with Vue and React bindings, simple and advanced presets, tree-shakeable entries. Built ESM with type declarations.",
   "license": "MIT",

package/dist/features/composites/derivation.d.ts

@@ -1,62 +0,0 @@
-import { CompositeKind } from "./kinds.js";
-import { DERIVATION_KEY } from "./meta-keys.js";
-import { Editor } from "@tiptap/core";
-import { Node as Node$1 } from "@tiptap/pm/model";
-//#region src/features/composites/derivation.d.ts
-/** How a derived Baustein was made; `ai:<kindId>` for a block derived from another block by the model. */
-export type DerivationMethod = 'transcription' | 'pdf-text' | 'ocr' | 'description' | 'bibliography' | (string & {});
-/** What a derived Baustein was made from: an uploaded asset (by asset name) or another block (by block id). */
-export type DerivationSource = {
-  asset: string;
-} | {
-  block: string; /** Document the block lives in; absent = this document. */
-  document?: string;
-};
-/** `meta.derivation` of a derived Baustein. */
-export interface Derivation {
-  from: DerivationSource;
-  method: DerivationMethod;
-  model?: string;
-  /** ISO timestamp. */
-  createdAt: string;
-  /** SHA-256 hex of the asset bytes / of the source block's Markdown; `''` when unknown. */
-  inputHash: string;
-  /** SHA-256 hex of the produced body's Markdown; `''` when unknown. */
-  outputHash: string;
-  /** Asset name of the stored raw output (text/markdown). */
-  output?: string;
-}
-/** The derivation of a composite (`meta.derivation` with a `from` object and a `method`); null when it has none. */
-export declare function derivationOf(node: Node$1): Derivation | null;
-/** The media block a source-holding kind keeps its original in: first body child of a type in `kind.source`. */
-export declare function sourceOf(composite: Node$1, kinds: readonly CompositeKind[]): {
-  node: Node$1;
-  index: number;
-  asset: {
-    documentId: string;
-    name: string;
-  } | null;
-  hash: string | null;
-} | null;
-/** The body children of `composite` that are derived Bausteine, with their child index. */
-export declare function renditionsOf(composite: Node$1): {
-  node: Node$1;
-  index: number;
-  derivation: Derivation;
-}[];
-/**
- * Whether `derived` (a Baustein with a derivation, a child of `composite`) is out of date or was edited since it was made.
- * `stale`: for an asset source, the block `sourceOf(composite, kinds)` finds has a `hash` that differs from `inputHash`; null
- * when either is unknown. A block source is null here: callers with the document compare the hash of the source block's
- * Markdown. `edited`: the body's
- * hash (computed lazily, it serialises the whole body) differs from `outputHash`; null when `outputHash` is unknown.
- */
-export declare function derivationState(composite: Node$1, derived: Node$1, bodyHash: () => string, kinds: readonly CompositeKind[]): {
-  stale: boolean | null;
-  edited: boolean | null;
-};
-/** Markdown of the body of `composite` (everything after title, description and tags). */
-export declare function bodyMarkdown(editor: Editor, composite: Node$1): string;
-//#endregion
-export { DERIVATION_KEY };
-//# sourceMappingURL=derivation.d.ts.map

package/dist/features/composites/derivation.js

@@ -1,102 +0,0 @@
-import { EDITOR_API } from "../../core/api-routes.js";
-import { compositeKind } from "./kinds.js";
-import { DERIVATION_KEY } from "./meta-keys.js";
-import "./nodes.js";
-//#region src/features/composites/derivation.ts
-/** The derivation of a composite (`meta.derivation` with a `from` object and a `method`); null when it has none. */
-function derivationOf(node) {
-	const meta = node.attrs.meta;
-	const value = meta && typeof meta === "object" ? meta[DERIVATION_KEY] : void 0;
-	if (!value || typeof value !== "object") return null;
-	const { from, method } = value;
-	if (!from || typeof from !== "object" || typeof method !== "string") return null;
-	return value;
-}
-/** Whether `derivation` points at a block of another document than `documentId` (the open one; null/undefined = unknown, so any named document is another). */
-function isForeignSource(derivation, documentId) {
-	return "block" in derivation.from && !!derivation.from.document && derivation.from.document !== documentId;
-}
-const ASSET_URL_PREFIX = `${EDITOR_API}/assets/`;
-const ASSET_NAME = /^[0-9a-f-]{36}\.[a-z0-9]{1,8}$/;
-const ASSET_DOCUMENT_ID = /^[A-Za-z0-9_-]{1,64}$/;
-/** The stored asset behind an `/api/editor/assets/<documentId>/<name>` URL; null for any other `src`. */
-function assetRefOf(src) {
-	if (!src.startsWith(ASSET_URL_PREFIX)) return null;
-	const [documentId, name, ...rest] = src.slice(ASSET_URL_PREFIX.length).split("/");
-	if (rest.length || !documentId || !name || !ASSET_DOCUMENT_ID.test(documentId) || !ASSET_NAME.test(name)) return null;
-	return {
-		documentId,
-		name
-	};
-}
-/** The media block a source-holding kind keeps its original in: first body child of a type in `kind.source`. */
-function sourceOf(composite, kinds) {
-	if (composite.type.name !== "composite") return null;
-	const types = compositeKind(kinds, String(composite.attrs.kind)).source;
-	if (!types) return null;
-	for (let index = 3; index < composite.childCount; index++) {
-		const node = composite.child(index);
-		if (!types.includes(node.type.name)) continue;
-		const hash = node.attrs.hash;
-		return {
-			node,
-			index,
-			asset: assetRefOf(String(node.attrs.src ?? "")),
-			hash: typeof hash === "string" && hash ? hash : null
-		};
-	}
-	return null;
-}
-/** The body children of `composite` that are derived Bausteine, with their child index. */
-function renditionsOf(composite) {
-	const found = [];
-	composite.forEach((node, _offset, index) => {
-		if (index < 3 || node.type.name !== "composite") return;
-		const derivation = derivationOf(node);
-		if (derivation) found.push({
-			node,
-			index,
-			derivation
-		});
-	});
-	return found;
-}
-/**
-* Whether `derived` (a Baustein with a derivation, a child of `composite`) is out of date or was edited since it was made.
-* `stale`: for an asset source, the block `sourceOf(composite, kinds)` finds has a `hash` that differs from `inputHash`; null
-* when either is unknown. A block source is null here: callers with the document compare the hash of the source block's
-* Markdown. `edited`: the body's
-* hash (computed lazily, it serialises the whole body) differs from `outputHash`; null when `outputHash` is unknown.
-*/
-function derivationState(composite, derived, bodyHash, kinds) {
-	const derivation = derivationOf(derived);
-	if (!derivation) return {
-		stale: null,
-		edited: null
-	};
-	let stale = null;
-	if ("asset" in derivation.from) {
-		const hash = sourceOf(composite, kinds)?.hash;
-		stale = hash && derivation.inputHash ? hash !== derivation.inputHash : null;
-	}
-	const edited = derivation.outputHash ? bodyHash() !== derivation.outputHash : null;
-	return {
-		stale,
-		edited
-	};
-}
-/** Markdown of the body of `composite` (everything after title, description and tags). */
-function bodyMarkdown(editor, composite) {
-	const content = [];
-	composite.forEach((child, _offset, index) => {
-		if (index >= 3) content.push(child.toJSON());
-	});
-	return editor.markdown.serialize({
-		type: "doc",
-		content
-	});
-}
-//#endregion
-export { DERIVATION_KEY, assetRefOf, bodyMarkdown, derivationOf, derivationState, isForeignSource, renditionsOf, sourceOf };
-
-//# sourceMappingURL=derivation.js.map

package/dist/features/composites/derivation.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"derivation.js","names":[],"sources":["../../../src/features/composites/derivation.ts"],"sourcesContent":["// Vue-free and server-importable: where a Baustein's content comes from. A source-holding Baustein (`recording`, `paper`,\n// `book`, `figure`, `document`) carries its original as an `image|audio|video|file` block in the body; a derived\n// Baustein (transcript, full text, description, AI result) records in `meta.derivation` what it was made from.\nimport type { Editor, JSONContent } from '@tiptap/core'\n// Types only: brings in the `editor.markdown` augmentation of `@tiptap/markdown` for contexts that do not otherwise load it.\nimport type {} from '@tiptap/markdown'\nimport type { Node as PMNode } from '@tiptap/pm/model'\nimport { EDITOR_API } from '../../core/api-routes'\nimport { type CompositeKind, compositeKind } from './kinds'\nimport { COMPOSITE_CHROME_COUNT } from './nodes'\nimport { DERIVATION_KEY } from './meta-keys'\n\n/** How a derived Baustein was made; `ai:<kindId>` for a block derived from another block by the model. */\nexport type DerivationMethod = 'transcription' | 'pdf-text' | 'ocr' | 'description' | 'bibliography' | (string & {})\n\n/** What a derived Baustein was made from: an uploaded asset (by asset name) or another block (by block id). */\nexport type DerivationSource = { asset: string } | { block: string, /** Document the block lives in; absent = this document. */ document?: string }\n\n/** `meta.derivation` of a derived Baustein. */\nexport interface Derivation {\n  from: DerivationSource\n  method: DerivationMethod\n  model?: string\n  /** ISO timestamp. */\n  createdAt: string\n  /** SHA-256 hex of the asset bytes / of the source block's Markdown; `''` when unknown. */\n  inputHash: string\n  /** SHA-256 hex of the produced body's Markdown; `''` when unknown. */\n  outputHash: string\n  /** Asset name of the stored raw output (text/markdown). */\n  output?: string\n}\n\nexport { DERIVATION_KEY }\n\n/** The derivation of a composite (`meta.derivation` with a `from` object and a `method`); null when it has none. */\nexport function derivationOf(node: PMNode): Derivation | null {\n  const meta: unknown = node.attrs.meta\n  const value = meta && typeof meta === 'object' ? (meta as Record<string, unknown>)[DERIVATION_KEY] : undefined\n  if (!value || typeof value !== 'object') return null\n  const { from, method } = value as Record<string, unknown>\n  if (!from || typeof from !== 'object' || typeof method !== 'string') return null\n  return value as Derivation\n}\n\n/** Whether `derivation` points at a block of another document than `documentId` (the open one; null/undefined = unknown, so any named document is another). */\nexport function isForeignSource(derivation: Derivation, documentId: string | null | undefined): boolean {\n  return 'block' in derivation.from && !!derivation.from.document && derivation.from.document !== documentId\n}\n\nconst ASSET_URL_PREFIX = `${EDITOR_API}/assets/`\n// Same patterns as `features/media/assets.ts`; copied because composites must not import media.\nconst ASSET_NAME = /^[0-9a-f-]{36}\\.[a-z0-9]{1,8}$/\nconst ASSET_DOCUMENT_ID = /^[A-Za-z0-9_-]{1,64}$/\n\n/** The stored asset behind an `/api/editor/assets/<documentId>/<name>` URL; null for any other `src`. */\nexport function assetRefOf(src: string): { documentId: string, name: string } | null {\n  if (!src.startsWith(ASSET_URL_PREFIX)) return null\n  const [documentId, name, ...rest] = src.slice(ASSET_URL_PREFIX.length).split('/')\n  if (rest.length || !documentId || !name || !ASSET_DOCUMENT_ID.test(documentId) || !ASSET_NAME.test(name)) return null\n  return { documentId, name }\n}\n\n/** The media block a source-holding kind keeps its original in: first body child of a type in `kind.source`. */\nexport function sourceOf(\n  composite: PMNode,\n  kinds: readonly CompositeKind[],\n): { node: PMNode, index: number, asset: { documentId: string, name: string } | null, hash: string | null } | null {\n  if (composite.type.name !== 'composite') return null\n  const types = compositeKind(kinds, String(composite.attrs.kind)).source\n  if (!types) return null\n  for (let index = COMPOSITE_CHROME_COUNT; index < composite.childCount; index++) {\n    const node = composite.child(index)\n    if (!(types as readonly string[]).includes(node.type.name)) continue\n    const hash: unknown = node.attrs.hash\n    return { node, index, asset: assetRefOf(String(node.attrs.src ?? '')), hash: typeof hash === 'string' && hash ? hash : null }\n  }\n  return null\n}\n\n/** The body children of `composite` that are derived Bausteine, with their child index. */\nexport function renditionsOf(composite: PMNode): { node: PMNode, index: number, derivation: Derivation }[] {\n  const found: { node: PMNode, index: number, derivation: Derivation }[] = []\n  composite.forEach((node, _offset, index) => {\n    if (index < COMPOSITE_CHROME_COUNT || node.type.name !== 'composite') return\n    const derivation = derivationOf(node)\n    if (derivation) found.push({ node, index, derivation })\n  })\n  return found\n}\n\n/**\n * Whether `derived` (a Baustein with a derivation, a child of `composite`) is out of date or was edited since it was made.\n * `stale`: for an asset source, the block `sourceOf(composite, kinds)` finds has a `hash` that differs from `inputHash`; null\n * when either is unknown. A block source is null here: callers with the document compare the hash of the source block's\n * Markdown. `edited`: the body's\n * hash (computed lazily, it serialises the whole body) differs from `outputHash`; null when `outputHash` is unknown.\n */\nexport function derivationState(\n  composite: PMNode,\n  derived: PMNode,\n  bodyHash: () => string,\n  kinds: readonly CompositeKind[],\n): { stale: boolean | null, edited: boolean | null } {\n  const derivation = derivationOf(derived)\n  if (!derivation) return { stale: null, edited: null }\n  let stale: boolean | null = null\n  if ('asset' in derivation.from) {\n    const hash = sourceOf(composite, kinds)?.hash\n    stale = hash && derivation.inputHash ? hash !== derivation.inputHash : null\n  }\n  const edited = derivation.outputHash ? bodyHash() !== derivation.outputHash : null\n  return { stale, edited }\n}\n\n/** Markdown of the body of `composite` (everything after title, description and tags). */\nexport function bodyMarkdown(editor: Editor, composite: PMNode): string {\n  const content: JSONContent[] = []\n  composite.forEach((child, _offset, index) => {\n    if (index >= COMPOSITE_CHROME_COUNT) content.push(child.toJSON() as JSONContent)\n  })\n  return editor.markdown!.serialize({ type: 'doc', content })\n}\n"],"mappings":";;;;;;AAoCA,SAAgB,aAAa,MAAiC;CAC5D,MAAM,OAAgB,KAAK,MAAM;CACjC,MAAM,QAAQ,QAAQ,OAAO,SAAS,WAAY,KAAiC,kBAAkB,KAAA;CACrG,IAAI,CAAC,SAAS,OAAO,UAAU,UAAU,OAAO;CAChD,MAAM,EAAE,MAAM,WAAW;CACzB,IAAI,CAAC,QAAQ,OAAO,SAAS,YAAY,OAAO,WAAW,UAAU,OAAO;CAC5E,OAAO;AACT;;AAGA,SAAgB,gBAAgB,YAAwB,YAAgD;CACtG,OAAO,WAAW,WAAW,QAAQ,CAAC,CAAC,WAAW,KAAK,YAAY,WAAW,KAAK,aAAa;AAClG;AAEA,MAAM,mBAAmB,GAAG,WAAW;AAEvC,MAAM,aAAa;AACnB,MAAM,oBAAoB;;AAG1B,SAAgB,WAAW,KAA0D;CACnF,IAAI,CAAC,IAAI,WAAW,gBAAgB,GAAG,OAAO;CAC9C,MAAM,CAAC,YAAY,MAAM,GAAG,QAAQ,IAAI,MAAM,iBAAiB,MAAM,CAAC,CAAC,MAAM,GAAG;CAChF,IAAI,KAAK,UAAU,CAAC,cAAc,CAAC,QAAQ,CAAC,kBAAkB,KAAK,UAAU,KAAK,CAAC,WAAW,KAAK,IAAI,GAAG,OAAO;CACjH,OAAO;EAAE;EAAY;CAAK;AAC5B;;AAGA,SAAgB,SACd,WACA,OACiH;CACjH,IAAI,UAAU,KAAK,SAAS,aAAa,OAAO;CAChD,MAAM,QAAQ,cAAc,OAAO,OAAO,UAAU,MAAM,IAAI,CAAC,CAAC,CAAC;CACjE,IAAI,CAAC,OAAO,OAAO;CACnB,KAAK,IAAI,QAAA,GAAgC,QAAQ,UAAU,YAAY,SAAS;EAC9E,MAAM,OAAO,UAAU,MAAM,KAAK;EAClC,IAAI,CAAE,MAA4B,SAAS,KAAK,KAAK,IAAI,GAAG;EAC5D,MAAM,OAAgB,KAAK,MAAM;EACjC,OAAO;GAAE;GAAM;GAAO,OAAO,WAAW,OAAO,KAAK,MAAM,OAAO,EAAE,CAAC;GAAG,MAAM,OAAO,SAAS,YAAY,OAAO,OAAO;EAAK;CAC9H;CACA,OAAO;AACT;;AAGA,SAAgB,aAAa,WAA8E;CACzG,MAAM,QAAmE,CAAC;CAC1E,UAAU,SAAS,MAAM,SAAS,UAAU;EAC1C,IAAI,QAAA,KAAkC,KAAK,KAAK,SAAS,aAAa;EACtE,MAAM,aAAa,aAAa,IAAI;EACpC,IAAI,YAAY,MAAM,KAAK;GAAE;GAAM;GAAO;EAAW,CAAC;CACxD,CAAC;CACD,OAAO;AACT;;;;;;;;AASA,SAAgB,gBACd,WACA,SACA,UACA,OACmD;CACnD,MAAM,aAAa,aAAa,OAAO;CACvC,IAAI,CAAC,YAAY,OAAO;EAAE,OAAO;EAAM,QAAQ;CAAK;CACpD,IAAI,QAAwB;CAC5B,IAAI,WAAW,WAAW,MAAM;EAC9B,MAAM,OAAO,SAAS,WAAW,KAAK,CAAC,EAAE;EACzC,QAAQ,QAAQ,WAAW,YAAY,SAAS,WAAW,YAAY;CACzE;CACA,MAAM,SAAS,WAAW,aAAa,SAAS,MAAM,WAAW,aAAa;CAC9E,OAAO;EAAE;EAAO;CAAO;AACzB;;AAGA,SAAgB,aAAa,QAAgB,WAA2B;CACtE,MAAM,UAAyB,CAAC;CAChC,UAAU,SAAS,OAAO,SAAS,UAAU;EAC3C,IAAI,SAAA,GAAiC,QAAQ,KAAK,MAAM,OAAO,CAAgB;CACjF,CAAC;CACD,OAAO,OAAO,SAAU,UAAU;EAAE,MAAM;EAAO;CAAQ,CAAC;AAC5D"}

package/dist/features/composites/kinds.d.ts

@@ -1,83 +0,0 @@
-import { Translate } from "../../i18n/index.js";
-//#region src/features/composites/kinds.d.ts
-/** Media block types a source-holding kind's source may be (`CompositeKind.source`). */
-export declare const SOURCE_MEDIA_TYPES: readonly ["image", "audio", "video", "file"];
-/** One metadata field of a composite kind, stored under `key` in the composite's `meta` attribute. */
-export interface CompositeMetaField {
-  key: string;
-  label: string;
-  /**
-   * `bibliography`: CSL-JSON item under `meta.bib`; `derivation`: read-only provenance of a derived Baustein; `reference`: block id of another Baustein;
-   * `multiselect`: several of `options`, stored as `string[]` (the key is removed when none is chosen).
-   */
-  type: 'text' | 'textarea' | 'date' | 'number' | 'select' | 'multiselect' | 'reference' | 'bibliography' | 'derivation';
-  /** Choices of a `select` or `multiselect` field (required for `multiselect`). */
-  options?: {
-    value: string;
-    label: string;
-  }[];
-  /** `reference`: kind ids the field may point to; absent = any Baustein. */
-  targets?: readonly string[];
-}
-/**
- * What a kind tells the model beyond its fields. `purpose` goes into every AI request's block model (chat, generate
- * tasks); `instructions`, `instructionsField` and `skeleton` are read only by „Baustein füllen (KI)“ (`fillComposite`).
- */
-export interface CompositeKindAi {
-  /** One or two German sentences: what a Baustein of this kind is for and what its body holds. */
-  purpose: string;
-  /** Default instruction for filling the body of a Baustein of this kind (what to write, structure, tone). */
-  instructions?: string;
-  /** Key of a `textarea` field of this kind; a Baustein whose value is non-empty replaces `instructions` with it. */
-  instructionsField?: string;
-  /** Target text (Vorlage) as Markdown; `{key}` placeholders are replaced by the Baustein's `meta[key]` before it goes to the model, unknown ones stay. */
-  skeleton?: string;
-}
-/** A composite kind: what its `kind` attribute selects (label, icon, chrome placeholders, meta fields). */
-export interface CompositeKind {
-  id: string;
-  label: string;
-  icon: string;
-  titlePlaceholder: string;
-  descriptionPlaceholder: string;
-  fields: CompositeMetaField[];
-  /**
-   * How much of the chrome the kind shows. Absent: all of it. `tags: false` hides the tag row of this kind (the node stays in the schema, empty).
-   * `tone`: a CSS colour or `var(...)` that sets the kind apart: a Baustein of this kind gets `data-kind-tone` and `--sk-kind-tone` on its wrapper
-   * (a tinted surface and a left border in the tone) and its tree rows tint the kind icon with it. Absent: the kind looks as before.
-   * `controls: false` makes the chrome of a Baustein of this kind read-only although the editor is editable (for a kind whose attributes a host
-   * guard refuses to change): no basket menu, status menu, title-visibility toggle, tag editing or drag handle on the kind icon, and a read-only
-   * details popover; an existing basket, status and tags still show as chips. Default `true`.
-   */
-  chrome?: {
-    tags?: boolean;
-    tone?: string;
-    controls?: boolean;
-  };
-  /** Absent: the kind has no AI brief; „Baustein füllen (KI)“ is not offered for it. */
-  ai?: CompositeKindAi;
-  /**
-   * Baustein kinds this kind accepts as nested Bausteine: a list of kind ids, or `'all'`. Absent: `folder` and `document`
-   * accept `'all'`, every other kind accepts none. Non-Baustein content (paragraphs, lists, ...) is always allowed.
-   * Only new moves are checked; documents that already nest against it stay as they are.
-   */
-  accepts?: readonly string[] | 'all';
-  /** Present on source-holding kinds: the media block types the kind's source may be; `sourceOf` returns the first body child of one of these. */
-  source?: readonly (typeof SOURCE_MEDIA_TYPES)[number][];
-}
-/**
- * The built-in kinds in the language of `t`. The default set is produced from the translator (labels, placeholders, field
- * labels and status choices are catalog messages), so it is built per translator and memoized; hosts that pass their own
- * kinds (`compositeFeature({ kinds })`, `Composite.configure({ kinds })`) keep their labels untouched. Ids, field keys and
- * stored values (`open`, `doing`, `done`) do not depend on the language.
- */
-export declare function defaultCompositeKinds(t: Translate): readonly CompositeKind[];
-/** Kind `id` from `kinds`; an unknown id gets the `section` kind's presentation (else the first kind's) under its own id and label. */
-export declare function compositeKind(kinds: readonly CompositeKind[], id: string): CompositeKind;
-/**
- * Whether a Baustein of kind `parentKind` accepts one of kind `childKind` as nested Baustein. The `accepts` of the kind
- * in `kinds` decides; without one (or for a kind `kinds` does not list) only `folder` and `document` accept all.
- */
-export declare function kindAccepts(kinds: readonly CompositeKind[], parentKind: string, childKind: string): boolean;
-//#endregion
-//# sourceMappingURL=kinds.d.ts.map