taon 19.0.66 → 19.0.67

package/browser/fesm2022/taon.mjs

@@ -1,6 +1,6 @@
 import 'reflect-metadata';
 import * as coreHelpers from 'tnp-core/browser';
-import { _, Utils, Helpers, UtilsOs, CoreModels, crossPlatformPath } from 'tnp-core/browser';
+import { _, Utils, Helpers, UtilsOs, CoreModels, crossPlatformPath, UtilsTerminal } from 'tnp-core/browser';
 import { __decorate, __metadata, __param } from 'tslib';
 import { SYMBOL, CLASS } from 'typescript-class-helpers/browser';
 import { OrignalClassKey, Table } from 'taon-typeorm/browser';
@@ -9,7 +9,7 @@ import * as i0 from '@angular/core';
 import { InjectionToken, inject as inject$1, Injectable } from '@angular/core';
 import axios from 'axios';
 import { JSON10 } from 'json10/browser';
-import { Models as Models$1, Resource, RestHeaders, Mapping } from 'ng2-rest/browser';
+import { RestResponseWrapper, Models as Models$1, Resource, RestHeaders, Mapping, HttpResponseError } from 'ng2-rest/browser';
 import { Observable, from, Subject } from 'rxjs';
 import { config } from 'tnp-config/browser';
 import * as JSON5 from 'json5';
@@ -488,9 +488,26 @@ class BaseClass {
     async _() { }
     //#endregion
     //#region clone
-    clone(override) {
+    /**
+     *
+     * @param overrideObjOrFn if object is provided it will override values in cloned object,
+     * if function is provided it will be called with old cloned values and should return
+     * object with values to override
+     * @returns cloned instance of the class
+     */
+    clone(overrideObjOrFn) {
+        if (_.isString(overrideObjOrFn)) {
+            console.log(overrideObjOrFn);
+            throw new Error('String is not supported as .clone() method argument');
+        }
         const classFn = ClassHelpers.getClassFnFromObject(this);
-        return cloneObj(override, classFn);
+        if (_.isFunction(overrideObjOrFn)) {
+            // console.log('clone with fn');
+            const oldValues = (_.cloneDeep(this) || {});
+            return cloneObj(overrideObjOrFn(oldValues), classFn);
+        }
+        // console.log('clone normal');
+        return cloneObj(overrideObjOrFn, classFn);
     }
 }
 
@@ -1208,9 +1225,6 @@ const getResponseValue = (response, options) => {
     /* */
     /* */
     /* */
-    /* */
-    /* */
-    /* */
     return (void 0);
 };
 
@@ -1231,6 +1245,12 @@ var TaonHelpers;
         return p && typeof p === 'string' && p.trim() !== '';
     };
     //#endregion
+    TaonHelpers.firstStringOrElemFromArray = (stringOrArrayOfString) => {
+        if (Array.isArray(stringOrArrayOfString)) {
+            return _.first(stringOrArrayOfString);
+        }
+        return stringOrArrayOfString;
+    };
     //#region try transform params
     TaonHelpers.tryTransformParam = param => {
         if (typeof param === 'string') {
@@ -1354,6 +1374,9 @@ var TaonHelpers;
     //#endregion
 })(TaonHelpers || (TaonHelpers = {}));
 
