@bufbuild/protobuf 2.0.0-alpha.1 → 2.0.0-alpha.3

package/dist/esm/codegenv1/boot.js

@@ -12,8 +12,7 @@
 // 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";
+import { createFileRegistry } from "../registry.js";
 /**
  * Hydrate a file descriptor for google/protobuf/descriptor.proto from a plain
  * object.
@@ -26,9 +25,8 @@ 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;
+    // non-null assertion because we just created the registry from the file we look up
+    return reg.getFile(root.name);
 }
 /**
  * Creates the message google.protobuf.FileDescriptorProto from an object literal.

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

@@ -1,4 +1,4 @@
-import type { DescEnum, DescExtension, DescFile, DescMessage, DescService } from "../desc-types.js";
+import type { DescEnum, DescExtension, DescMessage, DescService } from "../descriptors.js";
 import type { FileDescriptorProto } from "../wkt/gen/google/protobuf/descriptor_pb.js";
 import type { FileDescriptorProtoBoot } from "./boot.js";
 type EmbedUnknown = {
@@ -16,7 +16,7 @@ type EmbedDescriptorProto = Omit<EmbedUnknown, "bootable"> & {
  *
  * @private
  */
-export declare function embedFileDesc(file: DescFile): EmbedUnknown | EmbedDescriptorProto;
+export declare function embedFileDesc(file: FileDescriptorProto): EmbedUnknown | EmbedDescriptorProto;
 /**
  * Compute the path to a message, enumeration, extension, or service in a
  * file descriptor.

package/dist/esm/codegenv1/embed.js

@@ -12,7 +12,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 import { protoCamelCase } from "../reflect/names.js";
-import { assert } from "../reflect/assert.js";
 import { isFieldSet, clearField } from "../fields.js";
 import { base64Encode } from "../wire/base64-encoding.js";
 import { toBinary } from "../to-binary.js";
@@ -28,9 +27,9 @@ export function embedFileDesc(file) {
     const embed = {
         bootable: false,
         proto() {
-            const stripped = clone(FileDescriptorProtoDesc, file.proto);
-            clearField(FileDescriptorProtoDesc, stripped, "dependency");
-            clearField(FileDescriptorProtoDesc, stripped, "sourceCodeInfo");
+            const stripped = clone(FileDescriptorProtoDesc, file);
+            clearField(stripped, FileDescriptorProtoDesc.field.dependency);
+            clearField(stripped, FileDescriptorProtoDesc.field.sourceCodeInfo);
             stripped.messageType.map(stripJsonNames);
             return stripped;
         },
@@ -39,7 +38,7 @@ export function embedFileDesc(file) {
             return base64Encode(bytes, "std_raw");
         },
     };
-    return file.proto.name == "google/protobuf/descriptor.proto"
+    return file.name == "google/protobuf/descriptor.proto"
         ? Object.assign(Object.assign({}, embed), { bootable: true, boot() {
                 return createFileDescriptorProtoBoot(this.proto());
             } }) : embed;
@@ -47,7 +46,7 @@ export function embedFileDesc(file) {
 function stripJsonNames(d) {
     for (const f of d.field) {
         if (f.jsonName === protoCamelCase(f.name)) {
-            clearField(FieldDescriptorProtoDesc, f, "jsonName");
+            clearField(f, FieldDescriptorProtoDesc.field.jsonName);
         }
     }
     for (const n of d.nestedType) {
@@ -135,7 +134,6 @@ function createDescriptorBoot(proto) {
     assert(proto.extension.length == 0);
     assert(!proto.oneofDecl.length);
     assert(!proto.options);
-    assert(!proto.reservedName.length); // we're also dropping reserved_range
     const b = {
         name: proto.name,
     };
@@ -157,27 +155,27 @@ function createDescriptorBoot(proto) {
     return b;
 }
 function createFieldDescriptorBoot(proto) {
-    assert(isFieldSet(FieldDescriptorProtoDesc, proto, "name"));
-    assert(isFieldSet(FieldDescriptorProtoDesc, proto, "number"));
-    assert(isFieldSet(FieldDescriptorProtoDesc, proto, "type"));
-    assert(!isFieldSet(FieldDescriptorProtoDesc, proto, "oneofIndex"));
-    assert(!isFieldSet(FieldDescriptorProtoDesc, proto, "jsonName") ||
+    assert(isFieldSet(proto, FieldDescriptorProtoDesc.field.name));
+    assert(isFieldSet(proto, FieldDescriptorProtoDesc.field.number));
+    assert(isFieldSet(proto, FieldDescriptorProtoDesc.field.type));
+    assert(!isFieldSet(proto, FieldDescriptorProtoDesc.field.oneofIndex));
+    assert(!isFieldSet(proto, FieldDescriptorProtoDesc.field.jsonName) ||
         proto.jsonName === protoCamelCase(proto.name));
     const b = {
         name: proto.name,
         number: proto.number,
         type: proto.type,
     };
-    if (isFieldSet(FieldDescriptorProtoDesc, proto, "label")) {
+    if (isFieldSet(proto, FieldDescriptorProtoDesc.field.label)) {
         b.label = proto.label;
     }
-    if (isFieldSet(FieldDescriptorProtoDesc, proto, "typeName")) {
+    if (isFieldSet(proto, FieldDescriptorProtoDesc.field.typeName)) {
         b.typeName = proto.typeName;
     }
-    if (isFieldSet(FieldDescriptorProtoDesc, proto, "extendee")) {
+    if (isFieldSet(proto, FieldDescriptorProtoDesc.field.extendee)) {
         b.extendee = proto.extendee;
     }
-    if (isFieldSet(FieldDescriptorProtoDesc, proto, "defaultValue")) {
+    if (isFieldSet(proto, FieldDescriptorProtoDesc.field.defaultValue)) {
         b.defaultValue = proto.defaultValue;
     }
     if (proto.options) {
@@ -187,19 +185,19 @@ function createFieldDescriptorBoot(proto) {
 }
 function createFieldOptionsBoot(proto) {
     const b = {};
-    assert(!isFieldSet(FieldOptionsDesc, proto, "ctype"));
-    if (isFieldSet(FieldOptionsDesc, proto, "packed")) {
+    assert(!isFieldSet(proto, FieldOptionsDesc.field.ctype));
+    if (isFieldSet(proto, FieldOptionsDesc.field.packed)) {
         b.packed = proto.packed;
     }
-    assert(!isFieldSet(FieldOptionsDesc, proto, "jstype"));
-    assert(!isFieldSet(FieldOptionsDesc, proto, "lazy"));
-    assert(!isFieldSet(FieldOptionsDesc, proto, "unverifiedLazy"));
-    if (isFieldSet(FieldOptionsDesc, proto, "deprecated")) {
+    assert(!isFieldSet(proto, FieldOptionsDesc.field.jstype));
+    assert(!isFieldSet(proto, FieldOptionsDesc.field.lazy));
+    assert(!isFieldSet(proto, FieldOptionsDesc.field.unverifiedLazy));
+    if (isFieldSet(proto, FieldOptionsDesc.field.deprecated)) {
         b.deprecated = proto.deprecated;
     }
-    assert(!isFieldSet(FieldOptionsDesc, proto, "weak"));
-    assert(!isFieldSet(FieldOptionsDesc, proto, "debugRedact"));
-    if (isFieldSet(FieldOptionsDesc, proto, "retention")) {
+    assert(!isFieldSet(proto, FieldOptionsDesc.field.weak));
+    assert(!isFieldSet(proto, FieldOptionsDesc.field.debugRedact));
+    if (isFieldSet(proto, FieldOptionsDesc.field.retention)) {
         b.retention = proto.retention;
     }
     if (proto.targets.length) {
@@ -211,13 +209,11 @@ function createFieldOptionsBoot(proto) {
             edition: d.edition,
         }));
     }
-    assert(!isFieldSet(FieldOptionsDesc, proto, "features"));
-    assert(!isFieldSet(FieldOptionsDesc, proto, "uninterpretedOption"));
+    assert(!isFieldSet(proto, FieldOptionsDesc.field.features));
+    assert(!isFieldSet(proto, FieldOptionsDesc.field.uninterpretedOption));
     return b;
 }
 function createEnumDescriptorBoot(proto) {
-    assert(!proto.reservedName.length);
-    assert(!proto.reservedRange.length);
     assert(!proto.options);
     return {
         name: proto.name,
@@ -230,3 +226,12 @@ function createEnumDescriptorBoot(proto) {
         }),
     };
 }
+/**
+ * Assert that condition is truthy or throw error.
+ */
+function assert(condition) {
+    // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions -- we want the implicit conversion to boolean
+    if (!condition) {
+        throw new Error();
+    }
+}

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

