@xezzon/zeroweb-sdk 0.8.5-beta.0

package/dist/esm/file/upload.js

@@ -0,0 +1,104 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import CryptoJS from "crypto-js";
+import { crc32 } from "js-crc";
+/**
+ * 计算文件的校验和
+ * @param file 文件
+ * @returns 文件的SHA256值
+ */
+export function checksum(file) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (file.checksum && file.crc) {
+            return file;
+        }
+        return file.arrayBuffer()
+            .then(arrayBuffer => Promise.all([
+            Promise.resolve()
+                .then(() => CryptoJS
+                .SHA256(CryptoJS.lib.WordArray.create(arrayBuffer))
+                .toString(CryptoJS.enc.Base64))
+                .then(checksum => {
+                file.checksum = checksum;
+            }),
+            Promise.resolve()
+                .then(() => CryptoJS.enc.Base64.stringify(CryptoJS.enc.Hex.parse(crc32.hex(arrayBuffer))))
+                .then(crc => {
+                file.crc = crc;
+            }),
+        ]))
+            .then(() => file);
+    });
+}
+export function upload(client, attachmentApi) {
+    return (file, uploadInfo) => __awaiter(this, void 0, void 0, function* () {
+        return file.arrayBuffer()
+            .then(arrayBuffer => {
+            const partCount = uploadInfo.partCount;
+            const partSize = uploadInfo.partSize;
+            const parts = [];
+            for (let index = 0; index < partCount - 1; index++) {
+                const content = arrayBuffer.slice(index * partSize, (index + 1) * partSize);
+                const crc = CryptoJS.enc.Base64.stringify(CryptoJS.enc.Hex.parse(crc32.hex(content)));
+                parts.push({ content, crc });
+            }
+            const content = arrayBuffer.slice((partCount - 1) * partSize, file.size);
+            const crc = CryptoJS.enc.Base64.stringify(CryptoJS.enc.Hex.parse(crc32.hex(content)));
+            parts.push({ content, crc });
+            return parts;
+        })
+            .then(parts => Promise.all(parts
+            .map((part, index) => __awaiter(this, void 0, void 0, function* () {
+            return Promise.resolve()
+                .then(() => {
+                if (uploadInfo.partCount > 1) {
+                    return attachmentApi.getMultipartUploadEndpoint(uploadInfo.id, index + 1, part.crc);
+                }
+                else {
+                    return attachmentApi.getUploadEndpoint(uploadInfo.id);
+                }
+            })
+                .then(response => response.data)
+                .then((_a) => __awaiter(this, [_a], void 0, function* ({ endpoint }) {
+                if (!endpoint) {
+                    return;
+                }
+                const partChecksum = CryptoJS
+                    .SHA256(CryptoJS.lib.WordArray.create(part.content))
+                    .toString(CryptoJS.enc.Base64);
+                let headers;
+                if (uploadInfo.partCount > 1) {
+                    // 分片上传的请求头
+                    headers = {
+                        'x-amz-sdk-checksum-algorithm': 'CRC32',
+                        'x-amz-checksum-crc32': part.crc,
+                    };
+                }
+                else {
+                    headers = {
+                        'x-amz-sdk-checksum-algorithm': 'SHA256',
+                        'x-amz-checksum-sha256': partChecksum,
+                        'x-amz-meta-id': uploadInfo.id,
+                        'x-amz-meta-filename': file.name,
+                        'Content-Type': file.type,
+                    };
+                }
+                return client
+                    .request({
+                    url: endpoint,
+                    method: 'PUT',
+                    data: part.content,
+                    headers: headers,
+                });
+            }));
+        }))))
+            .then(() => attachmentApi.finishUpload(uploadInfo.id));
+    });
+}

package/dist/esm/index.js

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

package/dist/esm/metadata/index.js

