@airpower/web 0.1.3 → 0.2.1

package/dist/model/export/ExportModel.d.ts

@@ -0,0 +1,24 @@
+import { QueryRequest } from '../query';
+import { Transformer } from '@airpower/transformer';
+/**
+ * # 导出的数据模型
+ * @author Hamm.cn
+ */
+export declare class ExportModel<R extends QueryRequest = QueryRequest> extends Transformer {
+    /**
+     * ### 创建导出任务的API地址
+     */
+    createExportTaskUrl: string;
+    /**
+     * ### 查询导出结果的 `API` 地址
+     */
+    queryExportUrl: string;
+    /**
+     * ### 请求的参数
+     */
+    param: R;
+    /**
+     * ### 下载导出文件的临时令牌
+     */
+    fileCode: string;
+}

package/dist/model/export/index.d.ts

@@ -0,0 +1 @@
+export * from './ExportModel';

package/dist/model/index.d.ts

@@ -0,0 +1,3 @@
+export * from './export';
+export * from './query';
+export * from './tree';

package/dist/model/query/QueryPage.d.ts

@@ -0,0 +1,15 @@
+import { Transformer } from '@airpower/transformer';
+/**
+ * # 分页类
+ * @author Hamm.cn
+ */
+export declare class QueryPage extends Transformer {
+    /**
+     * ### 分页页数
+     */
+    pageNum: number;
+    /**
+     * ### 每页数量
+     */
+    pageSize: number;
+}

package/dist/model/query/QueryRequest.d.ts

@@ -0,0 +1,27 @@
+import { ITransformerConstructor, Transformer } from '@airpower/transformer';
+import { RootEntity } from '../../base';
+import { QuerySort } from './QuerySort';
+/**
+ * # 请求类
+ * @author Hamm.cn
+ */
+export declare class QueryRequest<E extends RootEntity = RootEntity> extends Transformer {
+    /**
+     * ### 查询信息
+     */
+    filter: E;
+    /**
+     * ### 排序信息
+     */
+    sort?: QuerySort;
+    /**
+     * ### 初始化一个请求类
+     * @param filterClass 如传入 `filter` 的类 将自动初始化一个空 `filter`
+     */
+    constructor(filterClass: ITransformerConstructor<E>);
+    /**
+     * ### 设置排序对象
+     * @param sort 排序对象
+     */
+    setSort(sort: QuerySort): this;
+}

package/dist/model/query/QueryRequestPage.d.ts

@@ -0,0 +1,13 @@
+import { RootEntity } from '../../base';
+import { QueryPage } from './QueryPage';
+import { QueryRequest } from './QueryRequest';
+/**
+ * # 请求分页类
+ * @author Hamm.cn
+ */
+export declare class QueryRequestPage<E extends RootEntity> extends QueryRequest<E> {
+    /**
+     * ### 分页信息
+     */
+    page: QueryPage;
+}

package/dist/model/query/QueryResponsePage.d.ts

@@ -0,0 +1,30 @@
+import { RootEntity } from '../../base';
+import { Transformer } from '@airpower/transformer';
+import { QueryPage } from './QueryPage';
+import { QuerySort } from './QuerySort';
+/**
+ * # 响应分页类
+ * @author Hamm.cn
+ */
+export declare class QueryResponsePage<E extends RootEntity> extends Transformer {
+    /**
+     * ### 返回的当前页数据列表
+     */
+    list: E[];
+    /**
+     * ### 返回的页码信息
+     */
+    page: QueryPage;
+    /**
+     * ### 返回的排序信息
+     */
+    sort: QuerySort;
+    /**
+     * ### 返回总条数
+     */
+    total: number;
+    /**
+     * ### 返回总页数
+     */
+    pageCount: number;
+}

package/dist/model/query/QuerySort.d.ts

