@ruiapp/rapid-core 0.0.1

package/dist/bootstrapApplicationConfig.d.ts

@@ -0,0 +1,3 @@
+import { RpdApplicationConfig } from "./types";
+declare const _default: RpdApplicationConfig;
+export default _default;

package/dist/core/eventManager.d.ts

@@ -0,0 +1,7 @@
+import { RpdServerEventTypes as EventTypes } from "~/types";
+export default class EventManager {
+    #private;
+    constructor();
+    on<K extends keyof EventTypes>(eventName: K, listener: (...args: EventTypes[K]) => void): void;
+    emit<K extends keyof EventTypes>(eventName: K, ...args: EventTypes[K]): boolean;
+}

package/dist/core/http-types.d.ts

@@ -0,0 +1,3 @@
+export type HttpStatus = number;
+export type ResponseData = string | ArrayBuffer | ReadableStream;
+export type HeadersDefinition = [string, string][] | Record<string, string>;

package/dist/core/httpHandler.d.ts

@@ -0,0 +1,18 @@
+import { IPluginInstance, RpdApplicationConfig } from "~/types";
+import { IRpdServer } from "./server";
+import { Next, RouteContext } from "./routeContext";
+export interface HttpHandlerContext {
+    routerContext: RouteContext;
+    next: Next;
+    server: IRpdServer;
+    applicationConfig: RpdApplicationConfig;
+    input?: any;
+    output?: any;
+    status?: Response["status"];
+}
+export type PluginHttpHandler = (plugin: IPluginInstance, ctx: HttpHandlerContext, options: any) => void | Promise<void>;
+export type HttpRequestHandler = (ctx: HttpHandlerContext, options: any) => void | Promise<void>;
+export interface IPluginHttpHandler {
+    code: string;
+    handler: PluginHttpHandler;
+}

package/dist/core/plugin.d.ts

@@ -0,0 +1,6 @@
+import { IPluginInstance } from "~/types";
+export default class Plugin implements IPluginInstance {
+    #private;
+    constructor(name: string);
+    getName(): string;
+}

package/dist/core/pluginManager.d.ts

