@bufbuild/protobuf 1.9.0 → 2.0.0-alpha.1

package/dist/cjs/wkt/index.js

@@ -0,0 +1,44 @@
+"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.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./timestamp.js"), exports);
+__exportStar(require("./any.js"), exports);
+__exportStar(require("./wrappers.js"), exports);
+__exportStar(require("./gen/google/protobuf/api_pb.js"), exports);
+__exportStar(require("./gen/google/protobuf/any_pb.js"), exports);
+__exportStar(require("./gen/google/protobuf/descriptor_pb.js"), exports);
+__exportStar(require("./gen/google/protobuf/duration_pb.js"), exports);
+__exportStar(require("./gen/google/protobuf/empty_pb.js"), exports);
+__exportStar(require("./gen/google/protobuf/field_mask_pb.js"), exports);
+__exportStar(require("./gen/google/protobuf/source_context_pb.js"), exports);
+__exportStar(require("./gen/google/protobuf/struct_pb.js"), exports);
+__exportStar(require("./gen/google/protobuf/timestamp_pb.js"), exports);
+__exportStar(require("./gen/google/protobuf/type_pb.js"), exports);
+__exportStar(require("./gen/google/protobuf/wrappers_pb.js"), exports);
+__exportStar(require("./gen/google/protobuf/compiler/plugin_pb.js"), exports);

package/dist/cjs/wkt/timestamp.d.ts

@@ -0,0 +1,21 @@
+import type { Timestamp } from "./gen/google/protobuf/timestamp_pb.js";
+/**
+ * Create a google.protobuf.Timestamp for the current time.
+ */
+export declare function timestampNow(): Timestamp;
+/**
+ * Create a google.protobuf.Timestamp message from an ECMAScript Date.
+ */
+export declare function timestampFromDate(date: Date): Timestamp;
+/**
+ * Convert a google.protobuf.Timestamp message to an ECMAScript Date.
+ */
+export declare function timestampDate(timestamp: Timestamp): Date;
+/**
+ * Create a google.protobuf.Timestamp message from a Unix timestamp in milliseconds.
+ */
+export declare function timestampFromMs(timestampMs: number): Timestamp;
+/**
+ * Convert a google.protobuf.Timestamp to a Unix timestamp in milliseconds.
+ */
+export declare function timestampMs(timestamp: Timestamp): number;

package/dist/cjs/wkt/timestamp.js

@@ -0,0 +1,58 @@
+"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.timestampMs = exports.timestampFromMs = exports.timestampDate = exports.timestampFromDate = exports.timestampNow = void 0;
+const timestamp_pb_js_1 = require("./gen/google/protobuf/timestamp_pb.js");
+const create_js_1 = require("../create.js");
+const proto_int64_js_1 = require("../proto-int64.js");
+/**
+ * Create a google.protobuf.Timestamp for the current time.
+ */
+function timestampNow() {
+    Date.now();
+    return timestampFromDate(new Date());
+}
+exports.timestampNow = timestampNow;
+/**
+ * Create a google.protobuf.Timestamp message from an ECMAScript Date.
+ */
+function timestampFromDate(date) {
+    return timestampFromMs(date.getTime());
+}
+exports.timestampFromDate = timestampFromDate;
+/**
+ * Convert a google.protobuf.Timestamp message to an ECMAScript Date.
+ */
+function timestampDate(timestamp) {
+    return new Date(timestampMs(timestamp));
+}
+exports.timestampDate = timestampDate;
+/**
+ * Create a google.protobuf.Timestamp message from a Unix timestamp in milliseconds.
+ */
+function timestampFromMs(timestampMs) {
+    return (0, create_js_1.create)(timestamp_pb_js_1.TimestampDesc, {
+        seconds: proto_int64_js_1.protoInt64.parse(Math.floor(timestampMs / 1000)),
+        nanos: (timestampMs % 1000) * 1000000,
+    });
+}
+exports.timestampFromMs = timestampFromMs;
+/**
+ * Convert a google.protobuf.Timestamp to a Unix timestamp in milliseconds.
+ */
+function timestampMs(timestamp) {
+    return (Number(timestamp.seconds) * 1000 + Math.ceil(timestamp.nanos / 1000000));
+}
+exports.timestampMs = timestampMs;

package/dist/cjs/wkt/wrappers.d.ts

