@vector-im/matrix-wysiwyg 2.37.13 → 2.38.0

package/node_modules/@vector-im/matrix-wysiwyg-wasm/README.md

@@ -0,0 +1,61 @@
+# `wysiwyg-wasm`
+
+WASM/JavaScript bindings for wysiwyg-rust.
+
+## Building
+
+* [Install Rust](https://www.rust-lang.org/tools/install)
+* [Install NodeJS and NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+* [Install wasm-pack](https://rustwasm.github.io/wasm-pack/installer/)
+* Run:
+
+```sh
+cd bindings/wysiwyg-wasm
+yarn
+yarn build
+#yarn test (no tests yet)
+```
+
+This will generate:
+
+```
+pkg/matrix_sdk_wysiwyg_bg.wasm
+pkg/matrix_sdk_wysiwyg_bg.wasm.d.ts
+pkg/matrix_sdk_wysiwyg.d.ts
+pkg/matrix_sdk_wysiwyg.js
+... plus other files
+```
+
+You can then consume these files in your project by linking the package in your package.json:
+
+```json
+{
+  "dependencies": {
+    "@matrix-org/matrix-sdk-wysiwyg-wasm": "link:../../bindings/wysiwyg-wasm"
+  }
+}
+```
+
+And consume with code like this:
+
+```html
+<script type="module">
+import { initAsync, some_method_from_rust } from '@matrix-org/matrix-sdk-wysiwyg-wasm';
+
+async function run() {
+    await initAsync();
+    some_method_from_rust();
+}
+
+run();
+</script>
+```
+
+## Profiling
+
+To generate a debugging/profiling Wasm module, use the following command
+instead of `yarn build`:
+
+```sh
+$ yarn dev-build
+```

package/node_modules/@vector-im/matrix-wysiwyg-wasm/index-wasm-esm.js

@@ -0,0 +1,64 @@
+/*
+Copyright 2024 New Vector Ltd.
+
+SPDX-License-Identifier: AGPL-3.0-only
+Please see LICENSE in the repository root for full details.
+*/
+
+// @ts-check
+
+/**
+ * This is the entrypoint on non-node ESM environments which support the ES Module Integration Proposal for WebAssembly [1]
+ * (such as Element Web).
+ *
+ * [1]: https://github.com/webassembly/esm-integration
+ */
+
+import * as bindings from './pkg/wysiwyg_bg.js';
+
+// We want to throw an error if the user tries to use the bindings before
+// calling `initAsync`.
+bindings.__wbg_set_wasm(
+    new Proxy(
+        {},
+        {
+            get() {
+                throw new Error(
+                    '@element-hq/matrix-wysiwyg was used before it was initialized. Call `initAsync` first.',
+                );
+            },
+        },
+    ),
+);
+
+/**
+ * Stores a promise of the `loadModule` call
+ * @type {Promise<void> | null}
+ */
+let modPromise = null;
+
+/**
+ * Loads the WASM module asynchronously
+ *
+ * @returns {Promise<void>}
+ */
+async function loadModule() {
+    const wasm = await import('./pkg/wysiwyg_bg.wasm');
+    bindings.__wbg_set_wasm(wasm);
+    wasm.__wbindgen_start();
+}
+
+/**
+ * Load the WebAssembly module in the background, if it has not already been loaded.
+ *
+ * Returns a promise which will resolve once the other methods are ready.
+ *
+ * @returns {Promise<void>}
+ */
+export async function initAsync() {
+    if (!modPromise) modPromise = loadModule();
+    await modPromise;
+}
+
+// Re-export everything from the generated javascript wrappers
+export * from './pkg/wysiwyg_bg.js';

package/node_modules/@vector-im/matrix-wysiwyg-wasm/index.cjs

@@ -0,0 +1,85 @@
+/*
+Copyright 2024 New Vector Ltd.
+
+SPDX-License-Identifier: AGPL-3.0-only
+Please see LICENSE in the repository root for full details.
+*/
+
+// @ts-check
+
+/**
+ * This is the entrypoint on non-node CommonJS environments.
+ * `initAsync` will load the WASM module using a `fetch` call.
+ */
+
+const bindings = require("./pkg/wysiwyg_bg.cjs");
+
+const moduleUrl = require.resolve("./pkg/wysiwyg_bg.wasm");
+
+// We want to throw an error if the user tries to use the bindings before
+// calling `initAsync`.
+bindings.__wbg_set_wasm(
+    new Proxy(
+        {},
+        {
+            get() {
+                throw new Error(
+                    '@element-hq/matrix-wysiwyg was used before it was initialized. Call `initAsync` first.',
+                );
+            },
+        },
+    ),
+);
+
+/**
+ * Stores a promise of the `loadModule` call
+ * @type {Promise<void> | null}
+ */
+let modPromise = null;
+
+/**
+ * Loads the WASM module asynchronously
+ *
+ * @returns {Promise<void>}
+ */
+async function loadModule() {
+    let mod;
+    if (typeof WebAssembly.compileStreaming === 'function') {
+        mod = await WebAssembly.compileStreaming(fetch(moduleUrl));
+    } else {
+        // Fallback to fetch and compile
+        const response = await fetch(moduleUrl);
+        if (!response.ok) {
+            throw new Error(`Failed to fetch wasm module: ${moduleUrl}`);
+        }
+        const bytes = await response.arrayBuffer();
+        mod = await WebAssembly.compile(bytes);
+    }
+
+    /** @type {{exports: typeof import("./pkg/wysiwyg_bg.wasm.d.ts")}} */
+    // @ts-expect-error: Typescript doesn't know what the instance exports exactly
+    const instance = await WebAssembly.instantiate(mod, {
+        './wysiwyg_bg.js': bindings,
+    });
+
+    bindings.__wbg_set_wasm(instance.exports);
+    instance.exports.__wbindgen_start();
+}
+
+/**
+ * Load the WebAssembly module in the background, if it has not already been loaded.
+ *
+ * Returns a promise which will resolve once the other methods are ready.
+ *
+ * @returns {Promise<void>}
+ */
+async function initAsync() {
+    if (!modPromise) modPromise = loadModule();
+    await modPromise;
+}
+
+module.exports = {
+    // Re-export everything from the generated javascript wrappers
+    ...bindings,
+    initAsync,
+};

package/node_modules/@vector-im/matrix-wysiwyg-wasm/index.d.ts

@@ -0,0 +1,17 @@
+/*
+Copyright 2024 New Vector Ltd.
+
+SPDX-License-Identifier: AGPL-3.0-only
+Please see LICENSE in the repository root for full details.
+*/
+
+export * from './pkg/wysiwyg.d';
+
+/**
+ * Load the WebAssembly module in the background, if it has not already been loaded.
+ *
+ * Returns a promise which will resolve once the other methods are ready.
+ *
+ * @returns {Promise<void>}
+ */
+export function initAsync(): Promise<void>;

package/node_modules/@vector-im/matrix-wysiwyg-wasm/index.js

@@ -0,0 +1,85 @@
+/*
+Copyright 2024 New Vector Ltd.
+
+SPDX-License-Identifier: AGPL-3.0-only
+Please see LICENSE in the repository root for full details.
+*/
+
+// @ts-check
+
+/**
+ * This is the entrypoint on non-node ESM environments.
+ * `initAsync` will load the WASM module using a `fetch` call.
+ */
+
+import * as bindings from './pkg/wysiwyg_bg.js';
+
+const moduleUrl = new URL(
+    './pkg/wysiwyg_bg.wasm?url',
+    import.meta.url,
+);
+
+// We want to throw an error if the user tries to use the bindings before
+// calling `initAsync`.
+bindings.__wbg_set_wasm(
+    new Proxy(
+        {},
+        {
+            get() {
+                throw new Error(
+                    '@element-hq/matrix-wysiwyg was used before it was initialized. Call `initAsync` first.',
+                );
+            },
+        },
+    ),
+);
+
+/**
+ * Stores a promise of the `loadModule` call
+ * @type {Promise<void> | null}
+ */
+let modPromise = null;
+
+/**
+ * Loads the WASM module asynchronously
+ *
+ * @returns {Promise<void>}
+ */
+async function loadModule() {
+    let mod;
+    if (typeof WebAssembly.compileStreaming === 'function') {
+        mod = await WebAssembly.compileStreaming(fetch(moduleUrl));
+    } else {
+        // Fallback to fetch and compile
+        const response = await fetch(moduleUrl);
+        if (!response.ok) {
+            throw new Error(`Failed to fetch wasm module: ${moduleUrl}`);
+        }
+        const bytes = await response.arrayBuffer();
+        mod = await WebAssembly.compile(bytes);
+    }
+
+    /** @type {{exports: typeof import("./pkg/wysiwyg_bg.wasm.d.ts")}} */
+    // @ts-expect-error: Typescript doesn't know what the instance exports exactly
+    const instance = await WebAssembly.instantiate(mod, {
+        './wysiwyg_bg.js': bindings,
+    });
+
+    bindings.__wbg_set_wasm(instance.exports);
+    instance.exports.__wbindgen_start();
+}
+
+/**
+ * Load the WebAssembly module in the background, if it has not already been loaded.
+ *
+ * Returns a promise which will resolve once the other methods are ready.
+ *
+ * @returns {Promise<void>}
+ */
+export async function initAsync() {
+    if (!modPromise) modPromise = loadModule();
+    await modPromise;
+}
+
+// Re-export everything from the generated javascript wrappers
+export * from './pkg/wysiwyg_bg.js';

package/node_modules/@vector-im/matrix-wysiwyg-wasm/node.cjs

@@ -0,0 +1,120 @@
+/*
+Copyright 2024 New Vector Ltd.
+
+SPDX-License-Identifier: AGPL-3.0-only
+Please see LICENSE in the repository root for full details.
+*/
+
+// @ts-check
+
+/**
+ * This is the entrypoint on node-compatible CommonJS environments.
+ * `asyncLoad` will use `fs.readFile` to load the WASM module.
+ */
+
+const { readFileSync } = require("node:fs");
+const { readFile } = require("node:fs/promises");
+const path = require("node:path");
+const bindings = require("./pkg/wysiwyg_bg.cjs");
+
+const filename = path.join(__dirname, "pkg/wysiwyg_bg.wasm");
+
+// In node environments, we want to automatically load the WASM module
+// synchronously if the consumer did not call `initAsync`. To do so, we install
+// a `Proxy` that will intercept calls to the WASM module.
+bindings.__wbg_set_wasm(
+    new Proxy(
+        {},
+        {
+            get(_target, prop) {
+                const instance = loadModuleSync();
+                return instance[prop];
+            },
+        },
+    ),
+);
+
+/**
+ * Stores a promise of the `loadModule` call
+ * @type {Promise<void> | null}
+ */
+let modPromise = null;
+
+/**
+ * Tracks whether the module has been instantiated or not
+ * @type {boolean}
+ */
+let initialised = false;
+
+/**
+ * Loads and instantiates the WASM module synchronously
+ *
+ * It will throw if there is an attempt to load the module asynchronously running
+ *
+ * @returns {typeof import("./pkg/wysiwyg_bg.wasm.d")}
+ */
+function loadModuleSync() {
+  if (modPromise) throw new Error("The WASM module is being loaded asynchronously but hasn't finished");
+  const bytes = readFileSync(filename);
+  const mod = new WebAssembly.Module(bytes);
+
+  const instance = new WebAssembly.Instance(mod, {
+    // @ts-expect-error: The bindings don't exactly match the 'ExportValue' type
+    "./wysiwyg_bg.js": bindings,
+  });
+
+  initInstance(instance);
+
+  // @ts-expect-error: Typescript doesn't know what the instance exports exactly
+  return instance.exports;
+}
+
+/**
+ * Loads the WASM module asynchronously
+ *
+ * @returns {Promise<void>}
+ */
+async function loadModuleAsync() {
+  const bytes = await readFile(filename);
+  const { instance } = await WebAssembly.instantiate(bytes, {
+    // @ts-expect-error: The bindings don't exactly match the 'ExportValue' type
+    "./wysiwyg_bg.js": bindings,
+  });
+
+  initInstance(instance);
+
+  // @ts-expect-error: Typescript doesn't know what the instance exports exactly
+  return instance.exports;
+}
+
+/**
+ * Initializes the WASM module and returns the exports from the WASM module.
+ *
+ * @param {WebAssembly.Instance} instance
+ */
+function initInstance(instance) {
+  if (initialised) throw new Error("initInstance called twice");
+  bindings.__wbg_set_wasm(instance.exports);
+  // @ts-expect-error: Typescript doesn't know what the instance exports exactly
+  instance.exports.__wbindgen_start();
+  initialised = true;
+}
+
+/**
+ * Load the WebAssembly module in the background, if it has not already been loaded.
+ *
+ * Returns a promise which will resolve once the other methods are ready.
+ *
+ * @returns {Promise<void>}
+ */
+async function initAsync() {
+    if (initialised) return;
+    if (!modPromise) modPromise = loadModuleAsync();
+    await modPromise;
+}
+
+module.exports = {
+    // Re-export everything from the generated javascript wrappers
+    ...bindings,
+    initAsync,
+};

package/node_modules/@vector-im/matrix-wysiwyg-wasm/node.js

@@ -0,0 +1,117 @@
+/*
+Copyright 2024 New Vector Ltd.
+
+SPDX-License-Identifier: AGPL-3.0-only
+Please see LICENSE in the repository root for full details.
+*/
+
+// @ts-check
+
+/**
+ * This is the entrypoint on node-compatible ESM environments.
+ * `asyncLoad` will use `fs.readFile` to load the WASM module.
+ */
+
+import { fileURLToPath } from "node:url";
+import { join, dirname } from "node:path";
+import { readFileSync } from "node:fs";
+import { readFile } from "node:fs/promises";
+import * as bindings from "./pkg/wysiwyg_bg.js";
+
+const filename = join(dirname(fileURLToPath(import.meta.url)), "pkg", "wysiwyg_bg.wasm");
+
+// In node environments, we want to automatically load the WASM module
+// synchronously if the consumer did not call `initAsync`. To do so, we install
+// a `Proxy` that will intercept calls to the WASM module.
+bindings.__wbg_set_wasm(
+    new Proxy(
+        {},
+        {
+            get(_target, prop) {
+                const instance = loadModuleSync();
+                return instance[prop];
+            },
+        },
+    ),
+);
+
+/**
+ * Stores a promise of the `loadModule` call
+ * @type {Promise<void> | null}
+ */
+let modPromise = null;
+
+/**
+ * Tracks whether the module has been instantiated or not
+ * @type {boolean}
+ */
+let initialised = false;
+
+/**
+ * Loads and instantiates the WASM module synchronously
+ *
+ * It will throw if there is an attempt to load the module asynchronously running
+ *
+ * @returns {typeof import("./pkg/wysiwyg_bg.wasm.d")}
+ */
+function loadModuleSync() {
+  if (modPromise) throw new Error("The WASM module is being loaded asynchronously but hasn't finished");
+  const bytes = readFileSync(filename);
+  const mod = new WebAssembly.Module(bytes);
+
+  const instance = new WebAssembly.Instance(mod, {
+    // @ts-expect-error: The bindings don't exactly match the 'ExportValue' type
+    "./wysiwyg_bg.js": bindings,
+  });
+
+  initInstance(instance);
+
+  // @ts-expect-error: Typescript doesn't know what the instance exports exactly
+  return instance.exports;
+}
+
+/**
+ * Loads the WASM module asynchronously
+ *
+ * @returns {Promise<void>}
+ */
+async function loadModuleAsync() {
+  const bytes = await readFile(filename);
+  const { instance } = await WebAssembly.instantiate(bytes, {
+    // @ts-expect-error: The bindings don't exactly match the 'ExportValue' type
+    "./wysiwyg_bg.js": bindings,
+  });
+
+  initInstance(instance);
+
+  // @ts-expect-error: Typescript doesn't know what the instance exports exactly
+  return instance.exports;
+}
+
+/**
+ * Initializes the WASM module and returns the exports from the WASM module.
+ *
+ * @param {WebAssembly.Instance} instance
+ */
+function initInstance(instance) {
+  if (initialised) throw new Error("initInstance called twice");
+  bindings.__wbg_set_wasm(instance.exports);
+  // @ts-expect-error: Typescript doesn't know what the instance exports exactly
+  instance.exports.__wbindgen_start();
+  initialised = true;
+}
+
+/**
+ * Load the WebAssembly module in the background, if it has not already been loaded.
+ *
+ * Returns a promise which will resolve once the other methods are ready.
+ *
+ * @returns {Promise<void>}
+ */
+export async function initAsync() {
+    if (initialised) return;
+    if (!modPromise) modPromise = loadModuleAsync();
+    await modPromise;
+}
+
+export * from "./pkg/wysiwyg_bg.js";

package/node_modules/@vector-im/matrix-wysiwyg-wasm/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@vector-im/matrix-wysiwyg-wasm",
+  "version": "2.38.0",
+  "homepage": "https://gitlab.com/andybalaam/wysiwyg-rust",
+  "description": "WASM bindings for wysiwyg-rust",
+  "license": "AGPL-3.0",
+  "type": "module",
+  "collaborators": [
+    "Andy Balaam <andy.balaam@matrix.org>"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/andybalaam/wysiwyg-rust"
+  },
+  "keywords": [
+    "matrix",
+    "chat",
+    "messaging",
+    "wysiwyg"
+  ],
+  "exports": {
+    ".": {
+      "matrix-org:wasm-esm": {
+        "types": "./index.d.ts",
+        "default": "./index-wasm-esm.js"
+      },
+      "require": {
+        "types": "./index.d.ts",
+        "node": "./node.cjs",
+        "default": "./index.cjs"
+      },
+      "import": {
+        "types": "./index.d.ts",
+        "node": "./node.js",
+        "default": "./index.js"
+      }
+    }
+  },
+  "files": [
+    "pkg/wysiwyg_bg.js",
+    "pkg/wysiwyg_bg.cjs",
+    "pkg/wysiwyg_bg.wasm",
+    "pkg/wysiwyg_bg.wasm.d.ts",
+    "pkg/wysiwyg.d.ts",
+    "index.d.ts",
+    "index.js",
+    "index.cjs",
+    "index-wasm-esm.js",
+    "node.js",
+    "node.cjs"
+  ],
+  "devDependencies": {
+    "@babel/cli": "^7.23.5",
+    "@babel/plugin-transform-modules-commonjs": "^7.25.9",
+    "@types/node": "^22.10.2",
+    "jest": "^28.1.0",
+    "typedoc": "^0.26.0",
+    "typescript": "^5.7.2",
+    "wasm-pack": "^0.13.1"
+  },
+  "engines": {
+    "node": ">= 10"
+  },
+  "scripts": {
+    "dev-build": "WASM_BINDGEN_WEAKREF=1 wasm-pack build --profiling --target bundler --out-name wysiwyg --out-dir ./pkg",
+    "build": "yarn build:esm && yarn build:cjs && yarn lint",
+    "build:esm": "RUSTFLAGS='-C opt-level=s' WASM_BINDGEN_WEAKREF=1 wasm-pack build --release --target bundler --out-name wysiwyg --out-dir ./pkg",
+    "build:cjs": "babel pkg/wysiwyg_bg.js --out-dir pkg --out-file-extension .cjs --plugins @babel/plugin-transform-modules-commonjs",
+    "lint": "tsc --noEmit",
+    "test": "jest --verbose",
+    "doc": "typedoc --tsconfig ."
+  }
+}