@eienjs/adonisjs-sentry 1.0.0 → 2.0.0

package/README.md

@@ -7,11 +7,48 @@
 [![Build Status][badge-build]][build]
 [![Total Downloads][badge-downloads]][downloads]
 
-> Sentry service provider for AdonisJS.
+> Sentry service provider for AdonisJS v7 application.
 
 ## Introduction
 
-A simple wrapper around the Sentry SDK to make it easier to use with AdonisJS.
+A simple wrapper around the Sentry SDK to make it easier to use with AdonisJS v7 application.
+
+## Quick Start
+
+Install the package using the following command:
+
+```sh
+node ace add @eienjs/adonisjs-sentry
+```
+
+Automatically the command will register the provider and the command included in the package. Now update the `app/exceptions/handler.ts` file:
+
+```typescript
+// ... your other imports
+import { Sentry } from '@eienjs/adonisjs-sentry';
+
+export default class HttpExceptionHandler extends ExceptionHandler {
+  async report(error: unknown, ctx: HttpContext) {
+    /**
+     * Convert the error to a standardized HTTP error
+     * format that includes status code and error code
+     */
+    const httpError = this.toHttpError(error);
+
+    /**
+     * Only report the error if it passes the shouldReport check,
+     * which verifies it's not in ignoreStatuses or ignoreCodes
+     */
+    if (this.shouldReport(httpError)) {
+      Sentry.captureException(httpError);
+    }
+
+    await super.report(error, ctx);
+  }
+}
+```
+
+And not forget to update your `.env` file `SENTRY_DSN` value.
 
 ## Documentation
 
@@ -30,7 +67,7 @@ The `@eienjs/adonisjs-sentry` library is licensed for use under the MIT License
 [source]: https://github.com/eienjs/adonisjs-sentry
 [node-version]: https://www.npmjs.com/package/@eienjs/adonisjs-sentry
 [release]: https://www.npmjs.com/package/@eienjs/adonisjs-sentry
-[license]: https://github.com/eienjs/adonisjs-sentry/blob/main/LICENSE.md
+[license]: https://github.com/eienjs/adonisjs-sentry/blob/main/LICENSE
 [build]: https://github.com/eienjs/adonisjs-sentry/actions/workflows/build.yml?query=branch:main
 [downloads]: https://www.npmjs.com/package/@eienjs/adonisjs-sentry
 [badge-source]: https://img.shields.io/badge/source-eienjs/adonisjs--sentry-blue.svg?logo=github

package/build/commands/commands.json

@@ -1 +1 @@
-{"commands":[{"commandName":"sentry:verify","description":"Generate a test event and send it to Sentry","help":"","namespace":"sentry","aliases":[],"flags":[],"args":[],"options":{"startApp":true,"staysAlive":false},"filePath":"verify_sentry_integration.mjs"}],"version":1}
+{"commands":[{"commandName":"sentry:verify","description":"Generate a test event and send it to Sentry","help":"","namespace":"sentry","aliases":[],"flags":[],"args":[],"options":{"startApp":true,"staysAlive":false},"filePath":"verify_sentry_integration.js"}],"version":1}

package/build/commands/{verify_sentry_integration.mjs → verify_sentry_integration.js}

@@ -1,5 +1,4 @@
 import { BaseCommand } from "@adonisjs/core/ace";
-
 //#region commands/verify_sentry_integration.ts
 var VerifySentryIntegration = class extends BaseCommand {
 	static commandName = "sentry:verify";
@@ -14,7 +13,7 @@ var VerifySentryIntegration = class extends BaseCommand {
 			this.logger.info("Sentry is disabled");
 			return;
 		}
-		const { Sentry } = await import("../src/sentry.mjs");
+		const { Sentry } = await import("../src/sentry.js");
 		if (!Sentry.isInitialized()) Sentry.init(sentryConfig);
 		try {
 			throw new Error("This is a test exception sent from the sentry adonisjs");
@@ -24,6 +23,5 @@ var VerifySentryIntegration = class extends BaseCommand {
 		}
 	}
 };