@@ -0,0 +1,15 @@
+import type { Message } from "../types.js";
+import type { BoolValue, BytesValue, DoubleValue, FloatValue, Int32Value, Int64Value, StringValue, UInt32Value, UInt64Value } from "./gen/google/protobuf/wrappers_pb.js";
+import type { DescField, DescMessage } from "../desc-types.js";
+export declare function isWrapper(arg: Message): arg is DoubleValue | FloatValue | Int64Value | UInt64Value | Int32Value | UInt32Value | BoolValue | StringValue | BytesValue;
+export type WktWrapperDesc = DescMessage & {
+    fields: [
+        DescField & {
+            fieldKind: "scalar";
+            number: 1;
+            name: "value";
+            oneof: undefined;
+        }
+    ];
+};
+export declare function isWrapperDesc(messageDesc: DescMessage): messageDesc is WktWrapperDesc;

package/dist/cjs/wkt/wrappers.js

@@ -0,0 +1,43 @@
+"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.isWrapperDesc = exports.isWrapper = void 0;
+function isWrapper(arg) {
+    return isWrapperTypeName(arg.$typeName);
+}
+exports.isWrapper = isWrapper;
+function isWrapperDesc(messageDesc) {
+    const f = messageDesc.fields[0];
+    return (isWrapperTypeName(messageDesc.typeName) &&
+        f !== undefined &&
+        f.fieldKind == "scalar" &&
+        f.name == "value" &&
+        f.number == 1);
+}
+exports.isWrapperDesc = isWrapperDesc;
+function isWrapperTypeName(name) {
+    return (name.startsWith("google.protobuf.") &&
+        [
+            "DoubleValue",
+            "FloatValue",
+            "Int64Value",
+            "UInt64Value",
+            "Int32Value",
+            "UInt32Value",
+            "BoolValue",
+            "StringValue",
+            "BytesValue",
+        ].includes(name.substring(16)));
+}

package/dist/esm/clone.d.ts

@@ -0,0 +1,6 @@
+import type { MessageShape } from "./types.js";
+import type { DescMessage } from "./desc-types.js";
+/**
+ * Create a deep copy of a message, including extensions and unknown fields.
+ */
+export declare function clone<Desc extends DescMessage>(messageDesc: Desc, message: MessageShape<Desc>): MessageShape<Desc>;

package/dist/esm/clone.js

@@ -0,0 +1,73 @@
+// 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 { reflect } from "./reflect/reflect.js";
+import { isReflectMessage } from "./reflect/guard.js";
+import { ScalarType } from "./reflect/scalar.js";
+/**
+ * Create a deep copy of a message, including extensions and unknown fields.
+ */
+export function clone(messageDesc, message) {
+    return cloneReflect(reflect(messageDesc, message))
+        .message;
+}
+function cloneReflect(i) {
+    const o = reflect(i.desc);
+    for (const f of i.fields) {
+        if (!i.isSet(f)) {
+            continue;
+        }
+        switch (f.fieldKind) {
+            default: {
+                const err = o.set(f, cloneSingular(f, i.get(f)));
+                if (err) {
+                    throw err;
+                }
+                break;
+            }
+            case "list":
+                for (const item of i.get(f)) {
+                    // TODO fix type error
+                    // @ts-expect-error TODO
+                    const err = o.addListItem(f, cloneSingular(f, item));
+                    if (err) {
+                        throw err;
+                    }
+                }
+                break;
+            case "map":
+                for (const entry of i.get(f).entries()) {
+                    const err = o.setMapEntry(f, entry[0], cloneSingular(f, entry[1]));
+                    if (err) {
+                        throw err;
+                    }
+                }
+                break;
+        }
+    }
+    const unknown = i.getUnknown();
+    if (unknown && unknown.length > 0) {
+        o.setUnknown([...unknown]);
+    }
+    return o;
+}
+function cloneSingular(field, value) {
+    if (field.message !== undefined && isReflectMessage(value)) {
+        return cloneReflect(value);
+    }
+    if (field.scalar == ScalarType.BYTES && value instanceof Uint8Array) {
+        // @ts-expect-error T cannot extend Uint8Array in practice
+        return value.slice();
+    }
+    return value;
+}

package/dist/esm/codegenv1/boot.d.ts

