@bufbuild/protoplugin 1.8.0 → 2.0.0-alpha.1

package/dist/cjs/ecmascript/legacy-gencommon.js

@@ -1,237 +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.getFieldIntrinsicDefaultValue = exports.getFieldExplicitDefaultValue = exports.getFieldTyping = exports.literalString = void 0;
-const protobuf_1 = require("@bufbuild/protobuf");
-const { localName, getUnwrappedFieldType, scalarZeroValue } = protobuf_1.codegenInfo;
-/**
- * @deprecated Please use GeneratedFile.string() instead
- */
-function literalString(value) {
-    return ('"' +
-        value
-            .split("\\")
-            .join("\\\\")
-            .split('"')
-            .join('\\"')
-            .split("\r")
-            .join("\\r")
-            .split("\n")
-            .join("\\n") +
-        '"');
-}
-exports.literalString = literalString;
-/**
- * @deprecated
- */
-function getFieldTyping(field, file) {
-    const typing = [];
-    let optional = false;
-    switch (field.fieldKind) {
-        case "scalar":
-            typing.push(scalarTypeScriptType(field.scalar, field.longType));
-            optional = field.optional;
-            break;
-        case "message": {
-            const baseType = getUnwrappedFieldType(field);
-            if (baseType !== undefined) {
-                typing.push(scalarTypeScriptType(baseType, protobuf_1.LongType.BIGINT));
-            }
-            else {
-                typing.push(file.import(field.message).toTypeOnly());
-            }
-            optional = true;
-            break;
-        }
-        case "enum":
-            typing.push(file.import(field.enum).toTypeOnly());
-            optional = field.optional;
-            break;
-        case "map": {
-            let keyType;
-            switch (field.mapKey) {
-                case protobuf_1.ScalarType.INT32:
-                case protobuf_1.ScalarType.FIXED32:
-                case protobuf_1.ScalarType.UINT32:
-                case protobuf_1.ScalarType.SFIXED32:
-                case protobuf_1.ScalarType.SINT32:
-                    keyType = "number";
-                    break;
-                default:
-                    keyType = "string";
-                    break;
-            }
-            let valueType;
-            switch (field.mapValue.kind) {
-                case "scalar":
-                    valueType = scalarTypeScriptType(field.mapValue.scalar, protobuf_1.LongType.BIGINT);
-                    break;
-                case "message":
-                    valueType = file.import(field.mapValue.message).toTypeOnly();
-                    break;
-                case "enum":
-                    valueType = file.import(field.mapValue.enum).toTypeOnly();
-                    break;
-            }
-            typing.push("{ [key: ", keyType, "]: ", valueType, " }");
-            optional = false;
-            break;
-        }
-    }
-    if (field.repeated) {
-        typing.push("[]");
-        optional = false;
-    }
-    return { typing, optional };
-}
-exports.getFieldTyping = getFieldTyping;
-/**
- * @deprecated
- */
-function getFieldExplicitDefaultValue(field, protoInt64Symbol) {
-    switch (field.fieldKind) {
-        case "enum": {
-            const value = field.enum.values.find((v) => v.number === field.getDefaultValue());
-            if (value !== undefined) {
-                return [value.parent, ".", localName(value)];
-            }
-            break;
-        }
-        case "scalar": {
-            const defaultValue = field.getDefaultValue();
-            if (defaultValue === undefined) {
-                break;
-            }
-            switch (field.scalar) {
-                case protobuf_1.ScalarType.FLOAT:
-                case protobuf_1.ScalarType.DOUBLE: {
-                    return defaultValue;
-                }
-                case protobuf_1.ScalarType.INT64:
-                case protobuf_1.ScalarType.SINT64:
-                case protobuf_1.ScalarType.SFIXED64:
-                    return [protoInt64Symbol, `.parse("${defaultValue.toString()}")`];
-                case protobuf_1.ScalarType.UINT64:
-                case protobuf_1.ScalarType.FIXED64:
-                    return [protoInt64Symbol, `.uParse("${defaultValue.toString()}")`];
-                case protobuf_1.ScalarType.INT32:
-                case protobuf_1.ScalarType.FIXED32:
-                case protobuf_1.ScalarType.UINT32:
-                case protobuf_1.ScalarType.SFIXED32:
-                case protobuf_1.ScalarType.SINT32:
-                    return defaultValue;
-                case protobuf_1.ScalarType.BOOL: {
-                    return defaultValue;
-                }
-                case protobuf_1.ScalarType.STRING: {
-                    if (typeof defaultValue == "string") {
-                        return literalString(defaultValue);
-                    }
-                    break;
-                }
-                case protobuf_1.ScalarType.BYTES: {
-                    if (defaultValue instanceof Uint8Array) {
-                        return defaultValue;
-                    }
-                    break;
-                }
-            }
-            break;
-        }
-        default:
-            break;
-    }
-    return undefined;
-}
-exports.getFieldExplicitDefaultValue = getFieldExplicitDefaultValue;
-/**
- * @deprecated
- */
-function getFieldIntrinsicDefaultValue(field) {
-    if (field.repeated) {
-        return {
-            defaultValue: "[]",
-            typingInferrable: false,
-        };
-    }
-    if (field.fieldKind == "map") {
-        return {
-            defaultValue: "{}",
-            typingInferrable: false,
-        };
-    }
-    let defaultValue = undefined;
-    let typingInferrable = false;
-    if (field.parent.file.syntax == "proto3") {
-        switch (field.fieldKind) {
-            case "enum": {
-                if (!field.optional) {
-                    const zeroValue = field.enum.values.find((v) => v.number === 0);
-                    if (zeroValue === undefined) {
-                        throw new Error("invalid proto3 enum: missing 0 value");
-                    }
-                    defaultValue = [field.enum, ".", localName(zeroValue)];
-                    typingInferrable = true;
-                }
-                break;
-            }
-            case "scalar":
-                if (!field.optional) {
-                    typingInferrable = true;
-                    if (field.scalar === protobuf_1.ScalarType.STRING) {
-                        defaultValue = literalString("");
-                    }
-                    else {
-                        defaultValue = scalarZeroValue(field.scalar, field.longType);
-                        if (typeof defaultValue === "string") {
-                            defaultValue = literalString(defaultValue);
-                        }
-                    }
-                }
-                break;
-            default:
-                break;
-        }
-    }
-    return {
-        defaultValue,
-        typingInferrable,
-    };
-}
-exports.getFieldIntrinsicDefaultValue = getFieldIntrinsicDefaultValue;
-/**
- * @deprecated
- */
-function scalarTypeScriptType(type, longType) {
-    switch (type) {
-        case protobuf_1.ScalarType.STRING:
-            return "string";
-        case protobuf_1.ScalarType.BOOL:
-            return "boolean";
-        case protobuf_1.ScalarType.UINT64:
-        case protobuf_1.ScalarType.SFIXED64:
-        case protobuf_1.ScalarType.FIXED64:
-        case protobuf_1.ScalarType.SINT64:
-        case protobuf_1.ScalarType.INT64:
-            if (longType === protobuf_1.LongType.STRING) {
-                return "string";
-            }
-            return "bigint";
-        case protobuf_1.ScalarType.BYTES:
-            return "Uint8Array";
-        default:
-            return "number";
-    }
-}

