ts-proto 1.150.1 → 1.151.0

package/README.markdown

@@ -414,7 +414,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.
+- 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=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/main.js

@@ -418,7 +418,7 @@ function makeDeepPartial(options, longs) {
     const maybeLong = options.forceLong === options_1.LongOption.LONG ? (0, ts_poet_1.code) ` : T extends ${longs.Long} ? string | number | Long ` : "";
     const Builtin = (0, ts_poet_1.conditionalOutput)("Builtin", (0, ts_poet_1.code) `type Builtin = Date | Function | Uint8Array | string | number | boolean |${options.forceLong === options_1.LongOption.BIGINT ? " bigint |" : ""} undefined;`);
     // Based on https://github.com/sindresorhus/type-fest/pull/259
-    const maybeExcludeType = options.outputTypeAnnotations || options.outputTypeRegistry ? `| '$type'` : "";
+    const maybeExcludeType = addTypeToMessages(options) ? `| '$type'` : "";
     const Exact = (0, ts_poet_1.conditionalOutput)("Exact", (0, ts_poet_1.code) `
       type KeysOfUnion<T> = T extends T ? keyof T : never;
       ${maybeExport} type Exact<P, I extends P> = P extends ${Builtin}
@@ -427,7 +427,7 @@ function makeDeepPartial(options, longs) {
         { [K in keyof P]: Exact<P[K], I[K]> } & { [K in Exclude<keyof I, KeysOfUnion<P> ${maybeExcludeType}>]: never };
     `);
     // Based on the type from ts-essentials
-    const keys = options.outputTypeAnnotations || options.outputTypeRegistry ? (0, ts_poet_1.code) `Exclude<keyof T, '$type'>` : (0, ts_poet_1.code) `keyof T`;
+    const keys = addTypeToMessages(options) ? (0, ts_poet_1.code) `Exclude<keyof T, '$type'>` : (0, ts_poet_1.code) `keyof T`;
     const DeepPartial = (0, ts_poet_1.conditionalOutput)("DeepPartial", (0, ts_poet_1.code) `
       ${maybeExport} type DeepPartial<T> =  T extends ${Builtin}
         ? T
@@ -487,7 +487,7 @@ function makeTimestampMethods(options, longs) {
         // (note this only occurs when the string is > 8 characters)
         seconds = "Math.trunc(date.getTime() / 1_000).toString()";
     }
-    const maybeTypeField = options.outputTypeAnnotations || options.outputTypeRegistry ? `$type: 'google.protobuf.Timestamp',` : "";
+    const maybeTypeField = addTypeToMessages(options) ? `$type: 'google.protobuf.Timestamp',` : "";
     const toTimestamp = (0, ts_poet_1.conditionalOutput)("toTimestamp", options.useDate === options_1.DateOption.STRING
         ? (0, ts_poet_1.code) `
           function toTimestamp(dateStr: string): ${Timestamp} {
@@ -597,7 +597,7 @@ function generateInterfaceDeclaration(ctx, fullName, messageDesc, sourceInfo, fu
     (0, utils_1.maybeAddComment)(sourceInfo, chunks, (_a = messageDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
     // 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 (ctx.options.outputTypeAnnotations || ctx.options.outputTypeRegistry) {
+    if (addTypeToMessages(options)) {
         chunks.push((0, ts_poet_1.code) `$type: '${fullTypeName}',`);
     }
     // When oneof=unions, we generate a single property with an ADT per `oneof` clause.
@@ -688,7 +688,7 @@ function generateBaseInstanceFactory(ctx, fullName, messageDesc, fullTypeName) {
                     : (0, types_1.defaultValue)(ctx, field);
         fields.push((0, ts_poet_1.code) `${name}: ${val}`);
     }
-    if (ctx.options.outputTypeAnnotations || ctx.options.outputTypeRegistry) {
+    if (addTypeToMessages(options)) {
         fields.unshift((0, ts_poet_1.code) `$type: '${fullTypeName}'`);
     }
     if (ctx.options.unknownFields && ctx.options.initializeFieldsAsUndefined) {
@@ -954,7 +954,7 @@ function getEncodeWriteSnippet(ctx, field) {
         return (place) => (0, ts_poet_1.code) `${type}.encode(${utils.toTimestamp}(${place}), writer.uint32(${tag}).fork()).ldelim()`;
     }
     else if ((0, types_1.isValueType)(ctx, field)) {
-        const maybeTypeField = options.outputTypeAnnotations || options.outputTypeRegistry ? `$type: '${field.typeName.slice(1)}',` : "";
+        const maybeTypeField = addTypeToMessages(options) ? `$type: '${field.typeName.slice(1)}',` : "";
         const type = (0, types_1.basicTypeName)(ctx, field, { keepValueType: true });
         const wrappedValue = (place) => {
             if ((0, types_1.isAnyValueType)(field) || (0, types_1.isListValueType)(field) || (0, types_1.isStructType)(field) || (0, types_1.isFieldMaskType)(field)) {
@@ -1003,7 +1003,7 @@ function generateEncode(ctx, fullName, messageDesc) {
         if ((0, types_1.isRepeated)(field)) {
             if ((0, types_1.isMapType)(ctx, messageDesc, field)) {
                 const valueType = typeMap.get(field.typeName)[2].field[1];
-                const maybeTypeField = options.outputTypeAnnotations || options.outputTypeRegistry ? `$type: '${field.typeName.slice(1)}',` : "";
+                const maybeTypeField = addTypeToMessages(options) ? `$type: '${field.typeName.slice(1)}',` : "";
                 const entryWriteSnippet = (0, types_1.isValueType)(ctx, valueType)
                     ? (0, ts_poet_1.code) `
               if (value !== undefined) {
@@ -1255,7 +1255,7 @@ function generateExtension(ctx, message, extension) {
                 return (place) => (0, ts_poet_1.code) `${type}.encode(${utils.toTimestamp}(${place}), writer.fork()).ldelim()`;
             }
             else if ((0, types_1.isValueType)(ctx, field)) {
-                const maybeTypeField = options.outputTypeAnnotations || options.outputTypeRegistry ? `$type: '${field.typeName.slice(1)}',` : "";
+                const maybeTypeField = addTypeToMessages(options) ? `$type: '${field.typeName.slice(1)}',` : "";
                 const type = (0, types_1.basicTypeName)(ctx, field, { keepValueType: true });
                 const wrappedValue = (place) => {
                     if ((0, types_1.isAnyValueType)(field) || (0, types_1.isListValueType)(field) || (0, types_1.isStructType)(field) || (0, types_1.isFieldMaskType)(field)) {
@@ -1387,7 +1387,7 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
     fromJSON(${messageDesc.field.length > 0 ? "object" : "_"}: any): ${fullName} {
       return {
   `);
-    if (ctx.options.outputTypeAnnotations || ctx.options.outputTypeRegistry) {
+    if (addTypeToMessages(options)) {
         chunks.push((0, ts_poet_1.code) `$type: ${fullName}.$type,`);
     }
     const oneofFieldsCases = messageDesc.oneofDecl.map((oneof, oneofIndex) => messageDesc.field.filter(types_1.isWithinOneOf).filter((field) => field.oneofIndex === oneofIndex));
@@ -2014,3 +2014,6 @@ function maybeReadonly(options) {
 function maybeAsAny(options) {
     return options.useReadonlyTypes ? " as any" : "";
 }
+function addTypeToMessages(options) {
+    return ((options.outputTypeAnnotations || options.outputTypeRegistry) && options.outputTypeAnnotations !== "static-only");
+}

package/package.json

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