@bufbuild/protoc-gen-es 1.9.0 → 2.0.0-alpha.2

package/dist/cjs/src/util.js

@@ -13,56 +13,67 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFieldZeroValueExpression = exports.getFieldDefaultValueExpression = exports.getFieldTypeInfo = void 0;
-const protobuf_1 = require("@bufbuild/protobuf");
-const ecmascript_1 = require("@bufbuild/protoplugin/ecmascript");
-function getFieldTypeInfo(field) {
+exports.arrayLiteral = exports.functionCall = exports.fieldTypeScriptType = void 0;
+const reflect_1 = require("@bufbuild/protobuf/reflect");
+const wkt_1 = require("@bufbuild/protobuf/wkt");
+function fieldTypeScriptType(field) {
     const typing = [];
-    let typingInferrableFromZeroValue;
     let optional = false;
     switch (field.fieldKind) {
         case "scalar":
-            typing.push(scalarTypeScriptType(field.scalar, field.longType));
-            optional =
-                field.optional ||
-                    field.proto.label === protobuf_1.FieldDescriptorProto_Label.REQUIRED;
-            typingInferrableFromZeroValue = true;
+            typing.push((0, reflect_1.scalarTypeScriptType)(field.scalar, field.longType));
+            optional = field.proto.proto3Optional;
             break;
         case "message": {
-            const baseType = protobuf_1.codegenInfo.getUnwrappedFieldType(field);
-            if (baseType !== undefined) {
-                typing.push(scalarTypeScriptType(baseType, protobuf_1.LongType.BIGINT));
+            if (!field.oneof && (0, wkt_1.isWrapperDesc)(field.message)) {
+                const baseType = field.message.fields[0].scalar;
+                typing.push((0, reflect_1.scalarTypeScriptType)(baseType, reflect_1.LongType.BIGINT));
             }
             else {
                 typing.push({
-                    kind: "es_ref_message",
-                    type: field.message,
-                    typeOnly: true,
+                    kind: "es_shape_ref",
+                    desc: field.message,
                 });
             }
             optional = true;
-            typingInferrableFromZeroValue = true;
             break;
         }
         case "enum":
             typing.push({
-                kind: "es_ref_enum",
-                type: field.enum,
-                typeOnly: true,
+                kind: "es_shape_ref",
+                desc: field.enum,
             });
-            optional =
-                field.optional ||
-                    field.proto.label === protobuf_1.FieldDescriptorProto_Label.REQUIRED;
-            typingInferrableFromZeroValue = true;
+            optional = field.proto.proto3Optional;
+            break;
+        case "list":
+            optional = false;
+            switch (field.listKind) {
+                case "enum":
+                    typing.push({
+                        kind: "es_shape_ref",
+                        desc: field.enum,
+                    }, "[]");
+                    break;
+                case "scalar":
+                    typing.push((0, reflect_1.scalarTypeScriptType)(field.scalar, field.longType), "[]");
+                    break;
+                case "message": {
+                    typing.push({
+                        kind: "es_shape_ref",
+                        desc: field.message,
+                    }, "[]");
+                    break;
+                }
+            }
             break;
         case "map": {
             let keyType;
             switch (field.mapKey) {
-                case protobuf_1.ScalarType.INT32:
-                case protobuf_1.ScalarType.FIXED32:
-                case protobuf_1.ScalarType.UINT32:
-                case protobuf_1.ScalarType.SFIXED32:
-                case protobuf_1.ScalarType.SINT32:
+                case reflect_1.ScalarType.INT32:
+                case reflect_1.ScalarType.FIXED32:
+                case reflect_1.ScalarType.UINT32:
+                case reflect_1.ScalarType.SFIXED32:
+                case reflect_1.ScalarType.SINT32:
                     keyType = "number";
                     break;
                 default:
@@ -70,191 +81,50 @@ function getFieldTypeInfo(field) {
                     break;
             }
             let valueType;
-            switch (field.mapValue.kind) {
+            switch (field.mapKind) {
                 case "scalar":
-                    valueType = scalarTypeScriptType(field.mapValue.scalar, protobuf_1.LongType.BIGINT);
+                    valueType = (0, reflect_1.scalarTypeScriptType)(field.scalar, reflect_1.LongType.BIGINT);
                     break;
                 case "message":
                     valueType = {
-                        kind: "es_ref_message",
-                        type: field.mapValue.message,
-                        typeOnly: true,
+                        kind: "es_shape_ref",
+                        desc: field.message,
                     };
                     break;
                 case "enum":
                     valueType = {
-                        kind: "es_ref_enum",
-                        type: field.mapValue.enum,
-                        typeOnly: true,
+                        kind: "es_shape_ref",
+                        desc: field.enum,
                     };
                     break;
             }
             typing.push("{ [key: ", keyType, "]: ", valueType, " }");
-            typingInferrableFromZeroValue = false;
             optional = false;
             break;
         }
     }
-    if (field.repeated) {
-        typing.push("[]");
-        optional = false;
-        typingInferrableFromZeroValue = false;
-    }
-    return { typing, optional, typingInferrableFromZeroValue };
+    return { typing, optional };
 }
-exports.getFieldTypeInfo = getFieldTypeInfo;
-/**
- * Return a printable expression for the default value of a field.
- * Only applicable for singular scalar and enum fields.
- */
-function getFieldDefaultValueExpression(field, enumAs = "enum_value_as_is") {
-    if (field.repeated) {
-        return undefined;
-    }
-    if (field.fieldKind !== "enum" && field.fieldKind !== "scalar") {
-        return undefined;
-    }
-    const defaultValue = field.getDefaultValue();
-    if (defaultValue === undefined) {
-        return undefined;
-    }
-    switch (field.fieldKind) {
-        case "enum": {
-            const enumValue = field.enum.values.find((value) => value.number === defaultValue);
-            if (enumValue === undefined) {
-                throw new Error(`invalid enum default value: ${String(defaultValue)} for ${enumValue}`);
-            }
-            return literalEnumValue(enumValue, enumAs);
-        }
-        case "scalar":
-            return literalScalarValue(defaultValue, field);
+exports.fieldTypeScriptType = fieldTypeScriptType;
+function functionCall(fn, args, typeParams) {
+    let tp = [];
+    if (typeParams !== undefined && typeParams.length > 0) {
+        tp = ["<", commaSeparate(typeParams), ">"];
     }
+    return [fn, ...tp, "(", commaSeparate(args), ")"];
 }
-exports.getFieldDefaultValueExpression = getFieldDefaultValueExpression;
-/**
- * Return a printable expression for the zero value of a field.
- *
- * Returns either:
- * - empty array literal for repeated fields
- * - empty object literal for maps
- * - undefined for message fields
- * - an enums first value
- * - scalar zero value
- */
-function getFieldZeroValueExpression(field, enumAs = "enum_value_as_is") {
-    if (field.repeated) {
-        return "[]";
-    }
-    switch (field.fieldKind) {
-        case "message":
-            return undefined;
-        case "map":
-            return "{}";
-        case "enum": {
-            // In proto3, the first enum value must be zero.
-            // In proto2, protobuf-go returns the first value as the default.
-            if (field.enum.values.length < 1) {
-                throw new Error("invalid enum: missing at least one value");
-            }
-            const zeroValue = field.enum.values[0];
-            return literalEnumValue(zeroValue, enumAs);
-        }
-        case "scalar": {
-            const defaultValue = protobuf_1.codegenInfo.scalarZeroValue(field.scalar, field.longType);
-            return literalScalarValue(defaultValue, field);
-        }
-    }
-}
-exports.getFieldZeroValueExpression = getFieldZeroValueExpression;
-function literalScalarValue(value, field) {
-    switch (field.scalar) {
-        case protobuf_1.ScalarType.DOUBLE:
-        case protobuf_1.ScalarType.FLOAT:
-        case protobuf_1.ScalarType.INT32:
-        case protobuf_1.ScalarType.FIXED32:
-        case protobuf_1.ScalarType.UINT32:
-        case protobuf_1.ScalarType.SFIXED32:
-        case protobuf_1.ScalarType.SINT32:
-            if (typeof value != "number") {
-                throw new Error(`Unexpected value for ${protobuf_1.ScalarType[field.scalar]} ${field.toString()}: ${String(value)}`);
-            }
-            return value;
-        case protobuf_1.ScalarType.BOOL:
-            if (typeof value != "boolean") {
-                throw new Error(`Unexpected value for ${protobuf_1.ScalarType[field.scalar]} ${field.toString()}: ${String(value)}`);
-            }
-            return value;
-        case protobuf_1.ScalarType.STRING:
-            if (typeof value != "string") {
-                throw new Error(`Unexpected value for ${protobuf_1.ScalarType[field.scalar]} ${field.toString()}: ${String(value)}`);
-            }
-            return { kind: "es_string", value };
-        case protobuf_1.ScalarType.BYTES:
-            if (!(value instanceof Uint8Array)) {
-                throw new Error(`Unexpected value for ${protobuf_1.ScalarType[field.scalar]} ${field.toString()}: ${String(value)}`);
-            }
-            return value;
-        case protobuf_1.ScalarType.INT64:
-        case protobuf_1.ScalarType.SINT64:
-        case protobuf_1.ScalarType.SFIXED64:
-        case protobuf_1.ScalarType.UINT64:
-        case protobuf_1.ScalarType.FIXED64:
-            if (typeof value != "bigint" && typeof value != "string") {
-                throw new Error(`Unexpected value for ${protobuf_1.ScalarType[field.scalar]} ${field.toString()}: ${String(value)}`);
-            }
-            return {
-                kind: "es_proto_int64",
-                type: field.scalar,
-                longType: field.longType,
-                value,
-            };
-    }
+exports.functionCall = functionCall;
+function arrayLiteral(elements) {
+    return ["[", commaSeparate(elements), "]"];
 }
-function literalEnumValue(value, enumAs) {
-    switch (enumAs) {
-        case "enum_value_as_is":
-            return [
-                { kind: "es_ref_enum", type: value.parent, typeOnly: false },
-                ".",
-                (0, ecmascript_1.localName)(value),
-            ];
-        case "enum_value_as_integer":
-            return [
-                value.number,
-                " /* ",
-                value.parent.typeName,
-                ".",
-                value.name,
-                " */",
-            ];
-        case "enum_value_as_cast_integer":
-            return [
-                value.number,
-                " as ",
-                { kind: "es_ref_enum", type: value.parent, typeOnly: true },
-                ".",
-                (0, ecmascript_1.localName)(value),
-            ];
-    }
-}
-function scalarTypeScriptType(type, longType) {
-    switch (type) {
-        case protobuf_1.ScalarType.STRING:
-            return "string";
-        case protobuf_1.ScalarType.BOOL:
-            return "boolean";
-        case protobuf_1.ScalarType.UINT64:
-        case protobuf_1.ScalarType.SFIXED64:
-        case protobuf_1.ScalarType.FIXED64:
-        case protobuf_1.ScalarType.SINT64:
-        case protobuf_1.ScalarType.INT64:
-            if (longType === protobuf_1.LongType.STRING) {
-                return "string";
-            }
-            return "bigint";
-        case protobuf_1.ScalarType.BYTES:
-            return "Uint8Array";
-        default:
-            return "number";
+exports.arrayLiteral = arrayLiteral;
+function commaSeparate(elements) {
+    const r = [];
+    for (let i = 0; i < elements.length; i++) {
+        r.push(elements[i]);
+        if (i < elements.length - 1) {
+            r.push(", ");
+        }
     }
+    return r;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bufbuild/protoc-gen-es",
-  "version": "1.9.0",
+  "version": "2.0.0-alpha.2",
   "description": "Protocol Buffers code generator for ECMAScript",
   "license": "Apache-2.0",
   "repository": {
@@ -20,15 +20,19 @@
   },
   "preferUnplugged": true,
   "dependencies": {
-    "@bufbuild/protobuf": "^1.9.0",
-    "@bufbuild/protoplugin": "1.9.0"
+    "@bufbuild/protobuf": "^2.0.0-alpha.2",
+    "@bufbuild/protoplugin": "2.0.0-alpha.2"
   },
   "peerDependencies": {
-    "@bufbuild/protobuf": "1.9.0"
+    "@bufbuild/protobuf": "2.0.0-alpha.2"
   },
   "peerDependenciesMeta": {
     "@bufbuild/protobuf": {
       "optional": true
     }
-  }
+  },
+  "files": [
+    "dist/**",
+    "bin/**"
+  ]
 }

package/dist/cjs/src/declaration.js

@@ -1,218 +0,0 @@
-"use strict";
-// Copyright 2021-2024 Buf Technologies, Inc.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// 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.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateDts = void 0;
-const ecmascript_1 = require("@bufbuild/protoplugin/ecmascript");
-const editions_js_1 = require("./editions.js");
-const util_js_1 = require("./util.js");
-function generateDts(schema) {
-    for (const file of schema.files) {
-        const f = schema.generateFile(file.name + "_pb.d.ts");
-        f.preamble(file);
-        for (const enumeration of file.enums) {
-            generateEnum(schema, f, enumeration);
-        }
-        for (const message of file.messages) {
-            generateMessage(schema, f, message);
-        }
-        for (const extension of file.extensions) {
-            generateExtension(schema, f, extension);
-        }
-        // We do not generate anything for services
-    }
-}
-exports.generateDts = generateDts;
-// prettier-ignore
-function generateEnum(schema, f, enumeration) {
-    f.print(f.jsDoc(enumeration));
-    f.print(f.exportDecl("declare enum", (0, ecmascript_1.localName)(enumeration)), " {");
-    for (const value of enumeration.values) {
-        if (enumeration.values.indexOf(value) > 0) {
-            f.print();
-        }
-        f.print(f.jsDoc(value, "  "));
-        f.print("  ", (0, ecmascript_1.localName)(value), " = ", value.number, ",");
-    }
-    f.print("}");
-    f.print();
-}
-// prettier-ignore
-function generateMessage(schema, f, message) {
-    const protoN = (0, editions_js_1.getNonEditionRuntime)(schema, message.file);
-    const { PartialMessage, FieldList, Message, PlainMessage, BinaryReadOptions, JsonReadOptions, JsonValue } = schema.runtime;
-    const m = (0, ecmascript_1.localName)(message);
-    f.print(f.jsDoc(message));
-    f.print(f.exportDecl("declare class", m), " extends ", Message, "<", m, "> {");
-    for (const member of message.members) {
-        switch (member.kind) {
-            case "oneof":
-                generateOneof(schema, f, member);
-                break;
-            default:
-                generateField(schema, f, member);
-                break;
-        }
-        f.print();
-    }
-    f.print("  constructor(data?: ", PartialMessage, "<", m, ">);");
-    f.print();
-    generateWktMethods(schema, f, message);
-    f.print("  static readonly runtime: typeof ", protoN, ";");
-    f.print('  static readonly typeName = ', f.string(message.typeName), ';');
-    f.print("  static readonly fields: ", FieldList, ";");
-    // In case we start supporting options, we have to surface them here
-    //f.print("  static readonly options: { readonly [extensionName: string]: ", rt.JsonValue, " } = {};")
-    f.print();
-    generateWktStaticMethods(schema, f, message);
-    f.print("  static fromBinary(bytes: Uint8Array, options?: Partial<", BinaryReadOptions, ">): ", m, ";");
-    f.print();
-    f.print("  static fromJson(jsonValue: ", JsonValue, ", options?: Partial<", JsonReadOptions, ">): ", m, ";");
-    f.print();
-    f.print("  static fromJsonString(jsonString: string, options?: Partial<", JsonReadOptions, ">): ", m, ";");
-    f.print();
-    f.print("  static equals(a: ", m, " | ", PlainMessage, "<", m, "> | undefined, b: ", m, " | ", PlainMessage, "<", m, "> | undefined): boolean;");
-    f.print("}");
-    f.print();
-    for (const nestedEnum of message.nestedEnums) {
-        generateEnum(schema, f, nestedEnum);
-    }
-    for (const nestedMessage of message.nestedMessages) {
-        generateMessage(schema, f, nestedMessage);
-    }
-    for (const nestedExtension of message.nestedExtensions) {
-        generateExtension(schema, f, nestedExtension);
-    }
-}
-// prettier-ignore
-function generateOneof(schema, f, oneof) {
-    f.print(f.jsDoc(oneof, "  "));
-    f.print("  ", (0, ecmascript_1.localName)(oneof), ": {");
-    for (const field of oneof.fields) {
-        if (oneof.fields.indexOf(field) > 0) {
-            f.print(`  } | {`);
-        }
-        f.print(f.jsDoc(field, "    "));
-        const { typing } = (0, util_js_1.getFieldTypeInfo)(field);
-        f.print(`    value: `, typing, `;`);
-        f.print(`    case: "`, (0, ecmascript_1.localName)(field), `";`);
-    }
-    f.print(`  } | { case: undefined; value?: undefined };`);
-}
-// prettier-ignore
-function generateField(schema, f, field) {
-    f.print(f.jsDoc(field, "  "));
-    const e = [];
-    const { typing, optional } = (0, util_js_1.getFieldTypeInfo)(field);
-    if (!optional) {
-        e.push("  ", (0, ecmascript_1.localName)(field), ": ", typing, ";");
-    }
-    else {
-        e.push("  ", (0, ecmascript_1.localName)(field), "?: ", typing, ";");
-    }
-    f.print(e);
-}
-// prettier-ignore
-function generateExtension(schema, f, ext) {
-    const { typing } = (0, util_js_1.getFieldTypeInfo)(ext);
-    const e = f.import(ext.extendee).toTypeOnly();
-    f.print(f.jsDoc(ext));
-    f.print(f.exportDecl("declare const", (0, ecmascript_1.localName)(ext)), ": ", schema.runtime.Extension, "<", e, ", ", typing, ">;");
-    f.print();
-}
-// prettier-ignore
-function generateWktMethods(schema, f, message) {
-    const ref = (0, ecmascript_1.reifyWkt)(message);
-    if (ref === undefined) {
-        return;
-    }
-    const { Message, MessageType, IMessageTypeRegistry } = schema.runtime;
-    switch (ref.typeName) {
-        case "google.protobuf.Any":
-            f.print("  packFrom(message: ", Message, "): void;");
-            f.print();
-            f.print("  unpackTo(target: ", Message, "): boolean;");
-            f.print();
-            f.print("  unpack(registry: ", IMessageTypeRegistry, "): Message | undefined;");
-            f.print();
-            f.print("  is(type: ", MessageType, " | string): boolean;");
-            f.print();
-            f.print("  private typeNameToUrl(name: string): string;");
-            f.print();
-            f.print("  private typeUrlToName(url: string): string;");
-            f.print();
-            break;
-        case "google.protobuf.Timestamp":
-            f.print("  toDate(): Date;");
-            f.print();
-            break;
-        case "google.protobuf.Duration":
-        case "google.protobuf.Struct":
-        case "google.protobuf.Value":
-        case "google.protobuf.ListValue":
-        case "google.protobuf.FieldMask":
-        case "google.protobuf.DoubleValue":
-        case "google.protobuf.FloatValue":
-        case "google.protobuf.Int64Value":
-        case "google.protobuf.UInt64Value":
-        case "google.protobuf.Int32Value":
-        case "google.protobuf.UInt32Value":
-        case "google.protobuf.BoolValue":
-        case "google.protobuf.StringValue":
-        case "google.protobuf.BytesValue":
-            break;
-    }
-}
-// prettier-ignore
-function generateWktStaticMethods(schema, f, message) {
-    const ref = (0, ecmascript_1.reifyWkt)(message);
-    if (ref === undefined) {
-        return;
-    }
-    switch (ref.typeName) {
-        case "google.protobuf.Any":
-            f.print("  static pack(message: Message): ", message, ";");
-            f.print();
-            break;
-        case "google.protobuf.Timestamp":
-            f.print("  static now(): ", message, ";");
-            f.print();
-            f.print("  static fromDate(date: Date): ", message, ";");
-            f.print();
-            break;
-        case "google.protobuf.DoubleValue":
-        case "google.protobuf.FloatValue":
-        case "google.protobuf.Int64Value":
-        case "google.protobuf.UInt64Value":
-        case "google.protobuf.Int32Value":
-        case "google.protobuf.UInt32Value":
-        case "google.protobuf.BoolValue":
-        case "google.protobuf.StringValue":
-        case "google.protobuf.BytesValue": {
-            const { typing } = (0, util_js_1.getFieldTypeInfo)(ref.value);
-            f.print("  static readonly fieldWrapper: {");
-            f.print("    wrapField(value: ", typing, "): ", message, ",");
-            f.print("    unwrapField(value: ", message, "): ", typing, ",");
-            f.print("  };");
-            f.print();
-            break;
-        }
-        case "google.protobuf.Duration":
-        case "google.protobuf.Struct":
-        case "google.protobuf.Value":
-        case "google.protobuf.ListValue":
-        case "google.protobuf.FieldMask":
-            break;
-    }
-}

package/dist/cjs/src/editions.js

@@ -1,34 +0,0 @@
-"use strict";
-// Copyright 2021-2024 Buf Technologies, Inc.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// 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.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getNonEditionRuntime = void 0;
-/**
- * Temporary function to retrieve the import symbol for the proto2 or proto3
- * runtime.
- *
- * For syntax "editions", this function raises and error.
- *
- * Once support for "editions" is implemented in the runtime, this function can
- * be removed.
- */
-function getNonEditionRuntime(schema, file) {
-    var _a;
-    if (file.syntax === "editions") {
-        // TODO support editions
-        throw new Error(`${(_a = file.proto.name) !== null && _a !== void 0 ? _a : ""}: syntax "editions" is not supported yet`);
-    }
-    return schema.runtime[file.syntax];
-}
-exports.getNonEditionRuntime = getNonEditionRuntime;