fix: Use a module star import for protobuf types. (#540)

stephenh · Mar 25, 2022 · f5b7700 · f5b7700
1 parent a810b38
commit f5b7700
Show file tree

Hide file tree

Showing 123 changed files with 5,209 additions and 1,775 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -35,6 +35,14 @@ jobs:
         run: yarn test
         env:
           CI: true
+      - name: test esmodule interop
+        working-directory: ./integration/simple-esmodule-interop
+        run: |
+          yarn install
+          yarn tsc
+          yarn jest
+        env:
+          CI: true
 
   release:
     if: github.event_name == 'push' && github.ref == 'refs/heads/main'

diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,5 @@
-/node_modules/
-/build/
+node_modules/
+build/
 /.idea
 /.vscode
 /integration/*/pbjs.js

diff --git a/integration/angular/simple-message.ts b/integration/angular/simple-message.ts
@@ -1,6 +1,6 @@
 /* eslint-disable */
-import { util, configure, Writer, Reader } from 'protobufjs/minimal';
 import * as Long from 'long';
+import * as _m0 from 'protobufjs/minimal';
 
 export const protobufPackage = 'angular';
 
@@ -13,15 +13,15 @@ function createBaseSimpleMessage(): SimpleMessage {
 }
 
 export const SimpleMessage = {
-  encode(message: SimpleMessage, writer: Writer = Writer.create()): Writer {
+  encode(message: SimpleMessage, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
     if (message.numberField !== 0) {
       writer.uint32(8).int32(message.numberField);
     }
     return writer;
   },
 
-  decode(input: Reader | Uint8Array, length?: number): SimpleMessage {
-    const reader = input instanceof Reader ? input : new Reader(input);
+  decode(input: _m0.Reader | Uint8Array, length?: number): SimpleMessage {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
     let end = length === undefined ? reader.len : reader.pos + length;
     const message = createBaseSimpleMessage();
     while (reader.pos < end) {
@@ -76,9 +76,9 @@ export type Exact<P, I extends P> = P extends Builtin
 
 // If you get a compile-error about 'Constructor<Long> and ... have no overlap',
 // add '--ts_proto_opt=esModuleInterop=true' as a flag when calling 'protoc'.
-if (util.Long !== Long) {
-  util.Long = Long as any;
-  configure();
+if (_m0.util.Long !== Long) {
+  _m0.util.Long = Long as any;
+  _m0.configure();
 }
 
 function isSet(value: any): boolean {

diff --git a/integration/avoid-import-conflicts/simple.ts b/integration/avoid-import-conflicts/simple.ts
@@ -1,6 +1,6 @@
 /* eslint-disable */
-import { util, configure, Writer, Reader } from 'protobufjs/minimal';
 import * as Long from 'long';
+import * as _m0 from 'protobufjs/minimal';
 import {
   SimpleEnum as SimpleEnum1,
   Simple as Simple2,
@@ -63,7 +63,7 @@ function createBaseSimple(): Simple {
 }
 
 export const Simple = {
-  encode(message: Simple, writer: Writer = Writer.create()): Writer {
+  encode(message: Simple, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
     if (message.name !== '') {
       writer.uint32(10).string(message.name);
     }
@@ -73,8 +73,8 @@ export const Simple = {
     return writer;
   },
 
-  decode(input: Reader | Uint8Array, length?: number): Simple {
-    const reader = input instanceof Reader ? input : new Reader(input);
+  decode(input: _m0.Reader | Uint8Array, length?: number): Simple {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
     let end = length === undefined ? reader.len : reader.pos + length;
     const message = createBaseSimple();
     while (reader.pos < end) {
@@ -125,7 +125,7 @@ function createBaseSimpleEnums(): SimpleEnums {
 }
 
 export const SimpleEnums = {
-  encode(message: SimpleEnums, writer: Writer = Writer.create()): Writer {
+  encode(message: SimpleEnums, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
     if (message.localEnum !== 0) {
       writer.uint32(8).int32(message.localEnum);
     }
@@ -135,8 +135,8 @@ export const SimpleEnums = {
     return writer;
   },
 
-  decode(input: Reader | Uint8Array, length?: number): SimpleEnums {
-    const reader = input instanceof Reader ? input : new Reader(input);
+  decode(input: _m0.Reader | Uint8Array, length?: number): SimpleEnums {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
     let end = length === undefined ? reader.len : reader.pos + length;
     const message = createBaseSimpleEnums();
     while (reader.pos < end) {
@@ -197,9 +197,9 @@ export type Exact<P, I extends P> = P extends Builtin
 
 // If you get a compile-error about 'Constructor<Long> and ... have no overlap',
 // add '--ts_proto_opt=esModuleInterop=true' as a flag when calling 'protoc'.
-if (util.Long !== Long) {
-  util.Long = Long as any;
-  configure();
+if (_m0.util.Long !== Long) {
+  _m0.util.Long = Long as any;
+  _m0.configure();
 }
 
 function isSet(value: any): boolean {

diff --git a/integration/avoid-import-conflicts/simple2.ts b/integration/avoid-import-conflicts/simple2.ts
@@ -1,6 +1,6 @@
 /* eslint-disable */
-import { util, configure, Writer, Reader } from 'protobufjs/minimal';
 import * as Long from 'long';
+import * as _m0 from 'protobufjs/minimal';
 
 export const protobufPackage = 'simple2';
 
@@ -52,7 +52,7 @@ function createBaseSimple(): Simple {
 }
 
 export const Simple = {
-  encode(message: Simple, writer: Writer = Writer.create()): Writer {
+  encode(message: Simple, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
     if (message.name !== '') {
       writer.uint32(10).string(message.name);
     }
@@ -62,8 +62,8 @@ export const Simple = {
     return writer;
   },
 
-  decode(input: Reader | Uint8Array, length?: number): Simple {
-    const reader = input instanceof Reader ? input : new Reader(input);
+  decode(input: _m0.Reader | Uint8Array, length?: number): Simple {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
     let end = length === undefined ? reader.len : reader.pos + length;
     const message = createBaseSimple();
     while (reader.pos < end) {
@@ -124,9 +124,9 @@ export type Exact<P, I extends P> = P extends Builtin
 
 // If you get a compile-error about 'Constructor<Long> and ... have no overlap',
 // add '--ts_proto_opt=esModuleInterop=true' as a flag when calling 'protoc'.
-if (util.Long !== Long) {
-  util.Long = Long as any;
-  configure();
+if (_m0.util.Long !== Long) {
+  _m0.util.Long = Long as any;
+  _m0.configure();
 }
 
 function isSet(value: any): boolean {

diff --git a/integration/barrel-imports/bar.ts b/integration/barrel-imports/bar.ts
@@ -1,6 +1,6 @@
 /* eslint-disable */
-import { util, configure, Writer, Reader } from 'protobufjs/minimal';
 import * as Long from 'long';
+import * as _m0 from 'protobufjs/minimal';
 
 export interface Bar {
   name: string;
@@ -12,7 +12,7 @@ function createBaseBar(): Bar {
 }
 
 export const Bar = {
-  encode(message: Bar, writer: Writer = Writer.create()): Writer {
+  encode(message: Bar, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
     if (message.name !== '') {
       writer.uint32(10).string(message.name);
     }
@@ -22,8 +22,8 @@ export const Bar = {
     return writer;
   },
 
-  decode(input: Reader | Uint8Array, length?: number): Bar {
-    const reader = input instanceof Reader ? input : new Reader(input);
+  decode(input: _m0.Reader | Uint8Array, length?: number): Bar {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
     let end = length === undefined ? reader.len : reader.pos + length;
     const message = createBaseBar();
     while (reader.pos < end) {
@@ -84,9 +84,9 @@ type Exact<P, I extends P> = P extends Builtin
 
 // If you get a compile-error about 'Constructor<Long> and ... have no overlap',
 // add '--ts_proto_opt=esModuleInterop=true' as a flag when calling 'protoc'.
-if (util.Long !== Long) {
-  util.Long = Long as any;
-  configure();
+if (_m0.util.Long !== Long) {
+  _m0.util.Long = Long as any;
+  _m0.configure();
 }
 
 function isSet(value: any): boolean {

diff --git a/integration/barrel-imports/foo.ts b/integration/barrel-imports/foo.ts
@@ -1,6 +1,6 @@
 /* eslint-disable */
-import { util, configure, Writer, Reader } from 'protobufjs/minimal';
 import * as Long from 'long';
+import * as _m0 from 'protobufjs/minimal';
 import { Bar } from './bar';
 
 export interface Foo {
@@ -13,7 +13,7 @@ function createBaseFoo(): Foo {
 }
 
 export const Foo = {
-  encode(message: Foo, writer: Writer = Writer.create()): Writer {
+  encode(message: Foo, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
     if (message.name !== '') {
       writer.uint32(10).string(message.name);
     }
@@ -23,8 +23,8 @@ export const Foo = {
     return writer;
   },
 
-  decode(input: Reader | Uint8Array, length?: number): Foo {
-    const reader = input instanceof Reader ? input : new Reader(input);
+  decode(input: _m0.Reader | Uint8Array, length?: number): Foo {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
     let end = length === undefined ? reader.len : reader.pos + length;
     const message = createBaseFoo();
     while (reader.pos < end) {
@@ -85,9 +85,9 @@ type Exact<P, I extends P> = P extends Builtin
 
 // If you get a compile-error about 'Constructor<Long> and ... have no overlap',
 // add '--ts_proto_opt=esModuleInterop=true' as a flag when calling 'protoc'.
-if (util.Long !== Long) {
-  util.Long = Long as any;
-  configure();
+if (_m0.util.Long !== Long) {
+  _m0.util.Long = Long as any;
+  _m0.configure();
 }
 
 function isSet(value: any): boolean {