@manifest-configuration-language/browser 0.1.2 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md CHANGED
@@ -1,12 +1,13 @@
1
1
  # @manifest-configuration-language/browser
2
2
 
3
- `@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.
3
+ `@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.
4
4
 
5
5
  ```js
6
6
  import { createMclRuntime } from "@manifest-configuration-language/browser";
7
7
 
8
8
  const runtime = createMclRuntime();
9
9
  try {
10
+ await runtime.warmUp();
10
11
  const project = runtime.openProject({
11
12
  "main.mcl": source,
12
13
  "values.json": JSON.stringify(values),
@@ -18,11 +19,15 @@ try {
18
19
  }
19
20
  ```
20
21
 
21
- 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.
22
+ 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.
22
23
 
23
24
  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.
24
25
 
25
- The package exports `maxSourceBytes`, `maxProjectFiles`, `maxProjectFileBytes`, and `maxProjectBytes` so browser interfaces can display the same limits enforced by the runtime.
26
+ `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.
27
+
28
+ `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.
29
+
30
+ 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.
26
31
 
27
32
  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.
28
33
 
package/dist/mcl.wasm CHANGED
@@ -1,4 +1,4 @@
1
1
  [diffend] Oversized file quarantined before diffing.
2
2
  name: package/dist/mcl.wasm
3
- size: 95920350 bytes
4
- sha256: 3723f11f7acbd32086281639d28c5d0c25e7f1b9f0593b251876f2c60d1d5f2f
3
+ size: 96219418 bytes
4
+ sha256: c3cd77de141c61f1a424f86d6c539d2d87cd3af5b0a745420b0cdea2c9f8b96a
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@manifest-configuration-language/browser",
3
- "version": "0.1.2",
3
+ "version": "0.1.4",
4
4
  "description": "Run MCL projects in a browser Web Worker using the Go WebAssembly runtime.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -20,12 +20,6 @@
20
20
  "import": "./src/index.js"
21
21
  }
22
22
  },
23
- "scripts": {
24
- "build:wasm": "node ./scripts/build-wasm.mjs",
25
- "generate:protocol": "node ./scripts/generate-protocol.mjs",
26
- "test:unit": "node --test ./test/runtime-lifecycle.test.mjs",
27
- "prepack": "npm run build:wasm"
28
- },
29
23
  "engines": {
30
24
  "node": ">=20.19"
31
25
  },
@@ -34,5 +28,10 @@
34
28
  },
35
29
  "publishConfig": {
36
30
  "access": "public"
31
+ },
32
+ "scripts": {
33
+ "build:wasm": "node ./scripts/build-wasm.mjs",
34
+ "generate:protocol": "node ./scripts/generate-protocol.mjs",
35
+ "test:unit": "node --test ./test/runtime-lifecycle.test.mjs"
37
36
  }
38
- }
37
+ }
package/src/index.d.ts CHANGED
@@ -1,13 +1,21 @@
1
1
  import type {
2
2
  CheckResult,
3
+ CompletionItem as ProtocolCompletionItem,
4
+ CompletionPosition as ProtocolCompletionPosition,
5
+ CompletionResult as ProtocolCompletionResult,
6
+ DefinitionLocation as ProtocolDefinitionLocation,
7
+ DefinitionResult as ProtocolDefinitionResult,
3
8
  Error as ProtocolError,
4
9
  EvaluateResult,
5
10
  FormatResult,
11
+ HoverInfo as ProtocolHoverInfo,
12
+ HoverResult as ProtocolHoverResult,
6
13
  LintDiagnostic as ProtocolLintDiagnostic,
7
14
  ParseResult,
8
15
  RelatedLocation as ProtocolRelatedLocation,
9
16
  RenderResult,
10
17
  Request as WasmRequest,
18
+ SourceRange as ProtocolSourceRange,
11
19
  } from "./protocol.js";
12
20
 
13
21
  export type MclOperation = WasmRequest["operation"];
@@ -24,10 +32,21 @@ export type ProjectFiles = Readonly<Record<string, ProjectFile>>;
24
32
  export type MclError = ProtocolError;
25
33
 
26
34
  export type LintDiagnostic = ProtocolLintDiagnostic;
