@ruiapp/rapid-core 0.1.19 → 0.1.21

package/dist/core/actionHandler.d.ts

@@ -1,7 +1,9 @@
 import { RpdApplicationConfig } from "../types";
 import { IRpdServer, RapidPlugin } from "./server";
 import { Next, RouteContext } from "./routeContext";
+import { Logger } from "../facilities/log/LogFacility";
 export interface ActionHandlerContext {
+    logger: Logger;
     routerContext: RouteContext;
     next: Next;
     server: IRpdServer;

package/dist/core/pluginManager.d.ts

@@ -1,6 +1,7 @@
 import { RpdApplicationConfig } from "../types";
 import { IRpdServer, RapidPlugin } from "./server";
 import { RouteContext } from "./routeContext";
+import { ActionHandlerContext } from "./actionHandler";
 declare class PluginManager {
     #private;
     constructor(server: IRpdServer);
@@ -31,5 +32,7 @@ declare class PluginManager {
     onApplicationReady(applicationConfig: RpdApplicationConfig): Promise<void>;
     /** 在接收到HTTP请求，准备路由上下文时调用。 */
     onPrepareRouteContext(routeContext: RouteContext): Promise<void>;
+    /** 在接收到HTTP请求，执行 actions 前调用。 */
+    beforeRunRouteActions(handlerContext: ActionHandlerContext): Promise<void>;
 }
 export default PluginManager;

package/dist/core/request.d.ts

@@ -1,3 +1,4 @@
+import { IRpdServer } from "./server";
 export declare const GlobalRequest: {
     new (input: URL | RequestInfo, init?: RequestInit): Request;
     prototype: Request;
@@ -10,7 +11,7 @@ export declare class RapidRequest {
     #private;
     method: string;
     url: URL;
-    constructor(req: Request);
+    constructor(server: IRpdServer, req: Request);
     parseBody(): Promise<void>;
     get rawRequest(): Request;
     get headers(): Headers;

package/dist/core/routeContext.d.ts

@@ -1,15 +1,18 @@
 import { RapidRequest } from "./request";
 import { RapidResponse } from "./response";
 import { HttpStatus } from "./http-types";
+import { IRpdServer } from "./server";
 export type Next = () => Promise<void>;
 export declare class RouteContext {
+    #private;
     readonly request: RapidRequest;
     readonly response: RapidResponse;
     readonly state: Record<string, any>;
     method: string;
     path: string;
     params: Record<string, string>;
-    constructor(request: RapidRequest);
+    routeConfig: any;
+    constructor(server: IRpdServer, request: RapidRequest);
     set(headerName: string, headerValue: string): void;
     json(obj: any, status?: HttpStatus, headers?: HeadersInit): void;
     redirect(url: string, status?: HttpStatus): void;

package/dist/core/server.d.ts

@@ -1,11 +1,13 @@
-import { GetDataAccessorOptions, GetModelOptions, IDatabaseConfig, IQueryBuilder, IRpdDataAccessor, RapidServerConfig, RpdApplicationConfig, RpdDataModel, RpdServerEventTypes } from "../types";
-import { IPluginActionHandler, ActionHandler } from "./actionHandler";
+import { GetDataAccessorOptions, GetModelOptions, IDatabaseConfig, IQueryBuilder, IRpdDataAccessor, RapidServerConfig, RpdApplicationConfig, RpdDataModel, RpdDataModelProperty, RpdServerEventTypes } from "../types";
+import { IPluginActionHandler, ActionHandler, ActionHandlerContext } from "./actionHandler";
 import { Next, RouteContext } from "./routeContext";
 import EntityManager from "../dataAccess/entityManager";
+import { Logger } from "../facilities/log/LogFacility";
 export interface IRpdServer {
     config: RapidServerConfig;
     databaseConfig: IDatabaseConfig;
     queryBuilder: IQueryBuilder;
+    getLogger(): Logger;
     queryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>) => Promise<any[]>;
     tryQueryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>) => Promise<any[]>;
     registerMiddleware(middleware: any): void;
@@ -15,10 +17,12 @@ export interface IRpdServer {
     getEntityManager<TEntity = any>(singularCode: string): EntityManager<TEntity>;
     getApplicationConfig(): RpdApplicationConfig;
     appendApplicationConfig(config: Partial<RpdApplicationConfig>): any;
+    appendModelProperties(modelSingularCode: string, properties: RpdDataModelProperty[]): any;
     getModel(options: GetModelOptions): RpdDataModel | undefined;
     registerEventHandler<K extends keyof RpdServerEventTypes>(eventName: K, listener: (...args: RpdServerEventTypes[K]) => void): this;
     emitEvent<K extends keyof RpdServerEventTypes>(eventName: K, sender: RapidPlugin, payload: RpdServerEventTypes[K][1]): void;
     handleRequest(request: Request, next: Next): Promise<Response>;
+    beforeRunRouteActions(handlerContext: ActionHandlerContext): Promise<void>;
 }
 export type RpdConfigurationItemTypes = "integer" | "text" | "boolean" | "date" | "datetime" | "json";
 export interface RpdConfigurationItemOptions {
@@ -85,4 +89,6 @@ export interface RapidPlugin {
     onApplicationReady?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
     /** 在接收到HTTP请求，准备路由上下文时调用。 */
     onPrepareRouteContext?: (server: IRpdServer, routeContext: RouteContext) => Promise<any>;
+    /** 在接收到HTTP请求，执行 actions 前调用。 */
+    beforeRunRouteActions?: (server: IRpdServer, handlerContext: ActionHandlerContext) => Promise<any>;
 }

package/dist/dataAccess/dataAccessor.d.ts

@@ -1,12 +1,13 @@
 import { CountEntityOptions, FindEntityOptions, IRpdDataAccessor, RpdDataModel, IDatabaseAccessor } from "../types";
 import QueryBuilder from "../queryBuilder/queryBuilder";
+import { IRpdServer } from "../core/server";
 export interface IDataAccessorOptions {
     model: RpdDataModel;
     queryBuilder: QueryBuilder;
 }
 export default class DataAccessor<T = any> implements IRpdDataAccessor<T> {
     #private;
-    constructor(databaseAccessor: IDatabaseAccessor, options: IDataAccessorOptions);
+    constructor(server: IRpdServer, databaseAccessor: IDatabaseAccessor, options: IDataAccessorOptions);
     getModel(): RpdDataModel;
     create(entity: Partial<T>): Promise<T>;
     updateById(id: any, entity: Partial<T>): Promise<{

package/dist/facilities/log/LogFacility.d.ts

@@ -0,0 +1,33 @@
+import winston from "winston";
+export interface Logger {
+    log: winston.LogMethod;
+    /**
+     * The service/app is going to stop or become unusable now. An operator should definitely look into this immediately.
+     */
+    emerg: winston.LeveledLogMethod;
+    /**
+     * Fatal for a particular service, but the app continues servicing other requests. An operator should look at this immediately.
+     */
+    crit: winston.LeveledLogMethod;
+    /**
+     * Fatal for a particular request, but the service/app continues servicing other requests. An operator should look at this soon(ish).
+     */
+    error: winston.LeveledLogMethod;
+    /**
+     * A note on something that should probably be looked at by an operator eventually.
+     */
+    warn: winston.LeveledLogMethod;
+    /**
+     * Detail on regular operation.
+     */
+    info: winston.LeveledLogMethod;
+    /**
+     * Anything else, i.e. too verbose to be included in "info" level.
+     */
+    debug: winston.LeveledLogMethod;
+    /**
+     * Logging from external libraries used by your app or very detailed application logging.
+     */
+    verbose: winston.LeveledLogMethod;
+    child(options: Object): Logger;
+}

package/dist/index.d.ts

@@ -17,3 +17,4 @@ export { default as ServerOperationPlugin } from "./plugins/serverOperation/Serv
 export * from "./plugins/serverOperation/ServerOperationPluginTypes";
 export { default as EntityWatchPlugin } from "./plugins/entityWatch/EntityWatchPlugin";
 export * from "./plugins/entityWatch/EntityWatchPluginTypes";
+export { default as EntityAccessControlPlugin } from "./plugins/entityAccessControl/EntityAccessControlPlugin";