@privateaim/server-kit 0.7.0

package/src/domain-event/redis/publish.ts

@@ -0,0 +1,41 @@
+/*
+ * 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 { DomainEventName } from '@privateaim/core-kit';
+import type { DomainsEventContext } from '@privateaim/core-kit';
+import type { Client } from 'redis-extension';
+import type { DomainEventDestinations } from '../type';
+import { buildDomainEventChannelName, transformDomainEventData } from '../utils';
+
+export async function publishDomainRedisEvent(
+    client: Client,
+    context: DomainsEventContext,
+    destinations: DomainEventDestinations,
+) : Promise<any> {
+    context = transformDomainEventData(context);
+
+    const json = JSON.stringify(context);
+
+    const pipeline = client.pipeline();
+    for (let i = 0; i < destinations.length; i++) {
+        const { namespace } = destinations[i];
+        const keyPrefix = (namespace ? `${namespace}:` : '');
+
+        let key = keyPrefix + buildDomainEventChannelName(destinations[i].channel);
+        pipeline.publish(key, json);
+
+        if (
+            context.event !== DomainEventName.CREATED &&
+            typeof destinations[i].channel === 'function'
+        ) {
+            key = keyPrefix + buildDomainEventChannelName(destinations[i].channel, context.data.id);
+            pipeline.publish(key, json);
+        }
+    }
+
+    return pipeline.exec();
+}

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

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

package/src/domain-event/socket/publish.ts

@@ -0,0 +1,57 @@
+/*
+ * 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 type { DomainsEventContext } from '@privateaim/core-kit';
+import { DomainEventName, buildDomainEventFullName } from '@privateaim/core-kit';
+import { Emitter } from '@socket.io/redis-emitter';
+import type { Client } from 'redis-extension';
+import type { DomainEventDestinations } from '../type';
+import { buildDomainEventChannelName, transformDomainEventData } from '../utils';
+
+export function publishDomainSocketEvent(
+    client: Client,
+    context: DomainsEventContext,
+    destinations: DomainEventDestinations,
+) {
+    context = transformDomainEventData(context);
+
+    for (let i = 0; i < destinations.length; i++) {
+        let emitter = new Emitter(client);
+        if (destinations[i].namespace) {
+            emitter = emitter.of(destinations[i].namespace);
+        }
+
+        let roomName = buildDomainEventChannelName(destinations[i].channel);
+
+        const fullEventName = buildDomainEventFullName(context.type, context.event);
+
+        emitter
+            .in(roomName)
+            .emit(fullEventName, {
+                ...context,
+                meta: {
+                    roomName,
+                },
+            });
+
+        if (
+            context.event !== DomainEventName.CREATED &&
+            typeof destinations[i].channel === 'function'
+        ) {
+            roomName = buildDomainEventChannelName(destinations[i].channel, context.data.id);
+            emitter
+                .in(roomName)
+                .emit(fullEventName, {
+                    ...context,
+                    meta: {
+                        roomName,
+                        roomId: context.data.id,
+                    },
+                });
+        }
+    }
+}

package/src/domain-event/type.ts

@@ -0,0 +1,14 @@
+/*
+ * 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.
+ */
+
+export type DomainEventChannelName = string | ((id?: string | number) => string);
+export type DomainEventDestination = {
+    namespace?: string,
+    channel: DomainEventChannelName
+};
+
+export type DomainEventDestinations = DomainEventDestination[];

package/src/domain-event/utils.ts

@@ -0,0 +1,34 @@
+/*
+ * 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 { isObject } from '@privateaim/kit';
+import type { DomainEventChannelName } from './type';
+
+export function transformDomainEventData<T>(input: T) : T {
+    if (isObject(input)) {
+        const keys = Object.keys(input);
+        for (let i = 0; i < keys.length; i++) {
+            const value = input[keys[i]];
+            if (value instanceof Date) {
+                input[keys[i]] = value.toISOString();
+            }
+        }
+    }
+
+    return input;
+}
+
+export function buildDomainEventChannelName(
+    input: DomainEventChannelName,
+    id?: string | number,
+) : string {
+    if (typeof input === 'string') {
+        return input;
+    }
+
+    return input(id);
+}

package/src/index.ts

@@ -0,0 +1,12 @@
+/*
+ * 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.
+ */
+
+export * from './core';
+export * from './services';
+export * from './domain-event';
+export * from './type';
+export * from './utils';

package/src/services/amqp/index.ts

