@clairejs/server 3.12.13 → 3.13.0

package/dist/socket/LocalSocketManager.d.ts

@@ -1,47 +1,48 @@
-/// <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 { AbstractHttpAuthorizer } from "../http/auth/AbstractHttpAuthorizer";
-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: AbstractHttpAuthorizer;
-    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: AbstractHttpAuthorizer, 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 { AbstractHttpAuthorizer } from "../http/auth/AbstractHttpAuthorizer";
+import { IServerSocket } from "./IServerSocket";
+import { AbstractPrincipalResolver } from "../common/auth/AbstractPrincipalResolver";
+export declare class LocalSocketManager extends AbstractServerSocketManager implements IInit {
+    protected readonly authenticationRequired: boolean;
+    protected readonly redisServerUrl: string;
+    protected readonly logger: AbstractLogger;
+    protected readonly principalResolver: AbstractPrincipalResolver;
+    protected readonly httpAuthorizer: AbstractHttpAuthorizer;
+    /**
+     * 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, principalResolver: AbstractPrincipalResolver, httpAuthorizer: AbstractHttpAuthorizer);
+    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,19 +1,19 @@
-import { ClaireServer } from "./ClaireServer";
-interface ExpressWrapperConfig {
-    requestSetting?: {
-        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 {
+    requestSetting?: {
+        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,25 +1,25 @@
-import { RequestOptions } from "../common/request/RequestOptions";
-import { ClaireServer } from "./ClaireServer";
-interface LambdaResponse {
-    statusCode: number;
-    body: string;
-    headers: object;
-    cookies: string[];
-}
-export interface LambdaWrapperConfig {
-}
-export declare class LambdaWrapper {
-    readonly serverFactory: () => Promise<ClaireServer>;
-    readonly requestMapper: (event: any) => RequestOptions | undefined;
-    readonly config?: LambdaWrapperConfig | undefined;
-    private readonly injector;
-    private readonly logger;
-    private readonly httpRequestHandler?;
-    private readonly socketManager?;
-    private readonly jobScheduler?;
-    private _server?;
-    constructor(serverFactory: () => Promise<ClaireServer>, requestMapper: (event: any) => RequestOptions | undefined, config?: LambdaWrapperConfig | 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: object;
+    cookies: string[];
+}
+export interface LambdaWrapperConfig {
+}
+export declare class LambdaWrapper {
+    readonly serverFactory: () => Promise<ClaireServer>;
+    readonly requestMapper: (event: any) => RequestOptions | undefined;
+    readonly config?: LambdaWrapperConfig | undefined;
+    private readonly injector;
+    private readonly logger;
+    private readonly httpRequestHandler?;
+    private readonly socketManager?;
+    private readonly jobScheduler?;
+    private _server?;
+    constructor(serverFactory: () => Promise<ClaireServer>, requestMapper: (event: any) => RequestOptions | undefined, config?: LambdaWrapperConfig | 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,13 @@
-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: {
+    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,2 +1,2 @@
-import { RequestOptions } from "../common/request/RequestOptions";
-export declare const lambdaRequestMapper: (event: any) => RequestOptions;
+import { RequestOptions } from "../common/request/RequestOptions";
+export declare const lambdaRequestMapper: (event: any) => RequestOptions;

package/dist/system/locale/LocaleEntry.d.ts

@@ -1,3 +1,3 @@
-import { AbstractModel } from "@clairejs/core";
-export declare class LocaleEntry extends AbstractModel {
-}
+import { AbstractModel } from "@clairejs/core";
+export declare class LocaleEntry extends AbstractModel {
+}

package/dist/system/locale/LocaleTranslation.d.ts

@@ -1,6 +1,6 @@
-import { AbstractModel } from "@clairejs/core";
-export declare class LocaleTranslation extends AbstractModel {
-    entryId: number;
-    localeCode: string;
-    translation: string;
-}
+import { AbstractModel } from "@clairejs/core";
+export declare class LocaleTranslation extends AbstractModel {
+    entryId: string;
+    localeCode: string;
+    translation: string;
+}

package/dist/system/locale/decorators.d.ts

@@ -1,2 +1,2 @@
-import { AbstractModel } from "@clairejs/core";
-export declare const LocaleOf: <T>(referenceColumn: keyof T) => <K extends string>(prototype: T & AbstractModel & { [k in K]?: Record<string, string> | undefined; }, propertyKey: K) => void;
+import { AbstractModel } from "@clairejs/core";
+export declare const LocaleOf: <T>(referenceColumn: keyof T) => <K extends string>(prototype: T & AbstractModel & { [k in K]?: Record<string, string> | undefined; }, propertyKey: K) => void;

package/package.json

@@ -1,67 +1,67 @@
-{
-    "name": "@clairejs/server",
-    "version": "3.12.13",
-    "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",
-        "cookie-parser": "^1.4.6",
-        "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",
-        "randomstring": "^1.2.2",
-        "redlock": "^5.0.0-beta.2",
-        "reflect-metadata": "^0.1.13",
-        "ws": "^7.5.5"
-    },
-    "peerDependencies": {
-        "@clairejs/client": "^3.1.26",
-        "@clairejs/core": "^3.2.9",
-        "@clairejs/orm": "^3.2.5"
-    },
-    "devDependencies": {
-        "@types/cookie-parser": "^1.4.3",
-        "@types/cors": "^2.8.12",
-        "@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/randomstring": "^1.1.8",
-        "@types/uuid": "^9.0.0",
-        "@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",
-        "uuid": "^9.0.0",
-        "webpack": "^5.73.0",
-        "webpack-cli": "^4.10.0",
-        "webpack-node-externals": "^2.5.1"
-    }
-}
+{
+    "name": "@clairejs/server",
+    "version": "3.13.0",
+    "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",
+        "cookie-parser": "^1.4.6",
+        "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",
+        "randomstring": "^1.2.2",
+        "redlock": "^5.0.0-beta.2",
+        "reflect-metadata": "^0.1.13",
+        "ws": "^7.5.5"
+    },
+    "peerDependencies": {
+        "@clairejs/client": "^3.2.12",
+        "@clairejs/core": "^3.3.1",
+        "@clairejs/orm": "^3.3.4"
+    },
+    "devDependencies": {
+        "@types/cookie-parser": "^1.4.3",
+        "@types/cors": "^2.8.12",
+        "@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/randomstring": "^1.1.8",
+        "@types/uuid": "^9.0.0",
+        "@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",
+        "uuid": "^9.0.0",
+        "webpack": "^5.73.0",
+        "webpack-cli": "^4.10.0",
+        "webpack-node-externals": "^2.5.1"
+    }
+}

package/dist/http/auth/AbstractRbacHttpAuthorizer.d.ts

@@ -1,18 +0,0 @@
-import { AbstractLogger } from "@clairejs/core";
-import { HttpRequest } from "../common/HttpRequest";
-import { MountedEndpointInfo } from "../../common/request/MountedEndpointInfo";
-import { RbacCache } from "./rbac";
-import { AbstractHttpAuthorizer } from "./AbstractHttpAuthorizer";
-import { IPrincipal } from "../../common/auth/IPrincipal";
-import { AbstractPrincipalResolver } from "../../common/auth/AbstractPrincipalResolver";
-export declare abstract class AbstractRbacHttpAuthorizer<T extends IPrincipal> extends AbstractHttpAuthorizer<T> {
-    readonly authDataResolver: (req: HttpRequest) => string;
-    readonly principalResolver: AbstractPrincipalResolver<T>;
-    readonly logger: AbstractLogger;
-    constructor(authDataResolver: (req: HttpRequest) => string, principalResolver: AbstractPrincipalResolver<T>, logger: AbstractLogger);
-    getPrincipalResolver(): AbstractPrincipalResolver<T>;
-    abstract getRbacCache(): Promise<RbacCache | undefined>;
-    abstract getRolesOfPrincipal(principal: T): Promise<number[]>;
-    resolvePrincipal(req: HttpRequest): Promise<T | undefined>;
-    authorize(principal: T | undefined, request: HttpRequest, endpoint: MountedEndpointInfo): Promise<void>;
-}

package/dist/http/auth/RedisRbacHttpAuthorizer.d.ts

@@ -1,24 +0,0 @@
-import { AbstractLogger } from "@clairejs/core";
-import { AbstractPrincipalResolver } from "../../common/auth/AbstractPrincipalResolver";
-import { IPrincipal } from "../../common/auth/IPrincipal";
-import { AbstractCacheService } from "../../services/AbstractCacheService";
-import { HttpRequest } from "../common/HttpRequest";
-import { AbstractRbacHttpAuthorizer } from "./AbstractRbacHttpAuthorizer";
-import { RbacCache } from "./rbac";
-export declare class RedisRbacHttpAuthorizer<T extends IPrincipal> extends AbstractRbacHttpAuthorizer<T> {
-    readonly serviceIdResolver: () => Promise<string>;
-    readonly rbacChannel: string;
-    readonly principalChannel: string;
-    readonly authDataResolver: (req: HttpRequest) => any;
-    readonly principalResolver: AbstractPrincipalResolver<T>;
-    readonly cacheService: AbstractCacheService;
-    readonly logger: AbstractLogger;
-    readonly redisDataRetentionDurationMs: number;
-    private lastRbacFetchTimestamp;
-    private principalCache;
-    private rbacCache?;
-    private serviceId;
-    constructor(serviceIdResolver: () => Promise<string>, rbacChannel: string, principalChannel: string, authDataResolver: (req: HttpRequest) => any, principalResolver: AbstractPrincipalResolver<T>, cacheService: AbstractCacheService, logger: AbstractLogger, redisDataRetentionDurationMs?: number);
-    getRbacCache(): Promise<RbacCache | undefined>;
-    getRolesOfPrincipal(principal: T): Promise<number[]>;
-}

package/dist/http/auth/SocketRbacHttpAuthorizer.d.ts

@@ -1,25 +0,0 @@
-import { AbstractLogger, IInit, IClientSocket } from "@clairejs/core";
-import { AbstractRbacHttpAuthorizer } from "./AbstractRbacHttpAuthorizer";
-import { RbacCache } from "./rbac";
-import { HttpRequest } from "../common/HttpRequest";
-import { IPrincipal } from "../../common/auth/IPrincipal";
-import { AbstractPrincipalResolver } from "../../common/auth/AbstractPrincipalResolver";
-export declare class SocketRbacHttpAuthorizer<T extends IPrincipal> extends AbstractRbacHttpAuthorizer<T> implements IInit {
-    readonly rbacCacheChannel: string;
-    readonly principalCacheChannel: string;
-    readonly authDataResolver: (req: HttpRequest) => any;
-    readonly principalResolver: AbstractPrincipalResolver<T>;
-    readonly logger: AbstractLogger;
-    readonly socketProvider: () => Promise<IClientSocket>;
-    socket?: IClientSocket;
-    rbacCache?: RbacCache;
-    idResolvers: {
-        principalId: number;
-        resolvers: ((roleIds: number[]) => void)[];
-    }[];
-    constructor(rbacCacheChannel: string, principalCacheChannel: string, authDataResolver: (req: HttpRequest) => any, principalResolver: AbstractPrincipalResolver<T>, logger: AbstractLogger, socketProvider: () => Promise<IClientSocket>);
-    exit(): void;
-    init(): Promise<void>;
-    getRbacCache(): Promise<RbacCache | undefined>;
-    getRolesOfPrincipal(principal: T): Promise<number[]>;
-}

package/dist/http/auth/rbac.d.ts

@@ -1,34 +0,0 @@
-export interface RbacRolePolicy {
-    roleId: number;
-    policyId: number;
-}
-export interface RbacRole {
-    roleId: number;
-    isSuperRole: boolean;
-    isAnonymousRole: boolean;
-}
-export interface RbacPolicyPermissionCondition {
-    policyPermissionId: number;
-    conditionName: string;
-    conditionValue: string;
-}
-export interface RbacPolicyPermission {
-    id: number;
-    policyId: number;
-    permission: string;
-}
-export interface RbacPolicy {
-    policyId: number;
-    isUserDefined: boolean;
-}
-export interface PrincipalRole {
-    principalId: number;
-    roleIds: number[];
-}
-export interface RbacCache {
-    roles?: RbacRole[];
-    policies?: RbacPolicy[];
-    rolePolicies?: RbacRolePolicy[];
-    policyPermissions?: RbacPolicyPermission[];
-    policyPermissionConditions?: RbacPolicyPermissionCondition[];
-}