ts-proto 2.16.0 → 2.18.0

package/README.markdown

@@ -372,6 +372,8 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=exportCommonSymbols=false`, utility types like `DeepPartial` and `protobufPackage` won't be `export`d.
 
+  Each generated file also exports `protobufFileName`, the path of the `.proto` file it was generated from (for example `export const protobufFileName = "company/foo.proto";`), next to `protobufPackage`; neither is exported with `exportCommonSymbols=false`.
+
   This should make it possible to use create barrel imports of the generated output, i.e. `import * from ./foo` and `import * from ./bar`.
 
   Note that if you have the same message name used in multiple `*.proto` files, you will still get import conflicts.
@@ -569,6 +571,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.

package/build/src/main.js

@@ -49,6 +49,8 @@ function generateFile(ctx, fileDesc) {
     // Indicate this file's source protobuf package for reflective use with google.protobuf.Any
     if (options.exportCommonSymbols) {
         chunks.push((0, ts_poet_1.code) `export const protobufPackage = '${fileDesc.package}';`);
+        // The source .proto path, e.g. for NestJS's `protoPath` or @grpc/proto-loader
+        chunks.push((0, ts_poet_1.code) `export const protobufFileName = '${fileDesc.name}';`);
     }
     // Syntax, unlike most fields, is not repeated and thus does not use an index
     const sourceInfo = sourceInfo_1.default.fromDescriptor(fileDesc);
@@ -506,6 +508,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 +523,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 +531,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;

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,

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/package.json

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