ts-proto 1.172.0 → 1.173.0

package/README.markdown

@@ -796,6 +796,14 @@ type OneOfCase<T, K extends OneOfCases<T>> = T extends {
 }
   ? T[U]
   : never;
+
+/** Extracts the specific type of a value type from a oneOf field */
+export type OneOfValue<T, K extends OneOfCases<T>> = T extends {
+  $case: K;
+  [key: string]: unknown;
+}
+  ? T
+  : never;
 ```
 
 # Default values and unset fields

package/build/main.js

@@ -794,7 +794,17 @@ function getDecodeReadSnippet(ctx, field) {
             }
         }
         else if ((0, types_1.basicLongWireType)(field.type) !== undefined) {
-            if (options.forceLong === options_1.LongOption.LONG) {
+            if ((0, types_1.isJsTypeFieldOption)(options, field)) {
+                switch (field.options.jstype) {
+                    case ts_proto_descriptors_1.FieldOptions_JSType.JS_NUMBER:
+                        readSnippet = (0, ts_poet_1.code) `${utils.longToNumber}(${readSnippet} as Long)`;
+                        break;
+                    case ts_proto_descriptors_1.FieldOptions_JSType.JS_STRING:
+                        readSnippet = (0, ts_poet_1.code) `${utils.longToString}(${readSnippet} as Long)`;
+                        break;
+                }
+            }
+            else if (options.forceLong === options_1.LongOption.LONG) {
                 readSnippet = (0, ts_poet_1.code) `${readSnippet} as Long`;
             }
             else if (options.forceLong === options_1.LongOption.STRING) {
@@ -1038,13 +1048,13 @@ function getEncodeWriteSnippet(ctx, field) {
             case "int64":
             case "sint64":
             case "sfixed64":
-                return (place) => (0, ts_poet_1.code) `if (BigInt.asIntN(64, ${place}) !== ${place}) {
+                return (place, placeAlt) => (0, ts_poet_1.code) `if (BigInt.asIntN(64, ${place}) !== ${placeAlt !== null && placeAlt !== void 0 ? placeAlt : place}) {
           throw new ${utils.globalThis}.Error('value provided for field ${place} of type ${fieldType} too large');
         }
         writer.uint32(${tag}).${(0, types_1.toReaderCall)(field)}(${place}.toString())`;
             case "uint64":
             case "fixed64":
-                return (place) => (0, ts_poet_1.code) `if (BigInt.asUintN(64, ${place}) !== ${place}) {
+                return (place, placeAlt) => (0, ts_poet_1.code) `if (BigInt.asUintN(64, ${place}) !== ${placeAlt !== null && placeAlt !== void 0 ? placeAlt : place}) {
           throw new ${utils.globalThis}.Error('value provided for field ${place} of type ${fieldType} too large');
         }
         writer.uint32(${tag}).${(0, types_1.toReaderCall)(field)}(${place}.toString())`;
@@ -1277,9 +1287,13 @@ function generateEncode(ctx, fullName, messageDesc) {
       `);
         }
         else if ((0, types_1.isScalar)(field) || (0, types_1.isEnum)(field)) {
+            const isJsType = (0, types_1.isScalar)(field) && (0, types_1.isJsTypeFieldOption)(options, field);
+            const body = isJsType && options.forceLong === options_1.LongOption.BIGINT
+                ? writeSnippet(`BigInt(${messageProperty})`)
+                : writeSnippet(`${messageProperty}`);
             chunks.push((0, ts_poet_1.code) `
         if (${(0, types_1.notDefaultCheck)(ctx, field, messageDesc.options, `${messageProperty}`)}) {
-          ${writeSnippet(`${messageProperty}`)};
+          ${body};
         }
       `);
         }
@@ -1566,6 +1580,7 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
         const jsonPropertyOptional = (0, utils_1.getPropertyAccessor)("object", jsonName, true);
         // get code that extracts value from incoming object
         const readSnippet = (from) => {
+            var _a;
             if ((0, types_1.isEnum)(field)) {
                 const fromJson = (0, types_1.getEnumMethod)(ctx, field.typeName, "FromJSON");
                 return (0, ts_poet_1.code) `${fromJson}(${from})`;
@@ -1580,6 +1595,11 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
                         return (0, ts_poet_1.code) `${utils.bytesFromBase64}(${from})`;
                     }
                 }
