@privateaim/server-kit 0.8.21 → 0.8.23

package/src/core/component/type.ts

@@ -6,32 +6,58 @@
  */
 
 import type { ObjectLiteral } from '../../type';
-import type { ComponentError } from './error';
-
-export type Component = {
-    start: () => void,
-    trigger?: (
-        key: string,
-        value?: ObjectLiteral,
-        metadata?: ObjectLiteral
-    ) => void
+import type { ComponentHandler, ComponentHandlerFn } from './handler';
+
+export type ComponentData = ObjectLiteral;
+export type ComponentMetadata = {
+    correlationId?: string,
+    [key: string]: any
 };
 
+export type ComponentStartFn = () => Promise<void> | void;
+
 export type ComponentErrorOptions = {
     code?: string | null,
     message?: string
     cause?: unknown
 };
 
-export type ComponentContextWithError<
-    T extends ObjectLiteral = ObjectLiteral,
-> = T & {
-    error: ComponentError | Error
-};
+export type ComponentEventMapValue = [ComponentData, ComponentMetadata];
+export type ComponentEventMap = Record<string, ComponentEventMapValue>;
 
-export type ComponentContextWithCommand<
-    T extends ObjectLiteral = ObjectLiteral,
-    C extends string = string,
-> = Omit<T, 'command'> & {
-    command: C
+export type ComponentHandleOptions<
+    EventMap extends ComponentEventMap = ComponentEventMap,
+> = {
+    handle?: ComponentHandlerFn<EventMap>
 };
+
+export type ComponentHandleFnArgsForMap<
+    EventMap extends ComponentEventMap = ComponentEventMap,
+> = {
+    [K in keyof EventMap]: [
+        key: K & string,
+        data: EventMap[K][0],
+        metadata?: EventMap[K][1] | undefined,
+        options?: ComponentHandleOptions<EventMap>,
+    ]
+}[keyof EventMap];
+
+export type ComponentHandlerCallFnForMap<
+    EventMap extends ComponentEventMap = ComponentEventMap,
+> = (
+    ...input: ComponentHandleFnArgsForMap<EventMap>
+) => Promise<void> | void;
+
+export type ComponentHandlers<EventMap extends ComponentEventMap> = Map<
+keyof EventMap | '*',
+{
+    [Key in keyof EventMap]?: ComponentHandler<EventMap, Key> | ComponentHandlerFn<EventMap, Key>
+}[keyof EventMap]
+>;
+
+export interface Component<
+    EventMap extends ComponentEventMap = ComponentEventMap,
+> {
+    start: ComponentStartFn,
+    handle?: ComponentHandlerCallFnForMap<EventMap>
+}

package/src/core/index.ts

@@ -7,5 +7,4 @@
 
 export * from './aggregator';
 export * from './component';
-export * from './queue';
 export * from './queue-router';

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

@@ -40,6 +40,9 @@ export type QueueRouterPayload<
     metadata: QueueRouterPayloadMetadata
 };
 
+export type QueueRouterPayloadMetadataInput = Partial<Pick<QueueRouterPayloadMetadata, 'timestamp'>> &
+Omit<QueueRouterPayloadMetadata, 'timestamp'>;
+
 export type QueueRouterPayloadInput<
     KEY = string,
     VALUE = Record<string, any>,
@@ -47,8 +50,7 @@ export type QueueRouterPayloadInput<
     id?: string,
     type: KEY,
     data?: VALUE,
-    metadata: Partial<Pick<QueueRouterPayloadMetadata, 'timestamp'>> &
-    Omit<QueueRouterPayloadMetadata, 'timestamp'>
+    metadata: QueueRouterPayloadMetadataInput
 };
 
 export type QueueRouterHandler<

package/src/services/cache/adapters/memory.ts

@@ -5,8 +5,8 @@
  * view the LICENSE file that was distributed with this source code.
  */
 
-import type { Options } from '@isaacs/ttlcache';
-import TTLCache from '@isaacs/ttlcache';
+import type { TTLCacheOptions } from '@isaacs/ttlcache';
+import { TTLCache } from '@isaacs/ttlcache';
 import type { CacheClearOptions, CacheSetOptions } from '../types';
 import type { CacheAdapter } from './types';
 