@@ -0,0 +1,26 @@
+import { SortType } from './type';
+import { Transformer } from '@airpower/transformer';
+/**
+ * # 排序类
+ * @author Hamm.cn
+ */
+export declare class QuerySort extends Transformer {
+    /**
+     * ### 排序字段 默认 `id`
+     */
+    field: string;
+    /**
+     * ### 排序方式 默认 `desc`
+     */
+    direction: SortType;
+    /**
+     * ### 设置排序字段名
+     * @param field 字段名
+     */
+    setField(field: string): this;
+    /**
+     * ### 设置排序方向
+     * @param direction 方向
+     */
+    setDirection(direction: SortType): this;
+}

package/dist/model/query/index.d.ts

@@ -0,0 +1,6 @@
+export * from './QueryPage';
+export * from './QueryRequest';
+export * from './QueryRequestPage';
+export * from './QueryResponsePage';
+export * from './QuerySort';
+export * from './type';

package/dist/model/query/type.d.ts

@@ -0,0 +1,4 @@
+/**
+ * ### 排序方向
+ */
+export type SortType = 'desc' | 'asc';

package/dist/model/tree/ITree.d.ts

@@ -0,0 +1,21 @@
+import { IEntity } from '../../base';
+/**
+ * # 树形结构
+ *
+ * @author Hamm.cn
+ */
+export interface ITree extends IEntity {
+    /**
+     * ### 树的子节点
+     * 为了成功的数据转换,请注意自行 `@Type`
+     */
+    children: this[];
+    /**
+     * ### 父节点 `ID`
+     */
+    parentId?: number;
+    /**
+     * ### 名称
+     */
+    name: string;
+}

package/dist/model/tree/index.d.ts

@@ -0,0 +1 @@
+export * from './ITree';

package/dist/type/index.d.ts

@@ -0,0 +1 @@
+export type ClassConstructor<T> = new (...args: unknown[]) => T;

package/dist/util/feedback/FeedbackUtil.d.ts

@@ -0,0 +1,97 @@
+import { FeedbackType } from './type';
+/**
+ * ### 弹窗工具
+ * @author Hamm.cn
+ */
+export declare class FeedbackUtil {
+    static defaultToastDuration: number;
+    /**
+     * ### 警告吐司
+     * @param message 消息
+     */
+    static toastWarning(message: string): void;
+    /**
+     * ### 信息吐司
+     * @param message 消息
+     */
+    static toastInfo(message: string): void;
+    /**
+     * ### 成功吐司
+     * @param message 消息
+     */
+    static toastSuccess(message: string): void;
+    /**
+     * ### 错误吐司
+     * @param message 错误
+     */
+    static toastError(message: string): void;
+    /**
+     * ### 显示吐司
+     * @param message 消息
+     * @param type 类型
+     * @param duration 显示时长
+     */
+    static showToast(message: string, type?: FeedbackType, duration?: number): void;
+    /**
+     * ### 显示确认窗
+     * @param message 消息
+     * @param title 标题
+     * @param type 类型
+     */
+    static showConfirm(message: string, title?: string, type?: FeedbackType): Promise<void>;
+    /**
+     * ### 显示成功确认
+     * @param message 消息
+     * @param title 标题
+     */
+    static confirmSuccess(message: string, title?: string): Promise<void>;
+    /**
+     * ### 显示错误确认
+     * @param message 消息
+     * @param title 标题
+     */
+    static confirmError(message: string, title?: string): Promise<void>;
+    /**
+     * ### 显示警告确认
+     * @param message 消息
+     * @param title 标题
+     */
+    static confirmWarning(message: string, title?: string): Promise<void>;
+    /**
+     * ### 显示信息确认
+     * @param message 消息
+     * @param title 标题
+     */
+    static confirmInfo(message: string, title?: string): Promise<void>;
+    /**
+     * ### 显示弹窗
+     * @param message 消息
+     * @param title 标题
+     * @param type 类型
+     */
+    static showAlert(message: string, title?: string, type?: FeedbackType): Promise<void>;
+    /**
+     * ### 显示弹窗成功
+     * @param message 消息
+     * @param title 标题
+     */
+    static alertSuccess(message: string, title?: string): Promise<void>;
+    /**
+     * ### 显示弹窗错误
+     * @param message 消息
+     * @param title 标题
+     */
+    static alertError(message: string, title?: string): Promise<void>;
+    /**
+     * ### 显示弹窗警告
+     * @param message 消息
+     * @param title 标题
+     */
+    static alertWarning(message: string, title?: string): Promise<void>;
+    /**
+     * ### 显示弹窗信息
+     * @param message 消息
+     * @param title 标题
+     */
+    static alertInfo(message: string, title?: string): Promise<void>;
+}

