toilscript 0.1.12 → 0.1.14

package/dist/importmap.json

@@ -1,7 +1,7 @@
 {
   "imports": {
-    "toilscript": "https://cdn.jsdelivr.net/npm/toilscript@0.1.12/dist/toilscript.js",
-    "toilscript/cli": "https://cdn.jsdelivr.net/npm/toilscript@0.1.12/dist/cli.js",
+    "toilscript": "https://cdn.jsdelivr.net/npm/toilscript@0.1.14/dist/toilscript.js",
+    "toilscript/cli": "https://cdn.jsdelivr.net/npm/toilscript@0.1.14/dist/cli.js",
     "binaryen": "https://cdn.jsdelivr.net/npm/binaryen@129.0.0-nightly.20260428/index.js",
     "long": "https://cdn.jsdelivr.net/npm/long@5.3.2/index.js"
   }

package/dist/web.js

@@ -1,8 +1,8 @@
-var ASSEMBLYSCRIPT_VERSION = "0.1.12";
+var ASSEMBLYSCRIPT_VERSION = "0.1.14";
   var ASSEMBLYSCRIPT_IMPORTMAP = {
   "imports": {
-    "toilscript": "https://cdn.jsdelivr.net/npm/toilscript@0.1.12/dist/toilscript.js",
-    "toilscript/cli": "https://cdn.jsdelivr.net/npm/toilscript@0.1.12/dist/cli.js",
+    "toilscript": "https://cdn.jsdelivr.net/npm/toilscript@0.1.14/dist/toilscript.js",
+    "toilscript/cli": "https://cdn.jsdelivr.net/npm/toilscript@0.1.14/dist/cli.js",
     "binaryen": "https://cdn.jsdelivr.net/npm/binaryen@129.0.0-nightly.20260428/index.js",
     "long": "https://cdn.jsdelivr.net/npm/long@5.3.2/index.js"
   }

package/package.json

@@ -8,7 +8,7 @@
     "toilscript",
     "wasm"
   ],
-  "version": "0.1.12",
+  "version": "0.1.14",
   "author": "Daniel Wirtz <dcode+assemblyscript@dcode.io>",
   "license": "Apache-2.0",
   "homepage": "https://github.com/dacely-cloud/toilscript",

package/std/assembly/toilscript.d.ts

@@ -323,3 +323,54 @@ declare class i256 {
   isNeg(): bool;
   isZero(): bool;
 }
+
+/**
+ * The dynamic JSON value tree. A `@data` class's `toJSON()` returns one of these, and
+ * `JSON.parse(...)` produces one. Globalized by std/assembly/json, so it needs no import.
+ */
+declare class JSON {
+  /** A JSON null. */
+  static nul(): JSON;
+  /** An empty JSON object, build it with `.set(key, value)`. */
+  static obj(): JSON;
+  /** An empty JSON array, build it with `.push(value)`. */
+  static arr(): JSON;
+  /** Wrap a scalar/string/bool/array as a JSON value. */
+  static of<T>(value: T): JSON;
+  /** Parse JSON text into a value tree (returns an error value on malformed input). */
+  static parse(text: string): JSON;
+  /** Serialize a scalar/string/bool/array value to a JSON string. */
+  static stringify<T>(value: T): string;
+
+  /** Append a value to a JSON array; returns `this` for chaining. */
+  push(value: JSON): JSON;
+  /** Set a key on a JSON object; returns `this` for chaining. */
+  set(key: string, value: JSON): JSON;
+
+  isNull(): bool;
+  isBool(): bool;
+  isNumber(): bool;
+  isString(): bool;
+  isArray(): bool;
+  isObject(): bool;
+
+  asBool(): bool;
+  asF64(): f64;
+  asI64(): i64;
+  asU64(): u64;
+  asString(): string;
+
+  /** Element count of an array (or 0). */
+  length(): i32;
+  /** Element at `index` of an array. */
+  at(index: i32): JSON;
+  /** Whether an object has `key`. */
+  has(key: string): bool;
+  /** Value for `key` on an object. */
+  get(key: string): JSON;
+  /** The keys of an object. */
+  objectKeys(): Array<string>;
+
+  /** Serialize this value tree to a JSON string. */
+  toString(): string;
+}

package/std/ts-plugin.cjs

@@ -1,25 +1,26 @@
 /**
  * ToilScript TypeScript Language Service plugin.
  *
- * Stock TypeScript has no grammar for toil-native decorators applied to
- * top-level functions and globals (`@main`, `@inline`, `@unmanaged`, ...), so
- * the editor's language service flags them as errors even though the toilscript
- * compiler handles them correctly. It also can't see the members the compiler
- * injects into a `@data` class (`encode`/`decode`/`toJSON`/...). This plugin runs
- * only inside the editor's language service (VS Code, WebStorm, etc. - never
- * `tsc`/compiler builds) and removes exactly those false positives:
+ * Stock TypeScript can't see what the toilscript compiler does to a source file:
+ * the native decorators on top-level functions (`@main`, `@inline`, ...), the
+ * members it injects into a `@data` class (`encode`/`decode`/`toJSON`/...), or the
+ * fact that a class used only via a toil decorator is actually used. This plugin
+ * runs only inside the editor's language service (VS Code, WebStorm, etc. - never
+ * `tsc`/compiler builds) and bridges that gap:
  *
- *   TS1206  "Decorators are not valid here."
- *   TS1249  "A decorator can only decorate a method implementation, not an overload."
- *   TS2339  "Property '<m>' does not exist on type '<T>'." - but ONLY when `<m>` is a
- *           `@data`-injected member and `<T>` is a `@data` class (so a typo on any
- *           other type still surfaces).
+ *  1. Declaration-merges TYPED members onto each `@data` class (so `value.toJSON()`
+ *     is `JSON`, `Type.decode(bytes)` is the class, etc.) by appending ambient decls
+ *     to the file the editor sees. Diagnostics in that appended region are hidden.
+ *  2. As a fallback (if 1 doesn't apply), still removes the false positives:
+ *       TS1206 / TS1249  decorator grammar
+ *       TS2339  a `@data`-injected member accessed on a `@data` class
+ *       TS6133 / TS6196  a toil-decorated class/method reported as unused
  *
- * Every other diagnostic - unknown types, bad calls, missing names - passes
- * through untouched, so real type errors are still surfaced.
+ * Every other diagnostic passes through untouched, so real errors still surface.
  */
 const DECORATOR_GRAMMAR_CODES = new Set([1206, 1249]);
 const PROPERTY_NOT_EXIST = 2339;
+const DECLARED_NEVER_USED = new Set([6133, 6196]);
 
 /** Members the compiler injects into every `@data` class (instance + static). */
 const DATA_MEMBERS = new Set([
@@ -32,6 +33,32 @@ const DATA_MEMBERS = new Set([
   'dataId',
 ]);
 
+/** Toil-native decorators whose presence means the compiler uses the declaration. */
+const TOIL_DECORATORS = new Set([
+  'data',
+  'remote',
+  'service',
+  'rest',
+  'route',
+  'get',
+  'post',
+  'put',
+  'del',
+  'patch',
+  'head',
+  'options',
+  'main',
+  'global',
+  'inline',
+  'external',
+  'unmanaged',
+  'final',
+  'operator',
+  'lazy',
+  'unsafe',
+  'builtin',
+]);
+
 function init(modules) {
   const ts = modules.typescript;
 
@@ -46,37 +73,107 @@ function init(modules) {
     return found;
   }
 
-  /** Whether a class declaration carries the `@data` decorator (bare or called). */
-  function hasDataDecorator(decl) {
+  /** A decorator's bare name, for `@name` and `@name(...)`. */
+  function decoratorName(d) {
+    const e = d.expression;
+    return e && (e.text || (e.expression && e.expression.text));
+  }
+
+  function declHasDecorator(decl, names) {
     const decorators = (ts.getDecorators ? ts.getDecorators(decl) : decl.decorators) || [];
-    for (const d of decorators) {
-      const e = d.expression;
-      const name = e && (e.text || (e.expression && e.expression.text));
-      if (name === 'data') return true;
-    }
-    return false;
+    return decorators.some((d) => {
+      const n = decoratorName(d);
+      return typeof names === 'string' ? n === names : !!n && names.has(n);
+    });
   }
 
   function declsAreDataClass(declarations) {
     return (
       !!declarations &&
-      declarations.some((d) => ts.isClassDeclaration(d) && hasDataDecorator(d))
+      declarations.some((d) => ts.isClassDeclaration(d) && declHasDecorator(d, 'data'))
     );
   }
 
-  /** Whether `expr` is (an instance of, or the static side of) a `@data` class. */
   function resolvesToDataClass(expr, checker) {
     const type = checker.getTypeAtLocation(expr);
     const typeSym = type && type.getSymbol && type.getSymbol();
     if (typeSym && declsAreDataClass(typeSym.declarations)) return true;
-    // Static access like `Player.decode(...)`: resolve the identifier's own symbol.
     const sym = checker.getSymbolAtLocation(expr);
     return !!sym && declsAreDataClass(sym.declarations);
   }
 
+  function canHoldDecorators(node) {
+    return (
+      ts.isClassDeclaration(node) ||
+      ts.isClassExpression(node) ||
+      ts.isMethodDeclaration(node) ||
+      ts.isFunctionDeclaration(node) ||
+      ts.isPropertyDeclaration(node) ||
+      ts.isGetAccessorDeclaration(node) ||
+      ts.isSetAccessorDeclaration(node)
+    );
+  }
+
+  /**
+   * Ambient declarations to append so the editor types each `@data` class's injected
+   * codec members. Returns "" when the file declares no `@data` class. Uses only
+   * editor-visible globals (`Uint8Array`, `JSON`, `u32`), so the appended block is
+   * itself error-free; any diagnostics there are filtered anyway.
+   */
+  function dataAugmentation(text) {
+    if (text.indexOf('@data') < 0) return '';
+    let sf;
+    try {
+      sf = ts.createSourceFile('__toil_aug__.ts', text, ts.ScriptTarget.Latest, true);
+    } catch {
+      return '';
+    }
+    let out = '';
+    sf.forEachChild((node) => {
+      if (ts.isClassDeclaration(node) && node.name && declHasDecorator(node, 'data')) {
+        const n = node.name.text;
+        out +=
+          `\n// toilscript: editor types for the compiler-injected @data ${n} codec\n` +
+          `interface ${n} { encode(): Uint8Array; toJSON(): JSON; }\n` +
+          `declare namespace ${n} { function decode(buf: Uint8Array): ${n}; function fromJSON(v: JSON): ${n}; function dataId(): u32; }\n`;
+      }
+    });
+    return out;
+  }
+
   return {
     create(info) {
       const ls = info.languageService;
+      const host = info.languageServiceHost;
+
+      // Original text length per augmented file, so diagnostics in the appended region drop.
+      const originalLength = new Map();
+
+      // Inject the typed @data members into the editor's view of each source file.
+      if (typeof host.getScriptSnapshot === 'function' && typeof host.getScriptVersion === 'function') {
+        const origSnapshot = host.getScriptSnapshot.bind(host);
+        const origVersion = host.getScriptVersion.bind(host);
+        host.getScriptSnapshot = (fileName) => {
+          const snap = origSnapshot(fileName);
+          if (!snap) return snap;
+          let aug = '';
+          try {
+            aug = dataAugmentation(snap.getText(0, snap.getLength()));
+          } catch {
+            aug = '';
+          }
+          if (!aug) {
+            originalLength.delete(fileName);
+            return snap;
+          }
+          const text = snap.getText(0, snap.getLength());
+          originalLength.set(fileName, text.length);
+          return ts.ScriptSnapshot.fromString(text + aug);
+        };
+        // A stable suffix so the service re-reads once and picks up the augmentation; it
+        // still changes whenever the underlying file changes.
+        host.getScriptVersion = (fileName) => origVersion(fileName) + ':toil-data';
+      }
 
       // Proxy the language service, forwarding everything to the real one.
       const proxy = Object.create(null);
@@ -85,6 +182,12 @@ function init(modules) {
         proxy[key] = typeof value === 'function' ? value.bind(ls) : value;
       }
 
+      const inAugmentedRegion = (fileName, diag) => {
+        const len = originalLength.get(fileName);
+        return len != null && diag.start != null && diag.start >= len;
+      };
+
+      // Fallback: a TS2339 for a `@data`-injected member on a `@data` class.
       const isInjectedDataMember = (fileName, diag) => {
         if (diag.code !== PROPERTY_NOT_EXIST || diag.start == null) return false;
         const program = ls.getProgram();
@@ -101,9 +204,25 @@ function init(modules) {
         return resolvesToDataClass(access.expression, program.getTypeChecker());
       };
 
+      // A "declared but never used" for a class/method/function with a toil decorator.
+      const isToilDecoratedUnused = (fileName, diag) => {
+        if (!DECLARED_NEVER_USED.has(diag.code) || diag.start == null) return false;
+        const program = ls.getProgram();
+        const sf = program && program.getSourceFile(fileName);
+        if (!sf) return false;
+        const node = nodeAt(sf, diag.start);
+        if (!node) return false;
+        const decl = canHoldDecorators(node) ? node : node.parent;
+        return !!decl && canHoldDecorators(decl) && declHasDecorator(decl, TOIL_DECORATORS);
+      };
+
       const strip = (fileName, diagnostics) =>
         diagnostics.filter(
-          (d) => !DECORATOR_GRAMMAR_CODES.has(d.code) && !isInjectedDataMember(fileName, d),
+          (d) =>
+            !DECORATOR_GRAMMAR_CODES.has(d.code) &&
+            !inAugmentedRegion(fileName, d) &&
+            !isInjectedDataMember(fileName, d) &&
+            !isToilDecoratedUnused(fileName, d),
         );
 
       proxy.getSemanticDiagnostics = (fileName) =>
@@ -111,6 +230,13 @@ function init(modules) {
       proxy.getSyntacticDiagnostics = (fileName) =>
         strip(fileName, ls.getSyntacticDiagnostics(fileName));
 
+      if (typeof ls.getSuggestionDiagnostics === 'function') {
+        proxy.getSuggestionDiagnostics = (fileName) =>
+          ls
+            .getSuggestionDiagnostics(fileName)
+            .filter((d) => !inAugmentedRegion(fileName, d) && !isToilDecoratedUnused(fileName, d));
+      }
+
       return proxy;
     },
   };