Improve TS types to support isolatedModules and isolatedDeclarations

grpc/examples/ts/greeter/src/models.ts

@@ -2,5 +2,5 @@
 
 /* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any, @typescript-eslint/no-non-null-assertion */
 
-export { HelloReply } from './models/hello-reply.js';
-export { HelloRequest } from './models/hello-request.js';
+export {HelloReply} from './models/hello-reply.js';
+export {HelloRequest} from './models/hello-request.js';

grpc/examples/ts/greeter/src/models/hello-reply.ts

@@ -8,7 +8,7 @@ import * as flatbuffers from 'flatbuffers';
 
 export class HelloReply {
   bb: flatbuffers.ByteBuffer|null = null;
-  bb_pos = 0;
+  bb_pos: number = 0;
   __init(i:number, bb:flatbuffers.ByteBuffer):HelloReply {
   this.bb_pos = i;
   this.bb = bb;
@@ -31,11 +31,11 @@ message(optionalEncoding?:any):string|Uint8Array|null {
   return offset ? this.bb!.__string(this.bb_pos + offset, optionalEncoding) : null;
 }
 
-static startHelloReply(builder:flatbuffers.Builder) {
+static startHelloReply(builder:flatbuffers.Builder):void {
   builder.startObject(1);
 }
 
-static addMessage(builder:flatbuffers.Builder, messageOffset:flatbuffers.Offset) {
+static addMessage(builder:flatbuffers.Builder, messageOffset:flatbuffers.Offset):void {
   builder.addFieldOffset(0, messageOffset, 0);
 }
 

grpc/examples/ts/greeter/src/models/hello-request.ts

@@ -8,7 +8,7 @@ import * as flatbuffers from 'flatbuffers';
 
 export class HelloRequest {
   bb: flatbuffers.ByteBuffer|null = null;
-  bb_pos = 0;
+  bb_pos: number = 0;
   __init(i:number, bb:flatbuffers.ByteBuffer):HelloRequest {
   this.bb_pos = i;
   this.bb = bb;
@@ -31,11 +31,11 @@ name(optionalEncoding?:any):string|Uint8Array|null {
   return offset ? this.bb!.__string(this.bb_pos + offset, optionalEncoding) : null;
 }
 
-static startHelloRequest(builder:flatbuffers.Builder) {
+static startHelloRequest(builder:flatbuffers.Builder):void {
   builder.startObject(1);
 }
 
-static addName(builder:flatbuffers.Builder, nameOffset:flatbuffers.Offset) {
+static addName(builder:flatbuffers.Builder, nameOffset:flatbuffers.Offset):void {
   builder.addFieldOffset(0, nameOffset, 0);
 }
 

src/idl_gen_ts.cpp

@@ -296,11 +296,11 @@ class TsGenerator : public BaseGenerator {
         auto fully_qualified_type_name =
             it.second.ns->GetFullyQualifiedName(type_name);
         auto is_struct = parser_.structs_.Lookup(fully_qualified_type_name);
-        code += "export { " + type_name;
+        code += "export {" + type_name;
         if (parser_.opts.generate_object_based_api && is_struct) {
           code += ", " + type_name + parser_.opts.object_suffix;
         }
-        code += " } from '";
+        code += "} from '";
         std::string import_extension =
             parser_.opts.ts_no_import_ext ? "" : ".js";
         code += base_name_rel + import_extension + "';\n";
@@ -818,7 +818,7 @@ class TsGenerator : public BaseGenerator {
 
       code += "static finish" + (size_prefixed ? sizePrefixed : "") +
               GetPrefixedName(struct_def) + "Buffer";
-      code += "(builder:flatbuffers.Builder, offset:flatbuffers.Offset) {\n";
+      code += "(builder:flatbuffers.Builder, offset:flatbuffers.Offset):void {\n";
       code += "  builder.finish(offset";
       if (!parser_.file_identifier_.empty()) {
         code += ", '" + parser_.file_identifier_ + "'";
@@ -1040,7 +1040,7 @@ class TsGenerator : public BaseGenerator {
     std::string import_extension = parser_.opts.ts_no_import_ext ? "" : ".js";
     import.import_statement = "import { " + symbols_expression + " } from '" +
                               rel_file_path + import_extension + "';";
-    import.export_statement = "export { " + symbols_expression + " } from '." +
+    import.export_statement = "export {" + symbols_expression + "} from '." +
                               bare_file_path + import_extension + "';";
     import.dependency = &dependency;
     import.dependent = &dependent;
@@ -1703,7 +1703,7 @@ class TsGenerator : public BaseGenerator {
     }
     code += "  bb: flatbuffers.ByteBuffer|" + null_keyword_ + " = " +
             null_keyword_ + ";\n";
-    code += "  bb_pos = 0;\n";
+    code += "  bb_pos: number = 0;\n";
 
     // Generate the __init method that sets the field in a pre-existing
     // accessor object. This is to allow object reuse.
@@ -2156,7 +2156,7 @@ class TsGenerator : public BaseGenerator {
       GenDocComment(code_ptr);
 
       code += "static start" + GetPrefixedName(struct_def) +
-              "(builder:flatbuffers.Builder) {\n";
+              "(builder:flatbuffers.Builder):void {\n";
 
       code += "  builder.startObject(" +
               NumToString(struct_def.fields.vec.size()) + ");\n";
@@ -2173,7 +2173,7 @@ class TsGenerator : public BaseGenerator {
         GenDocComment(code_ptr);
         code += "static " + namer_.Method("add", field);
         code += "(builder:flatbuffers.Builder, " + argname + ":" +
-                GetArgType(imports, struct_def, field, false) + ") {\n";
+                GetArgType(imports, struct_def, field, false) + "):void {\n";
         code += "  builder.addField" + GenWriteMethod(field.value.type) + "(";
         code += NumToString(it - struct_def.fields.vec.begin()) + ", ";
         if (field.value.type.base_type == BASE_TYPE_BOOL) {
@@ -2245,7 +2245,7 @@ class TsGenerator : public BaseGenerator {
 
           code += "static ";
           code += namer_.Method("start", field, "Vector");
-          code += "(builder:flatbuffers.Builder, numElems:number) {\n";
+          code += "(builder:flatbuffers.Builder, numElems:number):void {\n";
           code += "  builder.startVector(" + NumToString(elem_size);
           code += ", numElems, " + NumToString(alignment) + ");\n";
           code += "}\n\n";

tests/ts/TypeScriptTest.py

@@ -228,6 +228,11 @@ def esbuild(input, output):
     " no_import_ext..."
 )
 check_call(["../../node_modules/.bin/tsc", "-p", "./tsconfig.node.json"])
+print(
+    "Running TypeScript Compiler with isolatedDeclarations and"
+    " isolatedModules..."
+)
+check_call(["../../node_modules/.bin/tsc", "-p", "./tsconfig.isolated.json"])
 
 NODE_CMD = ["node"]
 

tests/ts/abc.ts

@@ -0,0 +1,9 @@
+// automatically generated by the FlatBuffers compiler, do not modify
+
+/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any, @typescript-eslint/no-non-null-assertion */
+
+export enum ABC {
+  A = 0,
+  B = 1,
+  C = 2
+}

tests/ts/arrays_test_complex/my-game/example.d.ts

@@ -1,6 +1,6 @@
-export {ArrayStruct, ArrayStructT} from './example/array-struct.js';
-export {ArrayTable, ArrayTableT} from './example/array-table.js';
-export {InnerStruct, InnerStructT} from './example/inner-struct.js';
-export {NestedStruct, NestedStructT} from './example/nested-struct.js';
-export {OuterStruct, OuterStructT} from './example/outer-struct.js';
-export {TestEnum} from './example/test-enum.js';
+export { ArrayStruct, ArrayStructT } from './example/array-struct.js';
+export { ArrayTable, ArrayTableT } from './example/array-table.js';
+export { InnerStruct, InnerStructT } from './example/inner-struct.js';
+export { NestedStruct, NestedStructT } from './example/nested-struct.js';
+export { OuterStruct, OuterStructT } from './example/outer-struct.js';
+export { TestEnum } from './example/test-enum.js';

tests/ts/arrays_test_complex/my-game/example.js

@@ -1,9 +1,8 @@
 // automatically generated by the FlatBuffers compiler, do not modify
-/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any,
- * @typescript-eslint/no-non-null-assertion */
-export {ArrayStruct, ArrayStructT} from './example/array-struct.js';
-export {ArrayTable, ArrayTableT} from './example/array-table.js';
-export {InnerStruct, InnerStructT} from './example/inner-struct.js';
-export {NestedStruct, NestedStructT} from './example/nested-struct.js';
-export {OuterStruct, OuterStructT} from './example/outer-struct.js';
-export {TestEnum} from './example/test-enum.js';
+/* eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any, @typescript-eslint/no-non-null-assertion */
+export { ArrayStruct, ArrayStructT } from './example/array-struct.js';
+export { ArrayTable, ArrayTableT } from './example/array-table.js';
+export { InnerStruct, InnerStructT } from './example/inner-struct.js';
+export { NestedStruct, NestedStructT } from './example/nested-struct.js';
+export { OuterStruct, OuterStructT } from './example/outer-struct.js';
+export { TestEnum } from './example/test-enum.js';

tests/ts/arrays_test_complex/my-game/example/array-struct.d.ts

@@ -1,53 +1,31 @@
 import * as flatbuffers from 'flatbuffers';
-import {
-  NestedStruct,
-  NestedStructT,
-} from '../../my-game/example/nested-struct.js';
-import {OuterStruct, OuterStructT} from '../../my-game/example/outer-struct.js';
-export declare class ArrayStruct
-  implements flatbuffers.IUnpackableObject<ArrayStructT>
-{
-  bb: flatbuffers.ByteBuffer | null;
-  bb_pos: number;
-  __init(i: number, bb: flatbuffers.ByteBuffer): ArrayStruct;
-  aUnderscore(): number;
-  bUnderscore(index: number): number | null;
-  c(): number;
-  d(index: number, obj?: NestedStruct): NestedStruct | null;
-  e(): number;
-  f(index: number, obj?: OuterStruct): OuterStruct | null;
-  g(index: number): bigint | null;
-  static getFullyQualifiedName(): string;
-  static sizeOf(): number;
-  static createArrayStruct(
-    builder: flatbuffers.Builder,
-    a_underscore: number,
-    b_underscore: number[] | null,
-    c: number,
-    d: (any | NestedStructT)[] | null,
-    e: number,
-    f: (any | OuterStructT)[] | null,
-    g: bigint[] | null,
-  ): flatbuffers.Offset;
-  unpack(): ArrayStructT;
-  unpackTo(_o: ArrayStructT): void;
+import { NestedStruct, NestedStructT } from './nested-struct.js';
+import { OuterStruct, OuterStructT } from './outer-struct.js';
+export declare class ArrayStruct implements flatbuffers.IUnpackableObject<ArrayStructT> {
+    bb: flatbuffers.ByteBuffer | null;
+    bb_pos: number;
+    __init(i: number, bb: flatbuffers.ByteBuffer): ArrayStruct;
+    aUnderscore(): number;
+    bUnderscore(index: number): number | null;
+    c(): number;
+    d(index: number, obj?: NestedStruct): NestedStruct | null;
+    e(): number;
+    f(index: number, obj?: OuterStruct): OuterStruct | null;
+    g(index: number): bigint | null;
+    static getFullyQualifiedName(): "MyGame.Example.ArrayStruct";
+    static sizeOf(): number;
+    static createArrayStruct(builder: flatbuffers.Builder, a_underscore: number, b_underscore: number[], c: number, d: (any | NestedStructT)[], e: number, f: (any | OuterStructT)[], g: bigint[]): flatbuffers.Offset;
+    unpack(): ArrayStructT;
+    unpackTo(_o: ArrayStructT): void;
 }
 export declare class ArrayStructT implements flatbuffers.IGeneratedObject {
-  aUnderscore: number;
-  bUnderscore: number[];
-  c: number;
-  d: NestedStructT[];
-  e: number;
-  f: OuterStructT[];
-  g: bigint[];
-  constructor(
-    aUnderscore?: number,
-    bUnderscore?: number[],
-    c?: number,
-    d?: NestedStructT[],
-    e?: number,
-    f?: OuterStructT[],
-    g?: bigint[],
-  );
-  pack(builder: flatbuffers.Builder): flatbuffers.Offset;
+    aUnderscore: number;
+    bUnderscore: (number)[];
+    c: number;
+    d: (NestedStructT)[];
+    e: number;
+    f: (OuterStructT)[];
+    g: (bigint)[];
+    constructor(aUnderscore?: number, bUnderscore?: (number)[], c?: number, d?: (NestedStructT)[], e?: number, f?: (OuterStructT)[], g?: (bigint)[]);
+    pack(builder: flatbuffers.Builder): flatbuffers.Offset;
 }