@bufbuild/protoplugin 1.9.0 → 2.0.0-alpha.2

package/dist/esm/source-code-info.js

@@ -0,0 +1,278 @@
+// Copyright 2021-2024 Buf Technologies, Inc.
+//
+// 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
+// limitations under the License.
+import { isFieldSet, } from "@bufbuild/protobuf";
+import { protoCamelCase, reflect, ScalarType, } from "@bufbuild/protobuf/reflect";
+import { Edition, FieldDescriptorProto_Label, FieldDescriptorProto_Type, FieldDescriptorProtoDesc, FieldOptions_JSType, FieldOptionsDesc, FeatureSetDesc, SourceCodeInfo_LocationDesc, FileDescriptorProtoDesc, DescriptorProtoDesc, EnumDescriptorProtoDesc, ServiceDescriptorProtoDesc, } from "@bufbuild/protobuf/wkt";
+/**
+ * Get comments on the package element in the protobuf source.
+ */
+export function getPackageComments(desc) {
+    return findComments(desc.proto.sourceCodeInfo, [
+        FileDescriptorProtoDesc.field.package.number,
+    ]);
+}
+/**
+ * Get comments on the syntax element in the protobuf source.
+ */
+export function getSyntaxComments(desc) {
+    return findComments(desc.proto.sourceCodeInfo, [
+        FileDescriptorProtoDesc.field.syntax.number,
+    ]);
+}
+/**
+ * Get comments on the element in the protobuf source.
+ */
+export function getComments(desc) {
+    let path = [];
+    let file;
+    switch (desc.kind) {
+        case "enum":
+            path = desc.parent
+                ? [
+                    ...getComments(desc.parent).sourcePath,
+                    DescriptorProtoDesc.field.enumType.number,
+                    desc.parent.proto.enumType.indexOf(desc.proto),
+                ]
+                : [
+                    FileDescriptorProtoDesc.field.enumType.number,
+                    desc.file.proto.enumType.indexOf(desc.proto),
+                ];
+            file = desc.file;
+            break;
+        case "oneof":
+            path = [
+                ...getComments(desc.parent).sourcePath,
+                DescriptorProtoDesc.field.oneofDecl.number,
+                desc.parent.proto.oneofDecl.indexOf(desc.proto),
+            ];
+            file = desc.parent.file;
+            break;
+        case "message":
+            path = desc.parent
+                ? [
+                    ...getComments(desc.parent).sourcePath,
+                    DescriptorProtoDesc.field.nestedType.number,
+                    desc.parent.proto.nestedType.indexOf(desc.proto),
+                ]
+                : [
+                    FileDescriptorProtoDesc.field.messageType.number,
+                    desc.file.proto.messageType.indexOf(desc.proto),
+                ];
+            file = desc.file;
+            break;
+        case "enum_value":
+            path = [
+                ...getComments(desc.parent).sourcePath,
+                EnumDescriptorProtoDesc.field.value.number,
+                desc.parent.proto.value.indexOf(desc.proto),
+            ];
+            file = desc.parent.file;
+            break;
+        case "field":
+            path = [
+                ...getComments(desc.parent).sourcePath,
+                DescriptorProtoDesc.field.field.number,
+                desc.parent.proto.field.indexOf(desc.proto),
+            ];
+            file = desc.parent.file;
+            break;
+        case "extension":
+            path = desc.parent
+                ? [
+                    ...getComments(desc.parent).sourcePath,
+                    DescriptorProtoDesc.field.extension.number,
+                    desc.parent.proto.extension.indexOf(desc.proto),
+                ]
+                : [
+                    FileDescriptorProtoDesc.field.extension.number,
+                    desc.file.proto.extension.indexOf(desc.proto),
+                ];
+            file = desc.file;
+            break;
+        case "service":
+            path = [
+                FileDescriptorProtoDesc.field.service.number,
+                desc.file.proto.service.indexOf(desc.proto),
+            ];
+            file = desc.file;
+            break;
+        case "rpc":
+            path = [
+                ...getComments(desc.parent).sourcePath,
+                ServiceDescriptorProtoDesc.field.method.number,
+                desc.parent.proto.method.indexOf(desc.proto),
+            ];
+            file = desc.parent.file;
+            break;
+    }
+    return findComments(file.proto.sourceCodeInfo, path);
+}
+/**
+ * Get feature options set on the element in the protobuf source. This returns
+ * compact (e.g. fields) or regular options (e.g. files) as an array of strings.
+ */
+export function getFeatureOptionStrings(desc) {
+    var _a, _b;
+    const strings = [];
+    const features = (_a = desc.proto.options) === null || _a === void 0 ? void 0 : _a.features;
+    if (features !== undefined) {
+        const r = reflect(FeatureSetDesc, features);
+        for (const f of r.fields) {
+            if (f.fieldKind != "enum" || !r.isSet(f)) {
+                continue;
+            }
+            const val = r.get(f);
+            const name = (_b = f.enum.values.find((v) => v.number == val)) === null || _b === void 0 ? void 0 : _b.name;
+            if (name !== undefined) {
+                strings.push(`features.${f.name} = ${name}`);
+            }
+        }
+    }
+    return strings;
+}
+/**
+ * Return a string that matches the definition of a field in the protobuf
+ * source. Does not take custom options into account.
+ */
+export function getDeclarationString(desc) {
+    var _a;
+    if (desc.kind === "enum_value") {
+        let str = `${desc.name} = ${desc.number}`;
+        if (((_a = desc.proto.options) === null || _a === void 0 ? void 0 : _a.deprecated) === true) {
+            str += " [deprecated = true]";
+        }
+        return str;
+    }
+    const parts = [];
+    function typeName(f) {
+        if (f.message) {
+            return f.message.typeName;
+        }
+        if (f.enum) {
+            return f.enum.typeName;
+        }
+        return ScalarType[f.scalar].toLowerCase();
+    }
+    switch (desc.fieldKind) {
+        case "scalar":
+        case "enum":
+        case "message":
+            if (fieldHasRequiredKeyword(desc)) {
+                parts.push("required");
+            }
+            if (fieldHasOptionalKeyword(desc)) {
+                parts.push("optional");
+            }
+            parts.push(typeName(desc));
+            break;
+        case "list":
+            parts.push("repeated", typeName(desc));
+            break;
+        case "map": {
+            const k = ScalarType[desc.mapKey].toLowerCase();
+            const v = typeName(desc);
+            parts.push(`map<${k}, ${v}>`);
+            break;
+        }
+    }
+    parts.push(desc.name, "=", desc.number.toString());
+    const options = [];
+    const protoOptions = desc.proto.options;
+    if (protoOptions !== undefined &&
+        isFieldSet(protoOptions, FieldOptionsDesc.field.packed)) {
+        options.push(`packed = ${protoOptions.packed.toString()}`);
+    }
+    if (isFieldSet(desc.proto, FieldDescriptorProtoDesc.field.defaultValue)) {
+        let defaultValue = desc.proto.defaultValue;
+        if (desc.proto.type == FieldDescriptorProto_Type.BYTES ||
+            desc.proto.type == FieldDescriptorProto_Type.STRING) {
+            defaultValue = '"' + defaultValue.replace('"', '\\"') + '"';
+        }
+        options.push(`default = ${defaultValue}`);
+    }
+    if (desc.kind == "field" && desc.jsonName !== protoCamelCase(desc.name)) {
+        options.push(`json_name = "${desc.jsonName}"`);
+    }
+    if (protoOptions !== undefined &&
+        isFieldSet(protoOptions, FieldOptionsDesc.field.jstype)) {
+        options.push(`jstype = ${FieldOptions_JSType[protoOptions.jstype]}`);
+    }
+    if (protoOptions !== undefined &&
+        isFieldSet(protoOptions, FieldOptionsDesc.field.deprecated)) {
+        options.push(`deprecated = true`);
+    }
+    options.push(...getFeatureOptionStrings(desc));
+    if (options.length > 0) {
+        parts.push("[" + options.join(", ") + "]");
+    }
+    return parts.join(" ");
+}
+/**
+ * Whether this field was declared with `required` in the protobuf source.
+ */
+function fieldHasRequiredKeyword(field) {
+    const edition = (field.kind == "extension" ? field.file : field.parent.file)
+        .edition;
+    return (edition == Edition.EDITION_PROTO2 &&
+        field.proto.label == FieldDescriptorProto_Label.REQUIRED);
+}
+/**
+ * Whether this field was declared with `optional` in the protobuf source.
+ * Note that message fields are always optional. It is impossible to determine
+ * whether the keyword was used.
+ */
+function fieldHasOptionalKeyword(field) {
+    const edition = (field.kind == "extension" ? field.file : field.parent.file)
+        .edition;
+    if (edition == Edition.EDITION_PROTO2) {
+        return (!field.oneof && field.proto.label == FieldDescriptorProto_Label.OPTIONAL);
+    }
+    if (edition == Edition.EDITION_PROTO3) {
+        return field.proto.proto3Optional;
+    }
+    return false;
+}
+/**
+ * Find comments.
+ */
+function findComments(sourceCodeInfo, sourcePath) {
+    if (!sourceCodeInfo) {
+        return {
+            leadingDetached: [],
+            sourcePath,
+        };
+    }
+    for (const location of sourceCodeInfo.location) {
+        if (location.path.length !== sourcePath.length) {
+            continue;
+        }
+        if (location.path.some((value, index) => sourcePath[index] !== value)) {
+            continue;
+        }
+        return {
+            leadingDetached: location.leadingDetachedComments,
+            leading: isFieldSet(location, SourceCodeInfo_LocationDesc.field.leadingComments)
+                ? location.leadingComments
+                : undefined,
+            trailing: isFieldSet(location, SourceCodeInfo_LocationDesc.field.trailingComments)
+                ? location.trailingComments
+                : undefined,
+            sourcePath,
+        };
+    }
+    return {
+        leadingDetached: [],
+        sourcePath,
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bufbuild/protoplugin",
-  "version": "1.9.0",
+  "version": "2.0.0-alpha.2",
   "license": "(Apache-2.0 AND BSD-3-Clause)",
   "description": "Helps to create your own Protocol Buffers code generators.",
   "repository": {
@@ -36,7 +36,7 @@
     }
   },
   "dependencies": {
-    "@bufbuild/protobuf": "1.9.0",
+    "@bufbuild/protobuf": "2.0.0-alpha.2",
     "@typescript/vfs": "^1.4.0",
     "typescript": "4.5.2"
   },

package/dist/cjs/ecmascript/legacy-custom-options.d.ts

@@ -1,40 +0,0 @@
-import type { AnyDesc, MessageType } from "@bufbuild/protobuf";
-import { Message, ScalarType } from "@bufbuild/protobuf";
-/**
- * @deprecated Please use extensions instead.
- *
- * Returns the value of a custom option with a scalar type.
- *
- * If no option is found, returns undefined.
- */
-export declare function findCustomScalarOption<T extends ScalarType>(desc: AnyDesc, extensionNumber: number, scalarType: T): ScalarValue<T> | undefined;
-/**
- * @deprecated Please use extensions instead.
- *
- * Returns the value of a custom message option for the given descriptor and
- * extension number.
- * The msgType param is then used to deserialize the message for returning to
- * the caller.
- *
- * If no options are found, returns undefined.
- *
- * If the message option is unable to be read or deserialized, an error will
- * be thrown.
- */
-export declare function findCustomMessageOption<T extends Message<T>>(desc: AnyDesc, extensionNumber: number, msgType: MessageType<T>): T | undefined;
-/**
- * @deprecated Please use extensions instead.
- *
- * Returns the value of a custom enum option for the given descriptor and
- * extension number.
- *
- * If no options are found, returns undefined.
- */
-export declare function findCustomEnumOption(desc: AnyDesc, extensionNumber: number): number | undefined;
-/**
- * @deprecated Please use extensions instead.
- *
- * ScalarValue is a conditional type that pairs a ScalarType value with its concrete type.
- */
-type ScalarValue<T> = T extends ScalarType.STRING ? string : T extends ScalarType.INT32 ? number : T extends ScalarType.UINT32 ? number : T extends ScalarType.UINT32 ? number : T extends ScalarType.SINT32 ? number : T extends ScalarType.FIXED32 ? number : T extends ScalarType.SFIXED32 ? number : T extends ScalarType.FLOAT ? number : T extends ScalarType.DOUBLE ? number : T extends ScalarType.INT64 ? bigint | string : T extends ScalarType.SINT64 ? bigint | string : T extends ScalarType.SFIXED64 ? bigint | string : T extends ScalarType.UINT64 ? bigint | string : T extends ScalarType.FIXED64 ? bigint | string : T extends ScalarType.BOOL ? boolean : T extends ScalarType.BYTES ? Uint8Array : never;
-export {};

package/dist/cjs/ecmascript/legacy-custom-options.js

@@ -1,121 +0,0 @@
-"use strict";
-// Copyright 2021-2024 Buf Technologies, Inc.
-//
-// 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
-// limitations under the License.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.findCustomEnumOption = exports.findCustomMessageOption = exports.findCustomScalarOption = void 0;
-const protobuf_1 = require("@bufbuild/protobuf");
-/**
- * @deprecated Please use extensions instead.
- *
- * Returns the value of a custom option with a scalar type.
- *
- * If no option is found, returns undefined.
- */
-function findCustomScalarOption(desc, extensionNumber, scalarType) {
-    const reader = createBinaryReader(desc, extensionNumber);
-    if (reader) {
-        switch (scalarType) {
-            case protobuf_1.ScalarType.INT32:
-                return reader.int32();
-            case protobuf_1.ScalarType.UINT32:
-                return reader.uint32();
-            case protobuf_1.ScalarType.SINT32:
-                return reader.sint32();
-            case protobuf_1.ScalarType.FIXED32:
-                return reader.fixed32();
-            case protobuf_1.ScalarType.SFIXED32:
-                return reader.sfixed32();
-            case protobuf_1.ScalarType.FLOAT:
-                return reader.float();
-            case protobuf_1.ScalarType.DOUBLE:
-                return reader.double();
-            case protobuf_1.ScalarType.INT64:
-                return reader.int64();
-            case protobuf_1.ScalarType.SINT64:
-                return reader.sint64();
-            case protobuf_1.ScalarType.SFIXED64:
-                return reader.sfixed64();
-            case protobuf_1.ScalarType.UINT64:
-                return reader.uint64();
-            case protobuf_1.ScalarType.FIXED64:
-                return reader.fixed64();
-            case protobuf_1.ScalarType.BOOL:
-                return reader.bool();
-            case protobuf_1.ScalarType.BYTES:
-                return reader.bytes();
-            case protobuf_1.ScalarType.STRING:
-                return reader.string();
-            default: {
-                break;
-            }
-        }
-    }
-    return undefined;
-}
-exports.findCustomScalarOption = findCustomScalarOption;
-/**
- * @deprecated Please use extensions instead.
- *
- * Returns the value of a custom message option for the given descriptor and
- * extension number.
- * The msgType param is then used to deserialize the message for returning to
- * the caller.
- *
- * If no options are found, returns undefined.
- *
- * If the message option is unable to be read or deserialized, an error will
- * be thrown.
- */
-function findCustomMessageOption(desc, extensionNumber, msgType) {
-    const reader = createBinaryReader(desc, extensionNumber);
-    if (reader) {
-        try {
-            const data = reader.bytes();
-            return msgType.fromBinary(data);
-        }
-        catch (e) {
-            const innerMessage = e instanceof Error ? e.message : String(e);
-            throw new Error(`failed to access message option: ${innerMessage}`);
-        }
-    }
-    return undefined;
-}
-exports.findCustomMessageOption = findCustomMessageOption;
-/**
- * @deprecated Please use extensions instead.
- *
- * Returns the value of a custom enum option for the given descriptor and
- * extension number.
- *
- * If no options are found, returns undefined.
- */
-function findCustomEnumOption(desc, extensionNumber) {
-    return findCustomScalarOption(desc, extensionNumber, protobuf_1.ScalarType.INT32);
-}
-exports.findCustomEnumOption = findCustomEnumOption;
-/**
- * Returns a binary reader for the given descriptor and extension number.
- */
-function createBinaryReader(desc, extensionNumber) {
-    const opt = desc.proto.options;
-    let reader = undefined;
-    if (opt !== undefined) {
-        const unknownFields = protobuf_1.proto3.bin.listUnknownFields(opt);
-        const field = unknownFields.find((f) => f.no === extensionNumber);
-        if (field) {
-            reader = new protobuf_1.BinaryReader(field.data);
-        }
-    }
-    return reader;
-}

package/dist/cjs/ecmascript/legacy-gencommon.d.ts

@@ -1,25 +0,0 @@
-import type { DescExtension, DescField } from "@bufbuild/protobuf";
-import type { GeneratedFile, Printable } from "./generated-file.js";
-import type { ImportSymbol } from "./import-symbol.js";
-/**
- * @deprecated Please use GeneratedFile.string() instead
- */
-export declare function literalString(value: string): string;
-/**
- * @deprecated
- */
-export declare function getFieldTyping(field: DescField | DescExtension, file: GeneratedFile): {
-    typing: Printable;
-    optional: boolean;
-};
-/**
- * @deprecated
- */
-export declare function getFieldExplicitDefaultValue(field: DescField | DescExtension, protoInt64Symbol: ImportSymbol): Printable | undefined;
-/**
- * @deprecated
- */
-export declare function getFieldIntrinsicDefaultValue(field: DescField): {
-    defaultValue: Printable | undefined;
-    typingInferrable: boolean;
-};