@koalarx/nest 1.2.3 → 1.3.1

package/core/backgroud-services/cron-service/{cron-job.d.ts → cron-job.handler.base.d.ts}

@@ -2,7 +2,7 @@ import { ILoggingService } from '../../../services/logging/ilogging.service';
 import { IRedLockService } from '../../../services/redlock/ired-lock.service';
 import { RequestResult } from '../../request-overflow/request-result';
 export type CronJobResponse = RequestResult<Error, null>;
-export declare abstract class CronJob {
+export declare abstract class CronJobHandlerBase {
     private readonly redlockService;
     private readonly loggingService;
     private readonly _timeout;

package/core/backgroud-services/cron-service/{cron-job.js → cron-job.handler.base.js}

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CronJob = void 0;
+exports.CronJobHandlerBase = void 0;
 const delay_1 = require("@koalarx/utils/operators/delay");
 const koala_global_vars_1 = require("../../koala-global-vars");
-class CronJob {
+class CronJobHandlerBase {
     redlockService;
     loggingService;
     _timeout;
@@ -46,4 +46,4 @@ class CronJob {
         }
     }
 }
-exports.CronJob = CronJob;
+exports.CronJobHandlerBase = CronJobHandlerBase;

package/core/backgroud-services/cron-service/{cron-job.spec.d.ts → cron-job.handler.spec.d.ts}

@@ -1,5 +1,5 @@
-import { CronJob, CronJobResponse } from './cron-job';
-export declare class CronJobTest extends CronJob {
+import { CronJobHandlerBase, CronJobResponse } from './cron-job.handler.base';
+export declare class CronJobTest extends CronJobHandlerBase {
     constructor();
     static isCalled(): Promise<CronJobResponse>;
     protected run(): Promise<CronJobResponse>;

package/core/backgroud-services/cron-service/{cron-job.spec.js → cron-job.handler.spec.js}

@@ -6,8 +6,8 @@ const vitest_1 = require("vitest");
 const fake_logging_service_1 = require("../../../test/services/fake-logging.service");
 const fake_red_lock_service_1 = require("../../../test/services/fake-red-lock.service");
 const request_result_1 = require("../../request-overflow/request-result");
-const cron_job_1 = require("./cron-job");
-class CronJobTest extends cron_job_1.CronJob {
+const cron_job_handler_base_1 = require("./cron-job.handler.base");
+class CronJobTest extends cron_job_handler_base_1.CronJobHandlerBase {
     constructor() {
         super(new fake_red_lock_service_1.FakeRedLockService(), new fake_logging_service_1.FakeLoggingService());
     }

package/core/backgroud-services/event-service/{event-handler.d.ts → event-handler.base.d.ts}

@@ -1,5 +1,5 @@
 import { EventClass } from './event-class';
-export declare abstract class EventHandler<TEvent extends EventClass<any>> {
+export declare abstract class EventHandlerBase<TEvent extends EventClass<any>> {
     setupSubscriptions(): void;
     abstract handleEvent(event: TEvent): Promise<void>;
 }

package/core/backgroud-services/event-service/{event-handler.js → event-handler.base.js}

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventHandler = void 0;
+exports.EventHandlerBase = void 0;
 const event_queue_1 = require("./event-queue");
-class EventHandler {
+class EventHandlerBase {
     setupSubscriptions() {
         event_queue_1.EventQueue.register(this.handleEvent.bind(this), this.constructor.name);
     }
 }
-exports.EventHandler = EventHandler;
+exports.EventHandlerBase = EventHandlerBase;

package/core/backgroud-services/event-service/event-job.d.ts

@@ -1,12 +1,12 @@
 import { Type } from '@nestjs/common';
 import { EventClass } from './event-class';
-import { EventHandler } from './event-handler';
+import { EventHandlerBase } from './event-handler.base';
 import { EventQueue } from './event-queue';
 export declare abstract class EventJob<TEntity> {
     _id: `${string}-${string}-${string}-${string}-${string}`;
     private _eventQueue;
     constructor();
-    abstract defineHandlers(): Array<Type<EventHandler<any>>>;
+    abstract defineHandlers(): Array<Type<EventHandlerBase<any>>>;
     get eventQueue(): EventQueue[];
     clearQueue(): void;
     addEvent(event: EventClass<TEntity>): void;

package/core/backgroud-services/event-service/event-queue.spec.js

@@ -2,12 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const vitest_1 = require("vitest");
 const event_class_1 = require("./event-class");
-const event_handler_1 = require("./event-handler");
+const event_handler_base_1 = require("./event-handler.base");
 const event_job_1 = require("./event-job");
 const event_queue_1 = require("./event-queue");
 class CustomEvent extends event_class_1.EventClass {
 }
-class CustomEventHandler extends event_handler_1.EventHandler {
+class CustomEventHandler extends event_handler_base_1.EventHandlerBase {
     static async isCalled() {
         return null;
     }

package/core/controllers/controller.decorator.d.ts

@@ -0,0 +1,2 @@
+import { RouterConfigBase } from './router-config.base';
+export declare function Controller(config: RouterConfigBase): (target: any) => void;

package/core/controllers/controller.decorator.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Controller = void 0;
+const common_1 = require("@nestjs/common");
+const swagger_1 = require("@nestjs/swagger");
+function Controller(config) {
+    return function (target) {
+        (0, common_1.Controller)(config.group)(target);
+        (0, swagger_1.ApiTags)(config.tag)(target);
+    };
+}
+exports.Controller = Controller;

package/core/koala-app.d.ts

@@ -1,22 +1,34 @@
 import { INestApplication, Type } from '@nestjs/common';
 import { BaseExceptionFilter } from '@nestjs/core';
-import { CronJob } from '../core/backgroud-services/cron-service/cron-job';
-import { EventHandler } from '../core/backgroud-services/event-service/event-handler';
+import { SecuritySchemeObject } from '@nestjs/swagger/dist/interfaces/open-api-spec.interface';
+import { CronJobHandlerBase } from './backgroud-services/cron-service/cron-job.handler.base';
+import { EventHandlerBase } from './backgroud-services/event-service/event-handler.base';
 import { PrismaTransactionalClient } from './database/prisma-transactional-client';
+interface ApiDocAuthorizationConfig {
+    name: string;
+    config: SecuritySchemeObject;
+}
+interface ApiDocServerConfig {
+    url: string;
+    description: string;
+}
+type ScalarTheme = 'alternate' | 'default' | 'moon' | 'purple' | 'solarized' | 'bluePlanet' | 'saturn' | 'kepler' | 'mars' | 'deepSpace' | 'none';
 interface ApiDocConfig {
     endpoint: string;
     title: string;
     ui?: 'swagger' | 'scalar';
+    theme?: ScalarTheme;
     description?: string;
     externalDoc?: {
         message: string;
         url: string;
     };
+    servers?: ApiDocServerConfig[];
     version: string;
-    withAuthorization?: boolean;
+    authorizations?: boolean | ApiDocAuthorizationConfig[];
 }
-type CronJobClass = string | symbol | Function | Type<CronJob>;
-type EventJobClass = string | symbol | Function | Type<EventHandler<any>>;
+type CronJobClass = string | symbol | Function | Type<CronJobHandlerBase>;
+type EventJobClass = string | symbol | Function | Type<EventHandlerBase<any>>;
 export declare class KoalaApp {
     private readonly app;
     private _globalExceptionFilter;

package/core/koala-app.js

@@ -72,13 +72,28 @@ class KoalaApp {
             .setTitle(config.title)
             .setVersion(config.version);
         if (config.description) {
-            documentBuilder.setDescription(config.description);
+            if (config.externalDoc) {
+                documentBuilder.setDescription(`${config.description}\n\n[${config.externalDoc.message}](${config.externalDoc.url})`);
+            }
+            else {
+                documentBuilder.setDescription(config.description);
+            }
         }
-        if (config.externalDoc) {
-            documentBuilder.setExternalDoc(config.externalDoc.message, config.externalDoc.url);
+        if (config.authorizations) {
+            if (Array.isArray(config.authorizations)) {
+                for (const auth of config.authorizations) {
+                    documentBuilder.addBearerAuth(auth.config, auth.name);
+                    documentBuilder.addSecurityRequirements(auth.name);
+                }
+            }
+            else {
+                documentBuilder.addBearerAuth();
+            }
         }
-        if (config.withAuthorization) {
-            documentBuilder.addBearerAuth();
+        if (config.servers) {
+            for (const server of config.servers) {
+                documentBuilder.addServer(server.url, server.description);
+            }
         }
         const document = swagger_1.SwaggerModule.createDocument(this.app, documentBuilder.build());
         const swaggerEndpoint = config.endpoint;
@@ -89,7 +104,49 @@ class KoalaApp {
             swaggerUiEnabled: config.ui !== 'scalar',
         });
         if (config.ui === 'scalar') {
-            this.app.use(swaggerEndpoint, (0, nestjs_api_reference_1.apiReference)({ spec: { content: document } }));
+            this.app.use(swaggerEndpoint, (0, nestjs_api_reference_1.apiReference)({
+                spec: {
+                    content: document,
+                },
+                hideModels: true,
+                hideDownloadButton: true,
+                hideClientButton: true,
+                theme: config.theme ?? 'default',
+                hiddenClients: [
+                    'libcurl',
+                    'clj_http',
+                    'restsharp',
+                    'native',
+                    'http1.1',
+                    'asynchttp',
+                    'nethttp',
+                    'okhttp',
+                    'unirest',
+                    'xhr',
+                    'okhttp',
+                    'native',
+                    'request',
+                    'unirest',
+                    'nsurlsession',
+                    'cohttp',
+                    'guzzle',
+                    'http1',
+                    'http2',
+                    'webrequest',
+                    'restmethod',
+                    'requests',
+                    'httr',
+                    'native',
+                    'httpie',
+                    'wget',
+                    'nsurlsession',
+                    'undici',
+                ],
+                metaData: {
+                    title: config.title,
+                    description: config.description,
+                },
+            }));
         }
         return this;
     }

package/core/koala-nest.module.d.ts

@@ -1,9 +1,14 @@
-import { DynamicModule, Provider } from '@nestjs/common';
+import { DynamicModule, Provider, Type } from '@nestjs/common';
 import { ZodType } from 'zod';
 import { ILoggingService } from '../services/logging/ilogging.service';
+import { CronJobHandlerBase } from './backgroud-services/cron-service/cron-job.handler.base';
+import { EventHandlerBase } from './backgroud-services/event-service/event-handler.base';
 interface KoalaNestModuleConfig {
     logging?: Provider<ILoggingService>;
     env?: ZodType;
+    constrollers?: Type<any>[];
+    cronJobs?: Type<CronJobHandlerBase>[];
+    eventJobs?: Type<EventHandlerBase<any>>[];
 }
 export declare class KoalaNestModule {
     static register(config?: KoalaNestModuleConfig): DynamicModule;

package/core/koala-nest.module.js

@@ -21,6 +21,9 @@ const ired_lock_service_1 = require("../services/redlock/ired-lock.service");
 const red_lock_service_1 = require("../services/redlock/red-lock.service");
 let KoalaNestModule = exports.KoalaNestModule = KoalaNestModule_1 = class KoalaNestModule {
     static register(config) {
+        const controllers = config?.constrollers ?? [];
+        const cronJobsProviders = config?.cronJobs ?? [];
+        const eventJobsProviders = config?.eventJobs ?? [];
         return {
             module: KoalaNestModule_1,
             imports: [
@@ -29,8 +32,11 @@ let KoalaNestModule = exports.KoalaNestModule = KoalaNestModule_1 = class KoalaN
                     isGlobal: true,
                 }),
                 env_module_1.EnvModule,
+                ...controllers,
             ],
             providers: [
+                ...cronJobsProviders,
+                ...eventJobsProviders,
                 {
                     provide: ilogging_service_1.ILoggingService,
                     useValue: config?.logging ?? logging_service_1.LoggingService,
@@ -39,7 +45,14 @@ let KoalaNestModule = exports.KoalaNestModule = KoalaNestModule_1 = class KoalaN
                 { provide: ired_lock_service_1.IRedLockService, useClass: red_lock_service_1.RedLockService },
                 env_service_1.EnvService,
             ],
-            exports: [ilogging_service_1.ILoggingService, iredis_service_1.IRedisService, ired_lock_service_1.IRedLockService],
+            exports: [
+                ...cronJobsProviders,
+                ...eventJobsProviders,
+                ilogging_service_1.ILoggingService,
+                iredis_service_1.IRedisService,
+                ired_lock_service_1.IRedLockService,
+                env_service_1.EnvService,
+            ],
         };
     }
 };

package/env/env.service.d.ts

@@ -1,6 +1,6 @@
 import { ConfigService } from '@nestjs/config';
 import { Env } from './env';
-export declare class EnvService<TEnv = Env> {
+export declare class EnvService<TEnv extends Env = Env> {
     private readonly configService;
     constructor(configService: ConfigService<TEnv, true>);
     get<T extends keyof TEnv>(key: T): (string extends infer T_1 ? T_1 extends string ? T_1 extends keyof TEnv ? string extends infer T_2 ? T_2 extends string ? T_2 extends import("@nestjs/config").Path<TEnv[T_1]> ? import("@nestjs/config").PathValue<TEnv[T_1], T_2> : never : never : never : never : never : never) | (any extends infer T_3 ? T_3 extends any ? T_3 extends keyof TEnv ? TEnv[T_3] : never : never : never);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@koalarx/nest",
-  "version": "1.2.3",
+  "version": "1.3.1",
   "description": "",
   "repository": {
     "type": "git",
@@ -22,7 +22,7 @@
     "@nestjs/platform-express": "11.0.12",
     "@nestjs/swagger": "11.0.7",
     "@prisma/client": "6.5.0",
-    "@scalar/nestjs-api-reference": "0.4.2",
+    "@scalar/nestjs-api-reference": "0.4.3",
     "cookie-parser": "1.4.6",
     "dotenv": "16.0.3",
     "express-basic-auth": "1.2.1",