ts-proto 1.145.0 → 1.147.0

package/README.markdown

@@ -220,7 +220,7 @@ creating a class and calling the right getters/setters.
 
 - ObjectIds can be mapped as `mongodb.ObjectId`
 
-  (Configurable with the `useObjectId` parameter.)
+  (Configurable with the `useMongoObjectId` parameter.)
 
 # Auto-Batching / N+1 Prevention
 
@@ -410,11 +410,13 @@ 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=useMongoObjectId=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.
+- With `--ts_proto_opt=outputTypeAnnotations=true`, each message will be given a `$type` field containing its fully-qualified name.
+
+- 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 be given a `$type` field containing its fully-qualified name.
 
 - With `--ts_proto_opt=outputServices=grpc-js`, ts-proto will output service definitions and server / client stubs in [grpc-js](https://github.com/grpc/grpc-node/tree/master/packages/grpc-js) format.
 
@@ -461,7 +463,7 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=useJsonWireFormat=true`, the generated code will reflect the JSON representation of Protobuf messages.
 
-  Requires `onlyTypes=true`. Implies `useDate=string` and `stringEnums=true`. This option is to generate types that can be directly used with marshalling/unmarshalling Protobuf messages serialized as JSON.  
+  Requires `onlyTypes=true`. Implies `useDate=string` and `stringEnums=true`. This option is to generate types that can be directly used with marshalling/unmarshalling Protobuf messages serialized as JSON.
   You may also want to set `useOptionals=all`, as gRPC gateways are not required to send default value for scalar values.
 
 - With `--ts_proto_opt=useNumericEnumForJson=true`, the JSON converter (`toJSON`) will encode enum values as int, rather than a string literal.
@@ -502,6 +504,11 @@ Generated code will be placed in the Gradle build directory.
 
   by default this is enabled which would generate a type of `Box_Element_Image_Alignment`. By disabling this option the type that is generated would be `BoxElementImageAlignment`.
 
+- With `--ts_proto_opt=outputExtensions=true`, the generated code will include proto2 extensions
+
+  Extension encode/decode methods are compliant with the `outputEncodeMethods` option, and if `unknownFields=true`,
+  the `setExtension` and `getExtension` methods will be created for extendable messages, also compliant with `outputEncodeMethods` (setExtension = encode, getExtension = decode).
+
 ### 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/case.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.camelCaseGrpc = exports.camelCase = exports.capitalize = exports.camelToSnake = exports.snakeToCamel = exports.maybeSnakeToCamel = void 0;
+exports.camelCaseGrpc = exports.uncapitalize = exports.capitalize = exports.camelToSnake = exports.snakeToCamel = exports.maybeSnakeToCamel = void 0;
 const case_anything_1 = require("case-anything");
 /** Converts `key` to TS/JS camel-case idiom, unless overridden not to. */
 function maybeSnakeToCamel(key, options) {
@@ -32,16 +32,16 @@ function capitalize(s) {
     return s.substring(0, 1).toUpperCase() + s.substring(1);
 }
 exports.capitalize = capitalize;
-function camelCase(s) {
+function uncapitalize(s) {
     return s.substring(0, 1).toLowerCase() + s.substring(1);
 }
-exports.camelCase = camelCase;
+exports.uncapitalize = uncapitalize;
+/* This function uses the exact same semantics found inside the grpc
+ * nodejs library. Camel case splitting must be done by word i.e
+ * GetAPIValue must become getApiValue (notice the API becomes Api).
+ * This needs to be followed otherwise it will not succeed in the grpc nodejs module.
+ */
 function camelCaseGrpc(s) {
-    /* This function uses the exact same semantics found inside the grpc
-     * nodejs library. Camel case splitting must be done by word i.e
-     * GetAPIValue must become getApiValue (notice the API becomes Api).
-     * This needs to be followed otherwise it will not succeed in the grpc nodejs module.
-     */
     return (0, case_anything_1.camelCase)(s);
 }
 exports.camelCaseGrpc = camelCaseGrpc;

package/build/enums.js

@@ -58,7 +58,7 @@ exports.generateEnum = generateEnum;
 function generateEnumFromJson(ctx, fullName, enumDesc) {
     const { options, utils } = ctx;
     const chunks = [];
-    const functionName = (0, case_1.camelCase)(fullName) + "FromJSON";
+    const functionName = (0, case_1.uncapitalize)(fullName) + "FromJSON";
     chunks.push((0, ts_poet_1.code) `export function ${(0, ts_poet_1.def)(functionName)}(object: any): ${fullName} {`);
     chunks.push((0, ts_poet_1.code) `switch (object) {`);
     for (const valueDesc of enumDesc.value) {
@@ -94,7 +94,7 @@ exports.generateEnumFromJson = generateEnumFromJson;
 function generateEnumToJson(ctx, fullName, enumDesc) {
     const { options, utils } = ctx;
     const chunks = [];
-    const functionName = (0, case_1.camelCase)(fullName) + "ToJSON";
+    const functionName = (0, case_1.uncapitalize)(fullName) + "ToJSON";
     chunks.push((0, ts_poet_1.code) `export function ${(0, ts_poet_1.def)(functionName)}(object: ${fullName}): ${ctx.options.useNumericEnumForJson ? "number" : "string"} {`);
     chunks.push((0, ts_poet_1.code) `switch (object) {`);
     for (const valueDesc of enumDesc.value) {
@@ -140,7 +140,7 @@ exports.generateEnumToJson = generateEnumToJson;
 function generateEnumToNumber(ctx, fullName, enumDesc) {
     const { options, utils } = ctx;
     const chunks = [];
-    const functionName = (0, case_1.camelCase)(fullName) + "ToNumber";
+    const functionName = (0, case_1.uncapitalize)(fullName) + "ToNumber";
     chunks.push((0, ts_poet_1.code) `export function ${(0, ts_poet_1.def)(functionName)}(object: ${fullName}): number {`);
     chunks.push((0, ts_poet_1.code) `switch (object) {`);
     for (const valueDesc of enumDesc.value) {

package/build/generate-generic-service-definition.js

@@ -33,7 +33,7 @@ function generateGenericServiceDefinition(ctx, fileDesc, sourceInfo, serviceDesc
         const info = sourceInfo.lookup(sourceInfo_1.Fields.service.method, index);
         (0, utils_1.maybeAddComment)(info, chunks, (_c = methodDesc.options) === null || _c === void 0 ? void 0 : _c.deprecated);
         chunks.push((0, ts_poet_1.code) `
-      ${(0, case_1.camelCase)(methodDesc.name)}: ${generateMethodDefinition(ctx, methodDesc)},
+      ${(0, case_1.uncapitalize)(methodDesc.name)}: ${generateMethodDefinition(ctx, methodDesc)},
     `);
     }
     chunks.push((0, ts_poet_1.code) `
@@ -76,10 +76,10 @@ function generateMethodOptions(ctx, options) {
                 for (const value of values) {
                     valuesChunks.push((0, ts_poet_1.code) `${ctx.options.env == "node" ? "Buffer.from" : "new Uint8Array"}([${value.join(", ")}])`);
                 }
-                unknownFieldsChunks.push((0, ts_poet_1.code) `${key}: [\n${(0, ts_poet_1.joinCode)(valuesChunks, { on: "," }).toCodeString([])}\n],`);
+                unknownFieldsChunks.push((0, ts_poet_1.code) `${key}: [\n${(0, ts_poet_1.joinCode)(valuesChunks, { on: "," })}\n],`);
             }
             unknownFieldsChunks.push((0, ts_poet_1.code) `}`);
-            chunks.push((0, ts_poet_1.code) `_unknownFields: ${(0, ts_poet_1.joinCode)(unknownFieldsChunks, { on: "\n" }).toCodeString([])}`);
+            chunks.push((0, ts_poet_1.code) `_unknownFields: ${(0, ts_poet_1.joinCode)(unknownFieldsChunks, { on: "\n" })}`);
         }
     }
     chunks.push((0, ts_poet_1.code) `}`);

package/build/generate-nice-grpc.js

@@ -37,7 +37,7 @@ function generateServerStub(ctx, sourceInfo, serviceDesc) {
             if (methodDesc.serverStreaming) {
                 // bidi streaming
                 chunks.push((0, ts_poet_1.code) `
-          ${(0, case_1.camelCase)(methodDesc.name)}(
+          ${(0, case_1.uncapitalize)(methodDesc.name)}(
             request: AsyncIterable<${inputType}>,
             context: ${CallContext} & CallContextExt,
           ): ${ServerStreamingMethodResult}<${outputType}>;
@@ -46,7 +46,7 @@ function generateServerStub(ctx, sourceInfo, serviceDesc) {
             else {
                 // client streaming
                 chunks.push((0, ts_poet_1.code) `
-          ${(0, case_1.camelCase)(methodDesc.name)}(
+          ${(0, case_1.uncapitalize)(methodDesc.name)}(
             request: AsyncIterable<${inputType}>,
             context: ${CallContext} & CallContextExt,
           ): Promise<${outputType}>;
@@ -57,7 +57,7 @@ function generateServerStub(ctx, sourceInfo, serviceDesc) {
             if (methodDesc.serverStreaming) {
                 // server streaming
                 chunks.push((0, ts_poet_1.code) `
-          ${(0, case_1.camelCase)(methodDesc.name)}(
+          ${(0, case_1.uncapitalize)(methodDesc.name)}(
             request: ${inputType},
             context: ${CallContext} & CallContextExt,
           ): ${ServerStreamingMethodResult}<${outputType}>;
@@ -66,7 +66,7 @@ function generateServerStub(ctx, sourceInfo, serviceDesc) {
             else {
                 // unary
                 chunks.push((0, ts_poet_1.code) `
-          ${(0, case_1.camelCase)(methodDesc.name)}(
+          ${(0, case_1.uncapitalize)(methodDesc.name)}(
             request: ${inputType},
             context: ${CallContext} & CallContextExt,
           ): Promise<${outputType}>;
@@ -94,7 +94,7 @@ function generateClientStub(ctx, sourceInfo, serviceDesc) {
             if (methodDesc.serverStreaming) {
                 // bidi streaming
                 chunks.push((0, ts_poet_1.code) `
-          ${(0, case_1.camelCase)(methodDesc.name)}(
+          ${(0, case_1.uncapitalize)(methodDesc.name)}(
             request: AsyncIterable<${inputType}>,
             options?: ${CallOptions} & CallOptionsExt,
           ): AsyncIterable<${outputType}>;
@@ -103,7 +103,7 @@ function generateClientStub(ctx, sourceInfo, serviceDesc) {
             else {
                 // client streaming
                 chunks.push((0, ts_poet_1.code) `
-          ${(0, case_1.camelCase)(methodDesc.name)}(
+          ${(0, case_1.uncapitalize)(methodDesc.name)}(
             request: AsyncIterable<${inputType}>,
             options?: ${CallOptions} & CallOptionsExt,
           ): Promise<${outputType}>;
@@ -114,7 +114,7 @@ function generateClientStub(ctx, sourceInfo, serviceDesc) {
             if (methodDesc.serverStreaming) {
                 // server streaming
                 chunks.push((0, ts_poet_1.code) `
-          ${(0, case_1.camelCase)(methodDesc.name)}(
+          ${(0, case_1.uncapitalize)(methodDesc.name)}(
             request: ${inputType},
             options?: ${CallOptions} & CallOptionsExt,
           ): AsyncIterable<${outputType}>;
@@ -123,7 +123,7 @@ function generateClientStub(ctx, sourceInfo, serviceDesc) {
             else {
                 // unary
                 chunks.push((0, ts_poet_1.code) `
-          ${(0, case_1.camelCase)(methodDesc.name)}(
+          ${(0, case_1.uncapitalize)(methodDesc.name)}(
             request: ${inputType},
             options?: ${CallOptions} & CallOptionsExt,
           ): Promise<${outputType}>;

package/build/main.js

@@ -77,7 +77,11 @@ function generateFile(ctx, fileDesc) {
     // We add `nestJs` here because enough though it doesn't use our encode/decode methods
     // for most/vanilla messages, we do generate static wrap/unwrap methods for the special
     // Struct/Value/wrapper types and use the `wrappers[...]` to have NestJS know about them.
-    if (options.outputEncodeMethods || options.outputJsonMethods || options.outputTypeRegistry || options.nestJs) {
+    if (options.outputEncodeMethods ||
+        options.outputJsonMethods ||
+        options.outputTypeAnnotations ||
+        options.outputTypeRegistry ||
+        options.nestJs) {
         // then add the encoder/decoder/base instance
         (0, visit_1.visit)(fileDesc, sourceInfo, (fullName, message, _sInfo, fullProtoTypeName) => {
             const fullTypeName = (0, utils_1.maybePrefixPackage)(fileDesc, fullProtoTypeName);
@@ -89,17 +93,29 @@ function generateFile(ctx, fileDesc) {
                 chunks.push(generateBaseInstanceFactory(ctx, fullName, message, fullTypeName));
             }
             const staticMembers = [];
-            if (options.outputTypeRegistry) {
+            if (options.outputTypeAnnotations || options.outputTypeRegistry) {
                 staticMembers.push((0, ts_poet_1.code) `$type: '${fullTypeName}' as const`);
             }
+            if (options.outputExtensions) {
+                for (const extension of message.extension) {
+                    const { name, type, extensionInfo } = generateExtension(ctx, message, extension);
+                    staticMembers.push((0, ts_poet_1.code) `${name}: <${ctx.utils.Extension}<${type}>> ${extensionInfo}`);
+                }
+            }
             if (options.outputEncodeMethods) {
                 if (options.outputEncodeMethods === true ||
                     options.outputEncodeMethods === "encode-only" ||
                     options.outputEncodeMethods === "encode-no-creation") {
                     staticMembers.push(generateEncode(ctx, fullName, message));
+                    if (options.outputExtensions && options.unknownFields && message.extensionRange.length) {
+                        staticMembers.push(generateSetExtension(ctx, fullName));
+                    }
                 }
                 if (options.outputEncodeMethods === true || options.outputEncodeMethods === "decode-only") {
                     staticMembers.push(generateDecode(ctx, fullName, message));
+                    if (options.outputExtensions && options.unknownFields && message.extensionRange.length) {
+                        staticMembers.push(generateGetExtension(ctx, fullName));
+                    }
                 }
             }
             if (options.useAsyncIterable) {
@@ -144,6 +160,12 @@ function generateFile(ctx, fileDesc) {
             }
         }, options);
     }
+    if (options.outputExtensions) {
+        for (const extension of fileDesc.extension) {
+            const { name, type, extensionInfo } = generateExtension(ctx, undefined, extension);
+            chunks.push((0, ts_poet_1.code) `export const ${name}: ${ctx.utils.Extension}<${type}> = ${extensionInfo};`);
+        }
+    }
     if (options.nestJs) {
         if (fileDesc.messageType.find((message) => message.field.find(types_1.isStructType))) {
             chunks.push(makeProtobufStructWrapper(options));
@@ -256,6 +278,7 @@ function makeUtils(options) {
         ...makeComparisonUtils(),
         ...makeNiceGrpcServerStreamingMethodResult(),
         ...makeGrpcWebErrorClass(bytes),
+        ...makeExtensionClass(options),
     };
 }
 exports.makeUtils = makeUtils;
@@ -395,7 +418,7 @@ function makeDeepPartial(options, longs) {
     const maybeLong = options.forceLong === options_1.LongOption.LONG ? (0, ts_poet_1.code) ` : T extends ${longs.Long} ? string | number | Long ` : "";
     const Builtin = (0, ts_poet_1.conditionalOutput)("Builtin", (0, ts_poet_1.code) `type Builtin = Date | Function | Uint8Array | string | number | boolean |${options.forceLong === options_1.LongOption.BIGINT ? " bigint |" : ""} undefined;`);
     // Based on https://github.com/sindresorhus/type-fest/pull/259
-    const maybeExcludeType = options.outputTypeRegistry ? `| '$type'` : "";
+    const maybeExcludeType = options.outputTypeAnnotations || options.outputTypeRegistry ? `| '$type'` : "";
     const Exact = (0, ts_poet_1.conditionalOutput)("Exact", (0, ts_poet_1.code) `
       type KeysOfUnion<T> = T extends T ? keyof T : never;
       ${maybeExport} type Exact<P, I extends P> = P extends ${Builtin}
@@ -404,7 +427,7 @@ function makeDeepPartial(options, longs) {
         { [K in keyof P]: Exact<P[K], I[K]> } & { [K in Exclude<keyof I, KeysOfUnion<P> ${maybeExcludeType}>]: never };
     `);
     // Based on the type from ts-essentials
-    const keys = options.outputTypeRegistry ? (0, ts_poet_1.code) `Exclude<keyof T, '$type'>` : (0, ts_poet_1.code) `keyof T`;
+    const keys = options.outputTypeAnnotations || options.outputTypeRegistry ? (0, ts_poet_1.code) `Exclude<keyof T, '$type'>` : (0, ts_poet_1.code) `keyof T`;
     const DeepPartial = (0, ts_poet_1.conditionalOutput)("DeepPartial", (0, ts_poet_1.code) `
       ${maybeExport} type DeepPartial<T> =  T extends ${Builtin}
         ? T
@@ -464,7 +487,7 @@ function makeTimestampMethods(options, longs) {
         // (note this only occurs when the string is > 8 characters)
         seconds = "Math.trunc(date.getTime() / 1_000).toString()";
     }
-    const maybeTypeField = options.outputTypeRegistry ? `$type: 'google.protobuf.Timestamp',` : "";
+    const maybeTypeField = options.outputTypeAnnotations || options.outputTypeRegistry ? `$type: 'google.protobuf.Timestamp',` : "";
     const toTimestamp = (0, ts_poet_1.conditionalOutput)("toTimestamp", options.useDate === options_1.DateOption.STRING
         ? (0, ts_poet_1.code) `
           function toTimestamp(dateStr: string): ${Timestamp} {
@@ -550,6 +573,22 @@ function makeGrpcWebErrorClass(bytes) {
     `);
     return { GrpcWebError };
 }
+function makeExtensionClass(options) {
+    const Reader = (0, utils_1.impFile)(options, "Reader@protobufjs/minimal");
+    const Writer = (0, utils_1.impFile)(options, "Writer@protobufjs/minimal");
+    const Extension = (0, ts_poet_1.conditionalOutput)("Extension", (0, ts_poet_1.code) `
+      export interface Extension <T> {
+        number: number;
+        tag: number;
+        singularTag?: number;
+        encode?: (message: T) => Uint8Array[];
+        decode?: (tag: number, input: Uint8Array[]) => T;
+        repeated: boolean;
+        packed: boolean;
+      }
+    `);
+    return { Extension };
+}
 // Create the interface with properties
 function generateInterfaceDeclaration(ctx, fullName, messageDesc, sourceInfo, fullTypeName) {
     var _a;
@@ -558,7 +597,7 @@ function generateInterfaceDeclaration(ctx, fullName, messageDesc, sourceInfo, fu
     (0, utils_1.maybeAddComment)(sourceInfo, chunks, (_a = messageDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
     // interface name should be defined to avoid import collisions
     chunks.push((0, ts_poet_1.code) `export interface ${(0, ts_poet_1.def)(fullName)} {`);
-    if (ctx.options.outputTypeRegistry) {
+    if (ctx.options.outputTypeAnnotations || ctx.options.outputTypeRegistry) {
         chunks.push((0, ts_poet_1.code) `$type: '${fullTypeName}',`);
     }
     // When oneof=unions, we generate a single property with an ADT per `oneof` clause.
@@ -649,7 +688,7 @@ function generateBaseInstanceFactory(ctx, fullName, messageDesc, fullTypeName) {
                     : (0, types_1.defaultValue)(ctx, field);
         fields.push((0, ts_poet_1.code) `${name}: ${val}`);
     }
-    if (ctx.options.outputTypeRegistry) {
+    if (ctx.options.outputTypeAnnotations || ctx.options.outputTypeRegistry) {
         fields.unshift((0, ts_poet_1.code) `$type: '${fullTypeName}'`);
     }
     if (ctx.options.unknownFields && ctx.options.initializeFieldsAsUndefined) {
@@ -661,6 +700,73 @@ function generateBaseInstanceFactory(ctx, fullName, messageDesc, fullTypeName) {
     }
   `;
 }
+function getDecodeReadSnippet(ctx, field) {
+    const { options, utils } = ctx;
+    let readSnippet;
+    if ((0, types_1.isPrimitive)(field)) {
+        readSnippet = (0, ts_poet_1.code) `reader.${(0, types_1.toReaderCall)(field)}()`;
+        if ((0, types_1.isBytes)(field)) {
+            if (options.env === options_1.EnvOption.NODE) {
+                readSnippet = (0, ts_poet_1.code) `${readSnippet} as Buffer`;
+            }
+        }
+        else if ((0, types_1.basicLongWireType)(field.type) !== undefined) {
+            if (options.forceLong === options_1.LongOption.LONG) {
+                readSnippet = (0, ts_poet_1.code) `${readSnippet} as Long`;
+            }
+            else if (options.forceLong === options_1.LongOption.STRING) {
+                readSnippet = (0, ts_poet_1.code) `${utils.longToString}(${readSnippet} as Long)`;
+            }
+            else if (options.forceLong === options_1.LongOption.BIGINT) {
+                readSnippet = (0, ts_poet_1.code) `${utils.longToBigint}(${readSnippet} as Long)`;
+            }
+            else {
+                readSnippet = (0, ts_poet_1.code) `${utils.longToNumber}(${readSnippet} as Long)`;
+            }
+        }
+        else if ((0, types_1.isEnum)(field)) {
+            if (options.stringEnums) {
+                const fromJson = (0, types_1.getEnumMethod)(ctx, field.typeName, "FromJSON");
+                readSnippet = (0, ts_poet_1.code) `${fromJson}(${readSnippet})`;
+            }
+            else {
+                readSnippet = (0, ts_poet_1.code) `${readSnippet} as any`;
+            }
+        }
+    }
+    else if ((0, types_1.isValueType)(ctx, field)) {
+        const type = (0, types_1.basicTypeName)(ctx, field, { keepValueType: true });
+        const unwrap = (decodedValue) => {
+            if ((0, types_1.isListValueType)(field) || (0, types_1.isStructType)(field) || (0, types_1.isAnyValueType)(field) || (0, types_1.isFieldMaskType)(field)) {
+                return (0, ts_poet_1.code) `${type}.unwrap(${decodedValue})`;
+            }
+            return (0, ts_poet_1.code) `${decodedValue}.value`;
+        };
+        const decoder = (0, ts_poet_1.code) `${type}.decode(reader, reader.uint32())`;
+        readSnippet = (0, ts_poet_1.code) `${unwrap(decoder)}`;
+    }
+    else if ((0, types_1.isTimestamp)(field) && (options.useDate === options_1.DateOption.DATE || options.useDate === options_1.DateOption.STRING)) {
+        const type = (0, types_1.basicTypeName)(ctx, field, { keepValueType: true });
+        readSnippet = (0, ts_poet_1.code) `${utils.fromTimestamp}(${type}.decode(reader, reader.uint32()))`;
+    }
+    else if ((0, types_1.isObjectId)(field) && options.useMongoObjectId) {
+        const type = (0, types_1.basicTypeName)(ctx, field, { keepValueType: true });
+        readSnippet = (0, ts_poet_1.code) `${utils.fromProtoObjectId}(${type}.decode(reader, reader.uint32()))`;
+    }
+    else if ((0, types_1.isMessage)(field)) {
+        const type = (0, types_1.basicTypeName)(ctx, field);
+        if (field.type == ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_GROUP) {
+            readSnippet = (0, ts_poet_1.code) `${type}.decode(reader)`;
+        }
+        else {
+            readSnippet = (0, ts_poet_1.code) `${type}.decode(reader, reader.uint32())`;
+        }
+    }
+    else {
+        throw new Error(`Unhandled field ${field}`);
+    }
+    return readSnippet;
+}
 /** Creates a function to decode a message by loop overing the tags. */
 function generateDecode(ctx, fullName, messageDesc) {
     const { options, utils, typeMap } = ctx;
@@ -692,71 +798,12 @@ function generateDecode(ctx, fullName, messageDesc) {
         chunks.push((0, ts_poet_1.code) `case ${field.number}:`);
         const tag = ((field.number << 3) | (0, types_1.basicWireType)(field.type)) >>> 0;
         const tagCheck = (0, ts_poet_1.code) `
-      if(tag != ${tag})
+      if (tag !== ${tag}) {
         break;
+      }
     `;
         // get a generic 'reader.doSomething' bit that is specific to the basic type
-        let readSnippet;
-        if ((0, types_1.isPrimitive)(field)) {
-            readSnippet = (0, ts_poet_1.code) `reader.${(0, types_1.toReaderCall)(field)}()`;
-            if ((0, types_1.isBytes)(field)) {
-                if (options.env === options_1.EnvOption.NODE) {
-                    readSnippet = (0, ts_poet_1.code) `${readSnippet} as Buffer`;
-                }
-            }
-            else if ((0, types_1.basicLongWireType)(field.type) !== undefined) {
-                if (options.forceLong === options_1.LongOption.LONG) {
-                    readSnippet = (0, ts_poet_1.code) `${readSnippet} as Long`;
-                }
-                else if (options.forceLong === options_1.LongOption.STRING) {
-                    readSnippet = (0, ts_poet_1.code) `${utils.longToString}(${readSnippet} as Long)`;
-                }
-                else if (options.forceLong === options_1.LongOption.BIGINT) {
-                    readSnippet = (0, ts_poet_1.code) `${utils.longToBigint}(${readSnippet} as Long)`;
-                }
-                else {
-                    readSnippet = (0, ts_poet_1.code) `${utils.longToNumber}(${readSnippet} as Long)`;
-                }
-            }
-            else if ((0, types_1.isEnum)(field)) {
-                if (options.stringEnums) {
-                    const fromJson = (0, types_1.getEnumMethod)(ctx, field.typeName, "FromJSON");
-                    readSnippet = (0, ts_poet_1.code) `${fromJson}(${readSnippet})`;
-                }
-                else {
-                    readSnippet = (0, ts_poet_1.code) `${readSnippet} as any`;
-                }
-            }
-        }
-        else if ((0, types_1.isValueType)(ctx, field)) {
-            const type = (0, types_1.basicTypeName)(ctx, field, { keepValueType: true });
-            const unwrap = (decodedValue) => {
-                if ((0, types_1.isListValueType)(field) || (0, types_1.isStructType)(field) || (0, types_1.isAnyValueType)(field) || (0, types_1.isFieldMaskType)(field)) {
-                    return (0, ts_poet_1.code) `${type}.unwrap(${decodedValue})`;
-                }
-                return (0, ts_poet_1.code) `${decodedValue}.value`;
-            };
-            const decoder = (0, ts_poet_1.code) `${type}.decode(reader, reader.uint32())`;
-            readSnippet = (0, ts_poet_1.code) `${unwrap(decoder)}`;
-        }
-        else if ((0, types_1.isTimestamp)(field) && (options.useDate === options_1.DateOption.DATE || options.useDate === options_1.DateOption.STRING)) {
-            const type = (0, types_1.basicTypeName)(ctx, field, { keepValueType: true });
-            readSnippet = (0, ts_poet_1.code) `${utils.fromTimestamp}(${type}.decode(reader, reader.uint32()))`;
-        }
-        else if ((0, types_1.isObjectId)(field) && options.useMongoObjectId) {
-            const type = (0, types_1.basicTypeName)(ctx, field, { keepValueType: true });
-            readSnippet = (0, ts_poet_1.code) `${utils.fromProtoObjectId}(${type}.decode(reader, reader.uint32()))`;
-        }
-        else if ((0, types_1.isMessage)(field)) {
-            const type = (0, types_1.basicTypeName)(ctx, field);
-            if (field.type == ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_GROUP)
-                readSnippet = (0, ts_poet_1.code) `${type}.decode(reader)`;
-            else
-                readSnippet = (0, ts_poet_1.code) `${type}.decode(reader, reader.uint32())`;
-        }
-        else {
-            throw new Error(`Unhandled field ${field}`);
-        }
+        const readSnippet = getDecodeReadSnippet(ctx, field);
         // and then use the snippet to handle repeated fields if necessary
         const initializerNecessary = !options.initializeFieldsAsUndefined && (0, types_1.isOptionalProperty)(field, messageDesc.options, options);
         if ((0, types_1.isRepeated)(field)) {
@@ -769,9 +816,9 @@ function generateDecode(ctx, fullName, messageDesc) {
                     : `message.${fieldName}${maybeNonNullAssertion}[${varName}.key] = ${varName}.value`;
                 const initializerSnippet = initializerNecessary
                     ? `
-            if(message.${fieldName} === undefined)
+            if (message.${fieldName} === undefined) {
               message.${fieldName} = ${ctx.options.useMapType ? "new Map()" : "{}"};
-            `
+            }`
                     : "";
                 chunks.push((0, ts_poet_1.code) `
           ${tagCheck}
@@ -784,8 +831,10 @@ function generateDecode(ctx, fullName, messageDesc) {
             }
             else {
                 const initializerSnippet = initializerNecessary
-                    ? `if(message.${fieldName} === undefined)
-              message.${fieldName} = [];`
+                    ? `
+            if (message.${fieldName} === undefined) {
+              message.${fieldName} = [];
+            }`
                     : "";
                 if ((0, types_1.packedType)(field.type) === undefined) {
                     chunks.push((0, ts_poet_1.code) `
@@ -797,13 +846,14 @@ function generateDecode(ctx, fullName, messageDesc) {
                 else {
                     const packedTag = ((field.number << 3) | 2) >>> 0;
                     chunks.push((0, ts_poet_1.code) `
-            if(tag == ${tag}){
+            if (tag === ${tag}) {
               ${initializerSnippet}
               message.${fieldName}${maybeNonNullAssertion}.push(${readSnippet});
+
               continue;
             }
 
-            if(tag == ${packedTag}){
+            if (tag === ${packedTag}) {
               ${initializerSnippet}
               const end2 = reader.uint32() + reader.pos;
               while (reader.pos < end2) {
@@ -831,21 +881,24 @@ function generateDecode(ctx, fullName, messageDesc) {
         message.${fieldName} = ${readSnippet};
       `);
         }
-        if (!(0, types_1.isRepeated)(field) || (0, types_1.packedType)(field.type) === undefined)
+        if (!(0, types_1.isRepeated)(field) || (0, types_1.packedType)(field.type) === undefined) {
             chunks.push((0, ts_poet_1.code) `continue;`);
+        }
     });
     chunks.push((0, ts_poet_1.code) `}`);
     chunks.push((0, ts_poet_1.code) `
-      if((tag & 7) == 4 || tag == 0)
+      if ((tag & 7) === 4 || tag === 0) {
         break;
+      }
   `);
     if (options.unknownFields) {
         let unknownFieldsInitializerSnippet = "";
         let maybeNonNullAssertion = options.initializeFieldsAsUndefined ? "!" : "";
         if (!options.initializeFieldsAsUndefined) {
             unknownFieldsInitializerSnippet = `
-        if(message._unknownFields === undefined)
+        if (message._unknownFields === undefined) {
           message._unknownFields = {};
+        }
       `;
         }
         chunks.push((0, ts_poet_1.code) `
@@ -856,10 +909,11 @@ function generateDecode(ctx, fullName, messageDesc) {
       ${unknownFieldsInitializerSnippet}
       const list = message._unknownFields${maybeNonNullAssertion}[tag];
 
-      if(list === undefined)
+      if (list === undefined) {
         message._unknownFields${maybeNonNullAssertion}[tag] = [buf];
-      else
+      } else {
         list.push(buf);
+      }
     `);
     }
     else {
@@ -900,7 +954,7 @@ function getEncodeWriteSnippet(ctx, field) {
         return (place) => (0, ts_poet_1.code) `${type}.encode(${utils.toTimestamp}(${place}), writer.uint32(${tag}).fork()).ldelim()`;
     }
     else if ((0, types_1.isValueType)(ctx, field)) {
-        const maybeTypeField = options.outputTypeRegistry ? `$type: '${field.typeName.slice(1)}',` : "";
+        const maybeTypeField = options.outputTypeAnnotations || options.outputTypeRegistry ? `$type: '${field.typeName.slice(1)}',` : "";
         const type = (0, types_1.basicTypeName)(ctx, field, { keepValueType: true });
         const wrappedValue = (place) => {
             if ((0, types_1.isAnyValueType)(field) || (0, types_1.isListValueType)(field) || (0, types_1.isStructType)(field) || (0, types_1.isFieldMaskType)(field)) {
@@ -949,7 +1003,7 @@ function generateEncode(ctx, fullName, messageDesc) {
         if ((0, types_1.isRepeated)(field)) {
             if ((0, types_1.isMapType)(ctx, messageDesc, field)) {
                 const valueType = typeMap.get(field.typeName)[2].field[1];
-                const maybeTypeField = options.outputTypeRegistry ? `$type: '${field.typeName.slice(1)}',` : "";
+                const maybeTypeField = options.outputTypeAnnotations || options.outputTypeRegistry ? `$type: '${field.typeName.slice(1)}',` : "";
                 const entryWriteSnippet = (0, types_1.isValueType)(ctx, valueType)
                     ? (0, ts_poet_1.code) `
               if (value !== undefined) {
@@ -1099,6 +1153,226 @@ function generateEncode(ctx, fullName, messageDesc) {
     chunks.push((0, ts_poet_1.code) `}`);
     return (0, ts_poet_1.joinCode)(chunks, { on: "\n" });
 }
+function generateSetExtension(ctx, fullName) {
+    return (0, ts_poet_1.code) `
+    setExtension <T> (message: ${fullName}, extension: ${ctx.utils.Extension}<T>, value: T): void {
+      const encoded = extension.encode!(value);
+
+      if (message._unknownFields !== undefined) {
+        delete message._unknownFields[extension.tag];
+
+        if (extension.singularTag !== undefined) {
+          delete message._unknownFields[extension.singularTag];
+        }
+      }
+
+      if (encoded.length !== 0) {
+        if (message._unknownFields === undefined) {
+          message._unknownFields = {};
+        }
+
+        message._unknownFields[extension.tag] = encoded;
+      }
+    }
+  `;
+}
+function generateGetExtension(ctx, fullName) {
+    return (0, ts_poet_1.code) `
+    getExtension <T> (message: ${fullName}, extension: ${ctx.utils.Extension}<T>): T | undefined {
+      let results: T | undefined = undefined;
+
+      if (message._unknownFields === undefined) {
+        return undefined;
+      }
+
+      let list = message._unknownFields[extension.tag];
+
+      if (list !== undefined) {
+        results = extension.decode!(extension.tag, list);
+      }
+
+      if (extension.singularTag === undefined) {
+        return results;
+      }
+
+      list = message._unknownFields[extension.singularTag];
+
+      if (list !== undefined) {
+        const results2 = extension.decode!(extension.singularTag, list);
+
+        if (results !== undefined && (results as any).length !== 0) {
+          results = (results as any).concat(results2);
+        } else {
+          results = results2;
+        }
+      }
+
+      return results;
+    }
+  `;
+}
+function generateExtension(ctx, message, extension) {
+    var _a;
+    const type = (0, types_1.toTypeName)(ctx, message, extension);
+    const packedTag = (0, types_1.isRepeated)(extension) && (0, types_1.packedType)(extension.type) !== undefined ? ((extension.number << 3) | 2) >>> 0 : undefined;
+    const singularTag = ((extension.number << 3) | (0, types_1.basicWireType)(extension.type)) >>> 0;
+    const tag = packedTag !== null && packedTag !== void 0 ? packedTag : singularTag;
+    const chunks = [];
+    chunks.push((0, ts_poet_1.code) `{`);
+    chunks.push((0, ts_poet_1.code) `number: ${extension.number},`);
+    chunks.push((0, ts_poet_1.code) `tag: ${tag},`);
+    if (packedTag !== undefined)
+        chunks.push((0, ts_poet_1.code) `singularTag: ${singularTag},`);
+    chunks.push((0, ts_poet_1.code) `repeated: ${extension.label == ts_proto_descriptors_1.FieldDescriptorProto_Label.LABEL_REPEATED},`);
+    chunks.push((0, ts_poet_1.code) `packed: ${((_a = extension.options) === null || _a === void 0 ? void 0 : _a.packed) ? true : false},`);
+    const Reader = (0, utils_1.impFile)(ctx.options, "Reader@protobufjs/minimal");
+    const Writer = (0, utils_1.impFile)(ctx.options, "Writer@protobufjs/minimal");
+    if (ctx.options.outputEncodeMethods === true ||
+        ctx.options.outputEncodeMethods === "encode-only" ||
+        ctx.options.outputEncodeMethods === "encode-no-creation") {
+        chunks.push((0, ts_poet_1.code) `
+      encode: (value: ${type}): Uint8Array[] => {
+        const encoded: Uint8Array[] = [];
+    `);
+        function getEncodeSnippet(ctx, field) {
+            const { options, utils } = ctx;
+            if ((0, types_1.isEnum)(field) && options.stringEnums) {
+                const toNumber = (0, types_1.getEnumMethod)(ctx, field.typeName, "ToNumber");
+                return (place) => (0, ts_poet_1.code) `writer.${(0, types_1.toReaderCall)(field)}(${toNumber}(${place}))`;
+            }
+            else if ((0, types_1.isLong)(field) && options.forceLong === options_1.LongOption.BIGINT) {
+                return (place) => (0, ts_poet_1.code) `writer.${(0, types_1.toReaderCall)(field)}(${place}.toString())`;
+            }
+            else if ((0, types_1.isScalar)(field) || (0, types_1.isEnum)(field)) {
+                return (place) => (0, ts_poet_1.code) `writer.${(0, types_1.toReaderCall)(field)}(${place})`;
+            }
+            else if ((0, types_1.isObjectId)(field) && options.useMongoObjectId) {
+                const type = (0, types_1.basicTypeName)(ctx, field, { keepValueType: true });
+                return (place) => (0, ts_poet_1.code) `${type}.encode(${utils.toProtoObjectId}(${place}), writer.fork()).ldelim()`;
+            }
+            else if ((0, types_1.isTimestamp)(field) && (options.useDate === options_1.DateOption.DATE || options.useDate === options_1.DateOption.STRING)) {
+                const type = (0, types_1.basicTypeName)(ctx, field, { keepValueType: true });
+                return (place) => (0, ts_poet_1.code) `${type}.encode(${utils.toTimestamp}(${place}), writer.fork()).ldelim()`;
+            }
+            else if ((0, types_1.isValueType)(ctx, field)) {
+                const maybeTypeField = options.outputTypeAnnotations || options.outputTypeRegistry ? `$type: '${field.typeName.slice(1)}',` : "";
+                const type = (0, types_1.basicTypeName)(ctx, field, { keepValueType: true });
+                const wrappedValue = (place) => {
+                    if ((0, types_1.isAnyValueType)(field) || (0, types_1.isListValueType)(field) || (0, types_1.isStructType)(field) || (0, types_1.isFieldMaskType)(field)) {
+                        return (0, ts_poet_1.code) `${type}.wrap(${place})`;
+                    }
+                    return (0, ts_poet_1.code) `{${maybeTypeField} value: ${place}!}`;
+                };
+                return (place) => (0, ts_poet_1.code) `${type}.encode(${wrappedValue(place)}, writer.fork()).ldelim()`;
+            }
+            else if ((0, types_1.isMessage)(field)) {
+                const type = (0, types_1.basicTypeName)(ctx, field);
+                if (field.type == ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_GROUP) {
+                    const endTag = ((field.number << 3) | 4) >>> 0;
+                    return (place) => (0, ts_poet_1.code) `${type}.encode(${place}, writer).uint32(${endTag})`;
+                }
+                return (place) => (0, ts_poet_1.code) `${type}.encode(${place}, writer.fork()).ldelim()`;
+            }
+            else {
+                throw new Error(`Unhandled field ${field}`);
+            }
+        }
+        const writeSnippet = getEncodeSnippet(ctx, extension);
+        if ((0, types_1.isRepeated)(extension)) {
+            if (packedTag === undefined) {
+                chunks.push((0, ts_poet_1.code) `
+          for (const v of value) {
+            const writer = ${Writer}.create();
+            ${writeSnippet("v")};
+            encoded.push(writer.finish());
+          }
+        `);
+            }
+            else {
+                const rhs = (x) => (0, types_1.isLong)(extension) && ctx.options.forceLong === options_1.LongOption.BIGINT ? `${x}.toString()` : x;
+                chunks.push((0, ts_poet_1.code) `
+          const writer = ${Writer}.create();
+          writer.fork();
+          for (const v of value) {
+            ${writeSnippet(rhs("v"))};
+          }
+          writer.ldelim();
+          encoded.push(writer.finish());
+        `);
+            }
+        }
+        else if ((0, types_1.isScalar)(extension) || (0, types_1.isEnum)(extension)) {
+            chunks.push((0, ts_poet_1.code) `
+        if (${(0, types_1.notDefaultCheck)(ctx, extension, message === null || message === void 0 ? void 0 : message.options, "value")}) {
+          const writer = ${Writer}.create();
+          ${writeSnippet("value")};
+          encoded.push(writer.finish());
+        }
+      `);
+        }
+        else {
+            chunks.push((0, ts_poet_1.code) `
+        const writer = ${Writer}.create();
+        ${writeSnippet("value")};
+        encoded.push(writer.finish());
+      `);
+        }
+        chunks.push((0, ts_poet_1.code) `
+        return encoded;
+      },
+    `);
+    }
+    if (ctx.options.outputEncodeMethods === true || ctx.options.outputEncodeMethods === "decode-only") {
+        chunks.push((0, ts_poet_1.code) `decode: (tag: number, input: Uint8Array[]): ${type} => {`);
+        // get a generic 'reader.doSomething' bit that is specific to the basic type
+        const readSnippet = getDecodeReadSnippet(ctx, extension);
+        if ((0, types_1.isRepeated)(extension)) {
+            chunks.push((0, ts_poet_1.code) `const values: ${type} = [];`);
+            // start loop over all buffers
+            chunks.push((0, ts_poet_1.code) `
+        for (var buffer of input) {
+          const reader = ${Reader}.create(buffer);
+      `);
+            if ((0, types_1.packedType)(extension.type) === undefined) {
+                chunks.push((0, ts_poet_1.code) `
+          values.push(${readSnippet});
+        `);
+            }
+            else {
+                chunks.push((0, ts_poet_1.code) `
+          if (tag == ${packedTag}) {
+            const end2 = reader.uint32() + reader.pos;
+            while (reader.pos < end2) {
+              values.push(${readSnippet});
+            }
+          } else {
+            values.push(${readSnippet});
+          }
+        `);
+            }
+            chunks.push((0, ts_poet_1.code) `
+          }
+
+          return values;
+        },
+      `);
+        }
+        else {
+            // pick the last entry, since it overrides all previous entries if not repeated
+            chunks.push((0, ts_poet_1.code) `
+          const reader = ${Reader}.create(input[input.length -1]);
+          return ${readSnippet};
+        },
+      `);
+        }
+    }
+    chunks.push((0, ts_poet_1.code) `}`);
+    return {
+        name: (0, case_1.maybeSnakeToCamel)(extension.name, ctx.options),
+        type,
+        extensionInfo: (0, ts_poet_1.joinCode)(chunks, { on: "\n" }),
+    };
+}
 /**
  * Creates a function to decode a message from JSON.
  *
@@ -1113,7 +1387,7 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
     fromJSON(${messageDesc.field.length > 0 ? "object" : "_"}: any): ${fullName} {
       return {
   `);
-    if (ctx.options.outputTypeRegistry) {
+    if (ctx.options.outputTypeAnnotations || ctx.options.outputTypeRegistry) {
         chunks.push((0, 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));

package/build/options.js

@@ -49,6 +49,7 @@ function defaultOptions() {
         outputEncodeMethods: true,
         outputJsonMethods: true,
         outputPartialMethods: true,
+        outputTypeAnnotations: false,
         outputTypeRegistry: false,
         stringEnums: false,
         constEnums: false,
@@ -78,6 +79,7 @@ function defaultOptions() {
         useMapType: false,
         useReadonlyTypes: false,
         useSnakeTypeName: true,
+        outputExtensions: false,
         M: {},
     };
 }

package/build/types.js

@@ -571,14 +571,14 @@ function toModuleAndType(typeMap, protoType) {
 }
 function getEnumMethod(ctx, enumProtoType, methodSuffix) {
     const [module, type] = toModuleAndType(ctx.typeMap, enumProtoType);
-    return (0, utils_1.impProto)(ctx.options, module, `${(0, case_1.camelCase)(type)}${methodSuffix}`);
+    return (0, utils_1.impProto)(ctx.options, module, `${(0, case_1.uncapitalize)(type)}${methodSuffix}`);
 }
 exports.getEnumMethod = getEnumMethod;
 /** Return the TypeName for any field (primitive/message/etc.) as exposed in the interface. */
 function toTypeName(ctx, messageDesc, field) {
     let type = basicTypeName(ctx, field, { keepValueType: false });
     if (isRepeated(field)) {
-        const mapType = detectMapType(ctx, messageDesc, field);
+        const mapType = messageDesc ? detectMapType(ctx, messageDesc, field) : false;
         if (mapType) {
             const { keyType, valueType } = mapType;
             if (ctx.options.useMapType) {

package/build/utils.js

@@ -138,7 +138,8 @@ class FormattedMethodDescriptor {
     static formatName(methodName, options) {
         let result = methodName;
         if (options.lowerCaseServiceMethods || options.outputServices.includes(options_1.ServiceOption.GRPC)) {
-            result = (0, case_1.camelCaseGrpc)(result);
+            if (options.snakeToCamel)
+                result = (0, case_1.camelCaseGrpc)(result);
         }
         return result;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "1.145.0",
+  "version": "1.147.0",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",
@@ -65,7 +65,7 @@
     "object-hash": "^1.3.1",
     "protobufjs": "^6.11.3",
     "ts-poet": "^6.4.1",
-    "ts-proto-descriptors": "1.8.0"
+    "ts-proto-descriptors": "1.9.0"
   },
   "packageManager": "yarn@3.3.0"
 }