@coldsmirk/inkstone-codemirror 0.8.3 → 0.10.0

package/dist/index.d.cts

@@ -1,554 +0,0 @@
-import { Extension, StateField } from "@codemirror/state";
-import { EditorView } from "@codemirror/view";
-import { LanguageSupport } from "@codemirror/language";
-
-//#region src/context.d.ts
-/**
- * A node in the context shape. `ref` is a lazy pointer into {@link IrSchema.defs} (deref at use).
- */
-type IrType = {
-  readonly kind: "object";
-  readonly fields: Readonly<Record<string, IrField>>;
-} | {
-  readonly kind: "array";
-  readonly element: IrType;
-} | {
-  readonly kind: "enum";
-  readonly values: ReadonlyArray<string | number | boolean>;
-} | {
-  readonly kind: "string" | "number" | "boolean" | "null" | "any";
-} | {
-  readonly kind: "ref";
-  readonly name: string;
-};
-/**
- * A named member of an object type. `nullable` / `required` are display metadata, not gates.
- */
-interface IrField {
-  readonly type: IrType;
-  readonly required: boolean;
-  readonly nullable: boolean;
-  readonly doc?: string;
-}
-/**
- * A normalized context: a root shape plus a definition table backing `ref` nodes (and cycles).
- */
-interface IrSchema {
-  readonly root: IrType;
-  readonly defs: Readonly<Record<string, IrType>>;
-}
-/**
- * A resolved member, offered as one completion.
- */
-interface Member {
-  readonly name: string;
-  readonly type: IrType;
-  readonly required: boolean;
-  readonly nullable: boolean;
-  readonly doc?: string;
-}
-/**
- * How a caller hands inkstone a context: a JSON Schema, or a representative sample value to infer
- * the shape from. Pass a *stable* reference (memoize/hoist it) — in React a new identity each
- * render re-normalizes and re-dispatches.
- */
-type EditorContext = {
-  readonly schema: unknown;
-} | {
-  readonly sample: unknown;
-};
-/**
- * Reactively set (or clear) the render-context schema an editor completes against. Dispatch this
- * effect — `setMinijinjaContext.of(normalizeContext(...))`, or `.of(null)` to turn it off — to
- * update completion without recreating the editor, matching the create-once discipline used
- * throughout the toolkit. Defined here (not with the MiniJinja grammar) so it and the field stay
- * in the always-loaded chunk, leaving the grammar lazily code-split.
- */
-declare const setMinijinjaContext: import("@codemirror/state").StateEffectType<IrSchema | null>;
-/**
- * Holds the normalized render-context schema that variable / member completion reads. Seed it with
- * `minijinja({ context })`, or drive it at runtime with {@link setMinijinjaContext}. `null` (the
- * default) means no context — variable completion stays off and only tags / filters / tests /
- * globals are offered.
- */
-declare const minijinjaContextField: StateField<IrSchema | null>;
-/**
- * Normalize either input form to the internal {@link IrSchema}.
- */
-declare function normalizeContext(input: EditorContext): IrSchema;
-/**
- * Members reachable at `path` — `[]` yields the top-level context variables (plus any `scope`
- * bindings), a non-empty path walks member access (`["user", "address"]` → the fields of
- * `user.address`). The first segment may resolve against a `scope` binding (a `{% for %}` target,
- * macro parameter, …) before falling back to the root.
- */
-declare function resolveMembers(ir: IrSchema, path: readonly string[], scope?: ReadonlyMap<string, IrType>): Member[];
-/**
- * The type at a declared property path, or null if the path leaves the walkable shape.
- */
-declare function typeAtPath(ir: IrSchema, path: readonly string[]): IrType | null;
-//#endregion
-//#region src/controlled-host.d.ts
-interface ControlledEditorOptions {
-  /**
-   * The element the editor mounts into.
-   */
-  parent: HTMLElement;
-  /**
-   * Initial document text.
-   */
-  doc: string;
-  /**
-   * Called with the full document after every user edit. Not called for
-   * {@link ControlledEditorHost.setValue} reconciliations.
-   */
-  onChange: (value: string) => void;
-  /**
-   * Static extensions, fixed for the editor's lifetime.
-   */
-  extensions?: Extension[];
-  /**
-   * Extensions that change at runtime (theme, language config …), swapped in place via
-   * {@link ControlledEditorHost.reconfigure} without rebuilding the editor.
-   */
-  dynamicExtensions?: Extension[];
-}
-/**
- * A controlled CodeMirror 6 host — the create-once plumbing every framework wrapper repeats:
- *
- * - **External value reconcile.** {@link setValue} diffs the incoming value against the live
- * document and dispatches a minimal replace, so a store-driven update never resets the caret
- * and never echoes back through `onChange`.
- * - **In-place reconfiguration.** `dynamicExtensions` live in a {@link Compartment};
- * {@link reconfigure} swaps them (light/dark theme, language options) without rebuilding
- * the editor and losing its state.
- *
- * Framework-agnostic: a React wrapper calls `setValue` from a value effect and `reconfigure`
- * from a theme effect (see `@coldsmirk/inkstone-react`); any other framework does the same
- * from its own reactivity.
- */
-declare class ControlledEditorHost {
-  private readonly compartment;
-  private silent;
-  readonly view: EditorView;
-  constructor({
-    parent,
-    doc,
-    onChange,
-    extensions,
-    dynamicExtensions
-  }: ControlledEditorOptions);
-  /**
-   * Reconcile an externally-changed value into the live document without resetting the caret.
-   * No-op when the document already matches; the write never re-enters `onChange`.
-   */
-  setValue(value: string): void;
-  /**
-   * Swap the dynamic extensions (theme, language configuration) in place.
-   */
-  reconfigure(dynamicExtensions: Extension[]): void;
-  destroy(): void;
-}
-//#endregion
-//#region src/extensions.d.ts
-/**
- * Simplified-Chinese strings for the search / goto-line panels, as an opt-in extension —
- * inkstone's defaults are English, so pass this through `extensions` to localize the panel
- * (`search` must be on for the panel to exist at all).
- */
-declare const searchPhrasesZhCn: Extension;
-interface DocumentExtensionsOptions {
-  /**
-   * Placeholder text shown while the document is empty.
-   */
-  placeholder?: string;
-  /**
-   * Soft-wrap long lines instead of scrolling horizontally.
-   *
-   * @default false
-   */
-  lineWrapping?: boolean;
-  /**
-   * Show the line-number gutter.
-   *
-   * @default false
-   */
-  showLineNumbers?: boolean;
-  /**
-   * Enable code folding — adds the fold gutter and fold keymap. Fold points come from the
-   * language, so this stays inert until a language is set.
-   *
-   * @default false
-   */
-  folding?: boolean;
-  /**
-   * Turn native browser spell-check on. CodeMirror itself keeps it off (`spellcheck="false"`
-   * on the content element), which is right for code — red squiggles under identifiers help
-   * nobody. Enable it for prose-grade documents (prompt templates, messages).
-   *
-   * @default false
-   */
-  spellcheck?: boolean;
-  /**
-   * Enable in-editor search: the standard search keymap (Ctrl/Cmd-F opens the panel, F3 /
-   * Ctrl/Cmd-G cycle matches, Ctrl/Cmd-D selects the next occurrence, Alt-G jumps to a line)
-   * plus selection-match highlighting. The panel speaks CodeMirror's stock English; add
-   * {@link searchPhrasesZhCn} to `extensions` for Simplified Chinese.
-   *
-   * @default false
-   */
-  search?: boolean;
-}
-/**
- * The standard extension bundle for a document-grade editor — line numbers, history,
- * selection drawing, active-line highlight, auto-indent, bracket matching/closing,
- * completion UI, and the merged default keymap. This is the assembly every hand-built
- * CodeMirror host repeats; language support and theming stay with the caller.
- */
-declare function documentExtensions({
-  placeholder,
-  lineWrapping,
-  showLineNumbers,
-  folding,
-  spellcheck,
-  search
-}?: DocumentExtensionsOptions): Extension[];
-//#endregion
-//#region src/languages.d.ts
-/**
- * Resolves a language grammar. Every loader is a distinct dynamic `import()`, so a bundler
- * emits one chunk per language and only the selected grammar is fetched at runtime — the
- * whole catalog is never loaded at once.
- */
-type LanguageLoader = () => Promise<Extension>;
-/**
- * Language id → lazy loader. Two tiers back the catalog: the official `@codemirror/lang-*`
- * (Lezer) parsers where upstream ships one, and the full `@codemirror/legacy-modes` catalog
- * for every language upstream never wrote a Lezer grammar for — where a language exists in
- * both, the Lezer parser wins. Ids follow Monaco's spelling where they overlap, but the two
- * editors expose independent language types — {@link CodeMirrorLanguage} is exactly this set.
- */
-declare const loaders: {
-  javascript: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  typescript: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  jsx: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  tsx: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  json: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  html: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  css: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  scss: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  sass: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  less: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  python: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  java: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  markdown: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  xml: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  rust: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  php: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  yaml: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  go: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  cpp: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  c: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  vue: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  angular: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  liquid: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  wast: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  lezer: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  sql: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  mysql: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  pgsql: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  sqlite: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  mssql: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  mariadb: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  plsql: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  cassandra: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  apl: LanguageLoader;
-  asciiarmor: LanguageLoader;
-  asn1: LanguageLoader;
-  asterisk: LanguageLoader;
-  brainfuck: LanguageLoader;
-  ceylon: LanguageLoader;
-  clojure: LanguageLoader;
-  cmake: LanguageLoader;
-  cobol: LanguageLoader;
-  coffeescript: LanguageLoader;
-  commonlisp: LanguageLoader;
-  crystal: LanguageLoader;
-  csharp: LanguageLoader;
-  cypher: LanguageLoader;
-  cython: LanguageLoader;
-  d: LanguageLoader;
-  dart: LanguageLoader;
-  diff: LanguageLoader;
-  dockerfile: LanguageLoader;
-  dtd: LanguageLoader;
-  dylan: LanguageLoader;
-  ebnf: LanguageLoader;
-  ecl: LanguageLoader;
-  eiffel: LanguageLoader;
-  elm: LanguageLoader;
-  env: LanguageLoader;
-  erlang: LanguageLoader;
-  esper: LanguageLoader;
-  ez80: LanguageLoader;
-  factor: LanguageLoader;
-  fcl: LanguageLoader;
-  forth: LanguageLoader;
-  fortran: LanguageLoader;
-  fsharp: LanguageLoader;
-  gas: LanguageLoader;
-  "gas-arm": LanguageLoader;
-  gherkin: LanguageLoader;
-  gpsql: LanguageLoader;
-  gql: LanguageLoader;
-  groovy: LanguageLoader;
-  gss: LanguageLoader;
-  haskell: LanguageLoader;
-  haxe: LanguageLoader;
-  hive: LanguageLoader;
-  http: LanguageLoader;
-  hxml: LanguageLoader;
-  idl: LanguageLoader;
-  ini: LanguageLoader;
-  julia: LanguageLoader;
-  kotlin: LanguageLoader;
-  livescript: LanguageLoader;
-  lua: LanguageLoader;
-  mathematica: LanguageLoader;
-  mbox: LanguageLoader;
-  mirc: LanguageLoader;
-  modelica: LanguageLoader;
-  mscgen: LanguageLoader;
-  msgenny: LanguageLoader;
-  mumps: LanguageLoader;
-  nesc: LanguageLoader;
-  nginx: LanguageLoader;
-  nsis: LanguageLoader;
-  ntriples: LanguageLoader;
-  "objective-c": LanguageLoader;
-  "objective-cpp": LanguageLoader;
-  ocaml: LanguageLoader;
-  octave: LanguageLoader;
-  oz: LanguageLoader;
-  pascal: LanguageLoader;
-  pegjs: LanguageLoader;
-  perl: LanguageLoader;
-  pig: LanguageLoader;
-  powershell: LanguageLoader;
-  properties: LanguageLoader;
-  protobuf: LanguageLoader;
-  pug: LanguageLoader;
-  puppet: LanguageLoader;
-  q: LanguageLoader;
-  r: LanguageLoader;
-  "rpm-changes": LanguageLoader;
-  "rpm-spec": LanguageLoader;
-  ruby: LanguageLoader;
-  sas: LanguageLoader;
-  scala: LanguageLoader;
-  scheme: LanguageLoader;
-  shader: LanguageLoader;
-  shell: LanguageLoader;
-  sieve: LanguageLoader;
-  smalltalk: LanguageLoader;
-  sml: LanguageLoader;
-  solr: LanguageLoader;
-  sparksql: LanguageLoader;
-  sparql: LanguageLoader;
-  spreadsheet: LanguageLoader;
-  squirrel: LanguageLoader;
-  stex: LanguageLoader;
-  "stex-math": LanguageLoader;
-  stylus: LanguageLoader;
-  swift: LanguageLoader;
-  tcl: LanguageLoader;
-  textile: LanguageLoader;
-  tiddlywiki: LanguageLoader;
-  tiki: LanguageLoader;
-  tlv: LanguageLoader;
-  toml: LanguageLoader;
-  troff: LanguageLoader;
-  ttcn: LanguageLoader;
-  "ttcn-cfg": LanguageLoader;
-  turtle: LanguageLoader;
-  vb: LanguageLoader;
-  vbscript: LanguageLoader;
-  "vbscript-asp": LanguageLoader;
-  velocity: LanguageLoader;
-  verilog: LanguageLoader;
-  vhdl: LanguageLoader;
-  webidl: LanguageLoader;
-  xquery: LanguageLoader;
-  xu: LanguageLoader;
-  yacas: LanguageLoader;
-  z80: LanguageLoader;
-  minijinja: () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-html": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-xml": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-json": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-yaml": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-css": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-scss": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-sass": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-less": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-markdown": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-sql": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-mysql": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-pgsql": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-sqlite": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-mssql": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-mariadb": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-plsql": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-cassandra": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-hive": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-sparksql": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-gql": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-gpsql": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-esper": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-toml": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-ini": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-env": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-shell": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-dockerfile": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-  "minijinja-nginx": () => Promise<{
-    extension: Extension;
-  } | readonly Extension[] | LanguageSupport>;
-};
-/**
- * The language ids `<CodeMirrorEditor>` supports — exactly the keys of the loader registry.
- */
-type CodeMirrorLanguage = keyof typeof loaders;
-/**
- * Every supported language id, sorted.
- */
-declare const codeMirrorLanguages: readonly CodeMirrorLanguage[];
-/**
- * Lazily resolve a supported language id to a CodeMirror language {@link Extension}. Each
- * language is a separate dynamic import, so the consumer's bundler code-splits it and only
- * the requested grammar is fetched — the whole catalog is never loaded at once.
- */
-declare function loadLanguage(language: CodeMirrorLanguage): Promise<Extension>;
-//#endregion
-export { type CodeMirrorLanguage, ControlledEditorHost, type ControlledEditorOptions, type DocumentExtensionsOptions, type EditorContext, type IrField, type IrSchema, type IrType, type Member, codeMirrorLanguages, documentExtensions, loadLanguage, minijinjaContextField, normalizeContext, resolveMembers, searchPhrasesZhCn, setMinijinjaContext, typeAtPath };