@bufbuild/protobuf 0.0.8 → 0.1.0

package/dist/types/enum.d.ts

@@ -1,9 +1,9 @@
 /**
- * Reflection information for a protobuf enum.
+ * Reflection information for a protobuf enumeration.
  */
 export interface EnumType {
     /**
-     * The fully qualified name of the enum.
+     * The fully qualified name of the enumeration.
      */
     readonly typeName: string;
     readonly values: readonly EnumValueInfo[];
@@ -17,15 +17,19 @@ export interface EnumType {
     findNumber(no: number): EnumValueInfo | undefined;
 }
 /**
- * Reflection information for a protobuf enum value.
+ * Reflection information for a protobuf enumeration value.
  */
 export interface EnumValueInfo {
     /**
-     * The number of the value as specified in proto.
+     * The numeric enumeration value, as specified in the protobuf source.
      */
     readonly no: number;
     /**
-     * The name of the value as specified in proto.
+     * The name of the enumeration value, as specified in the protobuf source.
      */
     readonly name: string;
+    /**
+     * The name of the enumeration value in generated code.
+     */
+    readonly localName: string;
 }

package/dist/types/google/protobuf/descriptor_pb.d.ts

@@ -1333,8 +1333,8 @@ export declare class UninterpretedOption extends Message<UninterpretedOption> {
  * The name of the uninterpreted option.  Each string represents a segment in
  * a dot-separated name.  is_extension is true iff a segment represents an
  * extension (denoted with parentheses in options specs in .proto files).
- * E.g.,{ ["foo", false], ["bar.baz", true], ["qux", false] } represents
- * "foo.(bar.baz).qux".
+ * E.g.,{ ["foo", false], ["bar.baz", true], ["moo", false] } represents
+ * "foo.(bar.baz).moo".
  *
  * @generated from message google.protobuf.UninterpretedOption.NamePart
  */
@@ -1490,13 +1490,13 @@ export declare class SourceCodeInfo_Location extends Message<SourceCodeInfo_Loca
      *   // Comment attached to baz.
      *   // Another line attached to baz.
      *
-     *   // Comment attached to qux.
+     *   // Comment attached to moo.
      *   //
-     *   // Another line attached to qux.
-     *   optional double qux = 4;
+     *   // Another line attached to moo.
+     *   optional double moo = 4;
      *
      *   // Detached comment for corge. This is not leading or trailing comments
-     *   // to qux or corge because there are blank lines separating it from
+     *   // to moo or corge because there are blank lines separating it from
      *   // both.
      *
      *   // Detached comment for corge paragraph 2.

package/dist/types/google/protobuf/empty_pb.d.ts

@@ -12,7 +12,6 @@ import type { JsonReadOptions, JsonValue } from "../../json-format.js";
  *       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
  *     }
  *
- * The JSON representation for `Empty` is empty JSON object `{}`.
  *
  * @generated from message google.protobuf.Empty
  */

package/dist/types/google/varint.d.ts

@@ -21,20 +21,32 @@ export declare function varint64write(lo: number, hi: number, bytes: number[]):
 /**
  * Parse decimal string of 64 bit integer value as two JS numbers.
  *
- * Returns tuple:
- * [0]: minus sign?
- * [1]: low bits
- * [2]: high bits
+ * Copyright 2008 Google Inc.  All rights reserved.
+ *
+ * See https://github.com/protocolbuffers/protobuf-javascript/blob/a428c58273abad07c66071d9753bc4d1289de426/experimental/runtime/int64.js#L10
+ */
+export declare function int64FromString(dec: string): {
+    lo: number;
+    hi: number;
+};
+/**
+ * Losslessly converts a 64-bit signed integer in 32:32 split representation
+ * into a decimal string.
+ *
+ * Copyright 2008 Google Inc.  All rights reserved.
  *
- * Copyright 2008 Google Inc.
+ * See https://github.com/protocolbuffers/protobuf-javascript/blob/a428c58273abad07c66071d9753bc4d1289de426/experimental/runtime/int64.js#L10
  */
-export declare function int64fromString(dec: string): [boolean, number, number];
+export declare function int64ToString(lo: number, hi: number): string;
 /**
- * Format 64 bit integer value (as two JS numbers) to decimal string.
+ * Losslessly converts a 64-bit unsigned integer in 32:32 split representation
+ * into a decimal string.
+ *
+ * Copyright 2008 Google Inc.  All rights reserved.
  *
- * Copyright 2008 Google Inc.
+ * See https://github.com/protocolbuffers/protobuf-javascript/blob/a428c58273abad07c66071d9753bc4d1289de426/experimental/runtime/int64.js#L10
  */
-export declare function int64toString(bitsLow: number, bitsHigh: number): string;
+export declare function uInt64ToString(lo: number, hi: number): string;
 /**
  * Write a 32 bit varint, signed or unsigned. Same as `varint64write(0, value, bytes)`
  *

package/dist/types/index.d.ts

@@ -2,6 +2,7 @@ export { proto3 } from "./proto3.js";
 export { proto2 } from "./proto2.js";
 export { protoInt64 } from "./proto-int64.js";
 export { protoBase64 } from "./proto-base64.js";
+export { codegenInfo } from "./codegen-info.js";
 export { Message, AnyMessage, PartialMessage, PlainMessage, } from "./message.js";
 export type { FieldInfo } from "./field.js";
 export type { FieldList } from "./field-list.js";
@@ -10,13 +11,15 @@ export type { MessageType } from "./message-type.js";
 export type { EnumType, EnumValueInfo } from "./enum.js";
 export type { ServiceType, MethodInfo, MethodInfoUnary, MethodInfoServerStreaming, MethodInfoClientStreaming, MethodInfoBiDiStreaming, } from "./service-type.js";
 export { MethodKind, MethodIdempotency } from "./service-type.js";
-export { TypeRegistry, IMessageTypeRegistry } from "./type-registry.js";
-export { DescriptorRegistry } from "./descriptor-registry.js";
-export { DescriptorSet } from "./descriptor-set.js";
 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 { createDescriptorSet } from "./create-descriptor-set.js";
+export { IMessageTypeRegistry } from "./type-registry.js";
+export { createRegistry } from "./create-registry.js";
+export { createRegistryFromDescriptors } from "./create-registry-from-desc.js";
 export * from "./google/protobuf/compiler/plugin_pb.js";
 export * from "./google/protobuf/api_pb.js";
 export * from "./google/protobuf/any_pb.js";

package/dist/types/message.d.ts

@@ -67,7 +67,9 @@ export declare class Message<T extends Message<T> = AnyMessage> {
  * PlainMessage<T> strips all methods from a message, leaving only fields
  * and oneof groups.
  */
-export declare type PlainMessage<T extends Message> = Omit<T, keyof Message>;
+export declare type PlainMessage<T extends Message> = {
+    [P in keyof T as T[P] extends Function ? never : P]: T[P];
+};
 /**
  * PartialMessage<T> constructs a type from a message. The resulting type
  * only contains the protobuf field members of the message, and all of them

package/dist/types/private/enum.d.ts

@@ -15,17 +15,13 @@ export declare function getEnumType(enumObject: EnumObject): EnumType;
 /**
  * Sets reflection information on a generated enum.
  */
-export declare function setEnumType(enumObject: EnumObject, typeName: string, values: EnumValueInfo[]): void;
+export declare function setEnumType(enumObject: EnumObject, typeName: string, values: Omit<EnumValueInfo, "localName">[], opt?: {}): void;
 /**
  * Create a new EnumType with the given values.
  */
-export declare function makeEnumType(typeName: string, values: EnumValueInfo[]): EnumType;
+export declare function makeEnumType(typeName: string, values: (EnumValueInfo | Omit<EnumValueInfo, "localName">)[], _opt?: {}): EnumType;
 /**
  * Create a new enum object with the given values.
+ * Sets reflection information.
  */
-export declare function makeEnum(typeName: string, values: EnumValueInfo[], opt?: {
-    /**
-     * MY_ENUM_ for `enum MyEnum {MY_ENUM_A=0; MY_ENUM_B=1;}`, or blank string
-     */
-    sharedPrefix?: string;
-}): EnumObject;
+export declare function makeEnum(typeName: string, values: (EnumValueInfo | Omit<EnumValueInfo, "localName">)[], opt?: {}): EnumObject;

package/dist/types/private/field-wrapper.d.ts

@@ -1,5 +1,7 @@
 import type { Message } from "../message.js";
 import type { MessageType } from "../message-type.js";
+import type { DescField } from "../descriptor-set.js";
+import { ScalarType } from "../field.js";
 /**
  * A field wrapper unwraps a message to a primitive value that is more
  * ergonomic for use as a message field.
@@ -19,3 +21,8 @@ export declare function wrapField<T extends Message<T>>(type: MessageType<T>, va
  * Unwrap field values whose message type has a wrapper.
  */
 export declare function unwrapField<T extends Message<T>>(type: MessageType<T>, value: T): any;
+/**
+ * If the given field uses one of the well-known wrapper types, return
+ * the base type it wraps.
+ */
+export declare function getUnwrappedFieldType(field: DescField): ScalarType | undefined;

package/dist/types/private/message-type.d.ts

@@ -11,10 +11,7 @@ export declare function makeMessageType<T extends Message<T> = AnyMessage>(runti
      * It is useful in stack traces, debuggers and test frameworks,
      * but has no other implications.
      *
-     * This property is optional because by default, the last part
-     * from the given typeName is used. Since this does not take
-     * reserved words into account, we provide this property so that
-     * an escaped name can be given.
+     * If omitted, the last part of the typeName is used.
      */
     localName?: string;
 }): MessageType<T>;

