kool-koala 1.1.2 → 1.2.0

package/README.md

@@ -3,4 +3,69 @@
       (\__/)
       (o.o )  KOOL KOALA
       (> < )
-  
+
+The purpose of this package is to make easy to create applications.
+
+## Prerequisites
+
+The only prerequisites is to have the following dependencies installed in your project:
+
+- koa
+- koa-router
+- typeorm
+
+## How to install
+
+To use it in your project you only need to execute the following command in your project:
+
+```
+npm i kool-koala
+```
+
+## Start an app
+
+To start an application, you have to write only a few lines of code, like in the example below.
+
+```
+import { Configuration, KoalApp } from 'kool-koala';
+
+const configuration = new Configuration({
+  port: 8080,
+});
+
+KoalApp.getInstance(configuration).start((configuration) => {
+  console.log(`KoalApp is started.`);
+});
+```
+
+## Controllers
+
+To add endpoints to the application you have to create controllers and add them to the `controllers` attribute of the configuration.
+
+A basic controller:
+
+```
+import { ControllerBase, StatusCode } from "kool-koala";
+
+export class TestController extends ControllerBase {
+  registerEndpoints(): void {
+    this.router.get(this.getApiUrl("/test"), (context, res) => {
+      context.body = "It is working!";
+      context.status = StatusCode.OK;
+    });
+  }
+}
+```
+
+To register this controller you have to modify the configuration of the application like this:
+
+```
+import { TestController } from './test-controller';
+...
+const configuration = new Configuration({
+  port: 8080,
+  controllers: [
+      TestController
+  ]
+});
+```

package/common/status-code.d.ts

@@ -1,10 +1,65 @@
 export declare enum StatusCode {
+    CONTINUE = 100,
+    SWITCHING_PROTOCOLS = 101,
+    PROCESSING = 102,
+    EARLY_HINTS = 103,
     OK = 200,
     CREATED = 201,
+    ACCEPTED = 202,
+    NON_AUTHORITATIVE_INFORMATION = 203,
+    NO_CONTENT = 204,
+    RESET_CONTENT = 205,
+    PARTIAL_CONTENT = 206,
+    MULTI_STATUS = 207,
+    ALREADY_REPORTED = 208,
+    IM_USED = 226,
+    MULTIPLE_CHOICES = 300,
+    MOVED_PERMANENTLY = 301,
+    FOUND = 302,
+    SEE_OTHER = 303,
+    NOT_MODIFIED = 304,
+    USE_PROXY = 305,
+    SWITCH_PROXY = 306,
+    TEMPORARY_REDIRECT = 307,
+    PERMANENT_REDIRECT = 308,
     BAD_REQUEST = 400,
-    I_AM_A_TEAPOT = 418,
     UNAUTHORIZED = 401,
+    PAYMENT_REQUIRED = 402,
     FORBIDDEN = 403,
     NOT_FOUND = 404,
-    INTERNAL_SERVER_ERROR = 500
+    METHOD_NOT_ALLOWED = 405,
+    NOT_ACCEPTABLE = 406,
+    PROXY_AUTHENTICATION_REQUIRED = 407,
+    REQUEST_TIMEOUT = 408,
+    CONFLICT = 409,
+    GONE = 410,
+    LENGTH_REQUIRED = 411,
+    PRECONDITION_FAILED = 412,
+    CONTENT_TOO_LARGE = 413,
+    URI_TOO_LONG = 414,
+    UNSUPPORTED_MEDIA_TYPE = 415,
+    RANGE_NOT_SATISFIABLE = 416,
+    EXPECTATION_FAILED = 417,
+    I_AM_A_TEAPOT = 418,
+    MISDIRECTED_REQUEST = 421,
+    UNPROCESSABLE_ENTITY = 422,
+    LOCKED = 423,
+    FAILED_DEPENDENCY = 424,
+    TOO_EARLY = 425,
+    UPGRADE_REQUIRED = 426,
+    PRECONDITION_REQUIRED = 428,
+    TOO_MANY_REQUESTS = 429,
+    REQUEST_HEADER_FIELDS_TOO_LARGE = 431,
+    UNAVAILABLE_FOR_LEGAL_REASONS = 451,
+    INTERNAL_SERVER_ERROR = 500,
+    NOT_IMPLEMENTED = 501,
+    BAD_GATEWAY = 502,
+    SERVICE_UNAVAILABLE = 503,
+    GATEWAY_TIMEOUT = 504,
+    HTTP_VERSION_NOT_SUPPORTED = 505,
+    VARIANT_ALSO_NEGOTIATES = 506,
+    INSUFFICIENT_STORAGE = 507,
+    LOOP_DETECTED = 508,
+    NOT_EXTENDED = 510,
+    NETWORK_AUTHENTICATION_REQUIRED = 511
 }

package/common/status-code.js

