ts-proto 1.152.0 → 1.153.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "1.152.0",
+  "version": "1.153.0",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",
@@ -16,7 +16,7 @@
     "proto2pbjs": "docker compose run --rm protoc pbjs.sh",
     "bin2ts": "docker compose run --rm protoc codegen.sh",
     "test": "yarn jest -c jest.config.js --maxWorkers=2",
-    "tsc:check": "./tsc-check.sh tsconfig.json integration/tsconfig.json integration/tsconfig.proto.json protos/tsconfig.json",
+    "tsc:check": "./tsc-check.sh tsconfig.json tests/tsconfig.json integration/tsconfig.json integration/tsconfig.proto.json protos/tsconfig.json",
     "format": "prettier --write {src,tests}/**/*.ts integration/*.ts",
     "format:check": "prettier --list-different {src,tests}/**/*.ts",
     "setup:docker": "docker compose build",
@@ -30,7 +30,7 @@
   "license": "ISC",
   "devDependencies": {
     "@grpc/grpc-js": "^1.8.14",
-    "@grpc/proto-loader": "^0.6.13",
+    "@grpc/proto-loader": "^0.7.7",
     "@improbable-eng/grpc-web": "^0.14.0",
     "@improbable-eng/grpc-web-node-http-transport": "^0.14.0",
     "@nestjs/common": "^9.4.2",
@@ -52,6 +52,7 @@
     "mongodb": "^4.3.0",
     "nice-grpc": "^2.1.4",
     "prettier": "^2.8.8",
+    "protobufjs-cli": "^1.1.1",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.4.0",
     "semantic-release": "^21.0.3",
@@ -65,7 +66,7 @@
     "case-anything": "^2.1.10",
     "dataloader": "^1.4.0",
     "object-hash": "^3.0.0",
-    "protobufjs": "^6.11.3",
+    "protobufjs": "^7.2.4",
     "ts-poet": "^6.4.1",
     "ts-proto-descriptors": "1.9.0"
   },

package/build/integration/codegen.js

@@ -1,63 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ts_proto_descriptors_1 = require("ts-proto-descriptors");
-const fs_1 = require("fs");
-const path_1 = require("path");
-const util_1 = require("util");
-const main_1 = require("../src/main");
-const types_1 = require("../src/types");
-const utils_1 = require("../src/utils");
-const options_1 = require("../src/options");
-const generate_type_registry_1 = require("../src/generate-type-registry");
-/**
- * Generates output for our integration tests from their example proto files.
- *
- * We use snapshots of the protoc CodeGeneratorRequest's that are captured
- * by running ./update_proto_bins.sh, just because various machines/CI/etc
- * may not have the `protoc` compiler on their path.
- */
-async function main() {
-    const dir = process.argv[2];
-    const file = process.argv[3];
-    const param = process.argv[4];
-    await generate(file, dir, param);
-}
-async function generate(binFile, baseDir, parameter) {
-    const stdin = await (0, util_1.promisify)(fs_1.readFile)(binFile);
-    const request = ts_proto_descriptors_1.CodeGeneratorRequest.decode(stdin);
-    request.parameter = parameter;
-    const options = (0, options_1.optionsFromParameter)(parameter || "");
-    const typeMap = (0, types_1.createTypeMap)(request, options);
-    for (let file of request.protoFile) {
-        // Make a different utils per file to track per-file usage
-        if (options.M[file.name]) {
-            continue;
-        }
-        const utils = (0, main_1.makeUtils)(options);
-        const ctx = { options, typeMap, utils };
-        const [path, code] = (0, main_1.generateFile)(ctx, file);
-        const filePath = `${baseDir}/${path}`;
-        const dirPath = (0, path_1.parse)(filePath).dir;
-        await (0, util_1.promisify)(fs_1.mkdir)(dirPath, { recursive: true }).catch(() => { });
-        await (0, util_1.promisify)(fs_1.writeFile)(filePath, code.toString({ ...(0, options_1.getTsPoetOpts)(options), path }));
-    }
-    if (options.outputTypeRegistry) {
-        const utils = (0, main_1.makeUtils)(options);
-        const ctx = { options, typeMap, utils };
-        const path = "typeRegistry.ts";
-        const code = (0, generate_type_registry_1.generateTypeRegistry)(ctx);
-        const filePath = `${baseDir}/${path}`;
-        await (0, util_1.promisify)(fs_1.writeFile)(filePath, code.toString({ ...(0, options_1.getTsPoetOpts)(options), path }));
-    }
-    if (options.outputIndex) {
-        for (const [path, code] of (0, utils_1.generateIndexFiles)(request.protoFile, options)) {
-            const filePath = `${baseDir}/${path}`;
-            const dirPath = (0, path_1.parse)(filePath).dir;
-            await (0, util_1.promisify)(fs_1.mkdir)(dirPath, { recursive: true }).catch(() => { });
-            await (0, util_1.promisify)(fs_1.writeFile)(filePath, code.toString({ ...(0, options_1.getTsPoetOpts)(options), path }));
-        }
-    }
-}
-main().then(() => {
-    console.log(`${process.argv[3]}: Done`);
-});

