@elysiumjs/plugin-sentry 0.1.2 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # @elysiumjs/plugin-sentry
 
+## 0.2.0
+
+### Minor Changes
+
+- [`8ac91ab`](https://github.com/na2axl/elysiumjs/commit/8ac91ab676b1119b4eecf0ddb3fd0a3e84017cac) Thanks [@na2axl](https://github.com/na2axl)! - Upgrade dependencies to their latest major versions: wampy 8, zod 4, commander 15, @casl/ability 7, OpenTelemetry SDK 2 (sdk-node 0.300, resources 3), @sentry/bun 11. Generated projects now use TypeScript 7.
+
+  Breaking in `@elysiumjs/mnemosyne-drizzle`: it now requires drizzle-orm 1.0 (release candidate) and generated projects use drizzle-kit 1.0. `ColumnsWithTable` is no longer re-exported. `migration:generate` writes 1.0 migration folders (`<timestamp>_<name>/migration.sql`), and `migration:run` tracks those by folder name while still running flat `*.sql` files. Existing projects can upgrade their migrations folder with `drizzle-kit up`: `migration:run` recognises the moved migrations as already applied and renames their records. The `make:model` stub now generates a `pgTable` and a `DrizzleModel` built from it.
+
+  Breaking in `@elysiumjs/core`: the deprecated `@elysiajs/swagger` plugin is replaced by `@elysiajs/openapi`, and the app option `swagger` is renamed `openapi` (typed `ElysiaOpenAPIConfig | false`). Without a `path`, the docs now live at `/openapi` instead of `/swagger`. The UI options `scalarConfig` and `swaggerOptions` are now `scalar` and `swagger`. Elysia stays on 1.4 (now `^1.4.30`) until Elysia 2 and its OpenAPI plugin are stable.
+
+  Also in `@elysiumjs/core`: the WAMP `onChallenge` callback must return a string (or a promise of one); `null` is no longer accepted. `onError` now receives the error and `onReconnectSuccess` receives wampy's details object. `WampClient` is now wampy's own `Wampy` type. `onOpen` is called by Elysium once the connection is established, since wampy 8 no longer has that callback.
+
+- [`07236b3`](https://github.com/na2axl/elysiumjs/commit/07236b386c2506590d74e8753ce847c1e184b3ee) Thanks [@na2axl](https://github.com/na2axl)! - Introduce the module system. Modules are now the only way to register anything in an Elysium.js app. This is a breaking change with no compatibility layer.
+
+  Breaking changes:
+
+  - `@Module.register()` takes `imports`, `services`, `exports`, `controllers`, `commands`, `jobs`, `prefix` and `env`. Services are private to their module unless exported (or global). The `beforeRegister` and `afterRegister` hooks are replaced by `onInit`, `onServe` and `onDestroy`.
+  - Configurable modules are bound with `with()`, for example `HermesModule.with({ level: 'debug' })`. `with()` accepts an object or a function.
+  - Decorators only record metadata. Importing a file no longer registers commands, services or event wiring, and the side-effect imports of the packages are removed. List commands, jobs and services in the module that owns them.
+  - `@Application.register()` no longer takes `database`, `redis`, `wamp` or `'elysium:hermes'`/`'elysium:cerberus'` keys. Use `DrizzleModule`, `RedisModule`, `WampModule`, `HermesModule` and `CerberusModule`. Package plugins are replaced by modules: add `SentryModule` instead of the `plugin()` function. `plugins` still accepts plain Elysia plugin factories.
+  - Constructing an `Application` no longer runs it. Use `await App.start()`; `Application.testing()` boots a module graph for tests. The `styx` binary loads `src/app.ts` (or `index.ts`) and starts the exported application, so a project entry no longer needs to import commands.
+  - The job system of core (`Job`, `Worker`, `WorkerPool`, `commandWork`) is removed. `@elysiumjs/heracles` is the only job system: extend its `Job`, list jobs in a module's `jobs`, declare queues with `HeraclesModule.with({ queues })`, and dispatch with `Heracles.dispatch()`.
+  - `@elysiumjs/styx` ships `StyxModule`, active in development only. The `migration:generate` and `migration:run` commands move to `DrizzleModule` and are available in production.
+  - `@elysiumjs/mnemosyne` ships `MnemosyneModule` for its caches (`redis: false` or `memory: false` opts out). `DrizzleModule` imports it.
+  - New modules: `HephaestusModule`, `ArgusModule` (`serviceName` is required), `SentryModule` (needs a `dsn` or `SENTRY_DSN`) and `CerberusModule` (`getSubject` is required).
+  - Module and service code throws typed errors (for example `InvalidModuleConfigError`) instead of exiting the process. `Application.run()` prints them and exits; command `run()` methods may still exit, and package plugin factories are unchanged.
+  - `Application.register` merges subclass props over the parent's (own props, then own metadata, then parent, then defaults), and concatenates `modules` parent first. Previously defaults and parent values won, so `openapi` could not be enabled.
+  - `Heracles.dispatch` starts a stopped queue on first use, so producers no longer start queues. `Queue.start()` is idempotent.
+  - `create-elysium` generates apps that use modules, and adds Sentry and Hephaestus to the `modules` list.
+  - `@Event.on`/`@Event.once` method listeners on classes in a loaded module's `services` or `controllers` are wired by the kernel and run in their module's context. Jobs, commands and middlewares are not wired, and an instance listener on a class that is not a service throws `EventListenerNotSupportedError`. Listeners on classes not listed in a loaded module no longer fire.
+  - New typed errors: `CircularDependencyError` (services that depend on each other, in sync and async resolution), `DuplicateModuleNameError` (two different module classes sharing a name; module scopes and config tokens are name based) and `EventListenerNotSupportedError`.
+  - Lazy boot contract: a CLI command initialises only its own module and that module's imports. Sync helpers such as `Database.getConnection()` work when the owning module's `onInit` is synchronous; otherwise they throw `ServiceNotReadyError` naming the module. Use `await Service.resolve()` or set `static boot = true` on the command.
+
+### Patch Changes
+
+- Updated dependencies [[`8ac91ab`](https://github.com/na2axl/elysiumjs/commit/8ac91ab676b1119b4eecf0ddb3fd0a3e84017cac), [`3625883`](https://github.com/na2axl/elysiumjs/commit/3625883dba92f1596e7444ee52f9399d8e9b049f), [`07236b3`](https://github.com/na2axl/elysiumjs/commit/07236b386c2506590d74e8753ce847c1e184b3ee)]:
+  - @elysiumjs/core@0.8.0
+
 ## 0.1.1
 
 ### Patch Changes

package/README.md

@@ -10,26 +10,29 @@ bun add @elysiumjs/plugin-sentry
 
 ## Usage
 
+Add `SentryModule` to your application:
+
 ```ts
 import { Application } from '@elysiumjs/core';
-import { plugin as sentry } from '@elysiumjs/plugin-sentry';
+import { SentryModule } from '@elysiumjs/plugin-sentry';
 
 @Application.register({
-	// Your other app options
-	plugins: [
-		sentry({
+	modules: [
+		SentryModule.with({
 			serverName: 'my-app',
 			dsn: 'https://<key>@sentry.io/<project>'
 		})
-		// Your other plugins
+		// Your other modules
 	]
 })
 class MyApp extends Application {}
 ```
 
+The `dsn` can also come from the `SENTRY_DSN` environment variable. Boot fails when neither is set.
+
 ## Configuration
 
-This plugin forwards all options to the Sentry initialization method. You can find the full list of options [here](https://docs.sentry.io/platforms/javascript/guides/bun/configuration/options/).
+The module forwards all options to the Sentry initialization method. You can find the full list of options [here](https://docs.sentry.io/platforms/javascript/guides/bun/configuration/options/).
 
 ## License
 

package/dist/index.d.ts

@@ -1,8 +1,2 @@
-import type { ElysiumPlugin } from '@elysiumjs/core';
-import * as Sentry from '@sentry/bun';
-/**
- * Elysium plugin for Sentry integration.
- * @author Axel Nana <axel.nana@workbud.com>
- * @param options Plugin options.
- */
-export declare const plugin: (options?: Sentry.BunOptions) => ElysiumPlugin;
+export { plugin } from './plugin';
+export { SentryModule } from './sentry.module';

package/dist/index.js

@@ -1,2 +1,2 @@
 // @bun
-import{opentelemetry as A}from"@elysiajs/opentelemetry";import{Env as w}from"@elysiumjs/core";import*as f from"@sentry/bun";import{Elysia as B}from"elysia";var R=(g)=>{return async(C)=>{let h=g?.dsn??w.get("SENTRY_DSN");if(!h)throw Error("Must provide a DSN");let z=g?.environment??w.get("SENTRY_ENVIRONMENT");return f.init({dsn:h,environment:z,tracesSampleRate:1,integrations:[f.bunServerIntegration(),f.onUnhandledRejectionIntegration({mode:"warn"}),f.onUncaughtExceptionIntegration()],...g}),new B({name:"@elysiumjs/plugin-sentry"}).decorate("Sentry",f).use(A({serviceName:g?.serverName})).onError({as:"global"},({error:k,Sentry:q})=>{q.captureException(k)}).onAfterResponse({as:"global"},function({body:q,cookie:D,params:F,request:G,response:H,route:I,server:J,store:K,headers:L,path:M,query:N}){})}};export{R as plugin};
+var __legacyDecorateClassTS=function(decorators,target,key,desc){var c=arguments.length,r=c<3?target:desc===null?desc=Object.getOwnPropertyDescriptor(target,key):desc,d;if(typeof Reflect==="object"&&typeof Reflect.decorate==="function")r=Reflect.decorate(decorators,target,key,desc);else for(var i=decorators.length-1;i>=0;i--)if(d=decorators[i])r=(c<3?d(r):c>3?d(target,key,r):d(target,key))||r;return c>3&&r&&Object.defineProperty(target,key,r),r};import{opentelemetry}from"@elysiajs/opentelemetry";import{Env}from"@elysiumjs/core";import*as Sentry from"@sentry/bun";import{Elysia}from"elysia";var plugin=(options)=>async(_app)=>{let dsn=options?.dsn??Env.get("SENTRY_DSN");if(!dsn)throw Error("Must provide a DSN");let environment=options?.environment??Env.get("SENTRY_ENVIRONMENT");return Sentry.init({dsn,environment,tracesSampleRate:1,integrations:[Sentry.bunServerIntegration(),Sentry.onUnhandledRejectionIntegration({mode:"warn"}),Sentry.onUncaughtExceptionIntegration()],...options}),new Elysia({name:"@elysiumjs/plugin-sentry"}).decorate("Sentry",Sentry).use(opentelemetry({serviceName:options?.serverName})).onError({as:"global"},({error,Sentry})=>{Sentry.captureException(error)}).onAfterResponse({as:"global"},function({body,cookie,params,request,response,route,server,store,headers,path,query}){})};import{Application,Env as Env2,MissingModuleConfigError,Module}from"@elysiumjs/core";class SentryModule extends Module.configurable(){onInit(){if(!this.config.dsn&&!Env2.get("SENTRY_DSN"))throw new MissingModuleConfigError(SentryModule.name,["dsn (or SENTRY_DSN)"])}async onServe(app){app.use(await plugin(this.config)(Application.instance))}}SentryModule=__legacyDecorateClassTS([Module.register({})],SentryModule);export{SentryModule,plugin};

package/dist/plugin.d.ts

@@ -0,0 +1,8 @@
+import type { ElysiumPlugin } from '@elysiumjs/core';
+import * as Sentry from '@sentry/bun';
+/**
+ * Elysium plugin for Sentry integration.
+ * @author Axel Nana <axel.nana@workbud.com>
+ * @param options Plugin options.
+ */
+export declare const plugin: (options?: Sentry.BunOptions) => ElysiumPlugin;

package/dist/sentry.module.d.ts

@@ -0,0 +1,27 @@
+import type * as Sentry from '@sentry/bun';
+import { Module } from '@elysiumjs/core';
+declare const SentryModule_base: (abstract new () => {
+    readonly config: Sentry.BunOptions;
+    onInit(): Promise<void> | void;
+    onDestroy(): Promise<void> | void;
+    onServe(_app: import("elysia").default<any>): Promise<void> | void;
+}) & {
+    readonly config: string;
+    with(config: Partial<Sentry.BunOptions> | (() => Partial<Sentry.BunOptions> | Promise<Partial<Sentry.BunOptions>>)): import("@elysiumjs/core").ConfiguredModule<Sentry.BunOptions>;
+    resolveConfig(input?: Partial<Sentry.BunOptions> | undefined): Sentry.BunOptions;
+    register<TConfig_1 = any>(props?: import("@elysiumjs/core").ModuleProps<TConfig_1>): (target: import("@elysiumjs/core").ModuleClass) => void;
+    configurable<TConfig extends object>(options?: {
+        defaults?: Partial<TConfig>;
+        required?: (keyof TConfig)[];
+    }): any;
+};
+/**
+ * Configurable module that installs the Sentry plugin on the root app when serving.
+ * `dsn` may come from the config or from `SENTRY_DSN`; boot fails when neither is set.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export declare class SentryModule extends SentryModule_base {
+    onInit(): void;
+    onServe(app: Parameters<Module['onServe']>[0]): Promise<void>;
+}
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elysiumjs/plugin-sentry",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "license": "Apache-2.0",
   "description": "Sentry error reporting plugin for the Elysium.js framework.",
   "private": false,
@@ -16,7 +16,7 @@
   "scripts": {
     "format": "prettier --write \"./src/**/*.ts\"",
     "clean": "rimraf dist",
-    "build:js": "bun build ./src/index.ts --outdir ./dist --target bun --packages external --root ./src --minify",
+    "build:js": "bun build ./src/index.ts --outdir ./dist --target bun --packages external --root ./src --minify-syntax --minify-whitespace",
     "build:ts": "tsc",
     "build": "bun run clean && bun run build:js && bun run build:ts",
     "typecheck": "tsc --noEmit",
@@ -36,13 +36,13 @@
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
   "devDependencies": {
-    "@elysiumjs/core": "0.6.1"
+    "@elysiumjs/core": "0.8.0"
   },
   "peerDependencies": {
-    "@elysiumjs/core": "^0.6.1"
+    "@elysiumjs/core": "^0.8.0"
   },
   "dependencies": {
-    "@elysiajs/opentelemetry": "^1.4.0",
-    "@sentry/bun": "^10.17.0"
+    "@elysiajs/opentelemetry": "^1.4.11",
+    "@sentry/bun": "^11.9.0"
   }
 }

package/src/index.ts

@@ -1,4 +1,4 @@
-// Copyright (c) 2025-present Workbud Technologies Inc. All rights reserved.
+// Copyright (c) 2026-present Workbud Technologies Inc. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -12,74 +12,5 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import type { Application, ElysiumPlugin } from '@elysiumjs/core';
-
-import { opentelemetry } from '@elysiajs/opentelemetry';
-import { Env } from '@elysiumjs/core';
-import * as Sentry from '@sentry/bun';
-import { Elysia } from 'elysia';
-
-/**
- * Elysium plugin for Sentry integration.
- * @author Axel Nana <axel.nana@workbud.com>
- * @param options Plugin options.
- */
-export const plugin = (options?: Sentry.BunOptions): ElysiumPlugin => {
-	return async (_app: Application) => {
-		const dsn = options?.dsn ?? Env.get('SENTRY_DSN');
-		if (!dsn) {
-			throw new Error('Must provide a DSN');
-		}
-
-		const environment = options?.environment ?? Env.get('SENTRY_ENVIRONMENT');
-
-		Sentry.init({
-			dsn,
-			environment,
-			tracesSampleRate: 1.0,
-			integrations: [
-				Sentry.bunServerIntegration(),
-				Sentry.onUnhandledRejectionIntegration({
-					mode: 'warn'
-				}),
-				Sentry.onUncaughtExceptionIntegration()
-			],
-			...options
-		});
-
-		return (
-			new Elysia({
-				name: '@elysiumjs/plugin-sentry'
-			})
-				.decorate('Sentry', Sentry)
-				.use(
-					opentelemetry({
-						serviceName: options?.serverName
-					})
-				)
-				// Capture exceptions
-				.onError({ as: 'global' }, ({ error, Sentry }) => {
-					Sentry.captureException(error);
-				})
-				// Need this to inject attributes into the span
-				// https://github.com/elysiajs/opentelemetry/issues/40
-				.onAfterResponse(
-					{ as: 'global' },
-					// @ts-expect-error Unused parameters
-					function injectAttributes({
-						body,
-						cookie,
-						params,
-						request,
-						response,
-						route,
-						server,
-						store,
-						headers,
-						path,
-						query
-					}) {}
-				)
-		);
-	};
-};
+export { plugin } from './plugin';
+export { SentryModule } from './sentry.module';

package/src/plugin.ts

@@ -0,0 +1,85 @@
+// Copyright (c) 2025-present Workbud Technologies Inc. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import type { Application, ElysiumPlugin } from '@elysiumjs/core';
+
+import { opentelemetry } from '@elysiajs/opentelemetry';
+import { Env } from '@elysiumjs/core';
+import * as Sentry from '@sentry/bun';
+import { Elysia } from 'elysia';
+
+/**
+ * Elysium plugin for Sentry integration.
+ * @author Axel Nana <axel.nana@workbud.com>
+ * @param options Plugin options.
+ */
+export const plugin = (options?: Sentry.BunOptions): ElysiumPlugin => {
+	return async (_app: Application) => {
+		const dsn = options?.dsn ?? Env.get('SENTRY_DSN');
+		if (!dsn) {
+			throw new Error('Must provide a DSN');
+		}
+
+		const environment = options?.environment ?? Env.get('SENTRY_ENVIRONMENT');
+
+		Sentry.init({
+			dsn,
+			environment,
+			tracesSampleRate: 1.0,
+			integrations: [
+				Sentry.bunServerIntegration(),
+				Sentry.onUnhandledRejectionIntegration({
+					mode: 'warn'
+				}),
+				Sentry.onUncaughtExceptionIntegration()
+			],
+			...options
+		});
+
+		return (
+			new Elysia({
+				name: '@elysiumjs/plugin-sentry'
+			})
+				.decorate('Sentry', Sentry)
+				.use(
+					opentelemetry({
+						serviceName: options?.serverName
+					})
+				)
+				// Capture exceptions
+				.onError({ as: 'global' }, ({ error, Sentry }) => {
+					Sentry.captureException(error);
+				})
+				// Need this to inject attributes into the span
+				// https://github.com/elysiajs/opentelemetry/issues/40
+				.onAfterResponse(
+					{ as: 'global' },
+					// @ts-expect-error Unused parameters
+					function injectAttributes({
+						body,
+						cookie,
+						params,
+						request,
+						response,
+						route,
+						server,
+						store,
+						headers,
+						path,
+						query
+					}) {}
+				)
+		);
+	};
+};

package/src/sentry.module.ts

@@ -0,0 +1,37 @@
+// Copyright (c) 2026-present Workbud Technologies Inc. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import type * as Sentry from '@sentry/bun';
+
+import { Application, Env, MissingModuleConfigError, Module } from '@elysiumjs/core';
+
+import { plugin } from './plugin';
+
+/**
+ * Configurable module that installs the Sentry plugin on the root app when serving.
+ * `dsn` may come from the config or from `SENTRY_DSN`; boot fails when neither is set.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+@Module.register({})
+export class SentryModule extends Module.configurable<Sentry.BunOptions>() {
+	public override onInit(): void {
+		if (!this.config.dsn && !Env.get('SENTRY_DSN')) {
+			throw new MissingModuleConfigError(SentryModule.name, ['dsn (or SENTRY_DSN)']);
+		}
+	}
+
+	public override async onServe(app: Parameters<Module['onServe']>[0]): Promise<void> {
+		app.use(await plugin(this.config)(Application.instance));
+	}
+}