wok-server 0.5.0 → 0.6.0

package/types/mysql/manager/ops/paginate.d.ts

@@ -1,36 +1,36 @@
-import { PoolConnection } from 'mysql2';
-import { Table } from '../../table-info';
-import { MixCriteria } from './criteria';
-import { MysqlConfig } from '../../config';
-export interface MysqlPaginateOpts<T> {
-    /**
-     * 表
-     */
-    table: Table<T>;
-    /**
-     * 查询条件
-     * @param criteria
-     * @returns
-     */
-    criteria?: MixCriteria<T>;
-    /**
-     * 而码,默认1
-     */
-    pn?: number;
-    /**
-     * 每页的数据量大小,默认 20, 必须在 1-1000 之间
-     */
-    pz?: number;
-    /**
-     * 排序规则，按先后顺序放入，每个规则是一个元组，第一个元素是字段名称，第二个元素是顺序
-     */
-    orderBy?: Array<[keyof T, 'asc' | 'desc']>;
-}
-/**
- * mysql 分页查询结果
- */
-export interface MysqlPage<T> {
-    total: number;
-    list: T[];
-}
-export declare function paginate<T>(config: MysqlConfig, conn: PoolConnection, opts: MysqlPaginateOpts<T>): Promise<MysqlPage<T>>;
+import { PoolConnection } from 'mysql2';
+import { Table } from '../../table-info';
+import { MixCriteria } from './criteria';
+import { MysqlConfig } from '../../config';
+export interface MysqlPaginateOpts<T> {
+    /**
+     * 表
+     */
+    table: Table<T>;
+    /**
+     * 查询条件
+     * @param criteria
+     * @returns
+     */
+    criteria?: MixCriteria<T>;
+    /**
+     * 而码,默认1
+     */
+    pn?: number;
+    /**
+     * 每页的数据量大小,默认 20, 必须在 1-1000 之间
+     */
+    pz?: number;
+    /**
+     * 排序规则，按先后顺序放入，每个规则是一个元组，第一个元素是字段名称，第二个元素是顺序
+     */
+    orderBy?: Array<[keyof T, 'asc' | 'desc']>;
+}
+/**
+ * mysql 分页查询结果
+ */
+export interface MysqlPage<T> {
+    total: number;
+    list: T[];
+}
+export declare function paginate<T>(config: MysqlConfig, conn: PoolConnection, opts: MysqlPaginateOpts<T>): Promise<MysqlPage<T>>;

package/types/mysql/manager/ops/query.d.ts

@@ -1,3 +1,3 @@
-import { PoolConnection } from 'mysql2';
-import { MysqlConfig } from '../../config';
-export declare function query<T>(config: MysqlConfig, connection: PoolConnection, sql: string, values?: any[]): Promise<T[]>;
+import { PoolConnection } from 'mysql2';
+import { MysqlConfig } from '../../config';
+export declare function query<T>(config: MysqlConfig, connection: PoolConnection, sql: string, values?: any[]): Promise<T[]>;

package/types/mysql/manager/ops/update.d.ts

