@xezzon/zeroweb-sdk 0.9.0 → 0.10.0

package/LICENSE

@@ -0,0 +1,127 @@
+                     木兰宽松许可证, 第2版
+
+   木兰宽松许可证， 第2版 
+   2020年1月 http://license.coscl.org.cn/MulanPSL2
+
+
+   您对“软件”的复制、使用、修改及分发受木兰宽松许可证，第2版（“本许可证”）的如下条款的约束：
+
+   0. 定义
+
+      “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。
+
+      “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。
+
+      “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。
+
+      “法人实体”是指提交贡献的机构及其“关联实体”。
+
+      “关联实体”是指，对“本许可证”下的行为方而言，控制、受控制或与其共同受控制的机构，此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。
+
+   1. 授予版权许可
+
+      每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可，您可以复制、使用、修改、分发其“贡献”，不论修改与否。
+
+   2. 授予专利许可
+
+      每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的（根据本条规定撤销除外）专利许可，供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求，不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地，就“软件”或其中的“贡献”对任何人发起专利侵权诉讼（包括反诉或交叉诉讼）或其他专利维权行动，指控其侵犯专利权，则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。
+
+   3. 无商标许可
+
+      “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可，但您为满足第4条规定的声明义务而必须使用除外。
+
+   4. 分发限制
+
+      您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发，不论修改与否，但您必须向接收者提供“本许可证”的副本，并保留“软件”中的版权、商标、专利及免责声明。
+
+   5. 免责声明与责任限制
+
+      “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下，“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任，不论因何种原因导致或者基于何种法律理论，即使其曾被建议有此种损失的可能性。 
+
+   6. 语言
+      “本许可证”以中英文双语表述，中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致，以中文版为准。
+
+   条款结束 
+
+   如何将木兰宽松许可证，第2版，应用到您的软件
+   
+   如果您希望将木兰宽松许可证，第2版，应用到您的新软件，为了方便接收者查阅，建议您完成如下三步：
+
+      1， 请您补充如下声明中的空白，包括软件名、软件的首次发表年份以及您作为版权人的名字；
+
+      2， 请您在软件包的一级目录下创建以“LICENSE”为名的文件，将整个许可证文本放入该文件中；
+
+      3， 请将如下声明文本放入每个源文件的头部注释中。
+
+   Copyright (c) [Year] [name of copyright holder]
+   [Software Name] is licensed under Mulan PSL v2.
+   You can use this software according to the terms and conditions of the Mulan PSL v2. 
+   You may obtain a copy of Mulan PSL v2 at:
+            http://license.coscl.org.cn/MulanPSL2 
+   THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.  
+   See the Mulan PSL v2 for more details.  
+
+
+                     Mulan Permissive Software License，Version 2
+
+   Mulan Permissive Software License，Version 2 (Mulan PSL v2)
+   January 2020 http://license.coscl.org.cn/MulanPSL2
+
+   Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 
+   
+   0. Definition
+   
+      Software means the program and related documents which are licensed under this License and comprise all Contribution(s). 
+   
+      Contribution means the copyrightable work licensed by a particular Contributor under this License.
+   
+      Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License.
+   
+      Legal Entity means the entity making a Contribution and all its Affiliates.
+   
+      Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity.
+
+   1. Grant of Copyright License
+
+      Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not.
+
+   2. Grant of Patent License 
+
+      Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken.
+
+   3. No Trademark License
+
+      No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4.
+
+   4. Distribution Restriction
+
+      You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software.
+
+   5. Disclaimer of Warranty and Limitation of Liability
+
+      THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+   6. Language
+
+      THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL.
+
+   END OF THE TERMS AND CONDITIONS
+
+   How to Apply the Mulan Permissive Software License，Version 2 (Mulan PSL v2) to Your Software
+
+      To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps:
+
+      i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; 
+
+      ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package;
+
+      iii Attach the statement to the appropriate annotated syntax at the beginning of each source file.
+
+
+   Copyright (c) [Year] [name of copyright holder]
+   [Software Name] is licensed under Mulan PSL v2.
+   You can use this software according to the terms and conditions of the Mulan PSL v2. 
+   You may obtain a copy of Mulan PSL v2 at:
+               http://license.coscl.org.cn/MulanPSL2 
+   THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.  
+   See the Mulan PSL v2 for more details.  

package/README.md

