skir-typescript-gen 1.0.5 → 1.0.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Tyler Fibonacci
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -16,6 +16,12 @@ In your `skir.yml` file, add the following snippet under `generators`:
     config: {}
 ```
 
+The generated TypeScript code has a runtime dependency on the `skir_client` library. Install it with:
+
+```shell
+npm i skir-client
+```
+
 For more information, see this TypeScript project [example](https://github.com/gepheum/skir-typescript-example).
 
 ## TypeScript generated code guide
@@ -211,14 +217,30 @@ Every frozen struct class and enum class has a static readonly `serializer` prop
 const serializer = User.serializer;
 
 // Serialize 'john' to dense JSON.
-console.log(serializer.toJsonCode(john));
-// [42,"John Doe"]
+const johnDenseJson = serializer.toJson(john);
+
+// With dense JSON, structs are encoded as JSON arrays.
+assert(Array.isArray(johnDenseJson));
+
+// toJsonCode() returns a string containing the JSON code.
+// Equivalent to calling JSON.stringify() on toJson()'s result.
+const johnDenseJsonCode = serializer.toJsonCode(john);
+assert(johnDenseJsonCode.startsWith("["));
 
 // Serialize 'john' to readable JSON.
 console.log(serializer.toJsonCode(john, "readable"));
 // {
 //   "user_id": 42,
-//   "name": "John Doe"
+//   "name": "John Doe",
+//   "quote": "Coffee is just a socially acceptable form of rage.",
+//   "pets": [
+//     {
+//       "name": "Dumbo",
+//       "height_in_meters": 1,
+//       "picture": "🐘"
+//     }
+//   ],
+//   "subscription_status": "FREE"
 // }
 
 // The dense JSON flavor is the flavor you should pick if you intend to
@@ -241,7 +263,7 @@ const johnBytes = serializer.toBytes(john);
 ```typescript
 // Use fromJson(), fromJsonCode() and fromBytes() to deserialize.
 
-const reserializedJohn = serializer.fromJsonCode(serializer.toJsonCode(john));
+const reserializedJohn = serializer.fromJsonCode(johnDenseJsonCode);
 assert(reserializedJohn.name === "John Doe");
 
 const reserializedJane = serializer.fromJsonCode(
@@ -249,10 +271,48 @@ const reserializedJane = serializer.fromJsonCode(
 );
 assert(reserializedJane.name === "Jane Doe");
 
-const reserializedLyla = serializer.fromBytes(
-  serializer.toBytes(lylaMut).toBuffer(),
+assert(serializer.fromJson(johnDenseJson).name === "John Doe");
+assert(serializer.fromBytes(johnBytes.toBuffer()).name === "John Doe");
+```
+
+### Primitive serializers
+
+```typescript
+assert(primitiveSerializer("bool").toJson(true) === 1);
+assert(primitiveSerializer("int32").toJson(3) === 3);
+assert(
+  primitiveSerializer("int64").toJson(BigInt("9223372036854775807")) ===
+    "9223372036854775807",
+);
+assert(
+  primitiveSerializer("hash64").toJson(BigInt("18446744073709551615")) ===
+    "18446744073709551615",
+);
+assert(
+  primitiveSerializer("timestamp").toJson(
+    Timestamp.fromUnixMillis(1743682787000),
+  ) === 1743682787000,
+);
+assert(primitiveSerializer("float32").toJson(3.14) === 3.14);
+assert(primitiveSerializer("float64").toJson(3.14) === 3.14);
+assert(primitiveSerializer("string").toJson("Foo") === "Foo");
+assert(
+  primitiveSerializer("bytes").toJson(
+    ByteString.sliceOf(new Uint8Array([1, 2, 3]).buffer),
+  ) === "AQID",
+);
+```
+
+### Composite serializers
+
+```typescript
+assert(
+  optionalSerializer(primitiveSerializer("string")).toJson("foo") === "foo",
 );
-assert(reserializedLyla.name === "Lyla Doe");
+assert(optionalSerializer(primitiveSerializer("string")).toJson(null) === null);
+
+console.log(arraySerializer(primitiveSerializer("bool")).toJson([true, false]));
+// [1, 0]
 ```
 
 ### Frozen arrays and copies
@@ -309,9 +369,9 @@ console.log(TARZAN);
 //   name: 'Tarzan',
 //   quote: 'AAAAaAaAaAyAAAAaAaAaAyAAAAaAaAaA',
 //   pets: [ User_Pet { name: 'Cheeta', heightInMeters: 1.67, picture: '🐒' } ],
-//   subscriptionStatus: User_SubscriptionStatus {
+//   subscriptionStatus: SubscriptionStatus {
 //     kind: 'trial',
-//     value: User_Trial { startTime: [Timestamp] }
+//     value: SubscriptionStatus_Trial { startTime: [Timestamp] }
 //   }
 // }
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skir-typescript-gen",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "",
   "keywords": [],
   "repository": {
@@ -32,25 +32,29 @@
     "lint:fix": "eslint src/**/*.ts --fix"
   },
   "dependencies": {
-    "skir-internal": "^0.1.0",
+    "skir-internal": "^0.1.1",
     "zod": "^4.2.1"
   },
   "devDependencies": {
-    "@eslint/js": "^9.39.2",
-    "@types/mocha": "^10.0.1",
+    "@eslint/js": "^10.0.1",
+    "@types/mocha": "^10.0.10",
     "@types/node": "^20.6.0",
-    "@typescript-eslint/eslint-plugin": "^8.50.1",
-    "@typescript-eslint/parser": "^8.50.1",
+    "@typescript-eslint/eslint-plugin": "^8.56.0",
+    "@typescript-eslint/parser": "^8.56.0",
     "buckwheat": "^1.1.2",
-    "eslint": "^9.39.2",
+    "eslint": "^10.0.1",
     "mocha": "^11.7.5",
     "prettier": "^3.2.4",
     "prettier-plugin-organize-imports": "^4.2.0",
-    "skir": "^1.0.20",
-    "skir-client": "^1.0.9",
+    "skir": "^1.0.25",
+    "skir-client": "^1.0.11",
     "ts-node": "^10.9.2",
     "tsx": "^4.21.0",
     "typescript": "^5.2.2",
-    "typescript-eslint": "^8.50.1"
+    "typescript-eslint": "^8.56.0"
+  },
+  "overrides": {
+    "diff": "^8.0.3",
+    "minimatch": "^10.2.2"
   }
 }