@bufbuild/protobuf 0.1.1 → 0.2.0

package/dist/cjs/create-descriptor-set.js

@@ -440,24 +440,24 @@ function newField(proto, file, parent, oneof, cart) {
             const mapEntry = cart.mapEntries.get(trimLeadingDot(proto.typeName));
             if (mapEntry !== undefined) {
                 (0, assert_js_1.assert)(repeated, `invalid FieldDescriptorProto: expected map entry to be repeated`);
-                return Object.assign(Object.assign(Object.assign({}, common), { kind: "map_field", repeated: false }), getMapFieldTypes(mapEntry));
+                return Object.assign(Object.assign(Object.assign({}, common), { kind: "field", fieldKind: "map", repeated: false }), getMapFieldTypes(mapEntry));
             }
             const message = cart.messages.get(trimLeadingDot(proto.typeName));
             (0, assert_js_1.assert)(message !== undefined, `invalid FieldDescriptorProto: type_name ${proto.typeName} not found`);
-            return Object.assign(Object.assign({}, common), { kind: "message_field", repeated,
+            return Object.assign(Object.assign({}, common), { kind: "field", fieldKind: "message", repeated,
                 message });
         }
         case descriptor_pb_js_1.FieldDescriptorProto_Type.ENUM: {
             (0, assert_js_1.assert)(proto.typeName, `invalid FieldDescriptorProto: missing type_name`);
             const e = cart.enums.get(trimLeadingDot(proto.typeName));
             (0, assert_js_1.assert)(e !== undefined, `invalid FieldDescriptorProto: type_name ${proto.typeName} not found`);
-            return Object.assign(Object.assign({}, common), { kind: "enum_field", getDefaultValue,
+            return Object.assign(Object.assign({}, common), { kind: "field", fieldKind: "enum", getDefaultValue,
                 repeated, enum: e });
         }
         default: {
             const scalar = fieldTypeToScalarType[proto.type];
             (0, assert_js_1.assert)(scalar, `invalid FieldDescriptorProto: unknown type ${proto.type}`);
-            return Object.assign(Object.assign({}, common), { kind: "scalar_field", getDefaultValue,
+            return Object.assign(Object.assign({}, common), { kind: "field", fieldKind: "scalar", getDefaultValue,
                 repeated,
                 scalar });
         }
@@ -472,7 +472,7 @@ function newExtension(proto, file, parent, cart) {
     undefined, cart);
     const extendee = cart.messages.get(trimLeadingDot(proto.extendee));
     (0, assert_js_1.assert)(extendee, `invalid FieldDescriptorProto: extendee ${proto.extendee} not found`);
-    return Object.assign(Object.assign({}, field), { typeName: makeTypeName(proto, parent, file), parent,
+    return Object.assign(Object.assign({}, field), { kind: "extension", typeName: makeTypeName(proto, parent, file), parent,
         file,
         extendee,
         toString() {
@@ -541,18 +541,18 @@ function getMapFieldTypes(mapEntry) {
         mapKey !== field_js_1.ScalarType.DOUBLE, `invalid DescriptorProto: map entry ${mapEntry.toString()} has unexpected key type ${(_b = keyField.proto.type) !== null && _b !== void 0 ? _b : -1}`);
     const valueField = mapEntry.fields.find((f) => f.proto.number === 2);
     (0, assert_js_1.assert)(valueField, `invalid DescriptorProto: map entry ${mapEntry.toString()} is missing value field`);
-    switch (valueField.kind) {
-        case "scalar_field":
+    switch (valueField.fieldKind) {
+        case "scalar":
             return {
                 mapKey,
                 mapValue: Object.assign(Object.assign({}, valueField), { kind: "scalar" }),
             };
-        case "message_field":
+        case "message":
             return {
                 mapKey,
                 mapValue: Object.assign(Object.assign({}, valueField), { kind: "message" }),
             };
-        case "enum_field":
+        case "enum":
             return {
                 mapKey,
                 mapValue: Object.assign(Object.assign({}, valueField), { kind: "enum" }),
@@ -711,23 +711,23 @@ function declarationString() {
     if (this.optional) {
         parts.push("optional");
     }
-    const file = "extendee" in this ? this.file : this.parent.file;
+    const file = this.kind === "extension" ? this.file : this.parent.file;
     if (file.syntax == "proto2" &&
         this.proto.label === descriptor_pb_js_1.FieldDescriptorProto_Label.REQUIRED) {
         parts.push("required");
     }
     let type;
-    switch (this.kind) {
-        case "scalar_field":
+    switch (this.fieldKind) {
+        case "scalar":
             type = field_js_1.ScalarType[this.scalar].toLowerCase();
             break;
-        case "enum_field":
+        case "enum":
             type = this.enum.typeName;
             break;
-        case "message_field":
+        case "message":
             type = this.message.typeName;
             break;
-        case "map_field": {
+        case "map": {
             const k = field_js_1.ScalarType[this.mapKey].toLowerCase();
             let v;
             switch (this.mapValue.kind) {
@@ -777,13 +777,13 @@ function getDefaultValue() {
     if (d === undefined) {
         return undefined;
     }
-    switch (this.kind) {
-        case "enum_field": {
+    switch (this.fieldKind) {
+        case "enum": {
             const enumValue = this.enum.values.find((v) => v.name === d);
             (0, assert_js_1.assert)(enumValue, `cannot parse ${this.toString()} default value: ${d}`);
             return enumValue.number;
         }
-        case "scalar_field":
+        case "scalar":
             switch (this.scalar) {
                 case field_js_1.ScalarType.STRING:
                     return d;

package/dist/cjs/create-registry-from-desc.js

@@ -161,17 +161,17 @@ function createRegistryFromDescriptors(input, replaceWkt = true) {
 }
 exports.createRegistryFromDescriptors = createRegistryFromDescriptors;
 function makeFieldInfo(desc, resolver) {
-    switch (desc.kind) {
-        case "map_field":
+    switch (desc.fieldKind) {
+        case "map":
             return makeMapFieldInfo(desc, resolver);
-        case "message_field":
+        case "message":
             return makeMessageFieldInfo(desc, resolver);
-        case "enum_field": {
+        case "enum": {
             const fi = makeEnumFieldInfo(desc, resolver);
             fi.default = desc.getDefaultValue();
             return fi;
         }
-        case "scalar_field": {
+        case "scalar": {
             const fi = makeScalarFieldInfo(desc);
             fi.default = desc.getDefaultValue();
             return fi;

package/dist/cjs/google/protobuf/struct_pb.js

@@ -14,7 +14,7 @@
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ListValue = exports.Value = exports.Struct = exports.NullValue = void 0;
-// @generated by protoc-gen-es v0.1.1 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
+// @generated by protoc-gen-es v0.2.0 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
 // @generated from file google/protobuf/struct.proto (package google.protobuf, syntax proto3)
 /* eslint-disable */
 const proto3_js_1 = require("../../proto3.js");

package/dist/cjs/google/protobuf/type_pb.js

@@ -14,7 +14,7 @@
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Option = exports.EnumValue = exports.Enum = exports.Field_Cardinality = exports.Field_Kind = exports.Field = exports.Type = exports.Syntax = void 0;
-// @generated by protoc-gen-es v0.1.1 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
+// @generated by protoc-gen-es v0.2.0 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
 // @generated from file google/protobuf/type.proto (package google.protobuf, syntax proto3)
 /* eslint-disable */
 const proto3_js_1 = require("../../proto3.js");

package/dist/cjs/private/field-wrapper.js

@@ -40,7 +40,7 @@ exports.unwrapField = unwrapField;
  * the base type it wraps.
  */
 function getUnwrappedFieldType(field) {
-    if (field.kind !== "message_field") {
+    if (field.fieldKind !== "message") {
         return undefined;
     }
     if (field.repeated) {

package/dist/cjs/private/names.js

@@ -24,10 +24,7 @@ exports.findEnumSharedPrefix = exports.fieldJsonName = exports.localOneofName =
  */
 function localName(desc) {
     switch (desc.kind) {
-        case "enum_field":
-        case "message_field":
-        case "map_field":
-        case "scalar_field":
+        case "field":
             return localFieldName(desc.name, desc.oneof !== undefined);
         case "oneof":
             return localOneofName(desc.name);

package/dist/esm/create-descriptor-set.js

@@ -436,24 +436,24 @@ function newField(proto, file, parent, oneof, cart) {
             const mapEntry = cart.mapEntries.get(trimLeadingDot(proto.typeName));
             if (mapEntry !== undefined) {
                 assert(repeated, `invalid FieldDescriptorProto: expected map entry to be repeated`);
-                return Object.assign(Object.assign(Object.assign({}, common), { kind: "map_field", repeated: false }), getMapFieldTypes(mapEntry));
+                return Object.assign(Object.assign(Object.assign({}, common), { kind: "field", fieldKind: "map", repeated: false }), getMapFieldTypes(mapEntry));
             }
             const message = cart.messages.get(trimLeadingDot(proto.typeName));
             assert(message !== undefined, `invalid FieldDescriptorProto: type_name ${proto.typeName} not found`);
-            return Object.assign(Object.assign({}, common), { kind: "message_field", repeated,
+            return Object.assign(Object.assign({}, common), { kind: "field", fieldKind: "message", repeated,
                 message });
         }
         case FieldDescriptorProto_Type.ENUM: {
             assert(proto.typeName, `invalid FieldDescriptorProto: missing type_name`);
             const e = cart.enums.get(trimLeadingDot(proto.typeName));
             assert(e !== undefined, `invalid FieldDescriptorProto: type_name ${proto.typeName} not found`);
-            return Object.assign(Object.assign({}, common), { kind: "enum_field", getDefaultValue,
+            return Object.assign(Object.assign({}, common), { kind: "field", fieldKind: "enum", getDefaultValue,
                 repeated, enum: e });
         }
         default: {
             const scalar = fieldTypeToScalarType[proto.type];
             assert(scalar, `invalid FieldDescriptorProto: unknown type ${proto.type}`);
-            return Object.assign(Object.assign({}, common), { kind: "scalar_field", getDefaultValue,
+            return Object.assign(Object.assign({}, common), { kind: "field", fieldKind: "scalar", getDefaultValue,
                 repeated,
                 scalar });
         }
@@ -468,7 +468,7 @@ function newExtension(proto, file, parent, cart) {
     undefined, cart);
     const extendee = cart.messages.get(trimLeadingDot(proto.extendee));
     assert(extendee, `invalid FieldDescriptorProto: extendee ${proto.extendee} not found`);
-    return Object.assign(Object.assign({}, field), { typeName: makeTypeName(proto, parent, file), parent,
+    return Object.assign(Object.assign({}, field), { kind: "extension", typeName: makeTypeName(proto, parent, file), parent,
         file,
         extendee,
         toString() {
@@ -537,18 +537,18 @@ function getMapFieldTypes(mapEntry) {
         mapKey !== ScalarType.DOUBLE, `invalid DescriptorProto: map entry ${mapEntry.toString()} has unexpected key type ${(_b = keyField.proto.type) !== null && _b !== void 0 ? _b : -1}`);
     const valueField = mapEntry.fields.find((f) => f.proto.number === 2);
     assert(valueField, `invalid DescriptorProto: map entry ${mapEntry.toString()} is missing value field`);
-    switch (valueField.kind) {
-        case "scalar_field":
+    switch (valueField.fieldKind) {
+        case "scalar":
             return {
                 mapKey,
                 mapValue: Object.assign(Object.assign({}, valueField), { kind: "scalar" }),
             };
-        case "message_field":
+        case "message":
             return {
                 mapKey,
                 mapValue: Object.assign(Object.assign({}, valueField), { kind: "message" }),
             };
-        case "enum_field":
+        case "enum":
             return {
                 mapKey,
                 mapValue: Object.assign(Object.assign({}, valueField), { kind: "enum" }),
@@ -706,23 +706,23 @@ function declarationString() {
     if (this.optional) {
         parts.push("optional");
     }
-    const file = "extendee" in this ? this.file : this.parent.file;
+    const file = this.kind === "extension" ? this.file : this.parent.file;
     if (file.syntax == "proto2" &&
         this.proto.label === FieldDescriptorProto_Label.REQUIRED) {
         parts.push("required");
     }
     let type;
-    switch (this.kind) {
-        case "scalar_field":
+    switch (this.fieldKind) {
+        case "scalar":
             type = ScalarType[this.scalar].toLowerCase();
             break;
-        case "enum_field":
+        case "enum":
             type = this.enum.typeName;
             break;
-        case "message_field":
+        case "message":
             type = this.message.typeName;
             break;
-        case "map_field": {
+        case "map": {
             const k = ScalarType[this.mapKey].toLowerCase();
             let v;
             switch (this.mapValue.kind) {
@@ -772,13 +772,13 @@ function getDefaultValue() {
     if (d === undefined) {
         return undefined;
     }
-    switch (this.kind) {
-        case "enum_field": {
+    switch (this.fieldKind) {
+        case "enum": {
             const enumValue = this.enum.values.find((v) => v.name === d);
             assert(enumValue, `cannot parse ${this.toString()} default value: ${d}`);
             return enumValue.number;
         }
-        case "scalar_field":
+        case "scalar":
             switch (this.scalar) {
                 case ScalarType.STRING:
                     return d;

package/dist/esm/create-registry-from-desc.js

@@ -157,17 +157,17 @@ export function createRegistryFromDescriptors(input, replaceWkt = true) {
     };
 }
 function makeFieldInfo(desc, resolver) {
-    switch (desc.kind) {
-        case "map_field":
+    switch (desc.fieldKind) {
+        case "map":
             return makeMapFieldInfo(desc, resolver);
-        case "message_field":
+        case "message":
             return makeMessageFieldInfo(desc, resolver);
-        case "enum_field": {
+        case "enum": {
             const fi = makeEnumFieldInfo(desc, resolver);
             fi.default = desc.getDefaultValue();
             return fi;
         }
-        case "scalar_field": {
+        case "scalar": {
             const fi = makeScalarFieldInfo(desc);
             fi.default = desc.getDefaultValue();
             return fi;

package/dist/esm/google/protobuf/struct_pb.js

@@ -11,7 +11,7 @@
 // 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.
-// @generated by protoc-gen-es v0.1.1 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
+// @generated by protoc-gen-es v0.2.0 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
 // @generated from file google/protobuf/struct.proto (package google.protobuf, syntax proto3)
 /* eslint-disable */
 import { proto3 } from "../../proto3.js";

package/dist/esm/google/protobuf/type_pb.js

@@ -11,7 +11,7 @@
 // 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.
-// @generated by protoc-gen-es v0.1.1 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
+// @generated by protoc-gen-es v0.2.0 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
 // @generated from file google/protobuf/type.proto (package google.protobuf, syntax proto3)
 /* eslint-disable */
 import { proto3 } from "../../proto3.js";

package/dist/esm/private/field-wrapper.js

@@ -35,7 +35,7 @@ export function unwrapField(type, value) {
  * the base type it wraps.
  */
 export function getUnwrappedFieldType(field) {
-    if (field.kind !== "message_field") {
+    if (field.fieldKind !== "message") {
         return undefined;
     }
     if (field.repeated) {

package/dist/esm/private/names.js

@@ -21,10 +21,7 @@
  */
 export function localName(desc) {
     switch (desc.kind) {
-        case "enum_field":
-        case "message_field":
-        case "map_field":
-        case "scalar_field":
+        case "field":
             return localFieldName(desc.name, desc.oneof !== undefined);
         case "oneof":
             return localOneofName(desc.name);

package/dist/types/descriptor-set.d.ts

@@ -8,6 +8,10 @@ import type { MethodIdempotency, MethodKind } from "./service-type.js";
  * When protobuf sources are compiled, each file is parsed into a
  * google.protobuf.FileDescriptorProto. Those messages describe all parts
  * of the source file that are required to generate code for them.
+ *
+ * DescriptorSet resolves references between the descriptors, hides
+ * implementation details like synthetic map entry messages, and provides
+ * simple access to comments.
  */
 export interface DescriptorSet {
     /**
@@ -34,6 +38,10 @@ export interface DescriptorSet {
      */
     readonly extensions: ReadonlyMap<string, DescExtension>;
 }
+/**
+ * A union of all descriptors, discriminated by a `kind` property.
+ */
+export declare type AnyDesc = DescFile | DescEnum | DescEnumValue | DescMessage | DescField | DescExtension | DescOneof | DescService | DescMethod;
 /**
  * Describes a protobuf source file.
  */
@@ -232,6 +240,7 @@ export interface DescMessage {
  * Describes a field declaration in a protobuf source file.
  */
 export declare type DescField = DescFieldCommon & (DescFieldScalar | DescFieldMessage | DescFieldEnum | DescFieldMap) & {
+    kind: "field";
     /**
      * The message this field is declared on.
      */
@@ -241,6 +250,7 @@ export declare type DescField = DescFieldCommon & (DescFieldScalar | DescFieldMe
  * Describes an extension in a protobuf source file.
  */
 export declare type DescExtension = DescFieldCommon & (DescFieldScalar | DescFieldMessage | DescFieldEnum | DescFieldMap) & {
+    kind: "extension";
     /**
      * The fully qualified name of the extension.
      */
@@ -311,7 +321,7 @@ interface DescFieldCommon {
     toString(): string;
 }
 interface DescFieldScalar {
-    readonly kind: "scalar_field";
+    readonly fieldKind: "scalar";
     /**
      * Is the field repeated?
      */
@@ -343,7 +353,7 @@ interface DescFieldScalar {
     getDefaultValue(): number | boolean | string | bigint | Uint8Array | undefined;
 }
 interface DescFieldMessage {
-    readonly kind: "message_field";
+    readonly fieldKind: "message";
     /**
      * Is the field repeated?
      */
@@ -370,7 +380,7 @@ interface DescFieldMessage {
     readonly mapValue: undefined;
 }
 interface DescFieldEnum {
-    readonly kind: "enum_field";
+    readonly fieldKind: "enum";
     /**
      * Is the field repeated?
      */
@@ -402,7 +412,7 @@ interface DescFieldEnum {
     getDefaultValue(): number | boolean | string | bigint | Uint8Array | undefined;
 }
 interface DescFieldMap {
-    readonly kind: "map_field";
+    readonly fieldKind: "map";
     /**
      * Is the field repeated?
      */

package/dist/types/index.d.ts

@@ -15,7 +15,7 @@ export { WireType, BinaryWriter, BinaryReader } from "./binary-encoding.js";
 export type { IBinaryReader, IBinaryWriter } from "./binary-encoding.js";
 export type { BinaryFormat, BinaryWriteOptions, BinaryReadOptions, } from "./binary-format.js";
 export { JsonFormat, JsonObject, JsonValue, JsonReadOptions, JsonWriteOptions, JsonWriteStringOptions, } from "./json-format.js";
-export { DescriptorSet, DescFile, DescEnum, DescEnumValue, DescMessage, DescOneof, DescField, DescService, DescMethod, DescExtension, DescComments, } from "./descriptor-set.js";
+export { DescriptorSet, AnyDesc, DescFile, DescEnum, DescEnumValue, DescMessage, DescOneof, DescField, DescService, DescMethod, DescExtension, DescComments, } from "./descriptor-set.js";
 export { createDescriptorSet } from "./create-descriptor-set.js";
 export { IMessageTypeRegistry } from "./type-registry.js";
 export { createRegistry } from "./create-registry.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bufbuild/protobuf",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "license": "(Apache-2.0 AND BSD-3-Clause)",
   "description": "A complete implementation of Protocol Buffers in TypeScript, suitable for web browsers and Node.js.",
   "repository": {