OData(V4) Server

NodeJS OData(V4) Server Implementation.

This project is under heavy development, if you are looking forward an OData Framework for production usage, please try the SAP CAP Framework

Just check the demo project for features preview.

Features

• OASIS Standard OData Version 4.0 server
• usable as a standalone server, or as an Express router
• expose service document and service metadata - $metadata
• setup metadata using decorators or @odata/metadata
• supported data types are Edm primitives, complex types, navigation properties
• support create, read, update, and delete the EntitySets,
• support action imports, function imports, bounded actions and bounded functions on EntitySets
• support for full OData query language using @odata/parser
  • filtering entities - $filter
  • sorting - $orderby
  • paging - $skip and $top
  • projection of entities - $select
  • expanding entities - $expand
  • count records - $count
• support async controller functions using Promise, async/await
• support OData V4.01 JSON format $batch operation
• support dependency inject
• support deep insert

Concepts

Domain Model

Define domain model class, it will be transformed to database schema.

Action & Function

Define Action/Function on the Domain Models.

Using the actions implement the partially focused business logics, and use the functions implement complex queries.

Hook

Hook is general business logic for specify Domain Model, like beforeCreate/beforeUpdate, and it's mapped from OData/HTTP Method.

Define Hooks to implement the general business logics for entity.

Service

Using services in hook/action/function, keep the business consistence for single domain model.

Each model will have its own standard CRUD service which enhanced with hooks logic.

Transaction

Each TransactionContext will use single database transaction (connection).

CHANGELOG

LICENSE

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

0.2.48 (2021-06-07)

Bug Fixes

• $top empty issue (6e1b6fc)

0.2.47 (2021-01-04)

Features

• #68 add date validate documentation (4d01b3b)

0.2.46 (2020-11-04)

Features

• remove stream support (0ed1fc7)
• validate enum type (f2abdb9)

0.2.45 (2020-10-28)

Features

• #112 exclude some column types (50547fb)
• #113 provide ui annotations (b3de0c6)
• #121 define odata view entity (1f98fa9)
• #126 move out string closest check to util lib (903ebb6)
• add unit test for #121 (f6d83f6)
• update bignumber support (a466885)

Bug Fixes

• $expand($filter) issue (fca8f5c)
• pg type (ff22187)
• type (8fdb176)
• type issue (592721e)
• type issue for typescript (290785d)

0.2.44 (2020-10-11)

Bug Fixes

• $select for many to one navigation (cc02c22)

0.2.43 (2020-10-11)

Bug Fixes

• mysql identifier issue (a75d2cb)

0.2.42 (2020-10-11)

Bug Fixes

• projection not works correctly in deep expand (fc52615)

0.2.41 (2020-10-11)

Features

• #96 enhance $expand logic on SQL build (fcffee4)

Bug Fixes

• type issue (060ed9a)

0.2.40 (2020-10-11)

Features

• #25 'dependsOn' support (f23a50b)
• #68 enhance (e3f52da)

0.2.39 (2020-09-24)

Features

• #68 add validators for creation (0a84b42)
• #68 provide field suggest for user (20effcb)
• #68 support validation on update (d6a68e0)
• optimize migration logic (a54bee7)

Bug Fixes

• char type for test (2835dd3)
• windows build failed (d0be225)

0.2.38 (2020-09-22)

Bug Fixes

• getConnection of typed service (9a3509d)

0.2.37 (2020-09-22)

Bug Fixes

• avoid update un-necessary field for hana (dc583cc)

0.2.36 (2020-09-22)

Features

• mapping guid when query (9cda2e7)

Bug Fixes

• quote for mysql (a803510)

0.2.35 (2020-09-21)

Features

• #42 refactor (3563e6d)
• #65 migration init support (27c5a4a)
• support @injectService (7b552d0)

Bug Fixes

• #72 error (7e7accd)
• #74, apply typeorm transformers in entityset query (9735c7d)
• ci profile (c9f9836)
• connection released error (921e759)
• hana test case (70e5151)
• hook-afterLoad (7f89796)
• migration test wrong (1b8fa94)
• type issue in update (3046518)

0.2.34 (2020-09-07)

0.2.33 (2020-09-03)

Features

• update mysql db helper (c43f7b3)

Bug Fixes

• db helper for mysql (056bc94)
• db_helper (184ffd7)
• mysql builder & timeout (a1794a9)
• unit test table length for mysql (17a1760)
• ci: hana table prefix (0e8f23a)

0.2.32 (2020-09-01)

0.2.31 (2020-08-31)

Features

• add new api to typed-server (ed28944)

Bug Fixes

• hana again (7a16d2f)
• limit offset keyword (ca2a145)
• type issue (adcb38c)
• unit test for hana (fe5ec56)