@@ -0,0 +1,74 @@
+import axios from "axios";
+/**
+ * 服务类型
+ */
+export var ServiceType;
+(function (ServiceType) {
+    /**
+     * 前端
+     */
+    ServiceType["CLIENT"] = "CLIENT";
+    /**
+     * 后端
+     */
+    ServiceType["SERVER"] = "SERVER";
+})(ServiceType || (ServiceType = {}));
+/**
+ * 菜单类型
+ */
+export var MenuType;
+(function (MenuType) {
+    /**
+     * 路由
+     */
+    MenuType["ROUTE"] = "ROUTE";
+    /**
+     * 外部链接。
+     * 点击后会打开一个新的标签页
+     */
+    MenuType["EXTERNAL_LINK"] = "EXTERNAL_LINK";
+    /**
+     * 嵌入页面。
+     * 会在当前页面嵌入一个外部网页。
+     */
+    MenuType["EMBEDDED"] = "EMBEDDED";
+    /**
+     * 接口权限
+     * 路径格式为 `resource:operation`，operation 通常为 `read`（可省略）、`write` 等。
+     */
+    MenuType["PERMISSION"] = "PERMISSION";
+    /**
+     * 资源权限
+     * 路径格式为 `resource:#:operation`，operation 通常为 `read`（可省略）、`write` 等。
+     */
+    MenuType["GROUP_PERMISSION"] = "GROUP_PERMISSION";
+})(MenuType || (MenuType = {}));
+export default (config) => {
+    const instance = axios.create(config);
+    return {
+        /**
+         * 拦截器方法
+         */
+        interceptors: instance.interceptors,
+        /**
+         * 获取服务信息
+         * @returns 服务信息
+         */
+        loadServiceInfo() {
+            return instance.request({
+                url: '/metadata/info.json',
+                method: 'GET',
+            });
+        },
+        /**
+         * 获取菜单信息
+         * @returns 菜单信息
+         */
+        loadResourceInfo() {
+            return instance.request({
+                url: '/metadata/menu.json',
+                method: 'GET',
+            });
+        },
+    };
+};

package/dist/esm/open/index.js

@@ -0,0 +1,27 @@
+import axios from "axios";
+import openapi from "./openapi";
+import subscription from "./subscription";
+import thirdPartyApp from "./third_party_app";
+export default (config) => {
+    const instance = axios.create(config);
+    return {
+        /**
+         * 拦截器方法
+         */
+        interceptors: instance.interceptors,
+        /**
+         * 对外接口相关接口
+         */
+        openapi: openapi(instance),
+        /**
+         * 第三方应用订阅相关接口
+         */
+        subscription: subscription(instance),
+        /**
+         * 第三方应用相关接口
+         */
+        thirdPartyApp: thirdPartyApp(instance),
+    };
+};
+export { OpenapiStatus } from './openapi';
+export { SubscriptionStatus } from './subscription';

package/dist/esm/open/openapi.js

@@ -0,0 +1,35 @@
+/**
+ * 对外接口状态
+ */
+export var OpenapiStatus;
+(function (OpenapiStatus) {
+    /**
+     * 草稿
+     */
+    OpenapiStatus[OpenapiStatus["DRAFT"] = 0] = "DRAFT";
+    /**
+     * 已发布
+     */
+    OpenapiStatus[OpenapiStatus["PUBLISHED"] = 1] = "PUBLISHED";
+})(OpenapiStatus || (OpenapiStatus = {}));
+export default (client) => ({
+    addOpenapi: (openapi) => client.request({
+        url: '/openapi',
+        method: 'POST',
+        data: openapi,
+    }),
+    getOpenapiList: (odata) => client.request({
+        url: '/openapi',
+        method: 'GET',
+        params: odata,
+    }),
+    modifyOpenapi: (openapi) => client.request({
+        url: '/openapi',
+        method: 'PUT',
+        data: openapi,
+    }),
+    publishOpenapi: (id) => client.request({
+        url: `/openapi/publish/${id}`,
+        method: 'PUT',
+    }),
+});

