json-as 0.8.6 → 0.9.0

package/.github/workflows/nodejs.yml

@@ -9,7 +9,10 @@ jobs:
 
     steps:
       - name: Checkout the repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
+      
+      - name: Install Wasmtime
+        uses: jcbhmr/setup-wasmtime@v2
 
       - name: Setup Node.js
         uses: actions/setup-node@v2
@@ -17,6 +20,9 @@ jobs:
       - name: Install dependencies
         if: steps.node-cache.outputs.cache-hit != 'true'
         run: yarn
+      
+      - name: Build tests
+        run: yarn run tests:build
 
       - name: Perform tests
         run: yarn run test

package/CHANGELOG

@@ -2,4 +2,7 @@ v0.8.2 - Properties starting with `static` or `private` would be ignored
 v0.8.3 - Dirty fix to issue #68. Add __JSON_Stringify callable to global scope.
 v0.8.4 - Fix #71. Classes with the extending class overriding a property cause the property to be serialized twice.
 v0.8.5 - Fix #73. Support for nullable primatives with Box<T> from as-container
-v0.8.6 - Fix. Forgot to stash before publishing. Stash and push what should have been v0.8.5
+v0.8.6 - Fix. Forgot to stash before publishing. Stash and push what should have been v0.8.5
+
+v0.9.0 - Large update. Refactor all the code, nullable primitives, rewrite the transform, allow extensibility with @omit keywords, and fix a plethora of bugs
+[UNRELEASED] v0.9.1 - Port JSON.Value from the `develop` branch to allow for union types, parsing of arbitrary data, and whatever the hell you want.

package/README.md

@@ -7,7 +7,7 @@
 ██║  ██║███████║      ╚█████╔╝███████║╚██████╔╝██║ ╚████║
 ╚═╝  ╚═╝╚══════╝       ╚════╝ ╚══════╝ ╚═════╝ ╚═╝  ╚═══╝
 
-v0.8.6
+v0.9.0
 </pre>
 </h3>
 
@@ -34,6 +34,8 @@ Alternatively, add it to your `asconfig.json`
 }
 ```
 
+If you'd like to see the code that the transform generates, run with `JSON_DEBUG=true`
+
 ## Usage
 
 ```js
@@ -53,7 +55,10 @@ class Player {
   firstName!: string;
   lastName!: string;
   lastActive!: i32[];
+  // Drop in a code block, function, or expression that evaluates to a boolean
+  @omitif("this.age < 18")
   age!: i32;
+  @omitnull()
   pos!: Vec3 | null;
   isVerified!: boolean;
 }
@@ -71,15 +76,17 @@ const player: Player = {
   isVerified: true
 };
 
