ts-proto 1.99.0 → 1.100.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.100.0](https://github.com/stephenh/ts-proto/compare/v1.99.0...v1.100.0) (2022-01-09)
+
+
+### Features
+
+* support mapping ObjectId message as mongodb.ObjectId ([#467](https://github.com/stephenh/ts-proto/issues/467)) ([8b23897](https://github.com/stephenh/ts-proto/commit/8b2389715ecfd5d51b1b24f5a9332e4ff9f09a27))
+
 # [1.99.0](https://github.com/stephenh/ts-proto/compare/v1.98.0...v1.99.0) (2022-01-07)
 
 

package/README.markdown

@@ -175,6 +175,10 @@ creating a class and calling the right getters/setters.
 
 - `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). 
 
+- ObjectIds can be mapped as `mongodb.ObjectId`
+
+  (Configurable with the `useObjectId` parameter.)
+
 # Auto-Batching / N+1 Prevention
 
 (Note: this is currently only supported by the Twirp clients.)
@@ -347,6 +351,8 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=useDate=false`, fields of type `google.protobuf.Timestamp` will not be mapped to type `Date` in the generated types. See [Timestamp](#timestamp) for more details.
 
+- With `--ts_proto_opt=useObjectId=true`, fields of a type called ObjectId where the message is constructed to have on field called value that is a string will be mapped to type `mongodb.ObjectId` in the generated types. This will require your project to install the mongodb npm package. See [ObjectId](#objectid) for more details.
+
 - With `--ts_proto_opt=outputSchema=true`, meta typings will be generated that can later be used in other code generators.
 
 - With `--ts_proto_opt=outputTypeRegistry=true`, the type registry will be generated that can be used to resolve message types by fully-qualified name. Also, each message will get extra `$type` field containing fully-qualified name.
@@ -685,7 +691,6 @@ The representation of `google.protobuf.Timestamp` is configurable by the `useDat
 | --------------------------- | ---------------------- | ------------------------------------ | ---------------- |
 | `google.protobuf.Timestamp` | `Date`                 | `{ seconds: number, nanos: number }` | `string`         |
 
-
 # Number Types
 
 Numbers are by default assumed to be plain JavaScript `number`s.

package/build/main.js

@@ -193,6 +193,7 @@ function makeUtils(options) {
     return {
         ...bytes,
         ...makeDeepPartial(options, longs),
+        ...makeObjectIdMethods(options),
         ...makeTimestampMethods(options, longs),
         ...longs,
         ...makeComparisonUtils(),
@@ -325,6 +326,32 @@ function makeDeepPartial(options, longs) {
     `);
     return { Builtin, DeepPartial, Exact };
 }
+function makeObjectIdMethods(options) {
+    const mongodb = ts_poet_1.imp('mongodb*mongodb');
+    const fromProtoObjectId = ts_poet_1.conditionalOutput('fromProtoObjectId', ts_poet_1.code `
+      function fromProtoObjectId(oid: ObjectId): ${mongodb}.ObjectId {
+        return new ${mongodb}.ObjectId(oid.value);
+      }
+    `);
+    const fromJsonObjectId = ts_poet_1.conditionalOutput('fromJsonObjectId', ts_poet_1.code `
+      function fromJsonObjectId(o: any): ${mongodb}.ObjectId {
+        if (o instanceof ${mongodb}.ObjectId) {
+          return o;
+        } else if (typeof o === "string") {
+          return new ${mongodb}.ObjectId(o);
+        } else {
+          return ${fromProtoObjectId}(ObjectId.fromJSON(o));
+        }
+      }
+    `);
+    const toProtoObjectId = ts_poet_1.conditionalOutput('toProtoObjectId', ts_poet_1.code `
+      function toProtoObjectId(oid: ${mongodb}.ObjectId): ObjectId {
+        const value = oid.toString();
+        return { value };
+      }
+    `);
+    return { fromJsonObjectId, fromProtoObjectId, toProtoObjectId };
+}
 function makeTimestampMethods(options, longs) {
     const Timestamp = utils_1.impProto(options, 'google/protobuf/timestamp', 'Timestamp');
     let seconds = 'date.getTime() / 1_000';
@@ -575,6 +602,10 @@ function generateDecode(ctx, fullName, messageDesc) {
             const type = types_1.basicTypeName(ctx, field, { keepValueType: true });
             readSnippet = ts_poet_1.code `${utils.fromTimestamp}(${type}.decode(reader, reader.uint32()))`;
         }
+        else if (types_1.isObjectId(field) && options.useMongoObjectId) {
+            const type = types_1.basicTypeName(ctx, field, { keepValueType: true });
+            readSnippet = ts_poet_1.code `${utils.fromProtoObjectId}(${type}.decode(reader, reader.uint32()))`;
+        }
         else if (types_1.isMessage(field)) {
             const type = types_1.basicTypeName(ctx, field);
             readSnippet = ts_poet_1.code `${type}.decode(reader, reader.uint32())`;
@@ -659,6 +690,11 @@ function generateEncode(ctx, fullName, messageDesc) {
             const tag = ((field.number << 3) | types_1.basicWireType(field.type)) >>> 0;
             writeSnippet = (place) => ts_poet_1.code `writer.uint32(${tag}).${types_1.toReaderCall(field)}(${place})`;
         }
+        else if (types_1.isObjectId(field) && options.useMongoObjectId) {
+            const tag = ((field.number << 3) | 2) >>> 0;
+            const type = types_1.basicTypeName(ctx, field, { keepValueType: true });
+            writeSnippet = (place) => ts_poet_1.code `${type}.encode(${utils.toProtoObjectId}(${place}), writer.uint32(${tag}).fork()).ldelim()`;
+        }
         else if (types_1.isTimestamp(field) && (options.useDate === options_1.DateOption.DATE || options.useDate === options_1.DateOption.STRING)) {
             const tag = ((field.number << 3) | 2) >>> 0;
             const type = types_1.basicTypeName(ctx, field, { keepValueType: true });
@@ -852,6 +888,9 @@ function generateFromJson(ctx, fullName, messageDesc) {
                     return ts_poet_1.code `${cstr}(${from})`;
                 }
             }
+            else if (types_1.isObjectId(field) && options.useMongoObjectId) {
+                return ts_poet_1.code `${utils.fromJsonObjectId}(${from})`;
+            }
             else if (types_1.isTimestamp(field) && options.useDate === options_1.DateOption.STRING) {
                 return ts_poet_1.code `String(${from})`;
             }
@@ -901,6 +940,9 @@ function generateFromJson(ctx, fullName, messageDesc) {
                             return ts_poet_1.code `${cstr}(${from})`;
                         }
                     }
+                    else if (types_1.isObjectId(valueType) && options.useMongoObjectId) {
+                        return ts_poet_1.code `${utils.fromJsonObjectId}(${from})`;
+                    }
                     else if (types_1.isTimestamp(valueType) && options.useDate === options_1.DateOption.STRING) {
                         return ts_poet_1.code `String(${from})`;
                     }
@@ -1022,6 +1064,9 @@ function generateToJson(ctx, fullName, messageDesc) {
                     ? ts_poet_1.code `${from} !== undefined ? ${toJson}(${from}) : undefined`
                     : ts_poet_1.code `${toJson}(${from})`;
             }
+            else if (types_1.isObjectId(field) && options.useMongoObjectId) {
+                return ts_poet_1.code `${from}.toString()`;
+            }
             else if (types_1.isTimestamp(field) && options.useDate === options_1.DateOption.DATE) {
                 return ts_poet_1.code `${from}.toISOString()`;
             }
@@ -1041,6 +1086,9 @@ function generateToJson(ctx, fullName, messageDesc) {
                 else if (types_1.isBytes(valueType)) {
                     return ts_poet_1.code `${utils.base64FromBytes}(${from})`;
                 }
+                else if (types_1.isObjectId(valueType) && options.useMongoObjectId) {
+                    return ts_poet_1.code `${from}.toString()`;
+                }
                 else if (types_1.isTimestamp(valueType) && options.useDate === options_1.DateOption.DATE) {
                     return ts_poet_1.code `${from}.toISOString()`;
                 }
@@ -1152,6 +1200,9 @@ function generateFromPartial(ctx, fullName, messageDesc) {
             if ((types_1.isLong(field) || types_1.isLongValueType(field)) && options.forceLong === options_1.LongOption.LONG) {
                 return ts_poet_1.code `Long.fromValue(${from})`;
             }
+            else if (types_1.isObjectId(field) && options.useMongoObjectId) {
+                return ts_poet_1.code `${from} as mongodb.ObjectId`;
+            }
             else if (types_1.isPrimitive(field) ||
                 (types_1.isTimestamp(field) && (options.useDate === options_1.DateOption.DATE || options.useDate === options_1.DateOption.STRING)) ||
                 types_1.isValueType(ctx, field)) {
@@ -1178,6 +1229,9 @@ function generateFromPartial(ctx, fullName, messageDesc) {
                     else if (types_1.isAnyValueType(valueType)) {
                         return ts_poet_1.code `${from}`;
                     }
+                    else if (types_1.isObjectId(valueType) && options.useMongoObjectId) {
+                        return ts_poet_1.code `${from} as mongodb.ObjectId`;
+                    }
                     else if (types_1.isTimestamp(valueType) &&
                         (options.useDate === options_1.DateOption.DATE || options.useDate === options_1.DateOption.STRING)) {
                         return ts_poet_1.code `${from}`;

package/build/options.js

@@ -38,6 +38,7 @@ function defaultOptions() {
         forceLong: LongOption.NUMBER,
         useOptionals: 'none',
         useDate: DateOption.DATE,
+        useMongoObjectId: false,
         oneof: OneofOption.PROPERTIES,
         esModuleInterop: false,
         fileSuffix: '',

package/build/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.detectBatchMethod = exports.responsePromiseOrObservable = exports.responseObservable = exports.responsePromise = exports.responseType = exports.requestType = exports.rawRequestType = exports.detectMapType = exports.toTypeName = exports.getEnumMethod = exports.messageToTypeName = exports.wrapperTypeName = exports.valueTypeName = exports.isEmptyType = exports.isLongValueType = exports.isStructTypeName = exports.isStructType = exports.isListValueTypeName = exports.isListValueType = exports.isBytesValueType = exports.isAnyValueTypeName = exports.isAnyValueType = exports.isValueType = exports.isTimestamp = exports.isMapType = exports.isWholeNumber = exports.isLong = exports.isRepeated = exports.isWithinOneOfThatShouldBeUnion = exports.isWithinOneOf = exports.isEnum = exports.isMessage = exports.isBytes = exports.isPrimitive = exports.isOptionalProperty = exports.isScalar = exports.createTypeMap = exports.notDefaultCheck = exports.defaultValue = exports.packedType = exports.toReaderCall = exports.basicTypeName = exports.basicLongWireType = exports.basicWireType = void 0;
+exports.detectBatchMethod = exports.responsePromiseOrObservable = exports.responseObservable = exports.responsePromise = exports.responseType = exports.requestType = exports.rawRequestType = exports.detectMapType = exports.toTypeName = exports.getEnumMethod = exports.messageToTypeName = exports.wrapperTypeName = exports.valueTypeName = exports.isEmptyType = exports.isLongValueType = exports.isStructTypeName = exports.isStructType = exports.isListValueTypeName = exports.isListValueType = exports.isBytesValueType = exports.isAnyValueTypeName = exports.isAnyValueType = exports.isValueType = exports.isTimestamp = exports.isObjectId = exports.isMapType = exports.isWholeNumber = exports.isLong = exports.isRepeated = exports.isWithinOneOfThatShouldBeUnion = exports.isWithinOneOf = exports.isEnum = exports.isMessage = exports.isBytes = exports.isPrimitive = exports.isOptionalProperty = exports.isScalar = exports.createTypeMap = exports.notDefaultCheck = exports.defaultValue = exports.packedType = exports.toReaderCall = exports.basicTypeName = exports.basicLongWireType = exports.basicWireType = void 0;
 const ts_proto_descriptors_1 = require("ts-proto-descriptors");
 const ts_poet_1 = require("ts-poet");
 const options_1 = require("./options");
@@ -378,6 +378,11 @@ function isMapType(ctx, messageDesc, field) {
     return detectMapType(ctx, messageDesc, field) !== undefined;
 }
 exports.isMapType = isMapType;
+function isObjectId(field) {
+    // need to use endsWith instead of === because objectid could be imported from an external proto file
+    return field.typeName.endsWith('.ObjectId');
+}
+exports.isObjectId = isObjectId;
 function isTimestamp(field) {
     return field.typeName === '.google.protobuf.Timestamp';
 }
@@ -510,6 +515,10 @@ function messageToTypeName(ctx, protoType, typeOptions = {}) {
             return ts_poet_1.code `string`;
         }
     }
+    // need to use endsWith instead of === because objectid could be imported from an external proto file
+    if (!typeOptions.keepValueType && options.useMongoObjectId && protoType.endsWith('.ObjectId')) {
+        return ts_poet_1.code `mongodb.ObjectId`;
+    }
     const [module, type] = toModuleAndType(typeMap, protoType);
     return ts_poet_1.code `${utils_1.impProto(options, module, type)}`;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "1.99.0",
+  "version": "1.100.0",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",
@@ -48,6 +48,7 @@
     "@types/node": "^14.14.37",
     "chokidar": "^3.5.2",
     "jest": "^26.6.3",
+    "mongodb": "^4.3.0",
     "prettier": "^2.2.1",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.4.0",