@privateaim/server-kit 0.8.15 → 0.8.17

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

@@ -1,5 +1,5 @@
 import { type Factory } from 'singa';
-import type { Logger } from 'winston';
+import type { Logger } from './types';
 export declare function setLoggerFactory(factory: Factory<Logger>): void;
 export declare function isLoggerUsable(): boolean;
 export declare function setLogger(input: Logger): void;

package/dist/services/logger/transports/console.d.ts

@@ -0,0 +1,8 @@
+import { transports } from 'winston';
+import type { TransportStreamOptions } from 'winston-transport';
+import type { LoggerTransport } from '../types';
+export declare class LoggerConsoleTransport extends transports.Console {
+    constructor(options?: TransportStreamOptions);
+}
+export declare function createLoggerConsoleTransport(options?: TransportStreamOptions): LoggerTransport;
+//# sourceMappingURL=console.d.ts.map

package/dist/services/logger/transports/console.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"console.d.ts","sourceRoot":"","sources":["../../../../src/services/logger/transports/console.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAEhE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAEhD,qBAAa,sBAAuB,SAAQ,UAAU,CAAC,OAAO;gBAC9C,OAAO,GAAE,sBAA2B;CAQnD;AAED,wBAAgB,4BAA4B,CAAC,OAAO,GAAE,sBAA2B,GAAI,eAAe,CAEnG"}

package/dist/services/logger/transports/index.d.ts

@@ -0,0 +1,3 @@
+export * from './console';
+export * from './memory';
+//# sourceMappingURL=index.d.ts.map

package/dist/services/logger/transports/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/logger/transports/index.ts"],"names":[],"mappings":"AAOA,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC"}

package/dist/services/logger/transports/memory.d.ts

@@ -0,0 +1,6 @@
+import Transport from 'winston-transport';
+export declare class LoggerMemoryTransport extends Transport {
+    items: Record<PropertyKey, any>[];
+    log(info: Record<PropertyKey, any>, next: () => void): any;
+}
+//# sourceMappingURL=memory.d.ts.map

package/dist/services/logger/transports/memory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory.d.ts","sourceRoot":"","sources":["../../../../src/services/logger/transports/memory.ts"],"names":[],"mappings":"AAOA,OAAO,SAAS,MAAM,mBAAmB,CAAC;AAE1C,qBAAa,qBAAsB,SAAQ,SAAS;IACzC,KAAK,EAAG,MAAM,CAAC,WAAW,EAAE,GAAG,CAAC,EAAE,CAAM;IAE/C,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,WAAW,EAAE,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,IAAI,GAAG,GAAG;CAK7D"}

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

@@ -1,11 +1,31 @@
-import type { Logger, LoggerOptions } from 'winston';
-import type { LogStore } from '../log-store';
+import type Transport from 'winston-transport';
+import type { LoggerOptions } from 'winston';
+export type LoggerTransport = Transport;
 export type LoggerCreateContext = {
-    directory?: string;
     options?: Partial<LoggerOptions>;
-    store?: LogStore;
-    labels?: Record<string, string>;
+    transports?: LoggerTransport[];
 };
-export type LoggerTransports = LoggerOptions['transports'];
-export type { Logger, };
+type LogEntry = {
+    /**
+     * Log message.
+     */
+    message: string | Error;
+    [key: string]: any;
+};
+export interface LoggerLevelFn<OUT = any> {
+    (message: string, ...meta: Omit<LogEntry, 'message'>[]): OUT;
+    (message: LogEntry): OUT;
+    (message: string): OUT;
+}
+export type Logger = {
+    emerg: LoggerLevelFn<Logger>;
+    alert: LoggerLevelFn<Logger>;
+    crit: LoggerLevelFn<Logger>;
+    error: LoggerLevelFn<Logger>;
+    warn: LoggerLevelFn<Logger>;
+    notice: LoggerLevelFn<Logger>;
+    info: LoggerLevelFn<Logger>;
+    debug: LoggerLevelFn<Logger>;
+};
+export {};
 //# sourceMappingURL=types.d.ts.map