package/dist/esm/open/subscription.js

@@ -0,0 +1,36 @@
+import { BASE_URL as THIRD_PARTY_APP_URL } from './third_party_app';
+const BASE_URL = '/subscription';
+/**
+ * 订阅状态
+ */
+export var SubscriptionStatus;
+(function (SubscriptionStatus) {
+    /**
+     * 未订阅
+     */
+    SubscriptionStatus[SubscriptionStatus["NONE"] = 0] = "NONE";
+    /**
+     * 审核中
+     */
+    SubscriptionStatus[SubscriptionStatus["AUDITING"] = 1] = "AUDITING";
+    /**
+     * 已订阅
+     */
+    SubscriptionStatus[SubscriptionStatus["SUBSCRIBED"] = 2] = "SUBSCRIBED";
+})(SubscriptionStatus || (SubscriptionStatus = {}));
+export default (client) => ({
+    subscribe: (subscription) => client.request({
+        url: `${BASE_URL}`,
+        method: 'POST',
+        data: subscription,
+    }),
+    listSubscription: (appId, odata) => client.request({
+        url: `${THIRD_PARTY_APP_URL}/${appId}/subscription`,
+        method: 'GET',
+        params: odata,
+    }),
+    auditSubscription: (id) => client.request({
+        url: `${BASE_URL}/audit/${id}`,
+        method: 'PUT',
+    }),
+});

package/dist/esm/open/third_party_app.js

@@ -0,0 +1,46 @@
+export const BASE_URL = '/third-party-app';
+export default (client) => ({
+    addThirdPartyApp: (thirdPartyApp) => client.request({
+        url: `${BASE_URL}`,
+        method: 'POST',
+        data: thirdPartyApp,
+    }),
+    listMyThirdPartyApp: (odata) => client.request({
+        url: `${BASE_URL}/mine`,
+        method: 'GET',
+        params: odata,
+    }),
+    listThirdPartyApp: (odata) => client.request({
+        url: `${BASE_URL}`,
+        method: 'GET',
+        params: odata,
+    }),
+    rollAccessSecret: (id) => client.request({
+        url: `${BASE_URL}/${id}/roll`,
+        method: 'PATCH',
+    }),
+    inviteMember: (appId, timeout) => client.request({
+        url: `/third-party-app/${appId}/member`,
+        method: 'POST',
+        params: { timeout, },
+    }),
+    inviteParticularMember: (appId, userId, timeout) => client.request({
+        url: `/third-party-app/${appId}/member`,
+        method: 'POST',
+        params: { userId, timeout, },
+    }),
+    addThirdPartyAppMember: (token) => client.request({
+        url: `/third-party-app/-/member`,
+        method: 'PUT',
+        params: { token, },
+    }),
+    listThirdPartyAppMember: (appId) => client.request({
+        url: `/third-party-app/${appId}/member`,
+        method: 'GET',
+    }),
+    moveOwnerShip: (appId, userId) => client.request({
+        url: `/third-party-app/${appId}/owner`,
+        method: 'PATCH',
+        params: { userId, },
+    }),
+});

package/dist/esm/types.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,50 @@
+import { HttpClient, Id, PResponse } from "../types";
+/**
+ * 应用
+ */
+export interface App {
+    /**
+     * 应用ID
+     */
+    id: string;
+    /**
+     * 应用名称
+     */
+    name: string;
+    /**
+     * 应用基础访问路径
+     */
+    baseUrl: string;
+    /**
+     * 应用排序
+     * 顺序越小越靠前
+     */
+    ordinal: number;
+}
+declare type AddAppReq = Omit<App, 'id'>;
+declare type UpdateAppReq = App;
+export interface AppAPI {
+    /**
+     * 新增应用
+     * @param app 应用
+     * @returns 应用ID
+     */
+    addApp: (app: AddAppReq) => PResponse<Id>;
+    /**
+     * 查询应用列表
+     * @returns 应用列表
+     */
+    listApp: () => PResponse<App[]>;
+    /**
+     * 更新应用信息
+     * @param app 应用信息
+     */
+    updateApp: (app: UpdateAppReq) => PResponse<void>;
+    /**
+     * 删除应用
+     * @param id 应用ID
+     */
+    deleteApp: (id: string) => PResponse<void>;
+}
+declare const _default: (client: HttpClient) => AppAPI;
+export default _default;

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

