@clairejs/server 3.6.22 → 3.7.1

package/dist/socket/AwsSocketManager.d.ts

@@ -1,30 +1,30 @@
-import { AbstractLogger, IInit } from "@clairejs/core";
-import { AbstractHttpRequestHandler } from "../http/controller/AbstractHttpRequestHandler";
-import { AbstractServerSocketManager, ServerSocketInfo } from "./AbstractServerSocketManager";
-import { AbstractServerSocket } from "./AbstractServerSocket";
-import { AbstractHttpAuthorizationProvider } from "../http/auth/AbstractHttpAuthorizationProvider";
-import { IPrincipal } from "../common/auth/IPrincipal";
-import { IServerSocket } from "./IServerSocket";
-export declare class AwsSocketManager extends AbstractServerSocketManager implements IInit {
-    protected readonly authenticationRequired: boolean;
-    protected readonly region: string;
-    protected readonly socketDomainUrl: string;
-    protected readonly redisServerUrl: string;
-    protected readonly httpRequestHandler: AbstractHttpRequestHandler;
-    protected readonly authorizationProvider: AbstractHttpAuthorizationProvider<IPrincipal>;
-    protected readonly authResolver: (queries?: any) => any;
-    protected readonly logger: AbstractLogger;
-    private readonly apiGatewayManagement;
-    constructor(authenticationRequired: boolean, region: string, socketDomainUrl: string, redisServerUrl: string, httpRequestHandler: AbstractHttpRequestHandler, authorizationProvider: AbstractHttpAuthorizationProvider<IPrincipal>, authResolver: (queries?: any) => any, logger: AbstractLogger);
-    init(): Promise<void>;
-    exit(): void;
-    removeSocketFromRedis(socketId: string): Promise<void>;
-    physicSend(socketId: string, data: any): Promise<void>;
-    configure(data?: any): void;
-    getSocketsByChannel(channel: string): Promise<IServerSocket[]>;
-    broadcastToChannel(channel: string, data: any): Promise<void>;
-    addSocket(socketInfo: ServerSocketInfo, data: any): Promise<AbstractServerSocket>;
-    removeSocket(socketId: string, physicRemove?: boolean): Promise<void>;
-    private getSocketBySerialized;
-    getById(socketId: string): Promise<AbstractServerSocket | undefined>;
-}
+import { AbstractLogger, IInit } from "@clairejs/core";
+import { AbstractHttpRequestHandler } from "../http/controller/AbstractHttpRequestHandler";
+import { AbstractServerSocketManager, ServerSocketInfo } from "./AbstractServerSocketManager";
+import { AbstractServerSocket } from "./AbstractServerSocket";
+import { AbstractHttpAuthorizationProvider } from "../http/auth/AbstractHttpAuthorizationProvider";
+import { IPrincipal } from "../common/auth/IPrincipal";
+import { IServerSocket } from "./IServerSocket";
+export declare class AwsSocketManager extends AbstractServerSocketManager implements IInit {
+    protected readonly authenticationRequired: boolean;
+    protected readonly region: string;
+    protected readonly socketDomainUrl: string;
+    protected readonly redisServerUrl: string;
+    protected readonly httpRequestHandler: AbstractHttpRequestHandler;
+    protected readonly authorizationProvider: AbstractHttpAuthorizationProvider<IPrincipal>;
+    protected readonly authResolver: (queries?: any) => any;
+    protected readonly logger: AbstractLogger;
+    private readonly apiGatewayManagement;
+    constructor(authenticationRequired: boolean, region: string, socketDomainUrl: string, redisServerUrl: string, httpRequestHandler: AbstractHttpRequestHandler, authorizationProvider: AbstractHttpAuthorizationProvider<IPrincipal>, authResolver: (queries?: any) => any, logger: AbstractLogger);
+    init(): Promise<void>;
+    exit(): void;
+    removeSocketFromRedis(socketId: string): Promise<void>;
+    physicSend(socketId: string, data: any): Promise<void>;
+    configure(data?: any): void;
+    getSocketsByChannel(channel: string): Promise<IServerSocket[]>;
+    broadcastToChannel(channel: string, data: any): Promise<void>;
+    addSocket(socketInfo: ServerSocketInfo, data: any): Promise<AbstractServerSocket>;
+    removeSocket(socketId: string, physicRemove?: boolean): Promise<void>;
+    private getSocketBySerialized;
+    getById(socketId: string): Promise<AbstractServerSocket | undefined>;
+}

