@bufbuild/protobuf 1.1.1 → 1.2.0

package/dist/cjs/codegen-info.js

@@ -25,6 +25,8 @@ exports.codegenInfo = {
     reifyWkt: reify_wkt_js_1.reifyWkt,
     getUnwrappedFieldType: field_wrapper_js_1.getUnwrappedFieldType,
     scalarDefaultValue: scalars_js_1.scalarDefaultValue,
+    safeIdentifier: names_js_1.safeIdentifier,
+    safeObjectProperty: names_js_1.safeObjectProperty,
     // prettier-ignore
     symbols: {
         proto2: { typeOnly: false, privateImportPath: "./proto2.js", publicImportPath: packageName },

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 v1.1.1 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
+// @generated by protoc-gen-es v1.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 v1.1.1 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
+// @generated by protoc-gen-es v1.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/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/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/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 v1.1.1 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
+// @generated by protoc-gen-es v1.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 v1.1.1 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
+// @generated by protoc-gen-es v1.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/names.js

@@ -31,10 +31,12 @@ export 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 safeObjectProperty(safeIdentifier(name));
         }
         case "enum_value": {
             const sharedPrefix = desc.parent.sharedPrefix;
@@ -42,10 +44,7 @@ export function localName(desc) {
                 return desc.name;
             }
             const name = desc.name.substring(sharedPrefix.length);
-            if (reservedObjectProperties[name]) {
-                return name + "$";
-            }
-            return name;
+            return safeObjectProperty(name);
         }
         case "rpc": {
             let name = desc.name;
@@ -53,10 +52,7 @@ export function localName(desc) {
                 return name;
             }
             name = name[0].toLowerCase() + name.substring(1);
-            if (reservedObjectProperties[name]) {
-                return name + "$";
-            }
-            return name;
+            return safeObjectProperty(name);
         }
     }
 }
@@ -64,15 +60,12 @@ export function localName(desc) {
  * Returns the name of a field in generated code.
  */
 export 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 safeObjectProperty(safeMessageProperty(name));
 }
 /**
  * Returns the name of a oneof group in generated code.
@@ -149,91 +142,127 @@ 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.
+ */
+export const safeObjectProperty = (name) => {
+    if (reservedObjectProperties.has(name)) {
+        return fallback(name);
+    }
+    return name;
+};
+/**
+ * Names that can be used for identifiers or class properties
+ */
+export const safeIdentifier = (name) => {
+    if (reservedIdentifiers.has(name)) {
+        return fallback(name);
+    }
+    return name;
 };

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

@@ -1,4 +1,4 @@
-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";
@@ -10,6 +10,8 @@ interface CodegenInfo {
     readonly wktSourceFiles: readonly string[];
     readonly scalarDefaultValue: typeof scalarDefaultValue;
     readonly reifyWkt: typeof reifyWkt;
+    readonly safeIdentifier: typeof safeIdentifier;
+    readonly safeObjectProperty: typeof safeObjectProperty;
 }
 type RuntimeSymbolName = "proto2" | "proto3" | "Message" | "PartialMessage" | "PlainMessage" | "FieldList" | "MessageType" | "BinaryReadOptions" | "BinaryWriteOptions" | "JsonReadOptions" | "JsonWriteOptions" | "JsonValue" | "JsonObject" | "protoInt64" | "ScalarType" | "MethodKind" | "MethodIdempotency" | "IMessageTypeRegistry";
 type RuntimeSymbolInfo = {

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

@@ -31,4 +31,13 @@ export declare function findEnumSharedPrefix(enumName: string, valueNames: strin
  * used by protoc to convert a field name to a JSON name.
  */
 declare function protoCamelCase(snakeCase: string): string;
+/**
+ * Names that cannot be used for object properties because they are reserved
+ * by built-in JavaScript properties.
+ */
+export declare const safeObjectProperty: (name: string) => string;
+/**
+ * Names that can be used for identifiers or class properties
+ */
+export declare const safeIdentifier: (name: string) => string;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bufbuild/protobuf",
-  "version": "1.1.1",
+  "version": "1.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": {