@bufbuild/protobuf 1.3.0 → 1.3.2

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

@@ -0,0 +1,95 @@
+/**
+ * We use the `bigint` primitive to represent 64-bit integral types. If bigint
+ * is unavailable, we fall back to a string representation, which means that
+ * all values typed as `bigint` will actually be strings.
+ *
+ * If your code is intended to run in an environment where bigint may be
+ * unavailable, it must handle both the bigint and the string representation.
+ * For presenting values, this is straight-forward with implicit or explicit
+ * conversion to string:
+ *
+ * ```ts
+ * let el = document.createElement("span");
+ * el.innerText = message.int64Field; // assuming a protobuf int64 field
+ *
+ * console.log(`int64: ${message.int64Field}`);
+ *
+ * let str: string = message.int64Field.toString();
+ * ```
+ *
+ * If you need to manipulate 64-bit integral values and are sure the values
+ * can be safely represented as an IEEE-754 double precision number, you can
+ * convert to a JavaScript Number:
+ *
+ * ```ts
+ * console.log(message.int64Field.toString())
+ * let num = Number(message.int64Field);
+ * num = num + 1;
+ * message.int64Field = protoInt64.parse(num);
+ * ```
+ *
+ * If you need to manipulate 64-bit integral values that are outside the
+ * range of safe representation as a JavaScript Number, we recommend you
+ * use a third party library, for example the npm package "long":
+ *
+ * ```ts
+ * // 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);
+ *
+ * // 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 {
+    /**
+     * 0n if bigint is available, "0" if unavailable.
+     */
+    readonly zero: bigint;
+    /**
+     * Is bigint available?
+     */
+    readonly supported: boolean;
+    /**
+     * Parse a signed 64-bit integer.
+     * Returns a bigint if available, a string otherwise.
+     */
+    parse(value: string | number | bigint): bigint;
+    /**
+     * Parse an unsigned 64-bit integer.
+     * Returns a bigint if available, a string otherwise.
+     */
+    uParse(value: string | number | bigint): bigint;
+    /**
+     * Convert a signed 64-bit integral value to a two's complement.
+     */
+    enc(value: string | number | bigint): {
+        lo: number;
+        hi: number;
+    };
+    /**
+     * Convert an unsigned 64-bit integral value to a two's complement.
+     */
+    uEnc(value: string | number | bigint): {
+        lo: number;
+        hi: number;
+    };
+    /**
+     * Convert a two's complement to a signed 64-bit integral value.
+     * Returns a bigint if available, a string otherwise.
+     */
+    dec(lo: number, hi: number): bigint;
+    /**
+     * Convert a two's complement to an unsigned 64-bit integral value.
+     * Returns a bigint if available, a string otherwise.
+     */
+    uDec(lo: number, hi: number): bigint;
+}
+export declare const protoInt64: Int64Support;
+export {};

package/dist/esm/proto2.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Provides functionality for messages defined with the proto2 syntax.
+ */
+export declare const proto2: import("./private/proto-runtime.js").ProtoRuntime;

package/dist/esm/proto3.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Provides functionality for messages defined with the proto3 syntax.
+ */
+export declare const proto3: import("./private/proto-runtime.js").ProtoRuntime;

package/dist/esm/service-type.d.ts

