@xezzon/zeroweb-sdk 0.8.5-beta.0

package/dist/typings/admin/index.d.ts

@@ -0,0 +1,51 @@
+import { InstanceConfig } from "../types";
+declare const _default: (config: InstanceConfig) => {
+    /**
+     * 拦截器方法
+     */
+    interceptors: {
+        request: import("axios").AxiosInterceptorManager<import("axios").InternalAxiosRequestConfig>;
+        response: import("axios").AxiosInterceptorManager<import("axios").AxiosResponse>;
+    };
+    /**
+     * 应用管理相关接口
+     */
+    app: import("./app").AppAPI;
+    /**
+     * 认证相关接口
+     */
+    authn: import("./authn").AuthnAPI;
+    /**
+     * 授权相关接口
+     */
+    authz: import("./authz").AuthzAPI;
+    /**
+     * 加密相关接口
+     */
+    crypto: import("./crypto").CryptoAPI;
+    /**
+     * 字典相关接口
+     */
+    dict: import("./dict").DictAPI;
+    /**
+     * 角色管理接口
+     */
+    role: import("./role").RoleAPI;
+    /**
+     * 业务参数管理接口
+     */
+    setting: import("./setting").SettingAPI;
+    /**
+     * 用户相关接口
+     */
+    user: import("./user").UserAPI;
+};
+export default _default;
+export type * from './app';
+export type * from './authn';
+export type * from './authz';
+export type * from './crypto';
+export type * from './dict';
+export type * from './role';
+export type * from './setting';
+export type * from './user';

package/dist/typings/admin/role.d.ts

@@ -0,0 +1,60 @@
+import { HttpClient, Id, PResponse } from "../types";
+/**
+ * 角色
+ */
+export interface Role {
+    /**
+     * 角色ID
+     */
+    id: string;
+    /**
+     * 角色简码
+     */
+    code: string;
+    /**
+     * 角色编码
+     */
+    value: string;
+    /**
+     * 角色名称
+     */
+    name: string;
+    /**
+     * 是否允许该角色创建下级角色
+     */
+    inheritable: boolean;
+    /**
+     * 上级角色
+     */
+    parentId: string;
+    /**
+     * 下级角色
+     */
+    children?: Role[];
+}
+declare type AddRoleReq = Omit<Role, 'id' | 'value'>;
+export interface RoleAPI {
+    /**
+     * 新增角色
+     * @param role 角色信息
+     * @returns 角色ID
+     */
+    addRole: (role: AddRoleReq) => PResponse<Id>;
+    /**
+     * 查询角色列表
+     * @returns 角色列表（树形）
+     */
+    listAllRole: () => PResponse<Role[]>;
+    /**
+     * 删除角色
+     * @param id 角色ID
+     */
+    deleteRole: (id: string) => PResponse<void>;
+    /**
+     * 查询当前登陆人的角色及它们的下一级角色
+     * @returns 角色列表
+     */
+    listMyRole: () => PResponse<Role[]>;
+}
+declare const _default: (client: HttpClient) => RoleAPI;
+export default _default;

package/dist/typings/admin/setting.d.ts