-const stringified = JSON.stringify<Player>(player, true);
-// You can toggle on setting default values with the 2nd parameter
-// Alternative: use JSON.serializeTo(player, out);
+const stringified = JSON.stringify<Player>(player);
 
 const parsed = JSON.parse<Player>(stringified);
 ```
 
 If you use this project in your codebase, consider dropping a [star](https://github.com/JairusSW/as-json). I would really appreciate it!
 
+## Notes
+
+If you want a feature, drop an issue (and again, maybe a star). I'll likely add it in less than 7 days.
+
 ## Performance
 
 Run or view the benchmarks [here](https://github.com/JairusSW/as-json/tree/master/bench)
@@ -91,21 +98,25 @@ My library beats JSON (written in C++) on all counts *and*, I see many places wh
 
 Serialization Benchmarks:
 
-| Value                      | JavaScript (ops/s) | JSON-as (ops/s) | JSON-AS with Pages |
-|----------------------------|--------------------|-----------------|--------------------|
-| "hello world"              | 28,629,598         | 64,210,666      | + 124%             |
-| 12345                      | 31,562,431         | 56,329,066      | 321,783,941 ops/s  |
-| 1.2345                     | 15,977,278         | 20,322,939      | 30,307,616 ops/s  |
-| [[],[[]],[[],[[]]]]        | 8,998,624          | 34,453,102      | + 283% |
-
+| Value                      | JavaScript (ops/s) | JSON-as (ops/s) | Difference |
+|----------------------------|--------------------|-----------------|------------|
+| "hello world"              | 28,629,598         | 64,210,666      | + 124%     |
+| 12345                      | 31,562,431         | 56,329,066      | + 78%      |
+| 1.2345                     | 15,977,278         | 20,322,939      | + 27%      |
+| [[],[[]],[[],[[]]]]        | 8,998,624          | 34,453,102      | + 283%     |
+| { x: f64, y: f64, z: f64 } | 15,583,686         | 17,604,821      | + 12%      |
 
 
-Deserialization Benchmarks: (WIP)
 
-| Value                      | JavaScript (ops/s) | JSON-AS (ops/s) | % Diff |
-|----------------------------|--------------------|-----------------|--------|
-| "12345"                    | 34,647,886         | 254,640,930     | + 635% |
+Deserialization Benchmarks:
 
+| Value                      | JavaScript (ops/s) | JSON-AS (ops/s) | Difference|
+|----------------------------|--------------------|-----------------|-----------|
+| "hello world"              | 12,210,131         | 24,274,496      | + 98%     |
+| "12345"                    | 21,376,873         | 254,640,930     | + 1,191%  |
+| 1.2345                     | 23,193,902         | 221,869,840     | + 987%    |
+| [[],[[]],[[],[[]]]]        | 4,777,227          | 74,921,123      | + 1,568%  |
+| { x: f64, y: f64, z: f64 } | 10,973,723         | 25,214,019      | + 230%    |
 
 And my PC specs:
 
@@ -115,7 +126,6 @@ And my PC specs:
 | CPU             | AMD Ryzen 7 7800x3D @ 6.00 GHz       |
 | Memory          | T-Force DDR5 6000 MHz                |
 | OS              | Ubuntu WSL2                          |
-| Graphics        | AMD Radeon RX 6750XT                 |
 
 ## Issues
 

package/assembly/__tests__/deserialize.spec.ts

@@ -0,0 +1,298 @@
+import { JSON } from "..";
+import {
+  describe,
+  expect
+} from "as-test/assembly";
+
+@json
+class BaseObject {
+  a: string;
+  constructor(a: string) {
+    this.a = a;
+  }
+}
+
+@json
+class DerivedObject extends BaseObject {
+  b: string;
+  constructor(a: string, b: string) {
+    super(a);
+    this.b = b;
+  }
+}
+
+@json
+class Map4 {
+  a: string;
+  b: string;
+  c: string;
+  d: string;
+}
+
+@json
+class Vec3 {
+  x: f64;
+  y: f64;
+  z: f64;
+
+  static shouldIgnore: string = "should not be serialized";
+}
+
+@json
+class Player {
+  firstName: string;
+  lastName: string;
+  lastActive: i32[];
+  age: i32;
+  pos: Vec3 | null;
+  isVerified: boolean;
+}
+
+class Nullable { }
+type Null = Nullable | null;
+
+describe("Should deserialize strings", () => {
+
+  expect(
+    JSON.parse<string>("\"abcdefg\"")
+  ).toBe("abcdefg");
+
+  expect(
+    JSON.parse<string>('"\\"st\\\\\\"ring\\\\\\" w\\\\\\"\\\\\\"ith quotes\\\\\\"\\\""')
+  ).toBe('"st\\"ring\\" w\\"\\"ith quotes\\""');
+
+  expect(
+    JSON.parse<string>('"\\"string \\\\\\"with random spa\\\\nces and \\\\nnewlines\\\\n\\\\n\\\\n\\""')
+  ).toBe('"string \\"with random spa\\nces and \\nnewlines\\n\\n\\n"');
+
+  expect(
+    JSON.parse<string>('"\\"string with colon : comma , brace [ ] bracket { } and quote \\\\\\" and other quote \\\\\\\\\\"\\\""')
+  ).toBe('"string with colon : comma , brace [ ] bracket { } and quote \\" and other quote \\\\""');
+
+});
+
+describe("Should deserialize integers", () => {
+
+  expect(
+    JSON.parse<i32>("0")
+  ).toBe(<i32>0);
+
+  expect(
+    JSON.parse<u32>("100")
+  ).toBe(<u32>100);
+
+  expect(
+    JSON.parse<u64>("101")
+  ).toBe(<u64>101);
+
+  expect(
+    JSON.parse<i32>("-100")
+  ).toBe(<i32>-100);
+
+  expect(
+    JSON.parse<i64>("-101")
+  ).toBe(<i64>-101);
+
+});
+
+describe("Should deserialize floats", () => {
+
+  expect(
+    JSON.parse<f64>("7.23")
+  ).toBe(7.23);
+
+  expect(
+    JSON.parse<f64>("1000.0")
+  ).toBe(1000.0);
+
+  expect(
+    JSON.parse<f64>("1.23456")
+  ).toBe(1.23456);
+
+  expect(
+    JSON.parse<f64>("0.0")
+  ).toBe(0.0);
+
+  expect(
+    JSON.parse<f64>("-7.23")
+  ).toBe(-7.23);
+
+  expect(
+    JSON.parse<f64>("0.000001")
+  ).toBe(0.000001);
+
+  expect(
+    JSON.parse<f64>("1e-7")
+  ).toBe(1e-7);
+
+  expect(
+    JSON.parse<f64>("100000000000000000000.0")
+  ).toBe(1e20);
+
+  expect(
+    JSON.parse<f64>("1e+21")
+  ).toBe(1e21);
+
+});
+
+describe("Should deserialize booleans", () => {
+
+  expect(
+    JSON.parse<boolean>("true")
+  ).toBe(true);
+
+  expect(
+    JSON.parse<boolean>("false")
+  ).toBe(false);
+
+});
+
+describe("Should deserialize class inheritance", () => {
+
+  const jsonStr = "{\"a\":\"1\",\"b\":\"2\"}";
+  const obj = JSON.parse<DerivedObject>(jsonStr);
+
+  expect(obj instanceof DerivedObject).toBe(true);
+  expect(obj.a).toBe("1");
+  expect(obj.b).toBe("2");
+});
+
+describe("Should deserialize nulls", () => {
+
+  expect(
+    JSON.stringify(JSON.parse<Null>("null"))
+  ).toBe("null");
+
+});
+
+describe("Should deserialize integer arrays", () => {
+
+  expect(
+    JSON.stringify(JSON.parse<u32[]>("[0,100,101]"))
+  ).toBe(JSON.stringify([0, 100, 101]));
+
+  expect(
+    JSON.stringify(JSON.parse<i32[]>("[0,100,101,-100,-101]"))
+  ).toBe(JSON.stringify([0, 100, 101, -100, -101]));
+
+});
+
+describe("Should deserialize float arrays", () => {
+
+  expect(
+    JSON.stringify(JSON.parse<f64[]>("[7.23,1000.0,1000.0,1.23456,1.23456,0.0,7.23]"))
+  ).toBe(JSON.stringify([7.23, 1000.0, 1000.0, 1.23456, 1.23456, 0.0, 7.23]));
+
+  expect(
+    JSON.stringify(JSON.parse<f64[]>("[1e+21,1e+22,1e-7,1e-8,1e-9]"))
+  ).toBe(JSON.stringify([1e21, 1e22, 1e-7, 1e-8, 1e-9]));
+
+});
+
+describe("Should deserialize boolean arrays", () => {
+
+  expect(
+    JSON.stringify(JSON.parse<boolean[]>("[true,false]"))
+  ).toBe(JSON.stringify([true, false]));
+
+});
+
+describe("Should deserialize string arrays", () => {
+
+  expect(
+    JSON.stringify(JSON.parse<string[]>('["string \\"with random spa\\nces and \\nnewlines\\n\\n\\n"]'))
+  ).toBe(JSON.stringify([ 'string "with random spa\nces and \nnewlines\n\n\n' ]));
+
+});
+
+describe("Should deserialize nested integer arrays", () => {
+
+  expect(
+    JSON.stringify(JSON.parse<i64[][]>("[[100,101],[-100,-101],[0]]"))
+  ).toBe(JSON.stringify([[100, 101], [-100, -101], [0]]));
+
+});
+
+describe("Should deserialize nested float arrays", () => {
+
+  expect(
+    JSON.stringify(JSON.parse<f64[][]>("[[7.23],[1000.0],[1000.0],[1.23456],[1.23456],[0.0],[7.23]]"))
+  ).toBe(JSON.stringify([[7.23], [1000.0], [1000.0], [1.23456], [1.23456], [0.0], [7.23]]));
+
+});
+
+describe("Should deserialize nested boolean arrays", () => {
+
+  expect(
+    JSON.stringify(JSON.parse<boolean[][]>("[[true],[false]]"))
+  ).toBe(JSON.stringify([[true], [false]]));
+
+});
+
+describe("Should deserialize object arrays", () => {
+
+  expect(
+    JSON.stringify(JSON.parse<Vec3[]>('[{"x":3.4,"y":1.2,"z":8.3},{"x":3.4,"y":-2.1,"z":9.3}]'))
+  ).toBe(JSON.stringify(<Vec3[]>[
+    { x: 3.4, y: 1.2, z: 8.3 },
+    { x: 3.4, y: -2.1, z: 9.3 }
+  ]));
+
+});
+
+describe("Ser/de Objects", () => {
+
+  expect(
+    JSON.stringify(JSON.parse<Vec3>('{"x":3.4,"y":1.2,"z":8.3}'))
+  ).toBe(JSON.stringify(<Vec3>{ x: 3.4, y: 1.2, z: 8.3 }));
+
+  expect(
+    JSON.stringify(JSON.parse<Player>('{"firstName":"Emmet","lastName":"West","lastActive":[8,27,2022],"age":23,"pos":{"x":3.4,"y":1.2,"z":8.3},"isVerified":true}'))
+  ).toBe(JSON.stringify(<Player>{
+    firstName: "Emmet",
+    lastName: "West",
+    lastActive: [8, 27, 2022],
+    age: 23,
+    pos: { x: 3.4, y: 1.2, z: 8.3 },
+    isVerified: true
+  }));
+
+  expect(
+    JSON.stringify(JSON.parse<ObjectWithFloat>('{"f":7.23}'))
+  ).toBe(JSON.stringify(<ObjectWithFloat>{ f: 7.23 }));
+
+  expect(
+    JSON.stringify(JSON.parse<ObjectWithFloat>('{"f":0.000001}'))
+  ).toBe(JSON.stringify(<ObjectWithFloat>{ f: 0.000001 }));
+
+  expect(
+    JSON.stringify(JSON.parse<ObjWithStrangeKey<string>>('{"a\\\\\\t\\"\\u0002b`c":"foo"}'))
+  ).toBe(JSON.stringify(<ObjWithStrangeKey<string>>{ data: "foo" }));
+
+});
+
+@json
+class ObjWithString {
+  s!: string;
+}
+
+@json
+class ObjectWithStringArray {
+  sa!: string[];
+}
+
+@json
+class ObjectWithFloat {
+  f!: f64;
+}
+
+@json
+class ObjectWithFloatArray {
+  fa!: f64[];
+}
+
+@json
+class ObjWithStrangeKey<T> {
+  @alias('a\\\t"\x02b`c')
+  data!: T;
+}