@privateaim/server-kit 0.8.14 → 0.8.16

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

@@ -0,0 +1,59 @@
+/*
+ * 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 { ObjectLiteral } from '@privateaim/kit';
+
+export type DomainEventDestination = {
+    namespace?: string | string[],
+    channel: string | string[]
+};
+
+export type DomainEventDestinations = DomainEventDestination[];
+
+export type DomainEventDestinationsFn<
+    T extends ObjectLiteral =ObjectLiteral,
+> = (data: T) => DomainEventDestination[];
+
+export type DomainEventMetadata = {
+    domain: string,
+    event: string,
+
+    request_path?: string | null,
+    request_method?: string | null;
+    request_ip_address?: string | null;
+    request_user_agent?: string | null;
+
+    actor_type?: string | null;
+    actor_id?: string | null;
+    actor_name?: string | null;
+};
+
+export type DomainEventPublishOptions<
+    T extends ObjectLiteral = ObjectLiteral,
+> = {
+    data: T,
+    dataPrevious?: T,
+    metadata: DomainEventMetadata,
+    destinations: DomainEventDestinations | DomainEventDestinationsFn<T>
+};
+
+export interface IDomainEventPublisher {
+    publish(ctx: DomainEventPublishOptions) : Promise<void>;
+}
+
+export type DomainEventConsumeOptions<
+    T extends ObjectLiteral = ObjectLiteral,
+> = {
+    data: T,
+    dataPrevious?: T,
+    metadata: DomainEventMetadata,
+    destinations: DomainEventDestinations
+};
+
+export interface IDomainEventConsumer {
+    consume(ctx: DomainEventConsumeOptions) : Promise<void>;
+}

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

@@ -6,7 +6,6 @@
  */
 
 import { isObject } from '@privateaim/kit';
-import type { DomainEventChannelName } from './type';
 
 export function transformEventData<T>(input: T) : T {
     if (isObject(input)) {
@@ -21,14 +20,3 @@ export function transformEventData<T>(input: T) : T {
 
     return input;
 }
-
-export function buildEventChannelName(
-    input: DomainEventChannelName,
-    id?: string | number,
-) : string {
-    if (typeof input === 'string') {
-        return input;
-    }
-
-    return input(id);
-}

package/src/services/index.ts

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

package/src/services/logger/module.ts

@@ -6,39 +6,30 @@
  */
 
 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;
+function toTransports(input: LoggerTransports) {
+    return Array.isArray(input) ? input : [input];
+}
 
+export function createLogger(ctx: LoggerCreateContext = {}) : Logger {
     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,
-            }),
+            ...(ctx.transports ? toTransports(ctx.transports) : []),
         ];
     } else {
         loggerTransports = [
             new transports.Console({
                 level: 'debug',
             }),
+            ...(ctx.transports ? toTransports(ctx.transports) : []),
         ];
     }
 
@@ -46,12 +37,11 @@ export function createLogger(ctx: LoggerCreateContext = {}) : Logger {
         format: format.combine(
             format.errors({ stack: true }),
             format.timestamp(),
-            format.colorize(),
             format.simple(),
         ),
         level: 'debug',
         transports: loggerTransports,
         // todo: deeply merge options
-        ...(options || {}),
+        ...(ctx.options || {}),
     });
 }

package/src/services/logger/types.ts

@@ -7,13 +7,13 @@
 
 import type { Logger, LoggerOptions } from 'winston';
 
+export type LoggerTransports = LoggerOptions['transports'];
+
 export type LoggerCreateContext = {
-    directory?: string,
-    options?: Partial<LoggerOptions>
+    options?: Partial<LoggerOptions>,
+    transports?: LoggerTransports
 };
 
-export type LoggerTransports = LoggerOptions['transports'];
-
 export type {
     Logger,
 };

package/dist/services/domain-event/type.d.ts

@@ -1,15 +0,0 @@
-import type { DomainEventRecord } from '@privateaim/kit';
-export type DomainEventChannelName = string | ((id?: string | number) => string);
-export type DomainEventDestination = {
-    namespace?: string;
-    channel: DomainEventChannelName;
-};
-export type DomainEventDestinations = DomainEventDestination[];
-export type DomainEventPublishContext<T extends DomainEventRecord = DomainEventRecord> = {
-    data: T;
-    destinations: DomainEventDestinations;
-};
-export interface IDomainEventPublisher {
-    publish(ctx: DomainEventPublishContext): Promise<void>;
-}
-//# sourceMappingURL=type.d.ts.map