@@ -1,76 +1,76 @@
-import { PoolConnection } from 'mysql2';
-import { Table } from '../../table-info';
-import { MixCriteria } from './criteria';
-import { MysqlConfig } from '../../config';
-/**
- * 更新
- * @param config
- * @param connection
- * @param mapping
- * @param data
- * @returns
- */
-export declare function update<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>, data: T): Promise<T>;
-/**
- * 更新器
- */
-export type Updater<T> = Partial<{
-    [key in keyof T]: T[key] | undefined | ['setNull'] | ['inc', number]
-    /**
-     * 设置一个字段的值，和直接赋值是一样的，作用是解决一些特殊的情况的冲突
-     * 比如将 json 字段的值设置为 ['setNull'] ,这就会被认为是要置空，
-     * 使用 ['set',['setNull']] 就可以解决这个问题
-     */
-     | ['set', T[key]];
-}>;
-/**
- * 部分更新
- * @param connection
- * @param mapping
- * @param type
- * @param data
- */
-export declare function partialUpdate<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>, data: Updater<T>): Promise<boolean>;
-/**
- * 更新指定的一条记录
- * @param config
- * @param connection
- * @param table
- * @param query
- * @param data
- */
-export declare function updateOne<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>, query: MixCriteria<T>, updater: Updater<T>): Promise<boolean>;
-/**
- * 更新选项
- */
-export interface UpdateOpts<T> {
-    /**
-     * 表
-     */
-    table: Table<T>;
-    /**
-     * 查询条件
-     */
-    query: MixCriteria<T>;
-    /**
-     * 限制数量
-     */
-    limit?: number;
-    /**
-     * 排序规则，按先后顺序放入，每个规则是一个元组，第一个元素是字段名称，第二个元素是顺序
-     */
-    orderBy?: Array<[keyof T, 'asc' | 'desc']>;
-    /**
-     * 更新设置
-     */
-    updater: Updater<T>;
-}
-/**
- * 更新所有匹配条件的记录
- * @param config
- * @param connection 连接
- * @param table 表
- * @param query 查询条件
- * @param updater 更新操作，支持置空和递增（需要使用元组）
- */
-export declare function updateMany<T>(config: MysqlConfig, connection: PoolConnection, opts: UpdateOpts<T>): Promise<number>;
+import { PoolConnection } from 'mysql2';
+import { Table } from '../../table-info';
+import { MixCriteria } from './criteria';
+import { MysqlConfig } from '../../config';
+/**
+ * 更新
+ * @param config
+ * @param connection
+ * @param mapping
+ * @param data
+ * @returns
+ */
+export declare function update<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>, data: T): Promise<T>;
+/**
+ * 更新器
+ */
+export type Updater<T> = Partial<{
+    [key in keyof T]: T[key] | undefined | ['setNull'] | ['inc', number]
+    /**
+     * 设置一个字段的值，和直接赋值是一样的，作用是解决一些特殊的情况的冲突
+     * 比如将 json 字段的值设置为 ['setNull'] ,这就会被认为是要置空，
+     * 使用 ['set',['setNull']] 就可以解决这个问题
+     */
+     | ['set', T[key]];
+}>;
+/**
+ * 部分更新
+ * @param connection
+ * @param mapping
+ * @param type
+ * @param data
+ */
+export declare function partialUpdate<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>, data: Updater<T>): Promise<boolean>;
+/**
+ * 更新指定的一条记录
+ * @param config
+ * @param connection
+ * @param table
+ * @param query
+ * @param data
+ */
+export declare function updateOne<T>(config: MysqlConfig, connection: PoolConnection, table: Table<T>, query: MixCriteria<T>, updater: Updater<T>): Promise<boolean>;
+/**
+ * 更新选项
+ */
+export interface UpdateOpts<T> {
+    /**
+     * 表
+     */
+    table: Table<T>;
+    /**
+     * 查询条件
+     */
+    query: MixCriteria<T>;
+    /**
+     * 限制数量
+     */
+    limit?: number;
+    /**
+     * 排序规则，按先后顺序放入，每个规则是一个元组，第一个元素是字段名称，第二个元素是顺序
+     */
+    orderBy?: Array<[keyof T, 'asc' | 'desc']>;
+    /**
+     * 更新设置
+     */
+    updater: Updater<T>;
+}
+/**
+ * 更新所有匹配条件的记录
+ * @param config
+ * @param connection 连接
+ * @param table 表
+ * @param query 查询条件
+ * @param updater 更新操作，支持置空和递增（需要使用元组）
+ */
+export declare function updateMany<T>(config: MysqlConfig, connection: PoolConnection, opts: UpdateOpts<T>): Promise<number>;

package/types/mysql/manager/ops/utils.d.ts

@@ -1,5 +1,5 @@
-/**
- * 处理列的值，对特殊类型 json 进行加工处理后返回
- * @param value
- */
-export declare function processColumnValue(value: any): any;
+/**
+ * 处理列的值，对特殊类型 json 进行加工处理后返回
+ * @param value
+ */
+export declare function processColumnValue(value: any): any;

package/types/mysql/manager/tx-strict.d.ts

