ts-proto 1.167.8 → 1.168.0

package/README.markdown

@@ -432,7 +432,7 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=outputSchema=true`, meta typings will be generated that can later be used in other code generators.
 
-- With `--ts_proto_opt=outputTypeAnnotations=true`, each message will be given a `$type` field containing its fully-qualified name. You can use `--ts_proto_opt=outputTypeAnnotations=static-only` to omit it from the `interface` declaration.
+- With `--ts_proto_opt=outputTypeAnnotations=true`, each message will be given a `$type` field containing its fully-qualified name. You can use `--ts_proto_opt=outputTypeAnnotations=static-only` to omit it from the `interface` declaration, or `--ts_proto_opt=outputTypeAnnotations=optional` to make it an optional property on the `interface` definition. The latter option may be useful if you want to use the `$type` field for runtime type checking on responses from a server.
 
 - With `--ts_proto_opt=outputTypeRegistry=true`, the type registry will be generated that can be used to resolve message types by fully-qualified name. Also, each message will be given a `$type` field containing its fully-qualified name.
 

package/build/generate-struct-wrappers.js

@@ -21,15 +21,20 @@ function generateWrapDeep(ctx, fullProtoTypeName, fieldNames) {
     const chunks = [];
     if ((0, types_1.isStructTypeName)(fullProtoTypeName)) {
         let setStatement = "struct.fields[key] = Value.wrap(object[key]);";
+        let defaultFields = "struct.fields ??= {};";
         if (ctx.options.useMapType) {
             setStatement = "struct.fields.set(key, Value.wrap(object[key]));";
+            defaultFields = "struct.fields ??= new Map<string, any | undefined>();";
         }
+        if (ctx.options.useOptionals !== "all")
+            defaultFields = "";
         chunks.push((0, ts_poet_1.code) `wrap(object: {[key: string]: any} | undefined): Struct {
       const struct = createBaseStruct();
+      ${defaultFields}
       if (object !== undefined) {
-        Object.keys(object).forEach(key => {
+        for (const key of Object.keys(object)) {
           ${setStatement}
-        });
+        }
       }
       return struct;
     }`);
@@ -85,9 +90,11 @@ function generateUnwrapDeep(ctx, fullProtoTypeName, fieldNames) {
         if (ctx.options.useMapType) {
             chunks.push((0, ts_poet_1.code) `unwrap(message: Struct): {[key: string]: any} {
         const object: { [key: string]: any } = {};
-        [...message.fields.keys()].forEach((key) => {
-          object[key] = Value.unwrap(message.fields.get(key));
-        });
+        if (message.fields) {
+          for (const key of message.fields.keys()) {
+            object[key] = Value.unwrap(message.fields.get(key));
+          }
+        }
         return object;
       }`);
         }
@@ -95,9 +102,9 @@ function generateUnwrapDeep(ctx, fullProtoTypeName, fieldNames) {
             chunks.push((0, ts_poet_1.code) `unwrap(message: Struct): {[key: string]: any} {
         const object: { [key: string]: any } = {};
         if (message.fields) {
-          Object.keys(message.fields).forEach(key => {
+          for (const key of Object.keys(message.fields)) {
             object[key] = Value.unwrap(message.fields[key]);
-          });
+          }
         }
         return object;
       }`);
@@ -148,15 +155,20 @@ function generateWrapShallow(ctx, fullProtoTypeName, fieldNames) {
     const chunks = [];
     if ((0, types_1.isStructTypeName)(fullProtoTypeName)) {
         let setStatement = "struct.fields[key] = object[key];";
+        let defaultFields = "struct.fields ??= {};";
         if (ctx.options.useMapType) {
             setStatement = "struct.fields.set(key, object[key]);";
+            defaultFields = "struct.fields ??= new Map<string, any | undefined>();";
         }
+        if (ctx.options.useOptionals !== "all")
+            defaultFields = "";
         chunks.push((0, ts_poet_1.code) `wrap(object: {[key: string]: any} | undefined): Struct {
       const struct = createBaseStruct();
+      ${defaultFields}
       if (object !== undefined) {
-        Object.keys(object).forEach(key => {
+        for (const key of Object.keys(object)) {
           ${setStatement}
-        });
+        }
       }
       return struct;
     }`);
@@ -234,9 +246,11 @@ function generateUnwrapShallow(ctx, fullProtoTypeName, fieldNames) {
         if (ctx.options.useMapType) {
             chunks.push((0, ts_poet_1.code) `unwrap(message: Struct): {[key: string]: any} {
         const object: { [key: string]: any } = {};
-        [...message.fields.keys()].forEach((key) => {
-          object[key] = message.fields.get(key);
-        });
+        if (message.fields) {
+          for (const key of message.fields.keys()) {
+            object[key] = message.fields.get(key);
+          }
+        }
         return object;
       }`);
         }
@@ -244,9 +258,9 @@ function generateUnwrapShallow(ctx, fullProtoTypeName, fieldNames) {
             chunks.push((0, ts_poet_1.code) `unwrap(message: Struct): {[key: string]: any} {
         const object: { [key: string]: any } = {};
         if (message.fields) {
-          Object.keys(message.fields).forEach(key => {
+          for (const key of Object.keys(message.fields)) {
             object[key] = message.fields[key];
-          });
+          }
         }
         return object;
       }`);

package/build/main.js

@@ -678,7 +678,7 @@ function generateInterfaceDeclaration(ctx, fullName, messageDesc, sourceInfo, fu
     // interface name should be defined to avoid import collisions
     chunks.push((0, ts_poet_1.code) `export interface ${(0, ts_poet_1.def)(fullName)} {`);
     if ((0, options_1.addTypeToMessages)(options)) {
-        chunks.push((0, ts_poet_1.code) `$type: '${fullTypeName}',`);
+        chunks.push((0, ts_poet_1.code) `$type${options.outputTypeAnnotations === "optional" ? "?" : ""}: '${fullTypeName}',`);
     }
     // When oneof=unions, we generate a single property with an ADT per `oneof` clause.
     const processedOneofs = new Set();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "1.167.8",
+  "version": "1.168.0",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",