ts-proto 1.173.0 → 1.175.0

package/README.markdown

@@ -305,6 +305,8 @@ Generated code will be placed in the Gradle build directory.
 
   The default behavior is `forceLong=number`, which will internally still use the `long` library to encode/decode values on the wire (so you will still see a `util.Long = Long` line in your output), but will convert the `long` values to `number` automatically for you. Note that a runtime error is thrown if, while doing this conversion, a 64-bit value is larger than can be correctly stored as a `number`.
 
+- With `--ts_proto_opt=useJsTypeOverride`, 64-bit numbers will be ouput as the [FieldOption.JSType](https://protobuf.dev/reference/java/api-docs/com/google/protobuf/DescriptorProtos.FieldOptions.JSType) specified on the field. This takes precendence over the `forceLong` option provided.
+
 - With `--ts_proto_opt=esModuleInterop=true` changes output to be `esModuleInterop` compliant.
 
   Specifically the `Long` imports will be generated as `import Long from 'long'` instead of `import * as Long from 'long'`.
@@ -430,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.
@@ -785,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,8 +95,9 @@ export type Options = {
     disableProto2Optionals: boolean;
     disableProto2DefaultValues: boolean;
     useNullAsOptional: boolean;
+    annotateFilesWithVersion: boolean;
 };
 export declare function defaultOptions(): Options;
 export declare function optionsFromParameter(parameter: string | undefined): Options;
-export declare function getTsPoetOpts(options: Options): ToStringOpts;
+export declare function getTsPoetOpts(options: Options, tsProtoVersion: string, protocVersion: string, fileName?: string): ToStringOpts;
 export declare function addTypeToMessages(options: Options): boolean;

package/build/options.js

@@ -102,6 +102,7 @@ function defaultOptions() {
         disableProto2Optionals: false,
         disableProto2DefaultValues: false,
         useNullAsOptional: false,
+        annotateFilesWithVersion: true,
     };
 }
 exports.defaultOptions = defaultOptions;