+// ! TODO make it as a nice way to wrap normal request
+class TaonRestResponseWrapper extends RestResponseWrapper {
+}
 var Models;
 (function (Models) {
     //#region models / class types
@@ -1411,25 +1434,6 @@ var Models;
     let Http;
     (function (Http) {
         Http.Rest = Models$1;
-        class Errors {
-            constructor(message, code = 400) {
-                this.message = message;
-                this.code = code;
-                this.toString = () => {
-                    return this.message;
-                };
-            }
-            static create(message, code = 400) {
-                return new Errors(message, code);
-            }
-            static entityNotFound(entity) {
-                return Errors.create(`Entity ${ClassHelpers.getName(entity)} not found`);
-            }
-            static custom(message, code = 400) {
-                return Errors.create(message, code);
-            }
-        }
-        Http.Errors = Errors;
         /* */
         /* */
         /* */
@@ -1539,6 +1543,14 @@ class RealtimeSubsManager {
 
 //#region imports
 //#endregion
+/**
+ * Client for realtime communication
+ * you can listen to:
+ * - entity changes (any property in table changed)
+ * - entity custom property changes (specific property changed)
+ * - entity table changes (new instance added, instance removed)
+ * - custom events
+ */
 class RealtimeClient {
     constructor(core) {
         this.core = core;
@@ -1612,20 +1624,32 @@ class RealtimeClient {
     //#endregion
     //#region methods & getters  / listen changes entity
     /**
+     * Usage:
+     * myContext.realtimeClient.listenChangesEntity(myEntityInstance);
+     *
+     *
      * Changes trigger on backend needs to be done manually.. example code:
      *
-     * ...
-     * Context.Realtime.Server.TrigggerEntityChanges(myEntityInstance);
+     * myContext.realtimeServer.triggerEntityChanges(myEntityInstance);
      * ...
      */
-    listenChangesEntity(entityClassFn, idOrUniqValue, options) {
+    listenChangesEntity(entityClassFnOrObj, options) {
         options = options || {};
+        if (_.isObject(entityClassFnOrObj)) {
+            const orgObj = entityClassFnOrObj;
+            entityClassFnOrObj =
+                ClassHelpers.getClassFnFromObject(entityClassFnOrObj);
+            const uniqueKey = ClassHelpers.getUniqueKey(entityClassFnOrObj);
+            if (uniqueKey) {
+                options.idOrUniqValue = orgObj[uniqueKey];
+            }
+        }
         //#region parameters validation
         const { property, customEvent } = options;
-        const className = !customEvent && ClassHelpers.getName(entityClassFn);
+        const className = !customEvent && ClassHelpers.getName(entityClassFnOrObj);
         if (_.isString(property)) {
             if (property.trim() === '') {
-                throw new Error(`[Taon][listenChangesEntity.. incorect property '' for ${className}`);
+                throw new Error(`[Taon][listenChangesEntity.. incorrect property '' for ${className}`);
             }
         }
         //#endregion
@@ -1650,8 +1674,8 @@ to use socket realtime connection;
             }
             else {
                 roomName = _.isString(property)
-                    ? Symbols.REALTIME.ROOM_NAME_UPDATE_ENTITY_PROPERTY(this.core.ctx.contextName, className, property, idOrUniqValue)
-                    : Symbols.REALTIME.ROOM_NAME_UPDATE_ENTITY(this.core.ctx.contextName, className, idOrUniqValue);
+                    ? Symbols.REALTIME.ROOM_NAME_UPDATE_ENTITY_PROPERTY(this.core.ctx.contextName, className, property, options.idOrUniqValue)
+                    : Symbols.REALTIME.ROOM_NAME_UPDATE_ENTITY(this.core.ctx.contextName, className, options.idOrUniqValue);
             }
             const roomSubOptions = {
                 core: this.core,
@@ -1674,32 +1698,20 @@ to use socket realtime connection;
     }
     //#endregion
     //#region listen changes entity table
+    /**
+     * Listen changes entity table
+     * Example: for pagination, lists update ...
+     */
     listenChangesEntityTable(entityClassFn) {
         const className = ClassHelpers.getName(entityClassFn);
-        return this.listenChangesEntity(entityClassFn, void 0, {
+        return this.listenChangesEntity(entityClassFn, {
             customEvent: Symbols.REALTIME.TABLE_CHANGE(this.core.ctx.contextName, className),
         });
     }
     //#endregion
-    //#region listen change entity object
-    /**
-     * Changes trigger on backend needs to be done manually.. example code:
-     *
-     * ...
-     * Context.Realtime.Server.TrigggerEntityChanges(myEntityInstance);
-     * // or
-     * Context.Realtime.Server.TrigggerEntityPropertyChanges(myEntityInstance,{ property: 'geolocationX' });
-     * ...
-     */
-    listenChangesEntityObj(entity, options) {
-        const classFn = ClassHelpers.getClassFnFromObject(entity);
-        const uniqueKey = ClassHelpers.getUniqueKey(classFn);
-        return this.listenChangesEntity(classFn, entity[uniqueKey], options);
-    }
-    //#endregion
     //#region listen changes custom event
     listenChangesCustomEvent(customEvent) {
-        return this.listenChangesEntity(void 0, void 0, {
+        return this.listenChangesEntity(void 0, {
             customEvent,
         });
     }
@@ -1725,6 +1737,17 @@ to use socket realtime connection;
 //#region imports
 /* */
 //#endregion
+/**
+ * Server for realtime communication
+ * you can trigger:
+ * - entity changes (any property in table changed)
+ * - entity custom property changes (specific property changed)
+ * - entity table changes (new instance added, instance removed)
+ * - custom events
+ *
+ * and also listen to:
+ * - custom events from yourself
+ */
 class RealtimeServer {
     // private jobs = {};
     constructor(core) {
@@ -1972,7 +1995,12 @@ class RealtimeServer {
     //#endregion
     //#region entity changes
     //#region methods & getters / trigger entity changes
-    triggerEntityChanges(entityObjOrClass, idToTrigger) {
+    triggerEntityChanges(entityObjOrClass, 
+    /**
+     * value of unique key property of entity instance
+     * (this value is not needed if entityObjOrClass is instance of entity)
+     */
+    idToTrigger) {
         if (this.core.ctx.disabledRealtime) {
             const className = ClassHelpers.getName(entityObjOrClass);
             console.warn(`[Taon][TriggerEntityChanges] Entity "${className}' is not realtime`);
@@ -1982,7 +2010,17 @@ class RealtimeServer {
     }
     //#endregion
     //#region methods & getters / trigger entity property changes
-    triggerEntityPropertyChanges(entityObjOrClass, property, idToTrigger) {
+    triggerEntityPropertyChanges(entityObjOrClass, 
+    /**
+     * property name or array of property names that changed
+     * for entity instance
+     */
+    property, 
+    /**
+     * value of unique key property of entity instance
+     * (this value is not needed if entityObjOrClass is instance of entity)
+     */
+    idToTrigger) {
         if (this.core.ctx.disabledRealtime) {
             const className = ClassHelpers.getName(entityObjOrClass);
             console.warn(`[Taon][TriggerEntityPropertyChanges][property=${property}] Entity "${className}' is not realtime`);
@@ -2760,6 +2798,12 @@ class EndpointContext {
         }
         return this.config?.logs === true;
     }
+    get logRoutes() {
+        if (_.isObject(this.config?.logs)) {
+            return !!this.config.logs.routes;
+        }
+        return this.config?.logs === true;
+    }
     get logDb() {
         if (_.isObject(this.config?.logs)) {
             return !!this.config.logs.db;
@@ -4255,9 +4299,7 @@ class EndpointContext {
     //#endregion
     //#region methods & getters / write active routes
     writeActiveRoutes() {
-        if (this.isRemoteHost ||
-            this.isRunOrRevertOnlyMigrationAppStart ||
-            this.skipWritingServerRoutes) {
+        if (this.isRemoteHost || this.isRunOrRevertOnlyMigrationAppStart) {
             return;
         }
         // const contexts: EndpointContext[] = [this];
@@ -4297,6 +4339,7 @@ class EndpointContext {
         /* */
         /* */
         /* */
+        /* */
     }
     //#endregion
     //#region methods & getters / middlewares
@@ -4775,6 +4818,39 @@ class EndpointContext {
         };
     }
     //#endregion
+    sendError(res, error, req, expressPath) {
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        return (void 0);
+    }
     //#region methods & getters / init client
     /**
      * client can be browser or nodejs (when remote host)
@@ -4809,8 +4885,8 @@ class EndpointContext {
         });
         //#endregion
         // : { received: any; /* Rest<any, any>  */ }
-        this.logHttp &&
-            console.log(`${httpRequestType?.toUpperCase()} ${expressPath} `);
+        // this.logHttp &&
+        //   console.log(`${httpRequestType?.toUpperCase()} ${expressPath} `);
         // console.log('INITING', methodConfig); // TODO inject in static
         //#region resolve storage
         // TODO not a good idea
@@ -5887,6 +5963,9 @@ let BaseRepository = class BaseRepository extends BaseCustomRepository {
         /* */
         return (void 0);
     }
+    /**
+     * @deprecated use bulkSave instead
+     */
     async bulkCreate(items, options) {
         return this.bulkSave(items, options);
     }
@@ -6414,7 +6493,7 @@ const metaReq = (method, path, target, propertyKey, descriptor, pathOrOptions, p
     else {
         options = { pathOrOptions, pathIsGlobal };
     }
-    const { overrideContentType, overrideResponseType, middlewares } = options;
+    const { overrideContentType, overrideResponseType, overrideExpressSendAsHtml, middlewares, } = options;
     methodConfig.methodName = propertyKey;
     methodConfig.middlewares = middlewares;
     methodConfig.type = method;
@@ -6439,12 +6518,44 @@ const metaReq = (method, path, target, propertyKey, descriptor, pathOrOptions, p
     methodConfig.global = pathIsGlobal;
     methodConfig.contentType = overrideContentType;
     methodConfig.responseType = overrideResponseType;
+    methodConfig.overrideExpressSendAsHtml = overrideExpressSendAsHtml;
 };
 function GET(pathOrOptions, pathIsGlobal = false) {
     return function (target, propertyKey, descriptor) {
         metaReq('get', pathOrOptions, target, propertyKey, descriptor, pathOrOptions, pathIsGlobal);
     };
 }
+/**
+ * Method for sending html website from text
+ * Example
+ *
+ * ```ts
+ * ...
+ * // in your taon controller
+ * ..Taon.Http.HTML()
+ * sendHtmlDummyWebsite(): Taon.ResponseHtml {
+ *  return  `
+      <html>
+        <head>
+          <title>Dummy website</title>
+        </head>
+        <body>
+          <h1>This is dummy website</h1>
+          <p>Served as HTML string from Taon controller method</p>
+        </body>
+      </html>
+ *  `; *
+ * }
+ * ...
+ * ```
+ */
+function HTML(pathOrOptions) {
+    return function (target, propertyKey, descriptor) {
+        const opt = pathOrOptions;
+        opt.overrideExpressSendAsHtml = true;
+        metaReq('get', opt, target, propertyKey, descriptor, pathOrOptions, opt.pathIsGlobal);
+    };
+}
 function HEAD(pathOrOptions, pathIsGlobal = false) {
     return function (target, propertyKey, descriptor) {
         metaReq('head', pathOrOptions, target, propertyKey, descriptor, pathOrOptions, pathIsGlobal);
@@ -6520,7 +6631,7 @@ let BaseController = class BaseController extends BaseInjector {
      */
     async afterAllCtxInited(options) { }
     //#region upload form data to server
-    uploadFormDataToServer(formData) {
+    uploadFormDataToServer(formData, queryParams) {
         /* */
         /* */
         /* */
@@ -6555,11 +6666,13 @@ let BaseController = class BaseController extends BaseInjector {
      * Hook after file is uploaded
      * through `uploadFormDataToServer` or `uploadLocalFileToServer`
      */
-    afterFileUploadAction(file) {
+    afterFileUploadAction(file, queryParams) {
         // empty
     }
     //#region upload local file to server
-    async uploadLocalFileToServer(absFilePath, options) {
+    async uploadLocalFileToServer(absFilePath, options, queryParams) {
+        /* */
+        /* */
         /* */
         /* */
         /* */
@@ -6574,6 +6687,75 @@ let BaseController = class BaseController extends BaseInjector {
         /* */
         return (void 0);
     }
+    //#endregion
+    // async check() {
+    //   await this._waitForProperStatusChange({
+    //     request: () => this.uploadFormDataToServer(void 0, void 0).request(),
+    //     statusCheck: resp => resp.body.json[0].ok,
+    //   });
+    // }
+    /**
+     * Easy way to wait for status change with http (1s default) pooling.
+     *
+     * example (in sub class):
+     * ```ts
+        async check() {
+            await this.waitForProperStatusChange({
+              request: () => this.uploadFormDataToServer(void 0, void 0).request(),
+              statusCheck: resp => resp.body.json[0].ok,
+            });
+          }
+     * ```
+     */
+    async _waitForProperStatusChange(options) {
+        const poolingInterval = options.poolingInterval || 1000;
+        const taonRequest = options.request;
+        let maxTries = options.maxTries || Number.POSITIVE_INFINITY;
+        let i = 0;
+        let httpErrorsCount = 0;
+        while (true) {
+            await UtilsTerminal.waitMilliseconds(poolingInterval);
+            try {
+                const resp = await taonRequest({
+                    reqIndexNum: i,
+                    httpErrorsCount,
+                });
+                if (options.statusCheck && options.statusCheck(resp)) {
+                    return;
+                }
+            }
+            catch (error) {
+                httpErrorsCount++;
+                if (options.loopRequestsOnBackendError) {
+                    const isProperTaonError = error instanceof HttpResponseError &&
+                        error.body.json[CoreModels.TaonHttpErrorCustomProp];
+                    const isHttpError = error instanceof HttpResponseError && !isProperTaonError;
+                    const isUnknownError = !(error instanceof HttpResponseError);
+                    const resBool = await options.loopRequestsOnBackendError({
+                        taonError: isProperTaonError ? error : void 0,
+                        unknownHttpError: isHttpError ? error : void 0,
+                        unknownError: isUnknownError ? error : void 0,
+                        reqIndexNum: i,
+                        httpErrorsCount,
+                    });
+                    if (resBool) {
+                        i++;
+                        continue;
+                    }
+                    else {
+                        return;
+                    }
+                }
+                if (httpErrorsCount >
+                    (options.allowedHttpErrors || Number.POSITIVE_INFINITY)) {
+                    throw new Error(`Too many http errors (${httpErrorsCount}) for "${options.actionName}".`);
+                }
+            }
+            if (i++ > maxTries) {
+                throw new Error(`Timeout waiting for "${options.actionName}" to be finished. Waited for ${maxTries} seconds`);
+            }
+        }
+    }
 };
 __decorate([
     POST({
@@ -6584,8 +6766,9 @@ __decorate([
         }),
     }),
     __param(0, Body()),
+    __param(1, Query()),
     __metadata("design:type", Function),
-    __metadata("design:paramtypes", [FormData]),
+    __metadata("design:paramtypes", [FormData, Object]),
     __metadata("design:returntype", Object)
 ], BaseController.prototype, "uploadFormDataToServer", null);
 BaseController = __decorate([
@@ -6617,7 +6800,7 @@ let BaseCrudController = class BaseCrudController extends BaseController {
         else {
             Helpers.error(`Entity class not provided for controller ${ClassHelpers.getName(this)}.
 
-      Please provide entity as class propery entityClassFn:
+      Please provide entity as class property entityClassFn:
 
       class ${ClassHelpers.getName(this)} extends BaseCrudController<Entity> {
         // ...
@@ -6772,8 +6955,17 @@ let BaseCrudController = class BaseCrudController extends BaseController {
         return (void 0);
     }
     //#endregion
+    //#region bulk delete
+    clearTable() {
+        /* */
+        /* */
+        /* */
+        /* */
+        return (void 0);
+    }
+    //#endregion
     //#region create
-    create(item) {
+    save(item) {
         /* */
         /* */
         /* */
@@ -6850,7 +7042,7 @@ __decorate([
     DELETE(),
     __param(0, Query(`id`)),
     __metadata("design:type", Function),
-    __metadata("design:paramtypes", [Number]),
+    __metadata("design:paramtypes", [Object]),
     __metadata("design:returntype", Object)
 ], BaseCrudController.prototype, "deleteById", null);
 __decorate([
@@ -6860,13 +7052,19 @@ __decorate([
     __metadata("design:paramtypes", [Array]),
     __metadata("design:returntype", Object)
 ], BaseCrudController.prototype, "bulkDelete", null);
+__decorate([
+    DELETE(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Object)
+], BaseCrudController.prototype, "clearTable", null);
 __decorate([
     POST(),
     __param(0, Body()),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object]),
     __metadata("design:returntype", Object)
-], BaseCrudController.prototype, "create", null);
+], BaseCrudController.prototype, "save", null);
 __decorate([
     POST(),
     __param(0, Body()),
@@ -7132,6 +7330,7 @@ var Http;
     Http.DELETE = DELETE;
     Http.PATCH = PATCH;
     Http.HEAD = HEAD;
+    Http.HTML = HTML;
     Http.Response = Models$1.HttpResponse;
     let Param;
     (function (Param) {
@@ -7146,6 +7345,11 @@ var Http;
 // TODO export all things
 var Taon;
 (function (Taon) {
+    Taon.error = (opt) => {
+        throw () => {
+            return opt;
+        };
+    };
     Taon.Http = Http;
     Taon.Base = Base;
     Taon.getResponseValue = getResponseValue;
@@ -7198,5 +7402,5 @@ var Taon;
  * Generated bundle index. Do not edit.
  */
 
-export { BaseContext, BaseController, BaseCustomRepository, BaseEntity, BaseFileUploadMiddleware, BaseMigration, BaseProvider, BaseRepository, CURRENT_HOST_BACKEND_PORT, CURRENT_HOST_URL, ClassHelpers, ContextsEndpointStorage, EndpointContext, Models, TAON_CONTEXT, Taon, TaonAdminService, TaonEntityKeysToOmitArr, apiPrefix, createContext, inject };
+export { BaseClass, BaseContext, BaseController, BaseCustomRepository, BaseEntity, BaseFileUploadMiddleware, BaseMigration, BaseProvider, BaseRepository, CURRENT_HOST_BACKEND_PORT, CURRENT_HOST_URL, ClassHelpers, ContextsEndpointStorage, EndpointContext, Models, TAON_CONTEXT, Taon, TaonAdminService, TaonEntityKeysToOmitArr, apiPrefix, createContext, inject };
 //# sourceMappingURL=taon.mjs.map