package/dist/cjs/ecmascript/opaque-printables.d.ts

@@ -1,26 +0,0 @@
-import { DescEnum, DescExtension, DescMessage, LongType, ScalarType } from "@bufbuild/protobuf";
-export type LiteralProtoInt64 = {
-    readonly kind: "es_proto_int64";
-    type: ScalarType.INT64 | ScalarType.SINT64 | ScalarType.SFIXED64 | ScalarType.UINT64 | ScalarType.FIXED64;
-    longType: LongType;
-    value: bigint | string;
-};
-export type LiteralString = {
-    readonly kind: "es_string";
-    value: string;
-};
-export type RefDescMessage = {
-    readonly kind: "es_ref_message";
-    type: DescMessage;
-    typeOnly: boolean;
-};
-export type RefDescEnum = {
-    readonly kind: "es_ref_enum";
-    type: DescEnum;
-    typeOnly: boolean;
-};
-export type ExportDeclaration = {
-    readonly kind: "es_export_decl";
-    declaration: string;
-    name: string | DescMessage | DescEnum | DescExtension;
-};

package/dist/cjs/ecmascript/reify-wkt.d.ts

@@ -1,100 +0,0 @@
-import type { DescField, DescMessage, DescOneof } from "@bufbuild/protobuf";
-type DescWkt = {
-    typeName: "google.protobuf.Any";
-    typeUrl: DescField;
-    value: DescField;
-} | {
-    typeName: "google.protobuf.Timestamp";
-    seconds: DescField;
-    nanos: DescField;
-} | {
-    typeName: "google.protobuf.Duration";
-    seconds: DescField;
-    nanos: DescField;
-} | {
-    typeName: "google.protobuf.Struct";
-    fields: DescField & {
-        fieldKind: "map";
-    };
-} | {
-    typeName: "google.protobuf.Value";
-    kind: DescOneof;
-    nullValue: DescField & {
-        fieldKind: "enum";
-    };
-    numberValue: DescField;
-    stringValue: DescField;
-    boolValue: DescField;
-    structValue: DescField & {
-        fieldKind: "message";
-    };
-    listValue: DescField & {
-        fieldKind: "message";
-    };
-} | {
-    typeName: "google.protobuf.ListValue";
-    values: DescField & {
-        fieldKind: "message";
-    };
-} | {
-    typeName: "google.protobuf.FieldMask";
-    paths: DescField;
-} | {
-    typeName: "google.protobuf.DoubleValue";
-    value: DescField & {
-        fieldKind: "scalar";
-    };
-} | {
-    typeName: "google.protobuf.FloatValue";
-    value: DescField & {
-        fieldKind: "scalar";
-    };
-} | {
-    typeName: "google.protobuf.Int64Value";
-    value: DescField & {
-        fieldKind: "scalar";
-    };
-} | {
-    typeName: "google.protobuf.UInt64Value";
-    value: DescField & {
-        fieldKind: "scalar";
-    };
-} | {
-    typeName: "google.protobuf.Int32Value";
-    value: DescField & {
-        fieldKind: "scalar";
-    };
-} | {
-    typeName: "google.protobuf.UInt32Value";
-    value: DescField & {
-        fieldKind: "scalar";
-    };
-} | {
-    typeName: "google.protobuf.BoolValue";
-    value: DescField & {
-        fieldKind: "scalar";
-    };
-} | {
-    typeName: "google.protobuf.StringValue";
-    value: DescField & {
-        fieldKind: "scalar";
-    };
-} | {
-    typeName: "google.protobuf.BytesValue";
-    value: DescField & {
-        fieldKind: "scalar";
-    };
-};
-/**
- * Reifies a given DescMessage into a more concrete object representing its
- * respective well-known type.  The returned object will contain properties
- * representing the WKT's defined fields.
- *
- * Useful during code generation when immediate access to a particular field
- * is needed without having to search the object's typename and DescField list.
- *
- * Returns undefined if the WKT cannot be completely constructed via the
- * DescMessage.
- */
-export declare function reifyWkt(message: DescMessage): DescWkt | undefined;
-export {};