@@ -0,0 +1,66 @@
+import { HttpClient, Id, OData, Page, PResponse } from "../types";
+/**
+ * 业务参数
+ */
+export interface Setting {
+    /**
+     * 主键
+     */
+    id: string;
+    /**
+     * 业务参数标识
+     */
+    code: string;
+    /**
+     * 参数约束定义
+     * @see {@link https://json-schema.org/specification|JSON Schema}
+     */
+    schema: string;
+    /**
+     * 参数值
+     */
+    value: object;
+    /**
+     * 更新时间
+     */
+    updateTime: Date;
+}
+declare type AddSettingReq = Omit<Setting, 'id' | 'updateTime'>;
+declare type UpdateSettingSchemaReq = Omit<Setting, 'code' | 'updateTime'>;
+declare type UpdateSettingValueReq = Omit<Setting, 'code' | 'schema' | 'updateTime'>;
+export interface SettingAPI {
+    /**
+     * 新增业务参数
+     * @param setting 业务参数
+     * @returns 业务参数ID
+     */
+    addSetting: (setting: AddSettingReq) => PResponse<Id>;
+    /**
+     * 查询业务参数列表
+     * @returns 业务参数列表
+     */
+    listSetting: (odata: OData) => PResponse<Page<Setting>>;
+    /**
+     * 根据 code 查询业务参数
+     * @param code 业务参数标识
+     * @returns 业务参数
+     */
+    querySettingByCode: (code: string) => PResponse<Setting>;
+    /**
+     * 更新业务参数信息
+     * @param setting 业务参数信息
+     */
+    updateSchema: (setting: UpdateSettingSchemaReq) => PResponse<void>;
+    /**
+     * 更新业务参数信息
+     * @param setting 业务参数信息
+     */
+    updateValue: (setting: UpdateSettingValueReq) => PResponse<void>;
+    /**
+     * 删除业务参数
+     * @param id 业务参数ID
+     */
+    deleteSetting: (id: string) => PResponse<void>;
+}
+declare const _default: (client: HttpClient) => SettingAPI;
+export default _default;

package/dist/typings/admin/user.d.ts

@@ -0,0 +1,29 @@
+import { HttpClient, Id, PResponse } from "../types";
+export interface User {
+    id: string;
+    /**
+     * 用户名
+     */
+    username: string;
+    /**
+     * 昵称
+     */
+    nickname: string;
+    /**
+     * 口令
+     */
+    password: string;
+}
+/**
+ * 用户注册请求
+ */
+declare type RegisterReq = Omit<User, 'id'>;
+export interface UserAPI {
+    /**
+     * 用户注册
+     * @param user 用户
+     */
+    register: (user: RegisterReq) => PResponse<Id>;
+}
+declare const _default: ({ request }: HttpClient) => UserAPI;
+export default _default;

package/dist/typings/dev/index.d.ts

@@ -0,0 +1,16 @@
+import { InstanceConfig } from "../types";
+declare const _default: (config: InstanceConfig) => {
+    /**
+     * 拦截器方法
+     */
+    interceptors: {
+        request: import("axios").AxiosInterceptorManager<import("axios").InternalAxiosRequestConfig>;
+        response: import("axios").AxiosInterceptorManager<import("axios").AxiosResponse>;
+    };
+    /**
+     * 国际化相关接口
+     */
+    locale: import("./locale").LocaleAPI;
+};
+export default _default;
+export type * from './locale';

package/dist/typings/dev/locale.d.ts