package/build/tests/case-test.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const case_1 = require("../src/case");
-const options_1 = require("../src/options");
-const utils_1 = require("../src/utils");
-const keys = (0, options_1.optionsFromParameter)("snakeToCamel=keys");
-describe("case", () => {
-    it("converts snake to camel by default", () => {
-        expect((0, case_1.maybeSnakeToCamel)("foo_bar", (0, options_1.optionsFromParameter)(undefined))).toEqual("fooBar");
-    });
-    it("leaves as-is if snakeToCamel is false", () => {
-        expect((0, case_1.maybeSnakeToCamel)("foo_bar", (0, options_1.optionsFromParameter)("snakeToCamel=false"))).toEqual("foo_bar");
-    });
-    it("de-upper cases", () => {
-        expect((0, case_1.maybeSnakeToCamel)("FOO_BAR", keys)).toEqual("fooBar");
-    });
-    it("leaves existing mixed cases", () => {
-        expect((0, case_1.maybeSnakeToCamel)("clientI_d", keys)).toEqual("clientID");
-        expect((0, case_1.maybeSnakeToCamel)("menu_calendarI_d", keys)).toEqual("menuCalendarID");
-        expect((0, case_1.maybeSnakeToCamel)("display_nameI18n", keys)).toEqual("displayNameI18n");
-    });
-    it("leaves the first character as it was", () => {
-        expect((0, case_1.maybeSnakeToCamel)("Foo_Bar", keys)).toEqual("FooBar");
-    });
-    it("does nothing is already camel", () => {
-        expect((0, case_1.maybeSnakeToCamel)("FooBar", keys)).toEqual("FooBar");
-    });
-    // deal with original protoc which converts
-    // _uuid -> Uuid
-    // __uuid -> Uuid
-    // _uuid_foo -> UuidFoo
-    it("converts snake to camel with first underscore", () => {
-        expect((0, case_1.maybeSnakeToCamel)("_uuid", { snakeToCamel: ["keys"] })).toEqual("Uuid");
-    });
-    it("converts snake to camel with first double underscore", () => {
-        expect((0, case_1.maybeSnakeToCamel)("__uuid", { snakeToCamel: ["keys"] })).toEqual("Uuid");
-    });
-    it("converts snake to camel with first underscore and camelize other", () => {
-        expect((0, case_1.maybeSnakeToCamel)("_uuid_foo", { snakeToCamel: ["keys"] })).toEqual("UuidFoo");
-    });
-    it("converts string to camel case respecting word separation, getAPIValue === getApiValue", () => {
-        expect((0, case_1.camelCaseGrpc)("GetAPIValue")).toEqual("getApiValue");
-    });
-    describe("getFieldJsonName", () => {
-        it("keeps snake case when jsonName is probably not set", () => {
-            expect((0, utils_1.getFieldJsonName)({ name: "foo_bar", jsonName: "fooBar" }, { snakeToCamel: [] })).toBe("foo_bar");
-        });
-        it("uses jsonName when it is set", () => {
-            expect((0, utils_1.getFieldJsonName)({ name: "foo_bar", jsonName: "foo" }, { snakeToCamel: [] })).toBe("foo");
-        });
-    });
-});

package/build/tests/options-test.js