package/dist/types/private/names.d.ts

@@ -1,16 +1,34 @@
+import type { DescEnum, DescEnumValue, DescField, DescMessage, DescService } from "../descriptor-set.js";
+import type { DescMethod, DescOneof } from "../descriptor-set.js";
 /**
- * Returns the JSON name for a protobuf field, exactly like protoc does.
+ * Returns the name of a protobuf element in generated code.
+ *
+ * Field names - including oneofs - are converted to lowerCamelCase. For
+ * messages, enumerations and services, the package name is stripped from
+ * the type name. For nested messages and enumerations, the names are joined
+ * with an underscore. For methods, the first character is made lowercase.
+ */
+export declare function localName(desc: DescEnum | DescEnumValue | DescMessage | DescOneof | DescField | DescService | DescMethod): string;
+/**
+ * Returns the name of a field in generated code.
  */
-export declare function makeJsonName(protoName: string): string;
+export declare function localFieldName(protoName: string, inOneof: boolean): string;
 /**
- * Returns the local name of a field, exactly like protoc-gen-es does.
+ * Returns the name of a oneof group in generated code.
+ */
+export declare function localOneofName(protoName: string): string;
+/**
+ * Returns the JSON name for a protobuf field, exactly like protoc does.
  */
-export declare function makeFieldName(protoName: string, inOneof: boolean): string;
+export declare const fieldJsonName: typeof protoCamelCase;
 /**
- * Returns the local name of a oneof group, exactly like protoc-gen-es does.
+ * Finds a prefix shared by enum values, for example `MY_ENUM_` for
+ * `enum MyEnum {MY_ENUM_A=0; MY_ENUM_B=1;}`.
  */
