@coldsmirk/inkstone-elasticsearch 0.25.0 → 0.26.0

package/dist/codemirror.d.ts

@@ -0,0 +1,32 @@
+import { a as ElasticsearchAssist, o as ElasticsearchBodyAssist, t as ElasticsearchMarker } from "./markers-DnaVJoMY.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 request document, off an assist built with the host's catalog.
+ *
+ * Explicit or not: the list is asked for on `/`, on a quote and inside a word, the same three
+ * places `./monaco` names as trigger characters, and the engine half answers nothing where
+ * the caret is nowhere in particular.
+ */
+declare function elasticsearchCompletion(assist: ElasticsearchAssist): CompletionSource;
+/**
+ * Completion over a body standing on its own — a one-line filter field, whose document is a
+ * `query` object and nothing else (`createElasticsearchBodyAssist`).
+ */
+declare function elasticsearchBodyCompletion(assist: ElasticsearchBodyAssist): CompletionSource;
+/**
+ * The endpoint'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 elasticsearchHover(assist: ElasticsearchAssist, render: (markdown: string[]) => HTMLElement): Extension;
+/**
+ * This package's markers as CodeMirror's diagnostics, the words beside each code the host's,
+ * as `setElasticsearchMarkers` takes them.
+ */
+declare function elasticsearchDiagnostics(markers: readonly ElasticsearchMarker[], wording: (marker: ElasticsearchMarker) => string): Diagnostic[];
+//#endregion
+export { elasticsearchBodyCompletion, elasticsearchCompletion, elasticsearchDiagnostics, elasticsearchHover };

package/dist/codemirror.js