@@ -1,148 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const options_1 = require("../src/options");
-describe("options", () => {
-    it("can set outputJsonMethods with nestJs=true", () => {
-        expect((0, options_1.optionsFromParameter)("nestJs=true,outputJsonMethods=true")).toMatchInlineSnapshot(`
-      {
-        "M": {},
-        "addGrpcMetadata": false,
-        "addNestjsRestParameter": false,
-        "constEnums": false,
-        "context": false,
-        "emitImportedFiles": true,
-        "enumsAsLiterals": false,
-        "env": "both",
-        "esModuleInterop": false,
-        "exportCommonSymbols": true,
-        "fileSuffix": "",
-        "forceLong": "number",
-        "importSuffix": "",
-        "initializeFieldsAsUndefined": false,
-        "lowerCaseServiceMethods": true,
-        "metadataType": undefined,
-        "nestJs": true,
-        "oneof": "properties",
-        "onlyTypes": false,
-        "outputClientImpl": false,
-        "outputEncodeMethods": false,
-        "outputExtensions": false,
-        "outputIndex": false,
-        "outputJsonMethods": true,
-        "outputPartialMethods": false,
-        "outputSchema": false,
-        "outputServices": [
-          "default",
-        ],
-        "outputTypeAnnotations": false,
-        "outputTypeRegistry": false,
-        "removeEnumPrefix": false,
-        "returnObservable": false,
-        "snakeToCamel": [
-          "json",
-          "keys",
-        ],
-        "stringEnums": false,
-        "unknownFields": false,
-        "unrecognizedEnum": true,
-        "useAbortSignal": false,
-        "useAsyncIterable": false,
-        "useDate": "timestamp",
-        "useExactTypes": true,
-        "useJsonWireFormat": false,
-        "useMapType": false,
-        "useMongoObjectId": false,
-        "useNumericEnumForJson": false,
-        "useOptionals": "none",
-        "usePrototypeForDefaults": false,
-        "useReadonlyTypes": false,
-        "useSnakeTypeName": true,
-      }
-    `);
-    });
-    it("can set outputJsonMethods with nestJs=true", () => {
-        const options = (0, options_1.optionsFromParameter)("outputClientImpl=grpc-web,addGrpcMetadata=false");
-        expect(options).toMatchObject({
-            outputClientImpl: "grpc-web",
-            addGrpcMetadata: false,
-        });
-    });
-    it("can set fileSuffix", () => {
-        const options = (0, options_1.optionsFromParameter)("fileSuffix=.pb");
-        expect(options).toMatchObject({
-            fileSuffix: ".pb",
-        });
-    });
-    it("can set outputServices to false", () => {
-        const options = (0, options_1.optionsFromParameter)("outputServices=false");
-        expect(options).toMatchObject({
-            outputServices: [options_1.ServiceOption.NONE],
-        });
-    });
-    it("can set outputServices to grpc", () => {
-        const options = (0, options_1.optionsFromParameter)("outputServices=grpc-js");
-        expect(options).toMatchObject({
-            outputServices: [options_1.ServiceOption.GRPC],
-        });
-    });
-    it("can set useOptionals to boolean", () => {
-        const options = (0, options_1.optionsFromParameter)("useOptionals=true");
-        expect(options).toMatchObject({
-            useOptionals: true,
-        });
-    });
-    it("can set useOptionals to string", () => {
-        const options = (0, options_1.optionsFromParameter)("useOptionals=messages");
-        expect(options).toMatchObject({
-            useOptionals: "messages",
-        });
-    });
-    it("can set snakeToCamel as string", () => {
-        const options = (0, options_1.optionsFromParameter)("snakeToCamel=keys");
-        expect(options).toMatchObject({ snakeToCamel: ["keys"] });
-    });
-    it("can set snakeToCamel as two values", () => {
-        const options = (0, options_1.optionsFromParameter)("snakeToCamel=keys_json");
-        expect(options).toMatchObject({ snakeToCamel: ["keys", "json"] });
-    });
-    it("can set multiple values as an array", () => {
-        const options = (0, options_1.optionsFromParameter)("foo=one,foo=two");
-        expect(options).toMatchObject({ foo: ["one", "two"] });
-    });
-    it("´output*=false implies onlyTypes", () => {
-        const options = (0, options_1.optionsFromParameter)("outputJsonMethods=false,outputEncodeMethods=false,outputClientImpl=false");
-        expect(options).toMatchObject({
-            onlyTypes: true,
-        });
-    });
-    it("onlyTypes implies output*=false", () => {
-        const options = (0, options_1.optionsFromParameter)("onlyTypes=true");
-        expect(options).toMatchObject({
-            outputJsonMethods: false,
-            outputEncodeMethods: false,
-            outputClientImpl: false,
-            nestJs: false,
-        });
-    });
-    it("useJsonWireFormat requires onlyTypes", () => {
-        const options = (0, options_1.optionsFromParameter)("useJsonWireFormat=true");
-        expect(options).toMatchObject({
-            useJsonWireFormat: false,
-        });
-    });
-    it("useSnakeTypeName", () => {
-        const options = (0, options_1.optionsFromParameter)("useSnakeTypeName=false");
-        expect(options).toMatchObject({
-            useSnakeTypeName: false,
-        });
-    });
-    it("useJsonWireFormat implies useDate=string and stringEnums=true", () => {
-        const options = (0, options_1.optionsFromParameter)("useJsonWireFormat=true,onlyTypes=true");
-        expect(options).toMatchObject({
-            useJsonWireFormat: true,
-            onlyTypes: true,
-            stringEnums: true,
-            useDate: options_1.DateOption.STRING,
-        });
-    });
-});

package/build/tests/types-test.js