-export declare function makeOneofName(protoName: string): string;
+export declare function findEnumSharedPrefix(enumName: string, valueNames: string[]): string | undefined;
 /**
- * Returns the local name of a rpc, exactly like protoc-gen-es does.
+ * Converts snake_case to protoCamelCase according to the convention
+ * used by protoc to convert a field name to a JSON name.
  */
-export declare function makeMethodName(protoName: string): string;
+declare function protoCamelCase(snakeCase: string): string;
+export {};

package/dist/types/private/proto-runtime.d.ts

@@ -30,13 +30,13 @@ export interface ProtoRuntime {
      * The type name and other reflection information is accessible
      * via getEnumType().
      */
-    makeEnum(typeName: string, values: EnumValueInfo[], opt?: {}): EnumObject;
+    makeEnum(typeName: string, values: (EnumValueInfo | Omit<EnumValueInfo, "localName">)[], opt?: {}): EnumObject;
     /**
      * Create an enum type at runtime, without generating code.
      * Note that this only creates the reflection information, not an
      * actual enum object.
      */
-    makeEnumType(typeName: string, values: EnumValueInfo[], opt?: {}): EnumType;
+    makeEnumType(typeName: string, values: (EnumValueInfo | Omit<EnumValueInfo, "localName">)[], opt?: {}): EnumType;
     /**
      * Get reflection information - the EnumType - from an enum object.
      * If this function is called on something other than a generated

package/dist/types/private/util.d.ts

@@ -1,7 +1,6 @@
 import type { FieldListSource } from "./field-list.js";
 import type { FieldList } from "../field-list.js";
 import type { EnumObject } from "./enum.js";
-import type { JsonValue } from "../json-format.js";
 import type { Message, PartialMessage, PlainMessage } from "../message.js";
 import type { MessageType } from "../message-type.js";
 import type { EnumValueInfo } from "../enum.js";
@@ -18,11 +17,7 @@ export interface Util {
     /**
      * Sets reflection information on a generated enum.
      */
-    setEnumType(enumObject: EnumObject, typeName: string, values: EnumValueInfo[], opt?: {
-        options?: {
-            readonly [extensionName: string]: JsonValue;
-        };
-    }): void;
+    setEnumType(enumObject: EnumObject, typeName: string, values: Omit<EnumValueInfo, "localName">[], opt?: {}): void;
     /**
      * Set default field values on the target message.
      */

package/dist/types/proto-int64.d.ts

@@ -29,22 +29,23 @@
  * ```
  *
  * If you need to manipulate 64-bit integral values that are outside the
- * range of safe representation as Number, you can work with the two's
- * complement directly. The following example negates a field value:
+ * range of safe representation as a JavaScript Number, we recommend you
+ * use a third party library, for example the npm package "long":
  *
  * ```ts
- * let t = protoInt64.enc(message.int64Field);
- * t.hi = ~t.hi;
- * if (t.lo) {
- *     t.lo = ~t.lo + 1;
- * } else {
- *     t.hi += 1;
- * }
- * message.int64Field = protoInt64.dec(t.lo, t.hi);
- * ```
+ * // convert the field value to a Long
+ * const bits = protoInt64.enc(message.int64Field);
+ * const longValue = Long.fromBits(bits.lo, bits.hi);
+ *
+ * // perform arithmetic
+ * const longResult = longValue.subtract(1);
  *
- * There are several 3rd party libraries that provide arithmetic operations
- * on a two's complement, for example the npm package "long".
+ * // set the result in the field
+ * message.int64Field = protoInt64.dec(longResult.low, longResult.high);
+ *
+ * // Assuming int64Field contains 9223372036854775807:
+ * console.log(message.int64Field); // 9223372036854775806
+ * ```
  */
 interface Int64Support {
     /**

package/dist/types/type-registry.d.ts

@@ -28,41 +28,3 @@ export interface IServiceTypeRegistry {
      */
     findService(typeName: string): ServiceType | undefined;
 }
-/**
- * TypeRegistry is a simple registry for all message, enum, or service types.
- */
-export declare class TypeRegistry implements IMessageTypeRegistry, IEnumTypeRegistry, IServiceTypeRegistry {
-    private readonly messages;
-    private readonly enums;
-    private readonly services;
-    /**
-     * Find a message type by its protobuf type name.
-     */
-    findMessage(typeName: string): MessageType | undefined;
-    /**
-     * Find an enum type by its protobuf type name.
-     */
-    findEnum(typeName: string): EnumType | undefined;
-    /**
-     * Find a service type by its protobuf type name.
-     */
-    findService(typeName: string): ServiceType | undefined;
-    /**
-     * Create a new TypeRegistry from the given types.
-     */
-    static from(...types: Array<MessageType | EnumType | ServiceType>): TypeRegistry;
-    /**
-     * @deprecated use TypeRegistry.from()
-     */
-    static fromIterable(types: Iterable<MessageType>): TypeRegistry;
-    /**
-     * @deprecated use TypeRegistry.from()
-     */
-    static fromTypes(...types: MessageType[]): TypeRegistry;
-    /**
-     * Add a type to the registry. For messages, the types used in message
-     * fields are added recursively. For services, the message types used
-     * for requests and responses are added recursively.
-     */
-    add(type: MessageType | EnumType | ServiceType): void;
-}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@bufbuild/protobuf",
-  "version": "0.0.8",
+  "version": "0.1.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.",
+  "description": "A complete implementation of Protocol Buffers in TypeScript, suitable for web browsers and Node.js.",
   "repository": {
     "type": "git",
     "url": "https://github.com/bufbuild/protobuf-es.git",
@@ -12,19 +12,15 @@
   "scripts": {
     "clean": "rm -rf ./dist/cjs/* ./dist/esm/* ./dist/types/*",
     "build": "npm run build:cjs && npm run build:esm+types",
-    "build:cjs": "npx tsc --project tsconfig.json --module commonjs --outDir ./dist/cjs && echo >./dist/cjs/package.json '{\"type\":\"commonjs\"}'",
-    "build:esm+types": "npx tsc --project tsconfig.json --module ES2015 --outDir ./dist/esm --declaration --declarationDir ./dist/types"
+    "build:cjs": "../../node_modules/typescript/bin/tsc --project tsconfig.json --module commonjs --outDir ./dist/cjs && echo >./dist/cjs/package.json '{\"type\":\"commonjs\"}'",
+    "build:esm+types": "../../node_modules/typescript/bin/tsc --project tsconfig.json --module ES2015 --outDir ./dist/esm --declaration --declarationDir ./dist/types"
   },
-  "main": "./dist/esm/index.js",
+  "main": "./dist/cjs/index.js",
   "type": "module",
   "types": "./dist/types/index.d.ts",
   "exports": {
     "import": "./dist/esm/index.js",
-    "require": "./dist/cjs/index.js",
-    "default": "./dist/esm/index.js"
-  },
-  "devDependencies": {
-    "typescript": "^4.7.4"
+    "require": "./dist/cjs/index.js"
   },
   "files": [
     "dist/**/"