@bufbuild/protobuf 1.3.3 → 1.4.1

package/dist/cjs/codegen-info.d.ts

@@ -1,19 +1,24 @@
-import { localName, safeIdentifier, safeObjectProperty } from "./private/names.js";
-import { getUnwrappedFieldType } from "./private/field-wrapper.js";
-import { scalarDefaultValue } from "./private/scalars.js";
 import { reifyWkt } from "./private/reify-wkt.js";
+import type { DescEnum, DescEnumValue, DescField, DescMessage, DescMethod, DescOneof, DescService } from "./descriptor-set";
+import { LongType, ScalarType } from "./field.js";
 interface CodegenInfo {
+    /**
+     * Name of the runtime library NPM package.
+     */
     readonly packageName: string;
-    readonly localName: typeof localName;
+    readonly localName: (desc: DescEnum | DescEnumValue | DescMessage | DescOneof | DescField | DescService | DescMethod) => string;
     readonly symbols: Record<RuntimeSymbolName, RuntimeSymbolInfo>;
-    readonly getUnwrappedFieldType: typeof getUnwrappedFieldType;
+    readonly getUnwrappedFieldType: (field: DescField) => ScalarType | undefined;
     readonly wktSourceFiles: readonly string[];
-    readonly scalarDefaultValue: typeof scalarDefaultValue;
+    readonly scalarDefaultValue: (type: ScalarType, longType: LongType) => any;
+    /**
+     * @deprecated please use reifyWkt from @bufbuild/protoplugin/ecmascript instead
+     */
     readonly reifyWkt: typeof reifyWkt;
-    readonly safeIdentifier: typeof safeIdentifier;
-    readonly safeObjectProperty: typeof safeObjectProperty;
+    readonly safeIdentifier: (name: string) => string;
+    readonly safeObjectProperty: (name: string) => string;
 }