package/dist/util/feedback/index.d.ts

@@ -0,0 +1,2 @@
+export * from './FeedbackUtil';
+export * from './type';

package/dist/util/feedback/type.d.ts

@@ -0,0 +1 @@
+export type FeedbackType = 'info' | 'success' | 'warning' | 'error' | undefined;

package/dist/util/file/IFile.d.ts

@@ -0,0 +1,10 @@
+/**
+ * # 文件接口
+ * @author Hamm.cn
+ */
+export interface IFile {
+    /**
+     * ### 文件路径
+     */
+    url: string;
+}

package/dist/util/file/WebFileUtil.d.ts

@@ -0,0 +1,11 @@
+/**
+ * # 文件助手类
+ * @author Hamm.cn
+ */
+export declare class WebFileUtil {
+    /**
+     * ### 获取静态文件的绝对地址
+     * @param url 地址
+     */
+    static getStaticFileUrl(url: string): string;
+}

package/dist/util/file/index.d.ts

@@ -0,0 +1 @@
+export * from './IFile';

package/dist/util/http/Http.d.ts

@@ -0,0 +1,121 @@
+import { IJson, ITransformerConstructor, Transformer } from '@airpower/transformer';
+import { HttpContentType, HttpHeader, HttpMethod } from './enum';
+import { HttpResponse } from './HttpResponse';
+/**
+ * # 网络请求类
+ *
+ * @author Hamm.cn
+ */
+export declare class Http {
+    /**
+     * ### HTTP 请求前缀
+     */
+    static readonly PREFIX_HTTP = "http://";
+    /**
+     * ### HTTPS 请求前缀
+     */
+    static readonly PREFIX_HTTPS = "https://";
+    /**
+     * ### 请求方法
+     */
+    private method;
+    /**
+     * ### URL
+     */
+    private url;
+    /**
+     * ### 请求超时时间
+     */
+    private timeout;
+    /**
+     * ### 是否携带 `Cookies`
+     */
+    private widthCookie;
+    /**
+     * ### 请求头
+     */
+    private headers;
+    /**
+     * ### 错误回调
+     */
+    private errorHandler?;
+    /**
+     * ### 加载回调
+     */
+    private loadingHandler?;
+    /**
+     * ### 是否直接抛出错误
+     */
+    private isThrowError;
+    /**
+     * ### 创建一个客户端
+     * @param url 请求的 `URL`
+     * @param handlers 监听器
+     * @param handlers.error 错误
+     * @param handlers.loading 加载
+     */
+    static create(url: string, handlers?: {
+        error?: (error: HttpResponse) => void;
+        loading?: (loading: boolean) => void;
+    }): Http;
+    /**
+     * ### 设置请求超时时间
+     * @param timeout 超时毫秒数
+     */
+    setTimeout(timeout: number): this;
+    /**
+     * ### 设置请求头
+     * @param header 请求头
+     */
+    setHttpHeader(header: Record<HttpHeader | string, unknown>): this;
+    /**
+     * ### 允许携带 `Cookies`
+     */
+    withCredentials(): this;
+    /**
+     * ### 添加一个请求头
+     * @param key 请求头 `key`
+     * @param value 请求头 `value`
+     */
+    addHttpHeader(key: HttpHeader | string, value: string): this;
+    /**
+     * ### 设置请求方法
+     * @param method 请求方法
+     */
+    setMethod(method: HttpMethod): this;
+    /**
+     * ### 设置请求`content-type`
+     * @param contentType `content-type`
+     */
+    setContentType(contentType: HttpContentType): this;
+    /**
+     * ### 发送请求并获取转换后的模型
+     * @param postData 请求的数据
+     * @param parseClass 返回的模型
+     */
+    post<REQ extends Transformer, RES extends Transformer>(postData: REQ | REQ[] | undefined, parseClass: ITransformerConstructor<RES>): Promise<RES>;
+    /**
+     * ### 发送请求并获取转换后的模型数组
+     * @param postData 请求的数据
+     * @param parseClass 返回的模型数组
+     */
+    postArray<REQ extends Transformer, RES extends Transformer>(postData: REQ | REQ[] | undefined, parseClass: ITransformerConstructor<RES>): Promise<RES[]>;
+    /**
+     * ### 是否直接抛出错误
+     * @param isThrowError 是否回调错误
+     */
+    throwError(isThrowError?: boolean): this;
+    /**
+     * ### POST 发送模型/模型数组并
+     * @param postData 发送的数据模型(数组)
+     */
+    request<T extends Transformer>(postData?: T | T[]): Promise<IJson | IJson[]>;
+    /**
+     * ### 发送请求
+     *
+     * @param body `可选` 请求体
+     * @see request() 直接发送 `POST`
+     * @see get() 直接发送 `GET`
+     */
+    private send;
+}

