@bufbuild/protobuf 1.1.1 → 1.2.1

package/dist/cjs/private/names.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.findEnumSharedPrefix = exports.fieldJsonName = exports.localOneofName = exports.localFieldName = exports.localName = void 0;
+exports.safeIdentifier = exports.safeObjectProperty = exports.findEnumSharedPrefix = exports.fieldJsonName = exports.localOneofName = exports.localFieldName = exports.localName = void 0;
 /**
  * Returns the name of a protobuf element in generated code.
  *
@@ -34,10 +34,12 @@ function localName(desc) {
             const pkg = desc.file.proto.package;
             const offset = pkg === undefined ? 0 : pkg.length + 1;
             const name = desc.typeName.substring(offset).replace(/\./g, "_");
-            if (reservedIdent[name]) {
-                return name + "$";
-            }
-            return name;
+            // For services, we only care about safe identifiers, not safe object properties,
+            // but we have shipped v1 with a bug that respected object properties, and we
+            // do not want to introduce a breaking change, so we continue to escape for
+            // safe object properties.
+            // See https://github.com/bufbuild/protobuf-es/pull/391
+            return (0, exports.safeObjectProperty)((0, exports.safeIdentifier)(name));
         }
         case "enum_value": {
             const sharedPrefix = desc.parent.sharedPrefix;
@@ -45,10 +47,7 @@ function localName(desc) {
                 return desc.name;
             }
             const name = desc.name.substring(sharedPrefix.length);
-            if (reservedObjectProperties[name]) {
-                return name + "$";
-            }
-            return name;
+            return (0, exports.safeObjectProperty)(name);
         }
         case "rpc": {
             let name = desc.name;
@@ -56,10 +55,7 @@ function localName(desc) {
                 return name;
             }
             name = name[0].toLowerCase() + name.substring(1);
-            if (reservedObjectProperties[name]) {
-                return name + "$";
-            }
-            return name;
+            return (0, exports.safeObjectProperty)(name);
         }
     }
 }
@@ -68,15 +64,12 @@ exports.localName = localName;
  * Returns the name of a field in generated code.
  */
 function localFieldName(protoName, inOneof) {
-    let name = protoCamelCase(protoName);
+    const name = protoCamelCase(protoName);
     if (inOneof) {
         // oneof member names are not properties, but values of the `case` property.
         return name;
     }
-    if (reservedObjectProperties[name] || reservedMessageProperties[name]) {
-        name = name + "$";
-    }
-    return name;
+    return (0, exports.safeObjectProperty)(safeMessageProperty(name));
 }
 exports.localFieldName = localFieldName;
 /**
@@ -156,91 +149,129 @@ function protoCamelCase(snakeCase) {
     }
     return b.join("");
 }
-// Names that cannot be used for identifiers, such as class names,
-// but _can_ be used for object properties.
-const reservedIdent = {
+/**
+ * Names that cannot be used for identifiers, such as class names,
+ * but _can_ be used for object properties.
+ */
+const reservedIdentifiers = new Set([
     // ECMAScript 2015 keywords
-    break: true,
-    case: true,
-    catch: true,
-    class: true,
-    const: true,
-    continue: true,
-    debugger: true,
-    default: true,
-    delete: true,
-    do: true,
-    else: true,
-    export: true,
-    extends: true,
-    false: true,
-    finally: true,
-    for: true,
-    function: true,
-    if: true,
-    import: true,
-    in: true,
-    instanceof: true,
-    new: true,
-    null: true,
-    return: true,
-    super: true,
-    switch: true,
-    this: true,
-    throw: true,
-    true: true,
-    try: true,
-    typeof: true,
-    var: true,
-    void: true,
-    while: true,
-    with: true,
-    yield: true,
+    "break",
+    "case",
+    "catch",
+    "class",
+    "const",
+    "continue",
+    "debugger",
+    "default",
+    "delete",
+    "do",
+    "else",
+    "export",
+    "extends",
+    "false",
+    "finally",
+    "for",
+    "function",
+    "if",
+    "import",
+    "in",
+    "instanceof",
+    "new",
+    "null",
+    "return",
+    "super",
+    "switch",
+    "this",
+    "throw",
+    "true",
+    "try",
+    "typeof",
+    "var",
+    "void",
+    "while",
+    "with",
+    "yield",
     // ECMAScript 2015 future reserved keywords
-    enum: true,
-    implements: true,
-    interface: true,
-    let: true,
-    package: true,
-    private: true,
-    protected: true,
-    public: true,
-    static: true,
+    "enum",
+    "implements",
+    "interface",
+    "let",
+    "package",
+    "private",
+    "protected",
+    "public",
+    "static",
     // Class name cannot be 'Object' when targeting ES5 with module CommonJS
-    Object: true,
+    "Object",
     // TypeScript keywords that cannot be used for types (as opposed to variables)
-    bigint: true,
-    number: true,
-    boolean: true,
-    string: true,
-    object: true,
+    "bigint",
+    "number",
+    "boolean",
+    "string",
+    "object",
     // Identifiers reserved for the runtime, so we can generate legible code
-    globalThis: true,
-    Uint8Array: true,
-    Partial: true,
-};
-// Names that cannot be used for object properties because they are reserved
-// by built-in JavaScript properties.
-const reservedObjectProperties = {
+    "globalThis",
+    "Uint8Array",
+    "Partial",
+]);
+/**
+ * Names that cannot be used for object properties because they are reserved
+ * by built-in JavaScript properties.
+ */
+const reservedObjectProperties = new Set([
     // names reserved by JavaScript
-    constructor: true,
-    toString: true,
-    toJSON: true,
-    valueOf: true,
-};
-// Names that cannot be used for object properties because they are reserved
-// by the runtime.
-const reservedMessageProperties = {
+    "constructor",
+    "toString",
+    "toJSON",
+    "valueOf",
+]);
+/**
+ * Names that cannot be used for object properties because they are reserved
+ * by the runtime.
+ */
+const reservedMessageProperties = new Set([
     // names reserved by the runtime
-    getType: true,
-    clone: true,
-    equals: true,
-    fromBinary: true,
-    fromJson: true,
-    fromJsonString: true,
-    toBinary: true,
-    toJson: true,
-    toJsonString: true,
+    "getType",
+    "clone",
+    "equals",
+    "fromBinary",
+    "fromJson",
+    "fromJsonString",
+    "toBinary",
+    "toJson",
+    "toJsonString",
     // names reserved by the runtime for the future
-    toObject: true,
+    "toObject",
+]);
+const fallback = (name) => `${name}$`;
+/**
+ * Will wrap names that are Object prototype properties or names reserved
+ * for `Message`s.
+ */
+const safeMessageProperty = (name) => {
+    if (reservedMessageProperties.has(name)) {
+        return fallback(name);
+    }
+    return name;
+};
+/**
+ * Names that cannot be used for object properties because they are reserved
+ * by built-in JavaScript properties.
+ */
+const safeObjectProperty = (name) => {
+    if (reservedObjectProperties.has(name)) {
+        return fallback(name);
+    }
+    return name;
+};
+exports.safeObjectProperty = safeObjectProperty;
+/**
+ * Names that can be used for identifiers or class properties
+ */
+const safeIdentifier = (name) => {
+    if (reservedIdentifiers.has(name)) {
+        return fallback(name);
+    }
+    return name;
 };