35
+ export type CompletionPosition = ProtocolCompletionPosition;
36
+ export type CompletionItem = ProtocolCompletionItem;
37
+ export type CompletionResult = ProtocolCompletionResult;
38
+ export type DefinitionResult = ProtocolDefinitionResult;
39
+ export type DefinitionLocation = ProtocolDefinitionLocation;
40
+ export type HoverResult = ProtocolHoverResult;
41
+ export type HoverInfo = ProtocolHoverInfo;
42
+ export type SourceRange = ProtocolSourceRange;
27
43
 
28
44
  export type MclResult =
29
45
  | ({ operation: "parse" } & ParseResult)
30
46
  | { operation: "lint"; diagnostics: ProtocolLintDiagnostic[] }
47
+ | ({ operation: "completion" } & ProtocolCompletionResult)
48
+ | ({ operation: "definition" } & ProtocolDefinitionResult)
49
+ | ({ operation: "hover" } & ProtocolHoverResult)
31
50
  | ({ operation: "format" } & FormatResult)
32
51
  | ({ operation: "check" } & CheckResult)
33
52
  | ({ operation: "evaluate" } & EvaluateResult)
@@ -41,18 +60,26 @@ export interface RuntimeOptions {
41
60
 
42
61
  export interface MclRuntime {
43
62
  openProject(files: ProjectFiles): MclProject;
63
+ warmUp(options?: RequestOptions): Promise<void>;
44
64
  parse(source: string, options?: RequestOptions): Promise<MclResult & { operation: "parse" }>;
45
65
  lint(source: string, options?: RequestOptions): Promise<MclResult & { operation: "lint" }>;
46
66
  format(source: string, options?: RequestOptions): Promise<MclResult & { operation: "format" }>;
47
67
  check(source: string, files?: ProjectFiles, options?: RequestOptions): Promise<MclResult & { operation: "check" }>;
48
68
  evaluate(source: string, files?: ProjectFiles, options?: RequestOptions): Promise<MclResult & { operation: "evaluate" }>;
49
69
  render(source: string, files?: ProjectFiles, options?: RequestOptions): Promise<MclResult & { operation: "render" }>;
70
+ definition(source: string, options: PositionRequestOptions): Promise<MclResult & { operation: "definition" }>;
71
+ definition(source: string, files: ProjectFiles | undefined, options: PositionRequestOptions): Promise<MclResult & { operation: "definition" }>;
72
+ hover(source: string, options: PositionRequestOptions): Promise<MclResult & { operation: "hover" }>;
73
+ hover(source: string, files: ProjectFiles | undefined, options: PositionRequestOptions): Promise<MclResult & { operation: "hover" }>;
50
74
  dispose(): void;
51
75
  }
52
76
 
53
77
  export interface MclProject {
54
78
  parse(options?: ProjectOperationOptions): Promise<MclResult & { operation: "parse" }>;
55
79
  lint(options?: ProjectOperationOptions): Promise<MclResult & { operation: "lint" }>;
80
+ complete(options: ProjectCompletionOptions): Promise<MclResult & { operation: "completion" }>;
81
+ definition(options: ProjectNavigationOptions): Promise<MclResult & { operation: "definition" }>;
82
+ hover(options: ProjectNavigationOptions): Promise<MclResult & { operation: "hover" }>;
56
83
  format(options?: ProjectOperationOptions): Promise<MclResult & { operation: "format" }>;
57
84
  check(options?: ProjectOperationOptions): Promise<MclResult & { operation: "check" }>;
58
85
  evaluate(options?: ProjectOperationOptions): Promise<MclResult & { operation: "evaluate" }>;
@@ -68,6 +95,19 @@ export interface ProjectOperationOptions extends RequestOptions {
68
95
  entrypoint?: string;
69
96
  }
70
97
 
98
+ export interface ProjectCompletionOptions extends ProjectOperationOptions {
99
+ position: CompletionPosition;
100
+ }
101
+
102
+ export interface ProjectNavigationOptions extends ProjectOperationOptions {
103
+ position: CompletionPosition;
104
+ }
105
+
106
+ export interface PositionRequestOptions extends RequestOptions {
107
+ entrypoint?: string;
108
+ position: CompletionPosition;
109
+ }
110
+
71
111
  export declare class MclRuntimeError extends Error {
72
112
  readonly code: string;
73
113
  readonly path?: string;
package/src/index.js CHANGED
@@ -101,7 +101,7 @@ export function createMclRuntime(options = {}) {
101
101
  }
102
102
  }
103
103
 
104
- async function execute(operation, source, files, requestOptions = {}, entrypoint = "main.mcl") {
104
+ async function execute(operation, source, files, requestOptions = {}, entrypoint = "main.mcl", position) {
105
105
  const signal = requestOptions.signal;
106
106
  if (signal?.aborted) throw new DOMException("The operation was aborted", "AbortError");
107
107
  const run = async () => {
@@ -113,8 +113,7 @@ export function createMclRuntime(options = {}) {
113
113
  try {
114
114
  if (timeoutMs <= 0) throw timeoutError;
115
115
  timer = setTimeout(() => {
116
- if (stopCurrent) stopCurrent(timeoutError);
117
- else stopInitialization?.(timeoutError);
116
+ (stopCurrent ?? stopInitialization)?.(timeoutError);
118
117
  }, timeoutMs);
119
118
  await waitUntilReady(requestOptions.signal);
120
119
  if (requestOptions.signal?.aborted) throw new DOMException("The operation was aborted", "AbortError");
@@ -160,7 +159,7 @@ export function createMclRuntime(options = {}) {
160
159
  requestOptions.signal?.addEventListener("abort", onAbort, { once: true });
161
160
  stopCurrent = stop;
162
161
  try {
163
- currentWorker.postMessage({ type: "run", requestId, operation, source, files: preparedFiles.files, entrypoint }, preparedFiles.transferables);
162
+ currentWorker.postMessage({ type: "run", requestId, operation, source, files: preparedFiles.files, entrypoint, position }, preparedFiles.transferables);
164
163
  } catch (error) {
165
164
  stop(error);
166
165
  }
@@ -183,6 +182,35 @@ export function createMclRuntime(options = {}) {
183
182
  return Promise.race([result, aborted]).finally(() => signal.removeEventListener("abort", onAbort));
184
183
  }
185
184
 
185
+ function warmUp(requestOptions = {}) {
186
+ const signal = requestOptions.signal;
187
+ if (signal?.aborted) return Promise.reject(new DOMException("The operation was aborted", "AbortError"));
188
+ const run = async () => {
189
+ if (disposed) throw new Error("MCL runtime has been disposed");
190
+ if (signal?.aborted) throw new DOMException("The operation was aborted", "AbortError");
191
+ const timeoutMs = requestOptions.timeoutMs ?? initializationTimeoutMs;
192
+ const timeoutError = new MclRuntimeError({ code: "MCL-WASM-TIMEOUT", message: "MCL WebAssembly initialization timed out" });
193
+ let timer;
194
+ try {
195
+ if (timeoutMs <= 0) throw timeoutError;
196
+ timer = setTimeout(() => stopInitialization?.(timeoutError), timeoutMs);
197
+ await waitUntilReady(signal);
198
+ } finally {
199
+ clearTimeout(timer);
200
+ }
201
+ };
202
+ const result = queue.then(run, run);
203
+ queue = result.catch(() => {});
204
+ if (!signal) return result;
205
+ let onAbort;
206
+ const aborted = new Promise((_, reject) => {
207
+ onAbort = () => reject(new DOMException("The operation was aborted", "AbortError"));
208
+ signal.addEventListener("abort", onAbort, { once: true });
209
+ if (signal.aborted) onAbort();
210
+ });
211
+ return Promise.race([result, aborted]).finally(() => signal.removeEventListener("abort", onAbort));
212
+ }
213
+
186
214
  function openProject(files) {
187
215
  const entries = Object.entries(files ?? {});
188
216
  if (entries.length === 0) throw new TypeError("Project must contain at least one MCL source file");
@@ -214,11 +242,14 @@ export function createMclRuntime(options = {}) {
214
242
  const projectBytes = Object.values(projectFiles).reduce((total, file) => total + (typeof file === "string" ? new TextEncoder().encode(file).byteLength : file.byteLength), 0);
215
243
  if (projectBytes > maxProjectBytes) throw new RangeError(`Project files exceed the ${maxProjectBytes}-byte limit`);
216
244
  const otherFiles = Object.fromEntries(Object.entries(projectFiles).filter(([filePath]) => filePath !== entrypoint));
217
- return execute(operation, source, otherFiles, requestOptions, entrypoint);
245
+ return execute(operation, source, otherFiles, requestOptions, entrypoint, requestOptions.position);
218
246
  };
219
247
  return Object.freeze({
220
248
  parse: (requestOptions) => runProjectOperation("parse", requestOptions),
221
249
  lint: (requestOptions) => runProjectOperation("lint", requestOptions),
250
+ complete: (requestOptions) => runProjectOperation("completion", requestOptions),
251
+ definition: (requestOptions) => runProjectOperation("definition", requestOptions),
252
+ hover: (requestOptions) => runProjectOperation("hover", requestOptions),
222
253
  format: (requestOptions) => runProjectOperation("format", requestOptions),
223
254
  check: (requestOptions) => runProjectOperation("check", requestOptions),
224
255
  evaluate: (requestOptions) => runProjectOperation("evaluate", requestOptions),
@@ -260,14 +291,24 @@ export function createMclRuntime(options = {}) {
260
291
  return { files: transferredFiles, transferables };
261
292
  }
262
293
 
294
+ function runSourceNavigation(operation, source, filesOrOptions, requestOptions) {
295
+ const files = requestOptions === undefined ? undefined : filesOrOptions;
296
+ const options = requestOptions ?? filesOrOptions;
297
+ if (!options?.position) throw new TypeError("A source position is required");
298
+ return execute(operation, source, files, options, options.entrypoint ?? "main.mcl", options.position);
299
+ }
300
+
263
301
  return {
264
302
  openProject,
303
+ warmUp,
265
304
  parse: (source, requestOptions) => execute("parse", source, undefined, requestOptions),
266
305
  lint: (source, requestOptions) => execute("lint", source, undefined, requestOptions),
267
306
  format: (source, requestOptions) => execute("format", source, undefined, requestOptions),
268
307
  check: (source, files, requestOptions) => execute("check", source, files, requestOptions),
269
308
  evaluate: (source, files, requestOptions) => execute("evaluate", source, files, requestOptions),
270
309
  render: (source, files, requestOptions) => execute("render", source, files, requestOptions),
310
+ definition: (source, filesOrOptions, requestOptions) => runSourceNavigation("definition", source, filesOrOptions, requestOptions),
311
+ hover: (source, filesOrOptions, requestOptions) => runSourceNavigation("hover", source, filesOrOptions, requestOptions),
271
312
  dispose() {
272
313
  if (disposed) return;
273
314
  disposed = true;
package/src/protocol.d.ts CHANGED
@@ -1,19 +1,11 @@
1
1
  /* Generated from cmd/mcl-wasm/protocol.schema.json. Do not edit. */
2
2
 
3
3
  export type MCLWebAssemblyRequestAndResponseProtocol = Request | Response;
4
- /**
5
- * Binary files omit content and are supplied in the optional second run argument under the same path.
6
- */
7
- export type FileInput = {
8
- encoding: "utf8" | "binary";
9
- content?: string;
10
- };
11
- export type LintResult = LintDiagnostic[];
12
-
13
- export interface Request {
4
+ export type Request = {
14
5
  requestId?: number;
15
6
  revision?: number;
16
- operation: "parse" | "lint" | "format" | "check" | "evaluate" | "render";
7
+ operation: "parse" | "lint" | "format" | "check" | "evaluate" | "render" | "completion" | "definition" | "hover";
8
+ position?: CompletionPosition;
17
9
  /**
18
10
  * Project-relative MCL source path. Defaults to main.mcl.
19
11
  */
@@ -28,12 +20,34 @@ export interface Request {
28
20
  files?: {
29
21
  [k: string]: FileInput;
30
22
  };
23
+ };
24
+ /**
25
+ * Binary files omit content and are supplied in the optional second run argument under the same path.
26
+ */
27
+ export type FileInput = {
28
+ encoding: "utf8" | "binary";
29
+ content?: string;
30
+ };
31
+ export type LintResult = LintDiagnostic[];
32
+
33
+ export interface CompletionPosition {
34
+ line: number;
35
+ character: number;
31
36
  }
32
37
  export interface Response {
33
38
  requestId: number;
34
39
  revision?: number;
35
40
  ok: boolean;
36
- result?: ParseResult | LintResult | FormatResult | CheckResult | EvaluateResult | RenderResult;
41
+ result?:
42
+ | ParseResult
43
+ | LintResult
44
+ | FormatResult
45
+ | CheckResult
46
+ | EvaluateResult
47
+ | RenderResult
48
+ | CompletionResult
49
+ | DefinitionResult
50
+ | HoverResult;
37
51
  error?: Error;
38
52
  }
39
53
  export interface ParseResult {
@@ -64,6 +78,33 @@ export interface RenderResult {
64
78
  yaml: string;
65
79
  artifacts: number;
66
80
  }
81
+ export interface CompletionResult {
82
+ isIncomplete: boolean;
83
+ items: CompletionItem[];
84
+ }
85
+ export interface CompletionItem {
86
+ label: string;
87
+ kind: number;
88
+ insertText?: string;
89
+ }
90
+ export interface DefinitionResult {
91
+ location: DefinitionLocation | null;
92
+ }
93
+ export interface DefinitionLocation {
94
+ path: string;
95
+ range: SourceRange;
96
+ }
97
+ export interface SourceRange {
98
+ start: CompletionPosition;
99
+ end: CompletionPosition;
100
+ }
101
+ export interface HoverResult {
102
+ hover: HoverInfo | null;
103
+ }
104
+ export interface HoverInfo {
105
+ contents: string;
106
+ range: SourceRange;
107
+ }
67
108
  export interface Error {
68
109
  code: string;
69
110
  message: string;
package/src/worker.js CHANGED
@@ -1,6 +1,5 @@
1
1
  let initialized;
2
2
  let runtimeAssets;
3
- let wasmMemory;
4
3
  let networkAccessDenied = false;
5
4
  const runtimeFetch = globalThis.fetch.bind(globalThis);
6
5
  const networkAPINames = [
@@ -58,7 +57,6 @@ async function initialize() {
58
57
  const go = new Go();
59
58
  const response = await runtimeFetch(runtimeAssets.wasmURL);
60
59
  if (!response.ok) throw new Error(`Unable to load MCL WebAssembly: ${response.status}`);
61
- const instantiateStartedAt = performance.now();
62
60
  // Load the runtime before denying network APIs, then lock them before Go starts.
63
61
  denyNetworkAccess();
64
62
  let instance;
@@ -67,15 +65,9 @@ async function initialize() {
67
65
  } catch {
68
66
  ({ instance } = await WebAssembly.instantiate(await response.arrayBuffer(), go.importObject));
69
67
  }
70
- const wasmInstantiateMs = performance.now() - instantiateStartedAt;
71
- wasmMemory = instance.exports.mem;
72
68
  void go.run(instance);
73
69
  while (!globalThis.mclWasmReady) await new Promise((resolve) => setTimeout(resolve, 0));
74
- postMessage({
75
- type: "ready",
76
- wasmInstantiateMs,
77
- wasmMemoryBytes: wasmMemory.buffer.byteLength,
78
- });
70
+ postMessage({ type: "ready" });
79
71
  })().catch((error) => {
80
72
  postMessage({ type: "fatal", message: error instanceof Error ? error.message : String(error) });
81
73
  throw error;
@@ -122,6 +114,7 @@ self.addEventListener("message", async (event) => {
122
114
  revision: message.requestId,
123
115
  operation: message.operation,
124
116
  entrypoint: message.entrypoint,
117
+ position: message.position,
125
118
  source: message.source,
126
119
  files: encodedFiles.files,
127
120
  };
@@ -130,7 +123,6 @@ self.addEventListener("message", async (event) => {
130
123
  type: "response",
131
124
  requestId: message.requestId,
132
125
  value,
133
- wasmMemoryBytes: wasmMemory.buffer.byteLength,
134
126
  });
135
127
  } catch (error) {
136
128
  postMessage({