@@ -1,4 +1,4 @@
-import type { DescEnum, DescFile } from "../desc-types.js";
+import type { DescEnum, DescFile } from "../descriptors.js";
 import type { GenDescEnum } from "./types.js";
 /**
  * Hydrate an enum descriptor.

package/dist/esm/codegenv1/enum.js

@@ -11,7 +11,6 @@
 // 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 { localName } from "../reflect/names.js";
 /**
  * Hydrate an enum descriptor.
  *
@@ -30,9 +29,8 @@ export function enumDesc(file, path, ...paths) {
 export function tsEnum(desc) {
     const enumObject = {};
     for (const value of desc.values) {
-        const name = localName(value);
-        enumObject[name] = value.number;
-        enumObject[value.number] = name;
+        enumObject[value.localName] = value.number;
+        enumObject[value.number] = value.localName;
     }
     return enumObject;
 }

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

@@ -1,5 +1,5 @@
 import type { Message } from "../types.js";
-import type { DescFile } from "../desc-types.js";
+import type { DescFile } from "../descriptors.js";
 import type { GenDescExtension } from "./types.js";
 /**
  * Hydrate an extension descriptor.

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

@@ -1,4 +1,4 @@
-import type { DescFile } from "../desc-types.js";
+import type { DescFile } from "../descriptors.js";
 /**
  * Hydrate a file descriptor.
  *

package/dist/esm/codegenv1/file.js

@@ -11,10 +11,9 @@
 // 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 { base64Decode } from "../wire/index.js";
+import { base64Decode } from "../wire/base64-encoding.js";
 import { FileDescriptorProtoDesc } from "../wkt/gen/google/protobuf/descriptor_pb.js";
-import { createFileRegistry } from "../reflect/registry.js";
-import { assert } from "../reflect/assert.js";
+import { createFileRegistry } from "../registry.js";
 import { restoreJsonNames } from "./restore-json-names.js";
 import { fromBinary } from "../from-binary.js";
 /**
@@ -28,7 +27,6 @@ export function fileDesc(b64, imports) {
     root.messageType.forEach(restoreJsonNames);
     root.dependency = (_a = imports === null || imports === void 0 ? void 0 : imports.map((f) => f.proto.name)) !== null && _a !== void 0 ? _a : [];
     const reg = createFileRegistry(root, (protoFileName) => imports === null || imports === void 0 ? void 0 : imports.find((f) => f.proto.name === protoFileName));
-    const file = reg.getFile(root.name);
-    assert(file);
-    return file;
+    // non-null assertion because we just created the registry from the file we look up
+    return reg.getFile(root.name);
 }

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

@@ -6,4 +6,5 @@ export * from "./file.js";
 export * from "./message.js";
 export * from "./service.js";
 export * from "./symbols.js";
+export * from "./scalar.js";
 export * from "./types.js";

package/dist/esm/codegenv1/index.js

@@ -19,4 +19,5 @@ export * from "./file.js";
 export * from "./message.js";
 export * from "./service.js";
 export * from "./symbols.js";
+export * from "./scalar.js";
 export * from "./types.js";

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

@@ -1,5 +1,5 @@
 import type { Message } from "../types.js";
-import type { DescFile } from "../desc-types.js";
+import type { DescFile } from "../descriptors.js";
 import type { GenDescMessage } from "./types.js";
 /**
  * Hydrate a message descriptor.

package/dist/esm/codegenv1/restore-json-names.d.ts

@@ -1,2 +1,5 @@
 import type { DescriptorProto } from "../wkt/gen/google/protobuf/descriptor_pb.js";
+/**
+ * @private
+ */
 export declare function restoreJsonNames(message: DescriptorProto): void;

