feat: added the exportTypeRegistry option.

README.markdown

@@ -555,6 +555,8 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=useNullAsOptional=true`, `undefined` values will be converted to `null`, and if you use `optional` label in your `.proto` file, the field will have `undefined` type as well. for example:
 
+- With `--ts_proto_opt=exportTypeRegistry=true`, the generated `index.ts` will export the `typeRegistry.ts` file, only if `outputTypeRegistry=true`.
+
 ```protobuf
 message ProfileInfo {
  int32 id = 1;

src/options.ts

@@ -104,6 +104,7 @@ export type Options = {
  annotateFilesWithVersion: boolean;
  noDefaultsForOptionals: boolean;
  bigIntLiteral: boolean;
+ exportTypeRegistry: boolean;
 };
 
 export function defaultOptions(): Options {
@@ -172,6 +173,7 @@ export function defaultOptions(): Options {
  annotateFilesWithVersion: true,
  noDefaultsForOptionals: false,
  bigIntLiteral: true,
+ exportTypeRegistry: false,
  };
 }
 
@@ -286,6 +288,10 @@ export function optionsFromParameter(parameter: string | undefined): Options {
  options.unrecognizedEnumValue = Number(options.unrecognizedEnumValue);
  }
 
+ if (!options.outputTypeRegistry) {
+ options.exportTypeRegistry = false;
+ }
+
  return options;
 }
 

src/plugin.ts

@@ -5,7 +5,7 @@ import {
  FileDescriptorProto,
 } from "ts-proto-descriptors";
 import { promisify } from "util";
-import { generateIndexFiles, getVersions, protoFilesToGenerate, readToBuffer } from "./utils";
+import { generateIndexFiles, getVersions, protoFilesToGenerate, readToBuffer, TYPE_REGISTRY_FILENAME } from "./utils";
 import { generateFile, makeUtils } from "./main";
 import { createTypeMap } from "./types";
 import { BaseContext, createFileContext } from "./context";
@@ -60,11 +60,13 @@ async function main() {
  const utils = makeUtils(options);
  const ctx: BaseContext = { options, typeMap, utils };
 
- const path = "typeRegistry.ts";
  const code = generateTypeRegistry(ctx);
 
- const content = code.toString({ ...getTsPoetOpts(options, tsProtoVersion, protocVersion), path });
- files.push({ name: path, content });
+ const content = code.toString({
+ ...getTsPoetOpts(options, tsProtoVersion, protocVersion),
+ path: TYPE_REGISTRY_FILENAME,
+ });
+ files.push({ name: TYPE_REGISTRY_FILENAME, content });
  }
 
  if (options.outputIndex) {
@@ -93,3 +95,5 @@ main()
  process.stderr.write(e.stack);
  process.exit(1);
  });
+
+export { TYPE_REGISTRY_FILENAME };

src/utils.ts

@@ -12,6 +12,8 @@ import { SourceDescription } from "./sourceInfo";
 import { OneofOption, Options, ServiceOption } from "./options";
 import { camelCaseGrpc, maybeSnakeToCamel, snakeToCamel } from "./case";
 
+export const TYPE_REGISTRY_FILENAME: string = "typeRegistry.ts";
+
 export function protoFilesToGenerate(request: CodeGeneratorRequest): FileDescriptorProto[] {
  return request.protoFile.filter((f) => request.fileToGenerate.includes(f.name));
 }
@@ -47,6 +49,10 @@ export function generateIndexFiles(files: FileDescriptorProto[], options: Option
  branch.chunks.push(code`export * from "./${moduleName + options.importSuffix}";`);
  }
 
+ if (options.exportTypeRegistry) {
+ packageTree.chunks.push(code`export * from "./${TYPE_REGISTRY_FILENAME}";`);
+ }
+
  const indexFiles: [string, Code][] = [];
  let branches: PackageTree[] = [packageTree];
  let currentBranch;

tests/options-test.ts

@@ -20,6 +20,7 @@ describe("options", () => {
  "env": "both",
  "esModuleInterop": false,
  "exportCommonSymbols": true,
+ "exportTypeRegistry": false,
  "fileSuffix": "",
  "forceLong": "number",
  "globalThisPolyfill": false,