@ruiapp/rapid-core 0.11.7 → 0.12.0

package/src/dataAccess/dataAccessTypes.ts

@@ -1,165 +1,165 @@
-export type DataAccessPgColumnTypes =
-  | "int4"
-  | "int8"
-  | "float4"
-  | "float8"
-  | "decimal"
-  | "text"
-  | "text[]"
-  | "bool"
-  | "date"
-  | "time"
-  | "timestamptz"
-  | "jsonb";
-
-export type RowFilterRelationalOperators =
-  | "eq"
-  | "ne"
-  | "lt"
-  | "lte"
-  | "gt"
-  | "gte"
-  | "matches"
-  | "matchesCS"
-  | "contains"
-  | "notContains"
-  | "containsCS"
-  | "notContainsCS"
-  | "startsWith"
-  | "notStartsWith"
-  | "endsWith"
-  | "notEndsWith";
-
-export type RowFilterArrayOperators = "arrayContains" | "arrayOverlap";
-
-export type RowFilterSetOperators = "in" | "notIn";
-
-export type RowFilterRangeOperators = "between" | "range";
-
-export type RowFilterLogicalOperators = "or" | "and";
-
-export type RowFilterUnaryOperators = "null" | "notNull";
-
-export type RowFilterExistenceOperators = "exists" | "notExists";
-
-export type RowFilterOperators =
-  | RowFilterRelationalOperators
-  | RowFilterArrayOperators
-  | RowFilterSetOperators
-  | RowFilterRangeOperators
-  | RowFilterLogicalOperators
-  | RowFilterUnaryOperators
-  | RowFilterExistenceOperators;
-
-export type RowFilterOptions =
-  | FindRowRelationalFilterOptions
-  | FindRowArrayFilterOptions
-  | FindRowSetFilterOptions
-  | FindRowRangeFilterOptions
-  | FindRowLogicalFilterOptions
-  | FindRowUnaryFilterOptions
-  | FindRowExistenceFilterOptions;
-
-export type RowNonRelationPropertyFilterOptions =
-  | FindRowRelationalFilterOptions
-  | FindRowArrayFilterOptions
-  | FindRowSetFilterOptions
-  | FindRowRangeFilterOptions
-  | FindRowUnaryFilterOptions;
-
-export type ColumnSelectOptions = string | ColumnNameWithTableName;
-
-export type ColumnNameWithTableName = {
-  name: string;
-  tableName?: string;
-  schema?: string;
-};
-
-export interface FindRowOptions {
-  filters?: RowFilterOptions[];
-  orderBy?: FindRowOrderByOptions[];
-  pagination?: FindRowPaginationOptions;
-  // TODO: may be `columns` is a better name.
-  fields?: ColumnSelectOptions[];
-  keepNonPropertyFields?: boolean;
-}
-
-export interface FindRowRelationalFilterOptions {
-  // TODO: may be `column` is a better name.
-  field: ColumnSelectOptions;
-  operator: RowFilterRelationalOperators;
-  value: any;
-}
-
-export interface FindRowArrayFilterOptions {
-  field: ColumnSelectOptions;
-  operator: RowFilterArrayOperators;
-  value: any[];
-  itemType?: string;
-}
-
-export interface FindRowSetFilterOptions {
-  field: ColumnSelectOptions;
-  operator: RowFilterSetOperators;
-  value: any[];
-  itemType?: string;
-}
-
-export interface FindRowRangeFilterOptions {
-  field: ColumnSelectOptions;
-  operator: RowFilterRangeOperators;
-  value: any[];
-  itemType?: string;
-}
-
-export interface FindRowLogicalFilterOptions {
-  operator: RowFilterLogicalOperators;
-  filters: RowFilterOptions[];
-}
-
-export interface FindRowUnaryFilterOptions {
-  field: ColumnSelectOptions;
-  operator: RowFilterUnaryOperators;
-}
-
-export interface FindRowExistenceFilterOptions {
-  field: ColumnSelectOptions;
-  operator: RowFilterExistenceOperators;
-  filters: RowFilterOptions[];
-}
-
-export interface FindRowPaginationOptions {
-  offset: number;
-  limit: number;
-  withoutTotal?: boolean;
-}
-
-export interface FindRowOrderByOptions {
-  /**
-   * 排序字段
-   */
-  field: ColumnSelectOptions;
-
-  /**
-   * 是否倒序
-   */
-  desc?: boolean;
-
-  /**
-   * 关系字段
-   */
-  relationField?: ColumnNameWithTableName;
-}
-
-export interface CountRowOptions {
-  filters?: RowFilterOptions[];
-}
-
-export interface UpdateRowOptions {
-  filters?: RowFilterOptions[];
-  entity: any;
-}
-
-export interface DeleteRowOptions {
-  filters?: RowFilterOptions[];
-}
+export type DataAccessPgColumnTypes =
+  | "int4"
+  | "int8"
+  | "float4"
+  | "float8"
+  | "decimal"
+  | "text"
+  | "text[]"
+  | "bool"
+  | "date"
+  | "time"
+  | "timestamptz"
+  | "jsonb";
+
+export type RowFilterRelationalOperators =
+  | "eq"
+  | "ne"
+  | "lt"
+  | "lte"
+  | "gt"
+  | "gte"
+  | "matches"
+  | "matchesCS"
+  | "contains"
+  | "notContains"
+  | "containsCS"
+  | "notContainsCS"
+  | "startsWith"
+  | "notStartsWith"
+  | "endsWith"
+  | "notEndsWith";
+
+export type RowFilterArrayOperators = "arrayContains" | "arrayOverlap";
+
+export type RowFilterSetOperators = "in" | "notIn";
+
+export type RowFilterRangeOperators = "between" | "range";
+
+export type RowFilterLogicalOperators = "or" | "and";
+
+export type RowFilterUnaryOperators = "null" | "notNull";
+
+export type RowFilterExistenceOperators = "exists" | "notExists";
+
+export type RowFilterOperators =
+  | RowFilterRelationalOperators
+  | RowFilterArrayOperators
+  | RowFilterSetOperators
+  | RowFilterRangeOperators
+  | RowFilterLogicalOperators
+  | RowFilterUnaryOperators
+  | RowFilterExistenceOperators;
+
+export type RowFilterOptions =
+  | FindRowRelationalFilterOptions
+  | FindRowArrayFilterOptions
+  | FindRowSetFilterOptions
+  | FindRowRangeFilterOptions
+  | FindRowLogicalFilterOptions
+  | FindRowUnaryFilterOptions
+  | FindRowExistenceFilterOptions;
+
+export type RowNonRelationPropertyFilterOptions =
+  | FindRowRelationalFilterOptions
+  | FindRowArrayFilterOptions
+  | FindRowSetFilterOptions
+  | FindRowRangeFilterOptions
+  | FindRowUnaryFilterOptions;
+
+export type ColumnSelectOptions = string | ColumnNameWithTableName;
+
+export type ColumnNameWithTableName = {
+  name: string;
+  tableName?: string;
+  schema?: string;
+};
+
+export interface FindRowOptions {
+  filters?: RowFilterOptions[];
+  orderBy?: FindRowOrderByOptions[];
+  pagination?: FindRowPaginationOptions;
+  // TODO: may be `columns` is a better name.
+  fields?: ColumnSelectOptions[];
+  keepNonPropertyFields?: boolean;
+}
+
+export interface FindRowRelationalFilterOptions {
+  // TODO: may be `column` is a better name.
+  field: ColumnSelectOptions;
+  operator: RowFilterRelationalOperators;
+  value: any;
+}
+
+export interface FindRowArrayFilterOptions {
+  field: ColumnSelectOptions;
+  operator: RowFilterArrayOperators;
+  value: any[];
+  itemType?: string;
+}
+
+export interface FindRowSetFilterOptions {
+  field: ColumnSelectOptions;
+  operator: RowFilterSetOperators;
+  value: any[];
+  itemType?: string;
+}
+
+export interface FindRowRangeFilterOptions {
+  field: ColumnSelectOptions;
+  operator: RowFilterRangeOperators;
+  value: any[];
+  itemType?: string;
+}
+
+export interface FindRowLogicalFilterOptions {
+  operator: RowFilterLogicalOperators;
+  filters: RowFilterOptions[];
+}
+
+export interface FindRowUnaryFilterOptions {
+  field: ColumnSelectOptions;
+  operator: RowFilterUnaryOperators;
+}
+
+export interface FindRowExistenceFilterOptions {
+  field: ColumnSelectOptions;
+  operator: RowFilterExistenceOperators;
+  filters: RowFilterOptions[];
+}
+
+export interface FindRowPaginationOptions {
+  offset: number;
+  limit: number;
+  withoutTotal?: boolean;
+}
+
+export interface FindRowOrderByOptions {
+  /**
+   * 排序字段
+   */
+  field: ColumnSelectOptions;
+
+  /**
+   * 是否倒序
+   */
+  desc?: boolean;
+
+  /**
+   * 关系字段
+   */
+  relationField?: ColumnNameWithTableName;
+}
+
+export interface CountRowOptions {
+  filters?: RowFilterOptions[];
+}
+
+export interface UpdateRowOptions {
+  filters?: RowFilterOptions[];
+  entity: any;
+}
+
+export interface DeleteRowOptions {
+  filters?: RowFilterOptions[];
+}