package/dist/esm/codegenv1/restore-json-names.js

@@ -13,6 +13,9 @@
 // limitations under the License.
 import { protoCamelCase } from "../reflect/names.js";
 import { unsafeIsSetExplicit } from "../reflect/unsafe.js";
+/**
+ * @private
+ */
 export function restoreJsonNames(message) {
     for (const f of message.field) {
         if (!unsafeIsSetExplicit(f, "jsonName")) {

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

@@ -0,0 +1,5 @@
+import { ScalarType } from "../descriptors.js";
+/**
+ * Return the TypeScript type (as a string) for the given scalar type.
+ */
+export declare function scalarTypeScriptType(scalar: ScalarType, longAsString: boolean): "string" | "boolean" | "bigint" | "bigint | string" | "Uint8Array" | "number";

package/dist/esm/codegenv1/scalar.js

@@ -0,0 +1,35 @@
+// 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 { ScalarType } from "../descriptors.js";
+/**
+ * Return the TypeScript type (as a string) for the given scalar type.
+ */
+export function scalarTypeScriptType(scalar, longAsString) {
+    switch (scalar) {
+        case ScalarType.STRING:
+            return "string";
+        case ScalarType.BOOL:
+            return "boolean";
+        case ScalarType.UINT64:
+        case ScalarType.SFIXED64:
+        case ScalarType.FIXED64:
+        case ScalarType.SINT64:
+        case ScalarType.INT64:
+            return longAsString ? "string" : "bigint";
+        case ScalarType.BYTES:
+            return "Uint8Array";
+        default:
+            return "number";
+    }
+}

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

@@ -1,8 +1,8 @@
-import type { GenDescService, GenDescServiceShape } from "./types.js";
-import type { DescFile } from "../desc-types.js";
+import type { GenDescService, GenDescServiceMethods } from "./types.js";
+import type { DescFile } from "../descriptors.js";
 /**
  * Hydrate a service descriptor.
  *
  * @private
  */
-export declare function serviceDesc<T extends GenDescServiceShape>(file: DescFile, path: number, ...paths: number[]): GenDescService<T>;
+export declare function serviceDesc<T extends GenDescServiceMethods>(file: DescFile, path: number, ...paths: number[]): GenDescService<T>;

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

@@ -1,5 +1,14 @@
+/**
+ * @private
+ */
 export declare const packageName = "@bufbuild/protobuf";
+/**
+ * @private
+ */
 export declare const wktPublicImportPaths: Readonly<Record<string, string>>;
+/**
+ * @private
+ */
 export declare const symbols: {
     readonly isMessage: {
         readonly typeOnly: false;

package/dist/esm/codegenv1/symbols.js

@@ -11,7 +11,13 @@
 // 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.
+/**
+ * @private
+ */
 export const packageName = "@bufbuild/protobuf";
+/**
+ * @private
+ */
 export const wktPublicImportPaths = {
     "google/protobuf/compiler/plugin.proto": packageName + "/wkt",
     "google/protobuf/any.proto": packageName + "/wkt",
@@ -26,6 +32,9 @@ export const wktPublicImportPaths = {
     "google/protobuf/type.proto": packageName + "/wkt",
     "google/protobuf/wrappers.proto": packageName + "/wkt",
 };
+/**
+ * @private
+ */
 // prettier-ignore
 export const symbols = {
     isMessage: { typeOnly: false, bootstrapWktFrom: "../../is-message.js", from: packageName },

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

@@ -1,19 +1,70 @@
 import type { Message } from "../types.js";
-import type { DescEnum, DescExtension, DescFile, DescMessage, DescService } from "../desc-types.js";
+import type { DescEnum, DescExtension, DescField, DescFile, DescMessage, DescMethod, DescService } from "../descriptors.js";
+/**
+ * Describes a protobuf source file.
+ *
+ * @private
+ */
 export type GenDescFile = DescFile;
-export type GenDescMessage<RuntimeShape extends Message> = DescMessage & brand<RuntimeShape>;
+/**
+ * Describes a message declaration in a protobuf source file.
+ *
+ * This type is identical to DescMessage, but carries additional type
+ * information.
+ *
+ * @private
+ */
+export type GenDescMessage<RuntimeShape extends Message> = Omit<DescMessage, "field"> & {
+    field: Record<MessageFieldNames<RuntimeShape>, DescField>;
+} & brand<RuntimeShape>;
+/**
+ * Describes an enumeration in a protobuf source file.
+ *
+ * This type is identical to DescEnum, but carries additional type
+ * information.
+ *
+ * @private
+ */
 export type GenDescEnum<RuntimeShape> = DescEnum & brand<RuntimeShape>;
+/**
+ * Describes an extension in a protobuf source file.
+ *
+ * This type is identical to DescExtension, but carries additional type
+ * information.
+ *
+ * @private
+ */
 export type GenDescExtension<Extendee extends Message = Message, RuntimeShape = unknown> = DescExtension & brand<Extendee, RuntimeShape>;
-export type GenDescService<RuntimeShape extends GenDescServiceShape> = DescService & brand<RuntimeShape>;
-export type GenDescServiceShape = {
-    [localName: string]: {
-        kind: "unary" | "server_streaming" | "client_streaming" | "bidi_streaming";
-        I: Message;
-        O: Message;
+/**
+ * Describes a service declaration in a protobuf source file.
+ *
+ * This type is identical to DescService, but carries additional type
+ * information.
+ *
+ * @private
+ */
+export type GenDescService<RuntimeShape extends GenDescServiceMethods> = Omit<DescService, "method"> & {
+    method: {
+        [K in keyof RuntimeShape]: RuntimeShape[K] & DescMethod;
     };
 };
+/**
+ * @private
+ */
+export type GenDescServiceMethods = Record<string, Pick<DescMethod, "input" | "output" | "methodKind">>;
 declare class brand<A, B = unknown> {
     protected a: A | boolean;
     protected b: B | boolean;
 }
+/**
+ * Union of the property names of all fields, including oneof members.
+ * For an anonymous message (no generated message shape), it's simply a string.
+ */
+type MessageFieldNames<T extends Message> = Message extends T ? string : Exclude<keyof {
+    [P in keyof T as P extends ("$typeName" | "$unknown") ? never : T[P] extends Oneof<infer K> ? K : P]-?: true;
+}, number | symbol>;
+type Oneof<K extends string> = {
+    case: K | undefined;
+    value?: unknown;
+};
 export {};

package/dist/esm/create.d.ts

@@ -1,4 +1,4 @@
-import type { DescMessage } from "./desc-types.js";
+import { type DescMessage } from "./descriptors.js";
 import type { MessageInitShape, MessageShape } from "./types.js";
 /**
  * Create a new message instance.

package/dist/esm/create.js

@@ -12,16 +12,14 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 import { isMessage } from "./is-message.js";
-import { localName } from "./reflect/names.js";
-import { LongType, ScalarType, scalarZeroValue } from "./reflect/scalar.js";
+import { ScalarType, } from "./descriptors.js";
+import { scalarZeroValue } from "./reflect/scalar.js";
 import { FieldError } from "./reflect/error.js";
 import { isObject } from "./reflect/guard.js";
 import { unsafeGet, unsafeOneofCase, unsafeSet } from "./reflect/unsafe.js";
 import { isWrapperDesc } from "./wkt/wrappers.js";
 // bootstrap-inject google.protobuf.Edition.EDITION_PROTO3: const $name: Edition.$localName = $number;
 const EDITION_PROTO3 = 999;
-// bootstrap-inject google.protobuf.FeatureSet.FieldPresence.EXPLICIT: const $name: FeatureSet_FieldPresence.$localName = $number;
-const EXPLICIT = 1;
 // bootstrap-inject google.protobuf.FeatureSet.FieldPresence.IMPLICIT: const $name: FeatureSet_FieldPresence.$localName = $number;
 const IMPLICIT = 2;
 /**
@@ -45,7 +43,7 @@ export function create(messageDesc, init) {
  */
 function initMessage(messageDesc, message, init) {
     for (const member of messageDesc.members) {
-        let value = init[localName(member)];
+        let value = init[member.localName];
         if (value == null) {
             // intentionally ignore undefined and null
             continue;
@@ -143,17 +141,9 @@ function createZeroMessage(desc) {
         // the `optional` keyword generate an optional property.
         msg = {};
         for (const member of desc.members) {
-            if (member.kind == "field") {
-                if (member.fieldKind == "scalar" ||
-                    member.fieldKind == "enum" ||
-                    member.fieldKind == "message") {
-                    if (member.presence == EXPLICIT) {
-                        // skips message fields and optional scalar/enum
-                        continue;
-                    }
-                }
+            if (member.kind == "oneof" || member.presence == IMPLICIT) {
+                msg[member.localName] = createZeroField(member);
             }
-            msg[localName(member)] = createZeroField(member);
         }
     }
     else {
@@ -180,12 +170,12 @@ function createZeroMessage(desc) {
                     continue;
                 }
                 if (member.presence == IMPLICIT) {
-                    // implicit presence tracks field presence by zero values
-                    // e.g. 0, false, "", are unset, 1, true, "x" are set
+                    // implicit presence tracks field presence by zero values - e.g. 0, false, "", are unset, 1, true, "x" are set.
+                    // message, map, list fields are mutable, and also have IMPLICIT presence.
                     continue;
                 }
                 members.add(member);
-                prototype[localName(member)] = createZeroField(member);
+                prototype[member.localName] = createZeroField(member);
             }
             messagePrototypes.set(desc, { prototype, members });
         }
@@ -204,7 +194,7 @@ function createZeroMessage(desc) {
                     }
                 }
             }
-            msg[localName(member)] = createZeroField(member);
+            msg[member.localName] = createZeroField(member);
         }
     }
     msg.$typeName = desc.typeName;
@@ -229,11 +219,11 @@ function createZeroField(field) {
     }
     const defaultValue = field.getDefaultValue();
     if (defaultValue !== undefined) {
-        return field.fieldKind == "scalar" && field.longType == LongType.STRING
+        return field.fieldKind == "scalar" && field.longAsString
             ? defaultValue.toString()
             : defaultValue;
     }
     return field.fieldKind == "scalar"
-        ? scalarZeroValue(field.scalar, field.longType)
+        ? scalarZeroValue(field.scalar, field.longAsString)
         : field.enum.values[0].number;
 }