@@ -0,0 +1,142 @@
+import { HttpClient, Id, OData, Page, PResponse } from "../types";
+/**
+ * 语言
+ */
+export interface Language {
+    id: string;
+    /**
+     * 语言标签
+     */
+    languageTag: string;
+    /**
+     * 语言描述
+     */
+    description: string;
+    /**
+     * 排序号
+     * 数值越小，排序越靠前
+     */
+    ordinal: number;
+    /**
+     * 启用状态
+     */
+    enabled: boolean;
+}
+/**
+ * 国际化内容
+ */
+export interface I18nMessage {
+    id: string;
+    /**
+     * 命名空间
+     */
+    namespace: string;
+    /**
+     * 国际化内容
+     */
+    messageKey: string;
+}
+/**
+ * 国际化文本
+ */
+export interface Translation {
+    id: string;
+    /**
+     * 命名空间
+     */
+    namespace: string;
+    /**
+     * 国际化内容
+     */
+    messageKey: string;
+    /**
+     * 语言
+     */
+    language: string;
+    /**
+     * 国际化文本
+     */
+    content: string;
+}
+/**
+ * 新增语言
+ */
+declare type AddLanguageReq = Omit<Language, 'id'>;
+/**
+ * 新增国际化内容
+ */
+declare type AddI18nMessageReq = Omit<I18nMessage, 'id'>;
+/**
+ * 新增/更新国际化文本
+ */
+declare type UpsertTranslationReq = Omit<Translation, 'id'>;
+export interface LocaleAPI {
+    /**
+     * 新增语言
+     * @param language 语言
+     */
+    addLanguage: (language: AddLanguageReq) => PResponse<Id>;
+    /**
+     * 查询语言列表
+     * @returns 语言列表
+     */
+    queryLanguageList: () => PResponse<Language[]>;
+    /**
+     * 更新语言
+     * @param language 语言
+     */
+    updateLanguage: (language: Language) => PResponse<void>;
+    /**
+     * 删除语言
+     * @param id 语言ID
+     */
+    deleteLanguage: (id: string) => PResponse<void>;
+    /**
+     * 新增国际化内容
+     * @param i18nMessage 国际化内容
+     */
+    addI18nMessage: (i18nMessage: AddI18nMessageReq) => PResponse<Id>;
+    /**
+     * 列举国际化内容命名空间
+     * @returns 国际化内容命名空间
+     */
+    listI18nNamespace: () => PResponse<string[]>;
+    /**
+     * 分页查询国际化内容
+     * @param namespace 命名空间
+     * @param odata 分页查询参数
+     * @returns 国际化内容列表
+     */
+    queryI18nMessageList: (namespace: string, odata: OData) => PResponse<Page<I18nMessage>>;
+    /**
+     * 更新国际化内容
+     * @param i18nMessage 国际化内容
+     */
+    updateI18nMessage: (i18nMessage: I18nMessage) => PResponse<void>;
+    /**
+     * 删除国际化内容
+     * @param id 国际化内容ID
+     */
+    deleteI18nMessage: (id: string) => PResponse<void>;
+    /**
+     * 查询国际化文本
+     * @param namespace 命名空间
+     * @param messageKey 国际化内容
+     * @returns 语言-国际化内容
+     */
+    queryTranslation: (namespace: string, messageKey: string) => PResponse<Map<string, string>>;
+    /**
+     * 新增/更新国际化文本
+     * @param translation 国际化文本
+     */
+    upsertTranslation: (translation: UpsertTranslationReq) => PResponse<Id>;
+    /**
+     * 加载国际化资源
+     * @param language 语言
+     * @param namespace 命名空间
+     * @returns 国际化内容-国际化文本
+     */
+    loadTranslation: (language: string, namespace: string) => PResponse<Map<string, string>>;
+}
+declare const _default: (client: HttpClient) => LocaleAPI;
+export default _default;

package/dist/typings/file/attachment.d.ts