@@ -1,36 +1,36 @@
-import { PoolConnection } from 'mysql2';
-import { MysqlConfig } from '../config';
-import { MysqlTxSession } from './tx';
-import { Table } from '../table-info';
-import { DeleteManyOpts, FindOpts, FindSelectOpts, MixCriteria, MysqlPage, MysqlPaginateOpts, UpdateOpts, Updater } from './ops';
-/**
- * 严格 mysql 事务会话，会禁用一些操作.
- */
-export declare class MysqlStrictTxSession extends MysqlTxSession {
-    #private;
-    private config;
-    constructor(config: MysqlConfig, conn: PoolConnection);
-    findById<T>(table: Table<T>, id: string | number): Promise<T | null>;
-    findByIdIn<T>(table: Table<T>, ids: (string | number)[]): Promise<T[]>;
-    existsBy<T>(table: Table<T>, criteria?: MixCriteria<T> | undefined): Promise<boolean>;
-    existsById<T>(table: Table<T>, id: string | number): Promise<boolean>;
-    deleteById<T>(table: Table<T>, id: string | number): Promise<boolean>;
-    deleteOne<T>(table: Table<T>, criteria: Partial<T>): Promise<boolean>;
-    deleteMany<T>(opts: DeleteManyOpts<T>): Promise<number>;
-    findAll<T>(table: Table<T>): Promise<T[]>;
-    findFirst<T>(table: Table<T>, criteria?: MixCriteria<T> | undefined): Promise<T | null>;
-    insert<T>(table: Table<T>, data: T): Promise<T>;
-    insertMany<T>(table: Table<T>, list: T[]): Promise<void>;
-    update<T>(table: Table<T>, data: T): Promise<T>;
-    updateMany<T>(opts: UpdateOpts<T>): Promise<number>;
-    updateOne<T>(table: Table<T>, query: Partial<T>, updater: Partial<{
-        [key in keyof T]: ['setNull'] | ['inc', number] | T[key] | undefined;
-    }>): Promise<boolean>;
-    partialUpdate<T>(table: Table<T>, data: Updater<T>): Promise<boolean>;
-    find<T>(opts: FindOpts<T>): Promise<T[]>;
-    findSelect<T, K extends keyof T>(opts: FindSelectOpts<T, K>): Promise<Pick<T, K>[]>;
-    count<T>(table: Table<T>, criteria?: MixCriteria<T> | undefined): Promise<number>;
-    paginate<T>(opts: MysqlPaginateOpts<T>): Promise<MysqlPage<T>>;
-    query<T>(sql: string, values?: any[] | undefined): Promise<T[]>;
-    modify(sql: string, values?: any[] | undefined): Promise<number>;
-}
+import { PoolConnection } from 'mysql2';
+import { MysqlConfig } from '../config';
+import { MysqlTxSession } from './tx';
+import { Table } from '../table-info';
+import { DeleteManyOpts, FindOpts, FindSelectOpts, MixCriteria, MysqlPage, MysqlPaginateOpts, UpdateOpts, Updater } from './ops';
+/**
+ * 严格 mysql 事务会话，会禁用一些操作.
+ */
+export declare class MysqlStrictTxSession extends MysqlTxSession {
+    #private;
+    private config;
+    constructor(config: MysqlConfig, conn: PoolConnection);
+    findById<T>(table: Table<T>, id: string | number): Promise<T | null>;
+    findByIdIn<T>(table: Table<T>, ids: (string | number)[]): Promise<T[]>;
+    existsBy<T>(table: Table<T>, criteria?: MixCriteria<T> | undefined): Promise<boolean>;
+    existsById<T>(table: Table<T>, id: string | number): Promise<boolean>;
+    deleteById<T>(table: Table<T>, id: string | number): Promise<boolean>;
+    deleteOne<T>(table: Table<T>, criteria: Partial<T>): Promise<boolean>;
+    deleteMany<T>(opts: DeleteManyOpts<T>): Promise<number>;
+    findAll<T>(table: Table<T>): Promise<T[]>;
+    findFirst<T>(table: Table<T>, criteria?: MixCriteria<T> | undefined): Promise<T | null>;
+    insert<T>(table: Table<T>, data: T): Promise<T>;
+    insertMany<T>(table: Table<T>, list: T[]): Promise<void>;
+    update<T>(table: Table<T>, data: T): Promise<T>;
+    updateMany<T>(opts: UpdateOpts<T>): Promise<number>;
+    updateOne<T>(table: Table<T>, query: Partial<T>, updater: Partial<{
+        [key in keyof T]: ['setNull'] | ['inc', number] | T[key] | undefined;
+    }>): Promise<boolean>;
+    partialUpdate<T>(table: Table<T>, data: Updater<T>): Promise<boolean>;
+    find<T>(opts: FindOpts<T>): Promise<T[]>;
+    findSelect<T, K extends keyof T>(opts: FindSelectOpts<T, K>): Promise<Pick<T, K>[]>;
+    count<T>(table: Table<T>, criteria?: MixCriteria<T> | undefined): Promise<number>;
+    paginate<T>(opts: MysqlPaginateOpts<T>): Promise<MysqlPage<T>>;
+    query<T>(sql: string, values?: any[] | undefined): Promise<T[]>;
+    modify(sql: string, values?: any[] | undefined): Promise<number>;
+}

