kool-koala 1.1.0 → 1.1.2

package/common/configuration-parameters.d.ts

@@ -0,0 +1,19 @@
+import { DataSource, Repository } from "typeorm";
+import { ControllerConstructor } from "../controllers";
+import { AuthenticableEntity } from "../types";
+export interface DatabaseConfigurationParamters {
+    dataSource: DataSource;
+    shouldRunMigrations: boolean;
+}
+export interface ConfigurationParameters<U extends AuthenticableEntity, P extends Record<string, string | number>> {
+    port: number;
+    controllers?: (ControllerConstructor)[];
+    database?: DatabaseConfigurationParamters;
+    jwt?: {
+        saltRounds: number;
+        secretKey: string;
+    };
+    userRepository?: Repository<U>;
+    permissionType?: P;
+    restPrefix?: string;
+}

package/common/configuration-parameters.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/../src/common/configuration-parameters.ts"],"names":[],"mappings":"","file":"configuration-parameters.js","sourcesContent":["import { DataSource, Repository } from \"typeorm\";\nimport { ControllerConstructor } from \"../controllers\";\nimport { AuthenticableEntity } from \"../types\";\n\nexport interface DatabaseConfigurationParamters {\n  dataSource: DataSource,\n  shouldRunMigrations: boolean\n}\n\nexport interface ConfigurationParameters<\n  U extends AuthenticableEntity,\n  P extends Record<string, string | number>\n> {\n  port: number,\n  controllers: (ControllerConstructor)[],\n  database?: DatabaseConfigurationParamters,\n  jwt?: {\n    saltRounds: number,\n    secretKey: string\n  },\n  userRepository: Repository<U>,\n  permissionType: P,\n  restPrefix?: string,\n}"]}
+{"version":3,"sources":["../src/../src/common/configuration-parameters.ts"],"names":[],"mappings":"","file":"configuration-parameters.js","sourcesContent":["import { DataSource, Repository } from \"typeorm\";\nimport { ControllerConstructor } from \"../controllers\";\nimport { AuthenticableEntity } from \"../types\";\n\nexport interface DatabaseConfigurationParamters {\n  dataSource: DataSource,\n  shouldRunMigrations: boolean\n}\n\nexport interface ConfigurationParameters<\n  U extends AuthenticableEntity,\n  P extends Record<string, string | number>\n> {\n  port: number,\n  controllers?: (ControllerConstructor)[],\n  database?: DatabaseConfigurationParamters,\n  jwt?: {\n    saltRounds: number,\n    secretKey: string\n  },\n  userRepository?: Repository<U>,\n  permissionType?: P,\n  restPrefix?: string,\n}"]}

package/common/configuration.d.ts

@@ -0,0 +1,21 @@
+import { Repository } from "typeorm";
+import { ControllerConstructor } from "../controllers/controller-base";
+import { AuthenticableEntity } from "../types/entities/authenticable-entity";
+import { ConfigurationParameters, DatabaseConfigurationParamters } from "./configuration-parameters";
+interface JwtParameters {
+    saltRounds: number;
+    secretKey: string;
+}
+export declare class Configuration<U extends AuthenticableEntity, P extends Record<string, string | number>> {
+    private parameters;
+    constructor(parameters: ConfigurationParameters<U, P>);
+    static instantiate<T extends AuthenticableEntity, Q extends Record<string, string | number>>(configurationParameters: ConfigurationParameters<T, Q>): Configuration<T, Q>;
+    getControllers(): ControllerConstructor[];
+    getDatabase(): DatabaseConfigurationParamters;
+    getPort(): number;
+    getJwtParameters(): JwtParameters;
+    getUserRepository(): Repository<U>;
+    getPermissionType(): P;
+    getRestPrefix(): string;
+}
+export {};

package/common/index.d.ts

@@ -0,0 +1,4 @@
+export * from './configuration';
+export * from './configuration-parameters';
+export * from './koalapp';
+export * from './status-code';

package/common/koalapp.d.ts

@@ -0,0 +1,23 @@
+import { Next, ParameterizedContext } from 'koa';
+import { Configuration } from './configuration';
+import { AuthenticableEntity } from '../types/entities/authenticable-entity';
+import { DataSource } from 'typeorm';
+import { AuthorizationService } from '../services';
+export declare class KoalApp<U extends AuthenticableEntity, P extends Record<string, string | number>> {
+    private configuration;
+    private static instance;
+    private koa;
+    private routerService;
+    private databaseConnection;
+    private authorizationService;
+    private constructor();
+    static getInstance<T extends AuthenticableEntity, Q extends Record<string, string | number>>(configuration?: Configuration<T, Q>): KoalApp<T, Q>;
+    getConfiguration(): Configuration<U, P>;
+    getDatabaseConnection(): DataSource;
+    initialize(): Promise<void>;
+    registerStaticFileServerMiddleware(): void;
+    start(callback?: (configuration: Configuration<U, P>) => void): Promise<void>;
+    authorizationHeaderParser(context: ParameterizedContext, next: Next): Promise<void>;
+    errorHandler(context: ParameterizedContext, next: Next): Promise<void>;
+    getAuthorizationService(): AuthorizationService<U, P>;
+}