package/dist/socket/IServerSocket.d.ts

@@ -1,16 +1,16 @@
-import { IPrincipal } from "../common/auth/IPrincipal";
-export interface IServerSocket {
-    getId(): string;
-    getAuthInfo(): IPrincipal | undefined;
-    /**
-     * Send back data to client
-     * @param data The data to send, will be serialized using JSON.stringify
-     */
-    send(data: any, channel?: string): Promise<void>;
-    /**
-     * Disconnect the socket and optionally provide the error which cause the disconnection.
-     * The client socket will treat this error as intended reason for socket termination.
-     * @param err The error which cause the disconnection
-     */
-    disconnect(err?: any): Promise<void>;
-}
+import { IPrincipal } from "../common/auth/IPrincipal";
+export interface IServerSocket {
+    getId(): string;
+    getAuthInfo(): IPrincipal | undefined;
+    /**
+     * Send back data to client
+     * @param data The data to send, will be serialized using JSON.stringify
+     */
+    send(data: any, channel?: string): Promise<void>;
+    /**
+     * Disconnect the socket and optionally provide the error which cause the disconnection.
+     * The client socket will treat this error as intended reason for socket termination.
+     * @param err The error which cause the disconnection
+     */
+    disconnect(err?: any): Promise<void>;
+}

package/dist/socket/LocalSocketManager.d.ts