@@ -0,0 +1,8 @@
+/*
+ * Copyright (c) 2024.
+ * 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';

package/src/services/amqp/module.ts

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 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 'amqp-extension';
+import type { Factory } from 'singa';
+import { singa } from 'singa';
+
+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();
+}

package/src/services/authup/helpers.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 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 { TokenCreatorOptions } from '@authup/core-http-kit';
+import { isVaultClientUsable, useVaultClient } from '../vault';
+
+export function guessAuthupTokenCreatorOptions() : TokenCreatorOptions {
+    let options : TokenCreatorOptions;
+    if (isVaultClientUsable()) {
+        options = {
+            type: 'robotInVault',
+            name: 'system',
+            vault: useVaultClient(),
+        };
+    } else {
+        options = {
+            type: 'user',
+            name: 'admin',
+            password: 'start123',
+        };
+    }
+
+    return options;
+}

package/src/services/authup/index.ts

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

package/src/services/authup/module.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 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 { ClientOptions } from '@authup/core-http-kit';
+import {
+    Client, mountClientResponseErrorTokenHook as mountAuthupClientResponseErrorTokenHook,
+    mountClientResponseErrorTokenHook,
+} from '@authup/core-http-kit';
+import { guessAuthupTokenCreatorOptions } from './helpers';
+
+export {
+    mountAuthupClientResponseErrorTokenHook,
+};
+
+export class AuthupClient extends Client {
+    constructor(options: ClientOptions = {}) {
+        super(options);
+
+        mountClientResponseErrorTokenHook(this, {
+            baseURL: options.baseURL,
+            tokenCreator: guessAuthupTokenCreatorOptions(),
+        });
+    }
+}

package/src/services/authup/singleton.ts

@@ -0,0 +1,26 @@
+/*
+ * 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 '@authup/core-http-kit';
+import type { Factory } from 'singa';
+import { singa } from 'singa';
+
+const instance = singa<Client>({
+    name: 'authup',
+});
+
+export function useAuthupClient() {
+    return instance.use();
+}
+
+export function isAuthupClientUsable() {
+    return instance.has() || instance.hasFactory();
+}
+
+export function setAuthupClientFactory(factory: Factory<Client>) {
+    instance.setFactory(factory);
+}

package/src/services/index.ts

@@ -0,0 +1,12 @@
+/*
+ * 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.
+ */
+
+export * from './amqp';
+export * from './authup';
+export * from './logger';
+export * from './redis';
+export * from './vault';

package/src/services/logger/index.ts