@@ -3,14 +3,69 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.StatusCode = void 0;
 var StatusCode;
 (function (StatusCode) {
+    StatusCode[StatusCode["CONTINUE"] = 100] = "CONTINUE";
+    StatusCode[StatusCode["SWITCHING_PROTOCOLS"] = 101] = "SWITCHING_PROTOCOLS";
+    StatusCode[StatusCode["PROCESSING"] = 102] = "PROCESSING";
+    StatusCode[StatusCode["EARLY_HINTS"] = 103] = "EARLY_HINTS";
     StatusCode[StatusCode["OK"] = 200] = "OK";
     StatusCode[StatusCode["CREATED"] = 201] = "CREATED";
+    StatusCode[StatusCode["ACCEPTED"] = 202] = "ACCEPTED";
+    StatusCode[StatusCode["NON_AUTHORITATIVE_INFORMATION"] = 203] = "NON_AUTHORITATIVE_INFORMATION";
+    StatusCode[StatusCode["NO_CONTENT"] = 204] = "NO_CONTENT";
+    StatusCode[StatusCode["RESET_CONTENT"] = 205] = "RESET_CONTENT";
+    StatusCode[StatusCode["PARTIAL_CONTENT"] = 206] = "PARTIAL_CONTENT";
+    StatusCode[StatusCode["MULTI_STATUS"] = 207] = "MULTI_STATUS";
+    StatusCode[StatusCode["ALREADY_REPORTED"] = 208] = "ALREADY_REPORTED";
+    StatusCode[StatusCode["IM_USED"] = 226] = "IM_USED";
+    StatusCode[StatusCode["MULTIPLE_CHOICES"] = 300] = "MULTIPLE_CHOICES";
+    StatusCode[StatusCode["MOVED_PERMANENTLY"] = 301] = "MOVED_PERMANENTLY";
+    StatusCode[StatusCode["FOUND"] = 302] = "FOUND";
+    StatusCode[StatusCode["SEE_OTHER"] = 303] = "SEE_OTHER";
+    StatusCode[StatusCode["NOT_MODIFIED"] = 304] = "NOT_MODIFIED";
+    StatusCode[StatusCode["USE_PROXY"] = 305] = "USE_PROXY";
+    StatusCode[StatusCode["SWITCH_PROXY"] = 306] = "SWITCH_PROXY";
+    StatusCode[StatusCode["TEMPORARY_REDIRECT"] = 307] = "TEMPORARY_REDIRECT";
+    StatusCode[StatusCode["PERMANENT_REDIRECT"] = 308] = "PERMANENT_REDIRECT";
     StatusCode[StatusCode["BAD_REQUEST"] = 400] = "BAD_REQUEST";
-    StatusCode[StatusCode["I_AM_A_TEAPOT"] = 418] = "I_AM_A_TEAPOT";
     StatusCode[StatusCode["UNAUTHORIZED"] = 401] = "UNAUTHORIZED";
+    StatusCode[StatusCode["PAYMENT_REQUIRED"] = 402] = "PAYMENT_REQUIRED";
     StatusCode[StatusCode["FORBIDDEN"] = 403] = "FORBIDDEN";
     StatusCode[StatusCode["NOT_FOUND"] = 404] = "NOT_FOUND";
+    StatusCode[StatusCode["METHOD_NOT_ALLOWED"] = 405] = "METHOD_NOT_ALLOWED";
+    StatusCode[StatusCode["NOT_ACCEPTABLE"] = 406] = "NOT_ACCEPTABLE";
+    StatusCode[StatusCode["PROXY_AUTHENTICATION_REQUIRED"] = 407] = "PROXY_AUTHENTICATION_REQUIRED";
+    StatusCode[StatusCode["REQUEST_TIMEOUT"] = 408] = "REQUEST_TIMEOUT";
+    StatusCode[StatusCode["CONFLICT"] = 409] = "CONFLICT";
+    StatusCode[StatusCode["GONE"] = 410] = "GONE";
+    StatusCode[StatusCode["LENGTH_REQUIRED"] = 411] = "LENGTH_REQUIRED";
+    StatusCode[StatusCode["PRECONDITION_FAILED"] = 412] = "PRECONDITION_FAILED";
+    StatusCode[StatusCode["CONTENT_TOO_LARGE"] = 413] = "CONTENT_TOO_LARGE";
+    StatusCode[StatusCode["URI_TOO_LONG"] = 414] = "URI_TOO_LONG";
+    StatusCode[StatusCode["UNSUPPORTED_MEDIA_TYPE"] = 415] = "UNSUPPORTED_MEDIA_TYPE";
+    StatusCode[StatusCode["RANGE_NOT_SATISFIABLE"] = 416] = "RANGE_NOT_SATISFIABLE";
+    StatusCode[StatusCode["EXPECTATION_FAILED"] = 417] = "EXPECTATION_FAILED";
+    StatusCode[StatusCode["I_AM_A_TEAPOT"] = 418] = "I_AM_A_TEAPOT";
+    StatusCode[StatusCode["MISDIRECTED_REQUEST"] = 421] = "MISDIRECTED_REQUEST";
+    StatusCode[StatusCode["UNPROCESSABLE_ENTITY"] = 422] = "UNPROCESSABLE_ENTITY";
+    StatusCode[StatusCode["LOCKED"] = 423] = "LOCKED";
+    StatusCode[StatusCode["FAILED_DEPENDENCY"] = 424] = "FAILED_DEPENDENCY";
+    StatusCode[StatusCode["TOO_EARLY"] = 425] = "TOO_EARLY";
+    StatusCode[StatusCode["UPGRADE_REQUIRED"] = 426] = "UPGRADE_REQUIRED";
+    StatusCode[StatusCode["PRECONDITION_REQUIRED"] = 428] = "PRECONDITION_REQUIRED";
+    StatusCode[StatusCode["TOO_MANY_REQUESTS"] = 429] = "TOO_MANY_REQUESTS";
+    StatusCode[StatusCode["REQUEST_HEADER_FIELDS_TOO_LARGE"] = 431] = "REQUEST_HEADER_FIELDS_TOO_LARGE";
+    StatusCode[StatusCode["UNAVAILABLE_FOR_LEGAL_REASONS"] = 451] = "UNAVAILABLE_FOR_LEGAL_REASONS";
     StatusCode[StatusCode["INTERNAL_SERVER_ERROR"] = 500] = "INTERNAL_SERVER_ERROR";
+    StatusCode[StatusCode["NOT_IMPLEMENTED"] = 501] = "NOT_IMPLEMENTED";
+    StatusCode[StatusCode["BAD_GATEWAY"] = 502] = "BAD_GATEWAY";
+    StatusCode[StatusCode["SERVICE_UNAVAILABLE"] = 503] = "SERVICE_UNAVAILABLE";
+    StatusCode[StatusCode["GATEWAY_TIMEOUT"] = 504] = "GATEWAY_TIMEOUT";
+    StatusCode[StatusCode["HTTP_VERSION_NOT_SUPPORTED"] = 505] = "HTTP_VERSION_NOT_SUPPORTED";
+    StatusCode[StatusCode["VARIANT_ALSO_NEGOTIATES"] = 506] = "VARIANT_ALSO_NEGOTIATES";
+    StatusCode[StatusCode["INSUFFICIENT_STORAGE"] = 507] = "INSUFFICIENT_STORAGE";
+    StatusCode[StatusCode["LOOP_DETECTED"] = 508] = "LOOP_DETECTED";
+    StatusCode[StatusCode["NOT_EXTENDED"] = 510] = "NOT_EXTENDED";
+    StatusCode[StatusCode["NETWORK_AUTHENTICATION_REQUIRED"] = 511] = "NETWORK_AUTHENTICATION_REQUIRED";
 })(StatusCode || (exports.StatusCode = StatusCode = {}));
 
 //# sourceMappingURL=status-code.js.map