package/dist/util/http/HttpResponse.d.ts

@@ -0,0 +1,19 @@
+/**
+ * # Http请求的响应
+ *
+ * @author Hamm.cn
+ */
+export declare class HttpResponse {
+    /**
+     * ### 业务状态码
+     */
+    code: number;
+    /**
+     * ### 返回的数据
+     */
+    data: unknown;
+    /**
+     * ### 错误信息
+     */
+    message: string;
+}

package/dist/util/http/enum/HttpContentType.d.ts

@@ -0,0 +1,27 @@
+/**
+ * # ContentType
+ *
+ * @author Hamm.cn
+ */
+export declare enum HttpContentType {
+    /**
+     * ### JSON
+     */
+    JSON = "application/json",
+    /**
+     * ### 表单
+     */
+    FORM_URLENCODED = "application/x-www-form-urlencoded",
+    /**
+     * ### 文件上传
+     */
+    MULTIPART_FORM_DATA = "multipart/form-data",
+    /**
+     * ### XML
+     */
+    XML = "application/xml",
+    /**
+     * ### 纯文本
+     */
+    PLAIN = "text/plain"
+}

package/dist/util/http/enum/HttpHeader.d.ts

@@ -0,0 +1,15 @@
+/**
+ * # 常见请求头
+ *
+ * @author Hamm.cn
+ */
+export declare enum HttpHeader {
+    /**
+     * ### 请求内容类型
+     */
+    CONTENT_TYPE = "Content-Type",
+    /**
+     * ### 请求认证
+     */
+    AUTHORIZATION = "Authorization"
+}

package/dist/util/http/enum/HttpMethod.d.ts

@@ -0,0 +1,12 @@
+/**
+ * # 请求方法
+ *
+ * @author Hamm.cn
+ */
+export declare enum HttpMethod {
+    GET = "GET",
+    POST = "POST",
+    PUT = "PUT",
+    DELETE = "DELETE",
+    PATCH = "PATCH"
+}

package/dist/util/http/enum/HttpStatus.d.ts

@@ -0,0 +1,31 @@
+/**
+ * # HTTP 状态码
+ *
+ * @author Hamm.cn
+ */
+export declare enum HttpStatus {
+    /**
+     * ### 200 OK
+     */
+    OK = 200,
+    /**
+     * ### 400 Bad Request
+     */
+    BAD_REQUEST = 400,
+    /**
+     * ### 401 Unauthorized
+     */
+    UNAUTHORIZED = 401,
+    /**
+     * ### 403 Forbidden
+     */
+    FORBIDDEN = 403,
+    /**
+     * ### 404 Not Found
+     */
+    NOT_FOUND = 404,
+    /**
+     * ### 500 Internal Server Error
+     */
+    INTERNAL_SERVER_ERROR = 500
+}