@@ -1,47 +1,47 @@
-/// <reference types="node" />
-import { AbstractLogger, IInit } from "@clairejs/core";
-import WebSocket from "ws";
-import { Server } from "http";
-import { AbstractServerSocketManager, ChannelInfo, ServerSocketInfo } from "./AbstractServerSocketManager";
-import { AbstractServerSocket } from "./AbstractServerSocket";
-import { AbstractHttpAuthorizationProvider } from "../http/auth/AbstractHttpAuthorizationProvider";
-import { IServerSocket } from "./IServerSocket";
-export declare class LocalSocketManager extends AbstractServerSocketManager implements IInit {
-    protected readonly authenticationRequired: boolean;
-    protected readonly redisServerUrl: string;
-    protected readonly logger: AbstractLogger;
-    protected readonly authProvider: AbstractHttpAuthorizationProvider;
-    protected readonly authResolver: (queries?: any) => any;
-    /**
-     * Use to subscribe to the socket-self channels
-     */
-    private readonly subClient;
-    /**
-     * Use to subscribe to channels
-     */
-    private readonly channelSubClient;
-    /**
-     * Use to publish data
-     */
-    private readonly sendClient;
-    private allSockets;
-    private subscribedChannels;
-    constructor(authenticationRequired: boolean, redisServerUrl: string, logger: AbstractLogger, authProvider: AbstractHttpAuthorizationProvider, authResolver: (queries?: any) => any);
-    init(): Promise<void>;
-    exit(): void;
-    private channelMessageListenner;
-    private socketMessageListener;
-    protected getUniqueDataChannelName(channel: string): string;
-    protected getSocketChannelKeyPrefix(): string;
-    protected getSocketChannelKey(socketId: string): string;
-    broadcastToChannel(channel: string, data: any): Promise<void>;
-    addSocketToChannel(socketId: string, channelInfos: ChannelInfo[]): Promise<AbstractServerSocket | undefined>;
-    removeSocketFromChannel(socketId: string, channels: string[], persist?: boolean): Promise<void>;
-    addSocket(socketInfo: ServerSocketInfo, { socket }: {
-        socket: WebSocket;
-    }): Promise<AbstractServerSocket>;
-    removeSocket(socketId: string, physicRemove?: boolean): Promise<void>;
-    getById(socketId: string): Promise<AbstractServerSocket | undefined>;
-    getSocketsByChannel(channel: string): Promise<IServerSocket[]>;
-    configure(httpServer?: Server): void;
-}
+/// <reference types="node" />
+import { AbstractLogger, IInit } from "@clairejs/core";
+import WebSocket from "ws";
+import { Server } from "http";
+import { AbstractServerSocketManager, ChannelInfo, ServerSocketInfo } from "./AbstractServerSocketManager";
+import { AbstractServerSocket } from "./AbstractServerSocket";
+import { AbstractHttpAuthorizationProvider } from "../http/auth/AbstractHttpAuthorizationProvider";
+import { IServerSocket } from "./IServerSocket";
+export declare class LocalSocketManager extends AbstractServerSocketManager implements IInit {
+    protected readonly authenticationRequired: boolean;
+    protected readonly redisServerUrl: string;
+    protected readonly logger: AbstractLogger;
+    protected readonly authProvider: AbstractHttpAuthorizationProvider;
+    protected readonly authResolver: (queries?: any) => any;
+    /**
+     * Use to subscribe to the socket-self channels
+     */
+    private readonly subClient;
+    /**
+     * Use to subscribe to channels
+     */
+    private readonly channelSubClient;
+    /**
+     * Use to publish data
+     */
+    private readonly sendClient;
+    private allSockets;
+    private subscribedChannels;
+    constructor(authenticationRequired: boolean, redisServerUrl: string, logger: AbstractLogger, authProvider: AbstractHttpAuthorizationProvider, authResolver: (queries?: any) => any);
+    init(): Promise<void>;
+    exit(): void;
+    private channelMessageListenner;
+    private socketMessageListener;
+    protected getUniqueDataChannelName(channel: string): string;
+    protected getSocketChannelKeyPrefix(): string;
+    protected getSocketChannelKey(socketId: string): string;
+    broadcastToChannel(channel: string, data: any): Promise<void>;
+    addSocketToChannel(socketId: string, channelInfos: ChannelInfo[]): Promise<AbstractServerSocket | undefined>;
+    removeSocketFromChannel(socketId: string, channels: string[], persist?: boolean): Promise<void>;
+    addSocket(socketInfo: ServerSocketInfo, { socket }: {
+        socket: WebSocket;
+    }): Promise<AbstractServerSocket>;
+    removeSocket(socketId: string, physicRemove?: boolean): Promise<void>;
+    getById(socketId: string): Promise<AbstractServerSocket | undefined>;
+    getSocketsByChannel(channel: string): Promise<IServerSocket[]>;
+    configure(httpServer?: Server): void;
+}

package/dist/system/ClaireServer.d.ts

@@ -1,13 +1,13 @@
-import { AbstractLogger, ClaireApp } from "@clairejs/core";
-import { AbstractHttpRequestHandler } from "../http/controller/AbstractHttpRequestHandler";
-import { AbstractServerSocketManager } from "../socket/AbstractServerSocketManager";
-export declare class ClaireServer extends ClaireApp {
-    readonly logger: AbstractLogger;
-    readonly httpRequestHandler: AbstractHttpRequestHandler | undefined;
-    readonly socketManager: AbstractServerSocketManager | undefined;
-    private booted;
-    constructor(logger: AbstractLogger, httpRequestHandler: AbstractHttpRequestHandler | undefined, socketManager: AbstractServerSocketManager | undefined);
-    init(): Promise<void>;
-    exit(): void;
-    private stop;
-}
+import { AbstractLogger, ClaireApp } from "@clairejs/core";
+import { AbstractHttpRequestHandler } from "../http/controller/AbstractHttpRequestHandler";
+import { AbstractServerSocketManager } from "../socket/AbstractServerSocketManager";
+export declare class ClaireServer extends ClaireApp {
+    readonly logger: AbstractLogger;
+    readonly httpRequestHandler: AbstractHttpRequestHandler | undefined;
+    readonly socketManager: AbstractServerSocketManager | undefined;
+    private booted;
+    constructor(logger: AbstractLogger, httpRequestHandler: AbstractHttpRequestHandler | undefined, socketManager: AbstractServerSocketManager | undefined);
+    init(): Promise<void>;
+    exit(): void;
+    private stop;
+}

