@coldsmirk/inkstone-mongodb 0.25.0 → 0.26.1

package/dist/codemirror.d.ts

@@ -0,0 +1,26 @@
+import { _ as MongodbFilterAssist, m as MongodbAssist, t as MongodbMarker } from "./markers-DjjkoOJP.js";
+import { CompletionSource } from "@codemirror/autocomplete";
+import { Diagnostic } from "@codemirror/lint";
+import { Extension } from "@codemirror/state";
+//#region src/codemirror.d.ts
+/**
+ * Completion over a whole command document, off an assist built with the host's catalog.
+ */
+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;
+/**
+ * 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;
+/**
+ * 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 };

package/dist/codemirror.js

@@ -0,0 +1,61 @@
+import { snippet } from "@codemirror/autocomplete";
+import { hoverTooltip } from "@codemirror/view";
+//#region src/codemirror.ts
+const TYPES = {
+	command: "keyword",
+	field: "property",
+	operator: "function",
+	stage: "function",
+	collection: "class",
+	database: "namespace"
+};
+function completion(candidate, at) {
+	return {
+		label: candidate.label,
+		type: TYPES[candidate.kind],
+		detail: candidate.detail,
+		info: candidate.documentation,
+		boost: -candidate.sortGroup * 10 - at / 1e3,
+		apply: candidate.snippet === true ? snippet(candidate.insertText) : candidate.insertText
+	};
+}
+function resultOf(candidates, pos) {
+	const first = candidates[0];
+	if (first === void 0) return null;
+	return {
+		from: pos - first.replace,
+		options: candidates.map((candidate, at) => completion(candidate, at)),
+		validFor: /^[\w.$-]*$/
+	};
+}
+function mongodbCompletion(assist) {
+	return (context) => resultOf(assist.complete(context.state.doc.toString(), context.pos), context.pos);
+}
+function mongodbFilterCompletion(assist) {
+	return (context) => resultOf(assist.complete(context.state.doc.toString(), context.pos), context.pos);
+}
+function mongodbHover(assist, render) {
+	return hoverTooltip((view, pos) => {
+		const card = assist.hover(view.state.doc.toString(), pos);
+		if (card === null) return null;
+		return {
+			pos: card.from,
+			end: card.to,
+			create: () => {
+				return { dom: render(card.markdown) };
+			}
+		};
+	});
+}
+function mongodbDiagnostics(markers, wording) {
+	return markers.map((marker) => {
+		return {
+			from: marker.from,
+			to: marker.to,
+			severity: marker.severity === "error" ? "error" : "info",
+			message: wording(marker)
+		};
+	});
+}
+//#endregion
+export { mongodbCompletion, mongodbDiagnostics, mongodbFilterCompletion, mongodbHover };

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-import { C as PUSH_MODIFIERS, D as keysAt, E as UPDATE_OPERATORS, S as MongoCommand, T as STAGES, _ as MongodbHoverCard, a as CaretContext, b as FIELD_OPERATORS, c as LITERALS, d as readDocument, f as runnableDocument, g as MongodbCompletionCandidate, h as MongodbCatalog, i as CONSTRUCTORS, l as RunnableDocument, m as MongodbAssist, n as MongodbMarkerCode, o as DocumentRead, p as CatalogCollection, r as documentMarkers, s as DocumentRefusal, t as MongodbMarker, u as caretContext, v as createMongodbAssist, w as QUERY_OPERATORS, x as MONGO_COMMANDS, y as EXPRESSION_OPERATORS } from "./markers-CQOm7diu.js";
-export { CONSTRUCTORS, type CaretContext, type CatalogCollection, type DocumentRead, type DocumentRefusal, EXPRESSION_OPERATORS, FIELD_OPERATORS, LITERALS, MONGO_COMMANDS, type MongoCommand, type MongodbAssist, type MongodbCatalog, type MongodbCompletionCandidate, type MongodbHoverCard, type MongodbMarker, type MongodbMarkerCode, PUSH_MODIFIERS, QUERY_OPERATORS, type RunnableDocument, STAGES, UPDATE_OPERATORS, caretContext, createMongodbAssist, documentMarkers, keysAt, readDocument, runnableDocument };
+import { A as keysAt, C as MONGO_COMMANDS, D as QUERY_OPERATORS, E as QUERY_HOLDERS, O as STAGES, S as FIELD_OPERATORS, T as PUSH_MODIFIERS, _ as MongodbFilterAssist, a as CaretContext, b as createMongodbFilterAssist, c as LITERALS, d as readDocument, f as runnableDocument, g as MongodbCompletionCandidate, h as MongodbCatalog, i as CONSTRUCTORS, k as UPDATE_OPERATORS, l as RunnableDocument, m as MongodbAssist, n as MongodbMarkerCode, o as DocumentRead, p as CatalogCollection, r as documentMarkers, s as DocumentRefusal, t as MongodbMarker, u as caretContext, v as MongodbHoverCard, w as MongoCommand, x as EXPRESSION_OPERATORS, y as createMongodbAssist } from "./markers-DjjkoOJP.js";
+export { CONSTRUCTORS, type CaretContext, type CatalogCollection, type DocumentRead, type DocumentRefusal, EXPRESSION_OPERATORS, FIELD_OPERATORS, LITERALS, MONGO_COMMANDS, type MongoCommand, type MongodbAssist, type MongodbCatalog, type MongodbCompletionCandidate, type MongodbFilterAssist, type MongodbHoverCard, type MongodbMarker, type MongodbMarkerCode, PUSH_MODIFIERS, QUERY_HOLDERS, QUERY_OPERATORS, type RunnableDocument, STAGES, UPDATE_OPERATORS, caretContext, createMongodbAssist, createMongodbFilterAssist, documentMarkers, keysAt, readDocument, runnableDocument };

package/dist/index.js

@@ -1,7 +1,26 @@
-import { a as PUSH_MODIFIERS, c as UPDATE_OPERATORS, i as MONGO_COMMANDS, l as keysAt, n as EXPRESSION_OPERATORS, o as QUERY_OPERATORS, r as FIELD_OPERATORS, s as STAGES, t as documentMarkers } from "./markers-Bdvbut2O.js";
+import { a as PUSH_MODIFIERS, c as STAGES, i as MONGO_COMMANDS, l as UPDATE_OPERATORS, n as EXPRESSION_OPERATORS, o as QUERY_HOLDERS, r as FIELD_OPERATORS, s as QUERY_OPERATORS, t as documentMarkers, u as keysAt } from "./markers-CbwviTiD.js";
 import { a as runnableDocument, i as readDocument, n as LITERALS, r as caretContext, t as CONSTRUCTORS } from "./document-CVB9YunA.js";
 //#region src/assist.ts
 const NO_CATALOG = { collections: () => [] };
+function createMongodbFilterAssist(fields = () => []) {
+	return { complete: (filter, offset) => {
+		const context = caretContext(filter, offset);
+		if (context.kind !== "key") return [];
+		const under = context.path.at(-1);
+		const named = under === void 0 || QUERY_HOLDERS.has(under) ? fields().filter((field) => !context.siblings.includes(field)) : [];
+		const keys = keysAt(["filter", ...context.path], context.siblings);
+		return [...named, ...keys].map((key) => {
+			return {
+				label: key,
+				kind: key.startsWith("$") ? "operator" : "field",
+				insertText: context.quoted ? key : `"${key}": $0`,
+				...!context.quoted && { snippet: true },
+				replace: context.typed.length,
+				sortGroup: key.startsWith("$") ? 1 : 0
+			};
+		});
+	} };
+}
 function documentationOf(command) {
 	return command.fields.length === 0 ? command.summary : `${command.summary}\n\nFields: ${command.fields.join(", ")}`;
 }
@@ -87,4 +106,4 @@ function createMongodbAssist(catalog = NO_CATALOG, commands = MONGO_COMMANDS) {
 	};
 }
 //#endregion
-export { CONSTRUCTORS, EXPRESSION_OPERATORS, FIELD_OPERATORS, LITERALS, MONGO_COMMANDS, PUSH_MODIFIERS, QUERY_OPERATORS, STAGES, UPDATE_OPERATORS, caretContext, createMongodbAssist, documentMarkers, keysAt, readDocument, runnableDocument };
+export { CONSTRUCTORS, EXPRESSION_OPERATORS, FIELD_OPERATORS, LITERALS, MONGO_COMMANDS, PUSH_MODIFIERS, QUERY_HOLDERS, QUERY_OPERATORS, STAGES, UPDATE_OPERATORS, caretContext, createMongodbAssist, createMongodbFilterAssist, documentMarkers, keysAt, readDocument, runnableDocument };

package/dist/{markers-Bdvbut2O.js → markers-CbwviTiD.js}

@@ -1020,4 +1020,4 @@ function documentMarkers(text, commands = MONGO_COMMANDS) {
 	return [];
 }
 //#endregion
-export { PUSH_MODIFIERS as a, UPDATE_OPERATORS as c, MONGO_COMMANDS as i, keysAt as l, EXPRESSION_OPERATORS as n, QUERY_OPERATORS as o, FIELD_OPERATORS as r, STAGES as s, documentMarkers as t };
+export { PUSH_MODIFIERS as a, STAGES as c, MONGO_COMMANDS as i, UPDATE_OPERATORS as l, EXPRESSION_OPERATORS as n, QUERY_HOLDERS as o, FIELD_OPERATORS as r, QUERY_OPERATORS as s, documentMarkers as t, keysAt as u };

package/dist/{markers-CQOm7diu.d.ts → markers-DjjkoOJP.d.ts}

@@ -28,6 +28,16 @@ declare const UPDATE_OPERATORS: string[];
 declare const PUSH_MODIFIERS: string[];
 declare const STAGES: string[];
 declare const EXPRESSION_OPERATORS: string[];
+/**
+ * The keys whose value is a query: a filter, and every logical operator's branches.
+ */
+/**
+ * The keys whose value is a query document: what is under one is a field name or a logical
+ * operator, and what is under a *field* of one is a comparison operator. Exported because a
+ * filter can also stand on its own, with no key above it to say so
+ * (`createMongodbFilterAssist`).
+ */
+declare const QUERY_HOLDERS: Set<string>;
 /**
  * The keys to offer at a key position, by the keys enclosing the caret and — at the top level
  * — the keys already there, the first of which names the command. Empty where the names are
@@ -80,6 +90,27 @@ interface MongodbAssist {
   complete: (text: string, offset: number) => MongodbCompletionCandidate[];
   hover: (text: string, offset: number) => MongodbHoverCard | null;
 }
+/**
+ * Completion for a query document standing on its own, with no command around it to say what
+ * it is the filter of — a filter typed into a one-line field, which is how a console browses
+ * a collection without a command written out.
+ */
+interface MongodbFilterAssist {
+  complete: (filter: string, offset: number) => MongodbCompletionCandidate[];
+}
+/**
+ * The query vocabulary alone, for a surface that holds a filter and nothing else.
+ *
+ * The document is read as though it were the value of a `filter` key, which it is in every
+ * command that takes one: `keysAt` then answers a filter's own vocabulary at every depth —
+ * the logical operators at the top, a field's comparison operators inside it — with nothing
+ * about a filter restated here.
+ *
+ * `fields` is the collection's own, which the package cannot know and the host can: they go
+ * first, and only where a field name is what belongs — under a query holder, never inside
+ * the operator object of a field.
+ */
+declare function createMongodbFilterAssist(fields?: () => readonly string[]): MongodbFilterAssist;
 /**
  * Completion for keys and for the values that name a collection or a database, hover for the
  * command under its key — all reading the document through `document.ts`.
@@ -215,4 +246,4 @@ interface MongodbMarker {
  */
 declare function documentMarkers(text: string, commands?: readonly MongoCommand[]): MongodbMarker[];
 //#endregion