-
 //#endregion
-export { VerifySentryIntegration as default };
+export { VerifySentryIntegration as default };

package/build/{configure.mjs → configure.js}

@@ -1,5 +1,4 @@
-import { stubsRoot } from "./stubs/main.mjs";
-
+import { stubsRoot } from "./stubs/main.js";
 //#region configure.ts
 async function configure(command) {
 	const codemods = await command.createCodemods();
@@ -10,14 +9,13 @@ async function configure(command) {
 		leadingComment: "Variables for configuring @eienjs/adonisjs-sentry package"
 	});
 	await codemods.registerMiddleware("router", [{
-		path: "@eienjs/adonisjs-sentry/sentry_middleware",
+		path: "@eienjs/adonisjs-sentry/middleware/sentry_middleware",
 		position: "before"
 	}]);
 	await codemods.updateRcFile((rcFile) => {
 		rcFile.addCommand("@eienjs/adonisjs-sentry/commands");
-		rcFile.addProvider("@eienjs/adonisjs-sentry/sentry_provider");
+		rcFile.addProvider("@eienjs/adonisjs-sentry/providers/sentry_provider");
 	});
 }
-
 //#endregion
-export { configure };
+export { configure };

package/build/index.d.ts

@@ -0,0 +1,5 @@
+import { configure } from "./configure.js";
+import { defineConfig } from "./src/define_config.js";
+import { Sentry } from "./src/sentry.js";
+import { stubsRoot } from "./stubs/main.js";
+export { Sentry, configure, defineConfig, stubsRoot };

package/build/index.js

@@ -0,0 +1,5 @@
+import { stubsRoot } from "./stubs/main.js";
+import { configure } from "./configure.js";
+import { defineConfig } from "./src/define_config.js";
+import { Sentry } from "./src/sentry.js";
+export { Sentry, configure, defineConfig, stubsRoot };

package/build/{sentry_middleware.mjs → middleware/sentry_middleware.js}

@@ -1,5 +1,4 @@
-import { Sentry } from "./src/sentry.mjs";
-
+import { Sentry } from "../src/sentry.js";
 //#region src/middleware/sentry_middleware.ts
 var SentryMiddleware = class {
 	async handle(ctx, next) {
@@ -9,6 +8,5 @@ var SentryMiddleware = class {
 		return next();
 	}
 };
-
 //#endregion
-export { SentryMiddleware as default };
+export { SentryMiddleware as default };

package/build/{sentry_provider.mjs → providers/sentry_provider.js}

@@ -1,16 +1,16 @@
 //#region providers/sentry_provider.ts
 var SentryProvider = class {
+	app;
 	constructor(app) {
 		this.app = app;
 	}
 	async boot() {
 		const config = this.app.config.get("sentry", {});
 		if (config.enabled) {
-			const { Sentry } = await import("./src/sentry.mjs");
+			const { Sentry } = await import("../src/sentry.js");
 			Sentry.init(config);
 		}
 	}
 };
-
 //#endregion
-export { SentryProvider as default };
+export { SentryProvider as default };

package/build/src/{define_config.d.mts → define_config.d.ts}

@@ -1,4 +1,4 @@
-import { SentryConfig } from "../types.mjs";
+import { SentryConfig } from "../types.js";
 
 //#region src/define_config.d.ts
 declare function defineConfig(config: SentryConfig): SentryConfig;

package/build/src/{define_config.mjs → define_config.js}

@@ -1,10 +1,8 @@
 import { RuntimeException } from "@adonisjs/core/exceptions";
-
 //#region src/define_config.ts
 function defineConfig(config) {
 	if (!config.environment) throw new RuntimeException("Missing \"environment\" property in sentry config");
 	return config;
 }
-
 //#endregion
-export { defineConfig };
+export { defineConfig };

package/build/src/{sentry.mjs → sentry.js}

@@ -1,3 +1,2 @@
 import * as Sentry from "@sentry/node";
-
-export { Sentry };
+export { Sentry };

package/build/stubs/main.d.ts

@@ -0,0 +1,4 @@
+//#region stubs/main.d.ts
+declare const stubsRoot: string;
+//#endregion
+export { stubsRoot };

package/build/stubs/main.js

@@ -0,0 +1,4 @@
+//#region stubs/main.ts
+const stubsRoot = import.meta.dirname;
+//#endregion
+export { stubsRoot };

package/build/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eienjs/adonisjs-sentry",
   "type": "module",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Sentry service provider for AdonisJS",
   "author": "Fernando Isidro <luffynando@gmail.com>",
   "license": "MIT",
@@ -20,51 +20,49 @@
     "sentry"
   ],
   "exports": {
-    ".": "./build/index.mjs",
-    "./commands/verify_sentry_integration": "./build/commands/verify_sentry_integration.mjs",
-    "./sentry_middleware": "./build/sentry_middleware.mjs",
-    "./sentry_provider": "./build/sentry_provider.mjs",
-    "./types": "./build/types.mjs",
+    ".": "./build/index.js",
+    "./commands/verify_sentry_integration": "./build/commands/verify_sentry_integration.js",
+    "./middleware/sentry_middleware": "./build/middleware/sentry_middleware.js",
+    "./providers/sentry_provider": "./build/providers/sentry_provider.js",
+    "./types": "./build/types.js",
     "./package.json": "./package.json",
     "./commands": "./build/commands/main.js"
   },
