@manifest-configuration-language/browser 0.1.3 → 0.1.5

package/README.md

@@ -1,6 +1,6 @@
 # @manifest-configuration-language/browser
 
-`@manifest-configuration-language/browser` runs MCL parse, lint, format, check, evaluate, and render operations in a dedicated Web Worker. Its `prepack` step uses the shared WASM build script, which builds with the active Go toolchain, applies the mise-pinned Binaryen `wasm-opt -Oz`, selects the smaller binary, and copies the matching Go `wasm_exec.js` so both runtime assets ship together. GitHub Release assets use this same output. Update the Go and Binaryen pins in the repository's `mise.toml` when upgrading either tool.
+`@manifest-configuration-language/browser` runs MCL parse, lint, format, completion, definition, hover, check, evaluate, and render operations in a dedicated Web Worker. Its `prepack` step uses the shared WASM build script, which builds with the active Go toolchain, applies the mise-pinned Binaryen `wasm-opt -Oz`, selects the smaller binary, and copies the matching Go `wasm_exec.js` so both runtime assets ship together. GitHub Release assets use this same output. Update the Go and Binaryen pins in the repository's `mise.toml` when upgrading either tool.
 
 ```js
 import { createMclRuntime } from "@manifest-configuration-language/browser";
@@ -25,9 +25,11 @@ Project files can be UTF-8 strings or `Uint8Array` values. UTF-8 files remain in
 
 `project.complete({ entrypoint, position })` returns the MCL language-service candidates for a zero-based UTF-16 position. Completion uses the same local project files as parsing and rendering, including schemas and Helm values schemas. It does not access a Kubernetes API server or any other network service.
 
-The package exports `CompletionPosition`, `CompletionItem`, `CompletionResult`, `maxSourceBytes`, `maxProjectFiles`, `maxProjectFileBytes`, and `maxProjectBytes` so browser interfaces can display or consume the runtime's public types and limits.
+`project.definition({ entrypoint, position })` returns a project-relative declaration path and zero-based UTF-16 range for local and imported MCL declarations. `project.hover({ entrypoint, position })` returns declaration syntax, including explicit type annotations and function or rule signatures. Hover does not infer runtime value types, and both operations use only project files already supplied to the browser runtime.
 
-MCL decodes the request into a root-relative `io/fs` filesystem for project files, module imports, schemas, resource catalogs, and dependency locks. The runtime limits are defined in the [protocol schema](https://github.com/manifest-configuration-language/mcl/blob/main/cmd/mcl-wasm/protocol.schema.json). The worker blocks `fetch` after loading the WASM runtime assets, so MCL project evaluation cannot make external network requests.
+The package exports the completion, definition, and hover result types, `maxSourceBytes`, `maxProjectFiles`, `maxProjectFileBytes`, and `maxProjectBytes` so browser interfaces can consume the runtime's public types and limits.
+
+MCL decodes the request into a root-relative `io/fs` filesystem for project files, module imports, schemas, and dependency locks. Kubernetes resource scope checks use built-in metadata and CRDs in the project; unknown resource kinds can still be rendered. The runtime limits are defined in the [protocol schema](https://github.com/manifest-configuration-language/mcl/blob/main/cmd/mcl-wasm/protocol.schema.json). The worker blocks `fetch` after loading the WASM runtime assets, so MCL project evaluation cannot make external network requests.
 
 The wire format is described in [`protocol.schema.json`](https://github.com/manifest-configuration-language/mcl/blob/main/cmd/mcl-wasm/protocol.schema.json). Go protocol models are generated with `go generate ./cmd/mcl-wasm`, and the browser package declarations are generated with `npm run generate:protocol`. The browser API declarations reuse the generated operation, diagnostic, and result types. MCL decodes each request into a root-relative `io/fs` project filesystem. Kustomize project overlays and locked Git archives use kyaml's in-memory filesystem, and Helm source loading accepts an `io/fs` filesystem. The Go `wasm_exec.js` runtime supplies its standard browser fallbacks for process, path, and stdout APIs; the Browser SDK does not provide a Node-style project filesystem or require Node polyfills in Vite.
 

package/dist/mcl.wasm

@@ -1,4 +1,4 @@
 [diffend] Oversized file quarantined before diffing.
 name: package/dist/mcl.wasm
-size: 96180751 bytes
-sha256: b895cd81bec50ee1d9da9613f4417ff6513a830dceb61788988f28a6e3e20d97
+size: 96219377 bytes
+sha256: 285f6bf9e6c1720d4db98f9aeedcf0d751e8ef33a5f7a3b2d2d2c501c9f12a9d

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manifest-configuration-language/browser",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Run MCL projects in a browser Web Worker using the Go WebAssembly runtime.",
   "repository": {
     "type": "git",

package/src/index.d.ts

@@ -3,14 +3,19 @@ import type {
   CompletionItem as ProtocolCompletionItem,
   CompletionPosition as ProtocolCompletionPosition,
   CompletionResult as ProtocolCompletionResult,
+  DefinitionLocation as ProtocolDefinitionLocation,
+  DefinitionResult as ProtocolDefinitionResult,
   Error as ProtocolError,
   EvaluateResult,
   FormatResult,
+  HoverInfo as ProtocolHoverInfo,
+  HoverResult as ProtocolHoverResult,
   LintDiagnostic as ProtocolLintDiagnostic,
   ParseResult,
   RelatedLocation as ProtocolRelatedLocation,
   RenderResult,
   Request as WasmRequest,
+  SourceRange as ProtocolSourceRange,
 } from "./protocol.js";
 
 export type MclOperation = WasmRequest["operation"];
@@ -30,11 +35,18 @@ export type LintDiagnostic = ProtocolLintDiagnostic;
 export type CompletionPosition = ProtocolCompletionPosition;
 export type CompletionItem = ProtocolCompletionItem;
 export type CompletionResult = ProtocolCompletionResult;
+export type DefinitionResult = ProtocolDefinitionResult;
+export type DefinitionLocation = ProtocolDefinitionLocation;
+export type HoverResult = ProtocolHoverResult;
+export type HoverInfo = ProtocolHoverInfo;
+export type SourceRange = ProtocolSourceRange;
 
 export type MclResult =
   | ({ operation: "parse" } & ParseResult)
   | { operation: "lint"; diagnostics: ProtocolLintDiagnostic[] }
   | ({ operation: "completion" } & ProtocolCompletionResult)
+  | ({ operation: "definition" } & ProtocolDefinitionResult)
+  | ({ operation: "hover" } & ProtocolHoverResult)
   | ({ operation: "format" } & FormatResult)
   | ({ operation: "check" } & CheckResult)
   | ({ operation: "evaluate" } & EvaluateResult)
@@ -55,6 +67,10 @@ export interface MclRuntime {
   check(source: string, files?: ProjectFiles, options?: RequestOptions): Promise<MclResult & { operation: "check" }>;
   evaluate(source: string, files?: ProjectFiles, options?: RequestOptions): Promise<MclResult & { operation: "evaluate" }>;
   render(source: string, files?: ProjectFiles, options?: RequestOptions): Promise<MclResult & { operation: "render" }>;
+  definition(source: string, options: PositionRequestOptions): Promise<MclResult & { operation: "definition" }>;
+  definition(source: string, files: ProjectFiles | undefined, options: PositionRequestOptions): Promise<MclResult & { operation: "definition" }>;
+  hover(source: string, options: PositionRequestOptions): Promise<MclResult & { operation: "hover" }>;
+  hover(source: string, files: ProjectFiles | undefined, options: PositionRequestOptions): Promise<MclResult & { operation: "hover" }>;
   dispose(): void;
 }
 
@@ -62,6 +78,8 @@ export interface MclProject {
   parse(options?: ProjectOperationOptions): Promise<MclResult & { operation: "parse" }>;
   lint(options?: ProjectOperationOptions): Promise<MclResult & { operation: "lint" }>;
   complete(options: ProjectCompletionOptions): Promise<MclResult & { operation: "completion" }>;
+  definition(options: ProjectNavigationOptions): Promise<MclResult & { operation: "definition" }>;
+  hover(options: ProjectNavigationOptions): Promise<MclResult & { operation: "hover" }>;
   format(options?: ProjectOperationOptions): Promise<MclResult & { operation: "format" }>;
   check(options?: ProjectOperationOptions): Promise<MclResult & { operation: "check" }>;
   evaluate(options?: ProjectOperationOptions): Promise<MclResult & { operation: "evaluate" }>;
@@ -81,6 +99,15 @@ export interface ProjectCompletionOptions extends ProjectOperationOptions {
   position: CompletionPosition;
 }
 
+export interface ProjectNavigationOptions extends ProjectOperationOptions {
+  position: CompletionPosition;
+}
+
+export interface PositionRequestOptions extends RequestOptions {
+  entrypoint?: string;
+  position: CompletionPosition;
+}
+
 export declare class MclRuntimeError extends Error {
   readonly code: string;
   readonly path?: string;

package/src/index.js

@@ -248,6 +248,8 @@ export function createMclRuntime(options = {}) {
       parse: (requestOptions) => runProjectOperation("parse", requestOptions),
       lint: (requestOptions) => runProjectOperation("lint", requestOptions),
       complete: (requestOptions) => runProjectOperation("completion", requestOptions),
+      definition: (requestOptions) => runProjectOperation("definition", requestOptions),
+      hover: (requestOptions) => runProjectOperation("hover", requestOptions),
       format: (requestOptions) => runProjectOperation("format", requestOptions),
       check: (requestOptions) => runProjectOperation("check", requestOptions),
       evaluate: (requestOptions) => runProjectOperation("evaluate", requestOptions),
@@ -289,6 +291,13 @@ export function createMclRuntime(options = {}) {
     return { files: transferredFiles, transferables };
   }
 
+  function runSourceNavigation(operation, source, filesOrOptions, requestOptions) {
+    const files = requestOptions === undefined ? undefined : filesOrOptions;
+    const options = requestOptions ?? filesOrOptions;
+    if (!options?.position) throw new TypeError("A source position is required");
+    return execute(operation, source, files, options, options.entrypoint ?? "main.mcl", options.position);
+  }
+
   return {
     openProject,
     warmUp,
@@ -298,6 +307,8 @@ export function createMclRuntime(options = {}) {
     check: (source, files, requestOptions) => execute("check", source, files, requestOptions),
     evaluate: (source, files, requestOptions) => execute("evaluate", source, files, requestOptions),
     render: (source, files, requestOptions) => execute("render", source, files, requestOptions),
+    definition: (source, filesOrOptions, requestOptions) => runSourceNavigation("definition", source, filesOrOptions, requestOptions),
+    hover: (source, filesOrOptions, requestOptions) => runSourceNavigation("hover", source, filesOrOptions, requestOptions),
     dispose() {
       if (disposed) return;
       disposed = true;

package/src/protocol.d.ts

@@ -4,7 +4,7 @@ export type MCLWebAssemblyRequestAndResponseProtocol = Request | Response;
 export type Request = {
   requestId?: number;
   revision?: number;
-  operation: "parse" | "lint" | "format" | "check" | "evaluate" | "render" | "completion";
+  operation: "parse" | "lint" | "format" | "check" | "evaluate" | "render" | "completion" | "definition" | "hover";
   position?: CompletionPosition;
   /**
    * Project-relative MCL source path. Defaults to main.mcl.
@@ -38,7 +38,16 @@ export interface Response {
   requestId: number;
   revision?: number;
   ok: boolean;
-  result?: ParseResult | LintResult | FormatResult | CheckResult | EvaluateResult | RenderResult | CompletionResult;
+  result?:
+    | ParseResult
+    | LintResult
+    | FormatResult
+    | CheckResult
+    | EvaluateResult
+    | RenderResult
+    | CompletionResult
+    | DefinitionResult
+    | HoverResult;
   error?: Error;
 }
 export interface ParseResult {
@@ -78,6 +87,24 @@ export interface CompletionItem {
   kind: number;
   insertText?: string;
 }
+export interface DefinitionResult {
+  location: DefinitionLocation | null;
+}
+export interface DefinitionLocation {
+  path: string;
+  range: SourceRange;
+}
+export interface SourceRange {
+  start: CompletionPosition;
+  end: CompletionPosition;
+}
+export interface HoverResult {
+  hover: HoverInfo | null;
+}
+export interface HoverInfo {
+  contents: string;
+  range: SourceRange;
+}
 export interface Error {
   code: string;
   message: string;