package/dist/system/ExpressWrapper.d.ts

@@ -1,17 +1,17 @@
-import { ClaireServer } from "./ClaireServer";
-interface ExpressWrapperConfig {
-    maxBodySizeKB?: number;
-}
-export declare class ExpressWrapper {
-    private readonly injector;
-    private readonly socketManager?;
-    private readonly logger;
-    private readonly server;
-    private readonly config?;
-    private readonly httpRequestHandler?;
-    private httpServer?;
-    constructor(server: ClaireServer, config?: ExpressWrapperConfig);
-    close(): void;
-    listen(listenPort: number): Promise<void>;
-}
-export {};
+import { ClaireServer } from "./ClaireServer";
+interface ExpressWrapperConfig {
+    maxBodySizeKB?: number;
+}
+export declare class ExpressWrapper {
+    private readonly injector;
+    private readonly socketManager?;
+    private readonly logger;
+    private readonly server;
+    private readonly config?;
+    private readonly httpRequestHandler?;
+    private httpServer?;
+    constructor(server: ClaireServer, config?: ExpressWrapperConfig);
+    close(): void;
+    listen(listenPort: number): Promise<void>;
+}
+export {};

package/dist/system/LambdaWrapper.d.ts

@@ -1,19 +1,20 @@
-import { RequestOptions } from "../common/request/RequestOptions";
-import { ClaireServer } from "./ClaireServer";
-interface LambdaResponse {
-    statusCode: number;
-    body: string;
-    headers: any;
-}
-export declare class LambdaWrapper {
-    readonly serverFactory: () => Promise<ClaireServer>;
-    readonly requestMapper: (event: any) => RequestOptions | undefined;
-    private readonly injector;
-    private readonly httpRequestHandler?;
-    private readonly socketManager?;
-    private _server?;
-    constructor(serverFactory: () => Promise<ClaireServer>, requestMapper: (event: any) => RequestOptions | undefined);
-    private bootServer;
-    handler(event: any): Promise<LambdaResponse>;
-}
-export {};
+import { RequestOptions } from "../common/request/RequestOptions";
+import { ClaireServer } from "./ClaireServer";
+interface LambdaResponse {
+    statusCode: number;
+    body: string;
+    headers: any;
+}
+export declare class LambdaWrapper {
+    readonly serverFactory: () => Promise<ClaireServer>;
+    readonly requestMapper: (event: any) => RequestOptions | undefined;
+    private readonly injector;
+    private readonly httpRequestHandler?;
+    private readonly socketManager?;
+    private readonly jobScheduler?;
+    private _server?;
+    constructor(serverFactory: () => Promise<ClaireServer>, requestMapper: (event: any) => RequestOptions | undefined);
+    private bootServer;
+    handler(event: any): Promise<LambdaResponse>;
+}
+export {};

package/dist/system/ServerGlobalStore.d.ts

@@ -1,5 +1,5 @@
-import { CoreGlobalStore } from "@clairejs/core";
-import { MountedEndpointInfo } from "../common/request/MountedEndpointInfo";
-export interface ServerGlobalStore extends CoreGlobalStore {
-    mountedEndpointInfo?: MountedEndpointInfo[];
-}
+import { CoreGlobalStore } from "@clairejs/core";
+import { MountedEndpointInfo } from "../common/request/MountedEndpointInfo";
+export interface ServerGlobalStore extends CoreGlobalStore {
+    mountedEndpointInfo?: MountedEndpointInfo[];
+}

package/dist/system/errors.d.ts