@@ -88,4 +88,4 @@ adminClient.interceptors.response.use(
 
 ## 许可证
 
-SDK 部分采用 [LGPL-2.1 license](https://www.gnu.org/licenses/lgpl-3.0.html)。
+SDK 部分采用 [LGPL-3.0 license](https://www.gnu.org/licenses/lgpl-3.0.html)。

package/dist/{typings/admin → admin}/app.d.ts

@@ -1,4 +1,4 @@
-import type { HttpClient, Id, PResponse } from "../types";
+import type { HttpClient, Id, PResponse } from '../types';
 /**
  * 应用
  */

package/dist/{typings/admin → admin}/authn.d.ts

@@ -1,4 +1,4 @@
-import type { HttpClient, PResponse } from "../types";
+import type { HttpClient, PResponse } from '../types';
 /**
  * 基础认证
  */

package/dist/{typings/admin → admin}/authz.d.ts

@@ -1,6 +1,6 @@
-import type { HttpClient, PResponse } from "../types";
-import type { Role } from "./role";
-import type { User } from "./user";
+import type { HttpClient, PResponse } from '../types';
+import type { Role } from './role';
+import type { User } from './user';
 /**
  * 角色-用户
  */

package/dist/{typings/admin → admin}/crypto.d.ts

@@ -1,4 +1,4 @@
-import type { HttpClient, PResponse } from "../types";
+import type { HttpClient, PResponse } from '../types';
 /**
  * 口令强度评估结果
  */

package/dist/{typings/admin → admin}/dict.d.ts

@@ -1,4 +1,4 @@
-import type { HttpClient, Id, OData, Page, PResponse } from "../types";
+import type { HttpClient, Id, OData, Page, PResponse } from '../types';
 /**
  * 字典
  */

package/dist/{typings/admin → admin}/index.d.ts

@@ -1,4 +1,4 @@
-import type { InstanceConfig } from "../types";
+import type { InstanceConfig } from '../types';
 declare const _default: (config: InstanceConfig) => {
     /**
      * 拦截器方法

package/dist/{typings/admin → admin}/role.d.ts

@@ -1,4 +1,4 @@
-import type { HttpClient, Id, PResponse } from "../types";
+import type { HttpClient, Id, PResponse } from '../types';
 /**
  * 角色
  */

package/dist/{typings/admin → admin}/setting.d.ts

@@ -1,4 +1,4 @@
-import type { HttpClient, Id, OData, Page, PResponse } from "../types";
+import type { HttpClient, Id, OData, Page, PResponse } from '../types';
 /**
  * 业务参数
  */

package/dist/{typings/admin → admin}/user.d.ts

@@ -1,4 +1,4 @@
-import type { HttpClient, Id, OData, Page, PResponse } from "../types";
+import type { HttpClient, Id, OData, Page, PResponse } from '../types';
 export interface User {
     id: string;
     /**
@@ -9,27 +9,51 @@ export interface User {
      * 昵称
      */
     nickname: string;
+}
+/**
+ * 用户注册请求
+ */
+export interface RegisterReq {
+    /**
+     * 用户名
+     */
+    username: string;
+    /**
+     * 昵称
+     */
+    nickname: string;
     /**
      * 口令
      */
     password: string;
 }
 /**
- * 用户注册请求
+ * 用户公开信息
  */
-declare type RegisterReq = Omit<User, 'id'>;
+declare type UserInfoResp = Pick<User, 'id' | 'username' | 'nickname'>;
 export interface UserAPI {
     /**
      * 用户注册
      * @param user 用户
      */
     register: (user: RegisterReq) => PResponse<Id>;
+    /**
+     * 查询当前用户信息
+     * @returns 用户信息
+     */
+    getMyInfo: () => PResponse<User>;
     /**
      * 获取用户列表
      * @param odata 查询参数
      * @returns 包含分页信息的用户列表
      */
     queryUserList: (odata: OData) => PResponse<Page<User>>;
+    /**
+     * 查询指定用户
+     * @param id 用户ID
+     * @returns 用户信息
+     */
+    queryUserById(id: string): PResponse<UserInfoResp>;
 }
 declare const _default: ({ request }: HttpClient) => UserAPI;
 export default _default;

package/dist/{typings/dev → dev}/index.d.ts

@@ -1,4 +1,4 @@
-import type { InstanceConfig } from "../types";
+import type { InstanceConfig } from '../types';
 declare const _default: (config: InstanceConfig) => {
     /**
      * 拦截器方法

package/dist/{typings/dev → dev}/locale.d.ts

@@ -1,4 +1,4 @@
-import type { HttpClient, Id, OData, Page, PResponse } from "../types";
+import type { HttpClient, Id, OData, Page, PResponse } from '../types';
 /**
  * 语言
  */
@@ -124,7 +124,7 @@ export interface LocaleAPI {
      * @param messageKey 国际化内容
      * @returns 语言-国际化内容
      */
-    queryTranslation: (namespace: string, messageKey: string) => PResponse<Map<string, string>>;
+    queryTranslation: (namespace: string, messageKey: string) => PResponse<object>;
     /**
      * 新增/更新国际化文本
      * @param translation 国际化文本
@@ -136,7 +136,7 @@ export interface LocaleAPI {
      * @param namespace 命名空间
      * @returns 国际化内容-国际化文本
      */
-    loadTranslation: (language: string, namespace: string) => PResponse<Map<string, string>>;
+    loadTranslation: (language: string, namespace: string) => PResponse<object>;
 }
 declare const _default: (client: HttpClient) => LocaleAPI;
 export default _default;

package/dist/{typings/file → file}/attachment.d.ts

@@ -1,5 +1,5 @@
-import type { FileProvider } from "..";
-import type { HttpClient, PResponse } from "../types";
+import type { FileProvider } from '..';
+import type { HttpClient, OData, Page, PResponse } from '../types';
 export declare enum AttachmentStatus {
     UPLOADING = "UPLOADING",
     DONE = "DONE"
@@ -90,6 +90,10 @@ export interface DownloadEndpoint {
      * 下载地址
      */
     endpoint: string;
+    /**
+     * 文件名
+     */
+    filename: string;
 }
 export interface AttachmentAPI {
     /**
@@ -133,6 +137,12 @@ export interface AttachmentAPI {
      * @returns 附件列表
      */
     queryAttachmentByBiz: (bizType: string, bizId: string) => PResponse<Attachment[]>;
+    /**
+     * 查询指定附件
+     * @param id 附件ID
+     * @returns 附件信息
+     */
+    queryById: (id: string) => PResponse<Attachment>;
     /**
      * 获取下载地址
      * @param id 附件ID
@@ -144,6 +154,12 @@ export interface AttachmentAPI {
      * @param id 附件ID
      */
     deleteAttachment: (id: string) => PResponse<void>;
+    /**
+     * 分页查询附件列表
+     * @param odata 查询参数
+     * @returns 附件列表（分页）
+     */
+    queryPage: (odata: OData) => PResponse<Page<Attachment>>;
 }
 declare const _default: (client: HttpClient) => AttachmentAPI;
 export default _default;

package/dist/{typings/file → file}/index.d.ts

@@ -1,4 +1,4 @@
-import type { InstanceConfig } from "../types";
+import type { InstanceConfig } from '../types';
 declare const _default: (config: InstanceConfig) => {
     /**
      * 拦截器方法
@@ -13,13 +13,18 @@ declare const _default: (config: InstanceConfig) => {
     attachment: import("./attachment").AttachmentAPI;
     /**
      * 文件上传
-     * @param file 文件
-     * @param bizType 业务类型
-     * @param bizId 业务编码
      */
     upload: (file: File, uploadInfo: import("./attachment").UploadInfo) => Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * 将获取并解析下载地址
+     */
+    resolveDownloadUrl: (attachment: import("./attachment").Attachment) => Promise<{
+        endpoint: string;
+        filename: string;
+    }>;
 };
 export default _default;
+export { checksum } from './upload';
 export declare enum FileProvider {
     FS = "FS",
     S3 = "S3"

package/dist/{typings/file → file}/upload.d.ts

@@ -1,5 +1,5 @@
-import type { HttpClient } from "../types";
-import type { AttachmentAPI, UploadInfo } from "./attachment";
+import type { HttpClient } from '../types';
+import type { Attachment, AttachmentAPI, UploadInfo } from './attachment';
 /**
  * 计算文件的校验和
  * @param file 文件
@@ -13,3 +13,7 @@ declare global {
     }
 }
 export declare function upload(client: HttpClient, attachmentApi: AttachmentAPI): (file: File, uploadInfo: UploadInfo) => Promise<import("axios").AxiosResponse<void, any, {}>>;
+export declare function resolveDownloadUrl(attachmentApi: AttachmentAPI, baseURL?: string): (attachment: Attachment) => Promise<{
+    endpoint: string;
+    filename: string;
+}>;