@ruiapp/rapid-core 0.9.9 → 0.10.1

package/src/core/response.ts

@@ -1,79 +1,79 @@
-import { isArray, isObject } from "lodash";
-import { HttpStatus, ResponseData } from "./http-types";
-
-export const GlobalResponse = global.Response;
-
-function mergeHeaders(target: Headers, source: HeadersInit) {
-  if (source instanceof Headers) {
-    for (const keyValuePair of source.entries()) {
-      target.set(keyValuePair[0], keyValuePair[1]);
-    }
-  } else if (isArray(source)) {
-    for (const keyValuePair of source) {
-      target.set(keyValuePair[0], keyValuePair[1]);
-    }
-  } else if (isObject(source)) {
-    Object.entries(source).forEach(([key, value]) => target.set(key, value));
-  }
-}
-
-interface NewResponseOptions {
-  body?: ResponseData;
-  status?: HttpStatus;
-  headers?: HeadersInit;
-}
-
-function newResponse(options: NewResponseOptions) {
-  return new Response(options.body, {
-    headers: options.headers,
-    status: options.status || 200,
-  });
-}
-
-export class RapidResponse {
-  // TODO: remove this field.
-  #response: Response;
-  status: number;
-  body: BodyInit;
-  headers: Headers;
-
-  constructor(body?: BodyInit, init?: ResponseInit) {
-    this.body = body;
-    this.headers = new Headers(init?.headers);
-    this.status = init?.status;
-  }
-
-  json(obj: any, status?: HttpStatus, headers?: HeadersInit) {
-    let body: string | null = null;
-    if (obj) {
-      body = JSON.stringify(obj);
-    }
-    this.headers.set("Content-Type", "application/json");
-    const responseHeaders = new Headers(this.headers);
-    if (headers) {
-      mergeHeaders(responseHeaders, headers);
-    }
-    this.status = status || 200;
-    this.body = body;
-    this.#response = newResponse({ body, status: this.status, headers: responseHeaders });
-  }
-
-  redirect(location: string, status?: HttpStatus) {
-    this.headers.set("Location", location);
-    this.status = status || 302;
-    this.#response = newResponse({
-      headers: this.headers,
-      status: this.status,
-    });
-  }
-
-  getResponse() {
-    if (!this.#response) {
-      this.#response = new Response(this.body, {
-        status: this.status || 200,
-        headers: this.headers,
-      });
-    }
-    return this.#response;
-  }
-}
+import { isArray, isObject } from "lodash";
+import { HttpStatus, ResponseData } from "./http-types";
+
+export const GlobalResponse = global.Response;
+
+function mergeHeaders(target: Headers, source: HeadersInit) {
+  if (source instanceof Headers) {
+    for (const keyValuePair of source.entries()) {
+      target.set(keyValuePair[0], keyValuePair[1]);
+    }
+  } else if (isArray(source)) {
+    for (const keyValuePair of source) {
+      target.set(keyValuePair[0], keyValuePair[1]);
+    }
+  } else if (isObject(source)) {
+    Object.entries(source).forEach(([key, value]) => target.set(key, value));
+  }
+}
+
+interface NewResponseOptions {
+  body?: ResponseData;
+  status?: HttpStatus;
+  headers?: HeadersInit;
+}
+
+function newResponse(options: NewResponseOptions) {
+  return new Response(options.body, {
+    headers: options.headers,
+    status: options.status || 200,
+  });
+}
+
+export class RapidResponse {
+  // TODO: remove this field.
+  #response: Response;
+  status: number;
+  body: BodyInit;
+  headers: Headers;
+
+  constructor(body?: BodyInit, init?: ResponseInit) {
+    this.body = body;
+    this.headers = new Headers(init?.headers);
+    this.status = init?.status;
+  }
+
+  json(obj: any, status?: HttpStatus, headers?: HeadersInit) {
+    let body: string | null = null;
+    if (obj) {
+      body = JSON.stringify(obj);
+    }
+    this.headers.set("Content-Type", "application/json");
+    const responseHeaders = new Headers(this.headers);
+    if (headers) {
+      mergeHeaders(responseHeaders, headers);
+    }
+    this.status = status || 200;
+    this.body = body;
+    this.#response = newResponse({ body, status: this.status, headers: responseHeaders });
+  }
+
+  redirect(location: string, status?: HttpStatus) {
+    this.headers.set("Location", location);
+    this.status = status || 302;
+    this.#response = newResponse({
+      headers: this.headers,
+      status: this.status,
+    });
+  }
+
+  getResponse() {
+    if (!this.#response) {
+      this.#response = new Response(this.body, {
+        status: this.status || 200,
+        headers: this.headers,
+      });
+    }
+    return this.#response;
+  }
+}

package/src/core/routeContext.ts