@@ -0,0 +1,10 @@
+/*
+ * Copyright (c) 2024.
+ * 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';
+export * from './singleton';

package/src/services/logger/module.ts

@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import { read } from 'envix';
+import path from 'node:path';
+import { EnvironmentName } from 'typeorm-extension';
+import type { Logger } from 'winston';
+import { createLogger as create, format, transports } from 'winston';
+import type { LoggerCreateContext, LoggerTransports } from './types';
+
+export function createLogger(ctx: LoggerCreateContext = {}) : Logger {
+    const { directory, options = {} } = ctx;
+
+    let loggerTransports : LoggerTransports;
+    if (read('env') === EnvironmentName.PRODUCTION) {
+        loggerTransports = [
+            new transports.Console({
+                level: 'info',
+            }),
+            new transports.File({
+                filename: path.join(directory || process.cwd(), 'access.log'),
+                level: 'http',
+                maxsize: 10 * 1024 * 1024, // 10MB
+                maxFiles: 5,
+            }),
+            new transports.File({
+                filename: path.join(directory || process.cwd(), 'error.log'),
+                level: 'warn',
+                maxsize: 10 * 1024 * 1024, // 10MB
+                maxFiles: 5,
+            }),
+        ];
+    } else {
+        loggerTransports = [
+            new transports.Console({
+                level: 'debug',
+            }),
+        ];
+    }
+
+    return create({
+        format: format.combine(
+            format.timestamp(),
+            format.colorize(),
+            format.simple(),
+        ),
+        level: 'debug',
+        transports: loggerTransports,
+        // todo: deeply merge options
+        ...(options || {}),
+    });
+}

package/src/services/logger/singleton.ts

@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2023.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import { type Factory, singa } from 'singa';
+import type { Logger } from 'winston';
+
+const instance = singa<Logger>({
+    name: 'logger',
+});
+
+export function setLoggerFactory(factory: Factory<Logger>) {
+    instance.setFactory(factory);
+}
+
+export function isLoggerUsable() {
+    return instance.has() || instance.hasFactory();
+}
+
+export function setLogger(input: Logger) {
+    instance.set(input);
+}
+
+export function useLogger() {
+    return instance.use();
+}

package/src/services/logger/types.ts

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 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 { Logger, LoggerOptions } from 'winston';
+
+export type LoggerCreateContext = {
+    directory?: string,
+    options?: Partial<LoggerOptions>
+};
+
+export type LoggerTransports = LoggerOptions['transports'];
+
+export type {
+    Logger,
+};

package/src/services/redis/helpers.ts

@@ -0,0 +1,12 @@
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import { buildKeyPath as buildRedisKeyPath } from 'redis-extension';
+
+export {
+    buildRedisKeyPath,
+};

package/src/services/redis/index.ts

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

package/src/services/redis/module.ts

@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import {
+    Cache as RedisCache,
+    Client as RedisClient,
+    ClientOptions as RedisClientOptions,
+    KeyPathID as RedisKeyPathID,
+    createClient as createRedisClient,
+} from 'redis-extension';
+
+export {
+    createRedisClient,
+    RedisClient,
+    RedisClientOptions,
+    RedisKeyPathID,
+    RedisCache,
+};

package/src/services/redis/singleton-publish.ts

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 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 { singa } from 'singa';
+import { useRedisClient } from './singleton';
+
+const instance = singa<Client>({
+    name: 'redisPublish',
+    factory: () => useRedisClient().duplicate(),
+});
+
+export function useRedisPublishClient() {
+    return instance.use();
+}

package/src/services/redis/singleton-subscribe.ts

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 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 { singa } from 'singa';
+import { useRedisClient } from './singleton';
+
+const instance = singa<Client>({
+    name: 'redisSubscribe',
+    factory: () => useRedisClient().duplicate(),
+});
+
+export function useRedisSubscribeClient() {
+    return instance.use();
+}

package/src/services/redis/singleton.ts

@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 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 { Factory } from 'singa';
+import { singa } from 'singa';
+
+const instance = singa<Client>({
+    name: 'redis',
+});
+
+export function setRedisFactory(factory: Factory<Client>) {
+    instance.setFactory(factory);
+}
+
+export function isRedisClientUsable() {
+    return instance.has() || instance.hasFactory();
+}
+
+export function setRedisClient(input: Client) {
+    instance.set(input);
+}
+
+export function useRedisClient() {
+    return instance.use();
+}

package/src/services/vault/index.ts

@@ -0,0 +1,9 @@
+/*
+ * Copyright (c) 2024.
+ * 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';

package/src/services/vault/module.ts

@@ -0,0 +1,13 @@
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import { VaultClient, createClient as createVaultClient } from '@hapic/vault';
+
+export {
+    VaultClient,
+    createVaultClient,
+};

package/src/services/vault/singleton.ts

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 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 { Factory } from 'singa';
+import { singa } from 'singa';
+import type { VaultClient } from '@hapic/vault';
+
+const instance = singa<VaultClient>({
+    name: 'vault',
+});
+
+export function setVaultFactory(factory: Factory<VaultClient>) {
+    instance.setFactory(factory);
+}
+
+export function isVaultClientUsable() {
+    return instance.has() || instance.hasFactory();
+}
+
+export function useVaultClient() {
+    return instance.use();
+}

package/src/type.ts

@@ -0,0 +1,8 @@
+/*
+ * 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.
+ */
+
+export type ObjectLiteral = Record<string, any>;

package/src/utils/has-property.ts

@@ -0,0 +1,13 @@
+/*
+ * 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.
+ */
+
+export function hasOwnProperty<X extends Record<string, any>, Y extends PropertyKey>(
+    obj: X,
+    prop: Y,
+): obj is X & Record<Y, unknown> {
+    return Object.prototype.hasOwnProperty.call(obj, prop);
+}

package/src/utils/index.ts

@@ -0,0 +1,8 @@
+/*
+ * 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.
+ */
+
+export * from './has-property';

package/tsconfig.build.json

@@ -0,0 +1,11 @@
+{
+    "extends": "../../tsconfig.build.json",
+
+    "compilerOptions": {
+        "outDir": "./dist"
+    },
+
+    "include": [
+        "src/**/*.ts"
+    ]
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+    "extends": "../../tsconfig.json",
+    "compilerOptions": {
+        "paths": {
+            "@privateaim/core-kit": ["./packages/core-kit/src"],
+            "@privateaim/kit": ["./packages/kit/src"]
+        }
+    }
+}