ts-proto 1.124.0 → 1.126.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [1.126.0](https://github.com/stephenh/ts-proto/compare/v1.125.0...v1.126.0) (2022-09-21)
+
+
+### Features
+
+* **options:** adds protoc-gen-go-like M option ([#672](https://github.com/stephenh/ts-proto/issues/672)) ([9304e5d](https://github.com/stephenh/ts-proto/commit/9304e5db7172db53530fb08fe0486f56b2a17181)), closes [#596](https://github.com/stephenh/ts-proto/issues/596)
+
+# [1.125.0](https://github.com/stephenh/ts-proto/compare/v1.124.0...v1.125.0) (2022-09-03)
+
+
+### Features
+
+* omit optional fields in base instance ([#669](https://github.com/stephenh/ts-proto/issues/669)) ([47b60aa](https://github.com/stephenh/ts-proto/commit/47b60aab95533542cf762f152138f7ab4234de88))
+
 # [1.124.0](https://github.com/stephenh/ts-proto/compare/v1.123.1...v1.124.0) (2022-09-03)
 
 

package/README.markdown

@@ -448,6 +448,16 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=useNumericEnumForJson=true`, the JSON converter (`toJSON`) will encode enum values as int, rather than a string literal.
 
+- With `--ts_proto_opt=initializeFieldsAsUndefined=false`, all optional field initializers will be omited from the generated base instances.
+
+- With `--ts_proto_opt=Mgoogle/protobuf/empty.proto=./google3/protobuf/empty`, ('M' means 'importMapping', similar to [protoc-gen-go](https://developers.google.com/protocol-buffers/docs/reference/go-generated#package)), the generated code import path for `./google/protobuf/empty.ts` will reflect the overridden value:
+  
+  - `Mfoo/bar.proto=@myorg/some-lib` will map `foo/bar.proto` imports into `import ... from '@myorg/some-lib'`.
+  - `Mfoo/bar.proto=./some/local/lib` will map `foo/bar.proto` imports into `import ... from './some/local/lib'`.
+  - `Mfoo/bar.proto=some-modules/some-lib` will map `foo/bar.proto` imports into `import ... from 'some-module/some-lib'`.
+  - **Note**: Uses are accummulated, so multiple values are expected in the form of `--ts_proto_opt=M... --ts_proto_opt=M...` (one `ts_proto_opt` per mapping).
+  - **Note**: Proto files that match mapped imports **will not be generated**.
+
 ### NestJS Support
 
 We have a great way of working together with [nestjs](https://docs.nestjs.com/microservices/grpc). `ts-proto` generates `interfaces` and `decorators` for you controller, client. For more information see the [nestjs readme](NESTJS.markdown).

package/build/main.js

@@ -549,6 +549,7 @@ function generateOneofProperty(ctx, messageDesc, oneofIndex, sourceInfo) {
 }
 // Create a function that constructs 'base' instance with default values for decode to use as a prototype
 function generateBaseInstanceFactory(ctx, fullName, messageDesc, fullTypeName) {
+    const { options } = ctx;
     const fields = [];
     // When oneof=unions, we generate a single property with an ADT per `oneof` clause.
     const processedOneofs = new Set();
@@ -562,6 +563,9 @@ function generateBaseInstanceFactory(ctx, fullName, messageDesc, fullTypeName) {
             }
             continue;
         }
+        if (!options.initializeFieldsAsUndefined && (0, types_1.isOptionalProperty)(field, messageDesc.options, options)) {
+            continue;
+        }
         const name = (0, case_1.maybeSnakeToCamel)(field.name, ctx.options);
         const val = (0, types_1.isWithinOneOf)(field)
             ? "undefined"

package/build/options.js

@@ -71,6 +71,8 @@ function defaultOptions() {
         usePrototypeForDefaults: false,
         useJsonWireFormat: false,
         useNumericEnumForJson: false,
+        initializeFieldsAsUndefined: true,
+        M: {},
     };
 }
 exports.defaultOptions = defaultOptions;
@@ -147,16 +149,36 @@ function optionsFromParameter(parameter) {
             options.useDate = DateOption.STRING;
         }
     }
+    if (options.nestJs) {
+        options.initializeFieldsAsUndefined = false;
+    }
     return options;
 }
 exports.optionsFromParameter = optionsFromParameter;
 // A very naive parse function, eventually could/should use iots/runtypes
 function parseParameter(parameter) {
     const options = {};
-    const pairs = parameter.split(",").map((s) => s.split("="));
-    pairs.forEach(([key, _value]) => {
-        const value = _value === "true" ? true : _value === "false" ? false : _value;
-        if (options[key]) {
+    parameter.split(",").forEach((param) => {
+        // same as protoc-gen-go https://github.com/protocolbuffers/protobuf-go/blob/bf9455640daabb98c93b5b5e71628f3f813d57bb/compiler/protogen/protogen.go#L168-L171
+        const optionSeparatorPos = param.indexOf("=");
+        const key = param.substring(0, optionSeparatorPos);
+        const value = parseParamValue(param.substring(optionSeparatorPos + 1));
+        if (key.charAt(0) === "M") {
+            if (typeof value !== "string") {
+                console.warn(`ignoring invalid M option: '${param}'`);
+            }
+            else {
+                const mKey = key.substring(1);
+                if (options.M[mKey]) {
+                    console.warn(`received conflicting M options: '${param}' will override 'M${mKey}=${options.M[mKey]}'`);
+                }
+                if (param.endsWith(".ts")) {
+                    console.warn(`received M option '${param}' ending in '.ts' this is usually a mistake`);
+                }
+                options.M[mKey] = value;
+            }
+        }
+        else if (options[key]) {
             options[key] = [options[key], value];
         }
         else {
@@ -165,6 +187,9 @@ function parseParameter(parameter) {
     });
     return options;
 }
+function parseParamValue(value) {
+    return value === "true" ? true : value === "false" ? false : value;
+}
 function getTsPoetOpts(_options) {
     const imports = ["protobufjs/minimal" + _options.importSuffix];
     return {

package/build/plugin.js

@@ -18,7 +18,9 @@ async function main() {
     const utils = (0, main_1.makeUtils)(options);
     const ctx = { typeMap, options, utils };
     const filesToGenerate = options.emitImportedFiles ? request.protoFile : (0, utils_1.protoFilesToGenerate)(request);
-    const files = await Promise.all(filesToGenerate.map(async (file) => {
+    const files = await Promise.all(filesToGenerate
+        .filter((file) => !options.M[file.name])
+        .map(async (file) => {
         const [path, code] = (0, main_1.generateFile)(ctx, file);
         const content = code.toString({ ...(0, options_1.getTsPoetOpts)(options), path });
         return { name: path, content };

package/build/utils.js

@@ -178,12 +178,11 @@ function impFile(options, spec) {
 }
 exports.impFile = impFile;
 function impProto(options, module, type) {
-    const importString = `${type}@./${module}${options.fileSuffix}${options.importSuffix}`;
-    if (options.onlyTypes) {
-        return (0, ts_poet_1.imp)("t:" + importString);
-    }
-    else {
-        return (0, ts_poet_1.imp)(importString);
+    const prefix = options.onlyTypes ? "t:" : "";
+    const protoFile = `${module}.proto`;
+    if (options.M[protoFile]) {
+        return (0, ts_poet_1.imp)(`${prefix}${type}@${options.M[protoFile]}`);
     }
+    return (0, ts_poet_1.imp)(`${prefix}${type}@./${module}${options.fileSuffix}${options.importSuffix}`);
 }
 exports.impProto = impProto;

package/package.json

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