package/dist/cjs/ecmascript/reify-wkt.js

@@ -1,170 +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.reifyWkt = void 0;
-const protobuf_1 = require("@bufbuild/protobuf");
-/**
- * Reifies a given DescMessage into a more concrete object representing its
- * respective well-known type.  The returned object will contain properties
- * representing the WKT's defined fields.
- *
- * Useful during code generation when immediate access to a particular field
- * is needed without having to search the object's typename and DescField list.
- *
- * Returns undefined if the WKT cannot be completely constructed via the
- * DescMessage.
- */
-function reifyWkt(message) {
-    switch (message.typeName) {
-        case "google.protobuf.Any": {
-            const typeUrl = message.fields.find((f) => f.number == 1 &&
-                f.fieldKind == "scalar" &&
-                f.scalar === protobuf_1.ScalarType.STRING);
-            const value = message.fields.find((f) => f.number == 2 &&
-                f.fieldKind == "scalar" &&
-                f.scalar === protobuf_1.ScalarType.BYTES);
-            if (typeUrl && value) {
-                return {
-                    typeName: message.typeName,
-                    typeUrl,
-                    value,
-                };
-            }
-            break;
-        }
-        case "google.protobuf.Timestamp": {
-            const seconds = message.fields.find((f) => f.number == 1 &&
-                f.fieldKind == "scalar" &&
-                f.scalar === protobuf_1.ScalarType.INT64);
-            const nanos = message.fields.find((f) => f.number == 2 &&
-                f.fieldKind == "scalar" &&
-                f.scalar === protobuf_1.ScalarType.INT32);
-            if (seconds && nanos) {
-                return {
-                    typeName: message.typeName,
-                    seconds,
-                    nanos,
-                };
-            }
-            break;
-        }
-        case "google.protobuf.Duration": {
-            const seconds = message.fields.find((f) => f.number == 1 &&
-                f.fieldKind == "scalar" &&
-                f.scalar === protobuf_1.ScalarType.INT64);
-            const nanos = message.fields.find((f) => f.number == 2 &&
-                f.fieldKind == "scalar" &&
-                f.scalar === protobuf_1.ScalarType.INT32);
-            if (seconds && nanos) {
-                return {
-                    typeName: message.typeName,
-                    seconds,
-                    nanos,
-                };
-            }
-            break;
-        }
-        case "google.protobuf.Struct": {
-            const fields = message.fields.find((f) => f.number == 1 && !f.repeated);
-            if ((fields === null || fields === void 0 ? void 0 : fields.fieldKind) !== "map" ||
-                fields.mapValue.kind !== "message" ||
-                fields.mapValue.message.typeName !== "google.protobuf.Value") {
-                break;
-            }
-            return { typeName: message.typeName, fields };
-        }
-        case "google.protobuf.Value": {
-            const kind = message.oneofs.find((o) => o.name === "kind");
-            const nullValue = message.fields.find((f) => f.number == 1 && f.oneof === kind);
-            if ((nullValue === null || nullValue === void 0 ? void 0 : nullValue.fieldKind) !== "enum" ||
-                nullValue.enum.typeName !== "google.protobuf.NullValue") {
-                return undefined;
-            }
-            const numberValue = message.fields.find((f) => f.number == 2 &&
-                f.fieldKind == "scalar" &&
-                f.scalar === protobuf_1.ScalarType.DOUBLE &&
-                f.oneof === kind);
-            const stringValue = message.fields.find((f) => f.number == 3 &&
-                f.fieldKind == "scalar" &&
-                f.scalar === protobuf_1.ScalarType.STRING &&
-                f.oneof === kind);
-            const boolValue = message.fields.find((f) => f.number == 4 &&
-                f.fieldKind == "scalar" &&
-                f.scalar === protobuf_1.ScalarType.BOOL &&
-                f.oneof === kind);
-            const structValue = message.fields.find((f) => f.number == 5 && f.oneof === kind);
-            if ((structValue === null || structValue === void 0 ? void 0 : structValue.fieldKind) !== "message" ||
-                structValue.message.typeName !== "google.protobuf.Struct") {
-                return undefined;
-            }
-            const listValue = message.fields.find((f) => f.number == 6 && f.oneof === kind);
-            if ((listValue === null || listValue === void 0 ? void 0 : listValue.fieldKind) !== "message" ||
-                listValue.message.typeName !== "google.protobuf.ListValue") {
-                return undefined;
-            }
-            if (kind && numberValue && stringValue && boolValue) {
-                return {
-                    typeName: message.typeName,
-                    kind,
-                    nullValue,
-                    numberValue,
-                    stringValue,
-                    boolValue,
-                    structValue,
-                    listValue,
-                };
-            }
-            break;
-        }
-        case "google.protobuf.ListValue": {
-            const values = message.fields.find((f) => f.number == 1 && f.repeated);
-            if ((values === null || values === void 0 ? void 0 : values.fieldKind) != "message" ||
-                values.message.typeName !== "google.protobuf.Value") {
-                break;
-            }
-            return { typeName: message.typeName, values };
-        }
-        case "google.protobuf.FieldMask": {
-            const paths = message.fields.find((f) => f.number == 1 &&
-                f.fieldKind == "scalar" &&
-                f.scalar === protobuf_1.ScalarType.STRING &&
-                f.repeated);
-            if (paths) {
-                return { typeName: message.typeName, paths };
-            }
-            break;
-        }
-        case "google.protobuf.DoubleValue":
-        case "google.protobuf.FloatValue":
-        case "google.protobuf.Int64Value":
-        case "google.protobuf.UInt64Value":
-        case "google.protobuf.Int32Value":
-        case "google.protobuf.UInt32Value":
-        case "google.protobuf.BoolValue":
-        case "google.protobuf.StringValue":
-        case "google.protobuf.BytesValue": {
-            const value = message.fields.find((f) => f.number == 1 && f.name == "value");
-            if (!value) {
-                break;
-            }
-            if (value.fieldKind !== "scalar") {
-                break;
-            }
-            return { typeName: message.typeName, value };
-        }
-    }
-    return undefined;
-}
-exports.reifyWkt = reifyWkt;

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

