skir-typescript-gen 1.0.1 → 1.0.3

package/README.md

@@ -7,20 +7,15 @@ Official plugin for generating TypeScript/JavaScript code from [.skir](https://g
 
 Generated code can run Node, Deno or in the browser.
 
-## Installation
-
-From your project's root directory, run `npm i --save-dev skir-typescript-gen`.
+## Set up
 
 In your `skir.yml` file, add the following snippet under `generators`:
 ```yaml
   - mod: skir-typescript-gen
-    config:
-      # Possible values: "" (CommonJS), ".js" (ES Modules), ".ts" (Deno)
-      importPathExtension: ""
+    outDir: ./src/skirout
+    config: {}
 ```
 
-The `npm run skirc` command will now generate .js and .t.ts files within the `skirout` directory.
-
 For more information, see this TypeScript project [example](https://github.com/gepheum/skir-typescript-example).
 
 ## TypeScript generated code guide
@@ -30,7 +25,7 @@ The examples below are for the code generated from [this](https://github.com/gep
 ### Referring to generated symbols
 
 ```typescript
-import { TARZAN, User, UserHistory, UserRegistry } from "../skirout/user";
+import { TARZAN, SubscriptionStatus, User, UserHistory, UserRegistry } from "../skirout/user";
 ```
 
 ### Struct classes
@@ -162,14 +157,14 @@ enum SubscriptionStatus {
 #### Making enum values
 
 ```typescript
-const johnStatus = User.SubscriptionStatus.FREE;
-const janeStatus = User.SubscriptionStatus.PREMIUM;
-const lylaStatus = User.SubscriptionStatus.create("PREMIUM");
-// ^ same as User.SubscriptionStatus.PREMIUM
-const jolyStatus = User.SubscriptionStatus.UNKNOWN;
-
-// Use create({kind: ..., value: ...}) for data variants.
-const roniStatus = User.SubscriptionStatus.create({
+const johnStatus = SubscriptionStatus.FREE;
+const janeStatus = SubscriptionStatus.PREMIUM;
+const lylaStatus = SubscriptionStatus.create("PREMIUM");
+// ^ same as SubscriptionStatus.PREMIUM
+const jolyStatus = SubscriptionStatus.UNKNOWN;
+
+// Use create({kind: ..., value: ...}) for wrapper variants.
+const roniStatus = SubscriptionStatus.create({
   kind: "trial",
   value: {
     startTime: Timestamp.fromUnixMillis(1234),
@@ -180,18 +175,19 @@ const roniStatus = User.SubscriptionStatus.create({
 #### Conditions on enums
 
 ```typescript
-// Use e.kind === "CONSTANT_NAME" to check if the enum value is a constant.
-assert(johnStatus.kind === "FREE");
-assert(johnStatus.value === undefined);
+// Use 'union.kind' to check which variant the enum value holds.
+assert(johnStatus.union.kind === "FREE");
 
 // Use "?" for UNKNOWN.
-assert(jolyStatus.kind === "?");
+assert(jolyStatus.union.kind === "?");
 
-assert(roniStatus.kind === "trial");
-assert(roniStatus.value!.startTime.unixMillis === 1234);
+assert(roniStatus.union.kind === "trial");
+// If the enum holds a wrapper variant, you can access the wrapped value through
+// 'union.value'.
+assert(roniStatus.union.value.startTime.unixMillis === 1234);
 
-function getSubscriptionInfoText(status: User.SubscriptionStatus): string {
-  // Use the 'union' getter for typesafe switches on enums.
+function getSubscriptionInfoText(status: SubscriptionStatus): string {
+  // Pattern matching on enum variants
   switch (status.union.kind) {
     case "?":
       return "Unknown subscription status";
@@ -200,7 +196,8 @@ function getSubscriptionInfoText(status: User.SubscriptionStatus): string {
     case "PREMIUM":
       return "Premium user";
     case "trial":
-      // Here the compiler knows that the type of union.value is 'User.Trial'.
+      // Here the compiler knows that the type of union.value is
+      // SubscriptionStatus.Trial
       return "On trial since " + status.union.value.startTime;
   }
 }
@@ -232,7 +229,7 @@ console.log(serializer.toJsonCode(john, "readable"));
 // You should pick the readable flavor mostly for debugging purposes.
 
 // Serialize 'john' to binary format.
-console.log(serializer.toBytes(john));
+const johnBytes = serializer.toBytes(john);
 
 // The binary format is not human readable, but it is slightly more compact than
 // JSON, and serialization/deserialization can be a bit faster in languages like
@@ -289,7 +286,7 @@ assert(jack.pets === jade.pets);
 
 ```typescript
 const userRegistry = UserRegistry.create({
-  users: [john, jane, lylaMut],
+  users: [john, jane, lylaMut, evilJane],
 });
 
 // searchUsers() returns the user with the given key (specified in the .skir
@@ -298,6 +295,10 @@ const userRegistry = UserRegistry.create({
 // time.
 assert(userRegistry.searchUsers(42) === john);
 assert(userRegistry.searchUsers(100) === undefined);
+
+// If multiple elements have the same key, the search method returns the last
+// one. Duplicates are allowed but generally discouraged.
+assert(userRegistry.searchUsers(43) === evilJane);
 ```
 
 ### Constants

package/dist/expression_maker.js

@@ -81,7 +81,7 @@ export function toFrozenExpression(arg) {
         primitive === "float64") {
         defaultValue = "0";
     }
-    else if (primitive === "int64" || primitive === "uint64") {
+    else if (primitive === "int64" || primitive === "hash64") {
         defaultValue = "BigInt(0)";
     }
     else if (primitive === "timestamp") {
@@ -112,7 +112,7 @@ function canBeFalsy(type) {
     return (primitive === "bool" ||
         primitive === "int32" ||
         primitive === "int64" ||
-        primitive === "uint64" ||
+        primitive === "hash64" ||
         primitive === "float32" ||
         primitive === "float64" ||
         primitive === "string");

package/dist/record_info.js

@@ -235,7 +235,7 @@ class RecordInfoCreator {
                     case "string":
                         return "k";
                     case "int64":
-                    case "uint64":
+                    case "hash64":
                         // BigInt is not hashable.
                         return "k.toString()";
                     case "timestamp":

package/dist/type_speller.js

@@ -101,7 +101,7 @@ export class TypeSpeller {
                     case "float64":
                         return TsType.NUMBER;
                     case "int64":
-                    case "uint64":
+                    case "hash64":
                         return TsType.BIGINT;
                     case "timestamp":
                         return TsType.TIMESTAMP;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skir-typescript-gen",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "",
   "keywords": [],
   "repository": {
@@ -32,7 +32,7 @@
     "lint:fix": "eslint src/**/*.ts --fix"
   },
   "dependencies": {
-    "skir-internal": "^0.0.8",
+    "skir-internal": "^0.1.0",
     "zod": "^4.2.1"
   },
   "devDependencies": {
@@ -46,8 +46,8 @@
     "mocha": "^11.7.5",
     "prettier": "^3.2.4",
     "prettier-plugin-organize-imports": "^4.2.0",
-    "skir": "^0.0.7",
-    "skir-client": "^0.0.10",
+    "skir": "^1.0.4",
+    "skir-client": "^0.1.0",
     "ts-node": "^10.9.2",
     "tsx": "^4.21.0",
     "typescript": "^5.2.2",

package/src/expression_maker.ts

@@ -92,7 +92,7 @@ export function toFrozenExpression(arg: ToFrozenExpressionArg): string {
     primitive === "float64"
   ) {
     defaultValue = "0";
-  } else if (primitive === "int64" || primitive === "uint64") {
+  } else if (primitive === "int64" || primitive === "hash64") {
     defaultValue = "BigInt(0)";
   } else if (primitive === "timestamp") {
     defaultValue = "$.Timestamp.UNIX_EPOCH";
@@ -121,7 +121,7 @@ function canBeFalsy(type: ResolvedType): boolean {
     primitive === "bool" ||
     primitive === "int32" ||
     primitive === "int64" ||
-    primitive === "uint64" ||
+    primitive === "hash64" ||
     primitive === "float32" ||
     primitive === "float64" ||
     primitive === "string"

package/src/record_info.ts

@@ -409,7 +409,7 @@ class RecordInfoCreator {
           case "string":
             return "k";
           case "int64":
-          case "uint64":
+          case "hash64":
             // BigInt is not hashable.
             return "k.toString()";
           case "timestamp":

package/src/type_speller.ts

@@ -124,7 +124,7 @@ export class TypeSpeller {
           case "float64":
             return TsType.NUMBER;
           case "int64":
-          case "uint64":
+          case "hash64":
             return TsType.BIGINT;
           case "timestamp":
             return TsType.TIMESTAMP;