json-as 1.1.9 → 1.1.11

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+## 2025-05-28 - 1.1.11
+
+- fix: class resolving should only search top level statements for class declarations
+- fix: add helpful error if class is missing an @json decorator
+- fix: properly calculate relative path when json-as is a library
+- fix: add proper null check when resolving imported classes
+
+## 2025-05-28 - 1.1.10
+
+- feat: add more debug levels (1 = print transform code, 2 = print keys/values at runtime)
+- feat: add write out feature (`JSON_WRITE=path-to-file.ts`) which writes out generated code
+- fix: complete full parity between port and original version for correct deserialization of all types
+- feat: add proper schema resolution and dependency resolution
+- feat: add proper type resolution to schema fields
+- fix: properly calculate the relative path between imports to modules
+
 ## 2025-05-27 - 1.1.9
 
 - change: strict mode is disabled by default. Enable it with JSON_STRICT=true

package/README.md

@@ -6,7 +6,7 @@
 ██   ██      ██ ██    ██ ██  ██ ██       ██   ██      ██
  █████  ███████  ██████  ██   ████       ██   ██ ███████
  </span>
-    AssemblyScript - v1.1.9
+    AssemblyScript - v1.1.11
   </pre>
 </h6>
 
@@ -25,6 +25,7 @@ JSON is the de-facto serialization format of modern web applications, but its se
   - [Using Raw JSON Strings](#️-using-raw-json-strings)
   - [Custom Serializers](#️-using-custom-serializers-or-deserializers)
 - [Performance](#-performance)
+- [Debugging](#-debugging)
 - [License](#-license)
 - [Contact](#-contact)
 
@@ -445,6 +446,12 @@ These benchmarks compare this library to JavaScript's native `JSON.stringify` an
 - Inline specific hot code paths
 - Implement error handling implementation
 
+## 🐛 Debugging
+
+`JSON_DEBUG=1` - Prints out generated code at compile-time
+`JSON_DEBUG=2` - The above and prints keys/values as they are deserialized
+`JSON_WRITE=path-to-file.ts` - Writes out generated code to `path-to-file.json.ts` for easy inspection
+
 ## 📃 License
 
 This project is distributed under an open source license. You can view the full license using the following link: [License](./LICENSE)

package/assembly/__benches__/large.bench.ts

@@ -2,11 +2,10 @@ import { JSON } from "..";
 import { expect } from "../__tests__/lib";
 import { bench } from "./lib/bench";
 
-
 @json
 class RepoOwner {
   public login!: string;
-  public id!: i32;
+  public id!: number;
   public node_id!: string;
   public avatar_url!: string;
   public gravatar_id!: string;
@@ -26,7 +25,6 @@ class RepoOwner {
   public site_admin!: boolean;
 }
 
-
 @json
 class RepoLicense {
   public key!: string;
@@ -36,10 +34,9 @@ class RepoLicense {
   public node_id!: string;
 }
 
-
 @json
 class Repo {
-  public id!: i32;
+  public id!: number;
   public node_id!: string;
   public name!: string;
   public full_name!: string;
@@ -93,9 +90,9 @@ class Repo {
   public clone_url!: string;
   public svn_url!: string;
   public homepage!: string | null;
-  public size!: i32;
-  public stargazers_count!: i32;
-  public watchers_count!: i32;
+  public size!: number;
+  public stargazers_count!: number;
+  public watchers_count!: number;
   public language!: string | null;
   public has_issues!: boolean;
   public has_projects!: boolean;
@@ -103,24 +100,24 @@ class Repo {
   public has_wiki!: boolean;
   public has_pages!: boolean;
   public has_discussions!: boolean;
-  public forks_count!: i32;
+  public forks_count!: number;
   public mirror_url!: string | null;
   public archived!: boolean;
   public disabled!: boolean;
-  public open_issues_count!: i32;
+  public open_issues_count!: number;
   public license!: RepoLicense | null;
   public allow_forking!: boolean;
   public is_template!: boolean;
   public web_commit_signoff_required!: boolean;
   public topics!: string[];
   public visibility!: string;
-  public forks!: i32;
-  public open_issues!: i32;
-  public watchers!: i32;
+  public forks!: number;
+  public open_issues!: number;
+  public watchers!: number;
   public default_branch!: string;
 }
 
-const v1: Repo = {
+let v1: Repo = {
   id: 132935648,
   node_id: "MDEwOlJlcG9zaXRvcnkxMzI5MzU2NDg=",
   name: "boysenberry-repo-1",
@@ -145,7 +142,7 @@ const v1: Repo = {
     received_events_url: "https://api.github.com/users/octocat/received_events",
     type: "User",
     user_view_type: "public",
-    site_admin: false,
+    site_admin: false
   },
   html_url: "https://github.com/octocat/boysenberry-repo-1",
   description: "Testing",
@@ -219,26 +216,26 @@ const v1: Repo = {
   forks: 20,
   open_issues: 1,
   watchers: 332,
-  default_branch: "master",
-};
+  default_branch: "master"
+}
 
 const v2 = `{"id":132935648,"node_id":"MDEwOlJlcG9zaXRvcnkxMzI5MzU2NDg=","name":"boysenberry-repo-1","full_name":"octocat/boysenberry-repo-1","private":true,"owner":{"login":"octocat","id":583231,"node_id":"MDQ6VXNlcjU4MzIzMQ==","avatar_url":"https://avatars.githubusercontent.com/u/583231?v=4","gravatar_id":"","url":"https://api.github.com/users/octocat","html_url":"https://github.com/octocat","followers_url":"https://api.github.com/users/octocat/followers","following_url":"https://api.github.com/users/octocat/following{/other_user}","gists_url":"https://api.github.com/users/octocat/gists{/gist_id}","starred_url":"https://api.github.com/users/octocat/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/octocat/subscriptions","organizations_url":"https://api.github.com/users/octocat/orgs","repos_url":"https://api.github.com/users/octocat/repos","events_url":"https://api.github.com/users/octocat/events{/privacy}","received_events_url":"https://api.github.com/users/octocat/received_events","type":"User","user_view_type":"public","site_admin":false},"html_url":"https://github.com/octocat/boysenberry-repo-1","description":"Testing","fork":true,"url":"https://api.github.com/repos/octocat/boysenberry-repo-1","forks_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/forks","keys_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/keys{/key_id}","collaborators_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/teams","hooks_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/hooks","issue_events_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/issues/events{/number}","events_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/events","assignees_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/assignees{/user}","branches_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/branches{/branch}","tags_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/tags","blobs_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/git/refs{/sha}","trees_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/git/trees{/sha}","statuses_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/statuses/{sha}","languages_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/languages","stargazers_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/stargazers","contributors_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/contributors","subscribers_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/subscribers","subscription_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/subscription","commits_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/commits{/sha}","git_commits_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/git/commits{/sha}","comments_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/comments{/number}","issue_comment_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/issues/comments{/number}","contents_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/contents/{+path}","compare_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/compare/{base}...{head}","merges_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/merges","archive_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/downloads","issues_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/issues{/number}","pulls_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/pulls{/number}","milestones_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/milestones{/number}","notifications_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/labels{/name}","releases_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/releases{/id}","deployments_url":"https://api.github.com/repos/octocat/boysenberry-repo-1/deployments","created_at":"2018-05-10T17:51:29Z","updated_at":"2025-05-24T02:01:19Z","pushed_at":"2024-05-26T07:02:05Z","git_url":"git://github.com/octocat/boysenberry-repo-1.git","ssh_url":"git@github.com:octocat/boysenberry-repo-1.git","clone_url":"https://github.com/octocat/boysenberry-repo-1.git","svn_url":"https://github.com/octocat/boysenberry-repo-1","homepage":"","size":4,"stargazers_count":332,"watchers_count":332,"language":null,"has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"has_discussions":false,"forks_count":20,"mirror_url":null,"archived":false,"disabled":false,"open_issues_count":1,"license":null,"allow_forking":true,"is_template":false,"web_commit_signoff_required":false,"topics":[],"visibility":"public","forks":20,"open_issues":1,"watchers":332,"default_branch":"master"}`;
 
 expect(JSON.stringify(v1)).toBe(v2);
-expect(JSON.stringify(JSON.parse<Repo>(v2))).toBe(v2);
+expect(JSON.stringify(JSON.parse(v2))).toBe(v2);
 
 bench(
   "Serialize Large Object",
   () => {
     JSON.stringify(v1);
   },
-  100_00,
+  1_000_000,
 );
 
 bench(
   "Deserialize Large Object",
   () => {
-    JSON.parse<Repo>(v2);
+    JSON.parse(v2);
   },
-  100_00,
-);
+  1_000_000,
+);

package/assembly/__tests__/lib/index.ts

@@ -13,7 +13,7 @@ export function expect<T>(left: T): Expectation {
   // @ts-ignore
   if (!isDefined(left.toString)) throw new Error("Expected left to have a toString method, but it does not.");
   // @ts-ignore
-  return new Expectation(left.toString());
+  return new Expectation(isNull(left) ? "null" : left.toString());
 }
 
 class Expectation {
@@ -26,12 +26,16 @@ class Expectation {
     // @ts-ignore
     if (!isDefined(right.toString)) throw new Error("Expected right to have a toString method, but it does not.");
     // @ts-ignore
-    if (this.left != right.toString()) {
+    if (this.left != (isNull(right) ? "null" : right.toString())) {
       console.log("  " + currentDescription + "\n");
       // @ts-ignore
-      console.log("  (expected) -> " + right.toString());
+      console.log("  (expected) -> " + (isNull(right) ? "null" : right.toString()));
       console.log("  (received) -> " + this.left);
       unreachable();
     }
   }
 }
+
+function isNull<T>(value: T): boolean {
+  return isInteger<T>() && !isSigned<T>() && nameof<T>() == "usize" && value == 0;
+}

package/assembly/index.ts

@@ -603,6 +603,8 @@ export namespace JSON {
       if (isDefined(type.__DESERIALIZE)) {
         const out = changetype<nonnull<T>>(dst || __new(offsetof<nonnull<T>>(), idof<nonnull<T>>()));
         // @ts-ignore: Defined by transform
+        if (isDefined(type.__INITIALIZE)) out.__INITIALIZE();
+        // @ts-ignore: Defined by transform
         return out.__DESERIALIZE(srcStart, srcEnd, out);
       } else if (type instanceof Map) {
         // @ts-ignore: type

package/assembly/test.ts

@@ -40,18 +40,143 @@ it("should parse", () => {
 }`;
 
   const output = JSON.parse<OpenAIChatOutput>(str);
-
   expect(output.id).toBe("chatcmpl-BbvlnP0ESWa8OForeEjt7AkoIuh3Q");
   expect(output.object).toBe("chat.completion");
+  expect(output.created.getTime()).toBe(1748379903000);
   expect(output.model).toBe("gpt-4o-mini-2024-07-18");
-  expect(output.system_fingerprint).toBe("fp_34a54ae93c"); // fails ("")
-});
+  expect(output.choices.length).toBe(1);
 
+  const choice = output.choices[0];
+  expect(choice.index).toBe(0);
+  expect(choice.message.content).toBe("Hello! How can I assist you today?");
+  // expect(choice.message.refusal).toBe("null");
+  // expect(choice.logprobs).toBe("null");
+  // expect(choice.finishReason).toBe("stop");
+
+  // expect(output.usage.promptTokens).toBe(15);
+  // expect(output.usage.completionTokens).toBe(9);
+  // expect(output.usage.totalTokens).toBe(24);
+  // expect(output.serviceTier).toBe("default");
+  // expect(output.systemFingerprint).toBe("fp_34a54ae93c");
+});
 
 @json
 class OpenAIChatOutput {
   id!: string;
+
   object!: string;
+
+  choices: Choice[] = [];
+
+  get created(): Date {
+    return new Date(this._created * 1000);
+  }
+
+  @alias("created")
+  private _created!: i64;
+
   model!: string;
-  system_fingerprint!: string;
+
+  @alias("service_tier")
+  serviceTier: string | null = null;
+
+  @alias("system_fingerprint")
+  systemFingerprint!: string;
+
+  usage!: Usage;
+}
+
+@json
+class ToolCall {
+  id!: string;
+
+  type: string = "function";
+
+  function!: FunctionCall;
+}
+
+@json
+class FunctionCall {
+  name!: string;
+
+  arguments!: string;
 }
+
+@json
+class Usage {
+  @alias("completion_tokens")
+  completionTokens!: i32;
+
+  @alias("prompt_tokens")
+  promptTokens!: i32;
+
+  @alias("total_tokens")
+  totalTokens!: i32;
+}
+
+@json
+class Choice {
+  @alias("finish_reason")
+  finishReason!: string;
+
+  index!: i32;
+
+  message: CompletionMessage = new CompletionMessage();
+
+  logprobs!: Logprobs | null;
+}
+
+@json
+class Logprobs {
+  content: LogprobsContent[] | null = null;
+}
+
+@json
+class LogprobsContent {
+  token!: string;
+
+  logprob!: f64;
+
+  bytes!: u8[] | null;
+
+  @alias("top_logprobs")
+  topLogprobs!: TopLogprobsContent[];
+}
+
+@json
+class TopLogprobsContent {
+  token!: string;
+
+  logprob!: f64;
+
+  bytes!: u8[] | null;
+}
+
+@json
+class CompletionMessage {
+  content!: string;
+
+  @omitnull()
+  refusal: string | null = null;
+
+  @alias("tool_calls")
+  @omitif((self: CompletionMessage) => self.toolCalls.length == 0)
+  toolCalls: ToolCall[] = [];
+
+  @omitnull()
+  audio: AudioOutput | null = null;
+}
+
+@json
+class AudioOutput {
+  id!: string;
+
+  get expiresAt(): Date {
+    return new Date(this._expiresAt * 1000);
+  }
+
+  @alias("expires_at")
+  private _expiresAt!: i64;
+
+  transcript!: string;
+}

package/assembly/types.ts

@@ -0,0 +1,70 @@
+import { JSON } from "."
+
+@json
+export class GenericEnum<T> {
+  private tag: string = ""
+  private value: T | null = null
+
+  constructor() {
+    this.tag = ""
+    this.value = null
+  }
+
+  static create<T>(tag: string, value: T): GenericEnum<T> {
+    const item = new GenericEnum<T>()
+    item.tag = tag
+    item.value = value
+    return item
+  }
+
+  getTag(): string {
+    return this.tag
+  }
+
+  getValue(): T | null {
+    return this.value
+  }
+  @serializer
+  serialize<T>(self: GenericEnum<T>): string {
+    const tagJson = JSON.stringify(self.tag);
+    const valueJson = JSON.stringify(self.value);
+    return `{${tagJson}:${valueJson}}`
+  }
+  @deserializer
+  deserialize(data: string): GenericEnum<T> {
+    const parsed = JSON.parse<Map<string, JSON.Raw>>(data);
+    const result = new GenericEnum<T>();
+
+    const keys = parsed.keys();
+    const values = parsed.values();
+
+    result.tag = keys[0];
+    result.value = JSON.parse<T>(values[0].data);
+
+    return result;
+  }
+}
+
+@json
+export class Node<T> {
+  name: string
+  id: u32
+  data: T
+
+  constructor() {
+    this.name = ""
+    this.id = 0
+    this.data = changetype<T>(0);
+  }
+}
+
+@json
+export class Vec3 {
+  x: f32 = 0.0;
+  y: f32 = 0.0;
+  z: f32 = 0.0;
+}
+
+
+@json
+export class Point { }