+exports.safeIdentifier = safeIdentifier;

package/dist/cjs/proto-base64.js

@@ -90,15 +90,7 @@ exports.protoBase64 = {
         return bytes.subarray(0, bytePos);
     },
     /**
-     * Decodes a base64 string to a byte array.
-     *
-     * - ignores white-space, including line breaks and tabs
-     * - allows inner padding (can decode concatenated base64 strings)
-     * - does not require padding
-     * - understands base64url encoding:
-     *   "-" instead of "+",
-     *   "_" instead of "/",
-     *   no padding
+     * Encode a byte array to a base64 string.
      */
     enc(bytes) {
         let base64 = "", groupPos = 0, // position in base64 group
@@ -124,7 +116,7 @@ exports.protoBase64 = {
                     break;
             }
         }
-        // padding required?
+        // add output padding
         if (groupPos) {
             base64 += encTable[p];
             base64 += "=";

package/dist/esm/codegen-info.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.
-import { localName } from "./private/names.js";
+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";
@@ -22,6 +22,8 @@ export const codegenInfo = {
     reifyWkt,
     getUnwrappedFieldType,
     scalarDefaultValue,
+    safeIdentifier,
+    safeObjectProperty,
     // prettier-ignore
     symbols: {
         proto2: { typeOnly: false, privateImportPath: "./proto2.js", publicImportPath: packageName },

package/dist/esm/create-descriptor-set.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.
-import { FieldDescriptorProto_Label, FieldDescriptorProto_Type, FileDescriptorSet, MethodOptions_IdempotencyLevel, } from "./google/protobuf/descriptor_pb.js";
+import { FieldDescriptorProto_Label, FieldDescriptorProto_Type, FileDescriptorProto, FileDescriptorSet, MethodDescriptorProto, MethodOptions_IdempotencyLevel, ServiceDescriptorProto, SourceCodeInfo, } from "./google/protobuf/descriptor_pb.js";
 import { assert } from "./private/assert.js";
 import { ScalarType } from "./field.js";
 import { MethodIdempotency, MethodKind } from "./service-type.js";

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

@@ -43,7 +43,7 @@ import { proto3 } from "../../proto3.js";
  *       foo = any.unpack(Foo.getDefaultInstance());
  *     }
  *
- * Example 3: Pack and unpack a message in Python.
+ *  Example 3: Pack and unpack a message in Python.
  *
  *     foo = Foo(...)
  *     any = Any()
@@ -53,7 +53,7 @@ import { proto3 } from "../../proto3.js";
  *       any.Unpack(foo)
  *       ...
  *
- * Example 4: Pack and unpack a message in Go
+ *  Example 4: Pack and unpack a message in Go
  *
  *      foo := &pb.Foo{...}
  *      any, err := anypb.New(foo)
@@ -73,7 +73,7 @@ import { proto3 } from "../../proto3.js";
  * name "y.z".
  *
  * JSON
- *
+ * ====
  * The JSON representation of an `Any` value uses the regular
  * representation of the deserialized, embedded message, with an
  * additional field `@type` which contains the type URL. Example:
@@ -103,7 +103,7 @@ import { proto3 } from "../../proto3.js";
  *
  * @generated from message google.protobuf.Any
  */
-export class Any extends Message {
+class Any extends Message {
     constructor(data) {
         super();
         /**
@@ -266,3 +266,4 @@ Any.fields = proto3.util.newFieldList(() => [
     { no: 1, name: "type_url", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 2, name: "value", kind: "scalar", T: 12 /* ScalarType.BYTES */ },
 ]);
+export { Any };

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

@@ -28,7 +28,7 @@ import { proto3 } from "../../proto3.js";
  *
  * @generated from message google.protobuf.Api
  */
-export class Api extends Message {
+class Api extends Message {
     constructor(data) {
         super();
         /**
@@ -113,12 +113,13 @@ Api.fields = proto3.util.newFieldList(() => [
     { no: 6, name: "mixins", kind: "message", T: Mixin, repeated: true },
     { no: 7, name: "syntax", kind: "enum", T: proto3.getEnumType(Syntax) },
 ]);
+export { Api };
 /**
  * Method represents a method of an API interface.
  *
  * @generated from message google.protobuf.Method
  */
-export class Method extends Message {
+class Method extends Message {
     constructor(data) {
         super();
         /**
@@ -189,6 +190,7 @@ Method.fields = proto3.util.newFieldList(() => [
     { no: 6, name: "options", kind: "message", T: Option, repeated: true },
     { no: 7, name: "syntax", kind: "enum", T: proto3.getEnumType(Syntax) },
 ]);
+export { Method };
 /**
  * Declares an API Interface to be included in this interface. The including
  * interface must redeclare all the methods from the included interface, but
@@ -237,7 +239,7 @@ Method.fields = proto3.util.newFieldList(() => [
  * The mixin construct implies that all methods in `AccessControl` are
  * also declared with same name and request/response types in
  * `Storage`. A documentation generator or annotation processor will
- * see the effective `Storage.GetAcl` method after inheriting
+ * see the effective `Storage.GetAcl` method after inherting
  * documentation and annotations as follows:
  *
  *     service Storage {
@@ -271,7 +273,7 @@ Method.fields = proto3.util.newFieldList(() => [
  *
  * @generated from message google.protobuf.Mixin
  */
-export class Mixin extends Message {
+class Mixin extends Message {
     constructor(data) {
         super();
         /**
@@ -308,3 +310,4 @@ Mixin.fields = proto3.util.newFieldList(() => [
     { no: 1, name: "name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 2, name: "root", kind: "scalar", T: 9 /* ScalarType.STRING */ },
 ]);
+export { Mixin };

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

@@ -19,7 +19,7 @@ import { FileDescriptorProto, GeneratedCodeInfo } from "../descriptor_pb.js";
  *
  * @generated from message google.protobuf.compiler.Version
  */
-export class Version extends Message {
+class Version extends Message {
     constructor(data) {
         super();
         proto2.util.initPartial(data, this);
@@ -45,12 +45,13 @@ Version.fields = proto2.util.newFieldList(() => [
     { no: 3, name: "patch", kind: "scalar", T: 5 /* ScalarType.INT32 */, opt: true },
     { no: 4, name: "suffix", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
 ]);
+export { Version };
 /**
  * An encoded CodeGeneratorRequest is written to the plugin's stdin.
  *
  * @generated from message google.protobuf.compiler.CodeGeneratorRequest
  */
-export class CodeGeneratorRequest extends Message {
+class CodeGeneratorRequest extends Message {
     constructor(data) {
         super();
         /**
@@ -103,12 +104,13 @@ CodeGeneratorRequest.fields = proto2.util.newFieldList(() => [
     { no: 15, name: "proto_file", kind: "message", T: FileDescriptorProto, repeated: true },
     { no: 3, name: "compiler_version", kind: "message", T: Version, opt: true },
 ]);
+export { CodeGeneratorRequest };
 /**
  * The plugin writes an encoded CodeGeneratorResponse to stdout.
  *
  * @generated from message google.protobuf.compiler.CodeGeneratorResponse
  */
-export class CodeGeneratorResponse extends Message {
+class CodeGeneratorResponse extends Message {
     constructor(data) {
         super();
         /**
@@ -137,6 +139,7 @@ CodeGeneratorResponse.fields = proto2.util.newFieldList(() => [
     { no: 2, name: "supported_features", kind: "scalar", T: 4 /* ScalarType.UINT64 */, opt: true },
     { no: 15, name: "file", kind: "message", T: CodeGeneratorResponse_File, repeated: true },
 ]);
+export { CodeGeneratorResponse };
 /**
  * Sync with code_generator.h.
  *
@@ -163,7 +166,7 @@ proto2.util.setEnumType(CodeGeneratorResponse_Feature, "google.protobuf.compiler
  *
  * @generated from message google.protobuf.compiler.CodeGeneratorResponse.File
  */
-export class CodeGeneratorResponse_File extends Message {
+class CodeGeneratorResponse_File extends Message {
     constructor(data) {
         super();
         proto2.util.initPartial(data, this);
@@ -189,3 +192,4 @@ CodeGeneratorResponse_File.fields = proto2.util.newFieldList(() => [
     { no: 15, name: "content", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
     { no: 16, name: "generated_code_info", kind: "message", T: GeneratedCodeInfo, opt: true },
 ]);
+export { CodeGeneratorResponse_File };