@ruiapp/rapid-core 0.1.20 → 0.1.22

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/facility.d.ts

@@ -0,0 +1,5 @@
+import { IRpdServer } from "./server";
+export interface FacilityFactory {
+    name: string;
+    createFacility: (server: IRpdServer, options?: any) => Promise<any>;
+}

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,8 +1,10 @@
 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>;
@@ -10,7 +12,7 @@ export declare class RouteContext {
     path: string;
     params: Record<string, string>;
     routeConfig: any;
-    constructor(request: RapidRequest);
+    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

@@ -2,10 +2,15 @@ import { GetDataAccessorOptions, GetModelOptions, IDatabaseConfig, IQueryBuilder
 import { IPluginActionHandler, ActionHandler, ActionHandlerContext } from "./actionHandler";
 import { Next, RouteContext } from "./routeContext";
 import EntityManager from "../dataAccess/entityManager";
+import { Logger } from "../facilities/log/LogFacility";
+import { FacilityFactory } from "./facility";
 export interface IRpdServer {
     config: RapidServerConfig;
     databaseConfig: IDatabaseConfig;
     queryBuilder: IQueryBuilder;
+    getLogger(): Logger;
+    registerFacilityFactory(factory: FacilityFactory): any;
+    getFacility<TFacility = any>(name: string, options?: any): Promise<TFacility>;
     queryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>) => Promise<any[]>;
     tryQueryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>) => Promise<any[]>;
     registerMiddleware(middleware: any): void;

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;
+}