package/common/status-code.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/../src/common/status-code.ts"],"names":[],"mappings":";;;AAAA,IAAY,UASX;AATD,WAAY,UAAU;IACpB,yCAAQ,CAAA;IACR,mDAAa,CAAA;IACb,2DAAiB,CAAA;IACjB,+DAAmB,CAAA;IACnB,6DAAkB,CAAA;IAClB,uDAAe,CAAA;IACf,uDAAe,CAAA;IACf,+EAA2B,CAAA;AAC7B,CAAC,EATW,UAAU,0BAAV,UAAU,QASrB","file":"status-code.js","sourcesContent":["export enum StatusCode {\n  OK = 200,\n  CREATED = 201,\n  BAD_REQUEST = 400,\n  I_AM_A_TEAPOT = 418,\n  UNAUTHORIZED = 401,\n  FORBIDDEN = 403,\n  NOT_FOUND = 404,\n  INTERNAL_SERVER_ERROR = 500,\n}"]}
+{"version":3,"sources":["../src/../src/common/status-code.ts"],"names":[],"mappings":";;;AAAA,IAAY,UAgEX;AAhED,WAAY,UAAU;IACpB,qDAAc,CAAA;IACd,2EAAyB,CAAA;IACzB,yDAAgB,CAAA;IAChB,2DAAiB,CAAA;IACjB,yCAAQ,CAAA;IACR,mDAAa,CAAA;IACb,qDAAc,CAAA;IACd,+FAAmC,CAAA;IACnC,yDAAgB,CAAA;IAChB,+DAAmB,CAAA;IACnB,mEAAqB,CAAA;IACrB,6DAAkB,CAAA;IAClB,qEAAsB,CAAA;IACtB,mDAAa,CAAA;IACb,qEAAsB,CAAA;IACtB,uEAAuB,CAAA;IACvB,+CAAW,CAAA;IACX,uDAAe,CAAA;IACf,6DAAkB,CAAA;IAClB,uDAAe,CAAA;IACf,6DAAkB,CAAA;IAClB,yEAAwB,CAAA;IACxB,yEAAwB,CAAA;IACxB,2DAAiB,CAAA;IACjB,6DAAkB,CAAA;IAClB,qEAAsB,CAAA;IACtB,uDAAe,CAAA;IACf,uDAAe,CAAA;IACf,yEAAwB,CAAA;IACxB,iEAAoB,CAAA;IACpB,+FAAmC,CAAA;IACnC,mEAAqB,CAAA;IACrB,qDAAc,CAAA;IACd,6CAAU,CAAA;IACV,mEAAqB,CAAA;IACrB,2EAAyB,CAAA;IACzB,uEAAuB,CAAA;IACvB,6DAAkB,CAAA;IAClB,iFAA4B,CAAA;IAC5B,+EAA2B,CAAA;IAC3B,yEAAwB,CAAA;IACxB,+DAAmB,CAAA;IACnB,2EAAyB,CAAA;IACzB,6EAA0B,CAAA;IAC1B,iDAAY,CAAA;IACZ,uEAAuB,CAAA;IACvB,uDAAe,CAAA;IACf,qEAAsB,CAAA;IACtB,+EAA2B,CAAA;IAC3B,uEAAuB,CAAA;IACvB,mGAAqC,CAAA;IACrC,+FAAmC,CAAA;IACnC,+EAA2B,CAAA;IAC3B,mEAAqB,CAAA;IACrB,2DAAiB,CAAA;IACjB,2EAAyB,CAAA;IACzB,mEAAqB,CAAA;IACrB,yFAAgC,CAAA;IAChC,mFAA6B,CAAA;IAC7B,6EAA0B,CAAA;IAC1B,+DAAmB,CAAA;IACnB,6DAAkB,CAAA;IAClB,mGAAqC,CAAA;AACvC,CAAC,EAhEW,UAAU,0BAAV,UAAU,QAgErB","file":"status-code.js","sourcesContent":["export enum StatusCode {\n  CONTINUE = 100,\n  SWITCHING_PROTOCOLS = 101,\n  PROCESSING = 102,\n  EARLY_HINTS = 103,\n  OK = 200,\n  CREATED = 201,\n  ACCEPTED = 202,\n  NON_AUTHORITATIVE_INFORMATION = 203,\n  NO_CONTENT = 204,\n  RESET_CONTENT = 205,\n  PARTIAL_CONTENT = 206,\n  MULTI_STATUS = 207,\n  ALREADY_REPORTED = 208,\n  IM_USED = 226,\n  MULTIPLE_CHOICES = 300,\n  MOVED_PERMANENTLY = 301,\n  FOUND = 302,\n  SEE_OTHER = 303,\n  NOT_MODIFIED = 304,\n  USE_PROXY = 305,\n  SWITCH_PROXY = 306,\n  TEMPORARY_REDIRECT = 307,\n  PERMANENT_REDIRECT = 308,\n  BAD_REQUEST = 400,\n  UNAUTHORIZED = 401,\n  PAYMENT_REQUIRED = 402,\n  FORBIDDEN = 403,\n  NOT_FOUND = 404,\n  METHOD_NOT_ALLOWED = 405,\n  NOT_ACCEPTABLE = 406,\n  PROXY_AUTHENTICATION_REQUIRED = 407,\n  REQUEST_TIMEOUT = 408,\n  CONFLICT = 409,\n  GONE = 410,\n  LENGTH_REQUIRED = 411,\n  PRECONDITION_FAILED = 412,\n  CONTENT_TOO_LARGE = 413,\n  URI_TOO_LONG = 414,\n  UNSUPPORTED_MEDIA_TYPE = 415,\n  RANGE_NOT_SATISFIABLE = 416,\n  EXPECTATION_FAILED = 417,\n  I_AM_A_TEAPOT = 418,\n  MISDIRECTED_REQUEST = 421,\n  UNPROCESSABLE_ENTITY = 422,\n  LOCKED = 423,\n  FAILED_DEPENDENCY = 424,\n  TOO_EARLY = 425,\n  UPGRADE_REQUIRED = 426,\n  PRECONDITION_REQUIRED = 428,\n  TOO_MANY_REQUESTS = 429,\n  REQUEST_HEADER_FIELDS_TOO_LARGE = 431,\n  UNAVAILABLE_FOR_LEGAL_REASONS = 451,\n  INTERNAL_SERVER_ERROR = 500,\n  NOT_IMPLEMENTED = 501,\n  BAD_GATEWAY = 502,\n  SERVICE_UNAVAILABLE = 503,\n  GATEWAY_TIMEOUT = 504,\n  HTTP_VERSION_NOT_SUPPORTED = 505,\n  VARIANT_ALSO_NEGOTIATES = 506,\n  INSUFFICIENT_STORAGE = 507,\n  LOOP_DETECTED = 508,\n  NOT_EXTENDED = 510,\n  NETWORK_AUTHENTICATION_REQUIRED = 511,\n}"]}