-type RuntimeSymbolName = "proto2" | "proto3" | "Message" | "PartialMessage" | "PlainMessage" | "FieldList" | "MessageType" | "BinaryReadOptions" | "BinaryWriteOptions" | "JsonReadOptions" | "JsonWriteOptions" | "JsonValue" | "JsonObject" | "protoDouble" | "protoInt64" | "ScalarType" | "MethodKind" | "MethodIdempotency" | "IMessageTypeRegistry";
+type RuntimeSymbolName = "proto2" | "proto3" | "Message" | "PartialMessage" | "PlainMessage" | "FieldList" | "MessageType" | "BinaryReadOptions" | "BinaryWriteOptions" | "JsonReadOptions" | "JsonWriteOptions" | "JsonValue" | "JsonObject" | "protoDouble" | "protoInt64" | "ScalarType" | "LongType" | "MethodKind" | "MethodIdempotency" | "IMessageTypeRegistry";
 type RuntimeSymbolInfo = {
     typeOnly: boolean;
     publicImportPath: string;

package/dist/cjs/codegen-info.js

@@ -20,7 +20,7 @@ const scalars_js_1 = require("./private/scalars.js");
 const reify_wkt_js_1 = require("./private/reify-wkt.js");
 const packageName = "@bufbuild/protobuf";
 exports.codegenInfo = {
-    packageName,
+    packageName: "@bufbuild/protobuf",
     localName: names_js_1.localName,
     reifyWkt: reify_wkt_js_1.reifyWkt,
     getUnwrappedFieldType: field_wrapper_js_1.getUnwrappedFieldType,
@@ -45,6 +45,7 @@ exports.codegenInfo = {
         protoDouble: { typeOnly: false, privateImportPath: "./proto-double.js", publicImportPath: packageName },
         protoInt64: { typeOnly: false, privateImportPath: "./proto-int64.js", publicImportPath: packageName },
         ScalarType: { typeOnly: false, privateImportPath: "./field.js", publicImportPath: packageName },
+        LongType: { typeOnly: false, privateImportPath: "./field.js", publicImportPath: packageName },
         MethodKind: { typeOnly: false, privateImportPath: "./service-type.js", publicImportPath: packageName },
         MethodIdempotency: { typeOnly: false, privateImportPath: "./service-type.js", publicImportPath: packageName },
         IMessageTypeRegistry: { typeOnly: true, privateImportPath: "./type-registry.js", publicImportPath: packageName },

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

@@ -397,7 +397,7 @@ function newOneof(proto, parent) {
  * Create a descriptor for a field.
  */
 function newField(proto, file, parent, oneof, cart) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e;
     (0, assert_js_1.assert)(proto.name, `invalid FieldDescriptorProto: missing name`);
     (0, assert_js_1.assert)(proto.number, `invalid FieldDescriptorProto: missing number`);
     (0, assert_js_1.assert)(proto.type, `invalid FieldDescriptorProto: missing type`);
@@ -414,6 +414,7 @@ function newField(proto, file, parent, oneof, cart) {
         packedByDefault,
         jsonName: proto.jsonName === (0, names_js_1.fieldJsonName)(proto.name) ? undefined : proto.jsonName,
         scalar: undefined,
+        longType: undefined,
         message: undefined,
         enum: undefined,
         mapKey: undefined,
@@ -459,7 +460,9 @@ function newField(proto, file, parent, oneof, cart) {
             (0, assert_js_1.assert)(scalar, `invalid FieldDescriptorProto: unknown type ${proto.type}`);
             return Object.assign(Object.assign({}, common), { kind: "field", fieldKind: "scalar", getDefaultValue,
                 repeated,
-                scalar });
+                scalar, longType: ((_e = proto.options) === null || _e === void 0 ? void 0 : _e.jstype) == descriptor_pb_js_1.FieldOptions_JSType.JS_STRING
+                    ? field_js_1.LongType.STRING
+                    : field_js_1.LongType.BIGINT });
         }
     }
 }
@@ -703,7 +706,7 @@ var FieldNumber;
  * source. Does not take custom options into account.
  */
 function declarationString() {
-    var _a, _b;
+    var _a, _b, _c;
     const parts = [];
     if (this.repeated) {
         parts.push("repeated");
@@ -761,7 +764,10 @@ function declarationString() {
     if (this.jsonName !== undefined) {
         options.push(`json_name = "${this.jsonName}"`);
     }
-    if (((_b = this.proto.options) === null || _b === void 0 ? void 0 : _b.deprecated) === true) {
+    if (((_b = this.proto.options) === null || _b === void 0 ? void 0 : _b.jstype) !== undefined) {
+        options.push(`jstype = ${descriptor_pb_js_1.FieldOptions_JSType[this.proto.options.jstype]}`);
+    }
+    if (((_c = this.proto.options) === null || _c === void 0 ? void 0 : _c.deprecated) === true) {
         options.push(`deprecated = true`);
     }
     if (options.length > 0) {

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

@@ -17,6 +17,7 @@ exports.createRegistryFromDescriptors = void 0;
 const assert_js_1 = require("./private/assert.js");
 const proto3_js_1 = require("./proto3.js");
 const proto2_js_1 = require("./proto2.js");
+const field_js_1 = require("./field.js");
 const names_js_1 = require("./private/names.js");
 const timestamp_pb_js_1 = require("./google/protobuf/timestamp_pb.js");
 const duration_pb_js_1 = require("./google/protobuf/duration_pb.js");
@@ -207,13 +208,12 @@ function makeMapFieldInfo(field, resolver) {
         } });
 }
 function makeScalarFieldInfo(field) {
-    const base = {
-        kind: "scalar",
-        no: field.number,
-        name: field.name,
-        jsonName: field.jsonName,
-        T: field.scalar,
-    };
+    // We are creating _partial_ field info here, so we omit long type bigint,
+    // which is the default.
+    const longType = field.longType == field_js_1.LongType.STRING
+        ? { L: field_js_1.LongType.STRING }
+        : {};
+    const base = Object.assign({ kind: "scalar", no: field.number, name: field.name, jsonName: field.jsonName, T: field.scalar }, longType);
     if (field.repeated) {
         return Object.assign(Object.assign({}, base), { repeated: true, packed: field.packed, oneof: undefined, T: field.scalar });
     }

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

@@ -1,5 +1,5 @@
 import type { DescriptorProto, EnumDescriptorProto, EnumValueDescriptorProto, FieldDescriptorProto, FileDescriptorProto, MethodDescriptorProto, OneofDescriptorProto, ServiceDescriptorProto } from "./google/protobuf/descriptor_pb.js";
-import type { ScalarType } from "./field.js";
+import type { ScalarType, LongType } from "./field.js";
 import type { MethodIdempotency, MethodKind } from "./service-type.js";
 /**
  * DescriptorSet provides a convenient interface for working with a set
@@ -330,6 +330,11 @@ interface DescFieldScalar {
      * Scalar type, if it is a scalar field.
      */
     readonly scalar: ScalarType;
+    /**
+     * JavaScript type for 64 bit integral types (int64, uint64,
+     * sint64, fixed64, sfixed64).
+     */
+    readonly longType: LongType;
     /**
      * The message type, if it is a message field.
      */
@@ -362,6 +367,11 @@ interface DescFieldMessage {
      * Scalar type, if it is a scalar field.
      */
     readonly scalar: undefined;
+    /**
+     * JavaScript type for 64 bit integral types (int64, uint64,
+     * sint64, fixed64, sfixed64).
+     */
+    readonly longType: undefined;
     /**
      * The message type, if it is a message field.
      */
@@ -389,6 +399,11 @@ interface DescFieldEnum {
      * Scalar type, if it is a scalar field.
      */
     readonly scalar: undefined;
+    /**
+     * JavaScript type for 64 bit integral types (int64, uint64,
+     * sint64, fixed64, sfixed64).
+     */
+    readonly longType: undefined;
     /**
      * The message type, if it is a message field.
      */
@@ -421,6 +436,11 @@ interface DescFieldMap {
      * Scalar type, if it is a scalar field.
      */
     readonly scalar: undefined;
+    /**
+     * JavaScript type for 64 bit integral types (int64, uint64,
+     * sint64, fixed64, sfixed64).
+     */
+    readonly longType: undefined;
     /**
      * The message type, if it is a message field.
      */

package/dist/cjs/field.d.ts

@@ -80,6 +80,26 @@ interface fiScalar extends fiShared {
      * Scalar type of the field.
      */
     readonly T: ScalarType;
+    /**
+     * JavaScript representation of 64 bit integral types (int64, uint64,
+     * sint64, fixed64, sfixed64).
+     *
+     * By default, this is LongType.BIGINT. Generated code will use the BigInt
+     * primitive.
+     *
+     * With LongType.STRING, generated code will use the String primitive instead.
+     * This can be specified per field with the option `[jstype = JS_STRING]`:
+     *
+     * ```protobuf
+     * uint64 field_a = 1; // BigInt
+     * uint64 field_b = 2 [jstype = JS_NORMAL]; // BigInt
+     * uint64 field_b = 2 [jstype = JS_NUMBER]; // BigInt
+     * uint64 field_b = 2 [jstype = JS_STRING]; // String
+     * ```
+     *
+     * This property is ignored for other scalar types.
+     */
+    readonly L: LongType;
     /**
      * Is the field repeated?
      */
@@ -201,13 +221,14 @@ type fiRules<T> = Omit<T, "oneof" | "repeat" | "repeated" | "packed" | "opt"> &
     readonly opt: false;
     readonly oneof: OneofInfo;
 });
-type fiPartialRules<T extends fiScalar | fiMap | fiEnum | fiMessage> = Omit<T, "jsonName" | "localName" | "oneof" | "repeat" | "repeated" | "packed" | "opt" | "default"> & ({
+type fiPartialRules<T extends fiScalar | fiMap | fiEnum | fiMessage> = Omit<T, "jsonName" | "localName" | "oneof" | "repeat" | "repeated" | "packed" | "opt" | "default" | "L"> & ({
     readonly jsonName?: string;
     readonly repeated?: false;
     readonly packed?: false;
     readonly opt?: false;
     readonly oneof?: undefined;
     default?: T["default"];
+    L?: LongType;
 } | {
     readonly jsonName?: string;
     readonly repeated?: false;
@@ -215,6 +236,7 @@ type fiPartialRules<T extends fiScalar | fiMap | fiEnum | fiMessage> = Omit<T, "
     readonly opt: true;
     readonly oneof?: undefined;
     default?: T["default"];
+    L?: LongType;
 } | {
     readonly jsonName?: string;
     readonly repeated?: boolean;
@@ -222,6 +244,7 @@ type fiPartialRules<T extends fiScalar | fiMap | fiEnum | fiMessage> = Omit<T, "
     readonly opt?: false;
     readonly oneof?: undefined;
     default?: T["default"];
+    L?: LongType;
 } | {
     readonly jsonName?: string;
     readonly repeated?: false;
@@ -229,6 +252,7 @@ type fiPartialRules<T extends fiScalar | fiMap | fiEnum | fiMessage> = Omit<T, "
     readonly opt?: false;
     readonly oneof: string;
     default?: T["default"];
+    L?: LongType;
 });
 /**
  * Scalar value types. This is a subset of field types declared by protobuf
@@ -252,4 +276,31 @@ export declare enum ScalarType {
     SINT32 = 17,
     SINT64 = 18
 }
+/**
+ * JavaScript representation of fields with 64 bit integral types (int64, uint64,
+ * sint64, fixed64, sfixed64).
+ *
+ * This is a subset of google.protobuf.FieldOptions.JSType, which defines JS_NORMAL,
+ * JS_STRING, and JS_NUMBER. Protobuf-ES uses BigInt by default, but will use
+ * String if `[jstype = JS_STRING]` is specified.
+ *
+ * ```protobuf
+ * uint64 field_a = 1; // BigInt
+ * uint64 field_b = 2 [jstype = JS_NORMAL]; // BigInt
+ * uint64 field_b = 2 [jstype = JS_NUMBER]; // BigInt
+ * uint64 field_b = 2 [jstype = JS_STRING]; // String
+ * ```
+ */
+export declare enum LongType {
+    /**
+     * Use JavaScript BigInt.
+     */
+    BIGINT = 0,
+    /**
+     * Use JavaScript String.
+     *
+     * Field option `[jstype = JS_STRING]`.
+     */
+    STRING = 1
+}
 export {};

package/dist/cjs/field.js

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ScalarType = void 0;
+exports.LongType = exports.ScalarType = void 0;
 /**
  * Scalar value types. This is a subset of field types declared by protobuf
  * enum google.protobuf.FieldDescriptorProto.Type The types GROUP and MESSAGE
@@ -51,3 +51,31 @@ var ScalarType;
     ScalarType[ScalarType["SINT32"] = 17] = "SINT32";
     ScalarType[ScalarType["SINT64"] = 18] = "SINT64";
 })(ScalarType || (exports.ScalarType = ScalarType = {}));
+/**
+ * JavaScript representation of fields with 64 bit integral types (int64, uint64,
+ * sint64, fixed64, sfixed64).
+ *
+ * This is a subset of google.protobuf.FieldOptions.JSType, which defines JS_NORMAL,
+ * JS_STRING, and JS_NUMBER. Protobuf-ES uses BigInt by default, but will use
+ * String if `[jstype = JS_STRING]` is specified.
+ *
+ * ```protobuf
+ * uint64 field_a = 1; // BigInt
+ * uint64 field_b = 2 [jstype = JS_NORMAL]; // BigInt
+ * uint64 field_b = 2 [jstype = JS_NUMBER]; // BigInt
+ * uint64 field_b = 2 [jstype = JS_STRING]; // String
+ * ```
+ */
+var LongType;
+(function (LongType) {
+    /**
+     * Use JavaScript BigInt.
+     */
+    LongType[LongType["BIGINT"] = 0] = "BIGINT";
+    /**
+     * Use JavaScript String.
+     *
+     * Field option `[jstype = JS_STRING]`.
+     */
+    LongType[LongType["STRING"] = 1] = "STRING";
+})(LongType || (exports.LongType = LongType = {}));

package/dist/cjs/google/protobuf/any_pb.d.ts

@@ -121,7 +121,8 @@ export declare class Any extends Message<Any> {
      *
      * Note: this functionality is not currently available in the official
      * protobuf release, and it is not used for type URLs beginning with
-     * type.googleapis.com.
+     * type.googleapis.com. As of May 2023, there are no widely used type server
+     * implementations and no plans to implement one.
      *
      * Schemes other than `http`, `https` (or the empty scheme) might be
      * used with implementation specific semantics.

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

@@ -133,7 +133,8 @@ class Any extends message_js_1.Message {
          *
          * Note: this functionality is not currently available in the official
          * protobuf release, and it is not used for type URLs beginning with
-         * type.googleapis.com.
+         * type.googleapis.com. As of May 2023, there are no widely used type server
+         * implementations and no plans to implement one.
          *
          * Schemes other than `http`, `https` (or the empty scheme) might be
          * used with implementation specific semantics.

package/dist/cjs/google/protobuf/compiler/plugin_pb.d.ts

@@ -64,6 +64,11 @@ export declare class CodeGeneratorRequest extends Message<CodeGeneratorRequest>
      * they import.  The files will appear in topological order, so each file
      * appears before any file that imports it.
      *
+     * Note: the files listed in files_to_generate will include runtime-retention
+     * options only, but all other files will include source-retention options.
+     * The source_file_descriptors field below is available in case you need
+     * source-retention options for files_to_generate.
+     *
      * protoc guarantees that all proto_files will be written after
      * the fields above, even though this is not technically guaranteed by the
      * protobuf wire format.  This theoretically could allow a plugin to stream
@@ -78,6 +83,14 @@ export declare class CodeGeneratorRequest extends Message<CodeGeneratorRequest>
      * @generated from field: repeated google.protobuf.FileDescriptorProto proto_file = 15;
      */
     protoFile: FileDescriptorProto[];
+    /**
+     * File descriptors with all options, including source-retention options.
+     * These descriptors are only provided for the files listed in
+     * files_to_generate.
+     *
+     * @generated from field: repeated google.protobuf.FileDescriptorProto source_file_descriptors = 17;
+     */
+    sourceFileDescriptors: FileDescriptorProto[];
     /**
      * The version number of protocol compiler.
      *
@@ -145,7 +158,11 @@ export declare enum CodeGeneratorResponse_Feature {
     /**
      * @generated from enum value: FEATURE_PROTO3_OPTIONAL = 1;
      */
-    PROTO3_OPTIONAL = 1
+    PROTO3_OPTIONAL = 1,
+    /**
+     * @generated from enum value: FEATURE_SUPPORTS_EDITIONS = 2;
+     */
+    SUPPORTS_EDITIONS = 2
 }
 /**
  * Represents a single generated file.

package/dist/cjs/google/protobuf/compiler/plugin_pb.js

@@ -70,6 +70,11 @@ class CodeGeneratorRequest extends message_js_1.Message {
          * they import.  The files will appear in topological order, so each file
          * appears before any file that imports it.
          *
+         * Note: the files listed in files_to_generate will include runtime-retention
+         * options only, but all other files will include source-retention options.
+         * The source_file_descriptors field below is available in case you need
+         * source-retention options for files_to_generate.
+         *
          * protoc guarantees that all proto_files will be written after
          * the fields above, even though this is not technically guaranteed by the
          * protobuf wire format.  This theoretically could allow a plugin to stream
@@ -84,6 +89,14 @@ class CodeGeneratorRequest extends message_js_1.Message {
          * @generated from field: repeated google.protobuf.FileDescriptorProto proto_file = 15;
          */
         this.protoFile = [];
+        /**
+         * File descriptors with all options, including source-retention options.
+         * These descriptors are only provided for the files listed in
+         * files_to_generate.
+         *
+         * @generated from field: repeated google.protobuf.FileDescriptorProto source_file_descriptors = 17;
+         */
+        this.sourceFileDescriptors = [];
         proto2_js_1.proto2.util.initPartial(data, this);
     }
     static fromBinary(bytes, options) {
@@ -106,6 +119,7 @@ CodeGeneratorRequest.fields = proto2_js_1.proto2.util.newFieldList(() => [
     { no: 1, name: "file_to_generate", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true },
     { no: 2, name: "parameter", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 15, name: "proto_file", kind: "message", T: descriptor_pb_js_1.FileDescriptorProto, repeated: true },
+    { no: 17, name: "source_file_descriptors", kind: "message", T: descriptor_pb_js_1.FileDescriptorProto, repeated: true },
     { no: 3, name: "compiler_version", kind: "message", T: Version, opt: true },
 ]);
 /**
@@ -158,11 +172,16 @@ var CodeGeneratorResponse_Feature;
      * @generated from enum value: FEATURE_PROTO3_OPTIONAL = 1;
      */
     CodeGeneratorResponse_Feature[CodeGeneratorResponse_Feature["PROTO3_OPTIONAL"] = 1] = "PROTO3_OPTIONAL";
+    /**
+     * @generated from enum value: FEATURE_SUPPORTS_EDITIONS = 2;
+     */
+    CodeGeneratorResponse_Feature[CodeGeneratorResponse_Feature["SUPPORTS_EDITIONS"] = 2] = "SUPPORTS_EDITIONS";
 })(CodeGeneratorResponse_Feature || (exports.CodeGeneratorResponse_Feature = CodeGeneratorResponse_Feature = {}));
 // Retrieve enum metadata with: proto2.getEnumType(CodeGeneratorResponse_Feature)
 proto2_js_1.proto2.util.setEnumType(CodeGeneratorResponse_Feature, "google.protobuf.compiler.CodeGeneratorResponse.Feature", [
     { no: 0, name: "FEATURE_NONE" },
     { no: 1, name: "FEATURE_PROTO3_OPTIONAL" },
+    { no: 2, name: "FEATURE_SUPPORTS_EDITIONS" },
 ]);
 /**
  * Represents a single generated file.