ts-proto 1.95.0 → 1.97.0

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+# [1.97.0](https://github.com/stephenh/ts-proto/compare/v1.96.1...v1.97.0) (2021-12-30)
+
+
+### Features
+
+* add an option to disable Exact types ([#456](https://github.com/stephenh/ts-proto/issues/456)) ([9c53d7e](https://github.com/stephenh/ts-proto/commit/9c53d7efb0252c7ea0af85a5d161ff94bcd69760))
+
+## [1.96.1](https://github.com/stephenh/ts-proto/compare/v1.96.0...v1.96.1) (2021-12-28)
+
+
+### Performance Improvements
+
+* optimize object creation in `decode`, `fromJSON` and `fromPartial` ([#457](https://github.com/stephenh/ts-proto/issues/457)) ([70832d3](https://github.com/stephenh/ts-proto/commit/70832d33bae82ecb3c5f87845d14e992a13437e4))
+
+# [1.96.0](https://github.com/stephenh/ts-proto/compare/v1.95.1...v1.96.0) (2021-12-24)
+
+
+### Features
+
+* `enumsAsLiterals` option ([#450](https://github.com/stephenh/ts-proto/issues/450)) ([fcaade2](https://github.com/stephenh/ts-proto/commit/fcaade2855ae28ea3553a365556ccb92a9644d70))
+
+## [1.95.1](https://github.com/stephenh/ts-proto/compare/v1.95.0...v1.95.1) (2021-12-23)
+
+
+### Bug Fixes
+
+* Add service to the client constructor. ([#455](https://github.com/stephenh/ts-proto/issues/455)) ([8c32104](https://github.com/stephenh/ts-proto/commit/8c32104a8522cfe2febcf2338d51710021d837ff))
+
 # [1.95.0](https://github.com/stephenh/ts-proto/compare/v1.94.0...v1.95.0) (2021-12-14)
 
 

package/README.markdown

@@ -5,7 +5,7 @@
 
 > `ts-proto` transforms your `.proto` files into strongly-typed, idiomatic TypeScript files!
 
-(Note, if you're a new user of ts-proto and using a modern TS setup with `esModuleInterop`, you need to also pass that as a `ts_proto_opt`.)
+(Note, if you're a new user of ts-proto and using a modern TS setup with `esModuleInterop`, or want to use ts-proto in ESM / snowpack / vite, you need to also pass that as a `ts_proto_opt`.)
 
 ## Table of contents
 
@@ -159,7 +159,7 @@ creating a class and calling the right getters/setters.
 
   (Configurable with the `useDate` parameter.)
 
-- `fromJSON`/`toJSON` support the [canonical Protobuf JS](https://developers.google.com/protocol-buffers/docs/proto3#json) format (i.e. timestamps are ISO strings)
+- `fromJSON`/`toJSON` use the [proto3 canonical JSON encoding format](https://developers.google.com/protocol-buffers/docs/proto3#json) (e.g. timestamps are ISO strings), unlike [`protobufjs`](https://github.com/protobufjs/protobuf.js/issues/1304). 
 
 # Auto-Batching / N+1 Prevention
 
@@ -348,6 +348,12 @@ 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=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.
+  
+  The default behavior is `useExactTypes=true`, which makes `fromPartial` use Exact type for its argument to make TypeScript reject any unknown properties.
+
 ### Only Types
 
 If you're looking for `ts-proto` to generate only types for your Protobuf types then passing all three of `outputEncodeMethods`, `outputJsonMethods`, and `outputClientImpl` as `false` is probably what you want, i.e.:

package/build/enums.js

@@ -13,17 +13,30 @@ function generateEnum(ctx, fullName, enumDesc, sourceInfo) {
     const { options } = ctx;
     const chunks = [];
     utils_1.maybeAddComment(sourceInfo, chunks, (_a = enumDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
-    chunks.push(ts_poet_1.code `export ${options.constEnums ? 'const ' : ''}enum ${ts_poet_1.def(fullName)} {`);
+    if (options.enumsAsLiterals) {
+        chunks.push(ts_poet_1.code `export const ${ts_poet_1.def(fullName)} = {`);
+    }
+    else {
+        chunks.push(ts_poet_1.code `export ${options.constEnums ? 'const ' : ''}enum ${ts_poet_1.def(fullName)} {`);
+    }
+    const delimiter = options.enumsAsLiterals ? ':' : '=';
     enumDesc.value.forEach((valueDesc, index) => {
         var _a;
         const info = sourceInfo.lookup(sourceInfo_1.Fields.enum.value, index);
         utils_1.maybeAddComment(info, chunks, (_a = valueDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated, `${valueDesc.name} - `);
-        chunks.push(ts_poet_1.code `${valueDesc.name} = ${options.stringEnums ? `"${valueDesc.name}"` : valueDesc.number.toString()},`);
+        chunks.push(ts_poet_1.code `${valueDesc.name} ${delimiter} ${options.stringEnums ? `"${valueDesc.name}"` : valueDesc.number.toString()},`);
     });
     if (options.unrecognizedEnum)
         chunks.push(ts_poet_1.code `
-      ${UNRECOGNIZED_ENUM_NAME} = ${options.stringEnums ? `"${UNRECOGNIZED_ENUM_NAME}"` : UNRECOGNIZED_ENUM_VALUE.toString()},`);
-    chunks.push(ts_poet_1.code `}`);
+      ${UNRECOGNIZED_ENUM_NAME} ${delimiter} ${options.stringEnums ? `"${UNRECOGNIZED_ENUM_NAME}"` : UNRECOGNIZED_ENUM_VALUE.toString()},`);
+    if (options.enumsAsLiterals) {
+        chunks.push(ts_poet_1.code `} as const`);
+        chunks.push(ts_poet_1.code `\n`);
+        chunks.push(ts_poet_1.code `export type ${ts_poet_1.def(fullName)} = typeof ${ts_poet_1.def(fullName)}[keyof typeof ${ts_poet_1.def(fullName)}]`);
+    }
+    else {
+        chunks.push(ts_poet_1.code `}`);
+    }
     if (options.outputJsonMethods || (options.stringEnums && options.outputEncodeMethods)) {
         chunks.push(ts_poet_1.code `\n`);
         chunks.push(generateEnumFromJson(ctx, fullName, enumDesc));

package/build/generate-grpc-js.js

@@ -192,6 +192,7 @@ function generateClientConstructor(fileDesc, serviceDesc) {
         credentials: ${ChannelCredentials},
         options?: Partial<${ChannelOptions}>,
       ): ${serviceDesc.name}Client;
+      service: typeof ${serviceDesc.name}Service;
     }
   `;
 }

package/build/main.js

@@ -70,7 +70,7 @@ function generateFile(ctx, fileDesc) {
         // then add the encoder/decoder/base instance
         visit_1.visit(fileDesc, sourceInfo, (fullName, message, sInfo, fullProtoTypeName) => {
             const fullTypeName = utils_1.maybePrefixPackage(fileDesc, fullProtoTypeName);
-            chunks.push(generateBaseInstance(ctx, fullName, message, fullTypeName));
+            chunks.push(generateBaseInstanceFactory(ctx, fullName, message, fullTypeName));
             const staticMembers = [];
             if (options.outputTypeRegistry) {
                 staticMembers.push(ts_poet_1.code `$type: '${fullTypeName}' as const`);
@@ -460,20 +460,39 @@ function generateOneofProperty(ctx, messageDesc, oneofIndex, sourceInfo) {
     return prop;
     */
 }
-// Create a 'base' instance with default values for decode to use as a prototype
-function generateBaseInstance(ctx, fullName, messageDesc, fullTypeName) {
-    const fields = messageDesc.field
-        .filter((field) => !types_1.isWithinOneOf(field))
-        .map((field) => [field, types_1.defaultValue(ctx, field)])
-        .filter(([field, val]) => val !== 'undefined' && !types_1.isBytes(field))
-        .map(([field, val]) => {
+// Create a function that constructs 'base' instance with default values for decode to use as a prototype
+function generateBaseInstanceFactory(ctx, fullName, messageDesc, fullTypeName) {
+    const fields = [];
+    // When oneof=unions, we generate a single property with an ADT per `oneof` clause.
+    const processedOneofs = new Set();
+    for (const field of messageDesc.field) {
+        if (types_1.isWithinOneOfThatShouldBeUnion(ctx.options, field)) {
+            const { oneofIndex } = field;
+            if (!processedOneofs.has(oneofIndex)) {
+                processedOneofs.add(oneofIndex);
+                const name = case_1.maybeSnakeToCamel(messageDesc.oneofDecl[oneofIndex].name, ctx.options);
+                fields.push(ts_poet_1.code `${name}: undefined`);
+            }
+            continue;
+        }
         const name = case_1.maybeSnakeToCamel(field.name, ctx.options);
-        return ts_poet_1.code `${name}: ${val}`;
-    });
+        const val = types_1.isWithinOneOf(field)
+            ? 'undefined'
+            : types_1.isMapType(ctx, messageDesc, field)
+                ? '{}'
+                : types_1.isRepeated(field)
+                    ? '[]'
+                    : types_1.defaultValue(ctx, field);
+        fields.push(ts_poet_1.code `${name}: ${val}`);
+    }
     if (ctx.options.outputTypeRegistry) {
         fields.unshift(ts_poet_1.code `$type: '${fullTypeName}'`);
     }
-    return ts_poet_1.code `const base${fullName}: object = { ${ts_poet_1.joinCode(fields, { on: ',' })} };`;
+    return ts_poet_1.code `
+    function createBase${fullName}(): ${fullName} {
+      return { ${ts_poet_1.joinCode(fields, { on: ',' })} };
+    }
+  `;
 }
 /** Creates a function to decode a message by loop overing the tags. */
 function generateDecode(ctx, fullName, messageDesc) {
@@ -487,22 +506,8 @@ function generateDecode(ctx, fullName, messageDesc) {
     ): ${fullName} {
       const reader = input instanceof ${Reader} ? input : new ${Reader}(input);
       let end = length === undefined ? reader.len : reader.pos + length;
-      const message = { ...base${fullName} } as ${fullName};
+      const message = createBase${fullName}();
   `);
-    // initialize all lists
-    messageDesc.field.filter(types_1.isRepeated).forEach((field) => {
-        const name = case_1.maybeSnakeToCamel(field.name, options);
-        const value = types_1.isMapType(ctx, messageDesc, field) ? '{}' : '[]';
-        chunks.push(ts_poet_1.code `message.${name} = ${value};`);
-    });
-    // initialize all buffers
-    messageDesc.field
-        .filter((field) => !types_1.isRepeated(field) && !types_1.isWithinOneOf(field) && types_1.isBytes(field))
-        .forEach((field) => {
-        const value = options.env === options_1.EnvOption.NODE ? 'Buffer.alloc(0)' : 'new Uint8Array()';
-        const name = case_1.maybeSnakeToCamel(field.name, options);
-        chunks.push(ts_poet_1.code `message.${name} = ${value};`);
-    });
     // start the tag loop
     chunks.push(ts_poet_1.code `
     while (reader.pos < end) {
@@ -567,28 +572,29 @@ function generateDecode(ctx, fullName, messageDesc) {
         }
         // and then use the snippet to handle repeated fields if necessary
         if (types_1.isRepeated(field)) {
+            const maybeNonNullAssertion = ctx.options.useOptionals === 'all' ? '!' : '';
             if (types_1.isMapType(ctx, messageDesc, field)) {
                 // We need a unique const within the `cast` statement
                 const varName = `entry${field.number}`;
                 chunks.push(ts_poet_1.code `
           const ${varName} = ${readSnippet};
           if (${varName}.value !== undefined) {
-            message.${fieldName}[${varName}.key] = ${varName}.value;
+            message.${fieldName}${maybeNonNullAssertion}[${varName}.key] = ${varName}.value;
           }
         `);
             }
             else if (types_1.packedType(field.type) === undefined) {
-                chunks.push(ts_poet_1.code `message.${fieldName}.push(${readSnippet});`);
+                chunks.push(ts_poet_1.code `message.${fieldName}${maybeNonNullAssertion}.push(${readSnippet});`);
             }
             else {
                 chunks.push(ts_poet_1.code `
           if ((tag & 7) === 2) {
             const end2 = reader.uint32() + reader.pos;
             while (reader.pos < end2) {
-              message.${fieldName}.push(${readSnippet});
+              message.${fieldName}${maybeNonNullAssertion}.push(${readSnippet});
             }
           } else {
-            message.${fieldName}.push(${readSnippet});
+            message.${fieldName}${maybeNonNullAssertion}.push(${readSnippet});
           }
         `);
             }
@@ -799,7 +805,7 @@ function generateFromJson(ctx, fullName, messageDesc) {
     // create the basic function declaration
     chunks.push(ts_poet_1.code `
     fromJSON(${messageDesc.field.length > 0 ? 'object' : '_'}: any): ${fullName} {
-      const message = { ...base${fullName} } as ${fullName};
+      const message = createBase${fullName}();
   `);
     // add a check for each incoming field
     messageDesc.field.forEach((field) => {
@@ -1095,13 +1101,19 @@ function generateToJson(ctx, fullName, messageDesc) {
 function generateFromPartial(ctx, fullName, messageDesc) {
     const { options, utils, typeMap } = ctx;
     const chunks = [];
-    const Timestamp = utils_1.impProto(options, 'google/protobuf/timestamp', 'Timestamp');
     // create the basic function declaration
     const paramName = messageDesc.field.length > 0 ? 'object' : '_';
-    chunks.push(ts_poet_1.code `
-    fromPartial<I extends ${utils.Exact}<${utils.DeepPartial}<${fullName}>, I>>(${paramName}: I): ${fullName} {
-      const message = { ...base${fullName} } as ${fullName};
-  `);
+    if (ctx.options.useExactTypes) {
+        chunks.push(ts_poet_1.code `
+      fromPartial<I extends ${utils.Exact}<${utils.DeepPartial}<${fullName}>, I>>(${paramName}: I): ${fullName} {
+    `);
+    }
+    else {
+        chunks.push(ts_poet_1.code `
+      fromPartial(${paramName}: ${utils.DeepPartial}<${fullName}>): ${fullName} {
+    `);
+    }
+    chunks.push(ts_poet_1.code `const message = createBase${fullName}();`);
     // add a check for each incoming field
     messageDesc.field.forEach((field) => {
         const fieldName = case_1.maybeSnakeToCamel(field.name, options);

package/build/options.js

@@ -48,6 +48,7 @@ function defaultOptions() {
         outputTypeRegistry: false,
         stringEnums: false,
         constEnums: false,
+        enumsAsLiterals: false,
         outputClientImpl: true,
         outputServices: ServiceOption.DEFAULT,
         returnObservable: false,
@@ -60,6 +61,7 @@ function defaultOptions() {
         outputSchema: false,
         onlyTypes: false,
         emitImportedFiles: true,
+        useExactTypes: true,
     };
 }
 exports.defaultOptions = defaultOptions;

package/package.json

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