package/controllers/index.d.ts

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

package/controllers/index.js

@@ -15,5 +15,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./controller-base"), exports);
+__exportStar(require("./rest-controller-base"), exports);
 
 //# sourceMappingURL=index.js.map

package/controllers/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/../src/controllers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC","file":"index.js","sourcesContent":["export * from './controller-base';"]}
+{"version":3,"sources":["../src/../src/controllers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,yDAAuC","file":"index.js","sourcesContent":["export * from './controller-base';\nexport * from './rest-controller-base';"]}

package/controllers/rest-controller-base.d.ts

@@ -0,0 +1,34 @@
+import { ParameterizedContext } from "koa";
+import { RepositoryBase } from "../database/repositories";
+import { IdentifiableEntity } from "../types";
+import { ControllerBase } from "./controller-base";
+import { DeepPartial } from "typeorm";
+export declare abstract class RestControllerBase<T extends IdentifiableEntity, RouteType extends Record<string, string>, PermissionType extends Record<string, string>, CreateRequest extends any = Omit<T, 'id'>, EditRequest = T> extends ControllerBase {
+    abstract getEndpoint(): RouteType[keyof RouteType];
+    abstract getRepository(): RepositoryBase<T>;
+    registerEndpoints(): void;
+    protected getAuthorizationService(): import("..").AuthorizationService<import("../types").AuthenticableEntity, Record<string, string | number>>;
+    listEntities(context: ParameterizedContext): Promise<void>;
+    viewEntity(context: ParameterizedContext): Promise<void>;
+    createEntity(context: ParameterizedContext): Promise<T>;
+    editEntity(context: ParameterizedContext): Promise<void>;
+    deleteEntity(context: ParameterizedContext): Promise<void>;
+    protected delete(entity: T): Promise<void>;
+    getEntities(context: ParameterizedContext): Promise<T[]>;
+    getById(context: ParameterizedContext): Promise<T>;
+    protected getListPermission(): PermissionType | undefined;
+    protected getViewPermission(): PermissionType | undefined;
+    protected getCreatePermission(): PermissionType | undefined;
+    protected getEditPermission(): PermissionType | undefined;
+    protected getDeletePermission(): PermissionType | undefined;
+    protected shouldRegisterListEndpoint(): boolean;
+    protected shouldRegisterViewEndpoint(): boolean;
+    protected shouldRegisterCreateEndpoint(): boolean;
+    protected shouldRegisterEditEndpoint(): boolean;
+    protected shouldRegisterDeleteEndpoint(): boolean;
+    protected entityCanBeCreated(body: CreateRequest): Promise<string | null>;
+    protected entityCanBeEdited(entity: T, body: EditRequest): Promise<string | null>;
+    protected entityCanBeDeleted(entity: T): Promise<string | null>;
+    protected modifyEntityForCreate(body: CreateRequest): Promise<DeepPartial<T>>;
+    protected modifyEntityForUpdate(entity: T, body: EditRequest): Promise<T>;
+}

package/controllers/rest-controller-base.js

@@ -0,0 +1,190 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RestControllerBase = void 0;
+const types_1 = require("../types");
+const controller_base_1 = require("./controller-base");
+const common_1 = require("../common");
+class RestControllerBase extends controller_base_1.ControllerBase {
+    registerEndpoints() {
+        if (this.shouldRegisterListEndpoint()) {
+            this.router.get(this.getApiUrl(this.getEndpoint()), this.listEntities.bind(this));
+        }
+        if (this.shouldRegisterViewEndpoint()) {
+            this.router.get(this.getApiUrl(`${this.getEndpoint()}/:id`), this.viewEntity.bind(this));
+        }
+        if (this.shouldRegisterCreateEndpoint()) {
+            this.router.post(this.getApiUrl(this.getEndpoint()), this.createEntity.bind(this));
+        }
+        if (this.shouldRegisterEditEndpoint()) {
+            this.router.put(this.getApiUrl(`${this.getEndpoint()}/:id`), this.editEntity.bind(this));
+        }
+        if (this.shouldRegisterDeleteEndpoint()) {
+            this.router.delete(this.getApiUrl(`${this.getEndpoint()}/:id`), this.deleteEntity.bind(this));
+        }
+    }
+    getAuthorizationService() {
+        return common_1.KoalApp.getInstance().getAuthorizationService();
+    }
+    listEntities(context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.getListPermission() !== undefined) {
+                yield this.getAuthorizationService().userHasRight(context.state.user, this.getListPermission());
+            }
+            context.body = yield this.getEntities(context);
+        });
+    }
+    viewEntity(context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.getViewPermission() !== undefined) {
+                yield this.getAuthorizationService().userHasRight(context.state.user, this.getViewPermission());
+            }
+            const entity = yield this.getById(context);
+            if (entity) {
+                context.body = entity;
+            }
+            else {
+                context.status = common_1.StatusCode.NOT_FOUND;
+            }
+        });
+    }
+    createEntity(context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.getCreatePermission() !== undefined) {
+                yield this.getAuthorizationService().userHasRight(context.state.user, this.getCreatePermission());
+            }
+            const errorMessage = yield this.entityCanBeCreated(context.request.body);
+            if (errorMessage !== null) {
+                throw new types_1.ErrorBase(errorMessage, common_1.StatusCode.BAD_REQUEST);
+            }
+            const entity = yield this.getRepository().save(yield this.modifyEntityForCreate(context.request.body));
+            context.status = common_1.StatusCode.CREATED;
+            context.body = {
+                success: true,
+                entity
+            };
+            return entity;
+        });
+    }
+    editEntity(context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.getEditPermission() !== undefined) {
+                yield this.getAuthorizationService().userHasRight(context.state.user, this.getEditPermission());
+            }
+            const entity = yield this.getById(context);
+            if (entity) {
+                const errorMessage = yield this.entityCanBeEdited(entity, context.request.body);
+                if (errorMessage !== null) {
+                    throw new types_1.ErrorBase(errorMessage, common_1.StatusCode.BAD_REQUEST);
+                }
+                yield this.getRepository().save(yield this.modifyEntityForUpdate(entity, context.request.body));
+                context.status = common_1.StatusCode.OK;
+                context.body = {
+                    success: true
+                };
+            }
+            else {
+                context.status = common_1.StatusCode.NOT_FOUND;
+            }
+        });
+    }
+    deleteEntity(context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.getDeletePermission() !== undefined) {
+                yield this.getAuthorizationService().userHasRight(context.state.user, this.getDeletePermission());
+            }
+            const entity = yield this.getById(context);
+            if (entity) {
+                const errorMessage = yield this.entityCanBeDeleted(entity);
+                if (errorMessage !== null) {
+                    throw new types_1.ErrorBase(errorMessage, common_1.StatusCode.BAD_REQUEST);
+                }
+                yield this.delete(entity);
+                context.status = common_1.StatusCode.OK;
+                context.body = {
+                    success: true
+                };
+            }
+            else {
+                context.status = common_1.StatusCode.NOT_FOUND;
+            }
+        });
+    }
+    delete(entity) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.getRepository().delete(entity);
+        });
+    }
+    getEntities(context) {
+        return this.getRepository().getAll();
+    }
+    getById(context) {
+        return this.getRepository().getById(context.params.id);
+    }
+    getListPermission() {
+        return undefined;
+    }
+    getViewPermission() {
+        return undefined;
+    }
+    getCreatePermission() {
+        return undefined;
+    }
+    getEditPermission() {
+        return undefined;
+    }
+    getDeletePermission() {
+        return undefined;
+    }
+    shouldRegisterListEndpoint() {
+        return true;
+    }
+    shouldRegisterViewEndpoint() {
+        return true;
+    }
+    shouldRegisterCreateEndpoint() {
+        return true;
+    }
+    shouldRegisterEditEndpoint() {
+        return true;
+    }
+    shouldRegisterDeleteEndpoint() {
+        return true;
+    }
+    entityCanBeCreated(body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return null;
+        });
+    }
+    entityCanBeEdited(entity, body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return null;
+        });
+    }
+    entityCanBeDeleted(entity) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return null;
+        });
+    }
+    modifyEntityForCreate(body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return body;
+        });
+    }
+    modifyEntityForUpdate(entity, body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return entity;
+        });
+    }
+}
+exports.RestControllerBase = RestControllerBase;
+
+//# sourceMappingURL=rest-controller-base.js.map

