ts-proto 2.15.3 → 2.17.0

package/README.markdown

@@ -569,6 +569,8 @@ With `--ts_proto_opt=protoJsonFormat=false`, strict proto3 compliance is disable
 
   The default behavior is `useMapType=false`, which makes it generate the code for protobuf `map<key_type, value_type` with the key-value pair like `{[key: key_type]: value_type}`.
 
+- With `--ts_proto_opt=useUnknownForValue=true`, `google.protobuf.Value` fields are typed as `unknown` instead of `any`, and so are the items of `google.protobuf.ListValue` and the values of `google.protobuf.Struct`. This makes TypeScript ask you to narrow the value before using it.
+
 - With `--ts_proto_opt=useReadonlyTypes=true`, the generated types will be declared as immutable using typescript's `readonly` modifier.
 
 - With `--ts_proto_opt=useSnakeTypeName=false` will remove snake casing from types.
@@ -612,6 +614,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

@@ -506,6 +506,9 @@ function makeDeepPartial(options, longs) {
     const maybeLong = options.forceLong === options_1.LongOption.LONG ? (0, ts_poet_1.code) ` : T extends ${longs.Long} ? string | number | Long ` : "";
     // Allow passing bigints as numbers or strings; fromPartial coerces them via BigInt()
     const maybeBigInt = options.forceLong === options_1.LongOption.BIGINT ? (0, ts_poet_1.code) `T extends bigint ? string | number | bigint : ` : "";
+    // Keep `unknown` (useUnknownForValue) as is; mapping over it would turn it into `{}`
+    const maybeUnknownT = options.useUnknownForValue ? "unknown extends T ? T : " : "";
+    const maybeUnknownP = options.useUnknownForValue ? "unknown extends P ? P : " : "";
     const optionalBuiltins = [];
     if (options.forceLong === options_1.LongOption.BIGINT) {
         optionalBuiltins.push("bigint");
@@ -518,7 +521,7 @@ function makeDeepPartial(options, longs) {
     const maybeExcludeType = (0, options_1.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}
+      ${maybeExport} type Exact<P, I extends P> = ${maybeUnknownP}P extends ${Builtin}
         ? P
         : P &
         { [K in keyof P]: Exact<P[K], I[K]> } & { [K in Exclude<keyof I, KeysOfUnion<P> ${maybeExcludeType}>]: never };
@@ -526,7 +529,7 @@ function makeDeepPartial(options, longs) {
     // Based on the type from ts-essentials
     const keys = (0, options_1.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> = ${maybeBigInt} T extends ${Builtin}
+      ${maybeExport} type DeepPartial<T> = ${maybeUnknownT}${maybeBigInt} T extends ${Builtin}
         ? T
         ${maybeLong}
         : T extends globalThis.Array<infer U>

package/build/src/options.d.ts

@@ -103,6 +103,7 @@ export type Options = {
     initializeFieldsAsUndefined: boolean;
     useMapType: boolean;
     useReadonlyTypes: boolean;
+    useUnknownForValue: boolean;
     useSnakeTypeName: boolean;
     outputExtensions: boolean;
     outputIndex: boolean;
@@ -121,6 +122,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

@@ -119,6 +119,7 @@ function defaultOptions() {
         initializeFieldsAsUndefined: true,
         useMapType: false,
         useReadonlyTypes: false,
+        useUnknownForValue: false,
         useSnakeTypeName: true,
         outputExtensions: false,
         outputIndex: false,
@@ -135,6 +136,10 @@ function defaultOptions() {
         bigIntLiteral: true,
         typePrefix: "",
         typeSuffix: "",
+        messagePrefix: "",
+        messageSuffix: "",
+        enumPrefix: "",
+        enumSuffix: "",
         useDuration: DurationOption.DURATION,
         anyType: AnyTypeOption.AT_TYPE,
     };

package/build/src/types.js

@@ -542,12 +542,16 @@ function valueTypeName(ctx, typeName) {
                 : ctx.options.useJsonWireFormat
                     ? (0, ts_poet_1.code) `string`
                     : (0, ts_poet_1.code) `Uint8Array`;
-        case ".google.protobuf.ListValue":
-            return ctx.options.useReadonlyTypes ? (0, ts_poet_1.code) `ReadonlyArray<any>` : (0, ts_poet_1.code) `Array<any>`;
+        case ".google.protobuf.ListValue": {
+            const item = ctx.options.useUnknownForValue ? "unknown" : "any";
+            return ctx.options.useReadonlyTypes ? (0, ts_poet_1.code) `ReadonlyArray<${item}>` : (0, ts_poet_1.code) `Array<${item}>`;
+        }
         case ".google.protobuf.Value":
-            return (0, ts_poet_1.code) `any`;
-        case ".google.protobuf.Struct":
-            return ctx.options.useReadonlyTypes ? (0, ts_poet_1.code) `{readonly [key: string]: any}` : (0, ts_poet_1.code) `{[key: string]: any}`;
+            return ctx.options.useUnknownForValue ? (0, ts_poet_1.code) `unknown` : (0, ts_poet_1.code) `any`;
+        case ".google.protobuf.Struct": {
+            const item = ctx.options.useUnknownForValue ? "unknown" : "any";
+            return ctx.options.useReadonlyTypes ? (0, ts_poet_1.code) `{readonly [key: string]: ${item}}` : (0, ts_poet_1.code) `{[key: string]: ${item}}`;
+        }
         case ".google.protobuf.FieldMask":
             return ctx.options.useJsonWireFormat
                 ? (0, ts_poet_1.code) `string`

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.3",
+  "version": "2.17.0",
   "description": "",
   "main": "build/src/plugin.js",
   "repository": "github:stephenh/ts-proto",