-export { PUSH_MODIFIERS as C, keysAt as D, UPDATE_OPERATORS as E, MongoCommand as S, STAGES as T, MongodbHoverCard as _, CaretContext as a, FIELD_OPERATORS as b, LITERALS as c, readDocument as d, runnableDocument as f, MongodbCompletionCandidate as g, MongodbCatalog as h, CONSTRUCTORS as i, RunnableDocument as l, MongodbAssist as m, MongodbMarkerCode as n, DocumentRead as o, CatalogCollection as p, documentMarkers as r, DocumentRefusal as s, MongodbMarker as t, caretContext as u, createMongodbAssist as v, QUERY_OPERATORS as w, MONGO_COMMANDS as x, EXPRESSION_OPERATORS as y };
+export { keysAt as A, MONGO_COMMANDS as C, QUERY_OPERATORS as D, QUERY_HOLDERS as E, STAGES as O, FIELD_OPERATORS as S, PUSH_MODIFIERS as T, MongodbFilterAssist as _, CaretContext as a, createMongodbFilterAssist as b, LITERALS as c, readDocument as d, runnableDocument as f, MongodbCompletionCandidate as g, MongodbCatalog as h, CONSTRUCTORS as i, UPDATE_OPERATORS as k, RunnableDocument as l, MongodbAssist as m, MongodbMarkerCode as n, DocumentRead as o, CatalogCollection as p, documentMarkers as r, DocumentRefusal as s, MongodbMarker as t, caretContext as u, MongodbHoverCard as v, MongoCommand as w, EXPRESSION_OPERATORS as x, createMongodbAssist as y };