package/types/mysql/manager/tx.d.ts

@@ -1,15 +1,15 @@
-import { PoolConnection } from 'mysql2';
-import { BaseMysqlManager } from './base';
-import { MysqlConfig } from '../config';
-/**
- * mysql 事务会话.
- */
-export declare class MysqlTxSession extends BaseMysqlManager {
-    #private;
-    constructor(config: MysqlConfig, conn: PoolConnection);
-    protected queryWithConnection<T>(queryFn: (conn: PoolConnection) => Promise<T>): Promise<T>;
-    /**
-     * 中止，被中止后的会话不能再进行任何操作
-     */
-    abort(): void;
-}
+import { PoolConnection } from 'mysql2';
+import { BaseMysqlManager } from './base';
+import { MysqlConfig } from '../config';
+/**
+ * mysql 事务会话.
+ */
+export declare class MysqlTxSession extends BaseMysqlManager {
+    #private;
+    constructor(config: MysqlConfig, conn: PoolConnection);
+    protected queryWithConnection<T>(queryFn: (conn: PoolConnection) => Promise<T>): Promise<T>;
+    /**
+     * 中止，被中止后的会话不能再进行任何操作
+     */
+    abort(): void;
+}

package/types/mysql/manager/utils.d.ts

@@ -1,17 +1,17 @@
-import { Connection, OkPacket, Pool, PoolConnection, ResultSetHeader, RowDataPacket } from 'mysql2';
-import { MysqlConfig } from '../config';
-/**
- * 查询，适用于各种 sql 的执行
- * @param config
- * @param conn
- * @param sql
- * @param values
- * @returns
- */
-export declare function promiseQuery(config: MysqlConfig, conn: Connection, sql: string, values?: any[]): Promise<OkPacket | ResultSetHeader | RowDataPacket[] | [RowDataPacket[], ResultSetHeader] | ResultSetHeader[] | RowDataPacket[][] | OkPacket[]>;
-/**
- * 获取连接
- * @param pool
- * @returns
- */
-export declare function promiseGetConnection(pool: Pool): Promise<PoolConnection>;
+import { Connection, OkPacket, Pool, PoolConnection, ResultSetHeader, RowDataPacket } from 'mysql2';
+import { MysqlConfig } from '../config';
+/**
+ * 查询，适用于各种 sql 的执行
+ * @param config
+ * @param conn
+ * @param sql
+ * @param values
+ * @returns
+ */
+export declare function promiseQuery(config: MysqlConfig, conn: Connection, sql: string, values?: any[]): Promise<OkPacket | ResultSetHeader | RowDataPacket[] | [RowDataPacket[], ResultSetHeader] | ResultSetHeader[] | RowDataPacket[][] | OkPacket[]>;
+/**
+ * 获取连接
+ * @param pool
+ * @returns
+ */
+export declare function promiseGetConnection(pool: Pool): Promise<PoolConnection>;

