From bd35682c18648ba01dc56edea1c873ceaacd38fd Mon Sep 17 00:00:00 2001 From: Antony Rizzitelli Date: Thu, 12 Nov 2026 13:21:06 +0000 Subject: [PATCH] docs(readme): adopt the AntelopeJS framework README style --- .github/readme/strip.svg | 1 + README.md | 35 ++++++++++++++++++++++++++++------- package.json | 2 +- pnpm-lock.yaml | 10 +++++----- pnpm-workspace.yaml | 2 ++ 5 files changed, 37 insertions(+), 13 deletions(-) create mode 100644 .github/readme/strip.svg create mode 100644 pnpm-workspace.yaml diff --git a/.github/readme/strip.svg b/.github/readme/strip.svg new file mode 100644 index 0000000..69c99c1 --- /dev/null +++ b/.github/readme/strip.svg @@ -0,0 +1 @@ +INTERFACE · DATABASE DECORATORS: part of AntelopeJS, hexagonal architecture beyond your own code. A glowing button reads Star AntelopeJS.INTERFACE · DATABASE DECORATORSPart of AntelopeJSHexagonal architecture, beyond your own code.★ Star AntelopeJS \ No newline at end of file diff --git a/README.md b/README.md index 832b0f9..77bd202 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,19 @@ -# `@antelopejs/interface-database-decorators` +INTERFACE · DATABASE DECORATORS: part of AntelopeJS, hexagonal architecture beyond your own code. A glowing button reads Star AntelopeJS.
-npm -License -Discord -Docs + +# `@antelopejs/interface-database-decorators` + +npm License Discord Docs Star AntelopeJS + +**Database tables and data models as TypeScript classes for AntelopeJS. Declare fields and indexes with decorators, then read and write rows through a typed model.** + +[Documentation](https://interfaces.antelopejs.com/docs/database-decorators) · [Implementations](#implementations) · [All interfaces and providers](https://github.com/AntelopeJS/antelopejs#ecosystem) +
Database tables and data models as TypeScript classes, on top of [`@antelopejs/interface-database`](https://github.com/AntelopeJS/interface-database). Declare fields and indexes with decorators, then read and write rows through a typed model. -Part of [AntelopeJS](https://github.com/AntelopeJS/antelopejs). Used by [AntelopeJS DMS](https://github.com/AntelopeJS/dms), the open-source back office for your PostgreSQL, MongoDB or RethinkDB database. - ## What it offers - `Table`, `@RegisterTable`, `@Field`, `@Index` and `@Fixture` declare tables, indexes and seed rows; `RegisterSchema` provisions them. @@ -113,6 +116,24 @@ pnpm lint pnpm test ``` +## Part of AntelopeJS + +[AntelopeJS](https://github.com/AntelopeJS/antelopejs) is a TypeScript framework where modules depend on contracts and the application chooses the provider behind each one. [AntelopeJS DMS](https://github.com/AntelopeJS/dms), the open-source back office, is built on it. + + + +| Area | Contracts | Providers | +| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| API | [`interface-api`](https://github.com/AntelopeJS/interface-api) · [`interface-api-util`](https://github.com/AntelopeJS/interface-api-util) · [`interface-data-api`](https://github.com/AntelopeJS/interface-data-api) | [`api`](https://github.com/AntelopeJS/api) | +| Auth | [`interface-auth`](https://github.com/AntelopeJS/interface-auth) | [`auth-jwt`](https://github.com/AntelopeJS/auth-jwt) | +| Database | [`interface-database`](https://github.com/AntelopeJS/interface-database) · **`interface-database-decorators`** · [`interface-database-catalog`](https://github.com/AntelopeJS/interface-database-catalog) · [`interface-mongodb`](https://github.com/AntelopeJS/interface-mongodb) · [`interface-rethinkdb`](https://github.com/AntelopeJS/interface-rethinkdb) | [`postgres`](https://github.com/AntelopeJS/postgres) · [`mongodb`](https://github.com/AntelopeJS/mongodb) · [`rethinkdb`](https://github.com/AntelopeJS/rethinkdb) | +| Redis | [`interface-redis`](https://github.com/AntelopeJS/interface-redis) · [`interface-redis-scheduler`](https://github.com/AntelopeJS/interface-redis-scheduler) | [`redis`](https://github.com/AntelopeJS/redis) | +| Email | [`interface-email`](https://github.com/AntelopeJS/interface-email) | [`nodemailer`](https://github.com/AntelopeJS/nodemailer) · [`brevo`](https://github.com/AntelopeJS/brevo) | +| File storage | [`interface-file-storage`](https://github.com/AntelopeJS/interface-file-storage) | [`file-storage-local`](https://github.com/AntelopeJS/file-storage-local) · [`file-storage-s3`](https://github.com/AntelopeJS/file-storage-s3) | +| Payments | [`interface-payment`](https://github.com/AntelopeJS/interface-payment) · [`interface-subscriptions`](https://github.com/AntelopeJS/interface-subscriptions) · [`interface-stripe`](https://github.com/AntelopeJS/interface-stripe) | [`stripe`](https://github.com/AntelopeJS/stripe) · [`mollie`](https://github.com/AntelopeJS/mollie) · [`checkout-com`](https://github.com/AntelopeJS/checkout-com) · [`payment-subscriptions`](https://github.com/AntelopeJS/payment-subscriptions) | + + + ## License [Apache-2.0](./LICENSE) diff --git a/package.json b/package.json index 7f8e2f9..f57caf0 100644 --- a/package.json +++ b/package.json @@ -146,7 +146,7 @@ "@antelopejs/interface-api": "^0.0.15", "@antelopejs/interface-core": "^0.4.0", "@antelopejs/interface-database": "^0.3.0", - "@antelopejs/tooling-configs": "^0.5.1", + "@antelopejs/tooling-configs": "^0.5.5", "@types/chai": "^4.3.20", "@types/mocha": "^10.0.10", "@types/node": "^22.19.15", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 1f3605c..12a314d 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -28,8 +28,8 @@ importers: specifier: ^0.3.0 version: 0.3.0(@antelopejs/interface-core@0.4.0) '@antelopejs/tooling-configs': - specifier: ^0.5.1 - version: 0.5.1(eslint-plugin-perfectionist@5.11.0(eslint@10.10.0(jiti@2.7.0))(typescript@5.9.3))(knip@6.34.0)(oxfmt@0.66.0)(oxlint@1.81.0(oxlint-tsgolint@7.0.2001)) + specifier: ^0.5.5 + version: 0.5.5(eslint-plugin-perfectionist@5.11.0(eslint@10.10.0(jiti@2.7.0))(typescript@5.9.3))(knip@6.34.0)(oxfmt@0.66.0)(oxlint@1.81.0(oxlint-tsgolint@7.0.2001)) '@types/chai': specifier: ^4.3.20 version: 4.3.20 @@ -102,8 +102,8 @@ packages: peerDependencies: '@antelopejs/interface-core': '>=0.2.4 <1.0.0' - '@antelopejs/tooling-configs@0.5.1': - resolution: {integrity: sha512-Q1JWAsMIDy8f6KaTFPAakT+ChWDhQCzJjdszFFam/pUFqBVMgY+Lp1I7bc8SwcWL3CMdHBzgUUEId2od2cB7hQ==} + '@antelopejs/tooling-configs@0.5.5': + resolution: {integrity: sha512-03QagBC3hE4GAtEF+vwEYWvQfD1oqik+3OrvzT6MaII88vwHdWJOiyqUcHW0ul+ujG4GBL5nDO+wmBciTxQB+g==} engines: {node: '>=22.18.0'} hasBin: true peerDependencies: @@ -2785,7 +2785,7 @@ snapshots: dependencies: '@antelopejs/interface-core': 0.4.0 - '@antelopejs/tooling-configs@0.5.1(eslint-plugin-perfectionist@5.11.0(eslint@10.10.0(jiti@2.7.0))(typescript@5.9.3))(knip@6.34.0)(oxfmt@0.66.0)(oxlint@1.81.0(oxlint-tsgolint@7.0.2001))': + '@antelopejs/tooling-configs@0.5.5(eslint-plugin-perfectionist@5.11.0(eslint@10.10.0(jiti@2.7.0))(typescript@5.9.3))(knip@6.34.0)(oxfmt@0.66.0)(oxlint@1.81.0(oxlint-tsgolint@7.0.2001))': dependencies: '@oxlint/plugins': 1.81.0 dts-bundle-generator: 9.5.1 diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml new file mode 100644 index 0000000..ece6642 --- /dev/null +++ b/pnpm-workspace.yaml @@ -0,0 +1,2 @@ +allowBuilds: + lefthook: false