@@ -1,56 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const options_1 = require("../src/options");
-const types_1 = require("../src/types");
-const ts_poet_1 = require("ts-poet");
-const fakeProto = undefined;
-describe("types", () => {
-    describe("messageToTypeName", () => {
-        const testCases = [
-            {
-                descr: "top-level messages",
-                typeMap: new Map([[".namespace.Message", ["namespace", "Message", fakeProto]]]),
-                protoType: ".namespace.Message",
-                expected: (0, ts_poet_1.code) `${(0, ts_poet_1.imp)("Message@./namespace")}`,
-            },
-            {
-                descr: "nested messages",
-                typeMap: new Map([[".namespace.Message.Inner", ["namespace", "Message_Inner", fakeProto]]]),
-                protoType: ".namespace.Message.Inner",
-                expected: (0, ts_poet_1.code) `${(0, ts_poet_1.imp)("Message_Inner@./namespace")}`,
-            },
-            {
-                descr: "nested messages: .js import suffix",
-                typeMap: new Map([[".namespace.Message.Inner", ["namespace", "Message_Inner", fakeProto]]]),
-                protoType: ".namespace.Message.Inner",
-                options: { ...(0, options_1.defaultOptions)(), importSuffix: ".js" },
-                expected: (0, ts_poet_1.code) `${(0, ts_poet_1.imp)("Message_Inner@./namespace.js")}`,
-            },
-            {
-                descr: "value types",
-                typeMap: new Map(),
-                protoType: ".google.protobuf.StringValue",
-                expected: (0, ts_poet_1.code) `string | undefined`,
-            },
-            {
-                descr: "value types (useOptionals=true)",
-                typeMap: new Map(),
-                protoType: ".google.protobuf.StringValue",
-                options: { ...(0, options_1.defaultOptions)(), useOptionals: true },
-                expected: (0, ts_poet_1.code) `string | undefined`,
-            },
-            {
-                descr: 'value types (useOptionals="all")',
-                typeMap: new Map(),
-                protoType: ".google.protobuf.StringValue",
-                options: { ...(0, options_1.defaultOptions)(), useOptionals: "all" },
-                expected: (0, ts_poet_1.code) `string | undefined`,
-            },
-        ];
-        testCases.forEach((t) => it(t.descr, async () => {
-            const ctx = { options: (0, options_1.defaultOptions)(), utils: undefined, ...t };
-            const got = (0, types_1.messageToTypeName)(ctx, t.protoType);
-            expect(got.toString()).toEqual(t.expected.toString());
-        }));
-    });
-});

package/build/tests/utils-test.js

@@ -1,65 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = require("../src/utils");
-const ts_poet_1 = require("ts-poet");
-describe("utils", () => {
-    describe("maybeAddComment", () => {
-        it("handles single-line impl comments", () => {
-            // Foo
-            const chunks = [];
-            (0, utils_1.maybeAddComment)({ leadingComments: " Foo\n" }, chunks);
-            expect((0, ts_poet_1.joinCode)(chunks).toString()).toMatchInlineSnapshot(`
-        "/** Foo */
-        "
-      `);
-        });
-        it("handles single-dot star comments", () => {
-            // /* Foo */
-            const chunks = [];
-            (0, utils_1.maybeAddComment)({ leadingComments: " Foo " }, chunks);
-            expect((0, ts_poet_1.joinCode)(chunks).toString()).toMatchInlineSnapshot(`
-        "/** Foo */
-        "
-      `);
-        });
-        it("handles single-line double-dot star comments", () => {
-            // /** Foo */
-            const chunks = [];
-            (0, utils_1.maybeAddComment)({ leadingComments: " * Foo " }, chunks);
-            expect((0, ts_poet_1.joinCode)(chunks).toString()).toMatchInlineSnapshot(`
-        "/** Foo */
-        "
-      `);
-        });
-        it("handles double-line double-dot star comments", () => {
-            // /**
-            //  * Foo
-            //  *
-            //  * bar.
-            //  */
-            const chunks = [];
-            (0, utils_1.maybeAddComment)({ leadingComments: "*\n Foo\n \n bar.\n" }, chunks);
-            expect((0, ts_poet_1.joinCode)(chunks).toString()).toMatchInlineSnapshot(`
-        "/**
-         * Foo
-         *
-         * bar.
-         */
-        "
-      `);
-        });
-        it("handles double-line impl comments", () => {
-            // // Foo
-            // // Bar
-            const chunks = [];
-            (0, utils_1.maybeAddComment)({ leadingComments: " Foo\n Bar\n" }, chunks);
-            expect((0, ts_poet_1.joinCode)(chunks).toString()).toMatchInlineSnapshot(`
-        "/**
-         * Foo
-         * Bar
-         */
-        "
-      `);
-        });
-    });
-});