ts-proto 1.96.1 → 1.98.0

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+# [1.98.0](https://github.com/stephenh/ts-proto/compare/v1.97.2...v1.98.0) (2022-01-06)
+
+
+### Features
+
+* watch for changed integration test files ([#464](https://github.com/stephenh/ts-proto/issues/464)) ([988cd7e](https://github.com/stephenh/ts-proto/commit/988cd7eb84bc3b8b72d6b4d59c38aa794c16c638))
+
+## [1.97.2](https://github.com/stephenh/ts-proto/compare/v1.97.1...v1.97.2) (2022-01-06)
+
+
+### Performance Improvements
+
+* fromJSON returns object literal to allow v8 optimizations ([#463](https://github.com/stephenh/ts-proto/issues/463)) ([5fcd05b](https://github.com/stephenh/ts-proto/commit/5fcd05b79e7c02547c4b6db46fae7a7202f97629))
+
+## [1.97.1](https://github.com/stephenh/ts-proto/compare/v1.97.0...v1.97.1) (2022-01-05)
+
+
+### Bug Fixes
+
+* oneof=union breaks wrapper types [#458](https://github.com/stephenh/ts-proto/issues/458) ([#462](https://github.com/stephenh/ts-proto/issues/462)) ([dd16992](https://github.com/stephenh/ts-proto/commit/dd16992a409f24e88e3a142830cd0745f50dbd10))
+
+# [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)
 
 

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
 
@@ -350,6 +350,10 @@ Generated code will be placed in the Gradle build directory.
 
 - 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.:
@@ -400,11 +404,13 @@ The commands below assume you have **Docker** installed. To use a **local** copy
 **Workflow**
 
 - Modifying the plugin implementation:
+  - The most important logic is found in [src/main.ts](src/main.ts).
   - Run `yarn bin2ts` or `yarn bin2ts:local`.  
     _Since the proto files were not changed, you only need to regenerate the typescript files._
   - Run `yarn test` to verify the typescript files are compatible with the reference implementation, and pass other tests.
 - Updating or adding `.proto` files in the integration directory:
-  - Run `yarn build:test` to regenerate the integration test files.
+  - Run `yarn watch` to automatically regenerate test files when proto files change. 
+    - Or run `yarn build:test` to regenerate all integration test files. 
   - Run `yarn test` to retest.
 
 **Contributing**

package/build/main.js

@@ -86,8 +86,8 @@ function generateFile(ctx, fileDesc) {
             if (options.outputPartialMethods) {
                 staticMembers.push(generateFromPartial(ctx, fullName, message));
             }
-            staticMembers.push(...generateWrap(fullTypeName));
-            staticMembers.push(...generateUnwrap(fullTypeName));
+            staticMembers.push(...generateWrap(ctx, fullTypeName));
+            staticMembers.push(...generateUnwrap(ctx, fullTypeName));
             chunks.push(ts_poet_1.code `
           export const ${ts_poet_1.def(fullName)} = {
             ${ts_poet_1.joinCode(staticMembers, { on: ',\n\n' })}
@@ -195,6 +195,7 @@ function makeUtils(options) {
         ...makeDeepPartial(options, longs),
         ...makeTimestampMethods(options, longs),
         ...longs,
+        ...makeComparisonUtils(),
     };
 }
 exports.makeUtils = makeUtils;
@@ -396,6 +397,17 @@ function makeTimestampMethods(options, longs) {
       `);
     return { toTimestamp, fromTimestamp, fromJsonTimestamp };
 }
+function makeComparisonUtils() {
+    const isObject = ts_poet_1.conditionalOutput('isObject', ts_poet_1.code `
+    function isObject(value: any): boolean {
+      return typeof value === 'object' && value !== null;
+    }`);
+    const isSet = ts_poet_1.conditionalOutput('isSet', ts_poet_1.code `
+    function isSet(value: any): boolean {
+      return value !== null && value !== undefined;
+    }`);
+    return { isObject, isSet };
+}
 // Create the interface with properties
 function generateInterfaceDeclaration(ctx, fullName, messageDesc, sourceInfo, fullTypeName) {
     var _a;
@@ -805,13 +817,17 @@ 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 = createBase${fullName}();
+      return {
   `);
+    if (ctx.options.outputTypeRegistry) {
+        chunks.push(ts_poet_1.code `$type: ${fullName}.$type,`);
+    }
+    const oneofFieldsCases = messageDesc.oneofDecl.map((oneof, oneofIndex) => messageDesc.field.filter(types_1.isWithinOneOf).filter((field) => field.oneofIndex === oneofIndex));
     // add a check for each incoming field
     messageDesc.field.forEach((field) => {
         const fieldName = case_1.maybeSnakeToCamel(field.name, options);
         const jsonName = utils_1.determineFieldJsonName(field, options);
-        // get a generic 'reader.doSomething' bit that is specific to the basic type
+        // get code that extracts value from incoming object
         const readSnippet = (from) => {
             if (types_1.isEnum(field)) {
                 const fromJson = types_1.getEnumMethod(ctx, field.typeName, 'FromJSON');
@@ -846,6 +862,9 @@ function generateFromJson(ctx, fullName, messageDesc) {
             else if (types_1.isAnyValueType(field) || types_1.isStructType(field)) {
                 return ts_poet_1.code `${from}`;
             }
+            else if (types_1.isListValueType(field)) {
+                return ts_poet_1.code `[...${from}]`;
+            }
             else if (types_1.isValueType(ctx, field)) {
                 const valueType = types_1.valueTypeName(ctx, field.typeName);
                 if (types_1.isLongValueType(field) && options.forceLong === options_1.LongOption.LONG) {
@@ -854,9 +873,6 @@ function generateFromJson(ctx, fullName, messageDesc) {
                 else if (types_1.isBytesValueType(field)) {
                     return ts_poet_1.code `new ${case_1.capitalize(valueType.toCodeString())}(${from})`;
                 }
-                else if (types_1.isListValueType(field)) {
-                    return ts_poet_1.code `[...${from}]`;
-                }
                 else {
                     return ts_poet_1.code `${case_1.capitalize(valueType.toCodeString())}(${from})`;
                 }
@@ -919,56 +935,71 @@ function generateFromJson(ctx, fullName, messageDesc) {
                 const fieldType = types_1.toTypeName(ctx, messageDesc, field);
                 const i = maybeCastToNumber(ctx, messageDesc, field, 'key');
                 chunks.push(ts_poet_1.code `
-          message.${fieldName} = Object.entries(object.${jsonName} ?? {}).reduce<${fieldType}>((acc, [key, value]) => {
-            acc[${i}] = ${readSnippet('value')};
-            return acc;
-          }, {});
-        `);
-            }
-            else if (types_1.isAnyValueType(field)) {
-                chunks.push(ts_poet_1.code `
-          message.${fieldName} = Array.isArray(object?.${jsonName}) ? [...object.${jsonName}] : [];
+          ${fieldName}: ${ctx.utils.isObject}(object.${jsonName})
+            ? Object.entries(object.${jsonName}).reduce<${fieldType}>((acc, [key, value]) => {
+                acc[${i}] = ${readSnippet('value')};
+                return acc;
+              }, {})
+            : {},
         `);
             }
             else {
-                // Explicit `any` type required to make TS with noImplicitAny happy. `object` is also `any` here.
-                chunks.push(ts_poet_1.code `
-          message.${fieldName} = (object.${jsonName} ?? []).map((e: any) => ${readSnippet('e')});
-        `);
+                const readValueSnippet = readSnippet('e');
+                if (readValueSnippet.toString() === ts_poet_1.code `e`.toString()) {
+                    chunks.push(ts_poet_1.code `${fieldName}: Array.isArray(object?.${jsonName}) ? [...object.${jsonName}] : [],`);
+                }
+                else {
+                    // Explicit `any` type required to make TS with noImplicitAny happy. `object` is also `any` here.
+                    chunks.push(ts_poet_1.code `
+            ${fieldName}: Array.isArray(object?.${jsonName}) ? object.${jsonName}.map((e: any) => ${readValueSnippet}): [],
+          `);
+                }
             }
         }
         else if (types_1.isWithinOneOfThatShouldBeUnion(options, field)) {
-            chunks.push(ts_poet_1.code `if (object.${jsonName} !== undefined && object.${jsonName} !== null) {`);
-            const oneofName = case_1.maybeSnakeToCamel(messageDesc.oneofDecl[field.oneofIndex].name, options);
-            chunks.push(ts_poet_1.code `
-        message.${oneofName} = { $case: '${fieldName}', ${fieldName}: ${readSnippet(`object.${jsonName}`)} }
-      `);
-            chunks.push(ts_poet_1.code `}`);
+            const cases = oneofFieldsCases[field.oneofIndex];
+            const firstCase = cases[0];
+            const lastCase = cases[cases.length - 1];
+            if (field === firstCase) {
+                const fieldName = case_1.maybeSnakeToCamel(messageDesc.oneofDecl[field.oneofIndex].name, options);
+                chunks.push(ts_poet_1.code `${fieldName}: `);
+            }
+            const ternaryIf = ts_poet_1.code `${ctx.utils.isSet}(object.${jsonName})`;
+            const ternaryThen = ts_poet_1.code `{ $case: '${fieldName}', ${fieldName}: ${readSnippet(`object.${jsonName}`)}`;
+            chunks.push(ts_poet_1.code `${ternaryIf} ? ${ternaryThen}} : `);
+            if (field === lastCase) {
+                chunks.push(ts_poet_1.code `undefined,`);
+            }
         }
         else if (types_1.isAnyValueType(field)) {
-            chunks.push(ts_poet_1.code `message.${fieldName} = object.${fieldName};`);
+            chunks.push(ts_poet_1.code `${fieldName}: ${ctx.utils.isSet}(object?.${jsonName})
+        ? ${readSnippet(`object.${jsonName}`)}
+        : undefined,
+      `);
         }
         else if (types_1.isStructType(field)) {
-            chunks.push(ts_poet_1.code `message.${fieldName} = typeof(object.${fieldName}) === 'object' ? object.${fieldName} : undefined;`);
+            chunks.push(ts_poet_1.code `${fieldName}: ${ctx.utils.isObject}(object.${jsonName})
+          ? ${readSnippet(`object.${jsonName}`)}
+          : undefined,`);
         }
         else if (types_1.isListValueType(field)) {
             chunks.push(ts_poet_1.code `
-        message.${fieldName} = Array.isArray(object?.${fieldName})
-          ? ${readSnippet(`object.${fieldName}`)}
-          : ${'undefined'};
+        ${fieldName}: Array.isArray(object.${jsonName})
+          ? ${readSnippet(`object.${jsonName}`)}
+          : undefined,
       `);
         }
         else {
             const fallback = types_1.isWithinOneOf(field) ? 'undefined' : types_1.defaultValue(ctx, field);
             chunks.push(ts_poet_1.code `
-        message.${fieldName} = (object.${jsonName} !== undefined && object.${jsonName} !== null)
+        ${fieldName}: ${ctx.utils.isSet}(object.${jsonName})
           ? ${readSnippet(`object.${jsonName}`)}
-          : ${fallback};
+          : ${fallback},
       `);
         }
     });
     // and then wrap up the switch/while/return
-    chunks.push(ts_poet_1.code `return message`);
+    chunks.push(ts_poet_1.code `};`);
     chunks.push(ts_poet_1.code `}`);
     return ts_poet_1.joinCode(chunks, { on: '\n' });
 }
@@ -1101,13 +1132,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 = createBase${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);
@@ -1217,7 +1254,7 @@ function generateFromPartial(ctx, fullName, messageDesc) {
     chunks.push(ts_poet_1.code `}`);
     return ts_poet_1.joinCode(chunks, { on: '\n' });
 }
-function generateWrap(fullProtoTypeName) {
+function generateWrap(ctx, fullProtoTypeName) {
     const chunks = [];
     if (types_1.isStructTypeName(fullProtoTypeName)) {
         chunks.push(ts_poet_1.code `wrap(object: {[key: string]: any} | undefined): Struct {
@@ -1231,7 +1268,29 @@ function generateWrap(fullProtoTypeName) {
     }`);
     }
     if (types_1.isAnyValueTypeName(fullProtoTypeName)) {
-        chunks.push(ts_poet_1.code `wrap(value: any): Value {
+        if (ctx.options.oneof === options_1.OneofOption.UNIONS) {
+            chunks.push(ts_poet_1.code `wrap(value: any): Value {
+      if (value === null) {
+        return {kind: {$case: 'nullValue', nullValue: NullValue.NULL_VALUE}};
+      } else if (typeof value === 'boolean') {
+        return {kind: {$case: 'boolValue', boolValue: value}};
+      } else if (typeof value === 'number') {
+        return {kind: {$case: 'numberValue', numberValue: value}};
+      } else if (typeof value === 'string') {
+        return {kind: {$case: 'stringValue', stringValue: value}};
+      } else if (Array.isArray(value)) {
+        return {kind: {$case: 'listValue', listValue: value}};
+      } else if (typeof value === 'object') {
+        return {kind: {$case: 'structValue', structValue: value}};
+      } else if (typeof value === 'undefined') {
+        return {} as Value;
+      } else {
+        throw new Error('Unsupported any value type: ' + typeof value);
+      }
+    }`);
+        }
+        else {
+            chunks.push(ts_poet_1.code `wrap(value: any): Value {
       if (value === null) {
         return {nullValue: NullValue.NULL_VALUE} as Value;
       } else if (typeof value === 'boolean') {
@@ -1250,15 +1309,16 @@ function generateWrap(fullProtoTypeName) {
         throw new Error('Unsupported any value type: ' + typeof value);
       }
     }`);
+        }
     }
     if (types_1.isListValueTypeName(fullProtoTypeName)) {
-        chunks.push(ts_poet_1.code `wrap(value: Array<any>): ListValue {
-      return {values: value};
+        chunks.push(ts_poet_1.code `wrap(value: Array<any> | undefined): ListValue {
+      return {values: value ?? []};
     }`);
     }
     return chunks;
 }
-function generateUnwrap(fullProtoTypeName) {
+function generateUnwrap(ctx, fullProtoTypeName) {
     const chunks = [];
     if (types_1.isStructTypeName(fullProtoTypeName)) {
         chunks.push(ts_poet_1.code `unwrap(message: Struct): {[key: string]: any} {
@@ -1270,7 +1330,27 @@ function generateUnwrap(fullProtoTypeName) {
     }`);
     }
     if (types_1.isAnyValueTypeName(fullProtoTypeName)) {
-        chunks.push(ts_poet_1.code `unwrap(message: Value): string | number | boolean | Object | null | Array<any> | undefined {
+        if (ctx.options.oneof === options_1.OneofOption.UNIONS) {
+            chunks.push(ts_poet_1.code `unwrap(message: Value): string | number | boolean | Object | null | Array<any> | undefined {
+        if (message.kind?.$case === 'nullValue') {
+          return null;
+        } else if (message.kind?.$case === 'numberValue') {
+          return message.kind?.numberValue;
+        } else if (message.kind?.$case === 'stringValue') {
+          return message.kind?.stringValue;
+        } else if (message.kind?.$case === 'boolValue') {
+          return message.kind?.boolValue;
+        } else if (message.kind?.$case === 'structValue') {
+          return message.kind?.structValue;
+        } else if (message.kind?.$case === 'listValue') {
+          return message.kind?.listValue;
+        } else {
+          return undefined;
+        }
+    }`);
+        }
+        else {
+            chunks.push(ts_poet_1.code `unwrap(message: Value): string | number | boolean | Object | null | Array<any> | undefined {
       if (message?.stringValue !== undefined) {
         return message.stringValue;
       } else if (message?.numberValue !== undefined) {
@@ -1286,6 +1366,7 @@ function generateUnwrap(fullProtoTypeName) {
       }
       return undefined;
     }`);
+        }
     }
     if (types_1.isListValueTypeName(fullProtoTypeName)) {
         chunks.push(ts_poet_1.code `unwrap(message: ListValue): Array<any> {

package/build/options.js

@@ -61,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.96.1",
+  "version": "1.98.0",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",
@@ -21,7 +21,8 @@
     "test": "yarn jest -c jest.config.js --maxWorkers=2",
     "prettier": "prettier --write {src,tests}/**/*.ts",
     "prettier:check": "prettier --list-different {src,tests}/**/*.ts",
-    "setup:docker": "docker-compose build"
+    "setup:docker": "docker-compose build",
+    "watch": "ts-node integration/watch.ts"
   },
   "files": [
     "build"
@@ -45,6 +46,7 @@
     "@semantic-release/release-notes-generator": "^9.0.2",
     "@types/jest": "^26.0.22",
     "@types/node": "^14.14.37",
+    "chokidar": "^3.5.2",
     "jest": "^26.6.3",
     "prettier": "^2.2.1",
     "reflect-metadata": "^0.1.13",