package/controllers/rest-controller-base.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/../src/controllers/rest-controller-base.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,oCAAuE;AACvE,uDAAmD;AACnD,sCAAgD;AAGhD,MAAsB,kBAAsM,SAAQ,gCAAc;IAGhP,iBAAiB;QACf,IAAI,IAAI,CAAC,0BAA0B,EAAE,EAAE,CAAC;YACtC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACpF,CAAC;QACD,IAAI,IAAI,CAAC,0BAA0B,EAAE,EAAE,CAAC;YACtC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3F,CAAC;QACD,IAAI,IAAI,CAAC,4BAA4B,EAAE,EAAE,CAAC;YACxC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACrF,CAAC;QACD,IAAI,IAAI,CAAC,0BAA0B,EAAE,EAAE,CAAC;YACtC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3F,CAAC;QACD,IAAI,IAAI,CAAC,4BAA4B,EAAE,EAAE,CAAC;YACxC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAChG,CAAC;IACH,CAAC;IACS,uBAAuB;QAC/B,OAAO,gBAAO,CAAC,WAAW,EAAE,CAAC,uBAAuB,EAAE,CAAC;IACzD,CAAC;IACK,YAAY,CAAC,OAA6B;;YAC9C,IAAI,IAAI,CAAC,iBAAiB,EAAE,KAAK,SAAS,EAAE,CAAC;gBAC3C,MAAM,IAAI,CAAC,uBAAuB,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAClG,CAAC;YACD,OAAO,CAAC,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACjD,CAAC;KAAA;IACK,UAAU,CAAC,OAA6B;;YAC5C,IAAI,IAAI,CAAC,iBAAiB,EAAE,KAAK,SAAS,EAAE,CAAC;gBAC3C,MAAM,IAAI,CAAC,uBAAuB,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAClG,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC3C,IAAI,MAAM,EAAE,CAAC;gBACX,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC;YACxB,CAAC;iBACI,CAAC;gBACJ,OAAO,CAAC,MAAM,GAAG,mBAAU,CAAC,SAAS,CAAC;YACxC,CAAC;QACH,CAAC;KAAA;IACK,YAAY,CAAC,OAA6B;;YAC9C,IAAI,IAAI,CAAC,mBAAmB,EAAE,KAAK,SAAS,EAAE,CAAC;gBAC7C,MAAM,IAAI,CAAC,uBAAuB,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;YACpG,CAAC;YACD,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,OAAO,CAAC,IAAqB,CAAC,CAAC;YAC1F,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;gBAC1B,MAAM,IAAI,iBAAS,CAAC,YAAY,EAAE,mBAAU,CAAC,WAAW,CAAC,CAAC;YAC5D,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,OAAO,CAAC,IAAqB,CAAC,CAAC,CAAC;YACxH,OAAO,CAAC,MAAM,GAAG,mBAAU,CAAC,OAAO,CAAC;YACpC,OAAO,CAAC,IAAI,GAAG;gBACb,OAAO,EAAE,IAAI;gBACb,MAAM;aACP,CAAC;YACF,OAAO,MAAM,CAAC;QAChB,CAAC;KAAA;IACK,UAAU,CAAC,OAA6B;;YAC5C,IAAI,IAAI,CAAC,iBAAiB,EAAE,KAAK,SAAS,EAAE,CAAC;gBAC3C,MAAM,IAAI,CAAC,uBAAuB,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAClG,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC3C,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,IAAmB,CAAC,CAAC;gBAC/F,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;oBAC1B,MAAM,IAAI,iBAAS,CAAC,YAAY,EAAE,mBAAU,CAAC,WAAW,CAAC,CAAC;gBAC5D,CAAC;gBACD,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,IAAmB,CAAC,CAAC,CAAC;gBAC/G,OAAO,CAAC,MAAM,GAAG,mBAAU,CAAC,EAAE,CAAA;gBAC9B,OAAO,CAAC,IAAI,GAAiB;oBAC3B,OAAO,EAAE,IAAI;iBACd,CAAC;YACJ,CAAC;iBACI,CAAC;gBACJ,OAAO,CAAC,MAAM,GAAG,mBAAU,CAAC,SAAS,CAAC;YACxC,CAAC;QACH,CAAC;KAAA;IACK,YAAY,CAAC,OAA6B;;YAC9C,IAAI,IAAI,CAAC,mBAAmB,EAAE,KAAK,SAAS,EAAE,CAAC;gBAC7C,MAAM,IAAI,CAAC,uBAAuB,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;YACpG,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC3C,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAA;gBAC1D,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;oBAC1B,MAAM,IAAI,iBAAS,CAAC,YAAY,EAAE,mBAAU,CAAC,WAAW,CAAC,CAAC;gBAC5D,CAAC;gBACD,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBAC1B,OAAO,CAAC,MAAM,GAAG,mBAAU,CAAC,EAAE,CAAC;gBAC/B,OAAO,CAAC,IAAI,GAAiB;oBAC3B,OAAO,EAAE,IAAI;iBACd,CAAC;YACJ,CAAC;iBACI,CAAC;gBACJ,OAAO,CAAC,MAAM,GAAG,mBAAU,CAAC,SAAS,CAAC;YACxC,CAAC;QACH,CAAC;KAAA;IACe,MAAM,CAAC,MAAS;;YAC9B,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC5C,CAAC;KAAA;IACD,WAAW,CAAC,OAA6B;QACvC,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC,MAAM,EAAE,CAAC;IACvC,CAAC;IACD,OAAO,CAAC,OAA6B;QACnC,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACzD,CAAC;IAES,iBAAiB;QACzB,OAAO,SAAS,CAAC;IACnB,CAAC;IACS,iBAAiB;QACzB,OAAO,SAAS,CAAC;IACnB,CAAC;IACS,mBAAmB;QAC3B,OAAO,SAAS,CAAC;IACnB,CAAC;IACS,iBAAiB;QACzB,OAAO,SAAS,CAAC;IACnB,CAAC;IACS,mBAAmB;QAC3B,OAAO,SAAS,CAAC;IACnB,CAAC;IAES,0BAA0B;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IACS,0BAA0B;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IACS,4BAA4B;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IACS,0BAA0B;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IACS,4BAA4B;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IACe,kBAAkB,CAAC,IAAmB;;YACpD,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;IACe,iBAAiB,CAAC,MAAS,EAAE,IAAiB;;YAC5D,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;IACe,kBAAkB,CAAC,MAAS;;YAC1C,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;IACe,qBAAqB,CAAC,IAAmB;;YACvD,OAAO,IAAsB,CAAC;QAChC,CAAC;KAAA;IACe,qBAAqB,CAAC,MAAS,EAAE,IAAiB;;YAChE,OAAO,MAAM,CAAC;QAChB,CAAC;KAAA;CACF;AAzJD,gDAyJC","file":"rest-controller-base.js","sourcesContent":["import { ParameterizedContext } from \"koa\";\nimport { RepositoryBase } from \"../database/repositories\";\nimport { BaseResponse, ErrorBase, IdentifiableEntity } from \"../types\";\nimport { ControllerBase } from \"./controller-base\";\nimport { KoalApp, StatusCode } from \"../common\";\nimport { DeepPartial } from \"typeorm\";\n\nexport abstract class RestControllerBase<T extends IdentifiableEntity, RouteType extends Record<string, string>, PermissionType extends Record<string, string>, CreateRequest extends any = Omit<T, 'id'>, EditRequest = T> extends ControllerBase {\n  abstract getEndpoint(): RouteType[keyof RouteType];\n  abstract getRepository(): RepositoryBase<T>;\n  registerEndpoints(): void {\n    if (this.shouldRegisterListEndpoint()) {\n      this.router.get(this.getApiUrl(this.getEndpoint()), this.listEntities.bind(this));\n    }\n    if (this.shouldRegisterViewEndpoint()) {\n      this.router.get(this.getApiUrl(`${this.getEndpoint()}/:id`), this.viewEntity.bind(this));\n    }\n    if (this.shouldRegisterCreateEndpoint()) {\n      this.router.post(this.getApiUrl(this.getEndpoint()), this.createEntity.bind(this));\n    }\n    if (this.shouldRegisterEditEndpoint()) {\n      this.router.put(this.getApiUrl(`${this.getEndpoint()}/:id`), this.editEntity.bind(this));\n    }\n    if (this.shouldRegisterDeleteEndpoint()) {\n      this.router.delete(this.getApiUrl(`${this.getEndpoint()}/:id`), this.deleteEntity.bind(this));\n    }\n  }\n  protected getAuthorizationService() {\n    return KoalApp.getInstance().getAuthorizationService();\n  }\n  async listEntities(context: ParameterizedContext): Promise<void> {\n    if (this.getListPermission() !== undefined) {\n      await this.getAuthorizationService().userHasRight(context.state.user, this.getListPermission());\n    }\n    context.body = await this.getEntities(context);\n  }\n  async viewEntity(context: ParameterizedContext): Promise<void> {\n    if (this.getViewPermission() !== undefined) {\n      await this.getAuthorizationService().userHasRight(context.state.user, this.getViewPermission());\n    }\n    const entity = await this.getById(context);\n    if (entity) {\n      context.body = entity;\n    }\n    else {\n      context.status = StatusCode.NOT_FOUND;\n    }\n  }\n  async createEntity(context: ParameterizedContext): Promise<T> {\n    if (this.getCreatePermission() !== undefined) {\n      await this.getAuthorizationService().userHasRight(context.state.user, this.getCreatePermission());\n    }\n    const errorMessage = await this.entityCanBeCreated(context.request.body as CreateRequest);\n    if (errorMessage !== null) {\n      throw new ErrorBase(errorMessage, StatusCode.BAD_REQUEST);\n    }\n    const entity = await this.getRepository().save(await this.modifyEntityForCreate(context.request.body as CreateRequest));\n    context.status = StatusCode.CREATED;\n    context.body = {\n      success: true,\n      entity\n    };\n    return entity;\n  }\n  async editEntity(context: ParameterizedContext): Promise<void> {\n    if (this.getEditPermission() !== undefined) {\n      await this.getAuthorizationService().userHasRight(context.state.user, this.getEditPermission());\n    }\n    const entity = await this.getById(context);\n    if (entity) {\n      const errorMessage = await this.entityCanBeEdited(entity, context.request.body as EditRequest);\n      if (errorMessage !== null) {\n        throw new ErrorBase(errorMessage, StatusCode.BAD_REQUEST);\n      }\n      await this.getRepository().save(await this.modifyEntityForUpdate(entity, context.request.body as EditRequest));\n      context.status = StatusCode.OK\n      context.body = <BaseResponse>{\n        success: true\n      };\n    }\n    else {\n      context.status = StatusCode.NOT_FOUND;\n    }\n  }\n  async deleteEntity(context: ParameterizedContext) {\n    if (this.getDeletePermission() !== undefined) {\n      await this.getAuthorizationService().userHasRight(context.state.user, this.getDeletePermission());\n    }\n    const entity = await this.getById(context);\n    if (entity) {\n      const errorMessage = await this.entityCanBeDeleted(entity)\n      if (errorMessage !== null) {\n        throw new ErrorBase(errorMessage, StatusCode.BAD_REQUEST);\n      }\n      await this.delete(entity);\n      context.status = StatusCode.OK;\n      context.body = <BaseResponse>{\n        success: true\n      };\n    }\n    else {\n      context.status = StatusCode.NOT_FOUND;\n    }\n  }\n  protected async delete(entity: T) {\n    await this.getRepository().delete(entity);\n  }\n  getEntities(context: ParameterizedContext): Promise<T[]> {\n    return this.getRepository().getAll();\n  }\n  getById(context: ParameterizedContext): Promise<T> {\n    return this.getRepository().getById(context.params.id);\n  }\n\n  protected getListPermission(): PermissionType | undefined {\n    return undefined;\n  }\n  protected getViewPermission(): PermissionType | undefined {\n    return undefined;\n  }\n  protected getCreatePermission(): PermissionType | undefined {\n    return undefined;\n  }\n  protected getEditPermission(): PermissionType | undefined {\n    return undefined;\n  }\n  protected getDeletePermission(): PermissionType | undefined {\n    return undefined;\n  }\n\n  protected shouldRegisterListEndpoint(): boolean {\n    return true;\n  }\n  protected shouldRegisterViewEndpoint(): boolean {\n    return true;\n  }\n  protected shouldRegisterCreateEndpoint(): boolean {\n    return true;\n  }\n  protected shouldRegisterEditEndpoint(): boolean {\n    return true;\n  }\n  protected shouldRegisterDeleteEndpoint(): boolean {\n    return true;\n  }\n  protected async entityCanBeCreated(body: CreateRequest): Promise<string | null> {\n    return null;\n  }\n  protected async entityCanBeEdited(entity: T, body: EditRequest): Promise<string | null> {\n    return null;\n  }\n  protected async entityCanBeDeleted(entity: T): Promise<string | null> {\n    return null;\n  }\n  protected async modifyEntityForCreate(body: CreateRequest): Promise<DeepPartial<T>> {\n    return body as DeepPartial<T>;\n  }\n  protected async modifyEntityForUpdate(entity: T, body: EditRequest): Promise<T> {\n    return entity;\n  }\n}"]}