package/src/dataAccess/dataAccessor.ts

@@ -1,135 +1,135 @@
-import { CreateEntityOptions, IRpdDataAccessor, RpdDataModel, IDatabaseAccessor, DatabaseQuery, IDatabaseClient } from "~/types";
-import QueryBuilder from "~/queryBuilder/queryBuilder";
-import { first, set } from "lodash";
-import { IRpdServer } from "~/core/server";
-import { Logger } from "~/facilities/log/LogFacility";
-import { newDatabaseError } from "~/utilities/errorUtility";
-import { CountRowOptions, FindRowOptions, UpdateRowOptions } from "./dataAccessTypes";
-
-export interface IDataAccessorOptions {
-  model: RpdDataModel;
-  queryBuilder: QueryBuilder;
-}
-
-export default class DataAccessor<T = any> implements IRpdDataAccessor<T> {
-  #logger: Logger;
-  #model: RpdDataModel;
-  #queryBuilder: QueryBuilder;
-  #server: IRpdServer;
-  #databaseAccessor: IDatabaseAccessor;
-
-  constructor(server: IRpdServer, databaseAccessor: IDatabaseAccessor, options: IDataAccessorOptions) {
-    this.#server = server;
-    this.#logger = server.getLogger();
-    this.#databaseAccessor = databaseAccessor;
-    this.#queryBuilder = options.queryBuilder;
-    this.#model = options.model;
-  }
-
-  getModel() {
-    return this.#model;
-  }
-
-  async create(entity: Partial<T>, databaseClient: IDatabaseClient | null): Promise<T> {
-    const options: CreateEntityOptions = {
-      entity,
-    };
-    const query = this.#queryBuilder.insert(this.#model, options);
-    const result = await this.#databaseAccessor.queryDatabaseObject(query.command, query.params, databaseClient);
-    return first(result);
-  }
-
-  async updateById(id: any, entity: Partial<T>, databaseClient: IDatabaseClient | null): Promise<{ count: number }> {
-    const options: UpdateRowOptions = {
-      entity,
-      filters: [
-        {
-          field: {
-            name: "id",
-          },
-          operator: "eq",
-          value: id,
-        },
-      ],
-    };
-    const query = this.#queryBuilder.update(this.#model, options);
-    const result = await this.#databaseAccessor.queryDatabaseObject(query.command, query.params, databaseClient);
-    return first(result);
-  }
-
-  async find(options: FindRowOptions, databaseClient: IDatabaseClient | null): Promise<T[]> {
-    this.#logger.debug(`Finding '${this.#model.singularCode}' entity.`, { options });
-    let query: DatabaseQuery;
-    if (this.#model.base) {
-      const baseModel = this.#server.getModel({
-        singularCode: this.#model.base,
-      });
-      query = this.#queryBuilder.selectDerived(this.#model, baseModel, options);
-    } else {
-      query = this.#queryBuilder.select(this.#model, options);
-    }
-
-    try {
-      return await this.#databaseAccessor.queryDatabaseObject(query.command, query.params, databaseClient);
-    } catch (err) {
-      throw newDatabaseError(`Failed to find entities. ${err.message}`, err);
-    }
-  }
-
-  async findOne(options: FindRowOptions, databaseClient: IDatabaseClient | null): Promise<T> {
-    set(options, "pagination.limit", 1);
-    const list = await this.find(options, databaseClient);
-    return first(list);
-  }
-
-  async findById(id: any, databaseClient: IDatabaseClient | null): Promise<T | null> {
-    const options: FindRowOptions = {
-      filters: [
-        {
-          field: {
-            name: "id",
-          },
-          operator: "eq",
-          value: id,
-        },
-      ],
-    };
-    const result = await this.findOne(options, databaseClient);
-    return result;
-  }
-
-  async count(options: CountRowOptions, databaseClient: IDatabaseClient | null): Promise<number> {
-    let query: DatabaseQuery;
-    if (this.#model.base) {
-      const baseModel = this.#server.getModel({
-        singularCode: this.#model.base,
-      });
-      query = this.#queryBuilder.countDerived(this.#model, baseModel, options);
-    } else {
-      query = this.#queryBuilder.count(this.#model, options);
-    }
-    const result = await this.#databaseAccessor.queryDatabaseObject(query.command, query.params, databaseClient);
-
-    const row = first(result);
-    if (row) {
-      return row.count;
-    }
-    return 0;
-  }
-
-  async deleteById(id: any, databaseClient: IDatabaseClient | null) {
-    const options: FindRowOptions = {
-      filters: [
-        {
-          field: {
-            name: "id",
-          },
-          operator: "eq",
-          value: id,
-        },
-      ],
-    };
-    const query = this.#queryBuilder.delete(this.#model, options);
-    await this.#databaseAccessor.queryDatabaseObject(query.command, query.params, databaseClient);
-  }
-}
+import { CreateEntityOptions, IRpdDataAccessor, RpdDataModel, IDatabaseAccessor, DatabaseQuery, IDatabaseClient } from "~/types";
+import QueryBuilder from "~/queryBuilder/queryBuilder";
+import { first, set } from "lodash";
+import { IRpdServer } from "~/core/server";
+import { Logger } from "~/facilities/log/LogFacility";
+import { newDatabaseError } from "~/utilities/errorUtility";
+import { CountRowOptions, FindRowOptions, UpdateRowOptions } from "./dataAccessTypes";
+
+export interface IDataAccessorOptions {
+  model: RpdDataModel;
+  queryBuilder: QueryBuilder;
+}
+
+export default class DataAccessor<T = any> implements IRpdDataAccessor<T> {
+  #logger: Logger;
+  #model: RpdDataModel;
+  #queryBuilder: QueryBuilder;
+  #server: IRpdServer;
+  #databaseAccessor: IDatabaseAccessor;
+
+  constructor(server: IRpdServer, databaseAccessor: IDatabaseAccessor, options: IDataAccessorOptions) {
+    this.#server = server;
+    this.#logger = server.getLogger();
+    this.#databaseAccessor = databaseAccessor;
+    this.#queryBuilder = options.queryBuilder;
+    this.#model = options.model;
+  }
+
+  getModel() {
+    return this.#model;
+  }
+
+  async create(entity: Partial<T>, databaseClient: IDatabaseClient | null): Promise<T> {
+    const options: CreateEntityOptions = {
+      entity,
+    };
+    const query = this.#queryBuilder.insert(this.#model, options);
+    const result = await this.#databaseAccessor.queryDatabaseObject(query.command, query.params, databaseClient);
+    return first(result);
+  }
+
+  async updateById(id: any, entity: Partial<T>, databaseClient: IDatabaseClient | null): Promise<{ count: number }> {
+    const options: UpdateRowOptions = {
+      entity,
+      filters: [
+        {
+          field: {
+            name: "id",
+          },
+          operator: "eq",
+          value: id,
+        },
+      ],
+    };
+    const query = this.#queryBuilder.update(this.#model, options);
+    const result = await this.#databaseAccessor.queryDatabaseObject(query.command, query.params, databaseClient);
+    return first(result);
+  }
+
+  async find(options: FindRowOptions, databaseClient: IDatabaseClient | null): Promise<T[]> {
+    this.#logger.debug(`Finding '${this.#model.singularCode}' entity.`, { options });
+    let query: DatabaseQuery;
+    if (this.#model.base) {
+      const baseModel = this.#server.getModel({
+        singularCode: this.#model.base,
+      });
+      query = this.#queryBuilder.selectDerived(this.#model, baseModel, options);
+    } else {
+      query = this.#queryBuilder.select(this.#model, options);
+    }
+
+    try {
+      return await this.#databaseAccessor.queryDatabaseObject(query.command, query.params, databaseClient);
+    } catch (err) {
+      throw newDatabaseError(`Failed to find entities. ${err.message}`, err);
+    }
+  }
+
+  async findOne(options: FindRowOptions, databaseClient: IDatabaseClient | null): Promise<T> {
+    set(options, "pagination.limit", 1);
+    const list = await this.find(options, databaseClient);
+    return first(list);
+  }
+
+  async findById(id: any, databaseClient: IDatabaseClient | null): Promise<T | null> {
+    const options: FindRowOptions = {
+      filters: [
+        {
+          field: {
+            name: "id",
+          },
+          operator: "eq",
+          value: id,
+        },
+      ],
+    };
+    const result = await this.findOne(options, databaseClient);
+    return result;
+  }
+
+  async count(options: CountRowOptions, databaseClient: IDatabaseClient | null): Promise<number> {
+    let query: DatabaseQuery;
+    if (this.#model.base) {
+      const baseModel = this.#server.getModel({
+        singularCode: this.#model.base,
+      });
+      query = this.#queryBuilder.countDerived(this.#model, baseModel, options);
+    } else {
+      query = this.#queryBuilder.count(this.#model, options);
+    }
+    const result = await this.#databaseAccessor.queryDatabaseObject(query.command, query.params, databaseClient);
+
+    const row = first(result);
+    if (row) {
+      return row.count;
+    }
+    return 0;
+  }
+
+  async deleteById(id: any, databaseClient: IDatabaseClient | null) {
+    const options: FindRowOptions = {
+      filters: [
+        {
+          field: {
+            name: "id",
+          },
+          operator: "eq",
+          value: id,
+        },
+      ],
+    };
+    const query = this.#queryBuilder.delete(this.#model, options);
+    await this.#databaseAccessor.queryDatabaseObject(query.command, query.params, databaseClient);
+  }
+}