ts-proto 1.174.0 → 1.175.1

package/README.markdown

@@ -432,6 +432,8 @@ Generated code will be placed in the Gradle build directory.
 
 - 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=annotateFilesWithVersion=false`, the generated files will not contain the versions of `protoc` and `ts-proto` used to generate the file. This option is normally set to `true`, such that files list the versions used.
+
 - With `--ts_proto_opt=outputSchema=true`, meta typings will be generated that can later be used in other code generators.
 
 - With `--ts_proto_opt=outputTypeAnnotations=true`, each message will be given a `$type` field containing its fully-qualified name. You can use `--ts_proto_opt=outputTypeAnnotations=static-only` to omit it from the `interface` declaration, or `--ts_proto_opt=outputTypeAnnotations=optional` to make it an optional property on the `interface` definition. The latter option may be useful if you want to use the `$type` field for runtime type checking on responses from a server.
@@ -787,9 +789,7 @@ The following helper types may make it easier to work with the types generated f
 type OneOfCases<T> = T extends { $case: infer U extends string } ? U : never;
 
 /** Extracts a union of all the value types from a oneOf field */
-type OneOfValues<T> = T extends { $case: infer U extends string; [key: string]: unknown }
-  ? T[U]
-  : never;
+type OneOfValues<T> = T extends { $case: infer U extends string; [key: string]: unknown } ? T[U] : never;
 
 /** Extracts the specific type of a oneOf case based on its field name */
 type OneOfCase<T, K extends OneOfCases<T>> = T extends {

package/build/options.d.ts

@@ -95,6 +95,7 @@ export type Options = {
     disableProto2Optionals: boolean;
     disableProto2DefaultValues: boolean;
     useNullAsOptional: boolean;
+    annotateFilesWithVersion: boolean;
 };
 export declare function defaultOptions(): Options;
 export declare function optionsFromParameter(parameter: string | undefined): Options;

package/build/options.js

@@ -102,6 +102,7 @@ function defaultOptions() {
         disableProto2Optionals: false,
         disableProto2DefaultValues: false,
         useNullAsOptional: false,
+        annotateFilesWithVersion: true,
     };
 }
 exports.defaultOptions = defaultOptions;
@@ -252,10 +253,12 @@ function getTsPoetOpts(options, tsProtoVersion, protocVersion, fileName) {
         // Comment block at the top of every source file, since these comments require specific
         // syntax incompatible with ts-poet, we will hard-code the string and prepend to the
         // generator output.
-        prefix: `// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+        prefix: `// Code generated by protoc-gen-ts_proto. DO NOT EDIT.${options.annotateFilesWithVersion
+            ? `
 // versions:
 //   protoc-gen-ts_proto  ${tsProtoVersion}
-//   protoc               ${protocVersion}
+//   protoc               ${protocVersion}`
+            : ""}
 ${fileName ? `// source: ${fileName}` : ""}
 
     /* eslint-disable */`,

package/build/schema.js

@@ -188,13 +188,30 @@ function encodedOptionsToOptions(ctx, extendee, encodedOptions) {
     for (const key in encodedOptions) {
         const value = encodedOptions[key];
         const extension = extensionCache[extendee][parseInt(key, 10) >>> 3];
-        resultOptions.push(getExtensionValue(ctx, extension, value));
+        if (shouldAddOptionDefinition(ctx, extension)) {
+            // todo: we should be able to create an option definition ALWAYS, however,
+            // we currently cannot do that because the if the extension is a sub-message
+            // (and thus, not just a straightforward value), we don't have an JSON object
+            // representation of the option - just it's encoded value. Our approach in
+            // getExtensionValue is to decode the encoded value into a message, but this
+            // Message.decode(...) method is not always included in the generated code.
+            // We should fix this so that we can always create an option definition by
+            // somehow premptively decoding the encoded value and then inserting it into
+            // the option defintion.
+            // please refer to inteegration/options-types-only to see this in action
+            resultOptions.push(getExtensionValue(ctx, extension, value));
+        }
     }
     if (resultOptions.length == 0) {
         return undefined;
     }
     return (0, ts_poet_1.code) `{${(0, ts_poet_1.joinCode)(resultOptions, { on: "," })}}`;
 }
+function shouldAddOptionDefinition(ctx, extension) {
+    return (extension.type !== ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_MESSAGE ||
+        ctx.options.outputEncodeMethods === true ||
+        ctx.options.outputEncodeMethods == "decode-only");
+}
 function resolveMessageOptions(ctx, message) {
     const fieldsOptions = [];
     message.field.forEach((field) => {

package/package.json

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