feat: no-file-descriptor setting for outputSchema option (#1047)

README.markdown

@@ -434,7 +434,7 @@ Generated code will be placed in the Gradle build directory.
 
 - 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=outputSchema=true`, meta typings will be generated that can later be used in other code generators. If outputSchema is instead specified to be `no-file-descriptor` then we do not include the file descriptor in the generated schema. This is useful if you are trying to minimize the size of the generated schema.
 
 - 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.
 

integration/schema-no-file-descriptor/const-enum.proto

@@ -0,0 +1,13 @@
+syntax = "proto3";
+
+message DividerData {
+    enum DividerType {
+        DOUBLE = 0;
+        SINGLE = 1;
+        DASHED = 2;
+        DOTTED = 3;
+    }
+
+    DividerType type = 1;
+    map<string, DividerType> typeMap = 2;
+}

integration/schema-no-file-descriptor/parameters.txt

@@ -0,0 +1 @@
+outputSchema=no-file-descriptor

integration/schema-no-file-descriptor/schema-no-file-descriptor-test.ts

@@ -0,0 +1,8 @@
+import { protoMetadata } from "./const-enum";
+
+describe("schema-no-file-descriptor", () => {
+  test("the property doesn't exist", () => {
+    expect(protoMetadata).not.toHaveProperty("fileDescriptor");
+    expect(protoMetadata).toHaveProperty("references");
+  });
+});

src/options.ts

@@ -75,7 +75,7 @@ export type Options = {
   unrecognizedEnumName: string;
   unrecognizedEnumValue: number;
   exportCommonSymbols: boolean;
-  outputSchema: boolean;
+  outputSchema: boolean | "no-file-descriptor";
   onlyTypes: boolean;
   emitImportedFiles: boolean;
   useAbortSignal: boolean;

src/schema.ts

@@ -36,8 +36,9 @@ export function generateSchema(ctx: Context, fileDesc: FileDescriptorProto, sour
     };
 
     export interface ProtoMetadata {
-      fileDescriptor: ${fileDescriptorProto};
-      references: { [key: string]: any };
+      ${
+        ctx.options.outputSchema !== "no-file-descriptor" ? code`fileDescriptor: ${fileDescriptorProto};\n` : ""
+      }references: { [key: string]: any };
       dependencies?: ProtoMetadata[];
       options?: {
         options?: { [key: string]: any };
@@ -181,8 +182,11 @@ export function generateSchema(ctx: Context, fileDesc: FileDescriptorProto, sour
 
   chunks.push(code`
     export const ${def("protoMetadata")}: ProtoMetadata = {
-      fileDescriptor: ${fileDescriptorProto}.fromPartial(${descriptor}),
-      references: { ${joinCode(references, { on: "," })} },
+      ${
+        ctx.options.outputSchema !== "no-file-descriptor"
+          ? code`fileDescriptor: ${fileDescriptorProto}.fromPartial(${descriptor}),\n`
+          : ""
+      }references: { ${joinCode(references, { on: "," })} },
       dependencies: [${joinCode(dependencies, { on: "," })}],
       ${
         fileOptions || messagesOptions.length > 0 || servicesOptions.length > 0 || enumsOptions.length > 0