@@ -0,0 +1,60 @@
+import { snippet } from "@codemirror/autocomplete";
+import { hoverTooltip } from "@codemirror/view";
+//#region src/codemirror.ts
+const TYPES = {
+	method: "keyword",
+	endpoint: "namespace",
+	index: "class",
+	alias: "class",
+	key: "property"
+};
+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 elasticsearchCompletion(assist) {
+	return (context) => resultOf(assist.complete(context.state.doc.toString(), context.pos), context.pos);
+}
+function elasticsearchBodyCompletion(assist) {
+	return (context) => resultOf(assist.complete(context.state.doc.toString(), context.pos), context.pos);
+}
+function elasticsearchHover(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 elasticsearchDiagnostics(markers, wording) {
+	return markers.map((marker) => {
+		return {
+			from: marker.from,
+			to: marker.to,
+			severity: marker.severity === "error" ? "error" : marker.severity === "warning" ? "warning" : "info",
+			message: wording(marker)
+		};
+	});
+}
+//#endregion
+export { elasticsearchBodyCompletion, elasticsearchCompletion, elasticsearchDiagnostics, elasticsearchHover };

package/dist/index.d.ts

@@ -1,34 +1,2 @@
-import { _ as readRequest, a as ElasticsearchAssist, b as runnableRequest, c as ElasticsearchHoverCard, d as REQUEST_METHODS, f as RequestMethod, g as caretContext, h as RunnableRequest, i as CatalogIndex, l as createElasticsearchAssist, m as RequestRefusal, n as ElasticsearchMarkerCode, o as ElasticsearchCatalog, p as RequestRead, r as requestMarkers, s as ElasticsearchCompletionCandidate, t as ElasticsearchMarker, u as CaretContext, v as requestAt, x as takesLines, y as requestSpans } from "./markers-BctX905j.js";
-//#region src/api.d.ts
-/**
- * The vocabulary the assist offers: the REST endpoints a bench reaches for, and the keys of a
- * body by where the caret stands in it. Curated, not exhaustive — the console's own
- * completion is a hint of the API's shape, and the server's answer is the authority.
- */
-/**
- * One endpoint: its path with `{index}`, `{id}` and `{name}` for the parts the reader fills
- * in, the methods it takes, and one line on what it does.
- */
-interface ApiEndpoint {
-  path: string;
-  methods: RequestMethod[];
-  summary: string;
-}
-declare const API_ENDPOINTS: readonly ApiEndpoint[];
-/**
- * The endpoint a path names, `{…}` parts matching one segment each; null where none does.
- * The query string is not part of the match.
- */
-declare function endpointOf(path: string): ApiEndpoint | null;
-/**
- * What the request is for, read off its path — which decides the top-level keys of its body.
- */
-type BodyKind = "search" | "count" | "index" | "mapping" | "settings" | "document" | "update" | "update-by-query" | "reindex" | "aliases" | "analyze" | "sql" | "cluster-settings" | "template" | "explain" | "mget" | "other";
-declare function bodyKindOf(method: string, path: string): BodyKind;
-/**
- * The keys to offer at a key position in the body, by the request the body belongs to and the
- * keys enclosing the caret; empty where the names are the reader's own (a field, an aggregation).
- */
-declare function bodyKeys(kind: BodyKind, path: readonly string[]): string[];
-//#endregion
-export { API_ENDPOINTS, type ApiEndpoint, type BodyKind, type CaretContext, type CatalogIndex, type ElasticsearchAssist, type ElasticsearchCatalog, type ElasticsearchCompletionCandidate, type ElasticsearchHoverCard, type ElasticsearchMarker, type ElasticsearchMarkerCode, REQUEST_METHODS, type RequestMethod, type RequestRead, type RequestRefusal, type RunnableRequest, bodyKeys, bodyKindOf, caretContext, createElasticsearchAssist, endpointOf, readRequest, requestAt, requestMarkers, requestSpans, runnableRequest, takesLines };
+import { A as runnableRequest, C as RequestRefusal, D as readRequest, E as keyPosition, O as requestAt, S as RequestRead, T as caretContext, _ as endpointOf, a as ElasticsearchAssist, b as REQUEST_METHODS, c as ElasticsearchCompletionCandidate, d as createElasticsearchBodyAssist, f as API_ENDPOINTS, g as bodyKindOf, h as bodyKeys, i as CatalogIndex, j as takesLines, k as requestSpans, l as ElasticsearchHoverCard, m as BodyKind, n as ElasticsearchMarkerCode, o as ElasticsearchBodyAssist, p as ApiEndpoint, r as requestMarkers, s as ElasticsearchCatalog, t as ElasticsearchMarker, u as createElasticsearchAssist, v as CaretContext, w as RunnableRequest, x as RequestMethod, y as KeyPosition } from "./markers-DnaVJoMY.js";
+export { API_ENDPOINTS, type ApiEndpoint, type BodyKind, type CaretContext, type CatalogIndex, type ElasticsearchAssist, type ElasticsearchBodyAssist, type ElasticsearchCatalog, type ElasticsearchCompletionCandidate, type ElasticsearchHoverCard, type ElasticsearchMarker, type ElasticsearchMarkerCode, type KeyPosition, REQUEST_METHODS, type RequestMethod, type RequestRead, type RequestRefusal, type RunnableRequest, bodyKeys, bodyKindOf, caretContext, createElasticsearchAssist, createElasticsearchBodyAssist, endpointOf, keyPosition, readRequest, requestAt, requestMarkers, requestSpans, runnableRequest, takesLines };

package/dist/index.js

@@ -1,9 +1,31 @@
-import { a as requestAt, c as takesLines, d as bodyKindOf, f as endpointOf, i as readRequest, l as API_ENDPOINTS, n as REQUEST_METHODS, o as requestSpans, r as caretContext, s as runnableRequest, t as requestMarkers, u as bodyKeys } from "./markers-DBJshw-Y.js";
+import { a as readRequest, c as runnableRequest, d as bodyKeys, f as bodyKindOf, i as keyPosition, l as takesLines, n as REQUEST_METHODS, o as requestAt, p as endpointOf, r as caretContext, s as requestSpans, t as requestMarkers, u as API_ENDPOINTS } from "./markers-DwYWlWEq.js";
 //#region src/assist.ts
 const NO_CATALOG = { indices: () => [] };
+function createElasticsearchBodyAssist(kind) {
+	return { complete: (body, offset) => {
+		const at = keyPosition(body.slice(0, offset));
+		return at === null ? [] : keyCandidates(kind, at);
+	} };
+}
 function tailOf(endpoint, prefix) {
 	return endpoint.path.slice(prefix.length).replaceAll(/\/\{[^}]+\}/gu, "").replace(/^\//u, "");
 }
+function keyCandidates(kind, at) {
+	return bodyKeys(kind, at.path).map((key) => at.quoted ? {
+		label: key,
+		kind: "key",
+		insertText: key,
+		replace: at.typed.length,
+		sortGroup: 0
+	} : {
+		label: key,
+		kind: "key",
+		insertText: `"${key}": $0`,
+		snippet: true,
+		replace: 0,
+		sortGroup: 0
+	});
+}
 function endpointCandidate(endpoint, label, replace) {
 	return {
 		label,
@@ -59,23 +81,7 @@ function createElasticsearchAssist(catalog = NO_CATALOG) {
 					}
 					return [];
 				}
-				case "body-key": {
-					const kind = bodyKindOf(context.request.method, context.request.path);
-					return bodyKeys(kind, context.path).map((key) => context.quoted ? {
-						label: key,
-						kind: "key",
-						insertText: key,
-						replace: context.typed.length,
-						sortGroup: 0
-					} : {
-						label: key,
-						kind: "key",
-						insertText: `"${key}": $0`,
-						snippet: true,
-						replace: 0,
-						sortGroup: 0
-					});
-				}
+				case "body-key": return keyCandidates(bodyKindOf(context.request.method, context.request.path), context);
 				default: return [];
 			}
 		},
