taon 21.0.29 → 21.0.32

package/lib-prod/models.d.ts

@@ -1,6 +1,6 @@
 import type { RequestHandler } from 'express';
-import { Models as ModelsNg2Rest, RestResponseWrapper } from 'ng2-rest/lib-prod';
-import { CoreModels } from 'tnp-core/lib-prod';
+import { RestResponseWrapper, Models_HttpResponse as ModelsNg2Rest_HttpResponse, Models_Ng2RestAxiosRequestConfig as ModelsNg2Rest_Ng2RestAxiosRequestConfig, Models_PromiseObservableMix as ModelsNg2Rest_PromiseObservableMix } from 'ng2-rest/lib-prod';
+import { CoreModels_DatabaseType } from 'tnp-core/lib-prod';
 import type { EndpointContext } from './endpoint-context';
 import { ExpressRequest, ExpressResponse } from './express-types';
 export declare class TaonRestResponseWrapper extends RestResponseWrapper {
@@ -8,253 +8,248 @@ export declare class TaonRestResponseWrapper extends RestResponseWrapper {
 export declare const BaseTaonClassesNames: readonly ["BaseCrudController", "BaseController", "BaseAbstractEntity", "BaseEntity", "BaseContext", "BaseCustomRepository", "BaseFileUploadMiddleware", "BaseMiddleware", "BaseClass", "BaseInjector", "BaseMigration", "BaseProvider", "BaseRepository", "BaseSubscriberForEntity", "BaseCliWorkerController", "PortsController", "PortsContext"];
 export declare const TaonTempDatabasesFolder = "databases";
 export declare const TaonTempRoutesFolder = "routes";
-export declare namespace Models {
-    const DatabasesFolder = "databases";
-    type FrameworkMode = 'backend-frontend(tcp+udp)' | 'remote-backend(tcp+udp)' | 'backend-frontend(ipc-electron)' | 'backend-frontend(websql-electron)' | 'backend-frontend(websql)';
-    enum ClassType {
-        ENTITY = "ENTITY",
-        CONTROLLER = "CONTROLLER",
-        REPOSITORY = "REPOSITORY",
-        PROVIDER = "PROVIDER",
-        SUBSCRIBER = "SUBSCRIBER",
-        MIGRATION = "MIGRATION",
-        MIDDLEWARE = "MIDDLEWARE"
-    }
-    const ClassTypeKey: { [key in ClassType]: keyof ContextOptions<any, any, any, any, any, any, any, any>; };
-    type MiddlewareType = [Function, any[]];
+export declare const Models_DatabasesFolder = "databases";
+export type Models_FrameworkMode = 'backend-frontend(tcp+udp)' | 'remote-backend(tcp+udp)' | 'backend-frontend(ipc-electron)' | 'backend-frontend(websql-electron)' | 'backend-frontend(websql)';
+export declare enum Models_ClassType {
+    ENTITY = "ENTITY",
+    CONTROLLER = "CONTROLLER",
+    REPOSITORY = "REPOSITORY",
+    PROVIDER = "PROVIDER",
+    SUBSCRIBER = "SUBSCRIBER",
+    MIGRATION = "MIGRATION",
+    MIDDLEWARE = "MIDDLEWARE"
+}
+export declare const Models_ClassTypeKey: { [key in Models_ClassType]: keyof Models_ContextOptions<any, any, any, any, any, any, any, any>; };
+export type Models_MiddlewareType = [Function, any[]];
+/**
+ * DROP_DB+MIGRATIONS (default for development)
+ * Drop all tables + recreate them + run migrations
+ * synchronize: true , dropSchema: true
+ * use migrations: true
+ *
+ * MIGRATIONS (default for production)
+ * Do not drop tables, only run migrations
+ * synchronize: false, dropSchema: false
+ * use migrations: true
+ */
+export type Models_DBRecreateMode = 'DROP_DB+MIGRATIONS' | 'PRESERVE_DATA+MIGRATIONS';
+export declare class Models_DatabaseConfigTypeOrm {
+    /**
+     * database name
+     */
+    database?: string;
+    /**
+     * only for file base db: sqlite, sqljs
+     */
+    location?: string;
+    synchronize: boolean;
+    dropSchema: boolean;
+    type?: CoreModels_DatabaseType;
     /**
-     * DROP_DB+MIGRATIONS (default for development)
-     * Drop all tables + recreate them + run migrations
-     * synchronize: true , dropSchema: true
-     * use migrations: true
+     * Persists db on disk/local-storage if serverless db
+     */
+    autoSave?: boolean;
+    /**
+     * for websql db mode
+     * true by default
+     */
+    useLocalForage?: boolean;
+    logging: boolean;
+    databasePort?: number;
+    databaseHost?: string;
+    databaseUsername?: string;
+    databasePassword?: string;
+}
+export declare class Models_DatabaseConfig extends Models_DatabaseConfigTypeOrm {
+    /**
+     * Default value 'DROP_ALL'.
      *
-     * MIGRATIONS (default for production)
-     * Do not drop tables, only run migrations
-     * synchronize: false, dropSchema: false
-     * use migrations: true
+     * Tell framework what is happening with db
+     * when context is starting.
      */
-    type DBRecreateMode = 'DROP_DB+MIGRATIONS' | 'PRESERVE_DATA+MIGRATIONS';
-    class DatabaseConfigTypeOrm {
-        /**
-         * database name
-         */
-        database?: string;
-        /**
-         * only for file base db: sqlite, sqljs
-         */
-        location?: string;
-        synchronize: boolean;
-        dropSchema: boolean;
-        type?: CoreModels.DatabaseType;
-        /**
-         * Persists db on disk/local-storage if serverless db
-         */
-        autoSave?: boolean;
-        /**
-         * for websql db mode
-         * true by default
-         */
-        useLocalForage?: boolean;
-        logging: boolean;
-        databasePort?: number;
-        databaseHost?: string;
-        databaseUsername?: string;
-        databasePassword?: string;
-    }
-    class DatabaseConfig extends DatabaseConfigTypeOrm {
-        /**
-         * Default value 'DROP_ALL'.
-         *
-         * Tell framework what is happening with db
-         * when context is starting.
-         */
-        recreateMode?: DBRecreateMode;
-        static from(databasePartialConfig: Partial<Omit<DatabaseConfig, 'synchronize' | 'dropSchema' | 'databaseConfigTypeORM'>>): DatabaseConfig;
-        get databaseConfigTypeORM(): DatabaseConfigTypeOrm;
-    }
-    type ISession = {
-        secret?: string;
-        saveUninitialized?: boolean;
-        /**
-         * max age of session
-         */
-        cookieMaxAge?: number;
-        secure?: boolean;
-        resave?: boolean;
-    };
-    type ConnectionOptionsLogs = {
-        http?: boolean;
-        realtime?: boolean;
-        framework?: boolean;
-        db?: boolean;
-        migrations?: boolean;
-        routes?: boolean;
+    recreateMode?: Models_DBRecreateMode;
+    static from(databasePartialConfig: Partial<Omit<Models_DatabaseConfig, 'synchronize' | 'dropSchema' | 'databaseConfigTypeORM'>>): Models_DatabaseConfig;
+    get databaseConfigTypeORM(): Models_DatabaseConfigTypeOrm;
+}
+export type Models_ISession = {
+    secret?: string;
+    saveUninitialized?: boolean;
+    /**
+     * max age of session
+     */
+    cookieMaxAge?: number;
+    secure?: boolean;
+    resave?: boolean;
+};
+export type Models_ConnectionOptionsLogs = {
+    http?: boolean;
+    realtime?: boolean;
+    framework?: boolean;
+    db?: boolean;
+    migrations?: boolean;
+    routes?: boolean;
+};
+export interface Models_ContextOptions<CONTEXTS, CONTROLLERS, ENTITIES, REPOSITORIES, PROVIDERS, SUBSCRIBERS, MIGRATIONS, MIDDLEWARES> {
+    appId?: string;
+    contextName: string;
+    /**
+     * if defined and different from contextName
+     * - context will NOT be initialized
+     */
+    activeContext?: string | null;
+    /**
+     * IMPORTANT! provide full url that starts with http:// or https://
+     * host/port for initing backend server
+     */
+    host?: string;
+    /**
+     * Needs to be specified in docker environment only
+     */
+    hostPortNumber?: number;
+    /**
+     * IMPORTANT! provide full url that starts with http:// or https://
+     * frontend host only needed when we are
+     * using withCredentials for axios
+     * and session cookie
+     * or realtime communication
+     */
+    frontendHost?: string;
+    /**
+     * Needs to be specified in docker environment only
+     */
+    frontendHostPortNumber?: number;
+    /**
+     * User ipc for communication between BE/FE
+     * when electron is used as a platform
+     * Default: true
+     */
+    useIpcWhenElectron?: boolean;
+    /**
+     * taon contexts here
+     * (module like structure)
+     */
+    contexts?: CONTEXTS;
+    /**
+     * taon controller here
+     * (glue between frontend and backend)
+     */
+    controllers?: CONTROLLERS;
+    /**
+     * taon entities
+     * (entities are used to create tables in db)
+     */
+    entities?: ENTITIES;
+    /**
+     * taon repositories
+     * (repositories are used to access data from db)
+     */
+    repositories?: REPOSITORIES;
+    /**
+     * taon providers
+     * (context singletons)
+     */
+    providers?: PROVIDERS;
+    /**
+     * taon subscribers
+     * (subscribers are used to listen to db events)
+     */
+    subscribers?: SUBSCRIBERS;
+    /**
+     * taon migrations
+     * (migrations are used to update db schema and achieve proper CI/CD)
+     */
+    migrations?: MIGRATIONS;
+    /**
+     * taon middlewares
+     * middlewares are used to intercept requests
+     * and responses in the context
+     */
+    middlewares?: MIDDLEWARES;
+    /**
+     * Config for express session
+     */
+    session?: Models_ISession;
+    /**
+     * taon is not going to write .rest files to cwd()
+     */
+    skipWritingServerRoutes?: boolean;
+    /**
+     * TODO - this is still in progress
+     * @deprecated
+     */
+    productionMode?: boolean;
+    /**
+     * If you want your context to never be started as separated server
+     * use abstract: true
+     * @default: false
+     */
+    abstract?: boolean;
+    logs?: boolean | Models_ConnectionOptionsLogs;
+    database?: boolean | Partial<Models_DatabaseConfig>;
+    /**
+     * disable default realtime communication through TCP upgrade sockets
+     */
+    disabledRealtime?: boolean;
+    /**
+     * Will be removed soon - cloud will handle certs and https
+     * @deprecated
+     */
+    https?: {
+        key: string;
+        cert: string;
     };
-    interface ContextOptions<CONTEXTS, CONTROLLERS, ENTITIES, REPOSITORIES, PROVIDERS, SUBSCRIBERS, MIGRATIONS, MIDDLEWARES> {
-        appId?: string;
-        contextName: string;
-        /**
-         * if defined and different from contextName
-         * - context will NOT be initialized
-         */
-        activeContext?: string | null;
-        /**
-         * IMPORTANT! provide full url that starts with http:// or https://
-         * host/port for initing backend server
-         */
-        host?: string;
-        /**
-         * Needs to be specified in docker environment only
-         */
-        hostPortNumber?: number;
-        /**
-         * IMPORTANT! provide full url that starts with http:// or https://
-         * frontend host only needed when we are
-         * using withCredentials for axios
-         * and session cookie
-         * or realtime communication
-         */
-        frontendHost?: string;
-        /**
-         * Needs to be specified in docker environment only
-         */
-        frontendHostPortNumber?: number;
-        /**
-         * User ipc for communication between BE/FE
-         * when electron is used as a platform
-         * Default: true
-         */
-        useIpcWhenElectron?: boolean;
-        /**
-         * taon contexts here
-         * (module like structure)
-         */
-        contexts?: CONTEXTS;
-        /**
-         * taon controller here
-         * (glue between frontend and backend)
-         */
-        controllers?: CONTROLLERS;
-        /**
-         * taon entities
-         * (entities are used to create tables in db)
-         */
-        entities?: ENTITIES;
-        /**
-         * taon repositories
-         * (repositories are used to access data from db)
-         */
-        repositories?: REPOSITORIES;
-        /**
-         * taon providers
-         * (context singletons)
-         */
-        providers?: PROVIDERS;
-        /**
-         * taon subscribers
-         * (subscribers are used to listen to db events)
-         */
-        subscribers?: SUBSCRIBERS;
-        /**
-         * taon migrations
-         * (migrations are used to update db schema and achieve proper CI/CD)
-         */
-        migrations?: MIGRATIONS;
-        /**
-         * taon middlewares
-         * middlewares are used to intercept requests
-         * and responses in the context
-         */
-        middlewares?: MIDDLEWARES;
-        /**
-         * Config for express session
-         */
-        session?: ISession;
-        /**
-         * taon is not going to write .rest files to cwd()
-         */
-        skipWritingServerRoutes?: boolean;
-        /**
-         * TODO - this is still in progress
-         * @deprecated
-         */
-        productionMode?: boolean;
-        /**
-         * If you want your context to never be started as separated server
-         * use abstract: true
-         * @default: false
-         */
-        abstract?: boolean;
-        logs?: boolean | ConnectionOptionsLogs;
-        database?: boolean | Partial<DatabaseConfig>;
-        /**
-         * disable default realtime communication through TCP upgrade sockets
-         */
-        disabledRealtime?: boolean;
-        /**
-         * Will be removed soon - cloud will handle certs and https
-         * @deprecated
-         */
-        https?: {
-            key: string;
-            cert: string;
-        };
-        /**
-         * TODO - will be removed soon
-         * @deprecated
-         */
-        publicAssets?: {
-            serverPath: string;
-            locationOnDisk: string;
-        }[];
-        /**
-         * by default cwd === process.cwd()
-         */
-        cwd?: string;
-    }
-    namespace Http {
-        export import Rest = ModelsNg2Rest;
-        type ContextENDPOINT = {
-            target: Function;
-            initFN: Function;
-        };
-        type FormlyFromType = 'material' | 'bootstrap';
-        type ExpressContext<T> = (req: ExpressRequest<any>, res: ExpressResponse<any>) => T;
-        type SyncResponse<T> = string | T;
-        type ResponseFuncOpt<T> = {
-            limitSize?: (enties: Function | Function[], include: string[], exclude: string[]) => void;
-        };
-        type SyncResponseFunc<T> = (options?: ResponseFuncOpt<T>) => SyncResponse<T>;
-        type MixResponse<T> = SyncResponse<T> | ExpressContext<T>;
-        interface ClientAction<T> {
-            /**
-             * @deprecated use request() mehods instead
-             */
-            readonly received?: Rest.PromiseObservableMix<Rest.HttpResponse<T>>;
-            request?(axiosConfig?: ModelsNg2Rest.Ng2RestAxiosRequestConfig): Rest.PromiseObservableMix<Rest.HttpResponse<T>>;
-        }
-        interface AsyncResponse<T> {
-            (req?: ExpressRequest<any>, res?: ExpressResponse<any>): Promise<SyncResponse<T> | SyncResponseFunc<T>>;
-        }
-        type Response<T = string> = AsyncResponse<T> & ClientAction<T>;
-        interface AuthCallBack {
-            (methodReference: Function): RequestHandler;
-        }
-    }
-    interface StartParams {
-        port: number;
-        args: string[];
-        onlyMigrationRun?: boolean;
-        onlyMigrationRevertToTimestamp?: number;
-    }
-    interface TaonInitializeParams {
-        onlyMigrationRun?: boolean;
-        onlyMigrationRevertToTimestamp?: number;
-    }
-    interface TaonCtxCloneParams {
-        useAsRemoteContext?: boolean;
-        overrideRemoteHost?: string;
-        overrideHost?: string;
-        sourceContext?: EndpointContext;
-    }
+    /**
+     * TODO - will be removed soon
+     * @deprecated
+     */
+    publicAssets?: {
+        serverPath: string;
+        locationOnDisk: string;
+    }[];
+    /**
+     * by default cwd === process.cwd()
+     */
+    cwd?: string;
+}
+export type Models_Http_ContextENDPOINT = {
+    target: Function;
+    initFN: Function;
+};
+export type Models_Http_FormlyFromType = 'material' | 'bootstrap';
+export type Models_Http_ExpressContext<T> = (req: ExpressRequest<any>, res: ExpressResponse<any>) => T;
+export type Models_Http_SyncResponse<T> = string | T;
+export type Models_Http_ResponseFuncOpt<T> = {
+    limitSize?: (enties: Function | Function[], include: string[], exclude: string[]) => void;
+};
+export type Models_Http_SyncResponseFunc<T> = (options?: Models_Http_ResponseFuncOpt<T>) => Models_Http_SyncResponse<T>;
+export type Models_Http_MixResponse<T> = Models_Http_SyncResponse<T> | Models_Http_ExpressContext<T>;
+export interface Models_Http_ClientAction<T> {
+    /**
+     * @deprecated use request() mehods instead
+     */
+    readonly received?: ModelsNg2Rest_PromiseObservableMix<ModelsNg2Rest_HttpResponse<T>>;
+    request?(axiosConfig?: ModelsNg2Rest_Ng2RestAxiosRequestConfig): ModelsNg2Rest_PromiseObservableMix<ModelsNg2Rest_HttpResponse<T>>;
+}
+export interface Models_Http_AsyncResponse<T> {
+    (req?: ExpressRequest<any>, res?: ExpressResponse<any>): Promise<Models_Http_SyncResponse<T> | Models_Http_SyncResponseFunc<T>>;
+}
+export type Models_Http_Response<T = string> = Models_Http_AsyncResponse<T> & Models_Http_ClientAction<T>;
+export interface Models_Http_AuthCallBack {
+    (methodReference: Function): RequestHandler;
+}
+export interface Models_StartParams {
+    port: number;
+    args: string[];
+    onlyMigrationRun?: boolean;
+    onlyMigrationRevertToTimestamp?: number;
+}
+export interface Models_TaonInitializeParams {
+    onlyMigrationRun?: boolean;
+    onlyMigrationRevertToTimestamp?: number;
+}
+export interface Models_TaonCtxCloneParams {
+    useAsRemoteContext?: boolean;
+    overrideRemoteHost?: string;
+    overrideHost?: string;
+    sourceContext?: EndpointContext;
 }