@@ -0,0 +1,149 @@
+import { HttpClient, PResponse } from "../types";
+import { FileProvider } from "..";
+export declare enum AttachmentStatus {
+    UPLOADING = "UPLOADING",
+    DONE = "DONE"
+}
+export interface Attachment {
+    /**
+     * 附件ID
+     */
+    id: string;
+    /**
+     * 文件名
+     */
+    name: string;
+    /**
+     * 文件摘要
+     */
+    checksum: string;
+    /**
+     * 文件大小
+     * 单位：字节
+     */
+    size: number;
+    /**
+     * MIME类型
+     */
+    type: string;
+    /**
+     * 业务类型
+     */
+    bizType: string;
+    /**
+     * 业务ID
+     */
+    bizId: string;
+    /**
+     * 存储后端
+     */
+    provider: FileProvider;
+    /**
+     * 附件状态
+     */
+    status: AttachmentStatus;
+    /**
+     * 上传者
+     */
+    ownerId: string;
+    /**
+     * 上传时间
+     */
+    createTime: Date;
+}
+export interface UploadInfo {
+    /**
+     * 附件ID
+     */
+    id: string;
+    /**
+     * 存储后端
+     */
+    provider: FileProvider;
+    /**
+     * 分片数量
+     */
+    partCount: number;
+    /**
+     * 分片大小。单位 Byte。
+     */
+    partSize: number;
+}
+/**
+ * 上传地址
+ */
+export interface UploadAddress {
+    /**
+     * 分片序号
+     */
+    partNumber: number;
+    /**
+     * 上传地址
+     */
+    endpoint?: string;
+}
+/**
+ * 下载地址
+ */
+export interface DownloadEndpoint {
+    /**
+     * 下载地址
+     */
+    endpoint: string;
+}
+export interface AttachmentAPI {
+    /**
+     * 新增附件
+     * @param file 文件信息
+     * @param bizType 业务类型
+     * @param bizId 业务ID
+     * @returns 文件上传元数据
+     */
+    addAttachment: (file: File, bizType: string, bizId: string) => PResponse<UploadInfo>;
+    /**
+     * 获取文件上传元数据
+     * @param id 附件ID
+     * @param checksum 文件摘要
+     * @param fileSize 文件大小
+     * @returns 文件上传元数据
+     */
+    getUploadInfo: (id: string, checksum: string, fileSize: number) => PResponse<UploadInfo>;
+    /**
+     * 获取上传地址
+     * @param id 附件ID
+     * @returns 上传地址
+     */
+    getUploadEndpoint: (id: string) => PResponse<UploadAddress>;
+    /**
+     * 获取分段上传地址
+     * @param id 附件ID
+     * @param partNumber 分段序号
+     * @returns 上传地址
+     */
+    getMultipartUploadEndpoint: (id: string, partNumber: number, crc?: string) => PResponse<UploadAddress>;
+    /**
+     * 文件上传完成后，将其状态变更为已完成
+     * @param id 附件ID
+     */
+    finishUpload: (id: string) => PResponse<void>;
+    /**
+     * 查询业务关联的附件
+     * @param bizType 业务类型
+     * @param bizId 业务ID
+     * @returns 附件列表
+     */
+    queryAttachmentByBiz: (bizType: string, bizId: string) => PResponse<Attachment[]>;
+    /**
+     * 获取下载地址
+     * @param id 附件ID
+     * @returns 下载地址
+     */
+    getDownloadEndpoint: (id: string) => PResponse<DownloadEndpoint>;
+    /**
+     * 删除附件
+     * @param id 附件ID
+     */
+    deleteAttachment: (id: string) => PResponse<void>;
+}
+declare const _default: (client: HttpClient) => AttachmentAPI;
+export default _default;

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

@@ -0,0 +1,28 @@
+import { InstanceConfig } from "../types";
+declare const _default: (config: InstanceConfig) => {
+    /**
+     * 拦截器方法
+     */
+    interceptors: {
+        request: import("axios").AxiosInterceptorManager<import("axios").InternalAxiosRequestConfig>;
+        response: import("axios").AxiosInterceptorManager<import("axios").AxiosResponse>;
+    };
+    /**
+     * 附件管理接口
+     */
+    attachment: import("./attachment").AttachmentAPI;
+    /**
+     * 文件上传
+     * @param file 文件
+     * @param bizType 业务类型
+     * @param bizId 业务编码
+     */
+    upload: (file: File, uploadInfo: import("./attachment").UploadInfo) => Promise<import("axios").AxiosResponse<void, any, {}>>;
+};
+export default _default;
+export declare enum FileProvider {
+    FS = "FS",
+    S3 = "S3"
+}
+export { AttachmentStatus } from './attachment';
+export type * from './attachment';

package/dist/typings/file/upload.d.ts

@@ -0,0 +1,15 @@
+import { HttpClient } from "../types";
+import { AttachmentAPI, UploadInfo } from "./attachment";
+/**
+ * 计算文件的校验和
+ * @param file 文件
+ * @returns 文件的SHA256值
+ */
+export declare function checksum(file: File): Promise<File>;
+declare global {
+    interface File {
+        checksum?: string;
+        crc?: string;
+    }
+}
+export declare function upload(client: HttpClient, attachmentApi: AttachmentAPI): (file: File, uploadInfo: UploadInfo) => Promise<import("axios").AxiosResponse<void, any, {}>>;

