@bufbuild/protoc-gen-es 1.4.1 → 1.5.0

package/dist/cjs/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@bufbuild/protoc-gen-es",
-    "version": "1.4.1",
+    "version": "1.5.0",
     "description": "Protocol Buffers code generator for ECMAScript",
     "license": "Apache-2.0",
     "repository": {
@@ -20,10 +20,11 @@
     },
     "preferUnplugged": true,
     "dependencies": {
-        "@bufbuild/protoplugin": "1.4.1"
+        "@bufbuild/protobuf": "^1.5.0",
+        "@bufbuild/protoplugin": "1.5.0"
     },
     "peerDependencies": {
-        "@bufbuild/protobuf": "1.4.1"
+        "@bufbuild/protobuf": "1.5.0"
     },
     "peerDependenciesMeta": {
         "@bufbuild/protobuf": {

package/dist/cjs/src/declaration.js

@@ -15,6 +15,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateDts = void 0;
 const ecmascript_1 = require("@bufbuild/protoplugin/ecmascript");
+const editions_js_1 = require("./editions.js");
 function generateDts(schema) {
     for (const file of schema.files) {
         const f = schema.generateFile(file.name + "_pb.d.ts");
@@ -45,7 +46,7 @@ function generateEnum(schema, f, enumeration) {
 }
 // prettier-ignore
 function generateMessage(schema, f, message) {
-    const protoN = schema.runtime[message.file.syntax];
+    const protoN = (0, editions_js_1.getNonEditionRuntime)(schema, message.file);
     const { PartialMessage, FieldList, Message, PlainMessage, BinaryReadOptions, JsonReadOptions, JsonValue } = schema.runtime;
     f.print((0, ecmascript_1.makeJsDoc)(message));
     f.print("export declare class ", message, " extends ", Message, "<", message, "> {");

package/dist/cjs/src/editions.js

@@ -0,0 +1,34 @@
+"use strict";
+// Copyright 2021-2023 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;

package/dist/cjs/src/javascript.js

@@ -16,6 +16,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateFieldInfo = exports.generateJs = void 0;
 const protobuf_1 = require("@bufbuild/protobuf");
 const ecmascript_1 = require("@bufbuild/protoplugin/ecmascript");
+const editions_js_1 = require("./editions.js");
 function generateJs(schema) {
     for (const file of schema.files) {
         const f = schema.generateFile(file.name + "_pb.js");
@@ -32,7 +33,7 @@ function generateJs(schema) {
 exports.generateJs = generateJs;
 // prettier-ignore
 function generateEnum(schema, f, enumeration) {
-    const protoN = schema.runtime[enumeration.file.syntax];
+    const protoN = (0, editions_js_1.getNonEditionRuntime)(schema, enumeration.file);
     f.print((0, ecmascript_1.makeJsDoc)(enumeration));
     f.print("export const ", enumeration, " = ", protoN, ".makeEnum(");
     f.print(`  "`, enumeration.typeName, `",`);
@@ -54,7 +55,7 @@ function generateEnum(schema, f, enumeration) {
 }
 // prettier-ignore
 function generateMessage(schema, f, message) {
-    const protoN = schema.runtime[message.file.syntax];
+    const protoN = (0, editions_js_1.getNonEditionRuntime)(schema, message.file);
     f.print((0, ecmascript_1.makeJsDoc)(message));
     f.print("export const ", message, " = ", protoN, ".makeMessageType(");
     f.print(`  `, (0, ecmascript_1.literalString)(message.typeName), `,`);
@@ -89,7 +90,7 @@ function generateMessage(schema, f, message) {
 }
 // prettier-ignore
 function generateFieldInfo(schema, f, field) {
-    const protoN = schema.runtime[field.parent.file.syntax];
+    const protoN = (0, editions_js_1.getNonEditionRuntime)(schema, field.parent.file);
     const e = [];
     e.push("    { no: ", field.number, `, name: "`, field.name, `", `);
     if (field.jsonName !== undefined) {
@@ -155,7 +156,7 @@ function generateWktMethods(schema, f, message) {
         return;
     }
     const { ScalarType: rtScalarType, protoInt64, } = schema.runtime;
-    const protoN = schema.runtime[message.file.syntax];
+    const protoN = (0, editions_js_1.getNonEditionRuntime)(schema, message.file);
     switch (ref.typeName) {
         case "google.protobuf.Any":
             f.print(message, ".prototype.toJson = function toJson(options) {");
@@ -250,7 +251,7 @@ function generateWktMethods(schema, f, message) {
             f.print("    throw new Error(`invalid type url: ${url}`);");
             f.print("  }");
             f.print(`  const slash = url.lastIndexOf("/");`);
-            f.print("  const name = slash > 0 ? url.substring(slash + 1) : url;");
+            f.print("  const name = slash >= 0 ? url.substring(slash + 1) : url;");
             f.print("  if (!name.length) {");
             f.print("    throw new Error(`invalid type url: ${url}`);");
             f.print("  }");

package/dist/cjs/src/typescript.js

@@ -17,6 +17,7 @@ exports.generateTs = void 0;
 const protobuf_1 = require("@bufbuild/protobuf");
 const ecmascript_1 = require("@bufbuild/protoplugin/ecmascript");
 const javascript_js_1 = require("./javascript.js");
+const editions_js_1 = require("./editions.js");
 function generateTs(schema) {
     for (const file of schema.files) {
         const f = schema.generateFile(file.name + "_pb.ts");
@@ -33,7 +34,7 @@ function generateTs(schema) {
 exports.generateTs = generateTs;
 // prettier-ignore
 function generateEnum(schema, f, enumeration) {
-    const protoN = schema.runtime[enumeration.file.syntax];
+    const protoN = (0, editions_js_1.getNonEditionRuntime)(schema, enumeration.file);
     f.print((0, ecmascript_1.makeJsDoc)(enumeration));
     f.print("export enum ", enumeration, " {");
     for (const value of enumeration.values) {
@@ -54,7 +55,7 @@ function generateEnum(schema, f, enumeration) {
 }
 // prettier-ignore
 function generateMessage(schema, f, message) {
-    const protoN = schema.runtime[message.file.syntax];
+    const protoN = (0, editions_js_1.getNonEditionRuntime)(schema, message.file);
     const { PartialMessage, FieldList, Message, PlainMessage, BinaryReadOptions, JsonReadOptions, JsonValue } = schema.runtime;
     f.print((0, ecmascript_1.makeJsDoc)(message));
     f.print("export class ", message, " extends ", Message, "<", message, "> {");
@@ -152,7 +153,7 @@ function generateWktMethods(schema, f, message) {
         return;
     }
     const { Message, JsonValue, JsonReadOptions, JsonWriteOptions, JsonObject, MessageType, IMessageTypeRegistry, ScalarType: rtScalarType, LongType: rtLongType, protoInt64, } = schema.runtime;
-    const protoN = schema.runtime[message.file.syntax];
+    const protoN = (0, editions_js_1.getNonEditionRuntime)(schema, message.file);
     switch (ref.typeName) {
         case "google.protobuf.Any":
             f.print("  override toJson(options?: Partial<", JsonWriteOptions, ">): ", JsonValue, " {");
@@ -247,7 +248,7 @@ function generateWktMethods(schema, f, message) {
             f.print("      throw new Error(`invalid type url: ${url}`);");
             f.print("    }");
             f.print(`    const slash = url.lastIndexOf("/");`);
-            f.print("    const name = slash > 0 ? url.substring(slash + 1) : url;");
+            f.print("    const name = slash >= 0 ? url.substring(slash + 1) : url;");
             f.print("    if (!name.length) {");
             f.print("      throw new Error(`invalid type url: ${url}`);");
             f.print("    }");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bufbuild/protoc-gen-es",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "Protocol Buffers code generator for ECMAScript",
   "license": "Apache-2.0",
   "repository": {
@@ -20,10 +20,11 @@
   },
   "preferUnplugged": true,
   "dependencies": {
-    "@bufbuild/protoplugin": "1.4.1"
+    "@bufbuild/protobuf": "^1.5.0",
+    "@bufbuild/protoplugin": "1.5.0"
   },
   "peerDependencies": {
-    "@bufbuild/protobuf": "1.4.1"
+    "@bufbuild/protobuf": "1.5.0"
   },
   "peerDependenciesMeta": {
     "@bufbuild/protobuf": {

package/src/declaration.ts

@@ -30,6 +30,7 @@ import {
   makeJsDoc,
   reifyWkt,
 } from "@bufbuild/protoplugin/ecmascript";
+import { getNonEditionRuntime } from "./editions.js";
 
 export function generateDts(schema: Schema) {
   for (const file of schema.files) {
@@ -62,7 +63,7 @@ function generateEnum(schema: Schema, f: GeneratedFile, enumeration: DescEnum) {
 
 // prettier-ignore
 function generateMessage(schema: Schema, f: GeneratedFile, message: DescMessage) {
-  const protoN = schema.runtime[message.file.syntax];
+  const protoN = getNonEditionRuntime(schema, message.file);
   const {
     PartialMessage,
     FieldList,

package/src/editions.ts

@@ -0,0 +1,38 @@
+// Copyright 2021-2023 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];
+}

package/src/javascript.ts

@@ -26,6 +26,7 @@ import {
   makeJsDoc,
   reifyWkt,
 } from "@bufbuild/protoplugin/ecmascript";
+import { getNonEditionRuntime } from "./editions.js";
 
 export function generateJs(schema: Schema) {
   for (const file of schema.files) {
@@ -43,7 +44,7 @@ export function generateJs(schema: Schema) {
 
 // prettier-ignore
 function generateEnum(schema: Schema, f: GeneratedFile, enumeration: DescEnum) {
-  const protoN = schema.runtime[enumeration.file.syntax];
+  const protoN = getNonEditionRuntime(schema, enumeration.file);
   f.print(makeJsDoc(enumeration));
   f.print("export const ", enumeration, " = ", protoN, ".makeEnum(")
   f.print(`  "`, enumeration.typeName, `",`)
@@ -65,7 +66,7 @@ function generateEnum(schema: Schema, f: GeneratedFile, enumeration: DescEnum) {
 
 // prettier-ignore
 function generateMessage(schema: Schema, f: GeneratedFile, message: DescMessage) {
-  const protoN = schema.runtime[message.file.syntax];
+  const protoN = getNonEditionRuntime(schema, message.file);
   f.print(makeJsDoc(message));
   f.print("export const ", message, " = ", protoN, ".makeMessageType(")
   f.print(`  `, literalString(message.typeName), `,`)
@@ -100,7 +101,7 @@ function generateMessage(schema: Schema, f: GeneratedFile, message: DescMessage)
 
 // prettier-ignore
 export function generateFieldInfo(schema: Schema, f: GeneratedFile, field: DescField) {
-  const protoN = schema.runtime[field.parent.file.syntax];
+  const protoN = getNonEditionRuntime(schema, field.parent.file);
   const e: Printable = [];
   e.push("    { no: ", field.number, `, name: "`, field.name, `", `);
   if (field.jsonName !== undefined) {
@@ -168,7 +169,7 @@ function generateWktMethods(schema: Schema, f: GeneratedFile, message: DescMessa
     ScalarType: rtScalarType,
     protoInt64,
   } = schema.runtime;
-  const protoN = schema.runtime[message.file.syntax];
+  const protoN = getNonEditionRuntime(schema, message.file);
   switch (ref.typeName) {
     case "google.protobuf.Any":
       f.print(message, ".prototype.toJson = function toJson(options) {")
@@ -263,7 +264,7 @@ function generateWktMethods(schema: Schema, f: GeneratedFile, message: DescMessa
       f.print("    throw new Error(`invalid type url: ${url}`);");
       f.print("  }");
       f.print(`  const slash = url.lastIndexOf("/");`);
-      f.print("  const name = slash > 0 ? url.substring(slash + 1) : url;");
+      f.print("  const name = slash >= 0 ? url.substring(slash + 1) : url;");
       f.print("  if (!name.length) {");
       f.print("    throw new Error(`invalid type url: ${url}`);");
       f.print("  }");

package/src/typescript.ts

@@ -33,6 +33,7 @@ import {
   reifyWkt,
 } from "@bufbuild/protoplugin/ecmascript";
 import { generateFieldInfo } from "./javascript.js";
+import { getNonEditionRuntime } from "./editions.js";
 
 export function generateTs(schema: Schema) {
   for (const file of schema.files) {
@@ -50,7 +51,7 @@ export function generateTs(schema: Schema) {
 
 // prettier-ignore
 function generateEnum(schema: Schema, f: GeneratedFile, enumeration: DescEnum) {
-  const protoN = schema.runtime[enumeration.file.syntax];
+  const protoN = getNonEditionRuntime(schema, enumeration.file);
   f.print(makeJsDoc(enumeration));
   f.print("export enum ", enumeration, " {");
   for (const value of enumeration.values) {
@@ -72,7 +73,7 @@ function generateEnum(schema: Schema, f: GeneratedFile, enumeration: DescEnum) {
 
 // prettier-ignore
 function generateMessage(schema: Schema, f: GeneratedFile, message: DescMessage) {
-  const protoN = schema.runtime[message.file.syntax];
+  const protoN = getNonEditionRuntime(schema, message.file);
   const {
     PartialMessage,
     FieldList,
@@ -191,7 +192,7 @@ function generateWktMethods(schema: Schema, f: GeneratedFile, message: DescMessa
     LongType: rtLongType,
     protoInt64,
   } = schema.runtime;
-  const protoN = schema.runtime[message.file.syntax];
+  const protoN = getNonEditionRuntime(schema, message.file);
   switch (ref.typeName) {
     case "google.protobuf.Any":
       f.print("  override toJson(options?: Partial<", JsonWriteOptions, ">): ", JsonValue, " {");
@@ -286,7 +287,7 @@ function generateWktMethods(schema: Schema, f: GeneratedFile, message: DescMessa
       f.print("      throw new Error(`invalid type url: ${url}`);");
       f.print("    }");
       f.print(`    const slash = url.lastIndexOf("/");`);
-      f.print("    const name = slash > 0 ? url.substring(slash + 1) : url;");
+      f.print("    const name = slash >= 0 ? url.substring(slash + 1) : url;");
       f.print("    if (!name.length) {");
       f.print("      throw new Error(`invalid type url: ${url}`);");
       f.print("    }");