@wzyjs/types 0.0.28

package/dist/esm/rd/database/types.d.ts

@@ -0,0 +1,151 @@
+import { Database, ICountRes } from '@cloudbase/node-sdk';
+export interface Config {
+    env: string;
+    secretId: string;
+    secretKey: string;
+}
+export type IdConditions = {
+    _id: string;
+    field?: string[] | {
+        [key: string]: false;
+    };
+    options?: {
+        timeout: number;
+        multiple?: false;
+    };
+};
+export declare enum Command {
+    Eq = "eq",
+    Neq = "neq",
+    Lt = "lt",
+    Lte = "lte",
+    Gt = "gt",
+    Gte = "gte",
+    In = "in",
+    Nin = "nin",
+    Gtlt = "gtlt"
+}
+export type CommandWhere = {
+    type: Command.Eq;
+    value: any;
+} | {
+    type: Command.Neq;
+    value: any;
+} | {
+    type: Command.Gt;
+    value: number;
+} | {
+    type: Command.Gte;
+    value: number;
+} | {
+    type: Command.Lt;
+    value: number;
+} | {
+    type: Command.Lte;
+    value: number;
+} | {
+    type: Command.Gtlt;
+    value: number[];
+} | {
+    type: Command.In;
+    value: any[];
+} | {
+    type: Command.Nin;
+    value: any[];
+};
+export type WhereConditions = {
+    where?: {
+        [key: string]: any | CommandWhere;
+    };
+    field?: string[] | {
+        [key: string]: false;
+    };
+    page?: {
+        size?: number;
+        current?: number;
+    };
+    order?: {
+        field: string;
+        type?: 'asc' | 'desc';
+    };
+    options?: {
+        timeout?: number;
+        multiple?: boolean;
+    };
+};
+export type Conditions = IdConditions | WhereConditions;
+export declare enum Method {
+    Add = "add",
+    Find = "find",
+    FindList = "findList",
+    Delete = "delete",
+    Update = "update",
+    Count = "count"
+}
+export declare namespace Add {
+    type Params<D> = {
+        method: Method.Add;
+        data: D;
+        conditions?: Pick<IdConditions, 'field'>;
+        isReturn?: true;
+    };
+    type Res = {
+        id: string;
+    };
+}
+export declare namespace Find {
+    type Params = {
+        method: Method.Find;
+        conditions?: Conditions;
+    };
+    type Res<D> = Record<D> | undefined;
+}
+export declare namespace FindList {
+    type Params = {
+        method: Method.FindList;
+        conditions?: WhereConditions;
+    };
+    type Res<D> = {
+        list?: Record<D>[];
+        total?: number;
+    };
+}
+export declare namespace Delete {
+    type Params = {
+        method: Method.Delete;
+        conditions: Conditions;
+    };
+    type Res = {
+        deleted: number | string;
+    };
+}
+export declare namespace Update {
+    type Params<D> = {
+        method: Method.Update;
+        conditions: Conditions;
+        data: Partial<Record<D>>;
+        isReturn?: true;
+        isSet?: true;
+    };
+    type Res<D> = {
+        updated?: number;
+        doc?: D;
+    };
+}
+export declare namespace Count {
+    type Params = {
+        method: Method.Count;
+        conditions?: WhereConditions;
+    };
+    type Res = {
+        total?: number;
+    };
+}
+export type MethodParams<D> = Add.Params<D> | Find.Params | FindList.Params | Delete.Params | Update.Params<D> | Count.Params;
+export type MethodRes<D> = Add.Res | Find.Res<D> | FindList.Res<D> | Delete.Res | Update.Res<D> | Count.Res;
+export type IRes = Database.IAddRes | Database.IGetRes | Database.IDeleteResult | Database.IUpdateResult | ICountRes;
+export type Record<D> = D & {
+    _id: string;
+    createAt: number;
+    updateAt: number;
+};

package/dist/esm/rd/database/utils.d.ts

@@ -0,0 +1,3 @@
+import { Conditions } from './types';
+export declare const appendTime: <D>(data: D, type: 'create' | 'update') => D;
+export declare const defaultConditions: Conditions;

package/dist/esm/rd/index.d.ts

@@ -0,0 +1,3 @@
+export * from './database';
+export * from './jsonFile';
+export * from './mail';

package/dist/esm/rd/jsonFile/index.d.ts

@@ -0,0 +1,6 @@
+export declare class JsonFile {
+    filePath: string;
+    constructor(filePath: string);
+    get(key: string): Promise<unknown>;
+    set(key: string, value: any): void;
+}

package/dist/esm/rd/mail/index.d.ts

@@ -0,0 +1 @@
+export declare const sendMail: (toEmail: string, title: string, content?: string) => Promise<string>;

package/index.ts

@@ -0,0 +1,40 @@
+// 接口响应的类型
+export interface RequestRes<D = any> {
+  success: boolean,
+  message: string,
+  data: D,
+}
+
+// 键值对的类型
+export type KeyValue<D extends object | string = string, V = any> = Partial<Record<D extends string ? string : keyof D, V>>
+
+// 分页的类型
+export interface Pagination {
+  current?: number,
+  pageSize?: number,
+}
+
+// 前端排序参数的类型
+export type SortParams<D extends object | string = string> = Record<D extends string ? string : keyof D, 'ascend' | 'descend'>
+
+// 后端排序参数的类型
+export type OrderParams<D extends object | string = string> = {
+  field: D extends string ? string : keyof D,
+  type: 'asc' | 'desc'
+}
+
+// 选项
+export interface Option<V extends string | number = string> {
+  label: string,
+  value: V,
+  children?: Option<V>[],
+}
+
+// 排序参数的类型
+export type OrderBy = { [key: string]: 'asc' | 'desc' } | { [key: string]: 'asc' | 'desc' }[]
+
+// 将指定 key 设为可选
+export type Optional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>
+
+// 将指定类型排除、将指定类型设为可选
+export type Set<T, OmitK extends keyof T = never, OptionalK extends Exclude<keyof T, OmitK> = never> = Optional<Omit<T, OmitK>, OptionalK>

package/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@wzyjs/types",
+  "version": "0.0.28",
+  "description": "description",
+  "author": "wzy",
+  "license": "ISC",
+  "typings": "index.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitee.com/wang-zhenyu/app.git"
+  },
+  "gitHead": "b27e8d285e4092485cd1be538c1f571bc29e7835"
+}