@privateaim/server-kit 0.8.14 → 0.8.16

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@privateaim/server-kit",
-    "version": "0.8.14",
+    "version": "0.8.16",
     "exports": {
         "./package.json": "./package.json",
         ".": {
@@ -28,24 +28,24 @@
     },
     "dependencies": {
         "@ebec/http": "^2.3.0",
-        "@hapic/loki": "^1.1.0",
         "@isaacs/ttlcache": "^1.4.1",
-        "@privateaim/kit": "^0.8.14",
+        "@privateaim/kit": "^0.8.16",
         "@socket.io/redis-emitter": "^5.1.0",
         "envix": "^1.5.0",
         "hapic": "^2.7.0",
-        "singa": "^1.0.0",
+        "singa": "^1.1.0",
+        "triple-beam": "^1.4.1",
         "winston": "^3.17.0"
     },
     "devDependencies": {
-        "@authup/core-http-kit": "^1.0.0-beta.26",
+        "@authup/core-http-kit": "^1.0.0-beta.27",
         "@hapic/vault": "^2.3.9",
         "amqp-extension": "^4.0.0",
         "redis-extension": "^2.0.2",
         "typeorm-extension": "^3.7.1"
     },
     "peerDependencies": {
-        "@authup/core-http-kit": "^1.0.0-beta.26",
+        "@authup/core-http-kit": "^1.0.0-beta.27",
         "@hapic/vault": "^2.3.9",
         "amqp-extension": "^4.0.0",
         "redis-extension": "^2.0.2",

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/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/domain-event/index.ts

@@ -9,4 +9,4 @@ export * from './module';
 export * from './redis';
 export * from './singleton';
 export * from './socket';
-export * from './type';
+export * from './types';

package/src/services/domain-event/module.ts

@@ -5,50 +5,67 @@
  * view the LICENSE file that was distributed with this source code.
  */
 
-import type { DomainEventRecord } from '@privateaim/kit';
+import type { ObjectLiteral } from '@privateaim/kit';
 import { buildDomainEventFullName } from '@privateaim/kit';
 import { isLoggerUsable, useLogger } from '../logger';
-import type { DomainEventPublishContext, IDomainEventPublisher } from './type';
+import type {
+    DomainEventConsumeOptions, DomainEventDestination,
+    DomainEventPublishOptions,
+    IDomainEventConsumer,
+    IDomainEventPublisher,
+} from './types';
 
 export class DomainEventPublisher implements IDomainEventPublisher {
-    protected publishers : Set<IDomainEventPublisher>;
+    protected consumers : Set<IDomainEventConsumer>;
 
     constructor() {
-        this.publishers = new Set<IDomainEventPublisher>();
+        this.consumers = new Set<IDomainEventConsumer>();
     }
 
-    addPublisher(publisher: IDomainEventPublisher) {
-        this.publishers.add(publisher);
+    addConsumer(consumer: IDomainEventConsumer) {
+        this.consumers.add(consumer);
     }
 
-    async safePublish<T extends DomainEventRecord>(
-        ctx: DomainEventPublishContext<T>,
+    async safePublish<T extends ObjectLiteral = ObjectLiteral>(
+        ctx: DomainEventPublishOptions<T>,
     ) : Promise<void> {
         try {
             await this.publish(ctx);
         } catch (e) {
             if (isLoggerUsable()) {
-                useLogger().error(`Publishing event ${buildDomainEventFullName(ctx.data.type, ctx.data.event)} failed`);
+                useLogger().error(`Publishing event ${buildDomainEventFullName(ctx.metadata.domain, ctx.metadata.event)} failed`);
                 useLogger().error(e);
             }
         }
     }
 
-    async publish<T extends DomainEventRecord>(
-        ctx: DomainEventPublishContext<T>,
+    async publish<T extends ObjectLiteral = ObjectLiteral>(
+        ctx: DomainEventPublishOptions<T>,
     ) : Promise<void> {
         if (isLoggerUsable()) {
-            useLogger().info(`Publishing event ${buildDomainEventFullName(ctx.data.type, ctx.data.event)}`);
+            useLogger().info(`Publishing event ${buildDomainEventFullName(ctx.metadata.domain, ctx.metadata.event)}`);
         }
 
-        const publishers = this.publishers.values();
+        let destinations : DomainEventDestination[] = [];
+        if (typeof ctx.destinations === 'function') {
+            destinations = ctx.destinations(ctx.data);
+        } else {
+            destinations = ctx.destinations;
+        }
+
+        const consumeContext : DomainEventConsumeOptions = {
+            ...ctx,
+            destinations,
+        };
+
+        const consumers = this.consumers.values();
         while (true) {
-            const it = publishers.next();
+            const it = consumers.next();
             if (it.done) {
                 return;
             }
 
-            await it.value.publish(ctx);
+            await it.value.consume(consumeContext);
         }
     }
 }

package/src/services/domain-event/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 buildDomainEventRedisChannel(
+    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/redis/index.ts

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

package/src/services/domain-event/redis/module.ts

@@ -6,30 +6,37 @@
  */
 
 import type { Client } from 'redis-extension';
-import type { DomainEventPublishContext, IDomainEventPublisher } from '../type';
-import { buildEventChannelName, transformEventData } from '../utils';
+import type { DomainEventRecord } from '@privateaim/kit';
+import type { DomainEventPublishOptions, IDomainEventConsumer } from '../types';
+import { transformEventData } from '../utils';
+import { buildDomainEventRedisChannel } from './helpers';
 
-export class DomainEventRedisPublisher implements IDomainEventPublisher {
+export class DomainEventRedisPublisher implements IDomainEventConsumer {
     protected driver : Client;
 
     constructor(client: Client) {
         this.driver = client;
     }
 
-    async publish(ctx: DomainEventPublishContext) : Promise<void> {
-        const data = JSON.stringify(transformEventData(ctx.data));
+    async consume(ctx: DomainEventPublishOptions) : Promise<void> {
+        const payload : DomainEventRecord = {
+            type: ctx.metadata.domain,
+            event: ctx.metadata.event,
+            data: transformEventData(ctx.data),
+        };
+
+        const payloadSerialized = JSON.stringify(payload);
 
         const pipeline = this.driver.pipeline();
         for (let i = 0; i < ctx.destinations.length; i++) {
-            const keyPrefix = (ctx.destinations[i].namespace ? `${ctx.destinations[i].namespace}:` : '');
+            const destination = ctx.destinations[i];
 
-            let key = keyPrefix + buildEventChannelName(ctx.destinations[i].channel);
-            pipeline.publish(key, data);
+            const key = buildDomainEventRedisChannel(
+                destination.channel,
+                destination.namespace,
+            );
 
-            if (typeof ctx.destinations[i].channel === 'function') {
-                key = keyPrefix + buildEventChannelName(ctx.destinations[i].channel, ctx.data.data.id);
-                pipeline.publish(key, data);
-            }
+            pipeline.publish(key, payloadSerialized);
         }
 
         await pipeline.exec();

package/src/services/domain-event/singleton.ts

@@ -9,9 +9,9 @@ import { singa } from 'singa';
 import { isRedisClientUsable, useRedisClient } from '../redis';
 import { DomainEventPublisher } from './module';
 import { DomainEventRedisPublisher } from './redis';
-import { DomainEventSocketPublisher } from './socket';
+import { DomainEventSocketConsumer } from './socket';
 
-const instance = singa<DomainEventPublisher>({
+const singaInstance = singa<DomainEventPublisher>({
     name: 'domainEventPublisher',
     factory: () => {
         const publisher = new DomainEventPublisher();
@@ -19,14 +19,18 @@ const instance = singa<DomainEventPublisher>({
         if (isRedisClientUsable()) {
             const client = useRedisClient();
 
-            publisher.addPublisher(new DomainEventRedisPublisher(client));
-            publisher.addPublisher(new DomainEventSocketPublisher(client));
+            publisher.addConsumer(new DomainEventRedisPublisher(client));
+            publisher.addConsumer(new DomainEventSocketConsumer(client));
         }
 
         return publisher;
     },
 });
 
+export function useDomainEventPublisherSinga() {
+    return singaInstance;
+}
+
 export function useDomainEventPublisher() {
-    return instance.use();
+    return singaInstance.use();
 }

package/src/services/domain-event/socket/helpers.ts

@@ -0,0 +1,26 @@
+/*
+ * 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 function buildDomainEventSocketNamespace(namespace?: string | string[]) {
+    if (typeof namespace === 'undefined') {
+        return '/';
+    }
+
+    if (typeof namespace === 'string') {
+        return namespace.startsWith('/') ? namespace : `/${namespace}`;
+    }
+
+    return `/${namespace.join('/')}`;
+}
+
+export function buildDomainEventSocketChannel(channel: string | string[]) {
+    if (typeof channel === 'string') {
+        return channel;
+    }
+
+    return channel.join('/');
+}

package/src/services/domain-event/socket/index.ts

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

package/src/services/domain-event/socket/module.ts

@@ -8,50 +8,46 @@
 import { buildDomainEventFullName } from '@privateaim/kit';
 import { Emitter } from '@socket.io/redis-emitter';
 import type { Client } from 'redis-extension';
-import type { DomainEventPublishContext, IDomainEventPublisher } from '../type';
-import { buildEventChannelName, transformEventData } from '../utils';
+import type { DomainEventPublishOptions, IDomainEventConsumer } from '../types';
+import { transformEventData } from '../utils';
+import { buildDomainEventSocketChannel, buildDomainEventSocketNamespace } from './helpers';
 
-export class DomainEventSocketPublisher implements IDomainEventPublisher {
+export class DomainEventSocketConsumer implements IDomainEventConsumer {
     protected client : Client;
 
     constructor(client: Client) {
         this.client = client;
     }
 
-    async publish(ctx: DomainEventPublishContext) : Promise<void> {
+    async consume(ctx: DomainEventPublishOptions) : Promise<void> {
         ctx.data = transformEventData(ctx.data);
 
         for (let i = 0; i < ctx.destinations.length; i++) {
-            let namespace : string;
-            if (ctx.destinations[i].namespace) {
-                namespace = ctx.destinations[i].namespace;
-            } else {
-                namespace = '/';
-            }
+            const destination = ctx.destinations[i];
+
+            const namespace = buildDomainEventSocketNamespace(destination.namespace);
+            const roomName = buildDomainEventSocketChannel(destination.channel);
+
+            const fullEventName = buildDomainEventFullName(
+                ctx.metadata.domain,
+                ctx.metadata.event,
+            );
 
             const emitter = new Emitter(this.client, {}, namespace);
 
-            const fullEventName = buildDomainEventFullName(ctx.data.type, ctx.data.event);
-
-            const rooms : string[] = [
-                buildEventChannelName(ctx.destinations[i].channel),
-            ];
-
-            if (typeof ctx.destinations[i].channel === 'function') {
-                rooms.push(buildEventChannelName(ctx.destinations[i].channel, ctx.data.data.id));
-            }
-
-            for (let j = 0; j < rooms.length; j++) {
-                emitter
-                    .in(rooms[j])
-                    .emit(fullEventName, {
-                        ...ctx.data,
-                        meta: {
-                            namespace,
-                            roomName: rooms[j],
-                        },
-                    });
-            }
+            emitter
+                .in(roomName)
+                .emit(fullEventName, {
+                    data: {
+                        data: ctx.data,
+                        type: ctx.metadata.domain,
+                        event: ctx.metadata.event,
+                    },
+                    meta: {
+                        namespace,
+                        roomName,
+                    },
+                });
         }
     }
 }