@stll/folio-core 0.55.0 → 0.57.0

package/dist/controller/canonicalInputTimer.d.ts

@@ -0,0 +1,16 @@
+import { EditorView } from "prosemirror-view";
+//#region src/controller/canonicalInputTimer.d.ts
+/** Shared by timer producers and browser diagnostics, regardless of bundling. */
+declare const CANONICAL_INPUT_TIMER_OWNER = "folio.canonical-input-timer";
+/** Delay after native composition end before the canonical session settles it. */
+declare const CANONICAL_COMPOSITION_FLUSH_DELAY_MS = 25;
+/** Mark the scheduled wrapper, never the caller's potentially shared callback. */
+declare const setCanonicalInputTimer: (callback: () => void, delay: number) => NodeJS.Timeout;
+/**
+ * Run `retry` once the view's canonical composition has settled. The session
+ * settles on an equal-delay timer armed at native composition end, so a retry
+ * armed at or after that point runs after it. Returns a disposer.
+ */
+declare const afterCanonicalCompositionSettles: (view: EditorView, retry: () => void) => (() => void);
+//#endregion
+export { CANONICAL_COMPOSITION_FLUSH_DELAY_MS, CANONICAL_INPUT_TIMER_OWNER, afterCanonicalCompositionSettles, setCanonicalInputTimer };

package/dist/controller/canonicalInputTimer.js

@@ -0,0 +1,34 @@
+//#region src/controller/canonicalInputTimer.ts
+/** Shared by timer producers and browser diagnostics, regardless of bundling. */
+const CANONICAL_INPUT_TIMER_OWNER = "folio.canonical-input-timer";
+/** Delay after native composition end before the canonical session settles it. */
+const CANONICAL_COMPOSITION_FLUSH_DELAY_MS = 25;
+/** Mark the scheduled wrapper, never the caller's potentially shared callback. */
+const setCanonicalInputTimer = (callback, delay) => {
+	const ownedCallback = () => callback();
+	Object.defineProperty(ownedCallback, Symbol.for(CANONICAL_INPUT_TIMER_OWNER), { value: true });
+	return setTimeout(ownedCallback, delay);
+};
+/**
+* Run `retry` once the view's canonical composition has settled. The session
+* settles on an equal-delay timer armed at native composition end, so a retry
+* armed at or after that point runs after it. Returns a disposer.
+*/
+const afterCanonicalCompositionSettles = (view, retry) => {
+	let timer;
+	const schedule = () => {
+		timer = setCanonicalInputTimer(retry, 25);
+	};
+	const onEnd = () => {
+		view.dom.removeEventListener("compositionend", onEnd);
+		schedule();
+	};
+	if (view.composing) view.dom.addEventListener("compositionend", onEnd);
+	else schedule();
+	return () => {
+		view.dom.removeEventListener("compositionend", onEnd);
+		if (timer !== void 0) clearTimeout(timer);
+	};
+};
+//#endregion
+export { CANONICAL_COMPOSITION_FLUSH_DELAY_MS, CANONICAL_INPUT_TIMER_OWNER, afterCanonicalCompositionSettles, setCanonicalInputTimer };

package/dist/controller/canonicalPublicOperations.d.ts

@@ -0,0 +1,48 @@
+import { ApplyFolioDocumentOperationsOptions, FolioDocumentOperationResult, FolioDocumentOperationUndoHandle, FolioDocumentOperationUndoResult } from "../document-operations.js";
+import { CanonicalCommit, CanonicalSession } from "./canonicalSession.js";
+import { EditorState } from "prosemirror-state";
+import { OpStory } from "@stll/docx-core/ops";
+//#region src/controller/canonicalPublicOperations.d.ts
+/** A new public kind cannot bypass a canonical compiler/refusal decision. */
+declare const CANONICAL_PUBLIC_OPERATION_DISPOSITIONS: {
+  readonly replaceInBlock: "compile";
+  readonly replaceRange: "compile";
+  readonly replaceBlock: "compile";
+  readonly splitBlock: "compile";
+  readonly formatRange: "compile";
+  readonly mergeBlockWithNext: "compile";
+  readonly setBlockParagraphProperties: "publicOps.unsupportedInline";
+  readonly insertAfterBlock: "publicOps.unsupportedInline";
+  readonly insertBeforeBlock: "publicOps.unsupportedInline";
+  readonly deleteBlock: "publicOps.unsupportedInline";
+  readonly commentOnBlock: "compile";
+  readonly commentOnRange: "compile";
+  readonly insertTable: "publicOps.tableProjection";
+  readonly insertSignatureTable: "publicOps.tableProjection";
+  readonly deleteTable: "publicOps.tableProjection";
+  readonly insertTableRow: "publicOps.tableProjection";
+  readonly deleteTableRow: "publicOps.tableProjection";
+  readonly insertTableColumn: "publicOps.tableProjection";
+  readonly deleteTableColumn: "publicOps.tableProjection";
+  readonly mergeTableCells: "publicOps.tableProjection";
+  readonly splitTableCell: "publicOps.tableProjection";
+};
+type CanonicalPublicOperationOptions = Omit<ApplyFolioDocumentOperationsOptions, "view" | "createUndoHandle" | "createCommentId">;
+type CanonicalPublicOperationsOptions = {
+  session: CanonicalSession;
+  getState: (story: OpStory) => EditorState | null;
+  publish: (commit: CanonicalCommit) => boolean;
+};
+/** Handles address isolated journal groups; no second document or PM history is retained. */
+declare class CanonicalPublicOperations {
+  private readonly options;
+  private readonly handles;
+  private nextHandle;
+  private readonly handleNamespace;
+  constructor(options: CanonicalPublicOperationsOptions);
+  apply(options: CanonicalPublicOperationOptions): FolioDocumentOperationResult;
+  undo(handle: FolioDocumentOperationUndoHandle): FolioDocumentOperationUndoResult;
+  private resolve;
+}
+//#endregion
+export { CANONICAL_PUBLIC_OPERATION_DISPOSITIONS, CanonicalPublicOperationOptions, CanonicalPublicOperations };