@aptre/protobuf-es-lite 0.2.7 → 0.2.8

package/dist/protoplugin/ecmascript/import-symbol.js

@@ -0,0 +1,37 @@
+"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.createImportSymbol = void 0;
+/**
+ * Create a new import symbol.
+ */
+function createImportSymbol(name, from, typeOnly) {
+    const id = `import("${from}").${name}`;
+    const s = {
+        kind: "es_symbol",
+        name,
+        from,
+        typeOnly: false,
+        id,
+        toTypeOnly() {
+            return {
+                ...this,
+                typeOnly: true,
+            };
+        },
+    };
+    return typeOnly === true ? s.toTypeOnly() : s;
+}
+exports.createImportSymbol = createImportSymbol;

package/dist/protoplugin/ecmascript/index.d.ts

@@ -0,0 +1,7 @@
+export { reifyWkt } from "./reify-wkt.js";
+export type { Target } from "./target.js";
+export type { Schema } from "./schema.js";
+export type { RuntimeImports } from "./runtime-imports.js";
+export type { GeneratedFile, FileInfo, Printable } from "./generated-file.js";
+export type { ImportSymbol } from "./import-symbol.js";
+export { createImportSymbol } from "./import-symbol.js";

package/dist/protoplugin/ecmascript/index.js

@@ -0,0 +1,20 @@
+"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.createImportSymbol = exports.reifyWkt = void 0;
+var reify_wkt_js_1 = require("./reify-wkt.js");
+Object.defineProperty(exports, "reifyWkt", { enumerable: true, get: function () { return reify_wkt_js_1.reifyWkt; } });
+var import_symbol_js_1 = require("./import-symbol.js");
+Object.defineProperty(exports, "createImportSymbol", { enumerable: true, get: function () { return import_symbol_js_1.createImportSymbol; } });

package/dist/protoplugin/ecmascript/jsdoc.d.ts

@@ -0,0 +1,14 @@
+import { AnyDesc, DescFile } from "../../descriptor-set.js";
+export type JSDocBlock = {
+    readonly kind: "es_jsdoc";
+    /**
+     * @deprecated In a future release, we will make this property optional.
+     */
+    text: string;
+    indentation?: string;
+    /**
+     * @deprecated In a future release, we will remove this method.
+     */
+    toString(): string;
+};
+export declare function createJsDocBlock(textOrDesc: string | Exclude<AnyDesc, DescFile>, indentation?: string): JSDocBlock;

package/dist/protoplugin/ecmascript/jsdoc.js

@@ -0,0 +1,93 @@
+"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.createJsDocBlock = void 0;
+// TODO simplify type JSDocBlock to bring it in line with others in opaque-printables.ts
+function createJsDocBlock(textOrDesc, indentation) {
+    const text = typeof textOrDesc == "string" ? textOrDesc : createTextForDesc(textOrDesc);
+    return {
+        kind: "es_jsdoc",
+        text,
+        indentation,
+        toString() {
+            if (text.trim().length == 0) {
+                return "";
+            }
+            let lines = text.split("\n");
+            if (lines.length === 0) {
+                return "";
+            }
+            lines = lines.map((l) => l.split("*/").join("*\\/"));
+            lines = lines.map((l) => (l.length > 0 ? " " + l : l));
+            const i = indentation ?? "";
+            return [`${i}/**\n`, ...lines.map((l) => `${i} *${l}\n`), `${i} */`].join("");
+        },
+    };
+}
+exports.createJsDocBlock = createJsDocBlock;
+function createTextForDesc(desc) {
+    const comments = desc.getComments();
+    let text = "";
+    if (comments.leading !== undefined) {
+        text += comments.leading;
+        if (text.endsWith("\n")) {
+            text = text.substring(0, text.length - 1);
+        }
+    }
+    if (comments.trailing !== undefined) {
+        if (text.length > 0) {
+            text += "\n\n";
+        }
+        text += comments.trailing;
+        if (text.endsWith("\n")) {
+            text = text.substring(0, text.length - 1);
+        }
+    }
+    if (text.length > 0) {
+        text += "\n\n";
+    }
+    text = text
+        .split("\n")
+        .map((line) => (line.startsWith(" ") ? line.substring(1) : line))
+        .join("\n");
+    switch (desc.kind) {
+        case "enum_value":
+            text += `@generated from enum value: ${desc.declarationString()};`;
+            break;
+        case "field":
+            text += `@generated from field: ${desc.declarationString()};`;
+            break;
+        case "extension":
+            text += `@generated from extension: ${desc.declarationString()};`;
+            break;
+        default:
+            text += `@generated from ${desc.toString()}`;
+            break;
+    }
+    let deprecated = desc.deprecated;
+    switch (desc.kind) {
+        case "enum":
+        case "message":
+        case "service":
+            deprecated = deprecated || (desc.file.proto.options?.deprecated ?? false);
+            break;
+        default:
+            break;
+    }
+    if (deprecated) {
+        text += "\n@deprecated";
+    }
+    return text;
+}

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