@@ -1,14 +1,14 @@
-export declare const Errors: {
-    TFA_REQUIRED: string;
-    SYSTEM_ERROR: string;
-    HTTP_REQUEST_ERROR: string;
-    SESSION_EXPIRED: string;
-    ACCESS_DENIED: string;
-    AUTHENTICATION_ERROR: string;
-    NOT_FOUND: string;
-    VALIDATION_ERROR: string;
-    BAD_STATE: string;
-    QUERY_ERROR: string;
-    REQUEST_RATE_LIMIT: string;
-    CANNOT_LOCK: string;
-};
+export declare const Errors: {
+    TFA_REQUIRED: string;
+    SYSTEM_ERROR: string;
+    HTTP_REQUEST_ERROR: string;
+    SESSION_EXPIRED: string;
+    ACCESS_DENIED: string;
+    AUTHENTICATION_ERROR: string;
+    NOT_FOUND: string;
+    VALIDATION_ERROR: string;
+    BAD_STATE: string;
+    QUERY_ERROR: string;
+    REQUEST_RATE_LIMIT: string;
+    CANNOT_LOCK: string;
+};

package/dist/system/lamba-request-mapper.d.ts

@@ -1,12 +1,17 @@
-import { HttpMethod, SocketMethod } from "@clairejs/core";
-export declare const lambdaRequestMapper: (event: any) => {
-    method: SocketMethod;
-    rawPath: any;
-    body: any;
-    headers?: undefined;
-} | {
-    method: HttpMethod;
-    rawPath: string;
-    body: any;
-    headers: any;
-};
+import { HttpMethod, SocketMethod } from "@clairejs/core";
+export declare const lambdaRequestMapper: (event: any) => {
+    method: SocketMethod;
+    rawPath: any;
+    body: any;
+    headers?: undefined;
+} | {
+    method: string;
+    body: any;
+    rawPath?: undefined;
+    headers?: undefined;
+} | {
+    method: HttpMethod;
+    rawPath: string;
+    body: any;
+    headers: any;
+};

package/package.json

@@ -1,59 +1,61 @@
-{
-    "name": "@clairejs/server",
-    "version": "3.6.22",
-    "description": "Claire server NodeJs framework written in Typescript.",
-    "types": "dist/index.d.ts",
-    "main": "dist/index.js",
-    "scripts": {
-        "test-http": "mocha -r ts-node/register ./test/e2e/e2e.test.ts",
-        "test-socket": "mocha -r ts-node/register ./test/socket/socket.test.ts",
-        "test": "npm run test-http && npm run test-socket",
-        "build": "rm -rf ./dist && webpack --mode production",
-        "push": "npm run build && npm publish && git push"
-    },
-    "author": "immort",
-    "license": "ISC",
-    "dependencies": {
-        "aws-sdk": "^2.841.0",
-        "cors": "^2.8.5",
-        "express": "^4.17.1",
-        "express-fileupload": "^1.2.1",
-        "ioredis": "^5.2.0",
-        "mysql2": "^2.2.5",
-        "node-cron": "^3.0.1",
-        "parseurl": "^1.3.3",
-        "path-to-regexp": "^6.2.0",
-        "pg": "^8.5.1",
-        "pg-hstore": "^2.3.4",
-        "query-string": "^6.14.0",
-        "redlock": "^5.0.0-beta.2",
-        "reflect-metadata": "^0.1.13",
-        "ws": "^7.5.5"
-    },
-    "peerDependencies": {
-        "@clairejs/core": "^3.1.15",
-        "@clairejs/orm": "^3.0.11"
-    },
-    "devDependencies": {
-        "@types/body-parser": "^1.19.0",
-        "@types/cors": "^2.8.9",
-        "@types/express": "^4.17.11",
-        "@types/express-fileupload": "^1.1.6",
-        "@types/mocha": "^8.2.2",
-        "@types/node": "^14.14.25",
-        "@types/parseurl": "^1.3.1",
-        "@types/validator": "^13.1.3",
-        "@types/webpack-env": "^1.16.0",
-        "@types/ws": "^7.4.0",
-        "axios": "^0.21.1",
-        "mocha": "^10.0.0",
-        "terser-webpack-plugin": "^4.2.3",
-        "ts-loader": "^8.4.0",
-        "ts-node": "^10.8.1",
-        "tslib": "^2.1.0",
-        "typescript": "^4.4.4",
-        "webpack": "^5.73.0",
-        "webpack-cli": "^4.10.0",
-        "webpack-node-externals": "^2.5.1"
-    }
-}
+{
+    "name": "@clairejs/server",
+    "version": "3.7.1",
+    "description": "Claire server NodeJs framework written in Typescript.",
+    "types": "dist/index.d.ts",
+    "main": "dist/index.js",
+    "scripts": {
+        "test-http": "mocha -r ts-node/register ./test/e2e/e2e.test.ts",
+        "test-socket": "mocha -r ts-node/register ./test/socket/socket.test.ts",
+        "test": "npm run test-http && npm run test-socket",
+        "build": "rm -rf ./dist && webpack --mode production",
+        "push": "npm run build && npm publish && git push"
+    },
+    "author": "immort",
+    "license": "ISC",
+    "dependencies": {
+        "aws-sdk": "^2.841.0",
+        "cors": "^2.8.5",
+        "express": "^4.17.1",
+        "express-fileupload": "^1.2.1",
+        "ioredis": "^5.2.0",
+        "mysql2": "^2.2.5",
+        "node-cron": "^3.0.1",
+        "node-schedule": "^2.1.0",
+        "parseurl": "^1.3.3",
+        "path-to-regexp": "^6.2.0",
+        "pg": "^8.5.1",
+        "pg-hstore": "^2.3.4",
+        "query-string": "^6.14.0",
+        "redlock": "^5.0.0-beta.2",
+        "reflect-metadata": "^0.1.13",
+        "ws": "^7.5.5"
+    },
+    "peerDependencies": {
+        "@clairejs/core": "^3.1.15",
+        "@clairejs/orm": "^3.0.11"
+    },
+    "devDependencies": {
+        "@types/body-parser": "^1.19.0",
+        "@types/cors": "^2.8.9",
+        "@types/express": "^4.17.11",
+        "@types/express-fileupload": "^1.1.6",
+        "@types/mocha": "^8.2.2",
+        "@types/node": "^14.14.25",
+        "@types/node-schedule": "^2.1.0",
+        "@types/parseurl": "^1.3.1",
+        "@types/validator": "^13.1.3",
+        "@types/webpack-env": "^1.16.0",
+        "@types/ws": "^7.4.0",
+        "axios": "^0.21.1",
+        "mocha": "^10.0.0",
+        "terser-webpack-plugin": "^4.2.3",
+        "ts-loader": "^8.4.0",
+        "ts-node": "^10.8.1",
+        "tslib": "^2.1.0",
+        "typescript": "^4.4.4",
+        "webpack": "^5.73.0",
+        "webpack-cli": "^4.10.0",
+        "webpack-node-externals": "^2.5.1"
+    }
+}

