ts-proto 1.95.1 → 1.96.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.96.0](https://github.com/stephenh/ts-proto/compare/v1.95.1...v1.96.0) (2021-12-24)
+
+
+### Features
+
+* `enumsAsLiterals` option ([#450](https://github.com/stephenh/ts-proto/issues/450)) ([fcaade2](https://github.com/stephenh/ts-proto/commit/fcaade2855ae28ea3553a365556ccb92a9644d70))
+
 ## [1.95.1](https://github.com/stephenh/ts-proto/compare/v1.95.0...v1.95.1) (2021-12-23)
 
 

package/README.markdown

@@ -348,6 +348,8 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=fileSuffix=<SUFFIX>`, ts-proto will emit generated files using the specified suffix. A `helloworld.proto` file with `fileSuffix=.pb` would be generated as `helloworld.pb.ts`. This is common behavior in other protoc plugins and provides a way to quickly glob all the generated files. 
 
+- With `--ts_proto_opt=enumsAsLiterals=true`, the generated enum types will be enum-ish object with `as const`.
+
 ### Only Types
 
 If you're looking for `ts-proto` to generate only types for your Protobuf types then passing all three of `outputEncodeMethods`, `outputJsonMethods`, and `outputClientImpl` as `false` is probably what you want, i.e.:

package/build/enums.js

@@ -13,17 +13,30 @@ function generateEnum(ctx, fullName, enumDesc, sourceInfo) {
     const { options } = ctx;
     const chunks = [];
     utils_1.maybeAddComment(sourceInfo, chunks, (_a = enumDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
-    chunks.push(ts_poet_1.code `export ${options.constEnums ? 'const ' : ''}enum ${ts_poet_1.def(fullName)} {`);
+    if (options.enumsAsLiterals) {
+        chunks.push(ts_poet_1.code `export const ${ts_poet_1.def(fullName)} = {`);
+    }
+    else {
+        chunks.push(ts_poet_1.code `export ${options.constEnums ? 'const ' : ''}enum ${ts_poet_1.def(fullName)} {`);
+    }
+    const delimiter = options.enumsAsLiterals ? ':' : '=';
     enumDesc.value.forEach((valueDesc, index) => {
         var _a;
         const info = sourceInfo.lookup(sourceInfo_1.Fields.enum.value, index);
         utils_1.maybeAddComment(info, chunks, (_a = valueDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated, `${valueDesc.name} - `);
-        chunks.push(ts_poet_1.code `${valueDesc.name} = ${options.stringEnums ? `"${valueDesc.name}"` : valueDesc.number.toString()},`);
+        chunks.push(ts_poet_1.code `${valueDesc.name} ${delimiter} ${options.stringEnums ? `"${valueDesc.name}"` : valueDesc.number.toString()},`);
     });
     if (options.unrecognizedEnum)
         chunks.push(ts_poet_1.code `
-      ${UNRECOGNIZED_ENUM_NAME} = ${options.stringEnums ? `"${UNRECOGNIZED_ENUM_NAME}"` : UNRECOGNIZED_ENUM_VALUE.toString()},`);
-    chunks.push(ts_poet_1.code `}`);
+      ${UNRECOGNIZED_ENUM_NAME} ${delimiter} ${options.stringEnums ? `"${UNRECOGNIZED_ENUM_NAME}"` : UNRECOGNIZED_ENUM_VALUE.toString()},`);
+    if (options.enumsAsLiterals) {
+        chunks.push(ts_poet_1.code `} as const`);
+        chunks.push(ts_poet_1.code `\n`);
+        chunks.push(ts_poet_1.code `export type ${ts_poet_1.def(fullName)} = typeof ${ts_poet_1.def(fullName)}[keyof typeof ${ts_poet_1.def(fullName)}]`);
+    }
+    else {
+        chunks.push(ts_poet_1.code `}`);
+    }
     if (options.outputJsonMethods || (options.stringEnums && options.outputEncodeMethods)) {
         chunks.push(ts_poet_1.code `\n`);
         chunks.push(generateEnumFromJson(ctx, fullName, enumDesc));

package/build/options.js

@@ -48,6 +48,7 @@ function defaultOptions() {
         outputTypeRegistry: false,
         stringEnums: false,
         constEnums: false,
+        enumsAsLiterals: false,
         outputClientImpl: true,
         outputServices: ServiceOption.DEFAULT,
         returnObservable: false,

package/package.json

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