@@ -1,127 +1,127 @@
-import { RapidRequest } from "./request";
-import { RapidResponse } from "./response";
-import { HttpStatus } from "./http-types";
-import { IRpdServer } from "./server";
-import { IDatabaseAccessor, IDatabaseClient, RpdRoute } from "~/types";
-
-export type Next = () => Promise<void>;
-
-export type TransactionState = "uninited" | "inited" | "started";
-
-// TODO: should divide to RequestContext and OperationContext
-
-export class RouteContext {
-  readonly request: RapidRequest;
-  readonly response: RapidResponse;
-  readonly state: Record<string, any>;
-  readonly databaseAccessor: IDatabaseAccessor;
-  method: string;
-  path: string;
-  params: Record<string, string>;
-  routeConfig: RpdRoute;
-  #server: IRpdServer;
-  #dbTransactionClient: IDatabaseClient | undefined;
-  #dbTransactionState: TransactionState;
-
-  static newSystemOperationContext(server: IRpdServer) {
-    return new RouteContext(server);
-  }
-
-  constructor(server: IRpdServer, request?: RapidRequest) {
-    this.#server = server;
-    this.databaseAccessor = server.getDatabaseAccessor();
-    this.#dbTransactionState = "uninited";
-
-    this.request = request;
-    this.state = {};
-    this.response = new RapidResponse();
-
-    // `method` and `path` are used by `koa-tree-router` to match route
-    if (this.request) {
-      this.method = request.method;
-      this.path = request.url.pathname;
-    }
-  }
-
-  clone(): RouteContext {
-    const clonedContext = new RouteContext(this.#server);
-    clonedContext.method = this.method;
-    clonedContext.path = this.path;
-    clonedContext.params = this.params;
-    clonedContext.setState(this.state);
-
-    return clonedContext;
-  }
-
-  setState(state: Record<string, any>) {
-    Object.assign(this.state, state);
-  }
-
-  // `koa-tree-router` uses this method to set headers
-  set(headerName: string, headerValue: string) {
-    this.response.headers.set(headerName, headerValue);
-  }
-
-  json(obj: any, status?: HttpStatus, headers?: HeadersInit) {
-    this.response.json(obj, status, headers);
-  }
-
-  redirect(url: string, status?: HttpStatus) {
-    this.response.redirect(url, status);
-  }
-
-  getDbTransactionClient(): IDatabaseClient | undefined {
-    return this.#dbTransactionClient;
-  }
-
-  async initDbTransactionClient(): Promise<IDatabaseClient> {
-    let dbClient = this.#dbTransactionClient;
-    if (dbClient) {
-      return dbClient;
-    }
-
-    dbClient = await this.databaseAccessor.getClient();
-    this.#dbTransactionState = "inited";
-    this.#dbTransactionClient = dbClient;
-    return dbClient;
-  }
-
-  async beginDbTransaction(): Promise<void> {
-    if (!this.#dbTransactionClient) {
-      throw new Error("Database transaction has not been inited. You should call initDbTransactionClient() first.");
-    }
-
-    if (this.#dbTransactionState === "started") {
-      throw new Error("Database transaction has been started. You can not begin a new transaction before you commit or rollback it.");
-    }
-
-    await this.databaseAccessor.queryDatabaseObject("BEGIN", [], this.#dbTransactionClient);
-    this.#dbTransactionState = "started";
-  }
-
-  async commitDbTransaction(): Promise<void> {
-    if (!this.#dbTransactionClient) {
-      throw new Error("Database transaction has not been inited. You should call initDbTransactionClient() first.");
-    }
-
-    if (this.#dbTransactionState !== "started") {
-      throw new Error("Database transaction has not been started. You should call beginDbTransaction() first.");
-    }
-
-    await this.databaseAccessor.queryDatabaseObject("COMMIT", [], this.#dbTransactionClient);
-    this.#dbTransactionState = "inited";
-  }
-
-  async rollbackDbTransaction(): Promise<void> {
-    if (!this.#dbTransactionClient) {
-      throw new Error("Database transaction has not been inited. You should call initDbTransactionClient() first.");
-    }
-
-    if (this.#dbTransactionState !== "started") {
-      throw new Error("Database transaction has not been started. You should call beginDbTransaction() first.");
-    }
-
-    await this.databaseAccessor.queryDatabaseObject("ROLLBACK", [], this.#dbTransactionClient);
-    this.#dbTransactionState = "inited";
-  }
-}
+import { RapidRequest } from "./request";
+import { RapidResponse } from "./response";
+import { HttpStatus } from "./http-types";
+import { IRpdServer } from "./server";
+import { IDatabaseAccessor, IDatabaseClient, RpdRoute } from "~/types";
+
+export type Next = () => Promise<void>;
+
+export type TransactionState = "uninited" | "inited" | "started";
+
+// TODO: should divide to RequestContext and OperationContext
+
+export class RouteContext {
+  readonly request: RapidRequest;
+  readonly response: RapidResponse;
+  readonly state: Record<string, any>;
+  readonly databaseAccessor: IDatabaseAccessor;
+  method: string;
+  path: string;
+  params: Record<string, string>;
+  routeConfig: RpdRoute;
+  #server: IRpdServer;
+  #dbTransactionClient: IDatabaseClient | undefined;
+  #dbTransactionState: TransactionState;
+
+  static newSystemOperationContext(server: IRpdServer) {
+    return new RouteContext(server);
+  }
+
+  constructor(server: IRpdServer, request?: RapidRequest) {
+    this.#server = server;
+    this.databaseAccessor = server.getDatabaseAccessor();
+    this.#dbTransactionState = "uninited";
+
+    this.request = request;
+    this.state = {};
+    this.response = new RapidResponse();
+
+    // `method` and `path` are used by `koa-tree-router` to match route
+    if (this.request) {
+      this.method = request.method;
+      this.path = request.url.pathname;
+    }
+  }
+
+  clone(): RouteContext {
+    const clonedContext = new RouteContext(this.#server);
+    clonedContext.method = this.method;
+    clonedContext.path = this.path;
+    clonedContext.params = this.params;
+    clonedContext.setState(this.state);
+
+    return clonedContext;
+  }
+
+  setState(state: Record<string, any>) {
+    Object.assign(this.state, state);
+  }
+
+  // `koa-tree-router` uses this method to set headers
+  set(headerName: string, headerValue: string) {
+    this.response.headers.set(headerName, headerValue);
+  }
+
+  json(obj: any, status?: HttpStatus, headers?: HeadersInit) {
+    this.response.json(obj, status, headers);
+  }
+
+  redirect(url: string, status?: HttpStatus) {
+    this.response.redirect(url, status);
+  }
+
+  getDbTransactionClient(): IDatabaseClient | undefined {
+    return this.#dbTransactionClient;
+  }
+
+  async initDbTransactionClient(): Promise<IDatabaseClient> {
+    let dbClient = this.#dbTransactionClient;
+    if (dbClient) {
+      return dbClient;
+    }
+
+    dbClient = await this.databaseAccessor.getClient();
+    this.#dbTransactionState = "inited";
+    this.#dbTransactionClient = dbClient;
+    return dbClient;
+  }
+
+  async beginDbTransaction(): Promise<void> {
+    if (!this.#dbTransactionClient) {
+      throw new Error("Database transaction has not been inited. You should call initDbTransactionClient() first.");
+    }
+
+    if (this.#dbTransactionState === "started") {
+      throw new Error("Database transaction has been started. You can not begin a new transaction before you commit or rollback it.");
+    }
+
+    await this.databaseAccessor.queryDatabaseObject("BEGIN", [], this.#dbTransactionClient);
+    this.#dbTransactionState = "started";
+  }
+
+  async commitDbTransaction(): Promise<void> {
+    if (!this.#dbTransactionClient) {
+      throw new Error("Database transaction has not been inited. You should call initDbTransactionClient() first.");
+    }
+
+    if (this.#dbTransactionState !== "started") {
+      throw new Error("Database transaction has not been started. You should call beginDbTransaction() first.");
+    }
+
+    await this.databaseAccessor.queryDatabaseObject("COMMIT", [], this.#dbTransactionClient);
+    this.#dbTransactionState = "inited";
+  }
+
+  async rollbackDbTransaction(): Promise<void> {
+    if (!this.#dbTransactionClient) {
+      throw new Error("Database transaction has not been inited. You should call initDbTransactionClient() first.");
+    }
+
+    if (this.#dbTransactionState !== "started") {
+      throw new Error("Database transaction has not been started. You should call beginDbTransaction() first.");
+    }
+
+    await this.databaseAccessor.queryDatabaseObject("ROLLBACK", [], this.#dbTransactionClient);
+    this.#dbTransactionState = "inited";
+  }
+}

package/src/core/routes/healthz.ts

@@ -1,20 +1,20 @@
-import { RpdRoute } from "~/types";
-import { ActionHandlerContext } from "../actionHandler";
-
-export default {
-  namespace: "sys",
-  name: "sys.healthz",
-  code: "sys.healthz",
-  type: "RESTful",
-  method: "GET",
-  endpoint: "/healthz",
-  handler,
-} satisfies RpdRoute;
-
-export async function handler(ctx: ActionHandlerContext) {
-  const { server, input, routerContext: routeContext, logger } = ctx;
-  const { response } = routeContext;
-  const {} = input;
-
-  ctx.output = {};
-}
+import { RpdRoute } from "~/types";
+import { ActionHandlerContext } from "../actionHandler";
+
+export default {
+  namespace: "sys",
+  name: "sys.healthz",
+  code: "sys.healthz",
+  type: "RESTful",
+  method: "GET",
+  endpoint: "/healthz",
+  handler,
+} satisfies RpdRoute;
+
+export async function handler(ctx: ActionHandlerContext) {
+  const { server, input, routerContext: routeContext, logger } = ctx;
+  const { response } = routeContext;
+  const {} = input;
+
+  ctx.output = {};
+}

package/src/core/routes/index.ts

@@ -1,3 +1,3 @@
-import healthz from "./healthz";
-
-export default [healthz];
+import healthz from "./healthz";
+
+export default [healthz];