Add support for AdonisJS (#83)

* WIP

* WIP

* WIP

* WIP

* Fix attw

* Fix order

* Fix order again

* WIP

* Update README and tests workflow

* Fix

* Capture VineJS validation errors

* Fix

* Fix typo

Co-authored-by: Copilot <[email protected]>

---------

Co-authored-by: Copilot <[email protected]>

Author: itssimon

.github/workflows/tests.yaml

@@ -76,6 +76,8 @@ jobs:
           - [email protected]
           - [email protected]
           - [email protected]
+          - "@adonisjs/[email protected]"
+          - "@adonisjs/[email protected]"
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
@@ -101,3 +103,6 @@ jobs:
       - name: Run tests for Hono
         run: npm test -- tests/hono
         if: contains(matrix.deps, 'hono')
+      - name: Run tests for AdonisJS
+        run: npm test -- tests/adonisjs
+        if: contains(matrix.deps, 'adonisjs')

README.md

@@ -31,6 +31,7 @@ frameworks:
 - [Fastify](https://docs.apitally.io/frameworks/fastify)
 - [Koa](https://docs.apitally.io/frameworks/koa)
 - [Hono](https://docs.apitally.io/frameworks/hono)
+- [AdonisJS](https://docs.apitally.io/frameworks/adonisjs)
 
 Learn more about Apitally on our 🌎 [website](https://apitally.io) or check out
 the 📚 [documentation](https://docs.apitally.io).
@@ -183,6 +184,46 @@ useApitally(app, {
 });
 ```
 
+### AdonisJS
+
+This is an example of how to use the Apitally middleware with a AdonisJS application.
+For further instructions, see our
+[setup guide for AdonisJS](https://docs.apitally.io/frameworks/adonisjs).
+
+Create a configuration file at `config/apitally.ts`:
+
+```javascript
+import { defineConfig } from "apitally/adonisjs";
+
+const apitallyConfig = defineConfig({
+  clientId: "your-client-id",
+  env: "dev", // or "prod" etc.
+});
+
+export default apitallyConfig;
+```
+
+Register the Apitally provider in your `adonisrc.ts` file:
+
+```javascript
+export default defineConfig({
+  // ... existing code ...
+  providers: [
+    // ... existing providers ...
+    () => import("apitally/adonisjs/provider"),
+  ],
+});
+```
+
+Register the Apitally middleware in your `start/kernel.ts` file:
+
+```javascript
+router.use([
+  () => import("apitally/adonisjs/middleware"),
+  // ... other middleware ...
+]);
+```
+
 ## Getting help
 
 If you need help please [create a new discussion](https://github.com/orgs/apitally/discussions/categories/q-a) on GitHub