package/dist/util/http/enum/index.d.ts

@@ -0,0 +1,4 @@
+export * from './HttpContentType';
+export * from './HttpHeader';
+export * from './HttpMethod';
+export * from './HttpStatus';

package/dist/util/http/index.d.ts

@@ -0,0 +1,4 @@
+export * from './enum';
+export * from './Http';
+export * from './HttpResponse';
+export * from './type';

package/dist/util/http/type.d.ts

@@ -0,0 +1,13 @@
+import { HttpHeader, HttpStatus } from './enum';
+/**
+ * # 请求头KEY类型
+ */
+export type HttpHeaderKey = HttpHeader | string;
+/**
+ * # 请求头记录
+ */
+export type HttpHeaderRecord = Record<HttpHeaderKey, unknown>;
+/**
+ * # 状态码类型
+ */
+export type HttpStatusNumber = HttpStatus | number;

package/dist/util/index.d.ts

@@ -1 +1,5 @@
-export * from './WebAccessTokenUtil';
+export * from './feedback';
+export * from './file';
+export * from './http';
+export * from './permission';
+export * from './validator';

package/dist/util/permission/PermissionAction.d.ts

@@ -0,0 +1,42 @@
+/**
+ * # 常用权限标识枚举
+ * @author Hamm.cn
+ */
+export declare enum PermissionAction {
+    /**
+     * ### 添加
+     */
+    ADD = "add",
+    /**
+     * ### 修改
+     */
+    EDIT = "update",
+    /**
+     * ### 删除
+     */
+    DELETE = "delete",
+    /**
+     * ### 详情
+     */
+    DETAIL = "getDetail",
+    /**
+     * ### 添加下级数据
+     */
+    ADD_CHILD = "addChild",
+    /**
+     * ### 导出
+     */
+    EXPORT = "export",
+    /**
+     * ### 导入
+     */
+    IMPORT = "import",
+    /**
+     * ### 禁用
+     */
+    DISABLE = "disable",
+    /**
+     * ### 启用
+     */
+    ENABLE = "enable"
+}

package/dist/util/permission/PermissionUtil.d.ts

@@ -0,0 +1,50 @@
+import { ITransformerConstructor } from '@airpower/transformer';
+import { RootEntity } from '../../base';
+import { PermissionAction } from './PermissionAction';
+/**
+ * # 权限标识处理类
+ * @author Hamm.cn
+ */
+export declare class PermissionUtil {
+    /**
+     * ### 权限缓存 `Key`
+     */
+    static permissionKey: string;
+    /**
+     * ### 权限列表
+     */
+    private static permissionList;
+    /**
+     * ### 获取权限标识
+     * - 如 `action` 对应装饰的 `xxxPermission` 是空字符串，则表示无需权限，否则：
+     * - 使用 `action` 来生成权限，除非手动配置了 `action` 对应装饰的 `xxxPermission`
+     * - 如 `permissionPrefix` 装饰了空字符串，则表示无需添加前缀，否则：
+     *
+     * #### `WebConfig.autoPermissionPrefix=true`
+     *
+     * - 使用实体类名作为权限前缀，除非 `permissionPrefix` 装饰了非空字符串
+     *
+     * #### `WebConfig.autoPermissionPrefix=false`
+     *
+     * - 不自动添加前缀，除非 `permissionPrefix` 装饰了非空字符串
+     *
+     * @param EntityClass 实体类
+     * @param action 权限场景
+     * @returns 权限标识
+     */
+    static get<E extends RootEntity>(EntityClass: ITransformerConstructor<E>, action: PermissionAction | string): string;
+    /**
+     * ### 保存权限列表
+     * @param permissions 权限列表
+     */
+    static saveList(permissions: string[]): void;
+    /**
+     * ### 获取缓存的权限列表
+     */
+    static getList(): string[];
+    /**
+     * ### 是否有权限
+     * @param permission 权限标识
+     */
+    static has(permission: string): boolean;
+}