-  "main": "./build/index.mjs",
-  "module": "./build/index.mjs",
-  "types": "./build/index.d.mts",
+  "types": "build/index.d.ts",
   "files": [
     "build"
   ],
   "engines": {
-    "node": ">=20.19"
+    "node": ">=24.0.0"
   },
   "peerDependencies": {
-    "@adonisjs/core": "^6.19.2"
+    "@adonisjs/core": "^7.3.4"
   },
   "dependencies": {
-    "@sentry/node": "^10.32.1"
+    "@sentry/node": "^10.62.0"
   },
   "devDependencies": {
-    "@adonisjs/assembler": "^7.8.2",
-    "@adonisjs/core": "^6.19.2",
-    "@adonisjs/tsconfig": "^1.4.1",
-    "@commitlint/cli": "^20.3.1",
-    "@commitlint/config-conventional": "^20.3.1",
-    "@eienjs/eslint-config": "^1.9.0",
+    "@adonisjs/assembler": "^8.4.0",
+    "@adonisjs/core": "^7.3.4",
+    "@adonisjs/eslint-plugin": "^2.2.2",
+    "@adonisjs/tsconfig": "^2.0.0",
+    "@commitlint/cli": "^21.1.0",
+    "@commitlint/config-conventional": "^21.1.0",
+    "@eienjs/eslint-config": "^2.1.2",
     "@japa/assert": "^4.2.0",
     "@japa/file-system": "^3.0.0",
-    "@japa/runner": "^5.2.0",
-    "@swc/core": "^1.15.8",
-    "@types/node": "^24.10.4",
-    "auto-changelog": "^2.5.0",
-    "c8": "^10.1.3",
-    "eslint": "^9.39.2",
-    "eslint-plugin-erasable-syntax-only": "^0.4.0",
+    "@japa/runner": "^5.3.0",
+    "@types/node": "^24.13.2",
+    "auto-changelog": "^2.6.0",
+    "c8": "^11.0.0",
+    "eslint": "^10.6.0",
+    "eslint-plugin-erasable-syntax-only": "^0.4.2",
     "husky": "^9.1.7",
     "is-in-ci": "^2.0.0",
-    "np": "^10.2.0",
-    "ts-node-maintained": "^10.9.6",
-    "tsdown": "^0.18.4",
-    "typescript": "^5.9.3"
+    "release-it": "^20.2.1",
+    "tsdown": "^0.22.3",
+    "tsdown-stale-guard": "^0.1.2",
+    "typescript": "^6.0.3"
   },
   "c8": {
     "reporter": [
@@ -72,6 +70,7 @@
       "lcov"
     ],
     "exclude": [
+      "bin/**",
       "tests/**"
     ]
   },
