swls-wasm 0.3.2-alpha.2 → 0.3.2-alpha.4

package/README.md

@@ -1,86 +1,67 @@
-# SWLS-Web
+# swls-wasm
 
-WASM bindings for the semantic web language server.
+The [Semantic Web Language Server](https://github.com/SemanticWebLanguageServer/swls)
+(Turtle, TriG, SPARQL, JSON-LD) compiled to WebAssembly, plus thin helpers for
+running it as a worker. Built with `wasm-pack --target web`, so it loads in
+browsers, bundlers, Web Workers and Node without any bundler plugins.
 
-As SWLS is not yet published, this package expects SWLS to be present in the parent directory.
+Both directions exchange whole JSON-RPC messages over `postMessage` with **no
+`Content-Length` framing**.
 
-## 🚴 Usage
+## Browser / bundler — `createSwlsWorker()`
 
-### 🛠️ Build with `wasm-pack build`
+The easiest path: get a ready-to-use Web Worker. Works with Vite, webpack, etc.
+(the bundler picks up the worker and its `.wasm` automatically).
 
-```
-wasm-pack build
-```
-
-### 🔬 Test in Headless Browsers with `wasm-pack test`
+```js
+import { createSwlsWorker } from "swls-wasm/client";
 
+const worker = createSwlsWorker();
+// hand `worker` to your editor's LSP client (e.g. swls-codemirror, monaco)
 ```
-wasm-pack test --headless --firefox
-```
-
-### 🎁 Publish to NPM with `wasm-pack publish`
-
-```
-wasm-pack publish
-```
-
-
-## Custom LSP Requests
-
-The WASM LSP server sends custom requests **from server to client** that the host must handle. All requests use `params: { url: string }`.
 
-If a handler is not implemented, the server falls back to a sensible default.
+The worker emits `{ jsonrpc: "2.0", method: "swls/ready" }` once the wasm has
+finished initializing.
 
-### `custom/readFile`
+## From a CDN — no build step
 
-Reads the contents of a file.
+`worker.js` and its sibling `swls_wasm_bg.wasm` are both published, so a worker
+can be loaded straight from a CDN:
 
-```ts
-params:  { url: string }
-result:  { content: string } | { error: string }
+```js
+const worker = new Worker(
+  "https://cdn.jsdelivr.net/npm/swls-wasm@0.3/worker.js",
+  { type: "module" },
+);
 ```
 
-### `custom/readDir`
+The worker resolves `swls_wasm_bg.wasm` relative to its own URL, so it is fetched
+from the same CDN path. Cross-origin module workers need permissive CORS (jsDelivr
+and unpkg send it); Safari is stricter about cross-origin worker scripts, so if you
+need to support it, load a small same-origin bootstrap that `import()`s the CDN URL.
 
-Lists the entries of a directory.
+## Custom host — `createSwlsServer()`
 
-```ts
-params:  { url: string }
-result:  Array<{ name: string; path: string; is_dir: boolean }>
-// fallback: returns null/error → treated as empty
-```
-
-### `custom/isFile`
-
-Returns whether the given URL refers to a file.
-
-```ts
-params:  { url: string }
-result:  boolean
-// fallback: true when URL does not end with '/'
-```
+For hosts that aren't a DOM `Worker` (a Node `worker_threads` worker, the VS Code
+web-extension host, …): wire the server to your own transport. `post` receives
+each outgoing message (already parsed); feed incoming messages (object or string)
+into the returned function.
 
-### `custom/isDir`
+```js
+import { createSwlsServer } from "swls-wasm";
 
-Returns whether the given URL refers to a directory.
+const feed = await createSwlsServer((message) => sendToClient(message), {
+  debug: (line) => console.log(line),
+  // Optional: override how the wasm is loaded. Defaults to fetching the sibling
+  // `swls_wasm_bg.wasm`; pass bytes/URL when the host can't fetch that itself
+  // (e.g. Node, which can't `fetch` a `file://` URL).
+  wasm: undefined,
+});
 
-```ts
-params:  { url: string }
-result:  boolean
-// fallback: true when URL ends with '/'
+feed({ jsonrpc: "2.0", id: 1, method: "initialize", params: { /* … */ } });
 ```
 
-### `custom/canonicalize`
-
-Resolves a URL to its canonical form.
-
-```ts
-params:  { url: string }
-result:  { url: string }
-// fallback: returns the input URL unchanged
-```
-
-## License
-
-* MIT license ([LICENSE](LICENSE) or http://opensource.org/licenses/MIT)
+## Low-level — `WasmLsp`
 
+`WasmLsp` (and the wasm `init` default export) are also re-exported for full
+control. `createSwlsServer` is just a thin wrapper around them.

package/package.json

@@ -4,7 +4,7 @@
   "collaborators": [
     "ajuvercr <arthur.vercruysse@outlook.com>"
   ],
-  "version": "0.3.2-alpha.2",
+  "version": "0.3.2-alpha.4",
   "files": [
     "swls_wasm_bg.wasm",
     "swls_wasm.js",

package/swls_wasm.js

@@ -329,7 +329,7 @@ function __wbg_get_imports() {
             return ret;
         },
         __wbindgen_cast_0000000000000001: function(arg0, arg1) {
-            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 4783, ret: Result(Unit), inner_ret: Some(Result(Unit)) }, mutable: true }) -> Externref`.
+            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 4958, ret: Result(Unit), inner_ret: Some(Result(Unit)) }, mutable: true }) -> Externref`.
             const ret = makeMutClosure(arg0, arg1, wasm_bindgen__convert__closures_____invoke__h5d8169a9c6a0716a);
             return ret;
         },