@elysiumjs/hermes 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,77 @@
 # @elysiumjs/hermes
 
+## 0.5.0
+
+### Minor Changes
+
+- [#11](https://github.com/na2axl/elysiumjs/pull/11) [`632d77b`](https://github.com/na2axl/elysiumjs/commit/632d77b561fc43ade605fb69b06ac1b9b9a2ffc4) Thanks [@na2axl](https://github.com/na2axl)! - Services are identified by their class, or by the name given to `@Service.register({ name })`. Class names are never used as identifiers, so services resolve the same way in minified builds; `bun run check:minified` in core bundles a minified app and checks that every service resolves. `@Service.inject()` without an argument injects the class of the parameter type, and throws when the type is unknown. Factory services in a module's `services` take a class or a name in `name`.
+
+  `ServiceScope.REQUEST` gives one instance per HTTP request, shared by the request's middlewares, controller and handler. `Service.runInRequestScope(fn)` opens a request scope outside a route. Resolving a request-scoped service outside a request throws `OutsideRequestScopeError`, and a singleton (or a server-scoped controller) depending on one throws `ScopeMismatchError`.
+
+  `HermesModule` registers the logger by the `HermesLogger` class and as `logger`.
+
+- [#16](https://github.com/na2axl/elysiumjs/pull/16) [`ac96e55`](https://github.com/na2axl/elysiumjs/commit/ac96e55874b0ffe350b287c4278cd85afecb7576) Thanks [@na2axl](https://github.com/na2axl)! - Redis, databases, logs, jobs and builds on Bun, Node.js and Cloudflare Workers.
+
+  Breaking:
+
+  - The level shortcuts of `InteractsWithConsole` (`info`, `success`, `warning`, `error` and `debug`) write a tag (`[I]`, `[S]`, `[W]`, `[E]` and `[D]`, in color) before the message, which `InteractsWithConsole.useTags()` changes. `trace()` writes to stderr.
+  - Outside Bun, a Drizzle connection needs a `driver`. Without one, the `connection` and `client` props are a Bun SQL connection, which is only available on Bun; elsewhere the connection throws `MissingDriverError`, which names the drivers.
+
+  Added:
+
+  - Redis adapters (`@elysiumjs/redis`): `ioredis(create)` plugs an ioredis client into the Redis port on Node.js, and `upstash({ token, url?, fetch? })` talks to Upstash over its REST API, for Workers (no pub/sub). `bunRedis` explains which adapter to use when it runs outside Bun.
+  - Drizzle drivers (`@elysiumjs/mnemosyne-drizzle`): a `DrizzleDriver` port set with the `driver` prop of a connection, and drivers on subpaths so that only the chosen database client is imported: `/bun-sql` (`bunSql()`), `/postgres-js` (`postgresJs()`), `/node-postgres` (`nodePostgres()`) and `/hyperdrive` (`hyperdrive({ binding, driver })`, a client per Worker invocation over a Cloudflare Hyperdrive binding). `DrizzleModule` closes connections through their driver, and `migration:run` runs on any driver.
+  - `InteractsWithConsole.write()` and `Runtime.write()` take the level of the line (`OutputLevel`), which the level shortcuts pass. On Cloudflare Workers, a line is written with the console method of its level, so Workers Logs keep it.
+  - `JsonConsoleLogger` (`@elysiumjs/hermes`): JSON lines through the console of the runtime (warnings and errors on stderr), with levels, error serialization and `child()`. `HermesModule.with({ transport: 'console' | 'pino' })` picks it, and it is the default on Workers. `RequestLogInterceptor` writes one structured line per request: method, route, status, duration, client address and request id.
+  - Scheduled jobs (`@elysiumjs/heracles`): `@Schedule(cron, { timezone, args })` on a job class, a five-field cron parser (`Cron`, with lists, ranges, steps and names), and a `Scheduler` that dispatches the jobs on time on Bun and Node.js, taking a Redis lock per tick when a Redis connection is set. The `heracles:schedule` command runs it.
+  - `@elysiumjs/heracles-workers`: `CloudflareQueueTransport` sends jobs to a Cloudflare Queue (dispatch delays become `delaySeconds`), and `HeraclesWorkersModule` consumes them in the Worker's `queue` handler (ack on success, retry with a delay up to the job's retries) and dispatches the `@Schedule()` jobs whose expression is the cron of a trigger.
+  - Queue handlers (`@elysiumjs/runtime-workers`) can settle a message themselves with `ack()` or `retry({ delaySeconds })`; the messages they leave are acked when no handler failed on them.
+  - `styx build --target node` (`@elysiumjs/hephaestus`) bundles the app into one ES module for Node.js, with decorator metadata emitted at build time, run with `node dist/server.js serve`. `styx build --target workers` runs from the CLI, resolves packages to their browser entry, and leaves Node.js modules imported by bare names to workerd (`nodejs_compat`).
+  - `styx create` (`@elysiumjs/styx`) takes `--runtime bun|node|workers`, `--database`, `--cache` and `--package-manager bun|npm|pnpm`. Each runtime gets its entry, tsconfig types, scripts and drivers: postgres.js and ioredis on Node.js; Hyperdrive, Upstash, console logs and a `wrangler.jsonc` on Workers.
+
+### Patch Changes
+
+- Updated dependencies [[`6bc48fe`](https://github.com/na2axl/elysiumjs/commit/6bc48febd51f7090c582e73f349eaeff7261241c), [`e9c3d98`](https://github.com/na2axl/elysiumjs/commit/e9c3d98dd2714b69100215f7c8a80046da463148), [`557a3ca`](https://github.com/na2axl/elysiumjs/commit/557a3cab7af8053a8bab9944e492e5022d91aa82), [`ccc3f5b`](https://github.com/na2axl/elysiumjs/commit/ccc3f5bb904d1bf52d8c72ebf7ea8d10f617a8c4), [`6789879`](https://github.com/na2axl/elysiumjs/commit/678987976ecfd46b534b65276e0de3f448977562), [`87299fd`](https://github.com/na2axl/elysiumjs/commit/87299fd9da82d1a408ced1891c0c3d42991444e5), [`bee66bd`](https://github.com/na2axl/elysiumjs/commit/bee66bdc874b8f23fea356f7d3adf7555a48ca64), [`0057b67`](https://github.com/na2axl/elysiumjs/commit/0057b67df0e3abecab8a9accff6b55a6a64c21df), [`632d77b`](https://github.com/na2axl/elysiumjs/commit/632d77b561fc43ade605fb69b06ac1b9b9a2ffc4), [`1ea417e`](https://github.com/na2axl/elysiumjs/commit/1ea417e3583250bc2f975d795f398b7ff736115d), [`0956186`](https://github.com/na2axl/elysiumjs/commit/0956186db0ca5a83c0a6636aeb2a4c81a0033de4), [`fbcc7da`](https://github.com/na2axl/elysiumjs/commit/fbcc7dad127db29da42e7a4a5c2124966731cd88), [`ac96e55`](https://github.com/na2axl/elysiumjs/commit/ac96e55874b0ffe350b287c4278cd85afecb7576), [`98a16aa`](https://github.com/na2axl/elysiumjs/commit/98a16aae889d46f7a9fb5573188f4cbe3629dd3b)]:
+  - @elysiumjs/core@0.11.0
+
+## 0.4.3
+
+### Patch Changes
+
+- [`04773f2`](https://github.com/na2axl/elysiumjs/commit/04773f2acd4ab1c762a80ee903715d90f1c08e21) Thanks [@na2axl](https://github.com/na2axl)! - Ship the type declarations. The packages pointed `types` at `dist/index.d.ts` but their build never wrote it, so TypeScript projects got no types for them.
+
+## 0.4.2
+
+### Patch Changes
+
+- [`68a0cdd`](https://github.com/na2axl/elysiumjs/commit/68a0cdd8b2e4a003d6e0af2d78985623cae40428) Thanks [@na2axl](https://github.com/na2axl)! - Route the framework's own diagnostics through the logger service.
+
+  Breaking changes:
+
+  - `@Event.listen()` with a mode other than `on` or `once` now throws an `ElysiumError` when the class is defined, instead of logging to the console and ignoring the listener.
+
+  Fixes and additions:
+
+  - `getLogger(context?)` and `LOGGER_SERVICE` (`'logger'`) are exported by `@elysiumjs/core`. `getLogger()` returns the `logger` service when one is registered (such as the one `HermesModule` provides), and a `ConsoleLogger` otherwise or when the service cannot be built or fails to create a child logger. It is resolved at call time from the global scope only, so a module's own `logger` service does not replace it, and returns a child logger bound to `context` when one is given.
+  - `Middleware.logger` (used by `RequestLoggerMiddleware`) falls back to a `ConsoleLogger` when no `logger` service is registered. It threw before.
+  - Core diagnostics go through the logger with structured context instead of `console.*`: the debug-mode request log (`debug`, with `method` and `url`), `onDestroy` failures on shutdown (`error`, with `target` and `error`), WAMP connection attempts (`warn` while retrying, `error` when giving up, with `connection`, `attempt`/`attempts`, `maxRetries` and `error`), and WAMP registrations and subscriptions (`info`, with `connection`, `topic` and the registration or subscription id).
+  - In debug mode, incoming requests are logged through the logger at `debug` level instead of printed with `console.log`. With `HermesModule`, they show only when its `level` is `debug` or `trace`.
+  - A failed WAMP registration or subscription is logged at `error` level and emitted as `elysium:error` with an error naming the topic and the connection, instead of becoming an unhandled rejection.
+  - The `elysium:error` emitted for a WAMP client error names the connection and its URL and includes the client's message (or the value it reported, when it is not an `Error`), with that value as `cause` when there is one.
+  - `HermesLogger` serialises an `error` field of the log context like pino's `err` (type, message and stack), so logged errors keep their stack trace. Elysium logs errors under `error`.
+  - `@Logged` resolves its fallback logger with `getLogger()`, and logs a thrown error whole under `error` (it logged only its message), so its stack trace is kept.
+  - The `elysium:error` emitted when a WAMP connection gives up states the number of attempts actually made (the first one plus the retries), as the logged `attempts` does. It stated `maxRetries` before.
+
+- Updated dependencies [[`68a0cdd`](https://github.com/na2axl/elysiumjs/commit/68a0cdd8b2e4a003d6e0af2d78985623cae40428), [`2c49acd`](https://github.com/na2axl/elysiumjs/commit/2c49acd3b552aa43765d70339fa216961499e1b5), [`76ba0ff`](https://github.com/na2axl/elysiumjs/commit/76ba0ff18f3c196cebc2189426328f67cb699f46), [`4ebf029`](https://github.com/na2axl/elysiumjs/commit/4ebf029611e6d753a4f1bfdbe247a75d954d9ded), [`bacce71`](https://github.com/na2axl/elysiumjs/commit/bacce7146f667a1a46bf474dc0344fb0111ae12a)]:
+  - @elysiumjs/core@0.10.0
+
+## 0.4.1
+
+### Patch Changes
+
+- Updated dependencies [[`5fef4a7`](https://github.com/na2axl/elysiumjs/commit/5fef4a7199f502fc4fe035299e7670739459a108)]:
+  - @elysiumjs/core@0.9.0
+
 ## 0.4.0
 
 ### Minor Changes

package/README.md

@@ -10,7 +10,7 @@ bun add @elysiumjs/hermes
 
 ## Usage
 
-Add `HermesModule` to your application. It provides the logger as the global services `HermesLogger` and `logger`.
+Add `HermesModule` to your application. It provides the logger as global services, by the `HermesLogger` class and by the name `logger`.
 
 ```ts
 import { Application } from '@elysiumjs/core';

package/dist/decorators/logged.d.ts

@@ -0,0 +1,16 @@
+import type { LogLevel } from '../types';
+export interface LoggedOptions {
+    level?: LogLevel;
+    includeArgs?: boolean;
+    includeResult?: boolean;
+    includeTiming?: boolean;
+}
+/**
+ * Decorator that logs method entry/exit with optional timing.
+ *
+ * Logger is resolved at CALL TIME (not decorator definition time)
+ * to avoid capturing a stale logger reference.
+ *
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export declare function Logged(options?: LoggedOptions): MethodDecorator;

package/dist/hermes.module.d.ts

@@ -0,0 +1,25 @@
+import type { HermesConfig } from './types';
+declare const HermesModule_base: (abstract new () => {
+    readonly config: HermesConfig;
+    onInit(): Promise<void> | void;
+    onDestroy(): Promise<void> | void;
+    onServe(_app: import("elysia").Elysia<any>): Promise<void> | void;
+}) & {
+    readonly config: string;
+    with(config: Partial<HermesConfig> | (() => Partial<HermesConfig> | Promise<Partial<HermesConfig>>)): import("@elysiumjs/core").ConfiguredModule<HermesConfig>;
+    resolveConfig(input?: Partial<HermesConfig> | undefined): HermesConfig;
+    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;
+};
+/**
+ * Provides the {@link HermesLogger} as global services, by its class and as `logger`
+ * (the same instance), built from the module config. With `transport: 'console'` (the default
+ * on Cloudflare Workers), `logger` is a {@link JsonConsoleLogger} instead.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export declare class HermesModule extends HermesModule_base {
+}
+export {};

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export { HermesModule } from './hermes.module';
+export { RequestLogInterceptor } from './interceptors/request-log.interceptor';
+export { JsonConsoleLogger } from './services/json-console.logger';
+export { HermesLogger } from './services/logger.service';
+export { HttpTransport } from './transports/http.transport';
+export type { HttpTransportOptions } from './transports/http.transport';
+export { Logged } from './decorators/logged';
+export type { LoggedOptions } from './decorators/logged';
+export type { HermesConfig, LogLevel, LogFormat, TransportConfig } from './types';

package/dist/index.js

@@ -1,2 +1,2 @@
 // @bun
-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};var __require=import.meta.require;import{Module}from"@elysiumjs/core";import{Service}from"@elysiumjs/core";import pino from"pino";var DEFAULT_CONFIG={level:"info",format:"json"};class HermesLogger{pino;config;static make(name){return Service.get(HermesLogger)?.child({name})??new HermesLogger({name})}constructor(config={}){this.config={...DEFAULT_CONFIG,...config},this.pino=this.createPinoInstance()}createPinoInstance(){let options={level:this.config.level,name:this.config.name};if(this.config.format==="pretty")return pino(options,pino.transport({target:"pino-pretty"}));return pino(options)}trace(msg,ctx){this.pino.trace(ctx??{},msg)}debug(msg,ctx){this.pino.debug(ctx??{},msg)}info(msg,ctx){this.pino.info(ctx??{},msg)}warn(msg,ctx){this.pino.warn(ctx??{},msg)}error(msg,ctx){this.pino.error(ctx??{},msg)}fatal(msg,ctx){this.pino.fatal(ctx??{},msg)}flush(){this.pino.flush?.()}onDestroy(){this.flush()}child(ctx){let child=Object.create(this);return child.pino=this.pino.child(ctx),child}}class HermesModule extends Module.configurable({defaults:{...DEFAULT_CONFIG}}){}HermesModule=__legacyDecorateClassTS([Module.register({services:(config)=>[{name:HermesLogger.name,global:!0,factory:()=>new HermesLogger(config)},{name:"logger",global:!0,factory:(_config,get)=>get(HermesLogger.name)}]})],HermesModule);class HttpTransport{options;buffer=[];flushTimer;maxBufferSize;constructor(options){this.options=options;this.options.batchSize??=100,this.options.flushInterval??=5000,this.maxBufferSize=this.options.maxBufferSize??1e4,this.flushTimer=setInterval(()=>this.flush(),this.options.flushInterval)}write(formatted){if(this.buffer.length>=this.maxBufferSize)this.buffer.shift();if(this.buffer.push(formatted),this.buffer.length>=this.options.batchSize)this.flush()}async flush(){if(this.buffer.length===0)return;let batch=this.buffer.splice(0);try{await fetch(this.options.url,{method:"POST",headers:{"Content-Type":"application/json",...this.options.headers},body:JSON.stringify({logs:batch})})}catch{let space=this.maxBufferSize-this.buffer.length;if(space>0)this.buffer.unshift(...batch.slice(0,space))}}async close(){if(this.flushTimer)clearInterval(this.flushTimer);await this.flush()}}import{ConsoleLogger}from"@elysiumjs/core";function Logged(options={}){return function(target,propertyKey,descriptor){let original=descriptor.value,methodName=`${target.constructor.name}.${String(propertyKey)}`;return descriptor.value=async function(...args){let logger=this.logger??getServiceLogger(),startTime=Date.now();if(options.includeArgs)logger.debug(`[${methodName}] Entry`,{args});try{let result=await original.apply(this,args);if(options.includeResult||options.includeTiming){let duration=Date.now()-startTime;logger[options.level??"debug"](`[${methodName}] Exit`,{...options.includeResult&&{result},...options.includeTiming&&{duration:`${duration}ms`}})}return result}catch(error){let duration=Date.now()-startTime;throw logger.error(`[${methodName}] Error`,{error:error instanceof Error?error.message:error,duration:`${duration}ms`}),error}},descriptor}}function getServiceLogger(){try{let{Service}=__require("@elysiumjs/core");return Service.get("logger")??new ConsoleLogger}catch{return new ConsoleLogger}}export{HermesLogger,HermesModule,HttpTransport,Logged};
+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{LOGGER_SERVICE,Module}from"@elysiumjs/core";import{InteractsWithConsole}from"@elysiumjs/core";var DEFAULT_CONFIG={level:"info",format:"json"};var LEVELS={trace:10,debug:20,info:30,warn:40,error:50,fatal:60},serializable=(value)=>{if(value instanceof Error)return{type:value.name,message:value.message,stack:value.stack,...value.cause!==void 0?{cause:serializable(value.cause)}:{}};return value};class JsonConsoleLogger{#console=new InteractsWithConsole;#threshold;#bindings;constructor(config={},bindings={}){let level=config.level??DEFAULT_CONFIG.level;this.#threshold=LEVELS[level],this.#bindings={...config.name?{name:config.name}:{},...bindings},this.level=level}level;trace(msg,ctx){this.#write("trace",msg,ctx)}debug(msg,ctx){this.#write("debug",msg,ctx)}info(msg,ctx){this.#write("info",msg,ctx)}warn(msg,ctx){this.#write("warn",msg,ctx)}error(msg,ctx){this.#write("error",msg,ctx)}fatal(msg,ctx){this.#write("fatal",msg,ctx)}child(ctx){return new JsonConsoleLogger({level:this.level},{...this.#bindings,...ctx})}#write(level,msg,ctx){if(LEVELS[level]<this.#threshold)return;let entry={level:LEVELS[level],time:Date.now(),...this.#bindings};for(let[key,value]of Object.entries(ctx??{}))entry[key]=serializable(value);entry.msg=msg;let line;try{line=JSON.stringify(entry)}catch{line=JSON.stringify({level:entry.level,time:entry.time,msg,unserializable:!0})}this.#console.write(line,!0,LEVELS[level]>=LEVELS.warn?"stderr":"stdout",level)}}import{Service}from"@elysiumjs/core";import pino from"pino";class HermesLogger{pino;config;static make(name){return Service.get(HermesLogger)?.child({name})??new HermesLogger({name})}constructor(config={}){this.config={...DEFAULT_CONFIG,...config},this.pino=this.createPinoInstance()}createPinoInstance(){let options={level:this.config.level,name:this.config.name,serializers:{error:pino.stdSerializers.err}};if(this.config.format==="pretty")return pino(options,pino.transport({target:"pino-pretty"}));return pino(options)}trace(msg,ctx){this.pino.trace(ctx??{},msg)}debug(msg,ctx){this.pino.debug(ctx??{},msg)}info(msg,ctx){this.pino.info(ctx??{},msg)}warn(msg,ctx){this.pino.warn(ctx??{},msg)}error(msg,ctx){this.pino.error(ctx??{},msg)}fatal(msg,ctx){this.pino.fatal(ctx??{},msg)}flush(){this.pino.flush?.()}onDestroy(){this.flush()}child(ctx){let child=Object.create(this);return child.pino=this.pino.child(ctx),child}}var defaultTransport=()=>globalThis.navigator?.userAgent==="Cloudflare-Workers"?"console":"pino";class HermesModule extends Module.configurable({defaults:{...DEFAULT_CONFIG}}){}HermesModule=__legacyDecorateClassTS([Module.register({services:(config)=>[{name:HermesLogger,global:!0,factory:()=>new HermesLogger(config)},{name:LOGGER_SERVICE,global:!0,factory:(_config,get)=>(config.transport??defaultTransport())==="console"?new JsonConsoleLogger(config):get(HermesLogger)}]})],HermesModule);import{getLogger}from"@elysiumjs/core";var statusOf=(error)=>{let status=error?.status;return typeof status==="number"?status:500};class RequestLogInterceptor{async intercept(ctx,next){let started=performance.now(),log=(status,error)=>{let fields={method:ctx.request.method,path:new URL(ctx.request.url).pathname,status,durationMs:Math.round((performance.now()-started)*100)/100};if(typeof ctx.route==="string")fields.route=ctx.route;if(typeof ctx.ip==="string")fields.ip=ctx.ip;let requestId=ctx.request.headers.get("x-request-id");if(requestId)fields.requestId=requestId;if(error!==void 0&&status>=500)fields.error=error;let message=`${fields.method} ${fields.path} ${status}`,logger=getLogger();if(status>=500)logger.error(message,fields);else if(status>=400)logger.warn(message,fields);else logger.info(message,fields)};try{let result=await next(),status=result instanceof Response?result.status:Number(ctx.set.status??200);return log(Number.isFinite(status)?status:200),result}catch(error){throw log(statusOf(error),error),error}}}class HttpTransport{options;buffer=[];flushTimer;maxBufferSize;constructor(options){this.options=options;this.options.batchSize??=100,this.options.flushInterval??=5000,this.maxBufferSize=this.options.maxBufferSize??1e4,this.flushTimer=setInterval(()=>this.flush(),this.options.flushInterval)}write(formatted){if(this.buffer.length>=this.maxBufferSize)this.buffer.shift();if(this.buffer.push(formatted),this.buffer.length>=this.options.batchSize)this.flush()}async flush(){if(this.buffer.length===0)return;let batch=this.buffer.splice(0);try{await fetch(this.options.url,{method:"POST",headers:{"Content-Type":"application/json",...this.options.headers},body:JSON.stringify({logs:batch})})}catch{let space=this.maxBufferSize-this.buffer.length;if(space>0)this.buffer.unshift(...batch.slice(0,space))}}async close(){if(this.flushTimer)clearInterval(this.flushTimer);await this.flush()}}import{getLogger as getLogger2}from"@elysiumjs/core";function Logged(options={}){return function(target,propertyKey,descriptor){let original=descriptor.value,methodName=`${target.constructor.name}.${String(propertyKey)}`;return descriptor.value=async function(...args){let logger=this.logger??getLogger2(),startTime=Date.now();if(options.includeArgs)logger.debug(`[${methodName}] Entry`,{args});try{let result=await original.apply(this,args);if(options.includeResult||options.includeTiming){let duration=Date.now()-startTime;logger[options.level??"debug"](`[${methodName}] Exit`,{...options.includeResult&&{result},...options.includeTiming&&{duration:`${duration}ms`}})}return result}catch(error){let duration=Date.now()-startTime;throw logger.error(`[${methodName}] Error`,{error,duration:`${duration}ms`}),error}},descriptor}}export{HermesLogger,HermesModule,HttpTransport,JsonConsoleLogger,Logged,RequestLogInterceptor};

package/dist/interceptors/request-log.interceptor.d.ts

@@ -0,0 +1,16 @@
+import type { Interceptor, InterceptorContext } from '@elysiumjs/core';
+/**
+ * Writes one structured line per request through the app logger: the method, the path, the route,
+ * the status, the duration in milliseconds, the client address and the `x-request-id` header when
+ * present. Server errors are logged at `error`, client errors at `warn`, the rest at `info`. Use it
+ * as an app interceptor; streaming routes do not run interceptors.
+ * @author Axel Nana <axel.nana@workbud.com>
+ * @example
+ * ```ts
+ * @Application.register({ modules: [HermesModule], interceptors: [RequestLogInterceptor] })
+ * class App extends Application {}
+ * ```
+ */
+export declare class RequestLogInterceptor implements Interceptor {
+    intercept(ctx: InterceptorContext, next: () => Promise<unknown>): Promise<unknown>;
+}

package/dist/services/json-console.logger.d.ts

@@ -0,0 +1,22 @@
+import type { LoggerInterface } from '@elysiumjs/core';
+import type { HermesConfig, LogLevel } from '../types';
+/**
+ * A logger that writes one JSON object per line, with the same fields as the pino logger
+ * (`level`, `time`, `name`, `msg` and the context), through the console of the runtime: the
+ * standard streams on Bun and Node.js (warnings and errors on stderr), and the console method of
+ * each level on Cloudflare Workers, where Workers Logs index the fields and keep the level.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export declare class JsonConsoleLogger implements LoggerInterface {
+    #private;
+    constructor(config?: Partial<HermesConfig>, bindings?: Record<string, unknown>);
+    /** The lowest level written. */
+    readonly level: LogLevel;
+    trace(msg: string, ctx?: Record<string, unknown>): void;
+    debug(msg: string, ctx?: Record<string, unknown>): void;
+    info(msg: string, ctx?: Record<string, unknown>): void;
+    warn(msg: string, ctx?: Record<string, unknown>): void;
+    error(msg: string, ctx?: Record<string, unknown>): void;
+    fatal(msg: string, ctx?: Record<string, unknown>): void;
+    child(ctx: Record<string, unknown>): JsonConsoleLogger;
+}

package/dist/services/logger.service.d.ts

@@ -0,0 +1,29 @@
+import type { LoggerInterface } from '@elysiumjs/core';
+import type { HermesConfig } from '../types';
+/**
+ * Production-ready logger implementation wrapping Pino.
+ * Implements `LoggerInterface` from `@elysiumjs/core`.
+ *
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export declare class HermesLogger implements LoggerInterface {
+    private pino;
+    private config;
+    static make(name: string): HermesLogger;
+    constructor(config?: Partial<HermesConfig>);
+    private createPinoInstance;
+    trace(msg: string, ctx?: Record<string, unknown>): void;
+    debug(msg: string, ctx?: Record<string, unknown>): void;
+    info(msg: string, ctx?: Record<string, unknown>): void;
+    warn(msg: string, ctx?: Record<string, unknown>): void;
+    error(msg: string, ctx?: Record<string, unknown>): void;
+    fatal(msg: string, ctx?: Record<string, unknown>): void;
+    /**
+     * Flushes buffered log lines of the underlying transport, when it supports it.
+     * @author Axel Nana <axel.nana@workbud.com>
+     */
+    flush(): void;
+    /** Flushes on shutdown. Only called for a logger the container built. */
+    onDestroy(): void;
+    child(ctx: Record<string, unknown>): HermesLogger;
+}

package/dist/transports/http.transport.d.ts

@@ -0,0 +1,22 @@
+export interface HttpTransportOptions {
+    url: string;
+    headers?: Record<string, string>;
+    batchSize?: number;
+    flushInterval?: number;
+    maxBufferSize?: number;
+}
+/**
+ * HTTP transport for batching and sending logs to a remote endpoint.
+ *
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export declare class HttpTransport {
+    private options;
+    private buffer;
+    private flushTimer?;
+    private maxBufferSize;
+    constructor(options: HttpTransportOptions);
+    write(formatted: string): void;
+    flush(): Promise<void>;
+    close(): Promise<void>;
+}

package/dist/types.d.ts

@@ -0,0 +1,18 @@
+export type LogLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal';
+export type LogFormat = 'json' | 'pretty' | 'logfmt';
+export interface TransportConfig {
+    type: 'console' | 'file' | 'http';
+    options?: Record<string, unknown>;
+}
+export interface HermesConfig {
+    name?: string;
+    level: LogLevel;
+    format: LogFormat;
+    transports?: TransportConfig[];
+    /**
+     * Where log lines go: `pino`, or `console` for JSON lines through `console` with no
+     * dependency. Defaults to `console` on Cloudflare Workers and `pino` elsewhere.
+     */
+    transport?: 'pino' | 'console';
+}
+export declare const DEFAULT_CONFIG: HermesConfig;

package/package.json

@@ -1,9 +1,23 @@
 {
   "name": "@elysiumjs/hermes",
-  "version": "0.4.0",
+  "description": "Structured logging for the Elysium.js framework.",
+  "version": "0.5.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/na2axl/elysiumjs.git",
+    "directory": "@elysiumjs/hermes"
+  },
+  "homepage": "https://github.com/na2axl/elysiumjs/tree/main/@elysiumjs/hermes#readme",
+  "bugs": {
+    "url": "https://github.com/na2axl/elysiumjs/issues"
+  },
   "type": "module",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "CHANGELOG.md"
+  ],
   "sideEffects": false,
   "scripts": {
     "format": "prettier --write \"./src/**/*.ts\"",
@@ -21,9 +35,10 @@
     "pino-pretty": "^13.2.0"
   },
   "devDependencies": {
-    "@elysiumjs/core": "0.8.0"
+    "@elysiumjs/core": "0.11.0",
+    "@elysiumjs/runtime-bun": "0.1.0"
   },
   "peerDependencies": {
-    "@elysiumjs/core": "^0.8.0"
+    "@elysiumjs/core": "^0.11.0"
   }
 }

package/index.ts

@@ -1,15 +0,0 @@
-// 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.
-
-export * from './src/index';

package/src/decorators/logged.ts

@@ -1,86 +0,0 @@
-// 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 { LoggerInterface } from '@elysiumjs/core';
-import type { LogLevel } from '../types';
-
-import { ConsoleLogger } from '@elysiumjs/core';
-
-export interface LoggedOptions {
-	level?: LogLevel;
-	includeArgs?: boolean;
-	includeResult?: boolean;
-	includeTiming?: boolean;
-}
-
-/**
- * Decorator that logs method entry/exit with optional timing.
- *
- * Logger is resolved at CALL TIME (not decorator definition time)
- * to avoid capturing a stale logger reference.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export function Logged(options: LoggedOptions = {}): MethodDecorator {
-	return function (
-		target: object,
-		propertyKey: string | symbol,
-		descriptor: TypedPropertyDescriptor<any>
-	) {
-		const original = descriptor.value;
-		const methodName = `${target.constructor.name}.${String(propertyKey)}`;
-
-		descriptor.value = async function (...args: any[]) {
-			const logger: LoggerInterface = (this as any).logger ?? getServiceLogger();
-
-			const startTime = Date.now();
-
-			if (options.includeArgs) {
-				logger.debug(`[${methodName}] Entry`, { args });
-			}
-
-			try {
-				const result = await original.apply(this, args);
-
-				if (options.includeResult || options.includeTiming) {
-					const duration = Date.now() - startTime;
-					logger[options.level ?? 'debug'](`[${methodName}] Exit`, {
-						...(options.includeResult && { result }),
-						...(options.includeTiming && { duration: `${duration}ms` })
-					});
-				}
-
-				return result;
-			} catch (error) {
-				const duration = Date.now() - startTime;
-				logger.error(`[${methodName}] Error`, {
-					error: error instanceof Error ? error.message : error,
-					duration: `${duration}ms`
-				});
-				throw error;
-			}
-		};
-
-		return descriptor;
-	};
-}
-
-function getServiceLogger(): LoggerInterface {
-	try {
-		const { Service } = require('@elysiumjs/core');
-		return Service.get('logger') ?? new ConsoleLogger();
-	} catch {
-		return new ConsoleLogger();
-	}
-}

package/src/hermes.module.ts

@@ -1,37 +0,0 @@
-// 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 { Module } from '@elysiumjs/core';
-
-import { HermesLogger } from './services/logger.service';
-import { DEFAULT_CONFIG, type HermesConfig } from './types';
-
-/**
- * Provides the {@link HermesLogger} as the global services `HermesLogger` and `logger`
- * (the same instance), built from the module config.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-@Module.register<HermesConfig>({
-	services: (config) => [
-		{ name: HermesLogger.name, global: true, factory: () => new HermesLogger(config) },
-		{
-			name: 'logger',
-			global: true,
-			factory: (_config: unknown, get: <T>(name: string) => T) => get<HermesLogger>(HermesLogger.name)
-		}
-	]
-})
-export class HermesModule extends Module.configurable<HermesConfig>({
-	defaults: { ...DEFAULT_CONFIG }
-}) {}

package/src/index.ts

@@ -1,21 +0,0 @@
-// 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.
-
-export { HermesModule } from './hermes.module';
-export { HermesLogger } from './services/logger.service';
-export { HttpTransport } from './transports/http.transport';
-export type { HttpTransportOptions } from './transports/http.transport';
-export { Logged } from './decorators/logged';
-export type { LoggedOptions } from './decorators/logged';
-export type { HermesConfig, LogLevel, LogFormat, TransportConfig } from './types';

package/src/services/logger.service.ts

@@ -1,98 +0,0 @@
-// 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 { LoggerInterface } from '@elysiumjs/core';
-import type { Logger as PinoLogger } from 'pino';
-import type { HermesConfig } from '../types';
-
-import { Service } from '@elysiumjs/core';
-import pino from 'pino';
-
-import { DEFAULT_CONFIG } from '../types';
-
-/**
- * Production-ready logger implementation wrapping Pino.
- * Implements `LoggerInterface` from `@elysiumjs/core`.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export class HermesLogger implements LoggerInterface {
-	private pino: PinoLogger;
-	private config: HermesConfig;
-
-	public static make(name: string): HermesLogger {
-		return Service.get(HermesLogger)?.child({ name }) ?? new HermesLogger({ name });
-	}
-
-	constructor(config: Partial<HermesConfig> = {}) {
-		this.config = { ...DEFAULT_CONFIG, ...config };
-		this.pino = this.createPinoInstance();
-	}
-
-	private createPinoInstance(): PinoLogger {
-		const options: pino.LoggerOptions = {
-			level: this.config.level,
-			name: this.config.name
-		};
-
-		if (this.config.format === 'pretty') {
-			return pino(options, pino.transport({ target: 'pino-pretty' }));
-		}
-
-		return pino(options);
-	}
-
-	public trace(msg: string, ctx?: Record<string, unknown>): void {
-		this.pino.trace(ctx ?? {}, msg);
-	}
-
-	public debug(msg: string, ctx?: Record<string, unknown>): void {
-		this.pino.debug(ctx ?? {}, msg);
-	}
-
-	public info(msg: string, ctx?: Record<string, unknown>): void {
-		this.pino.info(ctx ?? {}, msg);
-	}
-
-	public warn(msg: string, ctx?: Record<string, unknown>): void {
-		this.pino.warn(ctx ?? {}, msg);
-	}
-
-	public error(msg: string, ctx?: Record<string, unknown>): void {
-		this.pino.error(ctx ?? {}, msg);
-	}
-
-	public fatal(msg: string, ctx?: Record<string, unknown>): void {
-		this.pino.fatal(ctx ?? {}, msg);
-	}
-
-	/**
-	 * Flushes buffered log lines of the underlying transport, when it supports it.
-	 * @author Axel Nana <axel.nana@workbud.com>
-	 */
-	public flush(): void {
-		this.pino.flush?.();
-	}
-
-	/** Flushes on shutdown. Only called for a logger the container built. */
-	public onDestroy(): void {
-		this.flush();
-	}
-
-	public child(ctx: Record<string, unknown>): HermesLogger {
-		const child = Object.create(this) as HermesLogger;
-		child.pino = this.pino.child(ctx);
-		return child;
-	}
-}

package/src/transports/http.transport.ts

@@ -1,79 +0,0 @@
-// 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.
-
-export interface HttpTransportOptions {
-	url: string;
-	headers?: Record<string, string>;
-	batchSize?: number;
-	flushInterval?: number;
-	maxBufferSize?: number;
-}
-
-/**
- * HTTP transport for batching and sending logs to a remote endpoint.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export class HttpTransport {
-	private buffer: string[] = [];
-	private flushTimer?: ReturnType<typeof setInterval>;
-	private maxBufferSize: number;
-
-	constructor(private options: HttpTransportOptions) {
-		this.options.batchSize ??= 100;
-		this.options.flushInterval ??= 5000;
-		this.maxBufferSize = this.options.maxBufferSize ?? 10_000;
-
-		this.flushTimer = setInterval(() => this.flush(), this.options.flushInterval);
-	}
-
-	public write(formatted: string): void {
-		if (this.buffer.length >= this.maxBufferSize) {
-			this.buffer.shift();
-		}
-
-		this.buffer.push(formatted);
-
-		if (this.buffer.length >= this.options.batchSize!) {
-			this.flush();
-		}
-	}
-
-	public async flush(): Promise<void> {
-		if (this.buffer.length === 0) return;
-
-		const batch = this.buffer.splice(0);
-
-		try {
-			await fetch(this.options.url, {
-				method: 'POST',
-				headers: {
-					'Content-Type': 'application/json',
-					...this.options.headers
-				},
-				body: JSON.stringify({ logs: batch })
-			});
-		} catch {
-			const space = this.maxBufferSize - this.buffer.length;
-			if (space > 0) {
-				this.buffer.unshift(...batch.slice(0, space));
-			}
-		}
-	}
-
-	public async close(): Promise<void> {
-		if (this.flushTimer) clearInterval(this.flushTimer);
-		await this.flush();
-	}
-}

package/src/types.ts

@@ -1,34 +0,0 @@
-// 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.
-
-export type LogLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal';
-
-export type LogFormat = 'json' | 'pretty' | 'logfmt';
-
-export interface TransportConfig {
-	type: 'console' | 'file' | 'http';
-	options?: Record<string, unknown>;
-}
-
-export interface HermesConfig {
-	name?: string;
-	level: LogLevel;
-	format: LogFormat;
-	transports?: TransportConfig[];
-}
-
-export const DEFAULT_CONFIG: HermesConfig = {
-	level: 'info',
-	format: 'json'
-};