ts-proto 2.0.4 → 2.1.0

package/README.markdown

@@ -454,7 +454,11 @@ 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. 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=outputSchema=true`, meta typings will be generated that can later be used in other code generators.
+
+- With `--ts_proto_opt=outputSchema=no-file-descriptor`, meta typings will be generated, but 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=outputSchema=const`, meta typings will be generated `as const`, allowing type-safe access to all its properties. (only works with TypeScript 4.9 and up, because it also uses the [`satisfies`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-9.html#the-satisfies-operator) operator). Can be combined with the `no-file-descriptor` option (`outputSchema=const,outputSchema=no-file-descriptor`) to not include the file descriptor in 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.
 

package/build/src/options.d.ts

@@ -32,6 +32,11 @@ export declare enum ServiceOption {
     DEFAULT = "default",
     NONE = "none"
 }
+export declare enum OutputSchemaOption {
+    TRUE = "true",
+    NO_FILE_DESCRIPTOR = "no-file-descriptor",
+    CONST = "const"
+}
 export type Options = {
     context: boolean;
     snakeToCamel: Array<"json" | "keys">;
@@ -69,7 +74,7 @@ export type Options = {
     unrecognizedEnumName: string;
     unrecognizedEnumValue: number;
     exportCommonSymbols: boolean;
-    outputSchema: boolean | "no-file-descriptor";
+    outputSchema: false | OutputSchemaOption[];
     onlyTypes: boolean;
     emitImportedFiles: boolean;
     useAbortSignal: boolean;

package/build/src/options.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ServiceOption = exports.OneofOption = exports.EnvOption = exports.JsonTimestampOption = exports.DateOption = exports.LongOption = void 0;
+exports.OutputSchemaOption = exports.ServiceOption = exports.OneofOption = exports.EnvOption = exports.JsonTimestampOption = exports.DateOption = exports.LongOption = void 0;
 exports.defaultOptions = defaultOptions;
 exports.optionsFromParameter = optionsFromParameter;
 exports.getTsPoetOpts = getTsPoetOpts;
@@ -44,6 +44,12 @@ var ServiceOption;
     ServiceOption["DEFAULT"] = "default";
     ServiceOption["NONE"] = "none";
 })(ServiceOption || (exports.ServiceOption = ServiceOption = {}));
+var OutputSchemaOption;
+(function (OutputSchemaOption) {
+    OutputSchemaOption["TRUE"] = "true";
+    OutputSchemaOption["NO_FILE_DESCRIPTOR"] = "no-file-descriptor";
+    OutputSchemaOption["CONST"] = "const";
+})(OutputSchemaOption || (exports.OutputSchemaOption = OutputSchemaOption = {}));
 function defaultOptions() {
     return {
         context: false,
@@ -165,6 +171,13 @@ function optionsFromParameter(parameter) {
     if (options.nestJs && options.outputServices.length > 0) {
         options.outputEncodeMethods = true;
     }
+    // Handle outputSchema=true
+    if (options.outputSchema === true) {
+        options.outputSchema = [];
+    }
+    if (typeof options.outputSchema === "string") {
+        options.outputSchema = [options.outputSchema];
+    }
     if (options.useDate === true) {
         // Treat useDate=true as DATE
         options.useDate = DateOption.DATE;

package/build/src/schema.js

@@ -7,6 +7,7 @@ const visit_1 = require("./visit");
 const utils_1 = require("./utils");
 const types_1 = require("./types");
 const wire_1 = require("@bufbuild/protobuf/wire");
+const options_1 = require("./options");
 const fileDescriptorProto = (0, ts_poet_1.imp)("FileDescriptorProto@ts-proto-descriptors");
 const extensionCache = {};
 function generateSchema(ctx, fileDesc, sourceInfo) {
@@ -18,6 +19,9 @@ function generateSchema(ctx, fileDesc, sourceInfo) {
         }
         extensionCache[extension.extendee][extension.number] = extension;
     });
+    const outputSchemaOptions = ctx.options.outputSchema ? ctx.options.outputSchema : [];
+    const outputFileDescriptor = !outputSchemaOptions.includes(options_1.OutputSchemaOption.NO_FILE_DESCRIPTOR);
+    const outputAsConst = outputSchemaOptions.includes(options_1.OutputSchemaOption.CONST);
     chunks.push((0, ts_poet_1.code) `
     type ProtoMetaMessageOptions = {
       options?: { [key: string]: any };
@@ -27,7 +31,7 @@ function generateSchema(ctx, fileDesc, sourceInfo) {
     };
 
     export interface ProtoMetadata {
-      ${ctx.options.outputSchema !== "no-file-descriptor" ? (0, ts_poet_1.code) `fileDescriptor: ${fileDescriptorProto};\n` : ""}references: { [key: string]: any };
+      ${outputFileDescriptor ? (0, ts_poet_1.code) `fileDescriptor: ${fileDescriptorProto};\n` : ""}references: { [key: string]: any };
       dependencies?: ProtoMetadata[];
       options?: {
         options?: { [key: string]: any };
@@ -106,7 +110,7 @@ function generateSchema(ctx, fileDesc, sourceInfo) {
         if (methodsOptions.length > 0 || serviceOptions) {
             servicesOptions.push((0, ts_poet_1.code) `
         '${service.name}': {
-          options: ${serviceOptions},
+          ${serviceOptions ? (0, ts_poet_1.code) `options: ${serviceOptions},` : ""}
           methods: {${(0, ts_poet_1.joinCode)(methodsOptions, { on: "," })}}
         }
       `);
@@ -132,17 +136,17 @@ function generateSchema(ctx, fileDesc, sourceInfo) {
         if (valuesOptions.length > 0 || enumOptions) {
             enumsOptions.push((0, ts_poet_1.code) `
         '${Enum.name}': {
-          options: ${enumOptions},
+          ${enumOptions ? (0, ts_poet_1.code) `options: ${enumOptions},` : ""}
           values: {${(0, ts_poet_1.joinCode)(valuesOptions, { on: "," })}}
         }
       `);
         }
     });
     chunks.push((0, ts_poet_1.code) `
-    export const ${(0, ts_poet_1.def)("protoMetadata")}: ProtoMetadata = {
-      ${ctx.options.outputSchema !== "no-file-descriptor"
-        ? (0, ts_poet_1.code) `fileDescriptor: ${fileDescriptorProto}.fromPartial(${descriptor}),\n`
-        : ""}references: { ${(0, ts_poet_1.joinCode)(references, { on: "," })} },
+    export const ${(0, ts_poet_1.def)("protoMetadata")}${outputAsConst ? "" : ": ProtoMetadata"} = {
+      ${outputFileDescriptor ? (0, ts_poet_1.code) `fileDescriptor: ${descriptor},\n` : ""}references: { ${(0, ts_poet_1.joinCode)(references, {
+        on: ",",
+    })} },
       dependencies: [${(0, ts_poet_1.joinCode)(dependencies, { on: "," })}],
       ${fileOptions || messagesOptions.length > 0 || servicesOptions.length > 0 || enumsOptions.length > 0
         ? (0, ts_poet_1.code) `options: {
@@ -152,7 +156,7 @@ function generateSchema(ctx, fileDesc, sourceInfo) {
           ${enumsOptions.length > 0 ? (0, ts_poet_1.code) `enums: {${(0, ts_poet_1.joinCode)(enumsOptions, { on: "," })}}` : ""}
         }`
         : ""}
-    }
+    }${outputAsConst ? " as const satisfies ProtoMetadata" : ""}
   `);
     return chunks;
 }

package/package.json

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