package/dist/monaco.d.ts

@@ -1,4 +1,4 @@
-import { m as MongodbAssist, t as MongodbMarker } from "./markers-CQOm7diu.js";
+import { m as MongodbAssist, t as MongodbMarker } from "./markers-DjjkoOJP.js";
 import * as monacoEditor from "monaco-editor";
 import { IDisposable, editor } from "monaco-editor";
 //#region src/monaco.d.ts

package/dist/react.d.ts

@@ -1,4 +1,4 @@
-import { m as MongodbAssist, t as MongodbMarker } from "./markers-CQOm7diu.js";
+import { m as MongodbAssist, t as MongodbMarker } from "./markers-DjjkoOJP.js";
 import { MonacoModule } from "./monaco.js";
 import { ReactNode } from "react";
 import { editor } from "monaco-editor";

package/dist/react.js

@@ -1,4 +1,4 @@
-import { t as documentMarkers } from "./markers-Bdvbut2O.js";
+import { t as documentMarkers } from "./markers-CbwviTiD.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";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coldsmirk/inkstone-mongodb",
-  "version": "0.25.0",
+  "version": "0.26.1",
   "description": "MongoDB command editing intelligence for Monaco: a command document in the shell's own spelling, the database commands and their fields, query, update and aggregation operators by context, collection completion, markers, and a drop-in React command editor.",
   "keywords": [
     "mongodb",
@@ -28,32 +28,56 @@
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
+    "./codemirror": {
+      "types": "./dist/codemirror.d.ts",
+      "default": "./dist/codemirror.js"
+    },
     "./monaco": {
       "types": "./dist/monaco.d.ts",
       "default": "./dist/monaco.js"
     },
+    "./package.json": "./package.json",
     "./react": {
       "types": "./dist/react.d.ts",
       "default": "./dist/react.js"
-    },
-    "./package.json": "./package.json"
+    }
   },
   "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
   "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.25.0"
+    "@coldsmirk/inkstone-react": "^0.26.1"
   },
   "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",
     "react": ">=19",
-    "@coldsmirk/inkstone-react": "^0.25.0"
+    "@coldsmirk/inkstone-react": "^0.26.1"
   },
   "peerDependenciesMeta": {
+    "@codemirror/autocomplete": {
+      "optional": true
+    },
+    "@codemirror/lint": {
+      "optional": true
+    },
+    "@codemirror/state": {
+      "optional": true
+    },
+    "@codemirror/view": {
+      "optional": true
+    },
     "@coldsmirk/inkstone-react": {
       "optional": true
     },