@@ -0,0 +1,27 @@
+import { DescEnum, DescExtension, DescMessage } from "../../descriptor-set.js";
+import { LongType, ScalarType } from "../../scalar.js";
+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/protoplugin/ecmascript/opaque-printables.js

@@ -0,0 +1,15 @@
+"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 });

package/dist/protoplugin/ecmascript/parameter.d.ts

@@ -0,0 +1,13 @@
+import type { Target } from "./target.js";
+import type { RewriteImports } from "./import-path.js";
+export interface ParsedParameter {
+    targets: Target[];
+    tsNocheck: boolean;
+    bootstrapWkt: boolean;
+    keepEmptyFiles: boolean;
+    rewriteImports: RewriteImports;
+    importExtension: string;
+    jsImportStyle: "module" | "legacy_commonjs";
+    sanitizedParameter: string;
+}
+export declare function parseParameter(parameter: string | undefined, parseExtraOption: ((key: string, value: string) => void) | undefined): ParsedParameter;

package/dist/protoplugin/ecmascript/parameter.js

@@ -0,0 +1,161 @@
+"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.parseParameter = void 0;
+const error_js_1 = require("../error.js");
+function parseParameter(parameter, parseExtraOption) {
+    let targets = ["js", "dts"];
+    let tsNocheck = true;
+    let bootstrapWkt = false;
+    let keepEmptyFiles = false;
+    const rewriteImports = [];
+    let importExtension = ".js";
+    let jsImportStyle = "module";
+    const rawParameters = [];
+    for (const { key, value, raw } of splitParameter(parameter)) {
+        // Whether this key/value plugin parameter pair should be
+        // printed to the generated file preamble
+        let sanitize = false;
+        switch (key) {
+            case "target":
+                targets = [];
+                for (const rawTarget of value.split("+")) {
+                    switch (rawTarget) {
+                        case "js":
+                        case "ts":
+                        case "dts":
+                            if (targets.indexOf(rawTarget) < 0) {
+                                targets.push(rawTarget);
+                            }
+                            break;
+                        default:
+                            throw new error_js_1.PluginOptionError(raw);
+                    }
+                }
+                value.split("+");
+                break;
+            case "ts_nocheck":
+                switch (value) {
+                    case "true":
+                    case "1":
+                        tsNocheck = true;
+                        break;
+                    case "false":
+                    case "0":
+                        tsNocheck = false;
+                        break;
+                    default:
+                        throw new error_js_1.PluginOptionError(raw);
+                }
+                break;
+            case "bootstrap_wkt":
+                switch (value) {
+                    case "true":
+                    case "1":
+                        bootstrapWkt = true;
+                        break;
+                    case "false":
+                    case "0":
+                        bootstrapWkt = false;
+                        break;
+                    default:
+                        throw new error_js_1.PluginOptionError(raw);
+                }
+                break;
+            case "rewrite_imports": {
+                const parts = value.split(":");
+                if (parts.length !== 2) {
+                    throw new error_js_1.PluginOptionError(raw, "must be in the form of <pattern>:<target>");
+                }
+                const [pattern, target] = parts;
+                rewriteImports.push({ pattern, target });
+                // rewrite_imports can be noisy and is more of an implementation detail
+                // so we strip it out of the preamble
+                sanitize = true;
+                break;
+            }
+            case "import_extension": {
+                importExtension = value === "none" ? "" : value;
+                break;
+            }
+            case "js_import_style":
+                switch (value) {
+                    case "module":
+                        jsImportStyle = value;
+                        break;
+                    case "legacy_commonjs":
+                        jsImportStyle = value;
+                        break;
+                    default:
+                        throw new error_js_1.PluginOptionError(raw);
+                }
+                break;
+            case "keep_empty_files": {
+                switch (value) {
+                    case "true":
+                    case "1":
+                        keepEmptyFiles = true;
+                        break;
+                    case "false":
+                    case "0":
+                        keepEmptyFiles = false;
+                        break;
+                    default:
+                        throw new error_js_1.PluginOptionError(raw);
+                }
+                break;
+            }
+            default:
+                if (parseExtraOption === undefined) {
+                    throw new error_js_1.PluginOptionError(raw);
+                }
+                try {
+                    parseExtraOption(key, value);
+                }
+                catch (e) {
+                    throw new error_js_1.PluginOptionError(raw, e);
+                }
+                break;
+        }
+        if (!sanitize) {
+            rawParameters.push(raw);
+        }
+    }
+    const sanitizedParameter = rawParameters.join(",");
+    return {
+        targets,
+        tsNocheck,
+        bootstrapWkt,
+        rewriteImports,
+        importExtension,
+        jsImportStyle,
+        keepEmptyFiles,
+        sanitizedParameter,
+    };
+}
+exports.parseParameter = parseParameter;
+function splitParameter(parameter) {
+    if (parameter == undefined) {
+        return [];
+    }
+    return parameter.split(",").map((raw) => {
+        const i = raw.indexOf("=");
+        return {
+            key: i === -1 ? raw : raw.substring(0, i),
+            value: i === -1 ? "" : raw.substring(i + 1),
+            raw,
+        };
+    });
+}

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