+                else if ((0, types_1.isLong)(field) && (0, types_1.isJsTypeFieldOption)(options, field)) {
+                    const fieldType = (_a = (0, types_1.getFieldOptionsJsType)(field, ctx.options)) !== null && _a !== void 0 ? _a : field.type;
+                    const cstr = (0, case_1.capitalize)((0, types_1.basicTypeName)(ctx, { ...field, type: fieldType }, { keepValueType: true }).toCodeString([]));
+                    return (0, ts_poet_1.code) `${utils.globalThis}.${cstr}(${from})`;
+                }
                 else if ((0, types_1.isLong)(field) && options.forceLong === options_1.LongOption.LONG) {
                     const cstr = (0, case_1.capitalize)((0, types_1.basicTypeName)(ctx, field, { keepValueType: true }).toCodeString([]));
                     return (0, ts_poet_1.code) `${cstr}.fromValue(${from})`;
@@ -1812,6 +1832,7 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
         const jsonProperty = (0, utils_1.getPropertyAccessor)("obj", jsonName);
         const messageProperty = (0, utils_1.getPropertyAccessor)("message", fieldName);
         const readSnippet = (from) => {
+            var _a;
             if ((0, types_1.isEnum)(field)) {
                 const toJson = (0, types_1.getEnumMethod)(ctx, field.typeName, "ToJSON");
                 return (0, ts_poet_1.code) `${toJson}(${from})`;
@@ -1889,6 +1910,14 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
             else if ((0, types_1.isBytes)(field)) {
                 return (0, ts_poet_1.code) `${utils.base64FromBytes}(${from})`;
             }
+            else if ((0, types_1.isLong)(field) && (0, types_1.isJsTypeFieldOption)(options, field)) {
+                const fieldType = (_a = (0, types_1.getFieldOptionsJsType)(field, ctx.options)) !== null && _a !== void 0 ? _a : field.type;
+                if (!fieldType) {
+                    return (0, ts_poet_1.code) `${from}`;
+                }
+                const cstr = (0, case_1.capitalize)((0, types_1.basicTypeName)(ctx, { ...field, type: fieldType }, { keepValueType: true }).toCodeString([]));
+                return (0, ts_poet_1.code) `${utils.globalThis}.${cstr}(${from})`;
+            }
             else if ((0, types_1.isLong)(field) && options.forceLong === options_1.LongOption.LONG) {
                 return (0, ts_poet_1.code) `(${from} || ${(0, types_1.defaultValue)(ctx, field)}).toString()`;
             }
@@ -2007,7 +2036,9 @@ function generateFromPartial(ctx, fullName, messageDesc) {
         const messageProperty = (0, utils_1.getPropertyAccessor)("message", fieldName);
         const objectProperty = (0, utils_1.getPropertyAccessor)("object", fieldName);
         const readSnippet = (from) => {
-            if (((0, types_1.isLong)(field) || (0, types_1.isLongValueType)(field)) && options.forceLong === options_1.LongOption.LONG) {
+            if (((0, types_1.isLong)(field) || (0, types_1.isLongValueType)(field)) &&
+                options.forceLong === options_1.LongOption.LONG &&
+                !(0, types_1.isJsTypeFieldOption)(options, field)) {
                 return (0, ts_poet_1.code) `Long.fromValue(${from})`;
             }
             else if ((0, types_1.isObjectId)(field) && options.useMongoObjectId) {

package/build/options.d.ts

@@ -35,6 +35,7 @@ export type Options = {
     context: boolean;
     snakeToCamel: Array<"json" | "keys">;
     forceLong: LongOption;
+    useJsTypeOverride: boolean;
     globalThisPolyfill: boolean;
     useOptionals: boolean | "none" | "deprecatedOnly" | "messages" | "all";
     emitDefaultValues: Array<"json-methods">;

package/build/options.js

@@ -46,6 +46,7 @@ function defaultOptions() {
         emitDefaultValues: [],
         globalThisPolyfill: false,
         forceLong: LongOption.NUMBER,
+        useJsTypeOverride: false,
         useOptionals: "none",
         useDate: DateOption.DATE,
         useJsonTimestamp: JsonTimestampOption.RFC3339,

package/build/types.d.ts

@@ -12,6 +12,7 @@ export declare function basicTypeName(ctx: Context, field: FieldDescriptorProto,
 /** Returns the Reader method for the primitive's read/write call. */
 export declare function toReaderCall(field: FieldDescriptorProto): string;
 export declare function packedType(type: FieldDescriptorProto_Type): number | undefined;
+export declare function getFieldOptionsJsType(field: FieldDescriptorProto, options: Options): FieldDescriptorProto_Type | undefined;
 export declare function defaultValue(ctx: Context, field: FieldDescriptorProto): any;
 /** Creates code that checks that the field is not the default value. Supports scalars and enums. */
 export declare function notDefaultCheck(ctx: Context, field: FieldDescriptorProto, messageOptions: MessageOptions | undefined, place: string): Code;
@@ -101,3 +102,4 @@ export interface BatchMethod {
     mapType: boolean;
 }
 export declare function detectBatchMethod(ctx: Context, fileDesc: FileDescriptorProto, serviceDesc: ServiceDescriptorProto, methodDesc: MethodDescriptorProto): BatchMethod | undefined;
+export declare function isJsTypeFieldOption(options: Options, field: FieldDescriptorProto): boolean;

package/build/types.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.detectBatchMethod = exports.responsePromiseOrObservable = exports.responseObservable = exports.responsePromise = exports.responseType = exports.requestType = exports.observableType = exports.rawRequestType = exports.detectMapType = exports.shouldGenerateJSMapType = exports.toTypeName = exports.getEnumMethod = exports.messageToTypeName = exports.wrapperTypeName = exports.valueTypeName = exports.isEmptyType = exports.isLongValueType = exports.isStructTypeName = exports.isStructType = exports.isListValueTypeName = exports.isListValueType = exports.isFieldMaskTypeName = exports.isFieldMaskType = 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;
+exports.detectBatchMethod = exports.responsePromiseOrObservable = exports.responseObservable = exports.responsePromise = exports.responseType = exports.requestType = exports.observableType = exports.rawRequestType = exports.detectMapType = exports.shouldGenerateJSMapType = exports.toTypeName = exports.getEnumMethod = exports.messageToTypeName = exports.wrapperTypeName = exports.valueTypeName = exports.isEmptyType = exports.isLongValueType = exports.isStructTypeName = exports.isStructType = exports.isListValueTypeName = exports.isListValueType = exports.isFieldMaskTypeName = exports.isFieldMaskType = 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.getFieldOptionsJsType = exports.packedType = exports.toReaderCall = exports.basicTypeName = exports.basicLongWireType = exports.basicWireType = void 0;
+exports.isJsTypeFieldOption = void 0;
 const ts_proto_descriptors_1 = require("ts-proto-descriptors");
 const ts_poet_1 = require("ts-poet");
 const options_1 = require("./options");
@@ -60,8 +61,10 @@ function basicLongWireType(type) {
 exports.basicLongWireType = basicLongWireType;
 /** Returns the type name without any repeated/required/etc. labels. */
 function basicTypeName(ctx, field, typeOptions = {}) {
+    var _a, _b;
     const { options } = ctx;
-    switch (field.type) {
+    const fieldType = (_a = getFieldOptionsJsType(field, ctx.options)) !== null && _a !== void 0 ? _a : field.type;
+    switch (fieldType) {
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_DOUBLE:
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_FLOAT:
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_INT32:
@@ -75,8 +78,10 @@ function basicTypeName(ctx, field, typeOptions = {}) {
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_SINT64:
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_FIXED64:
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_SFIXED64:
-            // this handles 2^53, Long is only needed for 2^64; this is effectively pbjs's forceNumber
-            return longTypeName(ctx);
+            return isJsTypeFieldOption(options, field)
+                ? (_b = jsTypeName(field)) !== null && _b !== void 0 ? _b : longTypeName(ctx)
+                : // this handles 2^53, Long is only needed for 2^64; this is effectively pbjs's forceNumber
+                    longTypeName(ctx);
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_BOOL:
             return (0, ts_poet_1.code) `boolean`;
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_STRING:
@@ -164,10 +169,28 @@ function packedType(type) {
     }
 }
 exports.packedType = packedType;
+function getFieldOptionsJsType(field, options) {
+    var _a;
+    if (!options.useJsTypeOverride || ((_a = field.options) === null || _a === void 0 ? void 0 : _a.jstype) === undefined) {
+        return;
+    }
+    switch (field.options.jstype) {
+        case ts_proto_descriptors_1.FieldOptions_JSType.JS_STRING:
+            return ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_STRING;
+        case ts_proto_descriptors_1.FieldOptions_JSType.JS_NUMBER:
+            return ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_INT64;
+        // In the case of JS_NORMAL, we don't want to override the type, so we return
+        case ts_proto_descriptors_1.FieldOptions_JSType.JS_NORMAL:
+        // In the case of UNRECOGNIZED, we assume default behavior and we don't want to override the type, so we return
+        case ts_proto_descriptors_1.FieldOptions_JSType.UNRECOGNIZED:
+            return;
+    }
+}
+exports.getFieldOptionsJsType = getFieldOptionsJsType;
 function defaultValue(ctx, field) {
     const { typeMap, options, utils, currentFile } = ctx;
     const useDefaultValue = !currentFile.isProto3Syntax && !options.disableProto2DefaultValues && field.defaultValue;
-    const numbericDefaultVal = useDefaultValue ? field.defaultValue : 0;
+    const numericDefaultVal = useDefaultValue ? field.defaultValue : 0;
     switch (field.type) {
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_DOUBLE:
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_FLOAT:
@@ -176,7 +199,7 @@ function defaultValue(ctx, field) {
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_SINT32:
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_FIXED32:
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_SFIXED32:
-            return numbericDefaultVal;
+            return numericDefaultVal;
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_ENUM:
             // proto3 enforces enums starting at 0, however proto2 does not, so we have
             // to probe and see if zero is an allowed value. If it's not, pick the first one.
@@ -193,34 +216,33 @@ function defaultValue(ctx, field) {
             else {
                 return defaultEnum.number;
             }
+        case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_INT64:
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_UINT64:
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_FIXED64:
-            if (options.forceLong === options_1.LongOption.LONG) {
-                return (0, ts_poet_1.code) `${utils.Long}.${useDefaultValue ? "fromNumber" : "UZERO"}${useDefaultValue ? `(${numbericDefaultVal})` : ""}`;
-            }
-            else if (options.forceLong === options_1.LongOption.STRING) {
-                return `"${numbericDefaultVal}"`;
-            }
-            else if (options.forceLong === options_1.LongOption.BIGINT) {
-                return `BigInt("${numbericDefaultVal}")`;
-            }
-            else {
-                return numbericDefaultVal;
-            }
-        case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_INT64:
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_SINT64:
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_SFIXED64:
+            if (isJsTypeFieldOption(options, field)) {
+                switch (field.options.jstype) {
+                    case ts_proto_descriptors_1.FieldOptions_JSType.JS_STRING:
+                        return `"${numericDefaultVal}"`;
+                    case ts_proto_descriptors_1.FieldOptions_JSType.JS_NUMBER:
+                        return numericDefaultVal;
+                }
+            }
             if (options.forceLong === options_1.LongOption.LONG) {
-                return (0, ts_poet_1.code) `${utils.Long}.${useDefaultValue ? "fromNumber" : "ZERO"}${useDefaultValue ? `(${numbericDefaultVal})` : ""}`;
+                const value = field.type === ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_UINT64 || field.type === ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_FIXED64
+                    ? "UZERO"
+                    : "ZERO";
+                return (0, ts_poet_1.code) `${utils.Long}.${useDefaultValue ? "fromNumber" : value}${useDefaultValue ? `(${numericDefaultVal})` : ""}`;
             }
             else if (options.forceLong === options_1.LongOption.STRING) {
-                return `"${numbericDefaultVal}"`;
+                return `"${numericDefaultVal}"`;
             }
             else if (options.forceLong === options_1.LongOption.BIGINT) {
-                return `BigInt("${numbericDefaultVal}")`;
+                return `BigInt("${numericDefaultVal}")`;
             }
             else {
-                return numbericDefaultVal;
+                return numericDefaultVal;
             }
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_BOOL:
             return useDefaultValue ? field.defaultValue : false;
@@ -278,7 +300,7 @@ function notDefaultCheck(ctx, field, messageOptions, place) {
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_INT64:
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_SINT64:
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_SFIXED64:
-            if (options.forceLong === options_1.LongOption.LONG) {
+            if (options.forceLong === options_1.LongOption.LONG && !isJsTypeFieldOption(options, field)) {
                 return (0, ts_poet_1.code) `${maybeNotUndefinedAnd} !${place}.equals(${defaultValue(ctx, field)})`;
             }
             else {
@@ -541,6 +563,15 @@ function longTypeName(ctx) {
         return (0, ts_poet_1.code) `number`;
     }
 }
+function jsTypeName(field) {
+    var _a, _b;
+    if (((_a = field.options) === null || _a === void 0 ? void 0 : _a.jstype) === ts_proto_descriptors_1.FieldOptions_JSType.JS_STRING) {
+        return (0, ts_poet_1.code) `string`;
+    }
+    else if (((_b = field.options) === null || _b === void 0 ? void 0 : _b.jstype) === ts_proto_descriptors_1.FieldOptions_JSType.JS_NUMBER) {
+        return (0, ts_poet_1.code) `number`;
+    }
+}
 /** Maps `.some_proto_namespace.Message` to a TypeName. */
 function messageToTypeName(ctx, protoType, typeOptions = {}) {
     var _a;
@@ -584,13 +615,15 @@ function getEnumMethod(ctx, enumProtoType, methodSuffix) {
 exports.getEnumMethod = getEnumMethod;
 /** Return the TypeName for any field (primitive/message/etc.) as exposed in the interface. */
 function toTypeName(ctx, messageDesc, field, ensureOptional = false) {
+    var _a;
     function finalize(type, isOptional) {
         if (isOptional) {
             return (0, ts_poet_1.code) `${type} | ${(0, utils_1.nullOrUndefined)(ctx.options, field.proto3Optional)}`;
         }
         return type;
     }
-    let type = basicTypeName(ctx, field, { keepValueType: false });
+    const fieldType = (_a = getFieldOptionsJsType(field, ctx.options)) !== null && _a !== void 0 ? _a : field.type;
+    const type = basicTypeName(ctx, { ...field, type: fieldType }, { keepValueType: false });
     if (isRepeated(field)) {
         const mapType = messageDesc ? detectMapType(ctx, messageDesc, field) : false;
         if (mapType) {
@@ -756,3 +789,9 @@ exports.detectBatchMethod = detectBatchMethod;
 function hasSingleRepeatedField(messageDesc) {
     return messageDesc.field.length == 1 && messageDesc.field[0].label === ts_proto_descriptors_1.FieldDescriptorProto_Label.LABEL_REPEATED;
 }
+function isJsTypeFieldOption(options, field) {
+    var _a, _b;
+    return (options.useJsTypeOverride &&
+        (((_a = field.options) === null || _a === void 0 ? void 0 : _a.jstype) === ts_proto_descriptors_1.FieldOptions_JSType.JS_NUMBER || ((_b = field.options) === null || _b === void 0 ? void 0 : _b.jstype) === ts_proto_descriptors_1.FieldOptions_JSType.JS_STRING));
+}
+exports.isJsTypeFieldOption = isJsTypeFieldOption;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "1.172.0",
+  "version": "1.173.0",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",
@@ -62,7 +62,7 @@
     "rxjs": "^7.8.1",
     "semantic-release": "^21.0.7",
     "ts-jest": "^29.1.1",
-    "tsx": "^3.12.7",
+    "tsx": "^3.14.0",
     "typescript": "^5.1.6",
     "uglify-js": "^3.17.4"
   },