From 3e60747d4af70954c5a7f5c43096d107bb466fa6 Mon Sep 17 00:00:00 2001 From: Antony Rizzitelli Date: Thu, 12 Nov 2026 13:18:29 +0000 Subject: [PATCH 1/2] 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, 36 insertions(+), 14 deletions(-) create mode 100644 .github/readme/strip.svg diff --git a/.github/readme/strip.svg b/.github/readme/strip.svg new file mode 100644 index 0000000..6874277 --- /dev/null +++ b/.github/readme/strip.svg @@ -0,0 +1 @@ +INTERFACE · API: part of AntelopeJS, hexagonal architecture beyond your own code. A glowing button reads Star AntelopeJS.INTERFACE · APIPart of AntelopeJSHexagonal architecture, beyond your own code.★ Star AntelopeJS \ No newline at end of file diff --git a/README.md b/README.md index 05bb089..0d9f3ff 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,16 @@ -# `@antelopejs/interface-api` +INTERFACE · API: part of AntelopeJS, hexagonal architecture beyond your own code. A glowing button reads Star AntelopeJS.
-npm -License -Discord -Docs -
-The AntelopeJS interface for HTTP and WebSocket APIs. You declare controllers and routes with decorators, and the module that implements the interface serves them. +# `@antelopejs/interface-api` + +npm License Discord Docs Star AntelopeJS + +**The AntelopeJS contract for HTTP and WebSocket APIs. Declare controllers and routes with decorators and let the implementing module serve them.** + +[Documentation](https://interfaces.antelopejs.com/docs/api) · [Implementations](#implementations) · [All interfaces and providers](https://github.com/AntelopeJS/antelopejs#ecosystem) -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 @@ -94,6 +95,24 @@ pnpm install pnpm run checks ``` +## Part of AntelopeJS + +[AntelopeJS](https://github.com/AntelopeJS/antelopejs) is the framework this interface belongs to: modules depend on contracts, the application chooses each provider, and [AntelopeJS DMS](https://github.com/AntelopeJS/dms), the open-source back office, is built on it. + + + +| Area | Contracts | Providers | +| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| API | **`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`](https://github.com/AntelopeJS/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 c6cf58f..d4db45f 100644 --- a/package.json +++ b/package.json @@ -61,7 +61,7 @@ "@antelopejs/api": "1.7.0", "@antelopejs/core": "^1.21.0", "@antelopejs/interface-core": ">=0.4.0 <1.0.0", - "@antelopejs/tooling-configs": "^0.5.1", + "@antelopejs/tooling-configs": "^0.5.5", "@types/mocha": "^10.0.10", "@types/node": "^22.19.15", "@types/sinon": "^17.0.4", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 0ec0f3f..01563c7 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -21,8 +21,8 @@ importers: specifier: '>=0.4.0 <1.0.0' version: 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/mocha': specifier: ^10.0.10 version: 10.0.10 @@ -96,8 +96,8 @@ packages: '@antelopejs/interface-core@0.4.0': resolution: {integrity: sha512-IPX6dtt3KHknclN4mLOYeRYL2Odz1Pts+dtaZul62NghsBUX/0OFHD4Qhoaf+Beva4hjInbaF918ajr4Z5HVWQ==} - '@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: @@ -2569,7 +2569,7 @@ snapshots: dependencies: reflect-metadata: 0.2.2 - '@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 index 05539e4..04784ab 100644 --- a/pnpm-workspace.yaml +++ b/pnpm-workspace.yaml @@ -1,2 +1,4 @@ overrides: "@antelopejs/api>@antelopejs/interface-api": "link:." +allowBuilds: + lefthook: false From 9edfcf48db188c1b139f084da75bbb2f9be75300 Mon Sep 17 00:00:00 2001 From: Antony Rizzitelli Date: Thu, 12 Nov 2026 13:19:08 +0000 Subject: [PATCH 2/2] docs(readme): align the Part of AntelopeJS sentence with sibling READMEs --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0d9f3ff..a72976a 100644 --- a/README.md +++ b/README.md @@ -97,7 +97,7 @@ pnpm run checks ## Part of AntelopeJS -[AntelopeJS](https://github.com/AntelopeJS/antelopejs) is the framework this interface belongs to: modules depend on contracts, the application chooses each provider, and [AntelopeJS DMS](https://github.com/AntelopeJS/dms), the open-source back office, is built on it. +[AntelopeJS](https://github.com/AntelopeJS/antelopejs) is the TypeScript framework where modules depend on contracts and the application chooses the provider. [AntelopeJS DMS](https://github.com/AntelopeJS/dms) is built on it.