package/dist/services/domain-event/type.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../../src/services/domain-event/type.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEzD,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,KAAK,MAAM,CAAC,CAAC;AACjF,MAAM,MAAM,sBAAsB,GAAG;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,sBAAsB,CAAA;CAClC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,sBAAsB,EAAE,CAAC;AAE/D,MAAM,MAAM,yBAAyB,CACjC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB,IAC/C;IACA,IAAI,EAAE,CAAC,CAAC;IACR,YAAY,EAAE,uBAAuB,CAAA;CACxC,CAAC;AAEF,MAAM,WAAW,qBAAqB;IAClC,OAAO,CAAC,GAAG,EAAE,yBAAyB,GAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3D"}

package/dist/services/loki/index.d.ts

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

package/dist/services/loki/index.d.ts.map

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

package/dist/services/loki/module.d.ts

@@ -1,3 +0,0 @@
-import { LokiClient, CompactorDeletionRequestCreate as LokiCompactorDeletionRequestCreate, Config as LokiConfig, ConfigInput as LokiConfigInput, DistributorPushStream as LokiDistributorPushStream, QuerierQueryRangeOptions as LokiQuerierQueryRangeOptions, QuerierQueryResult as LokiQuerierQueryResult, createClient as createLokiClient, nanoSeconds } from '@hapic/loki';
-export { LokiClient, LokiConfig, LokiConfigInput, LokiCompactorDeletionRequestCreate, LokiDistributorPushStream, LokiQuerierQueryRangeOptions, LokiQuerierQueryResult, createLokiClient, nanoSeconds, };
-//# sourceMappingURL=module.d.ts.map

package/dist/services/loki/module.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../../src/services/loki/module.ts"],"names":[],"mappings":"AAOA,OAAO,EACH,UAAU,EACV,8BAA8B,IAAI,kCAAkC,EACpE,MAAM,IAAI,UAAU,EACpB,WAAW,IAAI,eAAe,EAC9B,qBAAqB,IAAI,yBAAyB,EAClD,wBAAwB,IAAI,4BAA4B,EACxD,kBAAkB,IAAI,sBAAsB,EAC5C,YAAY,IAAI,gBAAgB,EAChC,WAAW,EACd,MAAM,aAAa,CAAC;AAErB,OAAO,EACH,UAAU,EACV,UAAU,EACV,eAAe,EACf,kCAAkC,EAClC,yBAAyB,EACzB,4BAA4B,EAC5B,sBAAsB,EACtB,gBAAgB,EAChB,WAAW,GACd,CAAC"}

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

@@ -1,6 +0,0 @@
-import type { Factory } from 'singa';
-import type { LokiClient } from '@hapic/loki';
-export declare function setLokiFactory(factory: Factory<LokiClient>): void;
-export declare function isLokiClientUsable(): boolean;
-export declare function useLokiClient(): LokiClient;
-//# sourceMappingURL=singleton.d.ts.map

package/dist/services/loki/singleton.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"singleton.d.ts","sourceRoot":"","sources":["../../../src/services/loki/singleton.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAErC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAM9C,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,QAE1D;AAED,wBAAgB,kBAAkB,YAEjC;AAED,wBAAgB,aAAa,eAE5B"}

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

@@ -1,27 +0,0 @@
-/*
- * 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 { DomainEventRecord } from '@privateaim/kit';
-
-export type DomainEventChannelName = string | ((id?: string | number) => string);
-export type DomainEventDestination = {
-    namespace?: string,
-    channel: DomainEventChannelName
-};
-
-export type DomainEventDestinations = DomainEventDestination[];
-
-export type DomainEventPublishContext<
-    T extends DomainEventRecord = DomainEventRecord,
-> = {
-    data: T,
-    destinations: DomainEventDestinations
-};
-
-export interface IDomainEventPublisher {
-    publish(ctx: DomainEventPublishContext) : Promise<void>;
-}

package/src/services/loki/module.ts

@@ -1,30 +0,0 @@
-/*
- * 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 {
-    LokiClient,
-    CompactorDeletionRequestCreate as LokiCompactorDeletionRequestCreate,
-    Config as LokiConfig,
-    ConfigInput as LokiConfigInput,
-    DistributorPushStream as LokiDistributorPushStream,
-    QuerierQueryRangeOptions as LokiQuerierQueryRangeOptions,
-    QuerierQueryResult as LokiQuerierQueryResult,
-    createClient as createLokiClient,
-    nanoSeconds,
-} from '@hapic/loki';
-
-export {
-    LokiClient,
-    LokiConfig,
-    LokiConfigInput,
-    LokiCompactorDeletionRequestCreate,
-    LokiDistributorPushStream,
-    LokiQuerierQueryRangeOptions,
-    LokiQuerierQueryResult,
-    createLokiClient,
-    nanoSeconds,
-};