package/database/index.d.ts

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

package/database/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./repositories"), exports);
+
+//# sourceMappingURL=index.js.map

package/database/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/../src/database/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B","file":"index.js","sourcesContent":["export * from './repositories';\n"]}

package/database/repositories/index.d.ts

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

package/database/repositories/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./repository-base"), exports);
+
+//# sourceMappingURL=index.js.map

package/database/repositories/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/../src/database/repositories/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC","file":"index.js","sourcesContent":["export * from './repository-base';\n"]}

package/database/repositories/repository-base.d.ts

@@ -0,0 +1,16 @@
+import { DeepPartial, FindManyOptions, FindOneOptions, FindOptionsRelations, Repository } from "typeorm";
+import { IdentifiableEntity } from "../../types";
+export declare abstract class RepositoryBase<T extends IdentifiableEntity> {
+    private _repository;
+    constructor();
+    getRepository(): Repository<T>;
+    abstract getEntityType(): new () => T;
+    getAll(): Promise<T[]>;
+    getWhere(options: FindManyOptions<T>): Promise<T[]>;
+    getOneWhere(options: FindOneOptions<T>): Promise<T>;
+    getById(id: number, relations?: FindOptionsRelations<T>): Promise<T>;
+    save(entity: T | DeepPartial<T>): Promise<DeepPartial<T> & T>;
+    find(where: FindManyOptions<T>): Promise<T[]>;
+    findOne(where: FindOneOptions<T>): Promise<T>;
+    delete(entity: T): Promise<import("typeorm").DeleteResult>;
+}

