@privateaim/server-kit 0.8.14 → 0.8.15

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [0.8.15](https://github.com/PrivateAIM/hub/compare/v0.8.14...v0.8.15) (2025-07-30)
+
+
+### Features
+
+* event (re-) modelling ([#1125](https://github.com/PrivateAIM/hub/issues/1125)) ([621f704](https://github.com/PrivateAIM/hub/commit/621f7041794d0bf6d530445a9c3e7c9b66a373ba))
+* migrated to authup v1.0.0-beta.27 ([f96db78](https://github.com/PrivateAIM/hub/commit/f96db782a5b74e3aa8ab1ada270af770f3c92631))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @privateaim/kit bumped from ^0.8.14 to ^0.8.15
+
 ## [0.8.14](https://github.com/PrivateAIM/hub/compare/v0.8.13...v0.8.14) (2025-07-10)
 
 

package/dist/index.cjs

@@ -11,15 +11,16 @@ var envix = require('envix');
 var path = require('node:path');
 var typeormExtension = require('typeorm-extension');
 var winston = require('winston');
-var redisEmitter = require('@socket.io/redis-emitter');
+var WinstonTransport = require('winston-transport');
 var loki = require('@hapic/loki');
+var redisEmitter = require('@socket.io/redis-emitter');
 
 /*
  * 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.
- */ function _define_property$7(obj, key, value) {
+ */ function _define_property$b(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
             value: value,
@@ -36,7 +37,7 @@ class ComponentError extends Error {
     constructor(input){
         super(input.message, {
             cause: input.cause
-        }), _define_property$7(this, "code", void 0);
+        }), _define_property$b(this, "code", void 0);
         this.code = input.code;
     }
 }
@@ -205,7 +206,7 @@ function useRedisSubscribeClient() {
  * Author Peter Placzek (tada5hi)
  * For the full copyright and license information,
  * view the LICENSE file that was distributed with this source code.
- */ function _define_property$6(obj, key, value) {
+ */ function _define_property$a(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
             value: value,
@@ -253,7 +254,7 @@ class MemoryCacheAdapter {
         this.instance.clear();
     }
     constructor(options = {}){
-        _define_property$6(this, "instance", void 0);
+        _define_property$a(this, "instance", void 0);
         this.instance = new TTLCache({
             checkAgeOnGet: true,
             ttl: Infinity,
@@ -267,7 +268,7 @@ class MemoryCacheAdapter {
  * Author Peter Placzek (tada5hi)
  * For the full copyright and license information,
  * view the LICENSE file that was distributed with this source code.
- */ function _define_property$5(obj, key, value) {
+ */ function _define_property$9(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
             value: value,
@@ -316,8 +317,8 @@ class RedisCacheAdapter {
         await this.client.flushdb();
     }
     constructor(){
-        _define_property$5(this, "client", void 0);
-        _define_property$5(this, "instance", void 0);
+        _define_property$9(this, "client", void 0);
+        _define_property$9(this, "instance", void 0);
         this.client = useRedisClient();
         this.instance = new redisExtension.JsonAdapter(this.client);
     }
@@ -339,7 +340,7 @@ function buildCacheKey(options) {
  * Author Peter Placzek (tada5hi)
  * For the full copyright and license information,
  * view the LICENSE file that was distributed with this source code.
- */ function _define_property$4(obj, key, value) {
+ */ function _define_property$8(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
             value: value,
@@ -372,7 +373,7 @@ class Cache {
         return this.adapter.clear(options);
     }
     constructor(adapter){
-        _define_property$4(this, "adapter", void 0);
+        _define_property$8(this, "adapter", void 0);
         this.adapter = adapter;
     }
 }
@@ -393,8 +394,362 @@ function useCache() {
     return instance$4.use();
 }
 
+/*
+ * 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 _define_property$7(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+class LogStoreTransport extends WinstonTransport {
+    log(info, next) {
+        const { message, timestamp, stack, ...data } = info;
+        const labels = {
+            ...this.labels
+        };
+        const keys = Object.keys(data);
+        for(let i = 0; i < keys.length; i++){
+            if (typeof keys[i] !== 'string') {
+                continue;
+            }
+            const value = data[keys[i]];
+            if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
+                labels[keys[i]] = `${value}`;
+            }
+        }
+        let date;
+        if (typeof timestamp === 'string') {
+            date = new Date(`${timestamp}`);
+        } else {
+            date = new Date();
+        }
+        const payload = {
+            message: stack || message,
+            time: BigInt(date.getTime()) * 1000000n,
+            labels
+        };
+        Promise.resolve().then(()=>this.instance.write(payload)).then(()=>next());
+    }
+    constructor(store, options = {}){
+        super(options), _define_property$7(this, "instance", void 0), _define_property$7(this, "labels", void 0);
+        this.instance = store;
+        this.labels = options.labels || {};
+    }
+}
+
+const instance$3 = singa.singa({
+    name: 'loki'
+});
+function setLokiFactory(factory) {
+    instance$3.setFactory(factory);
+}
+function isLokiClientUsable() {
+    return instance$3.has() || instance$3.hasFactory();
+}
+function useLokiClient() {
+    return instance$3.use();
+}
+
+/*
+ * 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 _define_property$6(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+class BaseLogStore {
+    setLabels(labels) {
+        this.labels = labels;
+    }
+    getLabels() {
+        return this.labels;
+    }
+    extendLabels(labels) {
+        const keys = Object.keys(labels);
+        for(let i = 0; i < keys.length; i++){
+            this.labels[keys[i]] = labels[keys[i]];
+        }
+    }
+    constructor(){
+        _define_property$6(this, "labels", void 0);
+    }
+}
+
+/*
+ * 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 _define_property$5(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+class LokiLogStore extends BaseLogStore {
+    async write(message, labels) {
+        let data;
+        if (typeof message === 'string') {
+            const labelsNormalized = {
+                ...this.labels,
+                ...labels || {}
+            };
+            const level = labelsNormalized.level || kit.LogLevel.DEBUG;
+            delete labelsNormalized.level;
+            data = {
+                message,
+                level,
+                time: loki.nanoSeconds(),
+                labels: labelsNormalized
+            };
+        } else {
+            const labelsNormalized = {
+                ...this.labels,
+                ...message.labels || {},
+                ...labels || {}
+            };
+            const level = message.level || labelsNormalized.level || kit.LogLevel.DEBUG;
+            delete labelsNormalized.level;
+            data = {
+                ...message,
+                level,
+                time: message.time || loki.nanoSeconds(),
+                labels: labelsNormalized
+            };
+        }
+        const stream = {
+            stream: data.labels,
+            values: [
+                [
+                    data.time,
+                    data.message,
+                    {
+                        level: data.level
+                    }
+                ]
+            ]
+        };
+        await this.instance.distributor.push(stream);
+        return data;
+    }
+    async delete(options) {
+        await this.instance.compactor.createDeletionRequest({
+            start: options.start,
+            ...options.end ? {
+                end: options.end
+            } : {},
+            query: this.buildQuery({
+                ...this.labels,
+                ...options.labels || {}
+            })
+        });
+    }
+    async query(input) {
+        const options = {
+            query: this.buildQuery({
+                ...this.labels,
+                ...input.labels || {}
+            })
+        };
+        if (input.sort) {
+            options.direction = input.sort === 'DESC' ? 'forward' : 'backward';
+        }
+        if (input.limit) {
+            options.limit = input.limit;
+        }
+        if (input.start) {
+            options.start = BigInt(new Date(`${input.start}`).getTime()) * 1000000n;
+        }
+        if (input.end) {
+            options.end = BigInt(new Date(`${input.end}`).getTime()) * 1000000n;
+        }
+        const output = [];
+        const response = await this.instance.querier.queryRange(options);
+        if (response.data.resultType === 'streams') {
+            for(let i = 0; i < response.data.result.length; i++){
+                const set = response.data.result[i];
+                const labels = set.stream;
+                let level;
+                if (labels.level) {
+                    level = labels.level;
+                } else {
+                    level = labels.detected_level;
+                }
+                delete labels.level;
+                delete labels.detected_level;
+                if (!labels.service) {
+                    labels.service = labels.service_name;
+                }
+                delete labels.service_name;
+                for(let j = 0; j < set.values.length; j++){
+                    output.push({
+                        time: BigInt(set.values[j][0]),
+                        message: set.values[j][1],
+                        level,
+                        labels
+                    });
+                }
+            }
+        }
+        return [
+            output,
+            output.length
+        ];
+    }
+    // ----------------------------------------------
+    buildQuery(labels) {
+        const output = [];
+        const keys = Object.keys(labels);
+        for(let i = 0; i < keys.length; i++){
+            output.push(`${keys[i]}="${labels[keys[i]]}"`);
+        }
+        return `{${output.join(',')}}`;
+    }
+    constructor(instance, labels){
+        super(), _define_property$5(this, "instance", void 0);
+        this.instance = instance;
+        this.labels = labels || {};
+    }
+}
+
+/*
+ * 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 _define_property$4(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+class MemoryLogStore extends BaseLogStore {
+    // todo: apply query options
+    async delete() {
+        return Promise.resolve();
+    }
+    async query(options = {}) {
+        // todo: apply all query options
+        const data = this.items.filter((item)=>{
+            if (options.labels) {
+                if (!item.labels) {
+                    return false;
+                }
+                const labelKeys = Object.keys(options.labels);
+                for(let i = 0; i < labelKeys.length; i++){
+                    if (!item.labels[labelKeys[i]]) {
+                        return false;
+                    }
+                    if (item.labels[labelKeys[i]] !== options.labels[labelKeys[i]]) {
+                        return false;
+                    }
+                }
+            }
+            return true;
+        });
+        return [
+            data,
+            data.length
+        ];
+    }
+    async write(message, labels) {
+        let data;
+        if (typeof message === 'string') {
+            const labelsNormalized = {
+                ...this.labels,
+                ...labels || {}
+            };
+            const level = labelsNormalized.level || kit.LogLevel.DEBUG;
+            delete labelsNormalized.level;
+            data = {
+                message,
+                level,
+                time: loki.nanoSeconds(),
+                labels: labelsNormalized
+            };
+        } else {
+            const labelsNormalized = {
+                ...this.labels,
+                ...message.labels || {},
+                ...labels || {}
+            };
+            const level = message.level || labelsNormalized.level || kit.LogLevel.DEBUG;
+            delete labelsNormalized.level;
+            data = {
+                ...message,
+                level,
+                time: message.time || loki.nanoSeconds(),
+                labels: labelsNormalized
+            };
+        }
+        this.items.push(data);
+        return data;
+    }
+    constructor(labels){
+        super(), _define_property$4(this, "items", void 0);
+        this.items = [];
+        this.labels = labels;
+    }
+}
+
+const instance$2 = singa.singa({
+    name: 'logStore',
+    factory: ()=>{
+        if (isLokiClientUsable()) {
+            const loki = useLokiClient();
+            return new LokiLogStore(loki);
+        }
+        return new MemoryLogStore();
+    }
+});
+function isLogStoreUsable() {
+    return instance$2.has() || instance$2.hasFactory();
+}
+function setLogStoreFactory(input) {
+    instance$2.setFactory(input);
+}
+function useLogStore() {
+    return instance$2.use();
+}
+
 function createLogger(ctx = {}) {
-    const { directory, options = {} } = ctx;
+    const store = ctx.store || useLogStore();
     let loggerTransports;
     if (envix.read('env') === typeormExtension.EnvironmentName.PRODUCTION) {
         loggerTransports = [
@@ -402,50 +757,58 @@ function createLogger(ctx = {}) {
                 level: 'info'
             }),
             new winston.transports.File({
-                filename: path.join(directory || process.cwd(), 'access.log'),
+                filename: path.join(ctx.directory || process.cwd(), 'access.log'),
                 level: 'http',
                 maxsize: 10 * 1024 * 1024,
                 maxFiles: 5
             }),
             new winston.transports.File({
-                filename: path.join(directory || process.cwd(), 'error.log'),
+                filename: path.join(ctx.directory || process.cwd(), 'error.log'),
                 level: 'warn',
                 maxsize: 10 * 1024 * 1024,
                 maxFiles: 5
+            }),
+            new LogStoreTransport(store, {
+                level: 'http',
+                labels: ctx.labels
             })
         ];
     } else {
         loggerTransports = [
             new winston.transports.Console({
                 level: 'debug'
+            }),
+            new LogStoreTransport(store, {
+                level: 'http',
+                labels: ctx.labels
             })
         ];
     }
     return winston.createLogger({
         format: winston.format.combine(winston.format.errors({
             stack: true
-        }), winston.format.timestamp(), winston.format.colorize(), winston.format.simple()),
+        }), winston.format.timestamp(), winston.format.simple()),
         level: 'debug',
         transports: loggerTransports,
         // todo: deeply merge options
-        ...options || {}
+        ...ctx.options || {}
     });
 }
 
-const instance$3 = singa.singa({
+const instance$1 = singa.singa({
     name: 'logger'
 });
 function setLoggerFactory(factory) {
-    instance$3.setFactory(factory);
+    instance$1.setFactory(factory);
 }
 function isLoggerUsable() {
-    return instance$3.has() || instance$3.hasFactory();
+    return instance$1.has() || instance$1.hasFactory();
 }
 function setLogger(input) {
-    instance$3.set(input);
+    instance$1.set(input);
 }
 function useLogger() {
-    return instance$3.use();
+    return instance$1.use();
 }
 
 /*
@@ -475,14 +838,14 @@ class DomainEventPublisher {
             await this.publish(ctx);
         } catch (e) {
             if (isLoggerUsable()) {
-                useLogger().error(`Publishing event ${kit.buildDomainEventFullName(ctx.data.type, ctx.data.event)} failed`);
+                useLogger().error(`Publishing event ${kit.buildDomainEventFullName(ctx.metadata.domain, ctx.metadata.event)} failed`);
                 useLogger().error(e);
             }
         }
     }
     async publish(ctx) {
         if (isLoggerUsable()) {
-            useLogger().info(`Publishing event ${kit.buildDomainEventFullName(ctx.data.type, ctx.data.event)}`);
+            useLogger().info(`Publishing event ${kit.buildDomainEventFullName(ctx.metadata.domain, ctx.metadata.event)}`);
         }
         const publishers = this.publishers.values();
         while(true){
@@ -538,15 +901,29 @@ function buildEventChannelName(input, id) {
 }
 class DomainEventRedisPublisher {
     async publish(ctx) {
-        const data = JSON.stringify(transformEventData(ctx.data));
+        const payload = {
+            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}:` : '';
-            let key = keyPrefix + buildEventChannelName(ctx.destinations[i].channel);
-            pipeline.publish(key, data);
-            if (typeof ctx.destinations[i].channel === 'function') {
-                key = keyPrefix + buildEventChannelName(ctx.destinations[i].channel, ctx.data.data.id);
-                pipeline.publish(key, data);
+            const destination = ctx.destinations[i];
+            let keyPrefix;
+            if (destination.namespace) {
+                keyPrefix = typeof destination.namespace === 'function' ? destination.namespace(ctx.data) : destination.namespace;
+            }
+            let key;
+            if (keyPrefix) {
+                key = keyPrefix + buildEventChannelName(destination.channel);
+            } else {
+                key = buildEventChannelName(destination.channel);
+            }
+            pipeline.publish(key, payloadSerialized);
+            if (typeof destination.channel === 'function') {
+                key = keyPrefix + buildEventChannelName(destination.channel, ctx.data.id);
+                pipeline.publish(key, payloadSerialized);
             }
         }
         await pipeline.exec();
@@ -579,23 +956,28 @@ class DomainEventSocketPublisher {
     async publish(ctx) {
         ctx.data = transformEventData(ctx.data);
         for(let i = 0; i < ctx.destinations.length; i++){
+            const destination = ctx.destinations[i];
             let namespace;
-            if (ctx.destinations[i].namespace) {
-                namespace = ctx.destinations[i].namespace;
+            if (destination.namespace) {
+                namespace = typeof destination.namespace === 'function' ? destination.namespace(ctx.data) : destination.namespace;
             } else {
                 namespace = '/';
             }
             const emitter = new redisEmitter.Emitter(this.client, {}, namespace);
-            const fullEventName = kit.buildDomainEventFullName(ctx.data.type, ctx.data.event);
+            const fullEventName = kit.buildDomainEventFullName(ctx.metadata.domain, ctx.metadata.event);
             const rooms = [
-                buildEventChannelName(ctx.destinations[i].channel)
+                buildEventChannelName(destination.channel)
             ];
-            if (typeof ctx.destinations[i].channel === 'function') {
-                rooms.push(buildEventChannelName(ctx.destinations[i].channel, ctx.data.data.id));
+            if (typeof destination.channel === 'function') {
+                rooms.push(buildEventChannelName(destination.channel, ctx.data.id));
             }
             for(let j = 0; j < rooms.length; j++){
                 emitter.in(rooms[j]).emit(fullEventName, {
-                    ...ctx.data,
+                    data: {
+                        data: ctx.data,
+                        type: ctx.metadata.domain,
+                        event: ctx.metadata.event
+                    },
                     meta: {
                         namespace,
                         roomName: rooms[j]
@@ -610,7 +992,7 @@ class DomainEventSocketPublisher {
     }
 }
 
-const instance$2 = singa.singa({
+const singaInstance = singa.singa({
     name: 'domainEventPublisher',
     factory: ()=>{
         const publisher = new DomainEventPublisher();
@@ -622,21 +1004,11 @@ const instance$2 = singa.singa({
         return publisher;
     }
 });
-function useDomainEventPublisher() {
-    return instance$2.use();
-}
-
-const instance$1 = singa.singa({
-    name: 'loki'
-});
-function setLokiFactory(factory) {
-    instance$1.setFactory(factory);
+function useDomainEventPublisherSinga() {
+    return singaInstance;
 }
-function isLokiClientUsable() {
-    return instance$1.has() || instance$1.hasFactory();
-}
-function useLokiClient() {
-    return instance$1.use();
+function useDomainEventPublisher() {
+    return singaInstance.use();
 }
 
 /*
@@ -825,7 +1197,9 @@ exports.ComponentError = ComponentError;
 exports.DomainEventPublisher = DomainEventPublisher;
 exports.DomainEventRedisPublisher = DomainEventRedisPublisher;
 exports.DomainEventSocketPublisher = DomainEventSocketPublisher;
+exports.LokiLogStore = LokiLogStore;
 exports.MemoryCacheAdapter = MemoryCacheAdapter;
+exports.MemoryLogStore = MemoryLogStore;
 exports.QueueRouter = QueueRouter;
 exports.QueueRouterRoutingType = QueueRouterRoutingType;
 exports.RedisCacheAdapter = RedisCacheAdapter;
@@ -839,6 +1213,7 @@ exports.isAmqpClientUsable = isAmqpClientUsable;
 exports.isAuthupClientUsable = isAuthupClientUsable;
 exports.isClientAuthenticationHookUsable = isClientAuthenticationHookUsable;
 exports.isComponentError = isComponentError;
+exports.isLogStoreUsable = isLogStoreUsable;
 exports.isLoggerUsable = isLoggerUsable;
 exports.isLokiClientUsable = isLokiClientUsable;
 exports.isQueuePayload = isQueuePayload;
@@ -849,6 +1224,7 @@ exports.isVaultClientUsable = isVaultClientUsable;
 exports.setAmqpClientFactory = setAmqpClientFactory;
 exports.setAuthupClientFactory = setAuthupClientFactory;
 exports.setClientAuthenticationHookFactory = setClientAuthenticationHookFactory;
+exports.setLogStoreFactory = setLogStoreFactory;
 exports.setLogger = setLogger;
 exports.setLoggerFactory = setLoggerFactory;
 exports.setLokiFactory = setLokiFactory;
@@ -860,6 +1236,8 @@ exports.useAuthupClient = useAuthupClient;
 exports.useCache = useCache;
 exports.useClientAuthenticationHook = useClientAuthenticationHook;
 exports.useDomainEventPublisher = useDomainEventPublisher;
+exports.useDomainEventPublisherSinga = useDomainEventPublisherSinga;
+exports.useLogStore = useLogStore;
 exports.useLogger = useLogger;
 exports.useLokiClient = useLokiClient;
 exports.useQueueRouter = useQueueRouter;