@@ -86,28 +85,53 @@
   },
   "auto-changelog": {
     "template": "keepachangelog",
-    "hideCredit": true
+    "hideCredit": true,
+    "commitLimit": false
   },
-  "np": {
-    "message": "chore(release): :tada: %s",
-    "tag": "latest",
-    "branch": "main",
-    "testScript": "test"
+  "release-it": {
+    "git": {
+      "commit": true,
+      "tag": true,
+      "push": true,
+      "requireCleanWorkingDir": true,
+      "commitMessage": "chore(release): :tada: v${version}",
+      "tagAnnotation": "chore(release): :tada: v${version}"
+    },
+    "github": {
+      "release": true,
+      "web": true,
+      "releaseName": "Release v${version}"
+    },
+    "npm": {
+      "publish": true,
+      "publishPackageManager": "pnpm",
+      "publishArgs": [
+        "--no-git-checks"
+      ]
+    },
+    "hooks": {
+      "before:init": [
+        "pnpm run lint:check",
+        "pnpm run typecheck"
+      ],
+      "after:bump": [
+        "pnpm run build",
+        "pnpm run changelog"
+      ]
+    }
   },
   "scripts": {
-    "changelog": "auto-changelog -p && git add CHANGELOG.md",
+    "changelog": "auto-changelog -u -p",
+    "commitlint": "commitlint --edit",
     "index:commands": "adonis-kit index build/commands",
     "lint": "eslint . --fix",
     "lint:check": "eslint .",
     "typecheck": "tsc --noEmit",
-    "test": "node --import ts-node-maintained/register/esm --enable-source-maps bin/test.ts",
+    "test": "node --import=@poppinss/ts-exec --enable-source-maps bin/test.ts",
     "test:coverage": "c8 pnpm run test",
     "tool:code": "pnpm run lint:check && pnpm run typecheck",
     "tool:build": "pnpm run tool:code && pnpm run test",
-    "prebuild": "pnpm run tool:code",
-    "build": "tsdown --clean --dts",
-    "postbuild": "pnpm run index:commands",
-    "release": "np",
-    "version": "pnpm run build && pnpm run changelog"
+    "build": "tsdown && pnpm run index:commands",
+    "release": "release-it"
   }
 }

package/build/index.d.mts

@@ -1,5 +0,0 @@
-import { configure } from "./configure.mjs";
-import { defineConfig } from "./src/define_config.mjs";
-import { Sentry } from "./src/sentry.mjs";
-import { stubsRoot } from "./stubs/main.mjs";
-export { Sentry, configure, defineConfig, stubsRoot };

package/build/index.mjs

@@ -1,6 +0,0 @@
-import { stubsRoot } from "./stubs/main.mjs";
-import { configure } from "./configure.mjs";
-import { defineConfig } from "./src/define_config.mjs";
-import { Sentry } from "./src/sentry.mjs";
-
-export { Sentry, configure, defineConfig, stubsRoot };

package/build/stubs/main.d.mts

@@ -1,8 +0,0 @@
-//#region stubs/main.d.ts
-/**
- * Path to the root directory where the stubs are stored. We use
- * this path within commands and the configure hook
- */
-declare const stubsRoot: string;
-//#endregion
-export { stubsRoot };

package/build/stubs/main.mjs

@@ -1,12 +0,0 @@
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-
-//#region stubs/main.ts
-/**
-* Path to the root directory where the stubs are stored. We use
-* this path within commands and the configure hook
-*/
-const stubsRoot = path.dirname(fileURLToPath(import.meta.url));
-
-//#endregion
-export { stubsRoot };

package/build/types.mjs

@@ -1 +0,0 @@
-export {  };