gRPC utility library for loading .proto files. 

gRPC utility library for loading .proto files

grpc-packages

murgatroid99

nicolasnoble

@grpc/proto-loader

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *     http://www.apache.org/licenses/LICENSE-2.0

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

Object.defineProperty(exports, "__esModule", { value: true });

const camelCase = require("lodash.camelcase");

const useNameFmter = ({ outputTemplate, inputTemplate }) => {

    if (outputTemplate === inputTemplate) {

        throw new Error('inputTemplate and outputTemplate must differ');

        outputName: (n) => outputTemplate.replace(templateStr, n),

        inputName: (n) => inputTemplate.replace(templateStr, n)

        for (let i = 0; i < this.indentValue; i += 1) {

            this.textParts.push(this.indentText);

    return Array.isArray(obj.nestedArray);

    return name.startsWith('.') ? name.substring(1) : name;

    /* If the thing we are importing is defined in a message, it is generated in

    if (to.parent instanceof Protobuf.Type) {

    return stripLeadingPeriod(to.fullName).replace(/\./g, '/');

    return stripLeadingPeriod(to.fullName).replace(/\./g, '/') + '.ts';

    const depth = stripLeadingPeriod(from.fullName).split('.').length - 1;

function getRelativeImportPath(from, to) {

    return `import type { ${importedTypes} } from '${filePath}.ts';`;

    return `import type { ${importedTypes} } from '${filePath}';`;

function getChildMessagesAndEnums(namespace) {

    for (const nested of namespace.nestedArray) {

        if (nested instanceof Protobuf.Type || nested instanceof Protobuf.Enum) {

            messageList.push(...getChildMessagesAndEnums(nested));

function formatComment(formatter, comment, options) {

    if (!comment && !(options === null || options === void 0 ? void 0 : options.deprecated)) {

        for (const line of comment.split('\n')) {

            formatter.writeLine(` * ${line.replace(/\*\//g, '* /')}`);

    if (options === null || options === void 0 ? void 0 : options.deprecated) {

        formatter.writeLine(' * @deprecated');

const typeBrandHint = `This field is a type brand and is not populated at runtime. Instances of this type should be created using type assertions.

https://github.com/grpc/grpc-node/pull/2281`;

function formatTypeBrand(formatter, messageType) {

    formatComment(formatter, typeBrandHint);

    formatter.writeLine(`__type: '${messageType.fullName}'`);

function getTypeNamePermissive(fieldType, resolvedType, repeated, map, options) {

    const { inputName } = useNameFmter(options);

            return 'number | string | Long';

            return 'Buffer | Uint8Array | string';

                throw new Error('Found field with no usable type');

            const typeInterfaceName = getTypeInterfaceName(resolvedType);

            if (resolvedType instanceof Protobuf.Type) {

                    return inputName(typeInterfaceName);

                    return `${inputName(typeInterfaceName)} | null`;

                return inputName(typeInterfaceName);

function getFieldTypePermissive(field, options) {

    const valueType = getTypeNamePermissive(field.type, field.resolvedType, field.repeated, field.map, options);

    if (field instanceof Protobuf.MapField) {

        const keyType = field.keyType === 'string' ? 'string' : 'number';

        return `{[key: ${keyType}]: ${valueType}}`;

function generatePermissiveMessageInterface(formatter, messageType, options, nameOverride) {

        formatComment(formatter, messageType.comment, messageType.options);

    if (messageType.fullName === '.google.protobuf.Any') {

        /* This describes the behavior of the Protobuf.js Any wrapper fromObject

        formatter.writeLine(`export type ${inputName('Any')} = AnyExtension | {`);

        formatter.writeLine('  type_url: string;');

        formatter.writeLine('  value: Buffer | Uint8Array | string;');

  "description": "gRPC utility library for loading .proto files",

    "format": "clang-format -i -style=\"{Language: JavaScript, BasedOnStyle: Google, ColumnLimit: 80}\" src/*.ts test/*.ts",

    "lint": "tslint -c node_modules/google-ts-style/tslint.json -p . -t codeFrame --type-check",

    "generate-golden": "node ./build/bin/proto-loader-gen-types.js --keepCase --longs=String --enums=String --defaults --oneofs --json --includeComments --inputTemplate=I%s --outputTemplate=O%s -I deps/gapic-showcase/schema/ deps/googleapis/ -O ./golden-generated --grpcLib @grpc/grpc-js google/showcase/v1beta1/echo.proto",

    "validate-golden": "rm -rf ./golden-generated-old && mv ./golden-generated/ ./golden-generated-old && npm run generate-golden && diff -rb ./golden-generated ./golden-generated-old"

    "url": "https://github.com/grpc/grpc-node.git"

    "url": "https://github.com/grpc/grpc-node/issues"

    "proto-loader-gen-types": "./build/bin/proto-loader-gen-types.js"

		{
		"name": "@grpc/proto-loader",
		"version": "0.7.11",
		"version": "0.7.12",
		"author": "Google Inc.",
		@@ -5,0 +5,0 @@ "contributors": [

		@@ -135,3 +135,3 @@ #!/usr/bin/env node
		}
		return `import type { ${importedTypes} } from '${filePath}.ts';`;
		return `import type { ${importedTypes} } from '${filePath}';`;
		}
		@@ -138,0 +138,0 @@ function getChildMessagesAndEnums(namespace) {

Worsened metrics