@@ -99,4 +105,4 @@ function createElasticsearchAssist(catalog = NO_CATALOG) {
 	};
 }
 //#endregion
-export { API_ENDPOINTS, REQUEST_METHODS, bodyKeys, bodyKindOf, caretContext, createElasticsearchAssist, endpointOf, readRequest, requestAt, requestMarkers, requestSpans, runnableRequest, takesLines };
+export { API_ENDPOINTS, REQUEST_METHODS, bodyKeys, bodyKindOf, caretContext, createElasticsearchAssist, createElasticsearchBodyAssist, endpointOf, keyPosition, readRequest, requestAt, requestMarkers, requestSpans, runnableRequest, takesLines };

package/dist/{markers-BctX905j.d.ts → markers-DnaVJoMY.d.ts}

@@ -127,6 +127,66 @@ type CaretContext = {
   kind: "none";
 };
 declare function caretContext(text: string, offset: number): CaretContext;
+/**
+ * A caret standing where an object's key goes: which keys enclose it, what of its own is
+ * typed, and whether a quote was opened for it.
+ */
+interface KeyPosition {
+  /**
+   * The keys of the objects enclosing the caret, outermost first, arrays passed through:
+   * `["query", "bool"]` inside the bool's own object.
+   */
+  path: string[];
+  /**
+   * The key's own characters typed before the caret.
+   */
+  typed: string;
+  /**
+   * Whether those characters are inside a quote the reader already opened — which decides
+   * whether a completion inserts the name alone or the whole `"key": ` around it.
+   */
+  quoted: boolean;
+}
+/**
+ * Whether the end of `body` — the text before the caret — is a key position in an object, and
+ * which keys enclose it. A light scan, not a parse: a body being typed is rarely valid JSON.
+ *
+ * Exported because a body is a surface of its own: a `query` object typed into a one-line
+ * field has no request line above it to be read with (`createElasticsearchBodyAssist`).
+ */
+declare function keyPosition(body: string): KeyPosition | null;
+//#endregion
+//#region src/api.d.ts
+/**
+ * The vocabulary the assist offers: the REST endpoints a bench reaches for, and the keys of a
+ * body by where the caret stands in it. Curated, not exhaustive — the console's own
+ * completion is a hint of the API's shape, and the server's answer is the authority.
+ */
+/**
+ * One endpoint: its path with `{index}`, `{id}` and `{name}` for the parts the reader fills
+ * in, the methods it takes, and one line on what it does.
+ */
+interface ApiEndpoint {
+  path: string;
+  methods: RequestMethod[];
+  summary: string;
+}
+declare const API_ENDPOINTS: readonly ApiEndpoint[];
+/**
+ * The endpoint a path names, `{…}` parts matching one segment each; null where none does.
+ * The query string is not part of the match.
+ */
+declare function endpointOf(path: string): ApiEndpoint | null;
+/**
+ * What the request is for, read off its path — which decides the top-level keys of its body.
+ */
+type BodyKind = "search" | "count" | "index" | "mapping" | "settings" | "document" | "update" | "update-by-query" | "reindex" | "aliases" | "analyze" | "sql" | "cluster-settings" | "template" | "explain" | "mget" | "other";
+declare function bodyKindOf(method: string, path: string): BodyKind;
+/**
+ * The keys to offer at a key position in the body, by the request the body belongs to and the
+ * keys enclosing the caret; empty where the names are the reader's own (a field, an aggregation).
+ */
+declare function bodyKeys(kind: BodyKind, path: readonly string[]): string[];
 //#endregion
 //#region src/assist.d.ts
 /**
@@ -174,6 +234,22 @@ interface ElasticsearchAssist {
   complete: (text: string, offset: number) => ElasticsearchCompletionCandidate[];
   hover: (text: string, offset: number) => ElasticsearchHoverCard | null;
 }
+/**
+ * Completion for a request body standing on its own, with no request line above it to say
+ * what it is the body of — a `query` object typed into a one-line filter field, which is how
+ * a console browses an index without a command written out.
+ */
+interface ElasticsearchBodyAssist {
+  complete: (body: string, offset: number) => ElasticsearchCompletionCandidate[];
+}
+/**
+ * The body vocabulary alone, for a surface that holds a body and nothing else.
+ *
+ * The caller names the `kind` because nothing in the text can: the whole point of this
+ * surface is that the method and the path are decided elsewhere — a filter field under a
+ * browsed index is always a `"search"` body, and says so once rather than on every keystroke.
+ */
+declare function createElasticsearchBodyAssist(kind: BodyKind): ElasticsearchBodyAssist;
 /**
  * Completion for the request line and the body, hover for the endpoint on the request line —
  * both reading the request through `request.ts`, as the engine reads it.
@@ -201,4 +277,4 @@ interface ElasticsearchMarker {
  */
 declare function requestMarkers(text: string): ElasticsearchMarker[];
 //#endregion