@@ -0,0 +1,100 @@
+import { DescField, DescMessage, DescOneof } from "../../descriptor-set.js";
+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/protoplugin/ecmascript/reify-wkt.js

@@ -0,0 +1,170 @@
+"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 scalar_js_1 = require("../../scalar.js");
+/**
+ * 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 === scalar_js_1.ScalarType.STRING);
+            const value = message.fields.find((f) => f.number == 2 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === scalar_js_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 === scalar_js_1.ScalarType.INT64);
+            const nanos = message.fields.find((f) => f.number == 2 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === scalar_js_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 === scalar_js_1.ScalarType.INT64);
+            const nanos = message.fields.find((f) => f.number == 2 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === scalar_js_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?.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?.fieldKind !== "enum" ||
+                nullValue.enum.typeName !== "google.protobuf.NullValue") {
+                return undefined;
+            }
+            const numberValue = message.fields.find((f) => f.number == 2 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === scalar_js_1.ScalarType.DOUBLE &&
+                f.oneof === kind);
+            const stringValue = message.fields.find((f) => f.number == 3 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === scalar_js_1.ScalarType.STRING &&
+                f.oneof === kind);
+            const boolValue = message.fields.find((f) => f.number == 4 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === scalar_js_1.ScalarType.BOOL &&
+                f.oneof === kind);
+            const structValue = message.fields.find((f) => f.number == 5 && f.oneof === kind);
+            if (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?.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?.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 === scalar_js_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/protoplugin/ecmascript/runtime-imports.d.ts

@@ -0,0 +1,6 @@
+import type { ImportSymbol } from "./import-symbol.js";
+import type { RuntimeSymbolName } from "../../codegen-info.js";
+export type RuntimeImports = {
+    [K in RuntimeSymbolName]: ImportSymbol;
+};
+export declare function createRuntimeImports(bootstrapWkt: boolean): RuntimeImports;