@@ -245,11 +246,22 @@ function parseParameter(parameter) {
 function parseParamValue(value) {
     return value === "true" ? true : value === "false" ? false : value;
 }
-function getTsPoetOpts(options) {
+function getTsPoetOpts(options, tsProtoVersion, protocVersion, fileName) {
     const { importSuffix, esModuleInterop } = options;
     const pbjs = "protobufjs/minimal" + importSuffix;
     return {
-        prefix: `/* eslint-disable */`,
+        // 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.${options.annotateFilesWithVersion
+            ? `
+// versions:
+//   protoc-gen-ts_proto  ${tsProtoVersion}
+//   protoc               ${protocVersion}`
+            : ""}
+${fileName ? `// source: ${fileName}` : ""}
+
+    /* eslint-disable */`,
         dprintOptions: { preferSingleLine: true, lineWidth: 120 },
         forceRequireImport: esModuleInterop ? [] : ["long"],
         forceDefaultImport: esModuleInterop ? [pbjs] : [],

package/build/plugin.js

@@ -14,6 +14,7 @@ async function main() {
     // const json = JSON.parse(stdin.toString());
     // const request = CodeGeneratorRequest.fromObject(json);
     const request = ts_proto_descriptors_1.CodeGeneratorRequest.decode(stdin);
+    const { protocVersion, tsProtoVersion } = await (0, utils_1.getVersions)(request);
     const options = (0, options_1.optionsFromParameter)(request.parameter);
     const typeMap = (0, types_1.createTypeMap)(request, options);
     const utils = (0, main_1.makeUtils)(options);
@@ -42,7 +43,7 @@ async function main() {
     }
     const files = await Promise.all(filesToGenerate.map(async (file) => {
         const [path, code] = (0, main_1.generateFile)({ ...ctx, currentFile: (0, context_1.createFileContext)(file) }, file);
-        const content = code.toString({ ...(0, options_1.getTsPoetOpts)(options), path });
+        const content = code.toString({ ...(0, options_1.getTsPoetOpts)(options, tsProtoVersion, protocVersion, file.name), path });
         return { name: path, content };
     }));
     if (options.outputTypeRegistry) {
@@ -50,12 +51,12 @@ async function main() {
         const ctx = { options, typeMap, utils };
         const path = "typeRegistry.ts";
         const code = (0, generate_type_registry_1.generateTypeRegistry)(ctx);
-        const content = code.toString({ ...(0, options_1.getTsPoetOpts)(options), path });
+        const content = code.toString({ ...(0, options_1.getTsPoetOpts)(options, tsProtoVersion, protocVersion), path });
         files.push({ name: path, content });
     }
     if (options.outputIndex) {
         for (const [path, code] of (0, utils_1.generateIndexFiles)(filesToGenerate, options)) {
-            const content = code.toString({ ...(0, options_1.getTsPoetOpts)(options), path });
+            const content = code.toString({ ...(0, options_1.getTsPoetOpts)(options, tsProtoVersion, protocVersion), path });
             files.push({ name: path, content });
         }
     }

package/build/utils.d.ts

@@ -14,7 +14,6 @@ export declare function lowerFirst(name: string): string;
 export declare function upperFirst(name: string): string;
 /** Removes potentially harmful characters from comments and pushes it into chunks. */
 export declare function maybeAddComment(options: Pick<Options, "comments">, desc: Partial<Pick<SourceDescription, "leadingComments" | "trailingComments">>, chunks: Code[], deprecated?: boolean, prefix?: string): void;
-export declare function prefixDisableLinter(spec: string): string;
 export declare function maybePrefixPackage(fileDesc: FileDescriptorProto, rest: string): string;
 /**
  * Asserts that an object is an instance of a certain class
@@ -78,3 +77,7 @@ export declare function withOrMaybeCheckIsNotNull(options: Pick<Options, "useNul
 export declare function withOrMaybeCheckIsNull(options: Pick<Options, "useNullAsOptional">, typeName: string): string;
 export declare function withAndMaybeCheckIsNotNull(options: Pick<Options, "useNullAsOptional">, typeName: string): string;
 export declare function withAndMaybeCheckIsNull(options: Pick<Options, "useNullAsOptional">, typeName: string): string;
+export declare function getVersions(request: CodeGeneratorRequest): Promise<{
+    protocVersion: string;
+    tsProtoVersion: string;
+}>;

package/build/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.withAndMaybeCheckIsNull = exports.withAndMaybeCheckIsNotNull = exports.withOrMaybeCheckIsNull = exports.withOrMaybeCheckIsNotNull = exports.maybeCheckIsNull = exports.maybeCheckIsNotNull = exports.nullOrUndefined = exports.arrowFunction = exports.tryCatchBlock = exports.impProto = exports.impFile = exports.getPropertyAccessor = exports.safeAccessor = exports.getFieldName = exports.getFieldJsonName = exports.FormattedMethodDescriptor = exports.assertInstanceOf = exports.maybePrefixPackage = exports.prefixDisableLinter = exports.maybeAddComment = exports.upperFirst = exports.lowerFirst = exports.singular = exports.fail = exports.readToBuffer = exports.generateIndexFiles = exports.protoFilesToGenerate = void 0;
+exports.getVersions = exports.withAndMaybeCheckIsNull = exports.withAndMaybeCheckIsNotNull = exports.withOrMaybeCheckIsNull = exports.withOrMaybeCheckIsNotNull = exports.maybeCheckIsNull = exports.maybeCheckIsNotNull = exports.nullOrUndefined = exports.arrowFunction = exports.tryCatchBlock = exports.impProto = exports.impFile = exports.getPropertyAccessor = exports.safeAccessor = exports.getFieldName = exports.getFieldJsonName = exports.FormattedMethodDescriptor = exports.assertInstanceOf = exports.maybePrefixPackage = exports.maybeAddComment = exports.upperFirst = exports.lowerFirst = exports.singular = exports.fail = exports.readToBuffer = exports.generateIndexFiles = exports.protoFilesToGenerate = void 0;
 const path = require("path");
 const ts_poet_1 = require("ts-poet");
 const options_1 = require("./options");
@@ -116,13 +116,6 @@ function maybeAddComment(options, desc, chunks, deprecated, prefix = "") {
     }
 }
 exports.maybeAddComment = maybeAddComment;
-// 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.
-function prefixDisableLinter(spec) {
-    return `/* eslint-disable */\n${spec}`;
-}
-exports.prefixDisableLinter = prefixDisableLinter;
 function maybePrefixPackage(fileDesc, rest) {
     const prefix = fileDesc.package === "" ? "" : `${fileDesc.package}.`;
     return `${prefix}${rest}`;
@@ -289,3 +282,19 @@ function withAndMaybeCheckIsNull(options, typeName) {
     return maybeCheckIsNotNull(options, typeName, "&&");
 }
 exports.withAndMaybeCheckIsNull = withAndMaybeCheckIsNull;
+async function getVersions(request) {
+    var _a;
+    let protocVersion = "unknown";
+    if (request.compilerVersion) {
+        const { major, minor, patch } = request.compilerVersion;
+        protocVersion = `v${major}.${minor}.${patch}`;
+    }
+    const path = "../package.json";
+    const packageJson = await Promise.resolve(`${path}`).then(s => require(s));
+    const tsProtoVersion = `v${(_a = packageJson === null || packageJson === void 0 ? void 0 : packageJson.version) !== null && _a !== void 0 ? _a : "unknown"}`;
+    return {
+        protocVersion,
+        tsProtoVersion,
+    };
+}
+exports.getVersions = getVersions;

package/package.json

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