@@ -1,40 +0,0 @@
-import type { AnyDesc } from "@bufbuild/protobuf";
-import { Message, MessageType, 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/esm/ecmascript/legacy-custom-options.js

@@ -1,115 +0,0 @@
-// 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 { proto3, BinaryReader, 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 function findCustomScalarOption(desc, extensionNumber, scalarType) {
-    const reader = createBinaryReader(desc, extensionNumber);
-    if (reader) {
-        switch (scalarType) {
-            case ScalarType.INT32:
-                return reader.int32();
-            case ScalarType.UINT32:
-                return reader.uint32();
-            case ScalarType.SINT32:
-                return reader.sint32();
-            case ScalarType.FIXED32:
-                return reader.fixed32();
-            case ScalarType.SFIXED32:
-                return reader.sfixed32();
-            case ScalarType.FLOAT:
-                return reader.float();
-            case ScalarType.DOUBLE:
-                return reader.double();
-            case ScalarType.INT64:
-                return reader.int64();
-            case ScalarType.SINT64:
-                return reader.sint64();
-            case ScalarType.SFIXED64:
-                return reader.sfixed64();
-            case ScalarType.UINT64:
-                return reader.uint64();
-            case ScalarType.FIXED64:
-                return reader.fixed64();
-            case ScalarType.BOOL:
-                return reader.bool();
-            case ScalarType.BYTES:
-                return reader.bytes();
-            case ScalarType.STRING:
-                return reader.string();
-            default: {
-                break;
-            }
-        }
-    }
-    return 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 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;
-}
-/**
- * @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 function findCustomEnumOption(desc, extensionNumber) {
-    return findCustomScalarOption(desc, extensionNumber, ScalarType.INT32);
-}
-/**
- * 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 = proto3.bin.listUnknownFields(opt);
-        const field = unknownFields.find((f) => f.no === extensionNumber);
-        if (field) {
-            reader = new BinaryReader(field.data);
-        }
-    }
-    return reader;
-}