@aardarch/aardink-web 0.5.0

package/JETBRAINS_MONO_OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2020 The JetBrains Mono Project Authors (https://github.com/JetBrains/JetBrainsMono)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/LICENSE

@@ -0,0 +1,178 @@
+                                 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 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 transformations
+      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, as submitted to the 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 designated in writing by the copyright owner as
+      "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      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 the combined contribution 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 any Work embodying the Work constitutes direct or
+      contributory patent infringement, then any patent rights 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, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, 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 license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the Work.
+
+   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 conditions of
+      TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing 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 exemplary 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 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 offer only
+      conditions consistent with this License.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Aardarch
+
+   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

@@ -0,0 +1,86 @@
+# @aardarch/aardink-web
+
+The [Aardink](https://github.com/aardarch/aardink) code editor for the browser: Compose
+Multiplatform compiled to WebAssembly, behind a small Monaco-shaped API. It covers syntax
+highlighting for Kotlin, TypeScript, JSON, TOML, XML, HTML, CSS and Markdown, plus folding,
+find and replace, diagnostics, undo/redo and six themes.
+
+## Install
+
+```sh
+pnpm add @aardarch/aardink-web     # or: npm install @aardarch/aardink-web
+```
+
+The package is plain ES modules plus two `.wasm` files and a font. It needs a bundler that
+understands `new URL('./file', import.meta.url)`, which Vite, webpack 5 and Rollup all do.
+
+## Use
+
+```ts
+import { createEditor, preloadAardink } from '@aardarch/aardink-web';
+
+preloadAardink(); // optional: start loading the WebAssembly module early
+
+const editor = await createEditor(document.getElementById('editor')!, (text) => save(text), {
+  value: source,
+  language: 'xml',
+  theme: 'vscode-dark',
+  wordWrap: 'on',
+});
+
+editor.updateOptions({ readOnly: true });
+editor.setDiagnostics([
+  { line: 3, startColumn: 5, endColumn: 9, message: 'Unknown tag', severity: 'error' },
+]);
+const stop = editor.onDidChangeCursor((line, column) => showPosition(line, column));
+editor.dispose();
+```
+
+The editor fills its container, so give the container a size. `createEditor` is async because
+the first call loads the WebAssembly module (about 13 MB, 4.7 MB gzipped); every editor on the
+page shares that one module. See [`index.d.ts`](./index.d.ts) for the full API.
+
+## Vite
+
+```js
+// vite.config.js
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+  // The dev-server pre-bundler would move the package into .vite/deps and break the
+  // new URL(..., import.meta.url) references the loader relies on.
+  optimizeDeps: { exclude: ['@aardarch/aardink-web'] },
+  build: { target: 'es2022', chunkSizeWarningLimit: 3500 },
+});
+```
+
+`vite build` prints two harmless warnings about `node:fs` and `node:url` being externalised:
+the Kotlin loader has Node and Deno branches that never run in a browser. Serve `.wasm` with
+`Content-Type: application/wasm`.
+
+## Browser support
+
+Chrome and Edge 119+, Firefox 120+, Safari 18.2+: the module needs WebAssembly garbage
+collection and exception handling.
+
+## Known limitations
+
+Read these before adopting the package; the
+[integration guide](https://github.com/aardarch/aardink/blob/main/docs/WEB_INTEGRATION.md) has
+the measurements and the device checklist.
+
+- **Typing latency grows with document size, and fast typing can lose keys in large files.**
+  Up to a few hundred lines of highlighted code it is comfortable. At 1,000 lines each keystroke
+  keeps the editor busy for about half a second, and typing at 10 keys a second can drop around
+  half the keys. At 5,000 lines each keystroke keeps it busy for several seconds. 0.5.x is for
+  small files such as configuration or markup documents; a virtualised renderer that fixes this
+  is planned for 0.6.0.
+- **A disposed editor is not fully released** (about 275 KB each), because Compose
+  Multiplatform cannot yet tear down its viewport. Reuse one editor with `setValue` and
+  `updateOptions` rather than mounting one per view.
+- There is no minimap, bracket-pair colouring or multi-cursor yet.
+
+## Licence
+
+Apache-2.0. The bundled JetBrains Mono font is under the SIL Open Font License 1.1; see
+`JETBRAINS_MONO_OFL.txt`.

package/index.d.ts

@@ -0,0 +1,75 @@
+/*
+ * Copyright 2026 Aardarch
+ *
+ * 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
+ *
+ *     https://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.
+ */
+
+/** Editor options. Every field is optional; `updateOptions` changes only the ones you pass. */
+export interface AardinkOptions {
+  /** Initial text. Only read by `createEditor`. */
+  value?: string;
+  /** A language id: kotlin, typescript, json, toml, xml, html, css, markdown, plaintext. */
+  language?: string;
+  /** vscode-dark, vscode-light, material-dark, material-light, midnight-ocean, solarized-dark. */
+  theme?: string;
+  /** In CSS pixels. */
+  fontSize?: number;
+  wordWrap?: 'on' | 'off';
+  readOnly?: boolean;
+  showGutter?: boolean;
+  showLineNumbers?: boolean;
+  showFoldMarkers?: boolean;
+}
+
+/** Monaco-marker shape: 1-based line and columns, `endColumn` exclusive. */
+export interface AardinkDiagnostic {
+  line: number;
+  startColumn: number;
+  endColumn: number;
+  message: string;
+  severity: 'error' | 'warning' | 'info';
+}
+
+export interface AardinkEditor {
+  getValue(): string;
+  /** Replaces the whole text and clears undo history. Fires the change listeners. */
+  setValue(text: string): void;
+  updateOptions(options: Partial<AardinkOptions>): void;
+  /** Full text after every change, at most once per frame. Returns an unsubscribe function. */
+  onDidChangeContent(listener: (text: string) => void): () => void;
+  /** 1-based caret position. Returns an unsubscribe function. */
+  onDidChangeCursor(listener: (line: number, column: number) => void): () => void;
+  setDiagnostics(diagnostics: AardinkDiagnostic[]): void;
+  revealPosition(line: number, column: number): void;
+  showFind(): void;
+  undo(): boolean;
+  redo(): boolean;
+  /** Stops the editor. Safe to call twice. Remove or reuse the container yourself. */
+  dispose(): void;
+}
+
+/**
+ * Mounts an editor that fills `container`. Loads the WebAssembly module on first use (see
+ * `preloadAardink`). `onChange` is registered as the first content listener.
+ */
+export function createEditor(
+  container: HTMLElement,
+  onChange?: (text: string) => void,
+  options?: AardinkOptions,
+): Promise<AardinkEditor>;
+
+/** Starts loading the WebAssembly module without mounting anything. */
+export function preloadAardink(): Promise<void>;
+
+/** The Aardink version this package was built from. */
+export const version: string;

package/index.js

@@ -0,0 +1,92 @@
+/*
+ * Copyright 2026 Aardarch
+ *
+ * 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
+ *
+ *     https://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.
+ */
+
+// Adapts the Kotlin module's integer-handle exports (aardinkCreate, aardinkGetValue, ...) into
+// the Monaco-shaped object described in index.d.ts.
+
+export const version = '0.5.0';
+
+let kotlinModule;
+
+function load() {
+  // Memoised: every editor on the page shares one WebAssembly instance.
+  kotlinModule ??= import('./kotlin/aardink-web.mjs').then((k) => {
+    // Compose looks for resources relative to the page, not this package. A literal
+    // new URL(..., import.meta.url) is also what makes a bundler (Vite) emit the font file.
+    k.aardinkSetBundledFontUrl(
+      new URL('./kotlin/composeResources/com.aardarch.aardink.web.res/font/jetbrains_mono_regular.ttf', import.meta.url).href,
+    );
+    return k;
+  });
+  return kotlinModule;
+}
+
+export function preloadAardink() {
+  return load().then(() => undefined);
+}
+
+let generatedIds = 0;
+
+/** Keeps only the fields the Kotlin side knows, translating Monaco's wordWrap 'on'/'off'. */
+function toKotlinOptions(options) {
+  const out = {};
+  for (const key of ['language', 'theme', 'fontSize', 'readOnly', 'showGutter', 'showLineNumbers', 'showFoldMarkers']) {
+    if (options[key] !== undefined) out[key] = options[key];
+  }
+  if (options.wordWrap !== undefined) out.wordWrap = options.wordWrap === 'on';
+  return out;
+}
+
+export async function createEditor(container, onChange, options = {}) {
+  const k = await load();
+  if (!container.id) container.id = `aardink-editor-${++generatedIds}`;
+  const id = k.aardinkCreate(container.id, options.value ?? '', JSON.stringify(toKotlinOptions(options)));
+
+  // The Kotlin side holds one listener of each kind; fan out to any number here.
+  const contentListeners = new Set();
+  const cursorListeners = new Set();
+  k.aardinkOnChange(id, (text) => contentListeners.forEach((listener) => listener(text)));
+  k.aardinkOnCursorChange(id, (line, column) => cursorListeners.forEach((listener) => listener(line, column)));
+  if (onChange) contentListeners.add(onChange);
+
+  let disposed = false;
+
+  return {
+    getValue: () => k.aardinkGetValue(id),
+    setValue: (text) => k.aardinkSetValue(id, text),
+    updateOptions: (patch) => k.aardinkUpdateOptions(id, JSON.stringify(toKotlinOptions(patch))),
+    onDidChangeContent(listener) {
+      contentListeners.add(listener);
+      return () => contentListeners.delete(listener);
+    },
+    onDidChangeCursor(listener) {
+      cursorListeners.add(listener);
+      return () => cursorListeners.delete(listener);
+    },
+    setDiagnostics: (diagnostics) => k.aardinkSetDiagnostics(id, JSON.stringify(diagnostics)),
+    revealPosition: (line, column) => k.aardinkRevealPosition(id, line, column),
+    showFind: () => k.aardinkShowFind(id),
+    undo: () => k.aardinkUndo(id),
+    redo: () => k.aardinkRedo(id),
+    dispose() {
+      if (disposed) return;
+      disposed = true;
+      contentListeners.clear();
+      cursorListeners.clear();
+      k.aardinkDispose(id);
+    },
+  };
+}