@@ -0,0 +1,63 @@
+import type { DescriptorProto_ExtensionRange, FieldDescriptorProto_Label, FieldDescriptorProto_Type, FieldOptions_OptionRetention, FieldOptions_OptionTargetType, FieldOptions_EditionDefault, EnumValueDescriptorProto, FileDescriptorProto } from "../wkt/gen/google/protobuf/descriptor_pb.js";
+import type { DescFile } from "../desc-types.js";
+/**
+ * Hydrate a file descriptor for google/protobuf/descriptor.proto from a plain
+ * object.
+ *
+ * See createFileDescriptorProtoBoot() for details.
+ *
+ * @private
+ */
+export declare function boot(boot: FileDescriptorProtoBoot): DescFile;
+/**
+ * An object literal for initializing the message google.protobuf.FileDescriptorProto
+ * for google/protobuf/descriptor.proto.
+ *
+ * See createFileDescriptorProtoBoot() for details.
+ *
+ * @private
+ */
+export type FileDescriptorProtoBoot = {
+    name: "google/protobuf/descriptor.proto";
+    package: "google.protobuf";
+    messageType: DescriptorProtoBoot[];
+    enumType: EnumDescriptorProtoBoot[];
+};
+export type DescriptorProtoBoot = {
+    name: string;
+    field?: FieldDescriptorProtoBoot[];
+    nestedType?: DescriptorProtoBoot[];
+    enumType?: EnumDescriptorProtoBoot[];
+    extensionRange?: Pick<DescriptorProto_ExtensionRange, "start" | "end">[];
+};
+export type FieldDescriptorProtoBoot = {
+    name: string;
+    number: number;
+    label?: FieldDescriptorProto_Label;
+    type: FieldDescriptorProto_Type;
+    typeName?: string;
+    extendee?: string;
+    defaultValue?: string;
+    options?: FieldOptionsBoot;
+};
+export type FieldOptionsBoot = {
+    packed?: boolean;
+    deprecated?: boolean;
+    retention?: FieldOptions_OptionRetention;
+    targets?: FieldOptions_OptionTargetType[];
+    editionDefaults?: FieldOptions_EditionDefaultBoot[];
+};
+export type FieldOptions_EditionDefaultBoot = Pick<FieldOptions_EditionDefault, "edition" | "value">;
+export type EnumDescriptorProtoBoot = {
+    name: string;
+    value: EnumValueDescriptorProtoBoot[];
+};
+export type EnumValueDescriptorProtoBoot = Pick<EnumValueDescriptorProto, "name" | "number">;
+/**
+ * Creates the message google.protobuf.FileDescriptorProto from an object literal.
+ *
+ * See createFileDescriptorProtoBoot() for details.
+ *
+ * @private
+ */
+export declare function bootFileDescriptorProto(init: FileDescriptorProtoBoot): FileDescriptorProto;

package/dist/esm/codegenv1/boot.js

