ts-proto 1.116.1 → 1.118.0

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+# [1.118.0](https://github.com/stephenh/ts-proto/compare/v1.117.1...v1.118.0) (2022-07-19)
+
+
+### Features
+
+* add dynamic upStreamCodes option ([#618](https://github.com/stephenh/ts-proto/issues/618)) ([3091023](https://github.com/stephenh/ts-proto/commit/309102313273e09aef3a8480f4b46360ad82adaa))
+
+## [1.117.1](https://github.com/stephenh/ts-proto/compare/v1.117.0...v1.117.1) (2022-07-16)
+
+
+### Bug Fixes
+
+* import protobufjs/minimal with importSuffix ([#616](https://github.com/stephenh/ts-proto/issues/616)) ([b86291c](https://github.com/stephenh/ts-proto/commit/b86291c58b1cb9d4064944a6371e928b564aef7f))
+
+# [1.117.0](https://github.com/stephenh/ts-proto/compare/v1.116.1...v1.117.0) (2022-07-05)
+
+
+### Features
+
+* add importSuffix option and remove default .js suffix ([#612](https://github.com/stephenh/ts-proto/issues/612)) ([63a8895](https://github.com/stephenh/ts-proto/commit/63a8895f5a3a38fa3d5c0868f44e950e137fb697))
+
 ## [1.116.1](https://github.com/stephenh/ts-proto/compare/v1.116.0...v1.116.1) (2022-07-02)
 
 

package/README.markdown

@@ -110,6 +110,8 @@ plugins:
 
 # Goals
 
+In terms of the code that `ts-proto` generates, the general goals are:
+
 - Idiomatic TypeScript/ES6 types
   - `ts-proto` is a clean break from either the built-in Google/Java-esque JS code of `protoc` or the "make `.d.ts` files the `*.js` comments" approach of `protobufjs`
   - (Techically the `protobufjs/minimal` package is used for actually reading/writing bytes.)
@@ -118,6 +120,17 @@ plugins:
   - As much as possible, types are just interfaces, so you can work with messages just like regular hashes/data structures.
 - Only supports codegen `*.proto`-to-`*.ts` workflow, currently no runtime reflection/loading of dynamic `.proto` files
 
+## Non-Goals
+
+Note that ts-proto is not an out-of-the-box RPC framework; instead it's more of a swiss-army knife (as witnessed by its many config options), that lets you build _exactly_ the RPC framework you'd like on top of it (i.e. that best integrates with your company's protobuf ecosystem; for better or worse, protobuf RPC is still a somewhat fragmented ecosystem).
+
+If you'd like an out-of-the-box RPC framework built on top of ts-proto, there are a few examples:
+
+- [nice-grpc](https://github.com/deeplay-io/nice-grpc)
+- [starpc](https://github.com/aperturerobotics/starpc)
+
+(Note for potential contributors, if you develop other frameworks/mini-frameworks, or even blog posts/tutorials, on using `ts-proto`, we're happy to link to them.)
+
 # Example Types
 
 The generated types are "just data", i.e.:
@@ -388,6 +401,8 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=fileSuffix=<SUFFIX>`, ts-proto will emit generated files using the specified suffix. A `helloworld.proto` file with `fileSuffix=.pb` would be generated as `helloworld.pb.ts`. This is common behavior in other protoc plugins and provides a way to quickly glob all the generated files.
 
+- With `--ts_proto_opt=importSuffix=<SUFFIX>`, ts-proto will emit file imports using the specified suffix. An import of `helloworld.ts` with `fileSuffix=.js` would generate `import "helloworld.js"`. The default is to import without a file extension. Supported by TypeScript 4.7.x and up.
+
 - With `--ts_proto_opt=enumsAsLiterals=true`, the generated enum types will be enum-ish object with `as const`.
 
 - With `--ts_proto_opt=useExactTypes=false`, the generated `fromPartial` method will not use Exact types.
@@ -481,6 +496,8 @@ If you need ts-proto customizations or priority support for your company, you ca
 
 # Development
 
+This section describes how to contribute directly to ts-proto, i.e. it's not required for running `ts-proto` in `protoc` or using the generated TypeScript.
+
 **Requirements**
 
 - [Docker](https://www.docker.com) or [protoc](https://github.com/protocolbuffers/protobuf/releases) v3.19.1

package/build/generate-grpc-web.js

@@ -170,6 +170,7 @@ function generateGrpcWebImpl(ctx, returnObservable, hasStreamingMethods) {
       ${hasStreamingMethods ? 'streamingTransport?: grpc.TransportFactory,' : ``}
       debug?: boolean,
       metadata?: grpc.Metadata,
+      upStreamRetryCodes?: number[],
     }
   `;
     const chunks = [];
@@ -268,8 +269,7 @@ function createInvokeMethod(ctx) {
       _request: any,
       metadata: grpc.Metadata | undefined
     ): ${(0, types_1.observableType)(ctx)}<any> {
-      // Status Response Codes (https://developers.google.com/maps-booking/reference/grpc-api/status_codes)
-      const upStreamCodes = [2, 4, 8, 9, 10, 13, 14, 15]; 
+      const upStreamCodes = this.options.upStreamRetryCodes || [];
       const DEFAULT_TIMEOUT_TIME: number = 3_000;
       const request = { ..._request, ...methodDesc.requestType };
       const maybeCombinedMetadata =

package/build/generate-services.js

@@ -8,7 +8,6 @@ const sourceInfo_1 = require("./sourceInfo");
 const main_1 = require("./main");
 const hash = (0, ts_poet_1.imp)('hash*object-hash');
 const dataloader = (0, ts_poet_1.imp)('DataLoader*dataloader');
-const Reader = (0, ts_poet_1.imp)('Reader@protobufjs/minimal');
 /**
  * Generates an interface for `serviceDesc`.
  *
@@ -76,7 +75,7 @@ exports.generateService = generateService;
 function generateRegularRpcMethod(ctx, fileDesc, serviceDesc, methodDesc) {
     (0, utils_1.assertInstanceOf)(methodDesc, utils_1.FormattedMethodDescriptor);
     const { options, utils } = ctx;
-    const Reader = (0, ts_poet_1.imp)('Reader@protobufjs/minimal');
+    const Reader = (0, utils_1.impFile)(ctx.options, 'Reader@protobufjs/minimal');
     const rawInputType = (0, types_1.rawRequestType)(ctx, methodDesc);
     const inputType = (0, types_1.requestType)(ctx, methodDesc);
     const outputType = (0, types_1.responseType)(ctx, methodDesc);
@@ -223,6 +222,7 @@ function generateCachingRpcMethod(ctx, fileDesc, serviceDesc, methodDesc) {
     const inputType = (0, types_1.requestType)(ctx, methodDesc);
     const outputType = (0, types_1.responseType)(ctx, methodDesc);
     const uniqueIdentifier = `${(0, utils_1.maybePrefixPackage)(fileDesc, serviceDesc.name)}.${methodDesc.name}`;
+    const Reader = (0, utils_1.impFile)(ctx.options, 'Reader@protobufjs/minimal');
     const lambda = (0, ts_poet_1.code) `
     (requests) => {
       const responses = requests.map(async request => {

package/build/generate-type-registry.js

@@ -2,8 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateTypeRegistry = void 0;
 const ts_poet_1 = require("ts-poet");
-const Writer = (0, ts_poet_1.imp)('Writer@protobufjs/minimal');
-const Reader = (0, ts_poet_1.imp)('Reader@protobufjs/minimal');
+const utils_1 = require("./utils");
 function generateTypeRegistry(ctx) {
     const chunks = [];
     chunks.push(generateMessageType(ctx));
@@ -22,6 +21,8 @@ function generateMessageType(ctx) {
     chunks.push((0, ts_poet_1.code) `export interface MessageType<Message extends UnknownMessage = UnknownMessage> {`);
     chunks.push((0, ts_poet_1.code) `$type: Message['$type'];`);
     if (ctx.options.outputEncodeMethods) {
+        const Writer = (0, utils_1.impFile)(ctx.options, 'Writer@protobufjs/minimal');
+        const Reader = (0, utils_1.impFile)(ctx.options, 'Reader@protobufjs/minimal');
         chunks.push((0, ts_poet_1.code) `encode(message: Message, writer?: ${Writer}): ${Writer};`);
         chunks.push((0, ts_poet_1.code) `decode(input: ${Reader} | Uint8Array, length?: number): Message;`);
     }

package/build/main.js

@@ -108,7 +108,7 @@ function generateFile(ctx, fileDesc) {
           };
         `);
             if (options.outputTypeRegistry) {
-                const messageTypeRegistry = (0, ts_poet_1.imp)('messageTypeRegistry@./typeRegistry');
+                const messageTypeRegistry = (0, utils_1.impFile)(options, 'messageTypeRegistry@./typeRegistry');
                 chunks.push((0, ts_poet_1.code) `
             ${messageTypeRegistry}.set(${fullName}.$type, ${fullName});
           `);
@@ -227,8 +227,8 @@ exports.makeUtils = makeUtils;
 function makeLongUtils(options, bytes) {
     // Regardless of which `forceLong` config option we're using, we always use
     // the `long` library to either represent or at least sanity-check 64-bit values
-    const util = (0, ts_poet_1.imp)('util@protobufjs/minimal');
-    const configure = (0, ts_poet_1.imp)('configure@protobufjs/minimal');
+    const util = (0, utils_1.impFile)(options, 'util@protobufjs/minimal');
+    const configure = (0, utils_1.impFile)(options, 'configure@protobufjs/minimal');
     // Before esModuleInterop, we had to use 'import * as Long from long` b/c long is
     // an `export =` module and exports only the Long constructor (which is callable).
     // See https://www.typescriptlang.org/docs/handbook/modules.html#export--and-import--require.
@@ -572,6 +572,7 @@ function generateDecode(ctx, fullName, messageDesc) {
     if (options.usePrototypeForDefaults) {
         createBase = (0, ts_poet_1.code) `Object.create(${createBase}) as ${fullName}`;
     }
+    const Reader = (0, utils_1.impFile)(ctx.options, 'Reader@protobufjs/minimal');
     // create the basic function declaration
     chunks.push((0, ts_poet_1.code) `
     decode(
@@ -712,12 +713,11 @@ function generateDecode(ctx, fullName, messageDesc) {
     chunks.push((0, ts_poet_1.code) `}`);
     return (0, ts_poet_1.joinCode)(chunks, { on: '\n' });
 }
-const Writer = (0, ts_poet_1.imp)('Writer@protobufjs/minimal');
-const Reader = (0, ts_poet_1.imp)('Reader@protobufjs/minimal');
 /** Creates a function to encode a message by loop overing the tags. */
 function generateEncode(ctx, fullName, messageDesc) {
     const { options, utils, typeMap } = ctx;
     const chunks = [];
+    const Writer = (0, utils_1.impFile)(ctx.options, 'Writer@protobufjs/minimal');
     // create the basic function declaration
     chunks.push((0, ts_poet_1.code) `
     encode(

package/build/options.js

@@ -43,6 +43,7 @@ function defaultOptions() {
         oneof: OneofOption.PROPERTIES,
         esModuleInterop: false,
         fileSuffix: '',
+        importSuffix: '',
         lowerCaseServiceMethods: false,
         outputEncodeMethods: true,
         outputJsonMethods: true,
@@ -163,7 +164,8 @@ function parseParameter(parameter) {
     });
     return options;
 }
-function getTsPoetOpts(options) {
-    return { forceModuleImport: ['protobufjs/minimal'] };
+function getTsPoetOpts(_options) {
+    const imports = ['protobufjs/minimal' + _options.importSuffix];
+    return _options.esModuleInterop ? { forceDefaultImport: imports } : { forceModuleImport: imports };
 }
 exports.getTsPoetOpts = getTsPoetOpts;

package/build/schema.js

@@ -68,7 +68,7 @@ function generateSchema(ctx, fileDesc, sourceInfo) {
         }
     });
     const dependencies = fileDesc.dependency.map((dep) => {
-        return (0, ts_poet_1.code) `${(0, ts_poet_1.imp)(`protoMetadata@./${dep.replace('.proto', '')}`)}`;
+        return (0, ts_poet_1.code) `${(0, utils_1.impFile)(options, `protoMetadata@./${dep.replace('.proto', '')}`)}`;
     });
     // Use toObject so that we get enums as numbers (instead of the default toJSON behavior)
     const descriptor = ts_proto_descriptors_1.FileDescriptorProto.fromPartial(fileDesc);

package/build/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.impProto = exports.getPropertyAccessor = exports.getFieldJsonName = exports.FormattedMethodDescriptor = exports.assertInstanceOf = exports.maybePrefixPackage = exports.prefixDisableLinter = exports.maybeAddComment = exports.upperFirst = exports.lowerFirst = exports.singular = exports.fail = exports.readToBuffer = exports.protoFilesToGenerate = void 0;
+exports.impProto = exports.impFile = exports.getPropertyAccessor = exports.getFieldJsonName = exports.FormattedMethodDescriptor = exports.assertInstanceOf = exports.maybePrefixPackage = exports.prefixDisableLinter = exports.maybeAddComment = exports.upperFirst = exports.lowerFirst = exports.singular = exports.fail = exports.readToBuffer = exports.protoFilesToGenerate = void 0;
 const ts_poet_1 = require("ts-poet");
 const options_1 = require("./options");
 const case_1 = require("./case");
@@ -169,9 +169,12 @@ function getPropertyAccessor(objectName, propertyName, optional = false) {
         : `${objectName}${optional ? '?.' : ''}[${JSON.stringify(propertyName)}]`;
 }
 exports.getPropertyAccessor = getPropertyAccessor;
+function impFile(options, spec) {
+    return (0, ts_poet_1.imp)(`${spec}${options.importSuffix}`);
+}
+exports.impFile = impFile;
 function impProto(options, module, type) {
-    // NOTE: TypeScript resolves importing foo.js to importing foo.ts.
-    const importString = `${type}@./${module}${options.fileSuffix}.js`;
+    const importString = `${type}@./${module}${options.fileSuffix}${options.importSuffix}`;
     if (options.onlyTypes) {
         return (0, ts_poet_1.imp)('t:' + importString);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "1.116.1",
+  "version": "1.118.0",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",
@@ -68,6 +68,6 @@
     "object-hash": "^1.3.1",
     "protobufjs": "^6.11.3",
     "ts-poet": "^4.15.0",
-    "ts-proto-descriptors": "1.7.0"
+    "ts-proto-descriptors": "1.7.1"
   }
 }