@@ -15,7 +15,7 @@ export class MemoryCacheAdapter<
 > implements CacheAdapter {
     protected instance : TTLCache<string, VALUE>;
 
-    constructor(options: Options<string, VALUE> = {}) {
+    constructor(options: TTLCacheOptions<string, VALUE> = {}) {
         this.instance = new TTLCache<string, VALUE>({
             checkAgeOnGet: true,
             ttl: Infinity,
@@ -52,7 +52,10 @@ export class MemoryCacheAdapter<
             const keys = this.instance.keys();
             let iterator = keys.next();
             while (!iterator.done) {
-                if (iterator.value.startsWith(options.prefix)) {
+                if (
+                    typeof iterator.value === 'string' &&
+                    iterator.value.startsWith(options.prefix)
+                ) {
                     this.instance.delete(iterator.value);
                 }
 

package/src/services/index.ts

@@ -10,6 +10,7 @@ export * from './authup';
 export * from './authup-client-authentication-hook';
 export * from './cache';
 export * from './entity-event';
+export * from './task-manager';
 export * from './logger';
 export * from './redis';
 export * from './vault';

package/src/services/redis/module.ts

@@ -5,14 +5,17 @@
  * view the LICENSE file that was distributed with this source code.
  */
 
+import type { ClientOptions as RedisClientOptions } from 'redis-extension';
 import {
     Client as RedisClient,
-    ClientOptions as RedisClientOptions,
     createClient as createRedisClient,
 } from 'redis-extension';
 
 export {
     createRedisClient,
     RedisClient,
+};
+
+export type {
     RedisClientOptions,
 };

package/src/services/task-manager/helpers.ts

@@ -0,0 +1,15 @@
+/*
+ * 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 type { TaskEntry } from './types';
+
+export function isTaskEntry(input: unknown) : input is TaskEntry {
+    return isObject(input) &&
+        typeof (input as TaskEntry).type === 'string' &&
+        isObject((input as TaskEntry).data);
+}

package/src/services/task-manager/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 './module';
+export * from './types';

package/src/services/task-manager/module.ts

@@ -0,0 +1,131 @@
+/*
+ * 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 { HOUR_IN_MS, WEEK_IN_MS, createNanoID } from '@privateaim/kit';
+import type { Cache } from '../cache';
+import type {
+    TaskEntry, TaskEntryResolved, TaskManagerCreateOptions, TaskTypeMap,
+} from './types';
+import { isTaskEntry } from './helpers';
+
+export class TaskManager<
+    EntityMap extends TaskTypeMap = TaskTypeMap,
+> {
+    protected driver : Cache;
+
+    constructor(driver: Cache) {
+        this.driver = driver;
+    }
+
+    /**
+     * Store a specific job by type.
+     *
+     * @param type
+     * @param data
+     * @param options
+     */
+    async create<Key extends keyof EntityMap>(
+        type: Key & string,
+        data: EntityMap[Key],
+        options: TaskManagerCreateOptions<EntityMap, Key> = {},
+    ) : Promise<string> {
+        let id : string;
+        if (options.key) {
+            id = `task:${options.key(type, data)}`;
+        } else {
+            id = `task:${createNanoID()}`;
+        }
+
+        if (options.lock) {
+            const isLocked = await this.isLocked(id);
+            if (isLocked) {
+                return id;
+            }
+        }
+
+        const entity : TaskEntry = {
+            data,
+            type,
+        };
+
+        await this.driver.set(id, entity, {
+            ttl: WEEK_IN_MS,
+        });
+
+        if (options.lock) {
+            await this.createLock(id);
+        }
+
+        return id;
+    }
+
+    /**
+     * Get a job by id and type
+     *
+     * @param type
+     * @param id
+     * @param autoDelete
+     */
+    async get<Key extends keyof EntityMap>(
+        type: Key & string,
+        id: string,
+        autoDelete: boolean = true,
+    ) : Promise<EntityMap[Key]> {
+        const entity = await this.resolve(id, autoDelete);
+        if (!entity) {
+            throw new Error(`Job with id ${id} could not be found.`);
+        }
+
+        if (type && entity.type !== type) {
+            throw new Error(`Job type ${entity.type} does not not match with ${type}`);
+        }
+
+        return entity.data as EntityMap[Key];
+    }
+
+    /**
+     * Find a random job.
+     *
+     * @param id
+     * @param autoDelete
+     */
+    async resolve(
+        id: string,
+        autoDelete: boolean = true,
+    ) : Promise<TaskEntryResolved<EntityMap> | undefined> {
+        const entity : TaskEntry | undefined = await this.driver.get(id);
+        if (!entity || !isTaskEntry(entity)) {
+            return undefined;
+        }
+
+        await this.clearLock(id);
+
+        if (autoDelete) {
+            await this.driver.drop(id);
+        }
+
+        return entity as TaskEntryResolved<EntityMap>;
+    }
+
+    // -------------------------------------------------
+
+    protected async createLock(id: string) {
+        await this.driver.set(`taskLock:${id}`, true, {
+            ttl: HOUR_IN_MS,
+        });
+    }
+
+    protected async clearLock(id: string) {
+        await this.driver.drop(`taskLock:${id}`);
+    }
+
+    protected async isLocked(id: string) : Promise<boolean> {
+        const isActive = await this.driver.get(`taskLock:${id}`);
+
+        return !!isActive;
+    }
+}

package/src/services/task-manager/types.ts

@@ -0,0 +1,32 @@
+/*
+ * 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 TaskEntry<
+    Data extends ObjectLiteral = ObjectLiteral,
+    Key extends string = string,
+> = {
+    data: Data,
+    type: Key,
+};
+
+export type TaskTypeMap = {
+    [key: string]: ObjectLiteral
+};
+
+export type TaskEntryResolved<EntityMap extends TaskTypeMap = TaskTypeMap> = {
+    [Key in keyof EntityMap]?: TaskEntry<EntityMap[Key], Key & string>;
+}[keyof EntityMap];
+
+export type TaskManagerCreateOptions<
+    EntityMap extends ObjectLiteral = ObjectLiteral,
+    Key extends keyof EntityMap = keyof EntityMap,
+> = {
+    lock?: boolean;
+    key?: (type: Key & string, data: EntityMap[Key]) => string
+};

package/test/unit/logger.spec.ts

@@ -5,6 +5,7 @@
  * view the LICENSE file that was distributed with this source code.
  */
 
+import { describe, expect, it } from 'vitest';
 import { createLogger } from 'winston';
 import { LoggerMemoryTransport } from '../../src';
 import { CustomError } from '../data/error';

package/test/unit/memory-cache.spec.ts

@@ -5,6 +5,7 @@
  * view the LICENSE file that was distributed with this source code.
  */
 
+import { describe, expect, it } from 'vitest';
 import { Cache, MemoryCacheAdapter } from '../../src';
 
 describe('memory-cache', () => {

package/test/vitest.config.ts

@@ -0,0 +1,17 @@
+/*
+ * 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.
+ */
+
+// eslint-disable-next-line import/no-extraneous-dependencies
+import swc from 'unplugin-swc';
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+    test: {
+        include: ['test/unit/**/*.spec.ts'],
+    },
+    plugins: [swc.vite()],
+});

package/dist/core/component/handler/module.d.ts

@@ -1,13 +0,0 @@
-import type { ObjectLiteral } from '../../../type';
-import type { ComponentHandler, ComponentHandlerFn } from './types';
-export declare class ComponentHandlers {
-    protected initializing: boolean;
-    protected initialized: boolean;
-    protected handlers: Record<string, ComponentHandlerFn | ComponentHandler>;
-    constructor();
-    mount<K extends string>(key: K, fn: ComponentHandler<K, any> | ComponentHandlerFn<K, any>): void;
-    unmount(key: string): void;
-    initialize(): Promise<void>;
-    execute(key: string, value?: ObjectLiteral, metadata?: ObjectLiteral): Promise<void>;
-}
-//# sourceMappingURL=module.d.ts.map

package/dist/core/component/handler/module.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../../../src/core/component/handler/module.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEnD,OAAO,KAAK,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAEpE,qBAAa,iBAAiB;IAC1B,SAAS,CAAC,YAAY,EAAG,OAAO,CAAC;IAEjC,SAAS,CAAC,WAAW,EAAG,OAAO,CAAC;IAEhC,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,GAAG,gBAAgB,CAAC,CAAC;;IAQ1E,KAAK,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,gBAAgB,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,kBAAkB,CAAC,CAAC,EAAE,GAAG,CAAC;IAIzF,OAAO,CAAC,GAAG,EAAE,MAAM;IAIb,UAAU,IAAK,OAAO,CAAC,IAAI,CAAC;IAuB5B,OAAO,CACT,GAAG,EAAE,MAAM,EACX,KAAK,GAAE,aAAkB,EACzB,QAAQ,GAAE,aAAkB,GAC5B,OAAO,CAAC,IAAI,CAAC;CAcpB"}

package/dist/core/queue/index.d.ts

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

package/dist/core/queue/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/queue/index.ts"],"names":[],"mappings":"AAOA,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC"}

package/dist/core/queue/type.d.ts

@@ -1,12 +0,0 @@
-import type { ObjectLiteral } from '../../type';
-export type QueuePayloadError = {
-    code: string;
-    message: string;
-    step?: string | number;
-};
-export type QueuePayload<T extends ObjectLiteral = ObjectLiteral, M extends ObjectLiteral = ObjectLiteral> = {
-    data: T;
-    metadata: M;
-    error?: QueuePayloadError;
-};
-//# sourceMappingURL=type.d.ts.map

package/dist/core/queue/type.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../../src/core/queue/type.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEhD,MAAM,MAAM,iBAAiB,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,YAAY,CACpB,CAAC,SAAS,aAAa,GAAG,aAAa,EACvC,CAAC,SAAS,aAAa,GAAG,aAAa,IACvC;IACA,IAAI,EAAE,CAAC,CAAC;IACR,QAAQ,EAAE,CAAC,CAAC;IACZ,KAAK,CAAC,EAAE,iBAAiB,CAAA;CAC5B,CAAC"}

package/dist/core/queue/utils.d.ts

@@ -1,3 +0,0 @@
-import type { QueuePayload } from './type';
-export declare function isQueuePayload(input: unknown): input is QueuePayload;
-//# sourceMappingURL=utils.d.ts.map

package/dist/core/queue/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/core/queue/utils.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAE3C,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAI,KAAK,IAAI,YAAY,CAMrE"}