@manifest-configuration-language/browser 0.1.2 → 0.1.3

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -7,6 +7,7 @@ import { createMclRuntime } from "@manifest-configuration-language/browser";
 
 const runtime = createMclRuntime();
 try {
+  await runtime.warmUp();
   const project = runtime.openProject({
     "main.mcl": source,
     "values.json": JSON.stringify(values),
@@ -18,11 +19,13 @@ try {
 }
 ```
 
-Pass an `AbortSignal` through the final options argument to cancel an operation. The operation timeout covers both worker initialization and execution; `initializationTimeoutMs` is an additional upper bound for worker startup. Cancellation or a timeout terminates the current worker, and the runtime creates a fresh worker for the next operation. Operations are serialized because the current Go runtime uses one in-memory project root.
+Call `runtime.warmUp()` to load the WebAssembly runtime before the first project operation. Pass `signal` and `timeoutMs` to warm-up or an operation to cancel it or set an upper bound for that call. Warm-up's timeout and `initializationTimeoutMs` bound worker startup; an operation's `timeoutMs` bounds execution after startup. Cancelling or timing out worker startup terminates that worker; the next queued operation can create a fresh worker. Cancelling or timing out an operation terminates its worker. Operations and warm-up are serialized because the current Go runtime uses one in-memory project root.
 
 Project files can be UTF-8 strings or `Uint8Array` values. UTF-8 files remain inline in the JSON request. The Browser SDK copies each `Uint8Array` and transfers its buffer to the Worker; the Worker sends only `{ "encoding": "binary" }` metadata in the request JSON and passes a path-to-`Uint8Array` map as the second argument to `mclWasm.run(requestJSON, binaryFiles)`. The Go runtime copies those bytes into its project filesystem. The SDK-owned and caller-owned arrays remain reusable after each operation.
 
-The package exports `maxSourceBytes`, `maxProjectFiles`, `maxProjectFileBytes`, and `maxProjectBytes` so browser interfaces can display the same limits enforced by the runtime.
+`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.
 
 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.
 

package/dist/mcl.wasm

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manifest-configuration-language/browser",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Run MCL projects in a browser Web Worker using the Go WebAssembly runtime.",
   "repository": {
     "type": "git",
@@ -20,12 +20,6 @@
       "import": "./src/index.js"
     }
   },
-  "scripts": {
-    "build:wasm": "node ./scripts/build-wasm.mjs",
-    "generate:protocol": "node ./scripts/generate-protocol.mjs",
-    "test:unit": "node --test ./test/runtime-lifecycle.test.mjs",
-    "prepack": "npm run build:wasm"
-  },
   "engines": {
     "node": ">=20.19"
   },
@@ -34,5 +28,10 @@
   },
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "build:wasm": "node ./scripts/build-wasm.mjs",
+    "generate:protocol": "node ./scripts/generate-protocol.mjs",
+    "test:unit": "node --test ./test/runtime-lifecycle.test.mjs"
   }
-}
+}

package/src/index.d.ts

