commit	ef76b5ece4d6ff06bebf04f42e41a50427263ae3	[log] [tgz]
author	Björn Harrtell <bjornharrtell@users.noreply.github.com>	Sat Jan 21 21:22:22 2023 +0100
committer	GitHub <noreply@github.com>	Sat Jan 21 12:22:22 2023 -0800
tree	d91b74372601c7f4990f221b5722094021fdf729
parent	1703662285f5b2a2ee1a151b17755fd709ad2e13 [diff]

[TS/JS] Entry point per namespace and reworked 1.x compatible single file build (#7510)

* [TS/JS] Entry point per namespace

* Fix handling of outputpath and array_test

* Attempt to fix generate_code

* Fix cwd for ts in generate_code

* Attempt to fixup bazel and some docs

* Add --ts-flat-files to bazel build to get bundle

* Move to DEFAULT_FLATC_TS_ARGS

* Attempt to add esbuild

* Attempt to use npm instead

* Remove futile attempt to add esbuild

* Attempt to as bazel esbuild

* Shuffle

* Upgrade bazel deps

* Revert failed attempts to get bazel working

* Ignore flatc tests for now

* Add esbuild dependency

* `package.json` Include esbuild

* `WORKSPACE` Add fetching esbuild binary

* Update WORKSPACE

* Unfreeze Lockfile

* Update WORKSPACE

* Update BUILD.bazel

* Rework to suggest instead of running external bundler

* Add esbuild generation to test script

* Prelim bundle test

* Run test JavaScriptTest from flatbuffers 1.x

* Deps upgrade

* Clang format fix

* Revert bazel changes

* Fix newline

* Generate with type declarations

* Handle "empty" root namespace

* Adjust tests for typescript_keywords.ts

* Separate test procedure for old node resolution module output

* Fix rel path for root level re-exports

* Bazel support for esbuild-based flatc

Unfortunately, we lose typing information because the new esbuild method
of generating single files does not generate type information.

The method used here is a bit hack-ish because it relies on parsing the
console output of flatc to figure out what to do.

* Try to fix bazel build for when node isn't present on host

* Auto formatting fixes

* Fix missing generated code

Co-authored-by: Derek Bailey <derekbailey@google.com>
Co-authored-by: James Kuszmaul <jabukuszmaul+collab@gmail.com>

.github/workflows/build.yml[diff]
WORKSPACE[diff]
build_defs.bzl[diff]
docs/source/Tutorial.md[diff]
grpc/examples/ts/greeter/src/greeter.ts[diff]
grpc/examples/ts/greeter/src/models.ts[Added - diff]
include/flatbuffers/idl.h[diff]
package.json[diff]
reflection/ts/BUILD.bazel[diff]
rollup.config.js[Deleted - diff]
scripts/generate_code.py[diff]
src/flatc.cpp[diff]
src/idl_gen_ts.cpp[diff]
tests/my-game/example/ability.js[Deleted - diff]
tests/my-game/example/ability.ts[Deleted - diff]
tests/my-game/example/any-ambiguous-aliases.js[Deleted - diff]
tests/my-game/example/any-ambiguous-aliases.ts[Deleted - diff]
tests/my-game/example/any-unique-aliases.js[Deleted - diff]
tests/my-game/example/any-unique-aliases.ts[Deleted - diff]
tests/my-game/example/any.js[Deleted - diff]
tests/my-game/example/any.ts[Deleted - diff]
tests/my-game/example/color.js[Deleted - diff]
tests/my-game/example/color.ts[Deleted - diff]
tests/my-game/example/long-enum.ts[Deleted - diff]
tests/my-game/example/monster.js[Deleted - diff]
tests/my-game/example/monster.ts[Deleted - diff]
tests/my-game/example/race.js[Deleted - diff]
tests/my-game/example/race.ts[Deleted - diff]
tests/my-game/example/referrable.js[Deleted - diff]
tests/my-game/example/referrable.ts[Deleted - diff]
tests/my-game/example/stat.js[Deleted - diff]
tests/my-game/example/stat.ts[Deleted - diff]
tests/my-game/example/struct-of-structs-of-structs.ts[Deleted - diff]
tests/my-game/example/struct-of-structs.js[Deleted - diff]
tests/my-game/example/struct-of-structs.ts[Deleted - diff]
tests/my-game/example/test-simple-table-with-enum.js[Deleted - diff]
tests/my-game/example/test-simple-table-with-enum.ts[Deleted - diff]
tests/my-game/example/test.js[Deleted - diff]
tests/my-game/example/test.ts[Deleted - diff]
tests/my-game/example/type-aliases.js[Deleted - diff]
tests/my-game/example/type-aliases.ts[Deleted - diff]
tests/my-game/example/vec3.js[Deleted - diff]
tests/my-game/example/vec3.ts[Deleted - diff]
tests/my-game/example2/monster.js[Deleted - diff]
tests/my-game/example2/monster.ts[Deleted - diff]
tests/my-game/in-parent-namespace.js[Deleted - diff]
tests/my-game/in-parent-namespace.ts[Deleted - diff]
tests/namespace_test/namespace-a/namespace-b/enum-in-nested-n-s.js[Deleted - diff]
tests/namespace_test/namespace-a/namespace-b/struct-in-nested-n-s.js[Deleted - diff]
tests/namespace_test/namespace-a/namespace-b/struct-in-nested-n-s.ts[Deleted - diff]
tests/namespace_test/namespace-a/namespace-b/table-in-nested-n-s.js[Deleted - diff]
tests/namespace_test/namespace-a/namespace-b/table-in-nested-n-s.ts[Deleted - diff]
tests/namespace_test/namespace-a/namespace-b/union-in-nested-n-s.js[Deleted - diff]
tests/namespace_test/namespace-a/namespace-b/union-in-nested-n-s.ts[Deleted - diff]
tests/namespace_test/namespace-a/second-table-in-a.js[Deleted - diff]
tests/namespace_test/namespace-a/second-table-in-a.ts[Deleted - diff]
tests/namespace_test/namespace-a/table-in-first-n-s.js[Deleted - diff]
tests/namespace_test/namespace-a/table-in-first-n-s.ts[Deleted - diff]
tests/namespace_test/namespace-c/table-in-c.js[Deleted - diff]
tests/namespace_test/namespace-c/table-in-c.ts[Deleted - diff]
tests/namespace_test/namespace_test1.ts[Deleted - diff]
tests/namespace_test/namespace_test2.ts[Deleted - diff]
tests/optional-scalars/optional-byte.ts[Deleted - diff]
tests/optional-scalars/scalar-stuff.ts[Deleted - diff]
tests/optional_scalars/optional-byte.js[Deleted - diff]
tests/optional_scalars/optional-byte.ts[Deleted - diff]
tests/optional_scalars/scalar-stuff.js[Deleted - diff]
tests/optional_scalars/scalar-stuff.ts[Deleted - diff]
tests/ts/JavaScriptComplexArraysTest.js[diff]
tests/ts/JavaScriptTestv1.cjs[Added - diff]
tests/ts/TypeScriptTest.py[diff]
tests/ts/arrays_test_complex/arrays_test_complex_generated.cjs[Added - diff]
tests/ts/arrays_test_complex/arrays_test_complex_generated.js[Deleted - diff]
tests/ts/arrays_test_complex/arrays_test_complex_generated.ts[Deleted - diff]
tests/ts/arrays_test_complex/my-game/example.d.ts[Added - diff]
tests/ts/arrays_test_complex/my-game/example.js[Added - diff]
tests/ts/arrays_test_complex/my-game/example.ts[Added - diff]
tests/ts/arrays_test_complex/my-game/example/array-struct.d.ts[Added - diff]
tests/ts/arrays_test_complex/my-game/example/array-struct.js[Added - diff]
tests/ts/arrays_test_complex/my-game/example/array-struct.ts[Added - diff]
tests/ts/arrays_test_complex/my-game/example/array-table.d.ts[Added - diff]
tests/ts/arrays_test_complex/my-game/example/array-table.js[Added - diff]
tests/ts/arrays_test_complex/my-game/example/array-table.ts[Added - diff]
tests/ts/arrays_test_complex/my-game/example/inner-struct.d.ts[Added - diff]
tests/ts/arrays_test_complex/my-game/example/inner-struct.js[Added - diff]
tests/ts/arrays_test_complex/my-game/example/inner-struct.ts[Added - diff]
tests/ts/arrays_test_complex/my-game/example/nested-struct.d.ts[Added - diff]
tests/ts/arrays_test_complex/my-game/example/nested-struct.js[Added - diff]
tests/ts/arrays_test_complex/my-game/example/nested-struct.ts[Added - diff]
tests/ts/arrays_test_complex/my-game/example/outer-struct.d.ts[Added - diff]
tests/ts/arrays_test_complex/my-game/example/outer-struct.js[Added - diff]
tests/ts/arrays_test_complex/my-game/example/outer-struct.ts[Added - diff]
tests/ts/arrays_test_complex/my-game/example/test-enum.d.ts[Added - diff]
tests/ts/arrays_test_complex/my-game/example/test-enum.js[Added - diff]
tests/ts/arrays_test_complex/my-game/example/test-enum.ts[Renamed from tests/namespace_test/namespace-a/namespace-b/enum-in-nested-n-s.ts - diff]
tests/ts/foobar.d.ts[Added - diff]
tests/ts/foobar.js[Copied from tests/ts/typescript_transitive_include_generated.ts - diff]
tests/ts/foobar.ts[Renamed from tests/ts/typescript_transitive_include_generated.ts - diff]
tests/ts/foobar/abc.d.ts[Added - diff]
tests/ts/foobar/abc.js[diff]
tests/ts/foobar/class.d.ts[Added - diff]
tests/ts/foobar/class.js[diff]
tests/ts/monster_test.d.ts[Added - diff]
tests/ts/monster_test.js[diff]
tests/ts/monster_test.ts[diff]
tests/ts/monster_test_generated.cjs[Added - diff]
tests/ts/monster_test_generated.ts[Deleted - diff]
tests/ts/monster_test_grpc.d.ts[Deleted - diff]
tests/ts/monster_test_grpc.js[Deleted - diff]
tests/ts/monsterdata_javascript_wire.mon[diff]
tests/ts/my-game.d.ts[Added - diff]
tests/ts/my-game.js[Added - diff]
tests/ts/my-game.ts[Added - diff]
tests/ts/my-game/example.d.ts[Added - diff]
tests/ts/my-game/example.js[Added - diff]
tests/ts/my-game/example.ts[Added - diff]
tests/ts/my-game/example/ability.d.ts[Added - diff]
tests/ts/my-game/example/any-ambiguous-aliases.d.ts[Added - diff]
tests/ts/my-game/example/any-ambiguous-aliases.js[diff]
tests/ts/my-game/example/any-unique-aliases.d.ts[Added - diff]
tests/ts/my-game/example/any-unique-aliases.js[diff]
tests/ts/my-game/example/any.d.ts[Added - diff]
tests/ts/my-game/example/any.js[diff]
tests/ts/my-game/example/color.d.ts[Added - diff]
tests/ts/my-game/example/color.js[diff]
tests/ts/my-game/example/long-enum.d.ts[Added - diff]
tests/ts/my-game/example/long-enum.js[diff]
tests/ts/my-game/example/monster.d.ts[Added - diff]
tests/ts/my-game/example/race.d.ts[Added - diff]
tests/ts/my-game/example/race.js[diff]
tests/ts/my-game/example/referrable.d.ts[Added - diff]
tests/ts/my-game/example/stat.d.ts[Added - diff]
tests/ts/my-game/example/struct-of-structs-of-structs.d.ts[Added - diff]
tests/ts/my-game/example/struct-of-structs-of-structs.js[diff]
tests/ts/my-game/example/struct-of-structs.d.ts[Added - diff]
tests/ts/my-game/example/struct-of-structs.js[diff]
tests/ts/my-game/example/test-simple-table-with-enum.d.ts[Added - diff]
tests/ts/my-game/example/test.d.ts[Added - diff]
tests/ts/my-game/example/type-aliases.d.ts[Added - diff]
tests/ts/my-game/example/vec3.d.ts[Added - diff]
tests/ts/my-game/example/vec3.js[diff]
tests/ts/my-game/example2.d.ts[Added - diff]
tests/ts/my-game/example2.js[Added - diff]
tests/ts/my-game/example2.ts[Added - diff]
tests/ts/my-game/example2/monster.d.ts[Added - diff]
tests/ts/my-game/in-parent-namespace.d.ts[Added - diff]
tests/ts/my-game/other-name-space.d.ts[Added - diff]
tests/ts/my-game/other-name-space.js[Added - diff]
tests/ts/my-game/other-name-space.ts[Added - diff]
tests/ts/my-game/other-name-space/from-include.d.ts[Added - diff]
tests/ts/my-game/other-name-space/from-include.js[Added - diff]
tests/ts/my-game/other-name-space/from-include.ts[Renamed from tests/ts/typescript_include_generated.ts - diff]
tests/ts/my-game/other-name-space/table-b.d.ts[Added - diff]
tests/ts/my-game/other-name-space/table-b.js[Added - diff]
tests/ts/my-game/other-name-space/table-b.ts[Added - diff]
tests/ts/my-game/other-name-space/unused.d.ts[Added - diff]
tests/ts/my-game/other-name-space/unused.js[Added - diff]
tests/ts/my-game/other-name-space/unused.ts[Added - diff]
tests/ts/no_import_ext/optional-scalars.d.ts[Added - diff]
tests/ts/no_import_ext/optional-scalars.js[Renamed from tests/ts/no_import_ext/optional_scalars_generated.js - diff]
tests/ts/no_import_ext/optional-scalars.ts[Renamed from tests/ts/no_import_ext/optional_scalars_generated.ts - diff]
tests/ts/no_import_ext/optional-scalars/optional-byte.d.ts[Added - diff]
tests/ts/no_import_ext/optional-scalars/scalar-stuff.d.ts[Added - diff]
tests/ts/no_import_ext/optional_scalars.d.ts[Added - diff]
tests/ts/no_import_ext/optional_scalars.js[diff]
tests/ts/no_import_ext/optional_scalars.ts[diff]
tests/ts/optional-scalars.ts[Renamed from tests/ts/optional_scalars_generated.ts - diff]
tests/ts/optional_scalars.ts[diff]
tests/ts/reflection.d.ts[Added - diff]
tests/ts/reflection.js[Added - diff]
tests/ts/reflection.ts[Added - diff]
tests/ts/reflection/advanced-features.d.ts[Added - diff]
tests/ts/reflection/advanced-features.js[Added - diff]
tests/ts/reflection/base-type.d.ts[Added - diff]
tests/ts/reflection/base-type.js[diff]
tests/ts/reflection/enum-val.d.ts[Added - diff]
tests/ts/reflection/enum.d.ts[Added - diff]
tests/ts/reflection/field.d.ts[Added - diff]
tests/ts/reflection/key-value.d.ts[Added - diff]
tests/ts/reflection/object.d.ts[Added - diff]
tests/ts/reflection/rpccall.d.ts[Added - diff]
tests/ts/reflection/schema-file.d.ts[Added - diff]
tests/ts/reflection/schema.d.ts[Added - diff]
tests/ts/reflection/service.d.ts[Added - diff]
tests/ts/reflection/type.d.ts[Added - diff]
tests/ts/reflection_generated.cjs[Added - diff]
tests/ts/reflection_generated.js[Deleted - diff]
tests/ts/reflection_generated.ts[Deleted - diff]
tests/ts/table-a.d.ts[Added - diff]
tests/ts/table-a.js[Added - diff]
tests/ts/table-a.ts[Added - diff]
tests/ts/ts-flat-files/monster_test_generated.ts[Deleted - diff]
tests/ts/tsconfig.json[diff]
tests/ts/tsconfig.node.json[Added - diff]
tests/ts/typescript.d.ts[Added - diff]
tests/ts/typescript.js[Added - diff]
tests/ts/typescript.ts[Added - diff]
tests/ts/typescript/class.d.ts[Added - diff]
tests/ts/typescript/class.js[diff]
tests/ts/typescript/object.d.ts[Added - diff]
tests/ts/typescript_include.ts[Copied from tests/ts/typescript_transitive_include_generated.ts - diff]
tests/ts/typescript_include_generated.cjs[Added - diff]
tests/ts/typescript_include_generated.js[Deleted - diff]
tests/ts/typescript_keywords.d.ts[Added - diff]
tests/ts/typescript_keywords.js[Added - diff]
tests/ts/typescript_keywords.ts[Added - diff]
tests/ts/typescript_keywords_generated.cjs[Added - diff]
tests/ts/typescript_keywords_generated.js[Deleted - diff]
tests/ts/typescript_keywords_generated.ts[Deleted - diff]
tests/ts/typescript_transitive_include.ts[Copied from tests/ts/typescript_transitive_include_generated.ts - diff]
tests/ts/typescript_transitive_include_generated.cjs[Added - diff]
tests/ts/typescript_transitive_include_generated.js[Deleted - diff]
tests/ts/union_vector/attacker.d.ts[Added - diff]
tests/ts/union_vector/book-reader.d.ts[Added - diff]
tests/ts/union_vector/character.d.ts[Added - diff]
tests/ts/union_vector/character.js[diff]
tests/ts/union_vector/falling-tub.d.ts[Added - diff]
tests/ts/union_vector/gadget.d.ts[Added - diff]
tests/ts/union_vector/gadget.js[diff]
tests/ts/union_vector/hand-fan.d.ts[Added - diff]
tests/ts/union_vector/movie.d.ts[Added - diff]
tests/ts/union_vector/rapunzel.d.ts[Added - diff]
tests/ts/union_vector/union_vector.d.ts[Added - diff]
tests/ts/union_vector/union_vector.js[Added - diff]
tests/ts/union_vector/union_vector.ts[Added - diff]
tests/ts/union_vector/union_vector_generated.cjs[Added - diff]
tests/ts/union_vector/union_vector_generated.js[Deleted - diff]
tests/ts/union_vector/union_vector_generated.ts[Deleted - diff]
tests/union_vector/attacker.js[Deleted - diff]
tests/union_vector/attacker.ts[Deleted - diff]
tests/union_vector/book-reader.js[Deleted - diff]
tests/union_vector/book-reader.ts[Deleted - diff]
tests/union_vector/character.js[Deleted - diff]
tests/union_vector/character.ts[Deleted - diff]
tests/union_vector/falling-tub.ts[Deleted - diff]
tests/union_vector/gadget.ts[Deleted - diff]
tests/union_vector/hand-fan.ts[Deleted - diff]
tests/union_vector/movie.js[Deleted - diff]
tests/union_vector/movie.ts[Deleted - diff]
tests/union_vector/rapunzel.js[Deleted - diff]
tests/union_vector/rapunzel.ts[Deleted - diff]
tests/union_vector/union_vector.js[Deleted - diff]
tests/union_vector/union_vector.ts[Deleted - diff]
tests/union_vector/union_vector_generated.ts[Deleted - diff]
ts/BUILD.bazel[diff]
ts/compile_flat_file.sh[Added - diff]
ts/flatbuffers.ts[diff]
ts/index.ts[Deleted - diff]
tsconfig.json[diff]
tsconfig.mjs.json[diff]
typescript.bzl[diff]
yarn.lock[diff]

252 files changed

tree: d91b74372601c7f4990f221b5722094021fdf729

readme.md

FlatBuffers

FlatBuffers is a cross platform serialization library architected for maximum memory efficiency. It allows you to directly access serialized data without parsing/unpacking it first, while still having great forwards/backwards compatibility.

Go to our landing page to browse our documentation.

Supported operating systems

Windows
macOS
Linux
Android
And any others with a recent C++ compiler (C++ 11 and newer)

Supported programming languages

Code generation and runtime libraries for many popular languages.

C
C++ - snapcraft.io
C# - nuget.org
Dart - pub.dev
Go - go.dev
Java - Maven
JavaScript - NPM
Kotlin
Lobster
Lua
PHP
Python - PyPi
Rust - crates.io
Swift - swiftpackageindex
TypeScript - NPM
Nim

Versioning

FlatBuffers does not follow traditional Semver versioning (see rationale) but rather uses a format of the date of the release.

Contribution

FlatBuffers Issues Tracker to submit an issue.
stackoverflow.com with flatbuffers tag for any questions regarding FlatBuffers.

To contribute to this project, see CONTRIBUTING.

Community

FlatBuffers Google Group to discuss FlatBuffers with other developers and users.
Discord Server
Gitter

Security

Please see our Security Policy for reporting vulnerabilities.

Licensing

Flatbuffers is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.