ts-proto 1.151.1 → 1.152.1

package/build/generate-grpc-web.js

@@ -227,17 +227,16 @@ function createPromiseUnaryMethod(ctx) {
       ${useAbortSignal ? "abortSignal?: AbortSignal," : ""}
     ): Promise<any> {
       const request = { ..._request, ...methodDesc.requestType };
-      const maybeCombinedMetadata =
-        metadata && this.options.metadata
-          ? new ${BrowserHeaders}({ ...this.options?.metadata.headersMap, ...metadata?.headersMap })
-          : metadata || this.options.metadata;
+      const maybeCombinedMetadata = metadata && this.options.metadata
+        ? new ${BrowserHeaders}({ ...this.options?.metadata.headersMap, ...metadata?.headersMap })
+        : metadata ?? this.options.metadata;
       return new Promise((resolve, reject) => {
         ${useAbortSignal ? `const client =` : ""} ${grpc}.unary(methodDesc, {
           request,
           host: this.host,
-          metadata: maybeCombinedMetadata,
-          transport: this.options.transport,
-          debug: this.options.debug,
+          metadata: maybeCombinedMetadata ?? {},
+          ...(this.options.transport !== undefined ? {transport: this.options.transport} : {}),
+          debug: this.options.debug ?? false,
           onEnd: function (response) {
             if (response.status === grpc.Code.OK) {
               resolve(response.message!.toObject());
@@ -271,17 +270,16 @@ function createObservableUnaryMethod(ctx) {
       ${useAbortSignal ? "abortSignal?: AbortSignal," : ""}
     ): ${(0, types_1.observableType)(ctx)}<any> {
       const request = { ..._request, ...methodDesc.requestType };
-      const maybeCombinedMetadata =
-        metadata && this.options.metadata
-          ? new ${BrowserHeaders}({ ...this.options?.metadata.headersMap, ...metadata?.headersMap })
-          : metadata || this.options.metadata;
+      const maybeCombinedMetadata = metadata && this.options.metadata
+        ? new ${BrowserHeaders}({ ...this.options?.metadata.headersMap, ...metadata?.headersMap })
+        : metadata ?? this.options.metadata;
       return new Observable(observer => {
         ${useAbortSignal ? `const client =` : ""} ${grpc}.unary(methodDesc, {
           request,
           host: this.host,
-          metadata: maybeCombinedMetadata,
-          transport: this.options.transport,
-          debug: this.options.debug,
+          metadata: maybeCombinedMetadata ?? {},
+          ...(this.options.transport !== undefined ? {transport: this.options.transport} : {}),
+          debug: this.options.debug ?? false,
           onEnd: (next) => {
             if (next.status !== 0) {
               const err = new ${ctx.utils.GrpcWebError}(next.statusMessage, next.status, next.trailers);
@@ -317,21 +315,21 @@ function createInvokeMethod(ctx) {
       metadata: grpc.Metadata | undefined,
       ${useAbortSignal ? "abortSignal?: AbortSignal," : ""}
     ): ${(0, types_1.observableType)(ctx)}<any> {
-      const upStreamCodes = this.options.upStreamRetryCodes || [];
+      const upStreamCodes = this.options.upStreamRetryCodes ?? [];
       const DEFAULT_TIMEOUT_TIME: number = 3_000;
       const request = { ..._request, ...methodDesc.requestType };
-      const maybeCombinedMetadata =
-      metadata && this.options.metadata
+      const transport = this.options.streamingTransport ?? this.options.transport;
+      const maybeCombinedMetadata = metadata && this.options.metadata
         ? new ${BrowserHeaders}({ ...this.options?.metadata.headersMap, ...metadata?.headersMap })
-        : metadata || this.options.metadata;
+        : metadata ?? this.options.metadata;
       return new Observable(observer => {
         const upStream = (() => {
           const client = ${grpc}.invoke(methodDesc, {
             host: this.host,
             request,
-            transport: this.options.streamingTransport || this.options.transport,
-            metadata: maybeCombinedMetadata,
-            debug: this.options.debug,
+            ...(transport !== undefined ? {transport} : {}),
+            metadata: maybeCombinedMetadata ?? {},
+            debug: this.options.debug ?? false,
             onMessage: (next) => observer.next(next),
             onEnd: (code: ${grpc}.Code, message: string, trailers: ${grpc}.Metadata) => {
               if (code === 0) {

package/build/generate-services.js

@@ -206,7 +206,7 @@ function generateBatchingRpcMethod(ctx, batchMethod) {
         // If the return type is a map, lookup each key in the result
         lambda.push((0, ts_poet_1.code) `
       return this.${methodDesc.formattedName}(ctx, request).then(res => {
-        return ${inputFieldName}.map(key => res.${outputFieldName}[key])
+        return ${inputFieldName}.map(key => res.${outputFieldName}[key] ?? ${ctx.utils.fail}())
       });
     `);
     }

package/build/main.js

@@ -279,6 +279,7 @@ function makeUtils(options) {
         ...makeNiceGrpcServerStreamingMethodResult(),
         ...makeGrpcWebErrorClass(bytes),
         ...makeExtensionClass(options),
+        ...makeAssertionUtils(),
     };
 }
 exports.makeUtils = makeUtils;
@@ -365,10 +366,10 @@ function makeLongUtils(options, bytes) {
 }
 function makeByteUtils() {
     const globalThis = (0, ts_poet_1.conditionalOutput)("tsProtoGlobalThis", (0, ts_poet_1.code) `
-      declare var self: any | undefined;
-      declare var window: any | undefined;
-      declare var global: any | undefined;
-      var tsProtoGlobalThis: any = (() => {
+      declare const self: any | undefined;
+      declare const window: any | undefined;
+      declare const global: any | undefined;
+      const tsProtoGlobalThis: any = (() => {
         if (typeof globalThis !== "undefined") return globalThis;
         if (typeof self !== "undefined") return self;
         if (typeof window !== "undefined") return window;
@@ -589,6 +590,14 @@ function makeExtensionClass(options) {
     `);
     return { Extension };
 }
+function makeAssertionUtils() {
+    const fail = (0, ts_poet_1.conditionalOutput)("fail", (0, ts_poet_1.code) `
+      function fail(message?: string): never {
+        throw new Error(message ?? "Failed");
+      }
+    `);
+    return { fail };
+}
 // Create the interface with properties
 function generateInterfaceDeclaration(ctx, fullName, messageDesc, sourceInfo, fullTypeName) {
     var _a;
@@ -615,12 +624,15 @@ function generateInterfaceDeclaration(ctx, fullName, messageDesc, sourceInfo, fu
         const info = sourceInfo.lookup(sourceInfo_1.Fields.message.field, index);
         (0, utils_1.maybeAddComment)(info, chunks, (_a = fieldDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
         const name = (0, case_1.maybeSnakeToCamel)(fieldDesc.name, options);
-        const type = (0, types_1.toTypeName)(ctx, messageDesc, fieldDesc);
-        const q = (0, types_1.isOptionalProperty)(fieldDesc, messageDesc.options, options) ? "?" : "";
-        chunks.push((0, ts_poet_1.code) `${maybeReadonly(options)}${name}${q}: ${type}, `);
+        const isOptional = (0, types_1.isOptionalProperty)(fieldDesc, messageDesc.options, options);
+        const type = (0, types_1.toTypeName)(ctx, messageDesc, fieldDesc, isOptional);
+        if (isOptional && !type.toString().includes("undefined")) {
+            console.warn(name, type);
+        }
+        chunks.push((0, ts_poet_1.code) `${maybeReadonly(options)}${name}${isOptional ? "?" : ""}: ${type}, `);
     });
     if (ctx.options.unknownFields) {
-        chunks.push((0, ts_poet_1.code) `_unknownFields?: {[key: number]: Uint8Array[]},`);
+        chunks.push((0, ts_poet_1.code) `_unknownFields?: {[key: number]: Uint8Array[]} | undefined,`);
     }
     chunks.push((0, ts_poet_1.code) `}`);
     return (0, ts_poet_1.joinCode)(chunks, { on: "\n" });
@@ -635,7 +647,7 @@ function generateOneofProperty(ctx, messageDesc, oneofIndex, sourceInfo) {
         return (0, ts_poet_1.code) `{ ${mbReadonly}$case: '${fieldName}', ${mbReadonly}${fieldName}: ${typeName} }`;
     }), { on: " | " });
     const name = (0, case_1.maybeSnakeToCamel)(messageDesc.oneofDecl[oneofIndex].name, options);
-    return (0, ts_poet_1.code) `${mbReadonly}${name}?: ${unionType},`;
+    return (0, ts_poet_1.code) `${mbReadonly}${name}?: ${unionType} | undefined,`;
     /*
     // Ideally we'd put the comments for each oneof field next to the anonymous
     // type we've created in the type union above, but ts-poet currently lacks
@@ -1135,8 +1147,7 @@ function generateEncode(ctx, fullName, messageDesc) {
     });
     if (options.unknownFields) {
         chunks.push((0, ts_poet_1.code) `if (message._unknownFields !== undefined) {
-      for (const key in message._unknownFields) {
-        const values = message._unknownFields[key];
+      for (const [key, values] of Object.entries(message._unknownFields)) {
         const tag = parseInt(key, 10);
         for (const value of values) {
           writer.uint32(tag);
@@ -1330,7 +1341,7 @@ function generateExtension(ctx, message, extension) {
             chunks.push((0, ts_poet_1.code) `const values: ${type} = [];`);
             // start loop over all buffers
             chunks.push((0, ts_poet_1.code) `
-        for (var buffer of input) {
+        for (const buffer of input) {
           const reader = ${Reader}.create(buffer);
       `);
             if ((0, types_1.packedType)(extension.type) === undefined) {
@@ -1360,7 +1371,7 @@ function generateExtension(ctx, message, extension) {
         else {
             // pick the last entry, since it overrides all previous entries if not repeated
             chunks.push((0, ts_poet_1.code) `
-          const reader = ${Reader}.create(input[input.length -1]);
+          const reader = ${Reader}.create(input[input.length -1] ?? ${ctx.utils.fail}());
           return ${readSnippet};
         },
       `);

package/build/types.js

@@ -531,19 +531,15 @@ function longTypeName(ctx) {
 }
 /** Maps `.some_proto_namespace.Message` to a TypeName. */
 function messageToTypeName(ctx, protoType, typeOptions = {}) {
+    var _a;
     const { options, typeMap } = ctx;
     // Watch for the wrapper types `.google.protobuf.*Value`. If we're mapping
     // them to basic built-in types, we union the type with undefined to
     // indicate the value is optional. Exceptions:
     // - If the field is repeated, values cannot be undefined.
-    // - If useOptionals='messages' or useOptionals='all', all non-scalar types
-    //   are already optional properties, so there's no need for that union.
     let valueType = valueTypeName(ctx, protoType);
     if (!typeOptions.keepValueType && valueType) {
-        if (!!typeOptions.repeated ||
-            options.useOptionals === true ||
-            options.useOptionals === "messages" ||
-            options.useOptionals === "all") {
+        if ((_a = typeOptions.repeated) !== null && _a !== void 0 ? _a : false) {
             return valueType;
         }
         return (0, ts_poet_1.code) `${valueType} | undefined`;
@@ -575,26 +571,32 @@ function getEnumMethod(ctx, enumProtoType, methodSuffix) {
 }
 exports.getEnumMethod = getEnumMethod;
 /** Return the TypeName for any field (primitive/message/etc.) as exposed in the interface. */
-function toTypeName(ctx, messageDesc, field) {
+function toTypeName(ctx, messageDesc, field, ensureOptional = false) {
+    function finalize(type, isOptional) {
+        if (isOptional) {
+            return (0, ts_poet_1.code) `${type} | undefined`;
+        }
+        return type;
+    }
     let type = basicTypeName(ctx, field, { keepValueType: false });
     if (isRepeated(field)) {
         const mapType = messageDesc ? detectMapType(ctx, messageDesc, field) : false;
         if (mapType) {
             const { keyType, valueType } = mapType;
             if (ctx.options.useMapType) {
-                return (0, ts_poet_1.code) `Map<${keyType}, ${valueType}>`;
+                return finalize((0, ts_poet_1.code) `Map<${keyType}, ${valueType}>`, ensureOptional);
             }
-            return (0, ts_poet_1.code) `{ [key: ${keyType} ]: ${valueType} }`;
+            return finalize((0, ts_poet_1.code) `{ [key: ${keyType} ]: ${valueType} }`, ensureOptional);
         }
         if (ctx.options.useReadonlyTypes) {
-            return (0, ts_poet_1.code) `readonly ${type}[]`;
+            return finalize((0, ts_poet_1.code) `readonly ${type}[]`, ensureOptional);
         }
-        return (0, ts_poet_1.code) `${type}[]`;
+        return finalize((0, ts_poet_1.code) `${type}[]`, ensureOptional);
     }
     if (isValueType(ctx, field)) {
         // google.protobuf.*Value types are already unioned with `undefined`
         // in messageToTypeName, so no need to consider them for that here.
-        return type;
+        return finalize(type, false);
     }
     // By default (useOptionals='none', oneof=properties), non-scalar fields
     // outside oneofs and all fields within a oneof clause need to be unioned
@@ -608,14 +610,12 @@ function toTypeName(ctx, messageDesc, field) {
     // clause, spelling each option out inside a large type union. No need for
     // union with `undefined` here, either.
     const { options } = ctx;
-    if ((!isWithinOneOf(field) &&
+    return finalize(type, (!isWithinOneOf(field) &&
         isMessage(field) &&
         (options.useOptionals === false || options.useOptionals === "none")) ||
         (isWithinOneOf(field) && options.oneof === options_1.OneofOption.PROPERTIES) ||
-        (isWithinOneOf(field) && field.proto3Optional)) {
-        return (0, ts_poet_1.code) `${type} | undefined`;
-    }
-    return type;
+        (isWithinOneOf(field) && field.proto3Optional) ||
+        ensureOptional);
 }
 exports.toTypeName = toTypeName;
 function detectMapType(ctx, messageDesc, fieldDesc) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "1.151.1",
+  "version": "1.152.1",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",
@@ -16,6 +16,7 @@
     "proto2pbjs": "docker compose run --rm protoc pbjs.sh",
     "bin2ts": "docker compose run --rm protoc codegen.sh",
     "test": "yarn jest -c jest.config.js --maxWorkers=2",
+    "tsc:check": "./tsc-check.sh tsconfig.json tests/tsconfig.json integration/tsconfig.json integration/tsconfig.proto.json protos/tsconfig.json",
     "format": "prettier --write {src,tests}/**/*.ts integration/*.ts",
     "format:check": "prettier --list-different {src,tests}/**/*.ts",
     "setup:docker": "docker compose build",
@@ -42,8 +43,9 @@
     "@semantic-release/github": "^9.0.2",
     "@semantic-release/npm": "^10.0.3",
     "@semantic-release/release-notes-generator": "^11.0.2",
+    "@tsconfig/strictest": "^2.0.1",
     "@types/jest": "^29.5.2",
-    "@types/node": "^14.14.37",
+    "@types/node": "^16.18.38",
     "chokidar": "^3.5.3",
     "jest": "^29.5.0",
     "jest-ts-webcompat-resolver": "^1.0.0",