package/dist/typings/index.d.ts

@@ -0,0 +1,10 @@
+export { default as ZerowebMetadataClient, MenuType, ServiceType, } from './metadata';
+export type * from './metadata';
+export { default as ZerowebAdminClient } from './admin';
+export type * from './admin';
+export { default as ZerowebOpenClient, OpenapiStatus, SubscriptionStatus, } from './open';
+export type * from './open';
+export { default as ZerowebFileClient, FileProvider, AttachmentStatus, } from './file';
+export type * from './file';
+export { default as ZerowebDevClient } from './dev';
+export type * from './dev';

package/dist/typings/metadata/index.d.ts

@@ -0,0 +1,124 @@
+import { InstanceConfig } from "../types";
+/**
+ * 服务类型
+ */
+export declare enum ServiceType {
+    /**
+     * 前端
+     */
+    CLIENT = "CLIENT",
+    /**
+     * 后端
+     */
+    SERVER = "SERVER"
+}
+/**
+ * 服务信息
+ */
+export interface ServiceInfo {
+    /**
+     * 服务名称
+     */
+    name: string;
+    /**
+     * 服务版本号
+     */
+    version: string;
+    /**
+     * 服务类型
+     */
+    type: ServiceType;
+    /**
+     * 是否隐藏
+     */
+    hidden: boolean;
+}
+/**
+ * 菜单类型
+ */
+export declare enum MenuType {
+    /**
+     * 路由
+     */
+    ROUTE = "ROUTE",
+    /**
+     * 外部链接。
+     * 点击后会打开一个新的标签页
+     */
+    EXTERNAL_LINK = "EXTERNAL_LINK",
+    /**
+     * 嵌入页面。
+     * 会在当前页面嵌入一个外部网页。
+     */
+    EMBEDDED = "EMBEDDED",
+    /**
+     * 接口权限
+     * 路径格式为 `resource:operation`，operation 通常为 `read`（可省略）、`write` 等。
+     */
+    PERMISSION = "PERMISSION",
+    /**
+     * 资源权限
+     * 路径格式为 `resource:#:operation`，operation 通常为 `read`（可省略）、`write` 等。
+     */
+    GROUP_PERMISSION = "GROUP_PERMISSION"
+}
+/**
+ * 资源信息
+ */
+export interface MenuInfo {
+    /**
+     * 资源类型
+     */
+    type: MenuType;
+    /**
+     * 资源路径
+     */
+    path: string;
+    /**
+     * 访问资源所需要的权限
+     * 取并集，即资源必须满足所列出的所有权限
+     */
+    permissions: string[];
+    /**
+     * 菜单名称
+     */
+    name?: string;
+    /**
+     * 自定义菜单的国际化
+     * 默认为 path
+     */
+    locale?: string;
+    /**
+     * 不在菜单中展示
+     */
+    hideInMenu?: boolean;
+    /**
+     * 组件路径或嵌入页面的链接
+     */
+    route?: string;
+    /**
+     * 指定布局的路径
+     * 默认为'/'
+     */
+    layout?: string;
+}
+declare const _default: (config: InstanceConfig) => {
+    /**
+     * 拦截器方法
+     */
+    interceptors: {
+        request: import("axios").AxiosInterceptorManager<import("axios").InternalAxiosRequestConfig>;
+        response: import("axios").AxiosInterceptorManager<import("axios").AxiosResponse>;
+    };
+    /**
+     * 获取服务信息
+     * @returns 服务信息
+     */
+    loadServiceInfo(): Promise<import("axios").AxiosResponse<ServiceInfo, any, {}>>;
+    /**
+     * 获取菜单信息
+     * @returns 菜单信息
+     */
+    loadResourceInfo(): Promise<import("axios").AxiosResponse<MenuInfo[], any, {}>>;
+};
+export default _default;