package/database/repositories/repository-base.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RepositoryBase = void 0;
+const common_1 = require("../../common");
+class RepositoryBase {
+    constructor() {
+        this._repository = common_1.KoalApp.getInstance().getDatabaseConnection().getRepository(this.getEntityType());
+    }
+    getRepository() {
+        return this._repository;
+    }
+    getAll() {
+        return this._repository.find();
+    }
+    getWhere(options) {
+        return this._repository.find(options);
+    }
+    getOneWhere(options) {
+        return this._repository.findOne(options);
+    }
+    getById(id, relations) {
+        return this.getRepository().findOne({
+            where: {
+                id
+            },
+            relations
+        });
+    }
+    save(entity) {
+        return this.getRepository().save(entity);
+    }
+    find(where) {
+        return this.getRepository().find(where);
+    }
+    findOne(where) {
+        return this.getRepository().findOne(where);
+    }
+    delete(entity) {
+        return this.getRepository().delete(entity.id);
+    }
+}
+exports.RepositoryBase = RepositoryBase;
+
+//# sourceMappingURL=repository-base.js.map

package/database/repositories/repository-base.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/../src/database/repositories/repository-base.ts"],"names":[],"mappings":";;;AAEA,yCAAuC;AAEvC,MAAsB,cAAc;IAElC;QACE,IAAI,CAAC,WAAW,GAAG,gBAAO,CAAC,WAAW,EAAE,CAAC,qBAAqB,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;IACvG,CAAC;IACD,aAAa;QACX,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;IACjC,CAAC;IACD,QAAQ,CAAC,OAA2B;QAClC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IACD,WAAW,CAAC,OAA0B;QACpC,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,CAAC,EAAU,EAAE,SAAmC;QACrD,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC,OAAO,CAAoB;YACrD,KAAK,EAAE;gBACL,EAAE;aACH;YACD,SAAS;SACV,CAAC,CAAC;IACL,CAAC;IACD,IAAI,CAAC,MAA0B;QAC7B,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IACD,IAAI,CAAC,KAAyB;QAC5B,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,CAAC,KAAwB;QAC9B,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,CAAC,MAAS;QACd,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAChD,CAAC;CACF;AAtCD,wCAsCC","file":"repository-base.js","sourcesContent":["import { DeepPartial, FindManyOptions, FindOneOptions, FindOptionsRelations, Repository } from \"typeorm\";\nimport { IdentifiableEntity } from \"../../types\";\nimport { KoalApp } from \"../../common\";\n\nexport abstract class RepositoryBase<T extends IdentifiableEntity> {\n  private _repository: Repository<T>;\n  constructor() {\n    this._repository = KoalApp.getInstance().getDatabaseConnection().getRepository(this.getEntityType());\n  }\n  getRepository() {\n    return this._repository;\n  }\n  abstract getEntityType(): new () => T;\n  getAll() {\n    return this._repository.find();\n  }\n  getWhere(options: FindManyOptions<T>) {\n    return this._repository.find(options);\n  }\n  getOneWhere(options: FindOneOptions<T>) {\n    return this._repository.findOne(options);\n  }\n  getById(id: number, relations?: FindOptionsRelations<T>) {\n    return this.getRepository().findOne(<FindOneOptions<T>>{\n      where: {\n        id\n      },\n      relations\n    });\n  }\n  save(entity: T | DeepPartial<T>) {\n    return this.getRepository().save(entity);\n  }\n  find(where: FindManyOptions<T>) {\n    return this.getRepository().find(where);\n  }\n  findOne(where: FindOneOptions<T>) {\n    return this.getRepository().findOne(where);\n  }\n  delete(entity: T) {\n    return this.getRepository().delete(entity.id);\n  }\n}\n"]}