@@ -1,5 +1,8 @@
 import type {
   CheckResult,
+  CompletionItem as ProtocolCompletionItem,
+  CompletionPosition as ProtocolCompletionPosition,
+  CompletionResult as ProtocolCompletionResult,
   Error as ProtocolError,
   EvaluateResult,
   FormatResult,
@@ -24,10 +27,14 @@ export type ProjectFiles = Readonly<Record<string, ProjectFile>>;
 export type MclError = ProtocolError;
 
 export type LintDiagnostic = ProtocolLintDiagnostic;
+export type CompletionPosition = ProtocolCompletionPosition;
+export type CompletionItem = ProtocolCompletionItem;
+export type CompletionResult = ProtocolCompletionResult;
 
 export type MclResult =
   | ({ operation: "parse" } & ParseResult)
   | { operation: "lint"; diagnostics: ProtocolLintDiagnostic[] }
+  | ({ operation: "completion" } & ProtocolCompletionResult)
   | ({ operation: "format" } & FormatResult)
   | ({ operation: "check" } & CheckResult)
   | ({ operation: "evaluate" } & EvaluateResult)
@@ -41,6 +48,7 @@ export interface RuntimeOptions {
 
 export interface MclRuntime {
   openProject(files: ProjectFiles): MclProject;
+  warmUp(options?: RequestOptions): Promise<void>;
   parse(source: string, options?: RequestOptions): Promise<MclResult & { operation: "parse" }>;
   lint(source: string, options?: RequestOptions): Promise<MclResult & { operation: "lint" }>;
   format(source: string, options?: RequestOptions): Promise<MclResult & { operation: "format" }>;
@@ -53,6 +61,7 @@ export interface MclRuntime {
 export interface MclProject {
   parse(options?: ProjectOperationOptions): Promise<MclResult & { operation: "parse" }>;
   lint(options?: ProjectOperationOptions): Promise<MclResult & { operation: "lint" }>;
+  complete(options: ProjectCompletionOptions): Promise<MclResult & { operation: "completion" }>;
   format(options?: ProjectOperationOptions): Promise<MclResult & { operation: "format" }>;
   check(options?: ProjectOperationOptions): Promise<MclResult & { operation: "check" }>;
   evaluate(options?: ProjectOperationOptions): Promise<MclResult & { operation: "evaluate" }>;
@@ -68,6 +77,10 @@ export interface ProjectOperationOptions extends RequestOptions {
   entrypoint?: string;
 }
 
+export interface ProjectCompletionOptions extends ProjectOperationOptions {
+  position: CompletionPosition;
+}
+
 export declare class MclRuntimeError extends Error {
   readonly code: string;
   readonly path?: string;

package/src/index.js

@@ -101,7 +101,7 @@ export function createMclRuntime(options = {}) {
     }
   }
 
-  async function execute(operation, source, files, requestOptions = {}, entrypoint = "main.mcl") {
+  async function execute(operation, source, files, requestOptions = {}, entrypoint = "main.mcl", position) {
     const signal = requestOptions.signal;
     if (signal?.aborted) throw new DOMException("The operation was aborted", "AbortError");
     const run = async () => {
@@ -113,8 +113,7 @@ export function createMclRuntime(options = {}) {
       try {
         if (timeoutMs <= 0) throw timeoutError;
         timer = setTimeout(() => {
-          if (stopCurrent) stopCurrent(timeoutError);
-          else stopInitialization?.(timeoutError);
+          (stopCurrent ?? stopInitialization)?.(timeoutError);
         }, timeoutMs);
         await waitUntilReady(requestOptions.signal);
         if (requestOptions.signal?.aborted) throw new DOMException("The operation was aborted", "AbortError");
@@ -160,7 +159,7 @@ export function createMclRuntime(options = {}) {
           requestOptions.signal?.addEventListener("abort", onAbort, { once: true });
           stopCurrent = stop;
           try {
-            currentWorker.postMessage({ type: "run", requestId, operation, source, files: preparedFiles.files, entrypoint }, preparedFiles.transferables);
+            currentWorker.postMessage({ type: "run", requestId, operation, source, files: preparedFiles.files, entrypoint, position }, preparedFiles.transferables);
           } catch (error) {
             stop(error);
           }
@@ -183,6 +182,35 @@ export function createMclRuntime(options = {}) {
     return Promise.race([result, aborted]).finally(() => signal.removeEventListener("abort", onAbort));
   }
 
+  function warmUp(requestOptions = {}) {
+    const signal = requestOptions.signal;
+    if (signal?.aborted) return Promise.reject(new DOMException("The operation was aborted", "AbortError"));
+    const run = async () => {
+      if (disposed) throw new Error("MCL runtime has been disposed");
+      if (signal?.aborted) throw new DOMException("The operation was aborted", "AbortError");
+      const timeoutMs = requestOptions.timeoutMs ?? initializationTimeoutMs;
+      const timeoutError = new MclRuntimeError({ code: "MCL-WASM-TIMEOUT", message: "MCL WebAssembly initialization timed out" });
+      let timer;
+      try {
+        if (timeoutMs <= 0) throw timeoutError;
+        timer = setTimeout(() => stopInitialization?.(timeoutError), timeoutMs);
+        await waitUntilReady(signal);
+      } finally {
+        clearTimeout(timer);
+      }
+    };
+    const result = queue.then(run, run);
+    queue = result.catch(() => {});
+    if (!signal) return result;
+    let onAbort;
+    const aborted = new Promise((_, reject) => {
+      onAbort = () => reject(new DOMException("The operation was aborted", "AbortError"));
+      signal.addEventListener("abort", onAbort, { once: true });
+      if (signal.aborted) onAbort();
+    });
+    return Promise.race([result, aborted]).finally(() => signal.removeEventListener("abort", onAbort));
+  }
+
   function openProject(files) {
     const entries = Object.entries(files ?? {});
     if (entries.length === 0) throw new TypeError("Project must contain at least one MCL source file");
@@ -214,11 +242,12 @@ export function createMclRuntime(options = {}) {
       const projectBytes = Object.values(projectFiles).reduce((total, file) => total + (typeof file === "string" ? new TextEncoder().encode(file).byteLength : file.byteLength), 0);
       if (projectBytes > maxProjectBytes) throw new RangeError(`Project files exceed the ${maxProjectBytes}-byte limit`);
       const otherFiles = Object.fromEntries(Object.entries(projectFiles).filter(([filePath]) => filePath !== entrypoint));
-      return execute(operation, source, otherFiles, requestOptions, entrypoint);
+      return execute(operation, source, otherFiles, requestOptions, entrypoint, requestOptions.position);
     };
     return Object.freeze({
       parse: (requestOptions) => runProjectOperation("parse", requestOptions),
       lint: (requestOptions) => runProjectOperation("lint", requestOptions),
+      complete: (requestOptions) => runProjectOperation("completion", requestOptions),
       format: (requestOptions) => runProjectOperation("format", requestOptions),
       check: (requestOptions) => runProjectOperation("check", requestOptions),
       evaluate: (requestOptions) => runProjectOperation("evaluate", requestOptions),
@@ -262,6 +291,7 @@ export function createMclRuntime(options = {}) {
 
   return {
     openProject,
+    warmUp,
     parse: (source, requestOptions) => execute("parse", source, undefined, requestOptions),
     lint: (source, requestOptions) => execute("lint", source, undefined, requestOptions),
     format: (source, requestOptions) => execute("format", source, undefined, requestOptions),

package/src/protocol.d.ts

@@ -1,19 +1,11 @@
 /* Generated from cmd/mcl-wasm/protocol.schema.json. Do not edit. */
 
 export type MCLWebAssemblyRequestAndResponseProtocol = Request | Response;
-/**
- * Binary files omit content and are supplied in the optional second run argument under the same path.
- */
-export type FileInput = {
-  encoding: "utf8" | "binary";
-  content?: string;
-};
-export type LintResult = LintDiagnostic[];
-
-export interface Request {
+export type Request = {
   requestId?: number;
   revision?: number;
-  operation: "parse" | "lint" | "format" | "check" | "evaluate" | "render";
+  operation: "parse" | "lint" | "format" | "check" | "evaluate" | "render" | "completion";
+  position?: CompletionPosition;
   /**
    * Project-relative MCL source path. Defaults to main.mcl.
    */
@@ -28,12 +20,25 @@ export interface Request {
   files?: {
     [k: string]: FileInput;
   };
+};
+/**
+ * Binary files omit content and are supplied in the optional second run argument under the same path.
+ */
+export type FileInput = {
+  encoding: "utf8" | "binary";
+  content?: string;
+};
+export type LintResult = LintDiagnostic[];
+
+export interface CompletionPosition {
+  line: number;
+  character: number;
 }
 export interface Response {
   requestId: number;
   revision?: number;
   ok: boolean;
-  result?: ParseResult | LintResult | FormatResult | CheckResult | EvaluateResult | RenderResult;
+  result?: ParseResult | LintResult | FormatResult | CheckResult | EvaluateResult | RenderResult | CompletionResult;
   error?: Error;
 }
 export interface ParseResult {
@@ -64,6 +69,15 @@ export interface RenderResult {
   yaml: string;
   artifacts: number;
 }
+export interface CompletionResult {
+  isIncomplete: boolean;
+  items: CompletionItem[];
+}
+export interface CompletionItem {
+  label: string;
+  kind: number;
+  insertText?: string;
+}
 export interface Error {
   code: string;
   message: string;

package/src/worker.js

@@ -1,6 +1,5 @@
 let initialized;
 let runtimeAssets;
-let wasmMemory;
 let networkAccessDenied = false;
 const runtimeFetch = globalThis.fetch.bind(globalThis);
 const networkAPINames = [
@@ -58,7 +57,6 @@ async function initialize() {
     const go = new Go();
     const response = await runtimeFetch(runtimeAssets.wasmURL);
     if (!response.ok) throw new Error(`Unable to load MCL WebAssembly: ${response.status}`);
-    const instantiateStartedAt = performance.now();
     // Load the runtime before denying network APIs, then lock them before Go starts.
     denyNetworkAccess();
     let instance;
@@ -67,15 +65,9 @@ async function initialize() {
     } catch {
       ({ instance } = await WebAssembly.instantiate(await response.arrayBuffer(), go.importObject));
     }
-    const wasmInstantiateMs = performance.now() - instantiateStartedAt;
-    wasmMemory = instance.exports.mem;
     void go.run(instance);
     while (!globalThis.mclWasmReady) await new Promise((resolve) => setTimeout(resolve, 0));
-    postMessage({
-      type: "ready",
-      wasmInstantiateMs,
-      wasmMemoryBytes: wasmMemory.buffer.byteLength,
-    });
+    postMessage({ type: "ready" });
   })().catch((error) => {
     postMessage({ type: "fatal", message: error instanceof Error ? error.message : String(error) });
     throw error;
@@ -122,6 +114,7 @@ self.addEventListener("message", async (event) => {
       revision: message.requestId,
       operation: message.operation,
       entrypoint: message.entrypoint,
+      position: message.position,
       source: message.source,
       files: encodedFiles.files,
     };
@@ -130,7 +123,6 @@ self.addEventListener("message", async (event) => {
       type: "response",
       requestId: message.requestId,
       value,
-      wasmMemoryBytes: wasmMemory.buffer.byteLength,
     });
   } catch (error) {
     postMessage({