@bufbuild/protoc-gen-es 1.8.0 → 1.10.0

package/dist/cjs/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@bufbuild/protoc-gen-es",
-    "version": "1.8.0",
+    "version": "1.10.0",
     "description": "Protocol Buffers code generator for ECMAScript",
     "license": "Apache-2.0",
     "repository": {
@@ -16,15 +16,15 @@
     },
     "scripts": {
         "clean": "rm -rf ./dist/cjs/*",
-        "build": "../../node_modules/typescript/bin/tsc --project tsconfig.json --module commonjs --outDir ./dist/cjs"
+        "build": "../../node_modules/typescript/bin/tsc --project tsconfig.json --outDir ./dist/cjs"
     },
     "preferUnplugged": true,
     "dependencies": {
-        "@bufbuild/protobuf": "^1.8.0",
-        "@bufbuild/protoplugin": "1.8.0"
+        "@bufbuild/protobuf": "^1.10.0",
+        "@bufbuild/protoplugin": "1.10.0"
     },
     "peerDependencies": {
-        "@bufbuild/protobuf": "1.8.0"
+        "@bufbuild/protobuf": "1.10.0"
     },
     "peerDependenciesMeta": {
         "@bufbuild/protobuf": {

package/dist/cjs/src/declaration.js

@@ -37,7 +37,7 @@ exports.generateDts = generateDts;
 // prettier-ignore
 function generateEnum(schema, f, enumeration) {
     f.print(f.jsDoc(enumeration));
-    f.print("export declare enum ", 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();
@@ -52,8 +52,9 @@ function generateEnum(schema, f, enumeration) {
 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("export declare class ", message, " extends ", Message, "<", message, "> {");
+    f.print(f.exportDecl("declare class", m), " extends ", Message, "<", m, "> {");
     for (const member of message.members) {
         switch (member.kind) {
             case "oneof":
@@ -65,7 +66,7 @@ function generateMessage(schema, f, message) {
         }
         f.print();
     }
-    f.print("  constructor(data?: ", PartialMessage, "<", message, ">);");
+    f.print("  constructor(data?: ", PartialMessage, "<", m, ">);");
     f.print();
     generateWktMethods(schema, f, message);
     f.print("  static readonly runtime: typeof ", protoN, ";");
@@ -75,13 +76,13 @@ function generateMessage(schema, f, message) {
     //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, ">): ", message, ";");
+    f.print("  static fromBinary(bytes: Uint8Array, options?: Partial<", BinaryReadOptions, ">): ", m, ";");
     f.print();
-    f.print("  static fromJson(jsonValue: ", JsonValue, ", options?: Partial<", JsonReadOptions, ">): ", message, ";");
+    f.print("  static fromJson(jsonValue: ", JsonValue, ", options?: Partial<", JsonReadOptions, ">): ", m, ";");
     f.print();
-    f.print("  static fromJsonString(jsonString: string, options?: Partial<", JsonReadOptions, ">): ", message, ";");
+    f.print("  static fromJsonString(jsonString: string, options?: Partial<", JsonReadOptions, ">): ", m, ";");
     f.print();
-    f.print("  static equals(a: ", message, " | ", PlainMessage, "<", message, "> | undefined, b: ", message, " | ", PlainMessage, "<", message, "> | undefined): boolean;");
+    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) {
@@ -125,8 +126,9 @@ function generateField(schema, f, field) {
 // 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", ext), ": ", schema.runtime.Extension, "<", ext.extendee, ", ", typing, ">;");
+    f.print(f.exportDecl("declare const", (0, ecmascript_1.localName)(ext)), ": ", schema.runtime.Extension, "<", e, ", ", typing, ">;");
     f.print();
 }
 // prettier-ignore

package/dist/cjs/src/javascript.js

@@ -43,15 +43,12 @@ function generateEnum(schema, f, enumeration) {
     f.print(f.exportDecl("const", enumeration), " = /*@__PURE__*/ ", protoN, ".makeEnum(");
     f.print(`  "`, enumeration.typeName, `",`);
     f.print(`  [`);
-    if (enumeration.sharedPrefix === undefined) {
-        for (const value of enumeration.values) {
+    for (const value of enumeration.values) {
+        if ((0, ecmascript_1.localName)(value) === value.name) {
             f.print("    {no: ", value.number, ", name: ", f.string(value.name), "},");
         }
-    }
-    else {
-        for (const value of enumeration.values) {
-            const localName = value.name.substring(enumeration.sharedPrefix.length);
-            f.print("    {no: ", value.number, ", name: ", f.string(value.name), ", localName: ", f.string(localName), "},");
+        else {
+            f.print("    {no: ", value.number, ", name: ", f.string(value.name), ", localName: ", f.string((0, ecmascript_1.localName)(value)), "},");
         }
     }
     f.print(`  ],`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bufbuild/protoc-gen-es",
-  "version": "1.8.0",
+  "version": "1.10.0",
   "description": "Protocol Buffers code generator for ECMAScript",
   "license": "Apache-2.0",
   "repository": {
@@ -16,15 +16,15 @@
   },
   "scripts": {
     "clean": "rm -rf ./dist/cjs/*",
-    "build": "../../node_modules/typescript/bin/tsc --project tsconfig.json --module commonjs --outDir ./dist/cjs"
+    "build": "../../node_modules/typescript/bin/tsc --project tsconfig.json --outDir ./dist/cjs"
   },
   "preferUnplugged": true,
   "dependencies": {
-    "@bufbuild/protobuf": "^1.8.0",
-    "@bufbuild/protoplugin": "1.8.0"
+    "@bufbuild/protobuf": "^1.10.0",
+    "@bufbuild/protoplugin": "1.10.0"
   },
   "peerDependencies": {
-    "@bufbuild/protobuf": "1.8.0"
+    "@bufbuild/protobuf": "1.10.0"
   },
   "peerDependenciesMeta": {
     "@bufbuild/protobuf": {

package/src/declaration.ts

@@ -1,248 +0,0 @@
-// 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.
-
-import type {
-  DescEnum,
-  DescField,
-  DescMessage,
-  DescOneof,
-} from "@bufbuild/protobuf";
-import { DescExtension } from "@bufbuild/protobuf";
-import type {
-  GeneratedFile,
-  Printable,
-  Schema,
-} from "@bufbuild/protoplugin/ecmascript";
-import { localName, reifyWkt } from "@bufbuild/protoplugin/ecmascript";
-import { getNonEditionRuntime } from "./editions.js";
-import { getFieldTypeInfo } from "./util.js";
-
-export function generateDts(schema: 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
-  }
-}
-
-// prettier-ignore
-function generateEnum(schema: Schema, f: GeneratedFile, enumeration: DescEnum) {
-  f.print(f.jsDoc(enumeration));
-  f.print("export declare enum ", enumeration, " {");
-  for (const value of enumeration.values) {
-    if (enumeration.values.indexOf(value) > 0) {
-      f.print();
-    }
-    f.print(f.jsDoc(value, "  "));
-    f.print("  ", localName(value), " = ", value.number, ",");
-  }
-  f.print("}");
-  f.print();
-}
-
-// prettier-ignore
-function generateMessage(schema: Schema, f: GeneratedFile, message: DescMessage) {
-  const protoN = getNonEditionRuntime(schema, message.file);
-  const {
-    PartialMessage,
-    FieldList,
-    Message,
-    PlainMessage,
-    BinaryReadOptions,
-    JsonReadOptions,
-    JsonValue
-  } = schema.runtime;
-  f.print(f.jsDoc(message));
-  f.print("export declare class ", message, " extends ", Message, "<", message, "> {");
-  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, "<", message, ">);");
-  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, ">): ", message, ";")
-  f.print()
-  f.print("  static fromJson(jsonValue: ", JsonValue, ", options?: Partial<", JsonReadOptions, ">): ", message, ";")
-  f.print()
-  f.print("  static fromJsonString(jsonString: string, options?: Partial<", JsonReadOptions, ">): ", message, ";")
-  f.print()
-  f.print("  static equals(a: ", message, " | ", PlainMessage, "<", message, "> | undefined, b: ", message, " | ", PlainMessage, "<", message, "> | 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: Schema, f: GeneratedFile, oneof: DescOneof) {
-  f.print(f.jsDoc(oneof, "  "));
-  f.print("  ", localName(oneof), ": {");
-  for (const field of oneof.fields) {
-    if (oneof.fields.indexOf(field) > 0) {
-      f.print(`  } | {`);
-    }
-    f.print(f.jsDoc(field, "    "));
-    const { typing } = getFieldTypeInfo(field);
-    f.print(`    value: `, typing, `;`);
-    f.print(`    case: "`, localName(field), `";`);
-  }
-  f.print(`  } | { case: undefined; value?: undefined };`);
-}
-
-// prettier-ignore
-function generateField(schema: Schema, f: GeneratedFile, field: DescField) {
-    f.print(f.jsDoc(field, "  "));
-    const e: Printable = [];
-    const { typing, optional } = getFieldTypeInfo(field);
-    if (!optional) {
-        e.push("  ", localName(field), ": ", typing, ";");
-    } else {
-        e.push("  ", localName(field), "?: ", typing, ";");
-    }
-    f.print(e);
-}
-
-// prettier-ignore
-function generateExtension(
-  schema: Schema,
-  f: GeneratedFile,
-  ext: DescExtension,
-) {
-  const { typing } = getFieldTypeInfo(ext);
-  f.print(f.jsDoc(ext));
-  f.print(f.exportDecl("declare const", ext), ": ", schema.runtime.Extension, "<", ext.extendee, ", ", typing, ">;");
-  f.print();
-}
-
-// prettier-ignore
-function generateWktMethods(schema: Schema, f: GeneratedFile, message: DescMessage) {
-  const ref = 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: Schema, f: GeneratedFile, message: DescMessage) {
-  const ref = 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} = 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/src/editions.ts

@@ -1,38 +0,0 @@
-// 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.
-
-import type { ImportSymbol, Schema } from "@bufbuild/protoplugin/ecmascript";
-import { DescFile } from "@bufbuild/protobuf";
-
-/**
- * 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.
- */
-export function getNonEditionRuntime(
-  schema: Schema,
-  file: DescFile,
-): ImportSymbol {
-  if (file.syntax === "editions") {
-    // TODO support editions
-    throw new Error(
-      `${file.proto.name ?? ""}: syntax "editions" is not supported yet`,
-    );
-  }
-  return schema.runtime[file.syntax];
-}