package/types/mysql/migration.d.ts

@@ -1,8 +1,8 @@
-import { Connection } from 'mysql2';
-import { MysqlConfig } from './config';
-/**
- * 迁移.
- * @param config
- * @param conn
- */
-export declare function migrate(config: MysqlConfig, conn: Connection): Promise<void>;
+import { Connection } from 'mysql2';
+import { MysqlConfig } from './config';
+/**
+ * 迁移.
+ * @param config
+ * @param conn
+ */
+export declare function migrate(config: MysqlConfig, conn: Connection): Promise<void>;

package/types/mysql/table-info.d.ts

@@ -1,36 +1,36 @@
-import { ValidationOpts } from '../validation';
-/**
- * 表信息. 表的字段分为三个部分：主键、普通列、时间列，分别对应的属性是：id、columns
- * 和 createDate 还有 updatedDate，这三部分配置的字段名称不允许有重叠，否则会产生错误.
- */
-export interface Table<T> {
-    /**
-     * 表名.
-     */
-    tableName: string;
-    /**
-     * id 字段名称.
-     */
-    id: keyof T;
-    /**
-     * 列字段名称.只有配置了名称的字段才会参与数据库的查询与更新，没有配置的其它字段可作其它用途。
-     * 注意：columns 配置的字段不能和 id 或更新时间和创建时间重叠，否则在更新时产生错误，将数据改错。
-     * 程序本身是不会做检查的，编写的时候必须要注意。
-     */
-    columns: Array<keyof T>;
-    /**
-     * 创建时间字段信息.
-     */
-    createdDate?: {
-        column: keyof T;
-        type: 'number' | 'date';
-    };
-    /**
-     * 更新时间字段信息.
-     */
-    updatedDate?: {
-        column: keyof T;
-        type: 'number' | 'date';
-    };
-}
-export declare const tableValidation: ValidationOpts<Table<any>>;
+import { ValidationOpts } from '../validation';
+/**
+ * 表信息. 表的字段分为三个部分：主键、普通列、时间列，分别对应的属性是：id、columns
+ * 和 createDate 还有 updatedDate，这三部分配置的字段名称不允许有重叠，否则会产生错误.
+ */
+export interface Table<T> {
+    /**
+     * 表名.
+     */
+    tableName: string;
+    /**
+     * id 字段名称.
+     */
+    id: keyof T;
+    /**
+     * 列字段名称.只有配置了名称的字段才会参与数据库的查询与更新，没有配置的其它字段可作其它用途。
+     * 注意：columns 配置的字段不能和 id 或更新时间和创建时间重叠，否则在更新时产生错误，将数据改错。
+     * 程序本身是不会做检查的，编写的时候必须要注意。
+     */
+    columns: Array<keyof T>;
+    /**
+     * 创建时间字段信息.
+     */
+    createdDate?: {
+        column: keyof T;
+        type: 'number' | 'date';
+    };
+    /**
+     * 更新时间字段信息.
+     */
+    updatedDate?: {
+        column: keyof T;
+        type: 'number' | 'date';
+    };
+}
+export declare const tableValidation: ValidationOpts<Table<any>>;

package/types/task/daily.d.ts

@@ -1,16 +1,16 @@
-import { Task, TaskController } from './task';
-/**
- * 每日任务.
- * @param hours 时
- * @param minutes 分
- * @param task 要执行的任务
- * @param timeout 任务超时时间，单位毫秒
- * @returns
- */
-export declare function scheduleDailyTask(hours: number, minutes: number, task: Task, timeout?: number): TaskController;
-/**
- * 计算到下次指定时间点的延迟
- * @param hours
- * @param minutes
- */
-export declare function dailyTaskDelay(hours: number, minutes: number): number;
+import { Task, TaskController } from './task';
+/**
+ * 每日任务.
+ * @param hours 时
+ * @param minutes 分
+ * @param task 要执行的任务
+ * @param timeout 任务超时时间，单位毫秒
+ * @returns
+ */
+export declare function scheduleDailyTask(hours: number, minutes: number, task: Task, timeout?: number): TaskController;
+/**
+ * 计算到下次指定时间点的延迟
+ * @param hours
+ * @param minutes
+ */
+export declare function dailyTaskDelay(hours: number, minutes: number): number;