package/common/status-code.d.ts

@@ -0,0 +1,10 @@
+export declare enum StatusCode {
+    OK = 200,
+    CREATED = 201,
+    BAD_REQUEST = 400,
+    I_AM_A_TEAPOT = 418,
+    UNAUTHORIZED = 401,
+    FORBIDDEN = 403,
+    NOT_FOUND = 404,
+    INTERNAL_SERVER_ERROR = 500
+}

package/controllers/controller-base.d.ts

@@ -0,0 +1,8 @@
+import Router from "koa-router";
+export declare abstract class ControllerBase {
+    protected router: Router;
+    constructor(router: Router);
+    abstract registerEndpoints(): void;
+    protected getApiUrl(path: string): string;
+}
+export type ControllerConstructor = new (router: Router) => ControllerBase;

package/controllers/index.d.ts

@@ -0,0 +1 @@
+export * from './controller-base';

package/index.d.ts

@@ -0,0 +1,5 @@
+export * from './koalas';
+export * from './common';
+export * from './controllers';
+export * from './services';
+export * from './types';

package/koalas/index.d.ts

@@ -0,0 +1 @@
+export declare function printKoalaArt(): void;

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "kool-koala",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Full-stack framework to create NodeJS applications on server side and Angular applications on the client side with ease.",
   "main": "index.js",
+  "types": "index.d.ts",
   "bin": {
     "kool-koala": "./bin/kool-koala.js"
   },

package/services/authorization-service.d.ts

@@ -0,0 +1,5 @@
+import { AuthenticableEntity } from '../types';
+export declare class AuthorizationService<U extends AuthenticableEntity, P> {
+    constructor();
+    userHasRight(user: U, permission: P): Promise<void>;
+}

package/services/authorization-service.js

@@ -11,20 +11,20 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AuthorizationService = void 0;
 const authorization_error_1 = require("../types/errors/authorization-error");
