@bufbuild/protoc-gen-es 0.2.1 → 0.4.0

package/README.md

@@ -121,14 +121,29 @@ Multiple values can be given by separating them with `+`, for example
 `target=js+dts`.
 
 By default, we generate JavaScript and TypeScript declaration files, which
-produces the smallest code size. If you prefer to generate TypeScript, use
-`target=ts`.
+produces the smallest code size and is the most compatible with various 
+bundler configurations. If you prefer to generate TypeScript, use `target=ts`.
+
+### `import_extension=.js`
+
+By default, [protoc-gen-es](https://www.npmjs.com/package/@bufbuild/protoc-gen-es)
+(and all other plugins based on [@bufbuild/protoplugin](https://www.npmjs.com/package/@bufbuild/protoplugin))
+uses a `.js` file extensions in import paths, even in TypeScript files.
+
+This is unintuitive, but necessary for [ECMAScript modules in Node.js](https://www.typescriptlang.org/docs/handbook/esm-node.html).
+Unfortunately, not all bundlers and tools have caught up yet, and Deno 
+requires `.ts`. With this plugin option, you can replace `.js` extensions 
+in import paths with the given value. For example, set
+
+- `import_extension=none` to remove the `.js` extension
+- `import_extension=.ts` to replace the `.js` extension with `.ts`
+
 
 ### `keep_empty_files=true`
 
-By default, [protoc-gen-es](https://www.npmjs.com/package/@bufbuild/protoc-gen-es) 
-(and all other plugins based on [@bufbuild/protoplugin](https://www.npmjs.com/package/@bufbuild/protoplugin)) 
-omit empty files from the plugin output. This option disables pruning of 
-empty files, to allow for smooth interoperation with Bazel and similar 
+By default, [protoc-gen-es](https://www.npmjs.com/package/@bufbuild/protoc-gen-es)
+(and all other plugins based on [@bufbuild/protoplugin](https://www.npmjs.com/package/@bufbuild/protoplugin))
+omit empty files from the plugin output. This option disables pruning of
+empty files, to allow for smooth interoperation with Bazel and similar
 tooling that requires all output files to be declared ahead of time.
 Unless you use Bazel, it is very unlikely that you need this option.

package/dist/cjs/package.json

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

package/dist/cjs/src/declaration.js

@@ -122,14 +122,16 @@ function generateWktMethods(schema, f, message) {
     if (ref === undefined) {
         return;
     }
-    const { Message, MessageType, } = schema.runtime;
+    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("  is(type: ", MessageType, "): boolean;");
+            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();
@@ -185,7 +187,7 @@ function generateWktStaticMethods(schema, f, message) {
         case "google.protobuf.BytesValue": {
             const { typing } = (0, ecmascript_1.getFieldTyping)(ref.value, f);
             f.print("  static readonly fieldWrapper: {");
-            f.print("    wrapField(value: ", typing, " | ", message, "): ", message, ",");
+            f.print("    wrapField(value: ", typing, "): ", message, ",");
             f.print("    unwrapField(value: ", message, "): ", typing, ",");
             f.print("  };");
             f.print();

package/dist/cjs/src/javascript.js

@@ -213,8 +213,29 @@ function generateWktMethods(schema, f, message) {
             f.print("  return true;");
             f.print("};");
             f.print();
+            f.print(message, ".prototype.unpack = function unpack(registry) {");
+            f.print("    if (this.", (0, ecmascript_1.localName)(ref.typeUrl), ` === "") {`);
+            f.print("      return undefined;");
+            f.print("    }");
+            f.print("    const messageType = registry.findMessage(this.typeUrlToName(this.", (0, ecmascript_1.localName)(ref.typeUrl), "));");
+            f.print("    if (!messageType) {");
+            f.print("      return undefined;");
+            f.print("    }");
+            f.print("    return messageType.fromBinary(this.", (0, ecmascript_1.localName)(ref.value), ");");
+            f.print("  }");
+            f.print();
             f.print(message, ".prototype.is = function is(type) {");
-            f.print("  return this.", (0, ecmascript_1.localName)(ref.typeUrl), " === this.typeNameToUrl(type.typeName);");
+            f.print("  if (this.typeUrl === '') {");
+            f.print("    return false;");
+            f.print("  }");
+            f.print("  const name = this.typeUrlToName(this.", (0, ecmascript_1.localName)(ref.typeUrl), ");");
+            f.print("  let typeName = '';");
+            f.print("  if (typeof type === 'string') {");
+            f.print("      typeName = type;");
+            f.print("  } else {");
+            f.print("      typeName = type.typeName;");
+            f.print("  }");
+            f.print("  return name === typeName;");
             f.print("};");
             f.print();
             f.print(message, ".prototype.typeNameToUrl = function typeNameToUrl(name) {");
@@ -541,7 +562,7 @@ function generateWktStaticMethods(schema, f, message) {
         case "google.protobuf.BytesValue": {
             f.print(message, ".fieldWrapper = {");
             f.print("  wrapField(value) {");
-            f.print("    return value instanceof ", message, " ? value : new ", message, "({value});");
+            f.print("    return new ", message, "({value});");
             f.print("  },");
             f.print("  unwrapField(value) {");
             f.print("    return value.", (0, ecmascript_1.localName)(ref.value), ";");

package/dist/cjs/src/typescript.js

@@ -152,7 +152,7 @@ function generateWktMethods(schema, f, message) {
     if (ref === undefined) {
         return;
     }
-    const { Message, JsonValue, JsonReadOptions, JsonWriteOptions, JsonObject, MessageType, ScalarType: rtScalarType, protoInt64, } = schema.runtime;
+    const { Message, JsonValue, JsonReadOptions, JsonWriteOptions, JsonObject, MessageType, IMessageTypeRegistry, ScalarType: rtScalarType, protoInt64, } = schema.runtime;
     const protoN = schema.runtime[message.file.syntax];
     switch (ref.typeName) {
         case "google.protobuf.Any":
@@ -214,8 +214,29 @@ function generateWktMethods(schema, f, message) {
             f.print("    return true;");
             f.print("  }");
             f.print();
-            f.print("  is(type: ", MessageType, "): boolean {");
-            f.print("    return this.", (0, ecmascript_1.localName)(ref.typeUrl), " === this.typeNameToUrl(type.typeName);");
+            f.print("  unpack(registry: ", IMessageTypeRegistry, "): ", Message, " | undefined {");
+            f.print("    if (this.", (0, ecmascript_1.localName)(ref.typeUrl), ` === "") {`);
+            f.print("      return undefined;");
+            f.print("    }");
+            f.print("    const messageType = registry.findMessage(this.typeUrlToName(this.", (0, ecmascript_1.localName)(ref.typeUrl), "));");
+            f.print("    if (!messageType) {");
+            f.print("      return undefined;");
+            f.print("    }");
+            f.print("    return messageType.fromBinary(this.", (0, ecmascript_1.localName)(ref.value), ");");
+            f.print("  }");
+            f.print();
+            f.print("  is(type: ", MessageType, " | string): boolean {");
+            f.print("    if (this.typeUrl === '') {");
+            f.print("      return false;");
+            f.print("    }");
+            f.print("    const name = this.typeUrlToName(this.", (0, ecmascript_1.localName)(ref.typeUrl), ");");
+            f.print("    let typeName = '';");
+            f.print("    if (typeof type === 'string') {");
+            f.print("        typeName = type;");
+            f.print("    } else {");
+            f.print("        typeName = type.typeName;");
+            f.print("    }");
+            f.print("    return name === typeName;");
             f.print("  }");
             f.print();
             f.print("  private typeNameToUrl(name: string): string {");
@@ -542,8 +563,8 @@ function generateWktStaticMethods(schema, f, message) {
         case "google.protobuf.BytesValue": {
             const { typing } = (0, ecmascript_1.getFieldTyping)(ref.value, f);
             f.print("  static readonly fieldWrapper = {");
-            f.print("    wrapField(value: ", typing, " | ", message, "): ", message, " {");
-            f.print("      return value instanceof ", message, " ? value : new ", message, "({value});");
+            f.print("    wrapField(value: ", typing, "): ", message, " {");
+            f.print("      return new ", message, "({value});");
             f.print("    },");
             f.print("    unwrapField(value: ", message, "): ", typing, " {");
             f.print("      return value.", (0, ecmascript_1.localName)(ref.value), ";");

package/package.json

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

package/src/declaration.ts

@@ -152,6 +152,7 @@ function generateWktMethods(schema: Schema, f: GeneratedFile, message: DescMessa
   const {
     Message,
     MessageType,
+    IMessageTypeRegistry
   } = schema.runtime;
   switch (ref.typeName) {
     case "google.protobuf.Any":
@@ -159,7 +160,9 @@ function generateWktMethods(schema: Schema, f: GeneratedFile, message: DescMessa
       f.print();
       f.print("  unpackTo(target: ", Message, "): boolean;");
       f.print();
-      f.print("  is(type: ", MessageType, "): boolean;");
+      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();
@@ -216,7 +219,7 @@ function generateWktStaticMethods(schema: Schema, f: GeneratedFile, message: Des
     case "google.protobuf.BytesValue": {
       const {typing} = getFieldTyping(ref.value, f);
       f.print("  static readonly fieldWrapper: {")
-      f.print("    wrapField(value: ", typing, " | ", message, "): ", message, ",")
+      f.print("    wrapField(value: ", typing, "): ", message, ",")
       f.print("    unwrapField(value: ", message, "): ", typing, ",")
       f.print("  };")
       f.print()

package/src/javascript.ts

@@ -226,8 +226,29 @@ function generateWktMethods(schema: Schema, f: GeneratedFile, message: DescMessa
       f.print("  return true;");
       f.print("};");
       f.print();
+      f.print(message, ".prototype.unpack = function unpack(registry) {")
+      f.print("    if (this.", localName(ref.typeUrl), ` === "") {`);
+      f.print("      return undefined;");
+      f.print("    }");
+      f.print("    const messageType = registry.findMessage(this.typeUrlToName(this.", localName(ref.typeUrl), "));");
+      f.print("    if (!messageType) {");
+      f.print("      return undefined;");
+      f.print("    }");
+      f.print("    return messageType.fromBinary(this.", localName(ref.value), ");");
+      f.print("  }");
+      f.print();
       f.print(message, ".prototype.is = function is(type) {")
-      f.print("  return this.", localName(ref.typeUrl), " === this.typeNameToUrl(type.typeName);");
+      f.print("  if (this.typeUrl === '') {");
+      f.print("    return false;");
+      f.print("  }");
+      f.print("  const name = this.typeUrlToName(this.", localName(ref.typeUrl), ");");
+      f.print("  let typeName = '';");
+      f.print("  if (typeof type === 'string') {");
+      f.print("      typeName = type;");
+      f.print("  } else {");
+      f.print("      typeName = type.typeName;");
+      f.print("  }");
+      f.print("  return name === typeName;");
       f.print("};");
       f.print();
       f.print(message, ".prototype.typeNameToUrl = function typeNameToUrl(name) {")
@@ -557,7 +578,7 @@ function generateWktStaticMethods(schema: Schema, f: GeneratedFile, message: Des
     case "google.protobuf.BytesValue": {
       f.print(message, ".fieldWrapper = {")
       f.print("  wrapField(value) {")
-      f.print("    return value instanceof ", message, " ? value : new ", message, "({value});")
+      f.print("    return new ", message, "({value});")
       f.print("  },")
       f.print("  unwrapField(value) {")
       f.print("    return value.", localName(ref.value), ";")

package/src/typescript.ts

@@ -186,6 +186,7 @@ function generateWktMethods(schema: Schema, f: GeneratedFile, message: DescMessa
     JsonWriteOptions,
     JsonObject,
     MessageType,
+    IMessageTypeRegistry,
     ScalarType: rtScalarType,
     protoInt64,
   } = schema.runtime;
@@ -250,8 +251,29 @@ function generateWktMethods(schema: Schema, f: GeneratedFile, message: DescMessa
       f.print("    return true;");
       f.print("  }");
       f.print();
-      f.print("  is(type: ", MessageType, "): boolean {");
-      f.print("    return this.", localName(ref.typeUrl), " === this.typeNameToUrl(type.typeName);");
+      f.print("  unpack(registry: ", IMessageTypeRegistry, "): ", Message, " | undefined {");
+      f.print("    if (this.", localName(ref.typeUrl), ` === "") {`);
+      f.print("      return undefined;");
+      f.print("    }");
+      f.print("    const messageType = registry.findMessage(this.typeUrlToName(this.", localName(ref.typeUrl), "));");
+      f.print("    if (!messageType) {");
+      f.print("      return undefined;");
+      f.print("    }");
+      f.print("    return messageType.fromBinary(this.", localName(ref.value), ");");
+      f.print("  }");
+      f.print();
+      f.print("  is(type: ", MessageType, " | string): boolean {");
+      f.print("    if (this.typeUrl === '') {");
+      f.print("      return false;");
+      f.print("    }");
+      f.print("    const name = this.typeUrlToName(this.", localName(ref.typeUrl), ");");
+      f.print("    let typeName = '';");
+      f.print("    if (typeof type === 'string') {");
+      f.print("        typeName = type;");
+      f.print("    } else {");
+      f.print("        typeName = type.typeName;");
+      f.print("    }");
+      f.print("    return name === typeName;");
       f.print("  }");
       f.print();
       f.print("  private typeNameToUrl(name: string): string {");
@@ -581,8 +603,8 @@ function generateWktStaticMethods(schema: Schema, f: GeneratedFile, message: Des
     case "google.protobuf.BytesValue": {
       const {typing} = getFieldTyping(ref.value, f);
       f.print("  static readonly fieldWrapper = {")
-      f.print("    wrapField(value: ", typing, " | ", message, "): ", message, " {")
-      f.print("      return value instanceof ", message, " ? value : new ", message, "({value});")
+      f.print("    wrapField(value: ", typing, "): ", message, " {")
+      f.print("      return new ", message, "({value});")
       f.print("    },")
       f.print("    unwrapField(value: ", message, "): ", typing, " {")
       f.print("      return value.", localName(ref.value), ";")