@@ -0,0 +1,27 @@
+import { RpdApplicationConfig } from "~/types";
+import { IRpdServer } from "./server";
+export declare function loadPlugins(): Promise<void>;
+/** 初始化插件时调用。 */
+export declare function initPlugins(server: IRpdServer): Promise<void>;
+/** 注册中间件 */
+export declare function registerMiddlewares(server: IRpdServer): Promise<void>;
+/** 注册接口动作处理程序 */
+export declare function registerHttpHandlers(server: IRpdServer): Promise<void>;
+/** 注册事件处理程序 */
+export declare function registerEventHandlers(server: IRpdServer): Promise<void>;
+/** 注册消息处理程序 */
+export declare function registerMessageHandlers(server: IRpdServer): Promise<void>;
+/** 注册任务处理程序 */
+export declare function registerTaskProcessors(server: IRpdServer): Promise<void>;
+/** 在加载应用前调用。 */
+export declare function onLoadingApplication(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<void>;
+/** 配置数据模型 */
+export declare function configureModels(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<void>;
+/** 配置模型属性 */
+export declare function configureModelProperties(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<void>;
+/** 配置路由 */
+export declare function configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<void>;
+/** 在应用配置加载完成后调用。此时插件可以进行一些数据的初始化工作。 */
+export declare function onApplicationLoaded(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<void>;
+/** 在应用准备完成后调用。此时服务器已经可以处理网络请求。 */
+export declare function onApplicationReady(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<void>;

package/dist/core/request.d.ts

@@ -0,0 +1,15 @@
+export declare const GlobalRequest: {
+    new (input: URL | RequestInfo, init?: RequestInit): Request;
+    prototype: Request;
+};
+export interface RapidRequestBody {
+    type: string;
+    value: any;
+}
+export declare class RapidRequest {
+    method: string;
+    url: URL;
+    hasBody: boolean;
+    constructor(init: RequestInit);
+    body(): RapidRequestBody;
+}

package/dist/core/response.d.ts

@@ -0,0 +1,17 @@
+import { HttpStatus } from "./http-types";
+export declare const GlobalResponse: {
+    new (body?: BodyInit, init?: ResponseInit): Response;
+    prototype: Response;
+    error(): Response;
+    redirect(url: string | URL, status?: number): Response;
+};
+export declare class RapidResponse {
+    #private;
+    status: number;
+    body: BodyInit;
+    headers: Headers;
+    constructor(body?: BodyInit, init?: ResponseInit);
+    json(obj: any, status?: HttpStatus, headers?: HeadersInit): void;
+    redirect(location: string, status?: HttpStatus): void;
+    getResponse(): Response;
+}

package/dist/core/routeContext.d.ts

@@ -0,0 +1,17 @@
+import { RapidRequest } from "./request";
+import { RapidResponse } from "./response";
+import { HttpStatus } from "./http-types";
+export type Next = () => Promise<void>;
+export declare class RouteContext {
+    readonly request: RapidRequest;
+    readonly response: RapidResponse;
+    readonly state: Record<string, any>;
+    method: string;
+    path: string;
+    status: HttpStatus;
+    params: Record<string, string>;
+    constructor(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/routesBuilder.d.ts

@@ -0,0 +1,4 @@
+import Router from "koa-tree-router";
+import { IRpdServer } from "~/core/server";
+import { RpdApplicationConfig } from "~/types";
+export declare function buildRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<Router.Middleware<any, {}>>;

package/dist/core/server.d.ts

@@ -0,0 +1,83 @@
+import { GetDataAccessorOptions, GetModelOptions, IDatabaseConfig, IPluginInstance, IQueryBuilder, IRpdDataAccessor, RapidServerConfig, RpdApplicationConfig, RpdDataModel, RpdServerEventTypes } from "~/types";
+import { IPluginHttpHandler, HttpRequestHandler } from "./httpHandler";
+import { Next } from "./routeContext";
+export interface IRpdServer {
+    config: RapidServerConfig;
+    databaseConfig: IDatabaseConfig;
+    queryBuilder: IQueryBuilder;
+    queryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>) => Promise<any[]>;
+    tryQueryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>) => Promise<any[]>;
+    registerMiddleware(middleware: any): void;
+    registerHttpHandler(plugin: IPluginInstance, options: IPluginHttpHandler): void;
+    getHttpHandlerByCode(code: string): HttpRequestHandler | undefined;
+    getDataAccessor<T = any>(options: GetDataAccessorOptions): IRpdDataAccessor<T>;
+    getApplicationConfig(): RpdApplicationConfig;
+    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: IPluginInstance, payload: RpdServerEventTypes[K][1]): void;
+    handleRequest(request: Request, next: Next): Promise<Response>;
+}
+export type RpdConfigurationItemTypes = "integer" | "text" | "boolean" | "date" | "datetime" | "json";
+export interface RpdConfigurationItemOptions {
+    /**
+     * 配置项名称。可以包含中文。
+     */
+    name: string;
+    /**
+     * 配置项代码。
+     */
+    code: string;
+    /**
+     * 配置项类型。
+     */
+    type: RpdConfigurationItemTypes;
+    /**
+     * 是否必须有值。默认为 false。
+     */
+    required?: boolean;
+    /**
+     * 默认值。使用默认值的 JavaScript 字面量表示。
+     */
+    defaultValue?: string;
+}
+export type RpdServerPluginExtendingAbilities = /** 是指提供处理网络请求的middleware的能力。 */ "extendMiddleware" | /** 是指增加系统中的集合的能力。 */ "extendModel" | /** 是指可以对模型增加属性的能力。 */ "extendProperty" | /** 是指增加接口动作的能力。 */ "extendHttpHandler" | /** 是指增加或者修改接口定义的能力。 */ "extendRoute" | /** 是指对实体数据进行标准化的能力。 */ "normalizeEntity" | /** 处理事件总线发送过来的事件的能力。 */ "handleEvent" | /** 处理消息队列发送过来的消息的能力。 */ "handleMessage" | /** 对特定任务进行处理的能力。 */ "processTask";
+export interface RpdServerPluginConfigurableTargetOptions {
+    targetCode: string;
+    configurations: RpdConfigurationItemOptions[];
+}
+export interface IRpdServerPlugin {
+    /** 插件代码 */
+    code: string;
+    /** 插件描述 */
+    description: string;
+    /** 插件可以提供哪些扩展能力 */
+    extendingAbilities: RpdServerPluginExtendingAbilities[];
+    /** 插件可以配置的目标实体，以及和配置目标相关的配置项 */
+    configurableTargets?: RpdServerPluginConfigurableTargetOptions[];
+    /** 插件的全局配置项 */
+    configurations?: RpdConfigurationItemOptions[];
+    /** 初始化插件时调用。插件可以在此时进行一些内部对象的初始化工作。 */
+    initPlugin: (plugin: IPluginInstance, server: IRpdServer) => Promise<any>;
+    /** 注册中间件 */
+    registerMiddlewares?: (server: IRpdServer) => Promise<any>;
+    /** 注册接口动作处理程序 */
+    registerHttpHandlers?: (server: IRpdServer) => Promise<any>;
+    /** 注册事件处理程序 */
+    registerEventHandlers?: (server: IRpdServer) => Promise<any>;
+    /** 注册消息处理程序 */
+    registerMessageHandlers?: (server: IRpdServer) => Promise<any>;
+    /** 注册任务处理程序 */
+    registerTaskProcessors?: (server: IRpdServer) => Promise<any>;
+    /** 在加载应用前调用。 */
+    onLoadingApplication?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
+    /** 配置数据集合 */
+    configureModels?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
+    /** 配置模型属性 */
+    configureModelProperties?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
+    /** 配置路由 */
+    configureRoutes?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
+    /** 在应用配置加载完成后调用。此时插件可以进行一些数据的初始化工作。 */
+    onApplicationLoaded?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
+    /** 在应用准备完成后调用。此时服务器已经可以处理网络请求，可以对外广播消息。 */
+    onApplicationReady?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
+}

package/dist/dataAccess/dataAccessor.d.ts

@@ -0,0 +1,20 @@
+import { CountEntityOptions, FindEntityOptions, IRpdDataAccessor, RpdDataModel } from "~/types";
+import QueryBuilder from "~/queryBuilder/queryBuilder";
+export interface IDataAccessorOptions {
+    model: RpdDataModel;
+    queryBuilder: QueryBuilder;
+}
+export default class DataAccessor<T = any> implements IRpdDataAccessor<T> {
+    #private;
+    constructor(options: IDataAccessorOptions);
+    getModel(): RpdDataModel;
+    create(entity: Partial<T>): Promise<T>;
+    updateById(id: any, entity: Partial<T>): Promise<{
+        count: number;
+    }>;
+    find(options: FindEntityOptions): Promise<T[]>;
+    findOne(options: FindEntityOptions): Promise<T>;
+    findById(id: any): Promise<T | null>;
+    count(options: CountEntityOptions): Promise<any>;
+    deleteById(id: any): Promise<void>;
+}

package/dist/dataAccess/entityManager.d.ts

@@ -0,0 +1,6 @@
+import { CreateEntityOptions, FindEntityOptions, IRpdDataAccessor, UpdateEntityByIdOptions } from "~/types";
+import { IRpdServer } from "~/core/server";
+export declare function findEntities(server: IRpdServer, dataAccessor: IRpdDataAccessor, options: FindEntityOptions): Promise<any[]>;
+export declare function findEntity(server: IRpdServer, dataAccessor: IRpdDataAccessor, options: FindEntityOptions): Promise<any>;
+export declare function createEntity(server: IRpdServer, dataAccessor: IRpdDataAccessor, options: CreateEntityOptions): Promise<any>;
+export declare function updateEntityById(server: IRpdServer, dataAccessor: IRpdDataAccessor, options: UpdateEntityByIdOptions): Promise<any>;

package/dist/dataAccess/entityMapper.d.ts

@@ -0,0 +1,3 @@
+import { RpdDataModel } from "~/types";
+export declare function mapDbRowToEntity(model: RpdDataModel, row: any): any;
+export declare function mapEntityToDbRow(model: RpdDataModel, entity: any): any;

package/dist/dataAccess/filterHelper.d.ts

@@ -0,0 +1,2 @@
+import { EntityFilterOptions } from "~/types";
+export declare function removeFiltersWithNullValue(filters?: EntityFilterOptions[]): EntityFilterOptions[];

package/dist/dataAccess/propertyMapper.d.ts

@@ -0,0 +1,3 @@
+import { RpdDataModel } from "~/types";
+export declare function mapPropertyNameToColumnName(model: RpdDataModel, propertyName: string): string;
+export declare function mapPropertyNamesToColumnNames(model: RpdDataModel, propertyNames: string[]): string[];

package/dist/deno-std/assert/assert.d.ts

@@ -0,0 +1,2 @@
+/** Make an assertion, error will be thrown if `expr` does not have truthy value. */
+export declare function assert(expr: unknown, msg?: string): asserts expr;

package/dist/deno-std/assert/assertion_error.d.ts

@@ -0,0 +1,4 @@
+export declare class AssertionError extends Error {
+    name: string;
+    constructor(message: string);
+}

package/dist/deno-std/datetime/to_imf.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Formats the given date to IMF date time format. (Reference:
+ * https://tools.ietf.org/html/rfc7231#section-7.1.1.1).
+ * IMF is the time format to use when generating times in HTTP
+ * headers. The time being formatted must be in UTC for Format to
+ * generate the correct format.
+ *
+ * @example
+ * ```ts
+ * import { toIMF } from "https://deno.land/std@$STD_VERSION/datetime/to_imf.ts";
+ *
+ * toIMF(new Date(0)); // => returns "Thu, 01 Jan 1970 00:00:00 GMT"
+ * ```
+ * @param date Date to parse
+ * @return IMF date formatted string
+ */
+export declare function toIMF(date: Date): string;

package/dist/deno-std/http/cookie.d.ts

@@ -0,0 +1,134 @@
+export interface Cookie {
+    /** Name of the cookie. */
+    name: string;
+    /** Value of the cookie. */
+    value: string;
+    /** The cookie's `Expires` attribute, either as an explicit date or UTC milliseconds.
+     * @example <caption>Explicit date:</caption>
+     *
+     * ```ts
+     * import { Cookie } from "https://deno.land/std@$STD_VERSION/http/cookie.ts";
+     * const cookie: Cookie = {
+     *   name: 'name',
+     *   value: 'value',
+     *   // expires on Fri Dec 30 2022
+     *   expires: new Date('2022-12-31')
+     * }
+     * ```
+     *
+     * @example <caption>UTC milliseconds</caption>
+     *
+     * ```ts
+     * import { Cookie } from "https://deno.land/std@$STD_VERSION/http/cookie.ts";
+     * const cookie: Cookie = {
+     *   name: 'name',
+     *   value: 'value',
+     *   // expires 10 seconds from now
+     *   expires: Date.now() + 10000
+     * }
+     * ```
+     */
+    expires?: Date | number;
+    /** The cookie's `Max-Age` attribute, in seconds. Must be a non-negative integer. A cookie with a `maxAge` of `0` expires immediately. */
+    maxAge?: number;
+    /** The cookie's `Domain` attribute. Specifies those hosts to which the cookie will be sent. */
+    domain?: string;
+    /** The cookie's `Path` attribute. A cookie with a path will only be included in the `Cookie` request header if the requested URL matches that path. */
+    path?: string;
+    /** The cookie's `Secure` attribute. If `true`, the cookie will only be included in the `Cookie` request header if the connection uses SSL and HTTPS. */
+    secure?: boolean;
+    /** The cookie's `HTTPOnly` attribute. If `true`, the cookie cannot be accessed via JavaScript. */
+    httpOnly?: boolean;
+    /**
+     * Allows servers to assert that a cookie ought not to
+     * be sent along with cross-site requests.
+     */
+    sameSite?: "Strict" | "Lax" | "None";
+    /** Additional key value pairs with the form "key=value" */
+    unparsed?: string[];
+}
+/**
+ * Parse cookies of a header
+ *
+ * @example
+ * ```ts
+ * import { getCookies } from "https://deno.land/std@$STD_VERSION/http/cookie.ts";
+ *
+ * const headers = new Headers();
+ * headers.set("Cookie", "full=of; tasty=chocolate");
+ *
+ * const cookies = getCookies(headers);
+ * console.log(cookies); // { full: "of", tasty: "chocolate" }
+ * ```
+ *
+ * @param headers The headers instance to get cookies from
+ * @return Object with cookie names as keys
+ */
+export declare function getCookies(headers: Headers): Record<string, string>;
+/**
+ * Set the cookie header properly in the headers
+ *
+ * @example
+ * ```ts
+ * import {
+ *   Cookie,
+ *   setCookie,
+ * } from "https://deno.land/std@$STD_VERSION/http/cookie.ts";
+ *
+ * const headers = new Headers();
+ * const cookie: Cookie = { name: "Space", value: "Cat" };
+ * setCookie(headers, cookie);
+ *
+ * const cookieHeader = headers.get("set-cookie");
+ * console.log(cookieHeader); // Space=Cat
+ * ```
+ *
+ * @param headers The headers instance to set the cookie to
+ * @param cookie Cookie to set
+ */
+export declare function setCookie(headers: Headers, cookie: Cookie): void;
+/**
+ * Set the cookie header with empty value in the headers to delete it
+ *
+ * > Note: Deleting a `Cookie` will set its expiration date before now. Forcing
+ * > the browser to delete it.
+ *
+ * @example
+ * ```ts
+ * import { deleteCookie } from "https://deno.land/std@$STD_VERSION/http/cookie.ts";
+ *
+ * const headers = new Headers();
+ * deleteCookie(headers, "deno");
+ *
+ * const cookieHeader = headers.get("set-cookie");
+ * console.log(cookieHeader); // deno=; Expires=Thus, 01 Jan 1970 00:00:00 GMT
+ * ```
+ *
+ * @param headers The headers instance to delete the cookie from
+ * @param name Name of cookie
+ * @param attributes Additional cookie attributes
+ */
+export declare function deleteCookie(headers: Headers, name: string, attributes?: {
+    path?: string;
+    domain?: string;
+}): void;
+/**
+ * Parse set-cookies of a header
+ *
+ * @example
+ * ```ts
+ * import { getSetCookies } from "https://deno.land/std@$STD_VERSION/http/cookie.ts";
+ *
+ * const headers = new Headers([
+ *   ["Set-Cookie", "lulu=meow; Secure; Max-Age=3600"],
+ *   ["Set-Cookie", "booya=kasha; HttpOnly; Path=/"],
+ * ]);
+ *
+ * const cookies = getSetCookies(headers);
+ * console.log(cookies); // [{ name: "lulu", value: "meow", secure: true, maxAge: 3600 }, { name: "booya", value: "kahsa", httpOnly: true, path: "/ }]
+ * ```
+ *
+ * @param headers The headers instance to get set-cookies from
+ * @return List of cookies
+ */
+export declare function getSetCookies(headers: Headers): Cookie[];

package/dist/helpers/entityHelpers.d.ts

@@ -0,0 +1 @@
+export declare function getEntityPartChanges(before: any, after: any): Record<string, any> | null;

package/dist/helpers/inputHelper.d.ts

@@ -0,0 +1 @@
+export declare function mergeInput(defaultInput: any, input: any, fixedInput: any): any;

package/dist/helpers/runCollectionEntityHttpHandler.d.ts

@@ -0,0 +1,5 @@
+import { IRpdDataAccessor, RunEntityHttpHandlerOptions } from "~/types";
+import { HttpHandlerContext } from "~/core/httpHandler";
+type DataAccessHandler = (dataAccessor: IRpdDataAccessor, input: any) => Promise<any>;
+export default function runCollectionEntityHttpHandler(ctx: HttpHandlerContext, options: RunEntityHttpHandlerOptions, code: string, handleDataAccess: DataAccessHandler): Promise<void>;
+export {};

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./types";
+export * as RpdServer from "./server";
+export * from "./server";
+export * from "./core/request";
+export * from "./core/routeContext";
+export * from "./core/server";
+export * as bootstrapApplicationConfig from "./bootstrapApplicationConfig";