package/index.d.ts

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

package/index.js

@@ -21,6 +21,7 @@ if (require.main === module) {
 __exportStar(require("./koalas"), exports);
 __exportStar(require("./common"), exports);
 __exportStar(require("./controllers"), exports);
+__exportStar(require("./database"), exports);
 __exportStar(require("./services"), exports);
 __exportStar(require("./types"), exports);
 

package/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qCAAyC;AAEzC,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;IAC5B,IAAA,sBAAa,GAAE,CAAC;AAClB,CAAC;AAED,2CAAyB;AAEzB,2CAAyB;AACzB,gDAA8B;AAC9B,6CAA2B;AAC3B,0CAAwB","file":"index.js","sourcesContent":["import { printKoalaArt } from \"./koalas\";\n\nif (require.main === module) {\n  printKoalaArt();\n}\n\nexport * from './koalas';\n\nexport * from './common';\nexport * from './controllers';\nexport * from './services';\nexport * from './types';\n"]}
+{"version":3,"sources":["../src/../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qCAAyC;AAEzC,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;IAC5B,IAAA,sBAAa,GAAE,CAAC;AAClB,CAAC;AAED,2CAAyB;AAEzB,2CAAyB;AACzB,gDAA8B;AAC9B,6CAA2B;AAC3B,6CAA2B;AAC3B,0CAAwB","file":"index.js","sourcesContent":["import { printKoalaArt } from \"./koalas\";\n\nif (require.main === module) {\n  printKoalaArt();\n}\n\nexport * from './koalas';\n\nexport * from './common';\nexport * from './controllers';\nexport * from './database';\nexport * from './services';\nexport * from './types';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kool-koala",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "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",
@@ -40,10 +40,6 @@
     "@types/gulp-rename": "^2.0.6",
     "@types/gulp-sourcemaps": "^0.0.38",
     "@types/jsonwebtoken": "^9.0.9",
-    "@types/koa": "^2.15.0",
-    "@types/koa-bodyparser": "^4.3.12",
-    "@types/koa-router": "^7.4.8",
-    "@types/koa-static": "^4.0.4",
     "@types/yargs": "^17.0.33",
     "commitizen": "^4.3.1",
     "cz-git": "^1.11.1",
@@ -69,6 +65,10 @@
     "typeorm": "^0.3.21"
   },
   "dependencies": {
+    "@types/koa": "^2.15.0",
+    "@types/koa-bodyparser": "^4.3.12",
+    "@types/koa-router": "^7.4.8",
+    "@types/koa-static": "^4.0.4",
     "jsonwebtoken": "^9.0.2",
     "koa-bodyparser": "^4.4.1",
     "koa-static": "^5.0.0"