0.2.30 (2020-08-20)

Bug Fixes

• name of test (4f8f80a)

0.2.29 (2020-08-20)

Features

• #29, function/action injection (959c689)
• di update (d8c4ba0)
• integrate the standalong inject module (3239a68)
• wrapper of injection (305492d)

Bug Fixes

• type issue (078949e)
• type issue in @inject (132949a)

0.2.28 (2020-08-16)

Features

• #20 key validations for entity (ed25935)
• #25 fast fail (c2a2b31)
• #29 sub level inject (1f27fd8)
• dependency inject prototype (2c8f409)
• enhance dependency inject (ec58461)
• parent & sub class support (6847d09)
• rename files (c954296)
• rename typeorm (921ab7f)
• support database name for column (5e2fcd2)
• support provider injection (8969635)

Bug Fixes

• batch request (68f1517)
• type for unit tests (4921668)

0.2.27 (2020-08-10)

Features

• #26 & other enhance (dbb0603)
• #26 decorators update (031f341)

Bug Fixes

• connection issue (a12a9c8)
• get connection from wrong location (e7259b5)
• hana instance data issue (b5add91)

0.2.26 (2020-08-10)

Features

• #22 update events (811da43)
• #23 module rename (614f594)
• #23 remove jaystack resource (8ded1d0)
• #23 rename (f882af5)
• #24 remove typeorm association (e23bf95)
• #25 add payload validation for batch request (1eccd08)
• #25 basic support batch request in json format (4c70ecb)

Bug Fixes

• #25, response key (59941a0)

0.2.25 (2020-08-07)

Features

• #14 add debug module as basis logger (0c8ae04)
• db helper (49b764d)
• optimize query (68d36bd)
• unit test & ci for hana (b2f826a)
• ci: #21 support pg unt test (980eb70)
• ci: add tests for mysql #21 (a48f3dc)

Bug Fixes

• ci (f0dfecd)
• doc (d51a825)
• pg & mysql count (be27ac8)
• setup script (e84968f)

0.2.24 (2020-08-04)

Features

• #17 support datetime in body (ff89ffd)
• #17 support datetime on payload & query (849acd9)

0.2.23 (2020-08-02)

Features

• #15 support deep insert (9a18377)

0.2.22 (2020-08-01)

Features

• refactor server type & hook (445adcd)

Bug Fixes

• build script (a56ba53)

0.2.21 (2020-08-01)

Features

• get connection in hook (df3a27c)

0.2.20 (2020-08-01)

Bug Fixes

• creation hook (1b6a554)

0.2.19 (2020-08-01)

Features

• event hook (ebd57b9)

Bug Fixes

• doc: error (5d551c7)

0.2.18 (2020-08-01)

Features

• #18 (de3196c)
• action related refactor (ebc2856)
• action support for odata model (b4ece29)
• bounded function (4cf44b0)
• integration test for school (e536226)
• refactor action/function processor (0e255f7)
• support PUT method for odata (a0fe2bd)
• hook: attach new function shortcut (35dcc71)
• hook: rename shortcut (d01e7e4)

Bug Fixes

• type: for visitor (a45caec)

0.2.17 (2020-07-30)

Bug Fixes

• type: for hook processor (5938a88)

0.2.16 (2020-07-30)

Features

• #14 swagger & swagger UI (3a3d66c)
• #4 add event hook (f0c2ed1)
• #4, #15 transaction (8f20e0e)

Bug Fixes

• hook: transaction (4f1e7ea)
• hook: unit test order (b0b3d56)

0.2.15 (2020-07-29)

Features

• #15 add request id (faaa6d8)
• #15 support transaction for hook (49cf4ba)
• #15 transaction & fix count issue (f634e39)
• #4 define odata entity set name (e178efb)
• #4 enhance decorator (10d81be)
• #4 odata navigation (625fc01)
• #4 typeorm integration init (4ed3690)
• #4 typeorm support enhance (9f47a2c)
• #7 document (f650620)
• #7 hook (c533406)
• typeorm: integration (b45ec4b)
• #7 hook storage (5d69b4c)
• #7 hooks feature (fd7151a)
• #7 update hook impl (080aaab)
• ast to typeorm sql (4ef956c)
• odata controller & service creator (385fb2c)
• refactor (2ac08af)
• typeorm support (d92b220)

Bug Fixes

• #4 decorator wrong signature (cc3b776)
• #7 hook type (1252e22)

0.2.14 (2020-07-08)

Bug Fixes

• again (702524f)
• build script (546a5e5)
• ci script (8b5d756)
• file access issue on windows platform (013fbf1)
• only test stream api on linux (6f5c126)
• types (759d1ea)
• types (909c7cf)
• unit test script (e74d66e)
• windows tests (cbff854)