-export { readRequest as _, ElasticsearchAssist as a, runnableRequest as b, ElasticsearchHoverCard as c, REQUEST_METHODS as d, RequestMethod as f, caretContext as g, RunnableRequest as h, CatalogIndex as i, createElasticsearchAssist as l, RequestRefusal as m, ElasticsearchMarkerCode as n, ElasticsearchCatalog as o, RequestRead as p, requestMarkers as r, ElasticsearchCompletionCandidate as s, ElasticsearchMarker as t, CaretContext as u, requestAt as v, takesLines as x, requestSpans as y };
+export { runnableRequest as A, RequestRefusal as C, readRequest as D, keyPosition as E, requestAt as O, RequestRead as S, caretContext as T, endpointOf as _, ElasticsearchAssist as a, REQUEST_METHODS as b, ElasticsearchCompletionCandidate as c, createElasticsearchBodyAssist as d, API_ENDPOINTS as f, bodyKindOf as g, bodyKeys as h, CatalogIndex as i, takesLines as j, requestSpans as k, ElasticsearchHoverCard as l, BodyKind as m, ElasticsearchMarkerCode as n, ElasticsearchBodyAssist as o, ApiEndpoint as p, requestMarkers as r, ElasticsearchCatalog as s, ElasticsearchMarker as t, createElasticsearchAssist as u, CaretContext as v, RunnableRequest as w, RequestMethod as x, KeyPosition as y };

package/dist/{markers-DBJshw-Y.js → markers-DwYWlWEq.js}

@@ -1238,4 +1238,4 @@ function requestMarkers(text) {
 	return markers;
 }
 //#endregion
-export { requestAt as a, takesLines as c, bodyKindOf as d, endpointOf as f, readRequest as i, API_ENDPOINTS as l, REQUEST_METHODS as n, requestSpans as o, caretContext as r, runnableRequest as s, requestMarkers as t, bodyKeys as u };
+export { readRequest as a, runnableRequest as c, bodyKeys as d, bodyKindOf as f, keyPosition as i, takesLines as l, REQUEST_METHODS as n, requestAt as o, endpointOf as p, caretContext as r, requestSpans as s, requestMarkers as t, API_ENDPOINTS as u };

package/dist/monaco.d.ts

@@ -1,4 +1,4 @@
-import { a as ElasticsearchAssist, t as ElasticsearchMarker } from "./markers-BctX905j.js";
+import { a as ElasticsearchAssist, t as ElasticsearchMarker } from "./markers-DnaVJoMY.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 { a as ElasticsearchAssist, t as ElasticsearchMarker } from "./markers-BctX905j.js";
+import { a as ElasticsearchAssist, t as ElasticsearchMarker } from "./markers-DnaVJoMY.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 requestMarkers } from "./markers-DBJshw-Y.js";
+import { t as requestMarkers } from "./markers-DwYWlWEq.js";
 import { ELASTICSEARCH_LANGUAGE_ID, defineElasticsearchLanguage, registerElasticsearchLanguage, setElasticsearchMarkers } 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-elasticsearch",
-  "version": "0.25.0",
+  "version": "0.26.0",
   "description": "Elasticsearch request editing intelligence for Monaco: the console spelling (a method and a path, the body after), endpoint and index completion, body keys by context, request markers, and a drop-in React request editor.",
   "keywords": [
     "elasticsearch",
@@ -43,17 +43,37 @@
     "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.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",
     "react": ">=19",
-    "@coldsmirk/inkstone-react": "^0.25.0"
+    "@coldsmirk/inkstone-react": "^0.26.0"
   },
   "peerDependenciesMeta": {
+    "@codemirror/autocomplete": {
+      "optional": true
+    },
+    "@codemirror/lint": {
+      "optional": true
+    },
+    "@codemirror/state": {
+      "optional": true
+    },
+    "@codemirror/view": {
+      "optional": true
+    },
     "@coldsmirk/inkstone-react": {
       "optional": true
     },