@@ -0,0 +1,97 @@
+// 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 { restoreJsonNames } from "./restore-json-names.js";
+import { createFileRegistry } from "../reflect/registry.js";
+import { assert } from "../reflect/assert.js";
+/**
+ * Hydrate a file descriptor for google/protobuf/descriptor.proto from a plain
+ * object.
+ *
+ * See createFileDescriptorProtoBoot() for details.
+ *
+ * @private
+ */
+export function boot(boot) {
+    const root = bootFileDescriptorProto(boot);
+    root.messageType.forEach(restoreJsonNames);
+    const reg = createFileRegistry(root, () => undefined);
+    const file = reg.getFile(root.name);
+    assert(file);
+    return file;
+}
+/**
+ * Creates the message google.protobuf.FileDescriptorProto from an object literal.
+ *
+ * See createFileDescriptorProtoBoot() for details.
+ *
+ * @private
+ */
+export function bootFileDescriptorProto(init) {
+    const proto = Object.create({
+        syntax: "",
+        edition: 0,
+    });
+    return Object.assign(proto, Object.assign(Object.assign({ $typeName: "google.protobuf.FileDescriptorProto", dependency: [], publicDependency: [], weakDependency: [], service: [], extension: [] }, init), { messageType: init.messageType.map(bootDescriptorProto), enumType: init.enumType.map(bootEnumDescriptorProto) }));
+}
+function bootDescriptorProto(init) {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    return {
+        $typeName: "google.protobuf.DescriptorProto",
+        name: init.name,
+        field: (_b = (_a = init.field) === null || _a === void 0 ? void 0 : _a.map(bootFieldDescriptorProto)) !== null && _b !== void 0 ? _b : [],
+        extension: [],
+        nestedType: (_d = (_c = init.nestedType) === null || _c === void 0 ? void 0 : _c.map(bootDescriptorProto)) !== null && _d !== void 0 ? _d : [],
+        enumType: (_f = (_e = init.enumType) === null || _e === void 0 ? void 0 : _e.map(bootEnumDescriptorProto)) !== null && _f !== void 0 ? _f : [],
+        extensionRange: (_h = (_g = init.extensionRange) === null || _g === void 0 ? void 0 : _g.map((e) => (Object.assign({ $typeName: "google.protobuf.DescriptorProto.ExtensionRange" }, e)))) !== null && _h !== void 0 ? _h : [],
+        oneofDecl: [],
+        reservedRange: [],
+        reservedName: [],
+    };
+}
+function bootFieldDescriptorProto(init) {
+    const proto = Object.create({
+        label: 1,
+        typeName: "",
+        extendee: "",
+        defaultValue: "",
+        oneofIndex: 0,
+        jsonName: "",
+        proto3Optional: false,
+    });
+    return Object.assign(proto, Object.assign(Object.assign({ $typeName: "google.protobuf.FieldDescriptorProto" }, init), { options: init.options ? bootFieldOptions(init.options) : undefined }));
+}
+function bootFieldOptions(init) {
+    var _a, _b, _c;
+    const proto = Object.create({
+        ctype: 0,
+        packed: false,
+        jstype: 0,
+        lazy: false,
+        unverifiedLazy: false,
+        deprecated: false,
+        weak: false,
+        debugRedact: false,
+        retention: 0,
+    });
+    return Object.assign(proto, Object.assign(Object.assign({ $typeName: "google.protobuf.FieldOptions" }, init), { targets: (_a = init.targets) !== null && _a !== void 0 ? _a : [], editionDefaults: (_c = (_b = init.editionDefaults) === null || _b === void 0 ? void 0 : _b.map((e) => (Object.assign({ $typeName: "google.protobuf.FieldOptions.EditionDefault" }, e)))) !== null && _c !== void 0 ? _c : [], uninterpretedOption: [] }));
+}
+function bootEnumDescriptorProto(init) {
+    return {
+        $typeName: "google.protobuf.EnumDescriptorProto",
+        name: init.name,
+        reservedName: [],
+        reservedRange: [],
+        value: init.value.map((e) => (Object.assign({ $typeName: "google.protobuf.EnumValueDescriptorProto" }, e))),
+    };
+}

package/dist/esm/codegenv1/embed.d.ts

@@ -0,0 +1,43 @@
+import type { DescEnum, DescExtension, DescFile, DescMessage, DescService } from "../desc-types.js";
+import type { FileDescriptorProto } from "../wkt/gen/google/protobuf/descriptor_pb.js";
+import type { FileDescriptorProtoBoot } from "./boot.js";
+type EmbedUnknown = {
+    bootable: false;
+    proto(): FileDescriptorProto;
+    base64(): string;
+};
+type EmbedDescriptorProto = Omit<EmbedUnknown, "bootable"> & {
+    bootable: true;
+    boot(): FileDescriptorProtoBoot;
+};
+/**
+ * Create necessary information to embed a file descriptor in
+ * generated code.
+ *
+ * @private
+ */
+export declare function embedFileDesc(file: DescFile): EmbedUnknown | EmbedDescriptorProto;
+/**
+ * Compute the path to a message, enumeration, extension, or service in a
+ * file descriptor.
+ *
+ * @private
+ */
+export declare function pathInFileDesc(desc: DescMessage | DescEnum | DescExtension | DescService): number[];
+/**
+ * The file descriptor for google/protobuf/descriptor.proto cannot be embedded
+ * in serialized form, since it is required to parse itself.
+ *
+ * This function takes an instance of the message, and returns a plain object
+ * that can be hydrated to the message again via bootFileDescriptorProto().
+ *
+ * This function only works with a message google.protobuf.FileDescriptorProto
+ * for google/protobuf/descriptor.proto, and only supports features that are
+ * relevant for the specific use case. For example, it discards file options,
+ * reserved ranges and reserved names, and field options that are unused in
+ * descriptor.proto.
+ *
+ * @private
+ */
+export declare function createFileDescriptorProtoBoot(proto: FileDescriptorProto): FileDescriptorProtoBoot;
+export {};