+const common_1 = require("../common");
 class AuthorizationService {
-    constructor(userRepository) {
-        this.userRepository = userRepository;
+    constructor() {
     }
     userHasRight(user, permission) {
         return __awaiter(this, void 0, void 0, function* () {
-            user = yield this.userRepository.findOne({
+            user = (yield common_1.KoalApp.getInstance().getConfiguration().getUserRepository().findOne({
                 where: {
                     id: user.id
                 },
                 relations: {
                     permissions: true
                 }
-            });
+            }));
             if (!user.permissions.some((p) => p.textId === permission)) {
                 throw new authorization_error_1.AuthorizationError(user, permission);
             }

package/services/authorization-service.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/../src/services/authorization-service.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,6EAAyE;AAGzE,MAAa,oBAAoB;IAI/B,YAAoB,cAA6B;QAA7B,mBAAc,GAAd,cAAc,CAAe;IACjD,CAAC;IACK,YAAY,CAAC,IAAO,EAAE,UAAa;;YACvC,IAAI,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;gBACvC,KAAK,EAAuB;oBAC1B,EAAE,EAAE,IAAI,CAAC,EAAE;iBACZ;gBACD,SAAS,EAA2B;oBAClC,WAAW,EAAE,IAAI;iBAClB;aACF,CAAC,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,UAAU,CAAC,EAAE,CAAC;gBAC3D,MAAM,IAAI,wCAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YACjD,CAAC;QACH,CAAC;KAAA;CACF;AAnBD,oDAmBC","file":"authorization-service.js","sourcesContent":["import { FindOptionsRelations, FindOptionsWhere, Repository } from 'typeorm';\nimport { AuthorizationError } from '../types/errors/authorization-error';\nimport { AuthenticableEntity } from '../types';\n\nexport class AuthorizationService<\n  U extends AuthenticableEntity,\n  P\n> {\n  constructor(private userRepository: Repository<U>) {\n  }\n  async userHasRight(user: U, permission: P) {\n    user = await this.userRepository.findOne({\n      where: <FindOptionsWhere<U>>{\n        id: user.id\n      },\n      relations: <FindOptionsRelations<U>>{\n        permissions: true\n      }\n    });\n    if (!user.permissions.some((p) => p.textId === permission)) {\n      throw new AuthorizationError(user, permission);\n    }\n  }\n}"]}
+{"version":3,"sources":["../src/../src/services/authorization-service.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,6EAAyE;AAEzE,sCAAoC;AAEpC,MAAa,oBAAoB;IAI/B;IACA,CAAC;IACK,YAAY,CAAC,IAAO,EAAE,UAAa;;YACvC,IAAI,IAAM,MAAM,gBAAO,CAAC,WAAW,EAAE,CAAC,gBAAgB,EAAE,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACnF,KAAK,EAAuB;oBAC1B,EAAE,EAAE,IAAI,CAAC,EAAE;iBACZ;gBACD,SAAS,EAA2B;oBAClC,WAAW,EAAE,IAAI;iBAClB;aACF,CAAC,CAAA,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,UAAU,CAAC,EAAE,CAAC;gBAC3D,MAAM,IAAI,wCAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YACjD,CAAC;QACH,CAAC;KAAA;CACF;AAnBD,oDAmBC","file":"authorization-service.js","sourcesContent":["import { FindOptionsRelations, FindOptionsWhere, Repository } from 'typeorm';\nimport { AuthorizationError } from '../types/errors/authorization-error';\nimport { AuthenticableEntity } from '../types';\nimport { KoalApp } from '../common';\n\nexport class AuthorizationService<\n  U extends AuthenticableEntity,\n  P\n> {\n  constructor() {\n  }\n  async userHasRight(user: U, permission: P) {\n    user = <U>await KoalApp.getInstance().getConfiguration().getUserRepository().findOne({\n      where: <FindOptionsWhere<U>>{\n        id: user.id\n      },\n      relations: <FindOptionsRelations<U>>{\n        permissions: true\n      }\n    });\n    if (!user.permissions.some((p) => p.textId === permission)) {\n      throw new AuthorizationError(user, permission);\n    }\n  }\n}"]}

package/services/index.d.ts

@@ -0,0 +1,2 @@
+export * from './authorization-service';
+export * from './router-service';

package/services/router-service.d.ts

@@ -0,0 +1,9 @@
+import Router from "koa-router";
+import { ControllerConstructor } from "../controllers/controller-base";
+export declare class RouterService {
+    private controllers;
+    private router;
+    constructor(controllers: (ControllerConstructor)[]);
+    getRoutes(): Router.IMiddleware<any, {}>;
+    allowedMethods(): Router.IMiddleware<any, {}>;
+}

package/services/router-service.js

@@ -7,9 +7,10 @@ exports.RouterService = void 0;
 const koa_router_1 = __importDefault(require("koa-router"));
 class RouterService {
     constructor(controllers) {
+        var _a;
         this.controllers = controllers;
         this.router = new koa_router_1.default();
-        this.controllers.forEach((controllerType) => {
+        ((_a = this.controllers) !== null && _a !== void 0 ? _a : []).forEach((controllerType) => {
             console.log(`Register endpoints of '${controllerType.name}'`);
             const controller = new controllerType(this.router);
             controller.registerEndpoints();

package/services/router-service.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/../src/services/router-service.ts"],"names":[],"mappings":";;;;;;AAAA,4DAAgC;AAGhC,MAAa,aAAa;IAExB,YAAoB,WAAsC;QAAtC,gBAAW,GAAX,WAAW,CAA2B;QACxD,IAAI,CAAC,MAAM,GAAG,IAAI,oBAAM,EAAE,CAAC;QAC3B,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE;YAC1C,OAAO,CAAC,GAAG,CAAC,0BAA0B,cAAc,CAAC,IAAI,GAAG,CAAC,CAAC;YAC9D,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACnD,UAAU,CAAC,iBAAiB,EAAE,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;IAC9B,CAAC;IAED,cAAc;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;IACtC,CAAC;CACF;AAlBD,sCAkBC","file":"router-service.js","sourcesContent":["import Router from \"koa-router\";\nimport { ControllerConstructor } from \"../controllers/controller-base\";\n\nexport class RouterService {\n  private router: Router;\n  constructor(private controllers: (ControllerConstructor)[]) {\n    this.router = new Router();\n    this.controllers.forEach((controllerType) => {\n      console.log(`Register endpoints of '${controllerType.name}'`);\n      const controller = new controllerType(this.router);\n      controller.registerEndpoints();\n    });\n  }\n\n  getRoutes() {\n    return this.router.routes();\n  }\n\n  allowedMethods() {\n    return this.router.allowedMethods();\n  }\n}\n"]}
+{"version":3,"sources":["../src/../src/services/router-service.ts"],"names":[],"mappings":";;;;;;AAAA,4DAAgC;AAGhC,MAAa,aAAa;IAExB,YAAoB,WAAsC;;QAAtC,gBAAW,GAAX,WAAW,CAA2B;QACxD,IAAI,CAAC,MAAM,GAAG,IAAI,oBAAM,EAAE,CAAC;QAC3B,CAAC,MAAA,IAAI,CAAC,WAAW,mCAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE;YAClD,OAAO,CAAC,GAAG,CAAC,0BAA0B,cAAc,CAAC,IAAI,GAAG,CAAC,CAAC;YAC9D,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACnD,UAAU,CAAC,iBAAiB,EAAE,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;IAC9B,CAAC;IAED,cAAc;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;IACtC,CAAC;CACF;AAlBD,sCAkBC","file":"router-service.js","sourcesContent":["import Router from \"koa-router\";\nimport { ControllerConstructor } from \"../controllers/controller-base\";\n\nexport class RouterService {\n  private router: Router;\n  constructor(private controllers: (ControllerConstructor)[]) {\n    this.router = new Router();\n    (this.controllers ?? []).forEach((controllerType) => {\n      console.log(`Register endpoints of '${controllerType.name}'`);\n      const controller = new controllerType(this.router);\n      controller.registerEndpoints();\n    });\n  }\n\n  getRoutes() {\n    return this.router.routes();\n  }\n\n  allowedMethods() {\n    return this.router.allowedMethods();\n  }\n}\n"]}

package/types/entities/authenticable-entity.d.ts

@@ -0,0 +1,4 @@
+import { HumanIdentifiableEntity } from "./human-identifiable-entity";
+import { IdentifiableEntity } from "./identifiable-entity";
+import { PermissionHolderEntity } from "./permission-holder-entity";
+export type AuthenticableEntity = IdentifiableEntity & PermissionHolderEntity & HumanIdentifiableEntity;

package/types/entities/human-identifiable-entity.d.ts

@@ -0,0 +1,3 @@
+export interface HumanIdentifiableEntity {
+    username: string;
+}

package/types/entities/identifiable-entity.d.ts

@@ -0,0 +1,3 @@
+export interface IdentifiableEntity {
+    id: number;
+}

package/types/entities/index.d.ts

@@ -0,0 +1,6 @@
+export * from './authenticable-entity';
+export * from './human-identifiable-entity';
+export * from './identifiable-entity';
+export * from './permission-entity';
+export * from './permission-holder-entity';
+export * from './user-entity';

package/types/entities/permission-entity.d.ts

@@ -0,0 +1,4 @@
+import { IdentifiableEntity } from "./identifiable-entity";
+export interface PermissionEntity extends IdentifiableEntity {
+    textId: string;
+}

package/types/entities/permission-holder-entity.d.ts

@@ -0,0 +1,4 @@
+import { PermissionEntity } from "./permission-entity";
+export interface PermissionHolderEntity {
+    permissions: PermissionEntity[];
+}

package/types/entities/user-entity.d.ts

@@ -0,0 +1,4 @@
+import { IdentifiableEntity } from "./identifiable-entity";
+export interface UserEntity extends IdentifiableEntity {
+    username: string;
+}

package/types/errors/authorization-error.d.ts

@@ -0,0 +1,5 @@
+import { HumanIdentifiableEntity } from "../entities/human-identifiable-entity";
+import { ErrorBase } from "./error-base";
+export declare class AuthorizationError<U extends HumanIdentifiableEntity, PT> extends ErrorBase {
+    constructor(user: U, permission: PT);
+}

package/types/errors/error-base.d.ts

@@ -0,0 +1,9 @@
+import { StatusCode } from "../../common/status-code";
+export declare class ErrorBase extends Error {
+    message: string;
+    protected statusCode: StatusCode;
+    protected error?: Error;
+    constructor(message: string, statusCode: StatusCode, error?: Error);
+    getStatusCode(): StatusCode;
+    getError(): Error | undefined;
+}

package/types/errors/index.d.ts

@@ -0,0 +1,2 @@
+export * from './authorization-error';
+export * from './error-base';

package/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './entities';
+export * from './errors';
+export * from './responses';

package/types/responses/base-response.d.ts

@@ -0,0 +1,4 @@
+export interface BaseResponse {
+    success: boolean;
+    message?: string;
+}

package/types/responses/index.d.ts

@@ -0,0 +1 @@
+export * from './base-response';