ts-proto 2.15.2 → 2.16.0

package/README.markdown

@@ -612,6 +612,8 @@ With `--ts_proto_opt=protoJsonFormat=false`, strict proto3 compliance is disable
 
 - With `--ts_proto_opt=typeSuffix=MySuffix`, the generated interfaces, enums, and factories will have a suffix of `MySuffix` in their names.
 
+- With `--ts_proto_opt=messagePrefix=MyPrefix` / `messageSuffix=MySuffix`, only the generated message interfaces and factories get the prefix/suffix, and with `enumPrefix=MyPrefix` / `enumSuffix=MySuffix` only the enums do. They are added inside `typePrefix`/`typeSuffix` when both are set, e.g. `typePrefix=T,messagePrefix=M` gives `TMFoo`.
+
 ```protobuf
 message ProfileInfo {
     int32 id = 1;

package/build/src/generate-struct-wrappers.js

@@ -48,7 +48,7 @@ function generateWrapDeep(ctx, fullProtoTypeName, fieldNames) {
         chunks.push((0, ts_poet_1.code) `wrap(value: any): ${(0, utils_1.wrapTypeName)(ctx.options, "Value")} {
       const result = {} as any;
       if (value === null) {
-        result.${fieldNames.nullValue} = ${(0, utils_1.wrapTypeName)(ctx.options, "NullValue")}.NULL_VALUE;
+        result.${fieldNames.nullValue} = ${(0, utils_1.wrapTypeName)(ctx.options, "NullValue", "enum")}.NULL_VALUE;
       } else if (typeof value === 'boolean') {
         result.${fieldNames.boolValue} = value;
       } else if (typeof value === 'number') {
@@ -180,7 +180,7 @@ function generateWrapShallow(ctx, fullProtoTypeName, fieldNames) {
             chunks.push((0, ts_poet_1.code) `wrap(value: any): ${(0, utils_1.wrapTypeName)(ctx.options, "Value")} {
         const result = createBase${(0, utils_1.wrapTypeName)(ctx.options, "Value")}()${maybeAsAny(ctx.options)};
         if (value === null) {
-          result.kind = {$case: '${fieldNames.nullValue}', ${fieldNames.nullValue}: ${(0, utils_1.wrapTypeName)(ctx.options, "NullValue")}.NULL_VALUE};
+          result.kind = {$case: '${fieldNames.nullValue}', ${fieldNames.nullValue}: ${(0, utils_1.wrapTypeName)(ctx.options, "NullValue", "enum")}.NULL_VALUE};
         } else if (typeof value === 'boolean') {
           result.kind = {$case: '${fieldNames.boolValue}', ${fieldNames.boolValue}: value};
         } else if (typeof value === 'number') {
@@ -201,7 +201,7 @@ function generateWrapShallow(ctx, fullProtoTypeName, fieldNames) {
             chunks.push((0, ts_poet_1.code) `wrap(value: any): ${(0, utils_1.wrapTypeName)(ctx.options, "Value")} {
         const result = createBase${(0, utils_1.wrapTypeName)(ctx.options, "Value")}()${maybeAsAny(ctx.options)};
         if (value === null) {
-          result.kind = {$case: '${fieldNames.nullValue}', value: ${(0, utils_1.wrapTypeName)(ctx.options, "NullValue")}.NULL_VALUE};
+          result.kind = {$case: '${fieldNames.nullValue}', value: ${(0, utils_1.wrapTypeName)(ctx.options, "NullValue", "enum")}.NULL_VALUE};
         } else if (typeof value === 'boolean') {
           result.kind = {$case: '${fieldNames.boolValue}', value };
         } else if (typeof value === 'number') {
@@ -222,7 +222,7 @@ function generateWrapShallow(ctx, fullProtoTypeName, fieldNames) {
             chunks.push((0, ts_poet_1.code) `wrap(value: any): ${(0, utils_1.wrapTypeName)(ctx.options, "Value")} {
         const result = createBase${(0, utils_1.wrapTypeName)(ctx.options, "Value")}()${maybeAsAny(ctx.options)};
         if (value === null) {
-          result.${fieldNames.nullValue} = ${(0, utils_1.wrapTypeName)(ctx.options, "NullValue")}.NULL_VALUE;
+          result.${fieldNames.nullValue} = ${(0, utils_1.wrapTypeName)(ctx.options, "NullValue", "enum")}.NULL_VALUE;
         } else if (typeof value === 'boolean') {
           result.${fieldNames.boolValue} = value;
         } else if (typeof value === 'number') {

package/build/src/main.js

@@ -1900,6 +1900,27 @@ function generateExtension(ctx, message, extension) {
         extensionInfo: (0, ts_poet_1.joinCode)(chunks, { on: "\n" }),
     };
 }
+/** Converts the JSON of a wrapper type, such as `google.protobuf.Int64Value`, to the unwrapped value. */
+function valueTypeFromJson(ctx, field, from) {
+    const { options } = ctx;
+    const valueType = (0, types_1.valueTypeName)(ctx, field.typeName);
+    if ((0, types_1.isLongValueType)(field) && options.forceLong === options_1.LongOption.LONG) {
+        return (0, ts_poet_1.code) `${(0, case_1.capitalize)(valueType.toCodeString([]))}.fromValue(${from})`;
+    }
+    else if ((0, types_1.isLongValueType)(field) && options.forceLong === options_1.LongOption.BIGINT) {
+        return (0, ts_poet_1.code) `BigInt(${from})`;
+    }
+    else if ((0, types_1.isBytesValueType)(field)) {
+        return (0, ts_poet_1.code) `new ${(0, case_1.capitalize)(valueType.toCodeString([]))}(${from})`;
+    }
+    else {
+        return (0, ts_poet_1.code) `${(0, case_1.capitalize)(valueType.toCodeString([]))}(${from})`;
+    }
+}
+/** Whether `field` is a 64-bit wrapper type unwrapped to a `Long` or `bigint`, which JSON writes as a string. */
+function isLongValueTypeAsObject(options, field) {
+    return (0, types_1.isLongValueType)(field) && (options.forceLong === options_1.LongOption.LONG || options.forceLong === options_1.LongOption.BIGINT);
+}
 /**
  * Creates a function to decode a message from JSON.
  *
@@ -2042,19 +2063,7 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
                 return (0, ts_poet_1.code) `[...${from}]`;
             }
             else if ((0, types_1.isValueType)(ctx, field)) {
-                const valueType = (0, types_1.valueTypeName)(ctx, field.typeName);
-                if ((0, types_1.isLongValueType)(field) && options.forceLong === options_1.LongOption.LONG) {
-                    return (0, ts_poet_1.code) `${(0, case_1.capitalize)(valueType.toCodeString([]))}.fromValue(${from})`;
-                }
-                else if ((0, types_1.isLongValueType)(field) && options.forceLong === options_1.LongOption.BIGINT) {
-                    return (0, ts_poet_1.code) `BigInt(${from})`;
-                }
-                else if ((0, types_1.isBytesValueType)(field)) {
-                    return (0, ts_poet_1.code) `new ${(0, case_1.capitalize)(valueType.toCodeString([]))}(${from})`;
-                }
-                else {
-                    return (0, ts_poet_1.code) `${(0, case_1.capitalize)(valueType.toCodeString([]))}(${from})`;
-                }
+                return valueTypeFromJson(ctx, field, from);
             }
             else if ((0, types_1.isMessage)(field)) {
                 if ((0, types_1.isRepeated)(field) && (0, types_1.isMapType)(ctx, messageDesc, field)) {
@@ -2097,6 +2106,9 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
                             options.useDate === options_1.DateOption.TIMESTAMP)) {
                         return (0, ts_poet_1.code) `${utils.fromJsonTimestamp}(${from})`;
                     }
+                    else if ((0, types_1.isLongValueType)(valueField)) {
+                        return valueTypeFromJson(ctx, valueField, from);
+                    }
                     else if ((0, types_1.isValueType)(ctx, valueField)) {
                         return (0, ts_poet_1.code) `${from} as ${valueType}`;
                     }
@@ -2496,6 +2508,10 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
                 else if ((0, types_1.isFloatingPoint)(valueType)) {
                     return (0, ts_poet_1.code) `${utils.floatToJson}(${from})`;
                 }
+                else if (isLongValueTypeAsObject(options, valueType)) {
+                    // Map values of wrapper types are declared `| undefined`.
+                    return (0, ts_poet_1.code) `${from}?.toString()`;
+                }
                 else if ((0, types_1.isScalar)(valueType) || (0, types_1.isValueType)(ctx, valueType)) {
                     return (0, ts_poet_1.code) `${from}`;
                 }
@@ -2521,6 +2537,9 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
             else if ((0, types_1.isBytes)(field)) {
                 return (0, ts_poet_1.code) `${utils.base64FromBytes}(${from})`;
             }
+            else if (isLongValueTypeAsObject(options, field)) {
+                return (0, ts_poet_1.code) `${from}.toString()`;
+            }
             else if ((0, types_1.isLong)(field) && (0, types_1.isJsTypeFieldOption)(options, field)) {
                 const fieldType = (0, types_1.getFieldOptionsJsType)(field, ctx.options) ?? field.type;
                 if (!fieldType) {

package/build/src/options.d.ts

@@ -121,6 +121,10 @@ export type Options = {
     bigIntLiteral: boolean;
     typePrefix: string;
     typeSuffix: string;
+    messagePrefix: string;
+    messageSuffix: string;
+    enumPrefix: string;
+    enumSuffix: string;
     useDuration: DurationOption;
     anyType: AnyTypeOption;
 };

package/build/src/options.js

@@ -135,6 +135,10 @@ function defaultOptions() {
         bigIntLiteral: true,
         typePrefix: "",
         typeSuffix: "",
+        messagePrefix: "",
+        messageSuffix: "",
+        enumPrefix: "",
+        enumSuffix: "",
         useDuration: DurationOption.DURATION,
         anyType: AnyTypeOption.AT_TYPE,
     };

package/build/src/utils.d.ts

@@ -80,4 +80,4 @@ export declare function getVersions(request: CodeGeneratorRequest): Promise<{
     protocVersion: string;
     tsProtoVersion: string;
 }>;
-export declare function wrapTypeName(options: Options, name: string): string;
+export declare function wrapTypeName(options: Options, name: string, kind?: "message" | "enum"): string;

package/build/src/utils.js

@@ -308,6 +308,7 @@ async function readPackageJson() {
         return await Promise.resolve(`${"../package.json"}`).then(s => require(s));
     }
 }
-function wrapTypeName(options, name) {
-    return options.typePrefix + name + options.typeSuffix;
+function wrapTypeName(options, name, kind = "message") {
+    const [prefix, suffix] = kind === "enum" ? [options.enumPrefix, options.enumSuffix] : [options.messagePrefix, options.messageSuffix];
+    return options.typePrefix + prefix + name + suffix + options.typeSuffix;
 }

package/build/src/visit.js

@@ -13,7 +13,7 @@ function visit(proto, sourceInfo, messageFn, options, enumFn = () => { }, tsPref
         const protoFullName = protoPrefix + enumDesc.name;
         // I.e. FooBar_ZazInner
         const tsFullName = tsPrefix + (0, case_1.maybeSnakeToCamel)(enumDesc.name, options);
-        const tsFullNameWithAffixes = messageName((0, utils_1.wrapTypeName)(options, tsFullName));
+        const tsFullNameWithAffixes = messageName((0, utils_1.wrapTypeName)(options, tsFullName, "enum"));
         const nestedSourceInfo = sourceInfo.open(childEnumType, index);
         enumFn(tsFullNameWithAffixes, enumDesc, nestedSourceInfo, protoFullName);
     });

package/package.json

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