package/dist/services/logger/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/services/logger/types.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE7C,MAAM,MAAM,mBAAmB,GAAG;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IACjC,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;AAE3D,YAAY,EACR,MAAM,GACT,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/services/logger/types.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,SAAS,MAAM,mBAAmB,CAAC;AAC/C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,MAAM,MAAM,eAAe,GAAG,SAAS,CAAC;AAExC,MAAM,MAAM,mBAAmB,GAAG;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IACjC,UAAU,CAAC,EAAE,eAAe,EAAE,CAAA;CACjC,CAAC;AAEF,KAAK,QAAQ,GAAG;IACZ;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACrB,CAAC;AAEF,MAAM,WAAW,aAAa,CAAC,GAAG,GAAG,GAAG;IACpC,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,EAAE,GAAG,GAAG,CAAC;IAC7D,CAAC,OAAO,EAAE,QAAQ,GAAG,GAAG,CAAC;IACzB,CAAC,OAAO,EAAC,MAAM,GAAG,GAAG,CAAC;CACzB;AAED,MAAM,MAAM,MAAM,GAAG;IACjB,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAC7B,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAC7B,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAC5B,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAC7B,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAC5B,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAC9B,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAC5B,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;CAChC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@privateaim/server-kit",
-    "version": "0.8.15",
+    "version": "0.8.17",
     "exports": {
         "./package.json": "./package.json",
         ".": {
@@ -28,9 +28,8 @@
     },
     "dependencies": {
         "@ebec/http": "^2.3.0",
-        "@hapic/loki": "^1.2.0",
         "@isaacs/ttlcache": "^1.4.1",
-        "@privateaim/kit": "^0.8.15",
+        "@privateaim/kit": "^0.8.17",
         "@socket.io/redis-emitter": "^5.1.0",
         "envix": "^1.5.0",
         "hapic": "^2.7.0",

package/src/constants.ts

@@ -0,0 +1,12 @@
+/*
+ * Copyright (c) 2025.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+export enum EnvironmentName {
+    TEST = 'test',
+    DEVELOPMENT = 'development',
+    PRODUCTION = 'production',
+}

package/src/core/component/handler/check.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2025.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import { isObject } from '@privateaim/kit';
+import { hasOwnProperty } from '../../../utils';
+
+import type { ComponentHandler, ComponentHandlerFn } from './types';
+
+export function isComponentHandler(input: unknown) : input is ComponentHandler {
+    if (!isObject(input)) {
+        return false;
+    }
+
+    return !(!hasOwnProperty(input, 'execute') || typeof input.execute !== 'function');
+}
+
+export function isComponentHandlerFn(input: unknown) : input is ComponentHandlerFn {
+    return typeof input === 'function';
+}

package/src/{services/loki → core/component/handler}/index.ts

@@ -1,9 +1,9 @@
 /*
- * Copyright (c) 2024.
+ * Copyright (c) 2025.
  * Author Peter Placzek (tada5hi)
  * For the full copyright and license information,
  * view the LICENSE file that was distributed with this source code.
  */
 
 export * from './module';
-export * from './singleton';
+export * from './types';

package/src/core/component/handler/module.ts

@@ -0,0 +1,57 @@
+/*
+ * Copyright (c) 2025.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import type { ObjectLiteral } from '../../../type';
+import { isComponentHandlerFn } from './check';
+import type { ComponentHandler, ComponentHandlerFn } from './types';
+
+export class ComponentHandlers {
+    protected handlers: Record<string, ComponentHandlerFn | ComponentHandler>;
+
+    constructor() {
+        this.handlers = {};
+    }
+
+    mount<K extends string>(key: K, fn: ComponentHandler<K, any> | ComponentHandlerFn<K, any>) {
+        this.handlers[key] = fn;
+    }
+
+    unmount(key: string) {
+        delete this.handlers[key];
+    }
+
+    async setup() : Promise<void> {
+        const keys = Object.keys(this.handlers);
+        for (let i = 0; i < keys.length; i++) {
+            const handler = this.handlers[keys[i]];
+
+            if (
+                !isComponentHandlerFn(handler) &&
+                handler.setup
+            ) {
+                await handler.setup();
+            }
+        }
+    }
+
+    async execute(
+        key: string,
+        value: ObjectLiteral = {},
+        metadata: ObjectLiteral = {},
+    ) : Promise<void> {
+        const handler = this.handlers[key];
+        if (!handler) {
+            return;
+        }
+
+        if (isComponentHandlerFn(handler)) {
+            await handler(value, { key, metadata });
+        } else {
+            await handler.handle(value, { key, metadata });
+        }
+    }
+}

package/src/core/component/handler/types.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2025.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import type { ObjectLiteral } from '../../../type';
+
+export type ComponentHandlerContext<
+    KEY extends string = string,
+> = {
+    key: KEY,
+    metadata: ObjectLiteral
+};
+
+export type ComponentHandlerFn<
+    KEY extends string = string,
+    VALUE extends ObjectLiteral = ObjectLiteral,
+> = (value: VALUE, context: ComponentHandlerContext<KEY>) => Promise<void> | void;
+
+export type ComponentHandler<
+    KEY extends string = string,
+    VALUE extends ObjectLiteral = ObjectLiteral,
+> = {
+    setup?: () => Promise<void> | void;
+    handle: ComponentHandlerFn<KEY, VALUE>
+};

package/src/core/component/index.ts

@@ -6,5 +6,6 @@
  */
 
 export * from './error';
+export * from './handler';
 export * from './helper';
 export * from './type';

package/src/core/queue-router/module.ts

@@ -13,7 +13,7 @@ import { isQueueRouterPayload } from './helpers';
 import type {
     QueueRouterHandler,
     QueueRouterHandlers,
-    QueueRouterPayload, QueueRouterRouting,
+    QueueRouterPayload, QueueRouterPublishOptions, QueueRouterRouting,
 } from './types';
 
 export class QueueRouter {
@@ -27,7 +27,12 @@ export class QueueRouter {
 
     //----------------------------------------------------------------
 
-    publish(message: QueueRouterPayload) : Promise<boolean> {
+    publish(
+        message: QueueRouterPayload,
+        options: QueueRouterPublishOptions = {},
+    ) : Promise<boolean> {
+        options.logging ??= true;
+
         let exchange : Client;
         if (message.metadata.routing.type === 'work') {
             exchange = this.driver.of({
@@ -41,7 +46,10 @@ export class QueueRouter {
             });
         }
 
-        if (isLoggerUsable()) {
+        if (
+            options.logging &&
+            isLoggerUsable()
+        ) {
             useLogger()
                 .debug(`Publishing queue message ${message.type} in ${message.metadata.routing.key}`);
         }
@@ -54,6 +62,15 @@ export class QueueRouter {
         });
     }
 
+    consumeAny(
+        routing: QueueRouterRouting,
+        fn: (payload: QueueRouterPayload) => Promise<void> | void,
+    ) {
+        return this.consume(routing, {
+            $any: (payload) => fn(payload),
+        });
+    }
+
     consume(routing: QueueRouterRouting, handlers: QueueRouterHandlers) : Promise<void> {
         let exchange : Client;
         if (routing.type === 'work') {
@@ -113,7 +130,16 @@ export class QueueRouter {
                     return;
                 }
 
-                await handler(payload);
+                try {
+                    await handler(payload);
+                } catch (e) {
+                    if (isLoggerUsable()) {
+                        useLogger()
+                            .error(e);
+                    }
+
+                    throw e;
+                }
             },
         });
     }

package/src/core/queue-router/types.ts

@@ -26,6 +26,10 @@ export type QueueRouterPayloadMetadata = {
     routing: QueueRouterRouting
 };
 
+export type QueueRouterPublishOptions = {
+    logging?: boolean
+};
+
 export type QueueRouterPayload<
     T = string,
     D = Record<string, any>,
@@ -36,18 +40,21 @@ export type QueueRouterPayload<
     metadata: QueueRouterPayloadMetadata
 };
 
-export type QueueRouterPayloadInput<T = string, D = Record<string, any>> = {
+export type QueueRouterPayloadInput<
+    KEY = string,
+    VALUE = Record<string, any>,
+> = {
     id?: string,
-    type: T,
-    data?: D,
+    type: KEY,
+    data?: VALUE,
     metadata: Partial<Pick<QueueRouterPayloadMetadata, 'timestamp'>> &
     Omit<QueueRouterPayloadMetadata, 'timestamp'>
 };
 
 export type QueueRouterHandler<
-    T = string,
+    KEY = string,
     D = Record<string, any>,
-> = (message: QueueRouterPayload<T, D>) => Promise<void> | void;
+> = (message: QueueRouterPayload<KEY, D>) => Promise<void> | void;
 
 export type QueueRouterHandlers<
     R extends Record<string, Record<string, any>> = Record<string, Record<string, any>>,

package/src/index.ts

@@ -5,6 +5,7 @@
  * view the LICENSE file that was distributed with this source code.
  */
 
+export * from './constants';
 export * from './core';
 export * from './services';
 export * from './type';

package/src/services/amqp/index.ts

@@ -6,3 +6,4 @@
  */
 
 export * from './module';
+export * from './singleton';

package/src/services/amqp/module.ts

@@ -1,26 +1,12 @@
 /*
- * Copyright (c) 2024.
+ * Copyright (c) 2025.
  * Author Peter Placzek (tada5hi)
  * For the full copyright and license information,
  * view the LICENSE file that was distributed with this source code.
  */
 
-import type { Client } from 'amqp-extension';
-import type { Factory } from 'singa';
-import { singa } from 'singa';
+import { Client as AmqpClient } from 'amqp-extension';
 
-const instance = singa<Client>({
-    name: 'amqp',
-});
-
-export function setAmqpClientFactory(factory: Factory<Client>) {
-    instance.setFactory(factory);
-}
-
-export function isAmqpClientUsable() {
-    return instance.has() || instance.hasFactory();
-}
-
-export function useAmqpClient() {
-    return instance.use();
-}
+export {
+    AmqpClient,
+};

package/src/services/{loki → amqp}/singleton.ts

@@ -5,22 +5,22 @@
  * view the LICENSE file that was distributed with this source code.
  */
 
+import type { Client } from 'amqp-extension';
 import type { Factory } from 'singa';
 import { singa } from 'singa';
-import type { LokiClient } from '@hapic/loki';
 
-const instance = singa<LokiClient>({
-    name: 'loki',
+const instance = singa<Client>({
+    name: 'amqp',
 });
 
-export function setLokiFactory(factory: Factory<LokiClient>) {
+export function setAmqpClientFactory(factory: Factory<Client>) {
     instance.setFactory(factory);
 }
 
-export function isLokiClientUsable() {
+export function isAmqpClientUsable() {
     return instance.has() || instance.hasFactory();
 }
 
-export function useLokiClient() {
+export function useAmqpClient() {
     return instance.use();
 }

package/src/services/entity-event/handlers/index.ts

@@ -0,0 +1,9 @@
+/*
+ * Copyright (c) 2025.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+export * from './redis';
+export * from './socket';

package/src/services/entity-event/handlers/redis/helpers.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2025.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+function stringify(input: string | string[]) {
+    return typeof input === 'string' ? input : input.join('/');
+}
+
+export function buildEntityEventRedisChannel(
+    channel: string | string[],
+    namespace?: string | string[],
+) {
+    const channelNormalized = stringify(channel);
+
+    let namespaceNormalized : string | undefined;
+    if (namespace) {
+        namespaceNormalized = stringify(namespace);
+    }
+
+    if (typeof namespaceNormalized === 'undefined') {
+        return channelNormalized;
+    }
+
+    return `${namespaceNormalized}/${channelNormalized}`;
+}

package/src/services/{domain-event → entity-event/handlers}/redis/index.ts

@@ -6,3 +6,4 @@
  */
 
 export * from './module';
+export * from './helpers';

package/src/services/entity-event/handlers/redis/module.ts

@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2023-2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import type { Client } from 'redis-extension';
+import type { DomainEventRecord } from '@privateaim/kit';
+import type { EntityEventHandleOptions, IEntityEventHandler } from '../../types';
+import { transformEntityEventData } from '../../utils';
+import { buildEntityEventRedisChannel } from './helpers';
+
+export class EntityEventRedisHandler implements IEntityEventHandler {
+    protected driver : Client;
+
+    constructor(client: Client) {
+        this.driver = client;
+    }
+
+    async handle(ctx: EntityEventHandleOptions) : Promise<void> {
+        const payload : DomainEventRecord = {
+            type: ctx.metadata.ref_type,
+            event: ctx.metadata.event,
+            data: transformEntityEventData(ctx.data),
+        };
+
+        const payloadSerialized = JSON.stringify(payload);
+
+        const pipeline = this.driver.pipeline();
+        for (let i = 0; i < ctx.destinations.length; i++) {
+            const destination = ctx.destinations[i];
+
+            const key = buildEntityEventRedisChannel(
+                destination.channel,
+                destination.namespace,
+            );
+
+            pipeline.publish(key, payloadSerialized);
+        }
+
+        await pipeline.exec();
+    }
+}

package/src/services/entity-event/handlers/socket/module.ts

@@ -0,0 +1,72 @@
+/*
+ * Copyright (c) 2022-2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import { buildDomainEventFullName } from '@privateaim/kit';
+import { Emitter } from '@socket.io/redis-emitter';
+import type { Client } from 'redis-extension';
+import type { EntityEventHandleOptions, IEntityEventHandler } from '../../types';
+import { transformEntityEventData } from '../../utils';
+
+export class EntityEventSocketHandler implements IEntityEventHandler {
+    protected client : Client;
+
+    constructor(client: Client) {
+        this.client = client;
+    }
+
+    async handle(ctx: EntityEventHandleOptions) : Promise<void> {
+        ctx.data = transformEntityEventData(ctx.data);
+
+        for (let i = 0; i < ctx.destinations.length; i++) {
+            const destination = ctx.destinations[i];
+
+            const namespace = this.buildNamespace(destination.namespace);
+            const roomName = this.buildChannel(destination.channel);
+
+            const fullEventName = buildDomainEventFullName(
+                ctx.metadata.ref_type,
+                ctx.metadata.event,
+            );
+
+            const emitter = new Emitter(this.client, {}, namespace);
+
+            emitter
+                .in(roomName)
+                .emit(fullEventName, {
+                    data: {
+                        data: ctx.data,
+                        type: ctx.metadata.ref_type,
+                        event: ctx.metadata.event,
+                    },
+                    meta: {
+                        namespace,
+                        roomName,
+                    },
+                });
+        }
+    }
+
+    protected buildNamespace(namespace?: string | string[]) {
+        if (typeof namespace === 'undefined') {
+            return '/';
+        }
+
+        if (typeof namespace === 'string') {
+            return namespace.startsWith('/') ? namespace : `/${namespace}`;
+        }
+
+        return `/${namespace.join('/')}`;
+    }
+
+    protected buildChannel(channel: string | string[]) {
+        if (typeof channel === 'string') {
+            return channel;
+        }
+
+        return channel.join('/');
+    }
+}

package/src/services/{domain-event → entity-event}/index.ts

@@ -6,7 +6,6 @@
  */
 
 export * from './module';
-export * from './redis';
+export * from './handlers';
 export * from './singleton';
-export * from './socket';
 export * from './types';