@coldsmirk/inkstone-mongodb 0.30.0 → 0.32.0

package/README.md

@@ -9,7 +9,7 @@ Part of [inkstone](https://github.com/coldsmirk/inkstone). Built for the [**poly
 - **`@coldsmirk/inkstone-mongodb`** — the framework-free core: the document reader, the command table, the operator vocabularies, the assist, the markers. Zero editor dependencies.
 - **`@coldsmirk/inkstone-mongodb/monaco`** — `defineMongodbLanguage(monaco)` (the `mongodb` id with its Monarch grammar, once per monaco module), `registerMongodbLanguage(monaco, modelPath, hooks)` (completion and hover for one model), `setMongodbMarkers`. Peer: `monaco-editor`.
 - **`@coldsmirk/inkstone-mongodb/codemirror`** — the same assist bound to CodeMirror 6: `mongodbCompletion(assist)` and `mongodbFilterCompletion(assist)` (completion sources), `mongodbHover(assist, wording)`, `mongodbDiagnostics(markers, wording)`. No grammar of its own — a filter document is JSON, so pair it with `@codemirror/lang-json`; it does not close brackets or quotes either, so add `closeBrackets()` where a key's own quotes matter. Peers: `@codemirror/autocomplete`, `@codemirror/view`.
-- **`@coldsmirk/inkstone-mongodb/react`** — `<MongodbEditor>`: a controlled command editor built on `@coldsmirk/inkstone-react`'s `<MonacoEditor>`, with a run key (Ctrl/Cmd-Enter handing over the live caret), caret tracking, an insert handle for collection trees, and the markers refreshed on every change. Peers: `monaco-editor`, `react`.
+- **`@coldsmirk/inkstone-mongodb/react`** — `<MongodbEditor>`: a controlled command editor built on `@coldsmirk/inkstone-react`'s `<MonacoConsoleEditor>`, with a run key (Ctrl/Cmd-Enter handing over the live caret), caret tracking, an insert handle for collection trees, and the markers refreshed on every change. Peers: `monaco-editor`, `react`.
 
 ## The shape
 

package/dist/codemirror.d.ts

@@ -6,21 +6,20 @@ import { Extension } from "@codemirror/state";
 /**
  * Completion over a whole command document, off an assist built with the host's catalog.
  */
-declare function mongodbCompletion(assist: MongodbAssist): CompletionSource;
+export declare function mongodbCompletion(assist: MongodbAssist): CompletionSource;
 /**
  * Completion over a query document standing on its own — a one-line filter field, whose
  * document is the filter and nothing else (`createMongodbFilterAssist`).
  */
-declare function mongodbFilterCompletion(assist: MongodbFilterAssist): CompletionSource;
+export declare function mongodbFilterCompletion(assist: MongodbFilterAssist): CompletionSource;
 /**
  * The command's card under the pointer, as `./monaco`'s hover provider gives it. The markdown
  * is handed over as text: rendering it is the host's, since a tooltip's DOM is the host's
  * design and this package ships none.
  */
-declare function mongodbHover(assist: MongodbAssist, render: (markdown: string[]) => HTMLElement): Extension;
+export declare function mongodbHover(assist: MongodbAssist, render: (markdown: string[]) => HTMLElement): Extension;
 /**
  * This package's markers as CodeMirror's diagnostics, the words beside each code the host's.
  */
-declare function mongodbDiagnostics(markers: readonly MongodbMarker[], wording: (marker: MongodbMarker) => string): Diagnostic[];
-//#endregion
-export { mongodbCompletion, mongodbDiagnostics, mongodbFilterCompletion, mongodbHover };
+export declare function mongodbDiagnostics(markers: readonly MongodbMarker[], wording: (marker: MongodbMarker) => string): Diagnostic[];
+//#endregion

package/dist/monaco.d.ts

@@ -5,17 +5,17 @@ import { IDisposable, editor } from "monaco-editor";
 /**
  * The monaco module itself, as `onMount` hands it over.
  */
-type MonacoModule = typeof monacoEditor;
+export type MonacoModule = typeof monacoEditor;
 /**
  * The language id the editor registers a command document under.
  */
-declare const MONGODB_LANGUAGE_ID = "mongodb";
+export declare const MONGODB_LANGUAGE_ID = "mongodb";
 /**
  * Register the language — the id, its Monarch grammar and its bracket configuration — once per
  * monaco module. Call it before the first model of the language is created (`beforeMount`).
  */
-declare function defineMongodbLanguage(monaco: MonacoModule, languageId?: string): void;
-interface MongodbLanguageHooks {
+export declare function defineMongodbLanguage(monaco: MonacoModule, languageId?: string): void;
+export interface MongodbLanguageHooks {
   /**
    * The assist as it stands right now — read per request rather than captured, so the host
    * can swap it without touching Monaco's registry; null answers nothing.
@@ -26,15 +26,14 @@ interface MongodbLanguageHooks {
  * Register completion and hover for one model. The disposables are the caller's to hold:
  * Monaco's registry outlives any editor.
  */
-declare function registerMongodbLanguage(monaco: MonacoModule, modelPath: string, hooks: MongodbLanguageHooks, languageId?: string): IDisposable[];
+export declare function registerMongodbLanguage(monaco: MonacoModule, modelPath: string, hooks: MongodbLanguageHooks, languageId?: string): IDisposable[];
 /**
  * The owner Monaco files this package's markers under.
  */
-declare const MONGODB_MARKER_OWNER = "inkstone-mongodb";
+export declare const MONGODB_MARKER_OWNER = "inkstone-mongodb";
 /**
  * Put `markers` on the model as Monaco's own, replacing this package's last set; the words
  * beside each code are the host's, handed in per code.
  */
-declare function setMongodbMarkers(monaco: MonacoModule, model: editor.ITextModel, markers: readonly MongodbMarker[], wording: (marker: MongodbMarker) => string): void;
-//#endregion
-export { MONGODB_LANGUAGE_ID, MONGODB_MARKER_OWNER, MonacoModule, MongodbLanguageHooks, defineMongodbLanguage, registerMongodbLanguage, setMongodbMarkers };
+export declare function setMongodbMarkers(monaco: MonacoModule, model: editor.ITextModel, markers: readonly MongodbMarker[], wording: (marker: MongodbMarker) => string): void;
+//#endregion

package/dist/react.d.ts

@@ -1,78 +1,30 @@
 import { m as MongodbAssist, t as MongodbMarker } from "./markers-Co8ntyUI.js";
-import { MonacoModule } from "./monaco.js";
+import { ConsoleCaret, ConsoleEditorHandle, ConsoleEditorProps } from "@coldsmirk/inkstone-react/monaco";
 import { ReactNode } from "react";
-import { editor } from "monaco-editor";
 //#region src/react.d.ts
 /**
  * What a host reaches into the editor for: inserting at the caret — a collection tree is an
  * input device — and the focus.
  */
-interface MongodbEditorHandle {
-  insert: (text: string) => void;
-  focus: () => void;
-}
+export type MongodbEditorHandle = ConsoleEditorHandle;
 /**
  * Where the operator is in the document, in offsets — what `runnableDocument` reads to decide
- * what a run sends. `from` and `to` are the selection's bounds and equal where nothing is
- * selected; the text rides with them because the two must belong to the same instant.
+ * what a run sends.
  */
-interface MongodbCaret {
-  text: string;
-  from: number;
-  to: number;
-}
-interface MongodbEditorProps {
-  value: string;
-  onChange: (value: string) => void;
-  /**
-   * Render with the dark theme; the component never reads the OS `prefers-color-scheme`.
-   *
-   * @default false
-   */
-  dark?: boolean;
-  /**
-   * Editor height in px, or `"fill"` to consume the parent's resolved height (the parent must be
-   * a `min-height: 0` flex item).
-   */
-  height?: number | "fill";
-  fontSize?: number;
-  /**
-   * UI locale for Monaco's chrome — page-global and locked by the first editor to mount.
-   */
-  locale?: "en" | "zh-cn";
-  placeholder?: string;
-  /**
-   * The editor's accessible name, set on Monaco's own input surface.
-   */
-  ariaLabel: string;
+export type MongodbCaret = ConsoleCaret;
+export interface MongodbEditorProps extends ConsoleEditorProps<MongodbEditorHandle> {
   /**
    * The Monaco language id the model registers under; the grammar is defined under it.
    *
    * @default "mongodb"
    */
   languageId?: string;
-  loading?: ReactNode;
-  failure?: ReactNode;
-  /**
-   * Ctrl/Cmd-Enter — the run key, handed the editor's live caret; the host reads the document
-   * to send off it with `runnableDocument`.
-   */
-  onRun?: (caret: MongodbCaret) => void;
   /**
    * The label the run action shows in Monaco's own chrome.
    *
    * @default "Run command"
    */
   runActionLabel?: string;
-  /**
-   * The caret moved, or the text under it changed.
-   */
-  onCaret?: (caret: MongodbCaret) => void;
-  onReady?: (handle: MongodbEditorHandle) => void;
-  /**
-   * Runs after this component's own mount wiring, with the live editor and the monaco module.
-   */
-  onMount?: (instance: editor.IStandaloneCodeEditor, monaco: MonacoModule) => void;
   /**
    * What completion and hover answer from; neither without it.
    */
@@ -82,19 +34,12 @@ interface MongodbEditorProps {
    * markers are drawn without it.
    */
   markerWording?: (marker: MongodbMarker) => string;
-  /**
-   * Extra construction options, merged under this editor's own (`ariaLabel`): the escape hatch
-   * a host reaches for a construction option no prop names — `overflowWidgetsDomNode`, where
-   * the page's own layers would otherwise stand over the editor's floating widgets (hover,
-   * completion, parameter hints) left inside it.
-   */
-  options?: editor.IStandaloneEditorConstructionOptions;
 }
 /**
- * The command editing surface: Monaco under the `mongodb` grammar, one command document in the
- * shell's spelling, the run key handing the caret over, completion and hover wired through
- * `registerMongodbLanguage`, and the markers refreshed on every change.
+ * The command editing surface: `<MonacoConsoleEditor>` under the `mongodb` grammar, one command
+ * document in the shell's spelling, the run key handing the caret over (`runnableDocument` reads
+ * what to send off it), completion and hover wired through `registerMongodbLanguage`, and the
+ * markers refreshed on every change.
  */
-declare function MongodbEditor({ value, onChange, dark, height, fontSize, locale, placeholder, ariaLabel, languageId, loading, failure, onRun, runActionLabel, onCaret, onReady, onMount, assist, markerWording, options }: MongodbEditorProps): import("react").JSX.Element;
-//#endregion
-export { MongodbCaret, MongodbEditor, MongodbEditorHandle, MongodbEditorProps };
+export declare function MongodbEditor({ languageId, runActionLabel, assist, markerWording, ...props }: MongodbEditorProps): ReactNode;
+//#endregion

package/dist/react.js

@@ -1,106 +1,32 @@
 import { t as documentMarkers } from "./markers-30Z4EFiH.js";
 import { MONGODB_LANGUAGE_ID, defineMongodbLanguage, registerMongodbLanguage, setMongodbMarkers } from "./monaco.js";
-import { MonacoEditor } from "@coldsmirk/inkstone-react/monaco";
-import { useEffect, useInsertionEffect, useRef, useState } from "react";
+import { MonacoConsoleEditor } from "@coldsmirk/inkstone-react/monaco";
 import { jsx } from "react/jsx-runtime";
 //#region src/react.tsx
-const EDITOR_ID_KEY = Symbol.for("coldsmirk.inkstone.mongodb.editorId");
-function nextEditorId() {
-	const holder = globalThis;
-	const id = holder[EDITOR_ID_KEY] ?? 0;
-	holder[EDITOR_ID_KEY] = id + 1;
-	return id;
-}
-function useLatest(value) {
-	const ref = useRef(value);
-	useInsertionEffect(() => {
-		ref.current = value;
-	});
-	return ref;
-}
-function caretOf(instance) {
-	const model = instance.getModel();
-	const selection = instance.getSelection();
-	if (model === null || selection === null) return {
-		text: "",
-		from: 0,
-		to: 0
-	};
-	return {
-		text: model.getValue(),
-		from: model.getOffsetAt(selection.getStartPosition()),
-		to: model.getOffsetAt(selection.getEndPosition())
-	};
-}
-function MongodbEditor({ value, onChange, dark = false, height = 200, fontSize, locale, placeholder, ariaLabel, languageId = MONGODB_LANGUAGE_ID, loading, failure, onRun, runActionLabel = "Run command", onCaret, onReady, onMount, assist, markerWording, options }) {
-	const [modelPath] = useState(() => `file:///inkstone-mongodb/${String(nextEditorId())}.mongodb`);
-	const bindings = useRef([]);
-	const assistRef = useLatest(assist ?? null);
-	const runRef = useLatest(onRun);
-	const caretChangedRef = useLatest(onCaret);
-	const readyRef = useLatest(onReady);
-	const mountRef = useLatest(onMount);
-	const wordingRef = useLatest(markerWording);
-	useEffect(() => () => {
-		for (const binding of bindings.current) binding.dispose();
-		bindings.current = [];
-	}, []);
-	const fill = height === "fill";
-	return /* @__PURE__ */ jsx("div", {
-		style: fill ? {
-			height: "100%",
-			minHeight: 0
-		} : { height },
-		children: /* @__PURE__ */ jsx(MonacoEditor, {
-			showLineNumbers: true,
-			dark,
-			failure,
-			fontSize,
-			height: fill ? "100%" : height,
-			language: languageId,
-			loading,
-			locale,
-			options: {
-				...options,
-				ariaLabel
-			},
-			path: modelPath,
-			placeholder,
-			value,
-			beforeMount: (monaco) => {
-				defineMongodbLanguage(monaco, languageId);
-			},
-			onChange,
-			onMount: (live, monaco) => {
-				const mark = () => {
-					const model = live.getModel();
-					const wording = wordingRef.current;
-					if (model !== null && wording !== void 0) setMongodbMarkers(monaco, model, documentMarkers(model.getValue()), wording);
-				};
-				bindings.current.push(live.onDidChangeCursorSelection(() => caretChangedRef.current?.(caretOf(live))), live.onDidChangeModelContent(mark), live.addAction({
-					id: "inkstone-mongodb.run",
-					label: runActionLabel,
-					keybindings: [monaco.KeyMod.CtrlCmd | monaco.KeyCode.Enter],
-					run: (current) => runRef.current?.(caretOf(current))
-				}), ...registerMongodbLanguage(monaco, modelPath, { assist: () => assistRef.current }, languageId));
-				mark();
-				readyRef.current?.({
-					insert: (text) => {
-						const selection = live.getSelection();
-						if (selection) live.executeEdits("inkstone-mongodb-insert", [{
-							range: selection,
-							text,
-							forceMoveMarkers: true
-						}]);
-						live.focus();
-					},
-					focus: () => {
-						live.focus();
-					}
-				});
-				mountRef.current?.(live, monaco);
-			}
-		})
+function MongodbEditor({ languageId = MONGODB_LANGUAGE_ID, runActionLabel = "Run command", assist, markerWording, ...props }) {
+	return /* @__PURE__ */ jsx(MonacoConsoleEditor, {
+		...props,
+		context: {
+			assist,
+			markerWording
+		},
+		extension: "mongodb",
+		language: languageId,
+		namespace: "inkstone-mongodb",
+		runActionLabel,
+		beforeMount: (monaco) => {
+			defineMongodbLanguage(monaco, languageId);
+		},
+		register: ({ monaco, editor, path, context }) => {
+			const mark = () => {
+				const model = editor.getModel();
+				const wording = context().markerWording;
+				if (model !== null && wording !== void 0) setMongodbMarkers(monaco, model, documentMarkers(model.getValue()), wording);
+			};
+			const registered = [editor.onDidChangeModelContent(mark), ...registerMongodbLanguage(monaco, path, { assist: () => context().assist ?? null }, languageId)];
+			mark();
+			return registered;
+		}
 	});
 }
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coldsmirk/inkstone-mongodb",
-  "version": "0.30.0",
+  "version": "0.32.0",
   "description": "MongoDB command editing intelligence for Monaco and CodeMirror: a command document in the shell's own spelling, the database commands and their fields, query, update and aggregation operators by context — a bare filter document included — collection completion, markers, and a drop-in React command editor.",
   "keywords": [
     "mongodb",
@@ -50,21 +50,20 @@
   "devDependencies": {
     "@codemirror/autocomplete": "^6.20.3",
     "@codemirror/lint": "^6.9.7",
-    "@codemirror/state": "^6.6.0",
-    "@codemirror/view": "^6.43.0",
-    "monaco-editor": "^0.56.0",
-    "react": "^19.2.8",
-    "react-dom": "^19.2.8",
-    "@coldsmirk/inkstone-react": "^0.30.0"
+    "@codemirror/state": "^6.7.6",
+    "@codemirror/view": "^6.43.14",
+    "monaco-editor": "^0.57.0",
+    "react": "^19.3.0",
+    "@coldsmirk/inkstone-react": "^0.32.0"
   },
   "peerDependencies": {
     "@codemirror/autocomplete": "^6.20.3",
     "@codemirror/lint": "^6.9.7",
     "@codemirror/state": "^6.6.0",
     "@codemirror/view": "^6.43.0",
-    "monaco-editor": "^0.56.0",
+    "monaco-editor": "^0.57.0",
     "react": ">=19",
-    "@coldsmirk/inkstone-react": "^0.30.0"
+    "@coldsmirk/inkstone-react": "^0.32.0"
   },
   "peerDependenciesMeta": {
     "@codemirror/autocomplete": {