package/types/task/fixed-delay.d.ts

@@ -1,9 +1,9 @@
-import { Task, TaskController } from './task';
-/**
- * 固定延迟执行任务
- * @param initialDelay  第一次执行延迟的时间，单位秒
- * @param delay 每次的延迟时间，单位秒
- * @param task 任务
- * @param timeout 任务超时时间，单位毫秒
- */
-export declare function scheduleWithFixedDelay(initialDelay: number, delay: number, task: Task, timeout?: number): TaskController;
+import { Task, TaskController } from './task';
+/**
+ * 固定延迟执行任务
+ * @param initialDelay  第一次执行延迟的时间，单位秒
+ * @param delay 每次的延迟时间，单位秒
+ * @param task 任务
+ * @param timeout 任务超时时间，单位毫秒
+ */
+export declare function scheduleWithFixedDelay(initialDelay: number, delay: number, task: Task, timeout?: number): TaskController;

package/types/task/fixed-rate.d.ts

@@ -1,9 +1,9 @@
-import { Task, TaskController } from './task';
-/**
- * 固定延迟执行任务
- * @param initialDelay  第一次执行延迟的时间，单位秒
- * @param period 每次的延迟时间，单位秒
- * @param task 任务
- * @param timeout 任务超时时间，单位毫秒
- */
-export declare function scheduleWithFixedRate(initialDelay: number, period: number, task: Task, timeout?: number): TaskController;
+import { Task, TaskController } from './task';
+/**
+ * 固定延迟执行任务
+ * @param initialDelay  第一次执行延迟的时间，单位秒
+ * @param period 每次的延迟时间，单位秒
+ * @param task 任务
+ * @param timeout 任务超时时间，单位毫秒
+ */
+export declare function scheduleWithFixedRate(initialDelay: number, period: number, task: Task, timeout?: number): TaskController;

package/types/task/index.d.ts

@@ -1,4 +1,4 @@
-export { Task, TaskController } from './task';
-export * from './fixed-delay';
-export * from './fixed-rate';
-export * from './daily';
+export { Task, TaskController } from './task';
+export * from './fixed-delay';
+export * from './fixed-rate';
+export * from './daily';

package/types/task/task.d.ts

@@ -1,34 +1,34 @@
-/**
- * 任务.
- */
-export interface Task {
-    /**
-     * 任务的名称，用于跟踪任务的执行情况，定位错误.
-     * 当任务执行时间过长或任务失败时，相关的错误提示信息会显示名称，以便于排查.
-     */
-    name: string;
-    /**
-     * 任务运行.
-     * @returns
-     */
-    run: () => Promise<void>;
-}
-/**
- * 任务控制器
- */
-export declare class TaskController {
-    #private;
-    isStopped(): boolean;
-    stop(): void;
-}
-/**
- * 任务执行，封装任务执行过程中的一些通用信息输出和异常控制.
- * @param task
- * @param timeout 任务超时时间，单位毫秒
- * @returns
- */
-export declare function execTask(task: Task, timeout?: number): Promise<{
-    start: number;
-    cost: number;
-    end: number;
-}>;
+/**
+ * 任务.
+ */
+export interface Task {
+    /**
+     * 任务的名称，用于跟踪任务的执行情况，定位错误.
+     * 当任务执行时间过长或任务失败时，相关的错误提示信息会显示名称，以便于排查.
+     */
+    name: string;
+    /**
+     * 任务运行.
+     * @returns
+     */
+    run: () => Promise<void>;
+}
+/**
+ * 任务控制器
+ */
+export declare class TaskController {
+    #private;
+    isStopped(): boolean;
+    stop(): void;
+}
+/**
+ * 任务执行，封装任务执行过程中的一些通用信息输出和异常控制.
+ * @param task
+ * @param timeout 任务超时时间，单位毫秒
+ * @returns
+ */
+export declare function execTask(task: Task, timeout?: number): Promise<{
+    start: number;
+    cost: number;
+    end: number;
+}>;