@@ -0,0 +1,96 @@
+import type { AnyMessage, Message } from "./message.js";
+import type { MessageType } from "./message-type.js";
+/**
+ * ServiceType represents a protobuf services. It provides metadata for
+ * reflection-based operations.
+ */
+export interface ServiceType {
+    /**
+     * The fully qualified name of the service.
+     */
+    readonly typeName: string;
+    /**
+     * A map of local name (safe to use in ECMAScript) to method.
+     */
+    readonly methods: {
+        [localName: string]: MethodInfo;
+    };
+}
+/**
+ * MethodInfo represents a method of a protobuf service, a remote procedure
+ * call. All methods provide the following properties:
+ *
+ * - "name": The original name of the protobuf rpc.
+ * - "I": The input message type.
+ * - "O": The output message type.
+ * - "kind": The method type.
+ * - "idempotency": User-provided indication whether the method will cause
+ *   the same effect every time it is called.
+ */
+export type MethodInfo<I extends Message<I> = AnyMessage, O extends Message<O> = AnyMessage> = MethodInfoUnary<I, O> | MethodInfoServerStreaming<I, O> | MethodInfoClientStreaming<I, O> | MethodInfoBiDiStreaming<I, O>;
+/**
+ * A unary method: rpc (Input) returns (Output)
+ */
+export interface MethodInfoUnary<I extends Message<I>, O extends Message<O>> extends miShared<I, O> {
+    readonly kind: MethodKind.Unary;
+}
+/**
+ * A server streaming method: rpc (Input) returns (stream Output)
+ */
+export interface MethodInfoServerStreaming<I extends Message<I>, O extends Message<O>> extends miShared<I, O> {
+    readonly kind: MethodKind.ServerStreaming;
+}
+/**
+ * A client streaming method: rpc (stream Input) returns (Output)
+ */
+export interface MethodInfoClientStreaming<I extends Message<I>, O extends Message<O>> extends miShared<I, O> {
+    readonly kind: MethodKind.ClientStreaming;
+}
+/**
+ * A method that streams bi-directionally: rpc (stream Input) returns (stream Output)
+ */
+export interface MethodInfoBiDiStreaming<I extends Message<I>, O extends Message<O>> extends miShared<I, O> {
+    readonly kind: MethodKind.BiDiStreaming;
+}
+interface miShared<I extends Message<I> = AnyMessage, O extends Message<O> = AnyMessage> {
+    readonly name: string;
+    readonly I: MessageType<I>;
+    readonly O: MessageType<O>;
+    readonly idempotency?: MethodIdempotency;
+}
+/**
+ * MethodKind represents the four method types that can be declared in
+ * protobuf with the `stream` keyword:
+ *
+ * 1. Unary:           rpc (Input) returns (Output)
+ * 2. ServerStreaming: rpc (Input) returns (stream Output)
+ * 3. ClientStreaming: rpc (stream Input) returns (Output)
+ * 4. BiDiStreaming:   rpc (stream Input) returns (stream Output)
+ */
+export declare enum MethodKind {
+    Unary = 0,
+    ServerStreaming = 1,
+    ClientStreaming = 2,
+    BiDiStreaming = 3
+}
+/**
+ * Is this method side-effect-free (or safe in HTTP parlance), or just
+ * idempotent, or neither? HTTP based RPC implementation may choose GET verb
+ * for safe methods, and PUT verb for idempotent methods instead of the
+ * default POST.
+ *
+ * This enum matches the protobuf enum google.protobuf.MethodOptions.IdempotencyLevel,
+ * defined in the well-known type google/protobuf/descriptor.proto, but
+ * drops UNKNOWN.
+ */
+export declare enum MethodIdempotency {
+    /**
+     * Idempotent, no side effects.
+     */
+    NoSideEffects = 1,
+    /**
+     * Idempotent, but may have side effects.
+     */
+    Idempotent = 2
+}
+export {};

package/dist/esm/to-plain-message.d.ts

@@ -0,0 +1,9 @@
+import { Message } from "./message.js";
+import type { PlainMessage } from "./message.js";
+/**
+ * toPlainMessage returns a new object by striping
+ * all methods from a message, leaving only fields and
+ * oneof groups. It is recursive, meaning it applies this
+ * same logic to all nested message fields as well.
+ */
+export declare function toPlainMessage<T extends Message<T>>(message: T): PlainMessage<T>;

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

@@ -0,0 +1,30 @@
+import type { MessageType } from "./message-type.js";
+import type { EnumType } from "./enum.js";
+import type { ServiceType } from "./service-type.js";
+/**
+ * IMessageTypeRegistry provides look-up for message types.
+ */
+export interface IMessageTypeRegistry {
+    /**
+     * Find a message type by its protobuf type name.
+     */
+    findMessage(typeName: string): MessageType | undefined;
+}
+/**
+ * IEnumTypeRegistry provides look-up for enum types.
+ */
+export interface IEnumTypeRegistry {
+    /**
+     * Find an enum type by its protobuf type name.
+     */
+    findEnum(typeName: string): EnumType | undefined;
+}
+/**
+ * IServiceTypeRegistry provides look-up for service types.
+ */
+export interface IServiceTypeRegistry {
+    /**
+     * Find a service type by its protobuf type name.
+     */
+    findService(typeName: string): ServiceType | undefined;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bufbuild/protobuf",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "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": {
@@ -10,18 +10,23 @@
   },
   "sideEffects": false,
   "scripts": {
-    "clean": "rm -rf ./dist/cjs/* ./dist/esm/* ./dist/types/*",
-    "build": "npm run build:cjs && npm run build:esm+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 --verbatimModuleSyntax --outDir ./dist/esm --declaration --declarationDir ./dist/types"
+    "clean": "rm -rf ./dist/cjs/* ./dist/esm/*",
+    "build": "npm run build:cjs && npm run build:esm",
+    "build:cjs": "../../node_modules/typescript/bin/tsc --project tsconfig.json --module commonjs --outDir ./dist/cjs --declaration --declarationDir ./dist/cjs && echo >./dist/cjs/package.json '{\"type\":\"commonjs\"}'",
+    "build:esm": "../../node_modules/typescript/bin/tsc --project tsconfig.json --module ES2015 --verbatimModuleSyntax --outDir ./dist/esm --declaration --declarationDir ./dist/esm",
+    "attw": "attw --pack"
   },
   "main": "./dist/cjs/index.js",
   "type": "module",
-  "types": "./dist/types/index.d.ts",
   "exports": {
-    "import": "./dist/esm/index.js",
-    "require": "./dist/cjs/index.js",
-    "types": "./dist/types/index.d.ts"
+    "import": {
+      "types": "./dist/esm/index.d.ts",
+      "default": "./dist/esm/index.js"
+    },
+    "require": {
+      "types": "./dist/cjs/index.d.ts",
+      "default": "./dist/cjs/index.js"
+    }
   },
   "files": [
     "dist/**"