Alizarin

This is a pure JS/TS implementation of AORM for front or backend.

CI

To get linting up and running, this uses typescript-eslint. Currently, this has a temporary allowed limit of 46 warnings, and sets several errors to warnings. This is temporary and will be progressively reduced.

License

Currently, and you should assume for the foreseeable future, any use of this package, even as a front-end library, carries AGPL requirements and that means any derived work must be licensed appropriately, with shared source-code. This, for avoidance of doubt, means original untranspiled Javascript, Typescript etc. must be made public to all web-users for the whole of any web platform using this library.

This library unlikely to be suitable for use in most traditional commercial products.

We may, in future, dual-license or relicense this package more liberally, so please note that we will expect any PRs to be MIT-licensed to enable the possibility. This may seem lopsided if we begin receiving PRs on the scale of the existing project, so if you are considering doing a substantial piece of work, get in touch beforehand to see if a relicense is possible (which may depend on third-party discussions) and how we can handle it.

Please note that there is third-party code in the tests/ subdirectory.

Acknowledgments

Thanks to the folks at Historic England, the GCI and the Arches Developer Community for the fantastic Arches project, and to the Historic Environment Division for their support of our related Arches work.

In particular, the test data is based on the resource models from Arches for HERs and Arches for Science.