@@ -0,0 +1,76 @@
+import { HttpClient, PResponse } from "../types";
+/**
+ * 基础认证
+ */
+export interface BasicAuth {
+    /**
+     * 用户名
+     */
+    username: string;
+    /**
+     * 口令
+     */
+    password: string;
+}
+export interface SaTokenInfo {
+    /**
+     * token 名称
+     */
+    tokenName: string;
+    /**
+     * token 值
+     */
+    tokenValue: string;
+}
+export interface JwtClaim {
+    /**
+     * 用户ID
+     */
+    sub: string;
+    /**
+     * 用户名
+     */
+    preferredUsername: string;
+    /**
+     * 用户昵称
+     */
+    nickname: string;
+    /**
+     * 角色
+     */
+    roles: string[];
+    /**
+     * 权限
+     */
+    entitlements: string[];
+}
+/**
+ * @see {@link https://openid.net/specs/openid-connect-core-1_0.html|OIDC}
+ */
+export interface OidcToken {
+    access_token: string;
+    refresh_token: string;
+    expires_in: number;
+    id_token: string;
+}
+export interface AuthnAPI {
+    /**
+     * 基础认证
+     * @param user 用户名口令
+     */
+    basicLogin: (user: BasicAuth) => PResponse<OidcToken>;
+    /**
+     * @returns 当前用户的认证信息
+     */
+    self: () => PResponse<JwtClaim>;
+    /**
+     * @returns 用户令牌
+     */
+    token: () => PResponse<OidcToken>;
+    /**
+     * 退出登录
+     */
+    logout: () => PResponse<void>;
+}
+declare const _default: (client: HttpClient) => AuthnAPI;
+export default _default;

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

@@ -0,0 +1,79 @@
+import { HttpClient, PResponse } from "../types";
+import { User } from "./user";
+import { Role } from "./role";
+/**
+ * 角色-用户
+ */
+export interface RoleUser {
+    id: string;
+    /**
+     * 角色ID
+     */
+    roleId: string;
+    /**
+     * 用户ID
+     */
+    userId: string;
+}
+/**
+ * 角色-接口权限
+ */
+export interface RolePermission {
+    id: string;
+    /**
+     * 角色ID
+     */
+    roleId: string;
+    /**
+     * 接口权限编码
+     */
+    permission: string;
+}
+export interface AuthzAPI {
+    /**
+     * 查询角色绑定的用户
+     * @param roleId 角色ID
+     * @returns 用户信息列表
+     */
+    queryUserByRole: (roleId: string) => PResponse<User[]>;
+    /**
+     * 将用户绑定到角色
+     * @param roleUsers 角色-用户绑定关系
+     */
+    bindUserToRole: (roleUsers: RoleUser[]) => PResponse<void>;
+    /**
+     * 解除用户与角色的关联
+     * @param roleUsers 角色-用户关联
+     */
+    releaseRoleUser: (roleUsers: RoleUser[]) => PResponse<void>;
+    /**
+     * 查询角色的接口权限编码集合
+     * @param roleId 角色ID
+     * @returns 接口权限编码
+     */
+    queryPermissionByRole: (roleId: string) => PResponse<string[]>;
+    /**
+     * 解除角色与接口权限的关联
+     * @param rolePermissions 角色-接口权限关系
+     */
+    bindPermissionToRole: (rolePermissions: RolePermission[]) => PResponse<void>;
+    /**
+     * 解除角色与接口权限的关联
+     * @param rolePermissions 角色-接口权限关系
+     */
+    releaseRolePermission: (rolePermissions: RolePermission[]) => PResponse<void>;
+    /**
+     * 查询用户关联的角色
+     * @param userId 用户ID
+     * @returns 角色信息集合
+     */
+    queryRoleByUser: (userId: string) => PResponse<Role[]>;
+    /**
+     * 查询接口权限关联的角色集合
+     * @param permission 接口权限编码
+     * @returns 角色信息集合
+     */
+    queryRoleByPermission: (permission: string) => PResponse<Role[]>;
+}
+declare const _default: (client: HttpClient) => AuthzAPI;
+export default _default;

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

