kindy-editor 3.2.1 → 3.2.3

package/types/kindy-editor.d.ts

@@ -8,6 +8,10 @@ import type { EditorEvents, EditorEventsOptions } from "./events";
 export type { Document } from "./model";
 export { EditorEvents } from "./events";
 export type { EditorEventsOptions, PublicEditorEvent, PublicEditorEventDataMap, PublicEditorEventType } from "./events";
+export type { TextDiffSummary, DocumentChangeEventData, DocumentChangeCommittedData } from "./events";
+export { createHttpEventSink, type HttpEventSink, type HttpEventSinkOptions } from "./events";
+export { ChangeAggregator, type ChangeAggregatorOptions } from "./events";
+export { CommitPolicy, type CommitPolicyOptions, type CommitBoundaryReason } from "./events";
 
 /** Caller-supplied identity, used for change attribution and presence. */
 export interface UserInfo {
@@ -54,7 +58,71 @@ export interface RevealRangeOptions {
   align?: "center" | "nearest" | "top" | "bottom";
 }
 
-export type TemplateVariableValues = Record<string, string | number | null | undefined>;
+export type TemplateVariableValues = Record<string, string | number | boolean | null | undefined>;
+
+export type MetadataDataType = "TEXT" | "NUMBER" | "DATE" | "CURRENCY" | "SELECT";
+export type VariableDisplayMode = "code" | "value" | "placeholder" | "label";
+
+export interface VariableBoundingBox {
+  left: number;
+  top: number;
+  right: number;
+  bottom: number;
+  width: number;
+  height: number;
+}
+
+export interface VariableClickInfo {
+  key: string;
+  def: TemplateVariableDef;
+  position: DocPosition;
+  rect: VariableBoundingBox;
+  clientRect?: VariableBoundingBox;
+}
+
+export interface MetadataAuditEntry {
+  id: string;
+  author: UserInfo;
+  timestamp: number;
+  previousValue: unknown;
+  newValue: unknown;
+  action: "created" | "updated" | "reverted";
+  source?: "api" | "editor" | "sidebar" | "palette" | "inline" | "import";
+}
+
+export interface TemplateVariableDef {
+  key: string;
+  label: string;
+  dataType: MetadataDataType;
+  dateFormat?: string;
+  value?: unknown;
+  defaultValue?: string;
+  metadataId?: number | string;
+  group?: string;
+  createdBy?: UserInfo;
+  createdAt?: number;
+  lastModifiedBy?: UserInfo;
+  lastModifiedAt?: number;
+  history?: MetadataAuditEntry[];
+}
+
+export interface SetTemplateVariablesOptions {
+  author?: UserInfo;
+  source?: "api" | "editor" | "sidebar" | "inline" | "import" | "palette";
+  trackInReview?: boolean;
+  metadata?: Record<string, Partial<TemplateVariableDef>>;
+}
+
+export interface InsertTemplateVariableItem {
+  key: string;
+  label: string;
+  dataType?: MetadataDataType;
+  dateFormat?: string;
+  value?: unknown;
+  defaultValue?: string;
+  metadataId?: number | string;
+  group?: string;
+}
 
 export interface EditorPermissions {
   editContent: boolean;
@@ -547,6 +615,13 @@ export interface KindyEditorOptions {
   onLoadProgress?: (progress: LoadProgress) => void;
   /** Granular capabilities governing content edits, annotations, and selection. */
   permissions?: Partial<EditorPermissions>;
+  /** Callback fired when a template variable token is clicked in the editor.
+   *  Provides variable key, definition, doc position, and bounding rects (container & client viewport).
+   *  Allows host application (React/Vue/etc.) to render custom modals, drawers, or popovers. */
+  onVariableClick?: (info: VariableClickInfo) => void;
+  /** Whether to show the built-in variable audit popover UI on click. Defaults to false.
+   *  When false, the built-in popover does not appear, leaving UI rendering to the host via onVariableClick / event. */
+  showVariablePopover?: boolean;
 }
 
 /** Initial view-chrome state (see KindyEditorOptions.view). Every field is
@@ -805,7 +880,31 @@ export interface EditorHandle {
   revealRange(range: ExternalRange, options?: RevealRangeOptions): void;
   /** Live-update {{KEY}} template placeholders in the document without full reload,
    *  preserving zoom, scroll position, and selection. */
-  setTemplateVariables(values: TemplateVariableValues): void;
+  setTemplateVariables(values: TemplateVariableValues, options?: SetTemplateVariablesOptions): void;
+  /** Revert a template variable to an earlier value recorded in its audit history. */
+  revertTemplateVariable(key: string, historyId: string, actor?: UserInfo): boolean;
+  /** Insert an atomic template variable token at current caret/selection. */
+  insertTemplateVariable(item: InsertTemplateVariableItem, author?: UserInfo): boolean;
+  /** Open the contract metadata palette autocomplete at current caret position. */
+  openMetadataPalette(): void;
+  /** Set template variable display mode ('code' | 'value' | 'placeholder'). */
+  setVariableDisplayMode(mode: VariableDisplayMode): void;
+  /** Get current template variable display mode. */
+  getVariableDisplayMode(): VariableDisplayMode;
+  /** Get all registered template variables in the document. */
+  getTemplateVariables(): Record<string, TemplateVariableDef>;
+  /** Get a single registered template variable definition by key. */
+  getTemplateVariable(key: string): TemplateVariableDef | null;
+  /** Get audit trail history for a template variable. */
+  getVariableHistory(key: string): MetadataAuditEntry[];
+  /** Open built-in variable popover explicitly. */
+  openVariablePopover(key: string, pos?: DocPosition): void;
+  /** Close built-in variable popover. */
+  closeVariablePopover(): void;
+  /** Get all metadata IDs (numbers) currently used by template variables in the document. */
+  getUsedMetadataIds(): number[];
+  /** Set custom metadata catalog for autocomplete palette. */
+  setMetadataCatalog(catalog: TemplateVariableDef[]): void;
   /** Update fine-grained capabilities (e.g. allow comments/selection in view mode). */
   setPermissions(permissions: Partial<EditorPermissions>): void;
   /** Current effective permissions. */
@@ -894,7 +993,31 @@ export declare class KindyEditor {
   revealRange(range: ExternalRange, options?: RevealRangeOptions): Promise<void>;
   /** Live-update {{KEY}} template placeholders in the document without full reload,
    *  preserving zoom, scroll position, and selection. */
-  setTemplateVariables(values: TemplateVariableValues): Promise<void>;
+  setTemplateVariables(values: TemplateVariableValues, options?: SetTemplateVariablesOptions): Promise<void>;
+  /** Revert a template variable to an earlier value recorded in its audit history. */
+  revertTemplateVariable(key: string, historyId: string, actor?: UserInfo): Promise<boolean>;
+  /** Insert an atomic template variable token at current caret/selection. */
+  insertTemplateVariable(item: InsertTemplateVariableItem, author?: UserInfo): Promise<boolean>;
+  /** Open the contract metadata palette autocomplete at current caret position. */
+  openMetadataPalette(): Promise<void>;
+  /** Set template variable display mode ('code' | 'value' | 'placeholder'). */
+  setVariableDisplayMode(mode: VariableDisplayMode): Promise<void>;
+  /** Get current template variable display mode. */
+  getVariableDisplayMode(): Promise<VariableDisplayMode>;
+  /** Get all registered template variables in the document. */
+  getTemplateVariables(): Promise<Record<string, TemplateVariableDef>>;
+  /** Get a single registered template variable definition by key. */
+  getTemplateVariable(key: string): Promise<TemplateVariableDef | null>;
+  /** Get audit trail history for a template variable. */
+  getVariableHistory(key: string): Promise<MetadataAuditEntry[]>;
+  /** Open built-in variable popover explicitly. */
+  openVariablePopover(key: string, pos?: DocPosition): Promise<void>;
+  /** Close built-in variable popover. */
+  closeVariablePopover(): Promise<void>;
+  /** Get all metadata IDs (numbers) currently used by template variables in the document. */
+  getUsedMetadataIds(): Promise<number[]>;
+  /** Set custom metadata catalog for autocomplete palette. */
+  setMetadataCatalog(catalog: TemplateVariableDef[]): Promise<void>;
   /** Update fine-grained capabilities (e.g. allow comments/selection in view mode). */
   setPermissions(permissions: Partial<EditorPermissions>): Promise<void>;
   /** Current effective permissions. */

package/dist-lib/eventHub-CZFpTVqe.js

@@ -1,71 +0,0 @@
-class a {
-  detail;
-  includeSelection;
-  handlers = /* @__PURE__ */ new Map();
-  anyHandlers = /* @__PURE__ */ new Set();
-  sink;
-  redact;
-  onError;
-  disposed = !1;
-  constructor(e = {}) {
-    this.detail = e.detail ?? "metadata", this.includeSelection = e.includeSelection ?? !1, this.sink = e.sink, this.redact = e.redact, this.onError = e.onError ?? ((r) => console.error("[kindy-editor:event]", r));
-  }
-  on(e, r, t = {}) {
-    if (this.disposed || t.signal?.aborted) return () => {
-    };
-    let s = this.handlers.get(e);
-    s || this.handlers.set(e, s = /* @__PURE__ */ new Set()), s.add(r);
-    const i = () => {
-      s?.delete(r), s?.size === 0 && this.handlers.delete(e);
-    };
-    return t.signal?.addEventListener("abort", i, { once: !0 }), i;
-  }
-  onAny(e, r = {}) {
-    if (this.disposed || r.signal?.aborted) return () => {
-    };
-    this.anyHandlers.add(e);
-    const t = () => {
-      this.anyHandlers.delete(e);
-    };
-    return r.signal?.addEventListener("abort", t, { once: !0 }), t;
-  }
-  off(e, r) {
-    this.handlers.get(e)?.delete(r);
-  }
-  /** Called by the editor runtime after state is already consistent. Public only
-   * for custom bridges; normal integrations subscribe with on/onAny. */
-  dispatch(e) {
-    if (this.disposed) return;
-    const r = this.redact ? this.redact(e) : e;
-    if (r) {
-      for (const t of this.handlers.get(r.type) ?? []) this.safeCall(t, r);
-      for (const t of this.anyHandlers) this.safeCall(t, r);
-      if (this.sink)
-        try {
-          Promise.resolve(this.sink(r)).catch((t) => this.reportError(t, r));
-        } catch (t) {
-          this.reportError(t, r);
-        }
-    }
-  }
-  destroy() {
-    this.disposed = !0, this.handlers.clear(), this.anyHandlers.clear();
-  }
-  safeCall(e, r) {
-    try {
-      e(r);
-    } catch (t) {
-      this.reportError(t, r);
-    }
-  }
-  reportError(e, r) {
-    try {
-      this.onError(e, r);
-    } catch (t) {
-      console.error("[kindy-editor:event:onError]", t);
-    }
-  }
-}
-export {
-  a as E
-};

package/dist-lib/events-D_WEQDa6.js

@@ -1,104 +0,0 @@
-const r = "1.0";
-function n(e) {
-  const t = /* @__PURE__ */ new Set();
-  for (const a of e)
-    switch (a.type) {
-      case "insertText":
-      case "insertRuns":
-      case "splitParagraph":
-        t.add(a.at.blockId), a.type === "splitParagraph" && t.add(a.newBlockId);
-        break;
-      case "mergeParagraphs":
-        t.add(a.firstBlockId);
-        break;
-      case "insertBlock":
-        t.add(a.block.id);
-        break;
-      case "setTableRow":
-      case "setTableStructure":
-      case "setTableStyleRef":
-      case "insertTableRow":
-      case "removeTableRow":
-      case "setRowHeight":
-      case "insertTableColumn":
-      case "removeTableColumn":
-        t.add(a.tableId);
-        break;
-      case "deleteRange":
-      case "setRuns":
-      case "setParaStyle":
-      case "removeBlock":
-      case "setImageProps":
-      case "setEquation":
-      case "setEquationAlign":
-      case "setTableColFractions":
-      case "setTableWidthMode":
-      case "setTablePreferredWidth":
-      case "setTableAlign":
-      case "setTableProps":
-        t.add(a.blockId);
-        break;
-    }
-  return [...t];
-}
-function c(e, t) {
-  const a = { type: "review.operation.applied", data: { operation: e, remote: t } };
-  switch (e.type) {
-    case "addSuggestion":
-      return [a, { type: "review.suggestion.created", data: { suggestionId: e.s.id, kind: e.s.kind, remote: t } }];
-    case "removeSuggestion":
-      return [a, { type: "review.suggestion.removed", data: { suggestionId: e.id, remote: t } }];
-    case "growSuggestion":
-      return [a];
-    case "addThread": {
-      const d = e.t.comments[0];
-      return d ? [
-        a,
-        { type: "review.thread.created", data: { threadId: e.t.id, remote: t } },
-        { type: "review.comment.added", data: {
-          threadId: e.t.id,
-          commentId: d.id,
-          authorId: d.author.id,
-          isReply: !1,
-          mentionedUserIds: (d.mentions ?? []).map((s) => s.id),
-          remote: t
-        } }
-      ] : [a, { type: "review.thread.created", data: { threadId: e.t.id, remote: t } }];
-    }
-    case "removeThread":
-      return [a, { type: "review.thread.removed", data: { threadId: e.id, remote: t } }];
-    case "addComment":
-      return [a, { type: "review.comment.added", data: {
-        threadId: e.threadId,
-        commentId: e.c.id,
-        authorId: e.c.author.id,
-        isReply: !0,
-        mentionedUserIds: (e.c.mentions ?? []).map((d) => d.id),
-        remote: t
-      } }];
-    case "removeComment":
-      return [a, { type: "review.comment.removed", data: { threadId: e.threadId, commentId: e.commentId, remote: t } }];
-    case "editComment":
-      return [a, { type: "review.comment.edited", data: {
-        threadId: e.threadId,
-        commentId: e.commentId,
-        mentionedUserIds: (e.mentions ?? []).map((d) => d.id),
-        newlyMentionedUserIds: e.newlyMentionedUserIds ?? [],
-        remote: t
-      } }];
-    case "deleteComment":
-      return [a, { type: "review.comment.deleted", data: {
-        threadId: e.threadId,
-        commentId: e.commentId,
-        deletedByUserId: e.deletedBy.id,
-        remote: t
-      } }];
-    case "setThreadStatus":
-      return [a, { type: "review.thread.status.changed", data: { threadId: e.threadId, status: e.status, remote: t } }];
-  }
-}
-export {
-  r as E,
-  n as a,
-  c as p
-};