package/dist/job/AbstractJobExecutor.d.ts

@@ -1,10 +0,0 @@
-import { JobInfo } from "./interfaces";
-export declare abstract class AbstractJobExecutor {
-    private _allJobs;
-    init(): Promise<void>;
-    protected getAllJobs(): Promise<{
-        jobName: string;
-        handlerFn: (jobInfo?: JobInfo | undefined) => Promise<void>;
-    }[]>;
-    abstract executeJob(jobInfo: JobInfo, schedulerInterval: number): Promise<void>;
-}

package/dist/job/AwsJobExecutor.d.ts

@@ -1,8 +0,0 @@
-import { AbstractLogger } from "@clairejs/core";
-import { AbstractJobExecutor } from "./AbstractJobExecutor";
-import { JobInfo } from "./interfaces";
-export declare class AwsJobExecutor extends AbstractJobExecutor {
-    readonly logger: AbstractLogger;
-    constructor(logger: AbstractLogger);
-    executeJob(jobInfo: JobInfo, schedulerInterval: number): Promise<void>;
-}

package/dist/job/LocalJobExecutor.d.ts

@@ -1,8 +0,0 @@
-import { AbstractLogger } from "@clairejs/core";
-import { AbstractJobExecutor } from "./AbstractJobExecutor";
-import { JobInfo } from "./interfaces";
-export declare class LocalJobExecutor extends AbstractJobExecutor {
-    readonly logger: AbstractLogger;
-    constructor(logger: AbstractLogger);
-    executeJob(jobInfo: JobInfo, schedulerInterval: number): Promise<void>;
-}