@@ -0,0 +1,26 @@
+import { HttpClient, PResponse } from "../types";
+/**
+ * 口令强度评估结果
+ */
+export interface PasswordStrength {
+    /**
+     * 口令强度得分
+     */
+    score: number;
+    /**
+     * 强度量级
+     */
+    guessesLog10: number;
+}
+export interface CryptoAPI {
+    /**
+     * 计算口令强度。
+     * @param password 口令
+     * @param username 用户名
+     */
+    passwordStrength: (password: string, directory: {
+        username?: string;
+    }) => PResponse<PasswordStrength>;
+}
+declare const _default: ({ request }: HttpClient) => CryptoAPI;
+export default _default;

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

@@ -0,0 +1,86 @@
+import { HttpClient, Id, OData, Page, PResponse } from "../types";
+/**
+ * 字典
+ */
+export interface Dict {
+    id: string;
+    /**
+     * 字典目
+     */
+    tag: string;
+    /**
+     * 字典键
+     */
+    code: string;
+    /**
+     * 字典值
+     */
+    label?: string;
+    /**
+     * 排序号
+     * 数值越小，顺序越靠前
+     */
+    ordinal: number;
+    /**
+     * 上级字典ID
+     */
+    parentId: string;
+    /**
+     * 是否启用
+     */
+    enabled: boolean;
+    /**
+     * 是否允许修改
+     */
+    readonly editable: boolean;
+    /**
+     * 下级字典列表
+     */
+    children?: Dict[];
+}
+/**
+ * 新增字典
+ */
+declare type AddDictReq = Omit<Dict, 'id' | 'enabled' | 'editable' | 'children'>;
+/**
+ * 更新字典
+ */
+declare type ModifyDictReq = Omit<Dict, 'tag' | 'editable' | 'children'>;
+export interface DictAPI {
+    /**
+     * 新增字典
+     * @param dict 字典
+     */
+    addDict: (dict: AddDictReq) => PResponse<Id>;
+    /**
+     * 分页查询字典目列表
+     * @param odata 分页参数
+     * @returns 字典目列表
+     */
+    getDictTagList: (odata: OData) => PResponse<Page<Dict>>;
+    /**
+     * 查询指定字典目下所有字典项的列表
+     * @param tag 字典目编码
+     * @returns 字典项列表（树形）
+     */
+    getDictTreeByTag: (tag: string) => PResponse<Dict[]>;
+    /**
+     * 更新字典目/字典项
+     * @param dict 字典
+     * @returns
+     */
+    modifyDict: (dict: ModifyDictReq) => PResponse<void>;
+    /**
+     * 批量更新字典状态
+     * @param ids 字典ID集合
+     * @param enabled 更新后的字典启用状态
+     */
+    updateDictStatus: (ids: string[], enabled: boolean) => PResponse<void>;
+    /**
+     * 批量删除字典目/字典项
+     * @param ids 字典ID集合
+     */
+    removeDict: (ids: string[]) => PResponse<void>;
+}
+declare const _default: (client: HttpClient) => DictAPI;
+export default _default;