@xezzon/zeroweb-sdk 0.8.5-beta.0

package/README.md

@@ -0,0 +1,91 @@
+# ZeroWeb SDK
+
+ZeroWeb SDK 是一个用于与 ZeroWeb 微服务进行交互的 TypeScript 客户端库，提供了完整的 API 封装和类型支持。
+
+## 功能特性
+
+- **🔧 模块化设计**: 支持按需使用不同功能模块
+- **📝 完整类型支持**: 基于 TypeScript 的强类型定义
+- **🔄 拦截器支持**: 提供请求/响应拦截器功能
+- **📦 多种模块格式**: 支持 CommonJS 和 ES Module
+- **🛡️ 类型安全**: 完整的类型定义和接口约束
+
+## 安装
+
+### npm
+
+```bash
+npm install @xezzon/zeroweb-sdk
+```
+
+### pnpm
+
+```bash
+pnpm add @xezzon/zeroweb-sdk
+```
+
+### yarn
+
+```bash
+yarn add @xezzon/zeroweb-sdk
+```
+
+## 快速开始
+
+### 基础配置
+
+```typescript
+import { 
+  ZerowebAdminClient,
+  ZerowebMetadataClient,
+  ZerowebOpenClient,
+  ZerowebFileClient,
+  ZerowebDevClient
+} from '@xezzon/zeroweb-sdk';
+
+// 基础配置
+const config = {
+  baseURL: 'https://your-api-domain.com',
+  timeout: 10000,
+  headers: {
+    'Content-Type': 'application/json'
+  }
+};
+
+// 创建客户端实例
+const adminClient = ZerowebAdminClient(config);
+const metadataClient = ZerowebMetadataClient(config);
+const openClient = ZerowebOpenClient(config);
+const fileClient = ZerowebFileClient(config);
+const devClient = ZerowebDevClient(config);
+```
+
+### 添加请求拦截器
+
+```typescript
+// 添加请求拦截器
+adminClient.interceptors.request.use((config) => {
+  // 添加认证 token
+  const token = localStorage.getItem('auth_token');
+  if (token) {
+    config.headers.Authorization = `Bearer ${token}`;
+  }
+  return config;
+});
+
+// 添加响应拦截器
+adminClient.interceptors.response.use(
+  (response) => response,
+  (error) => {
+    if (error.response?.status === 401) {
+      // 处理未授权错误
+      window.location.href = '/login';
+    }
+    return Promise.reject(error);
+  }
+);
+```
+
+## 许可证
+
+SDK 部分采用 [LGPL-2.1 license](https://www.gnu.org/licenses/lgpl-3.0.html)。

package/dist/cjs/admin/app.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = (client) => ({
+    addApp: (app) => client.request({
+        url: '/app',
+        method: 'POST',
+        data: app,
+    }),
+    listApp: () => client.request({
+        url: '/app',
+        method: 'GET',
+    }),
+    updateApp: (app) => client.request({
+        url: '/app',
+        method: 'PUT',
+        data: app,
+    }),
+    deleteApp: (id) => client.request({
+        url: `/app/${id}`,
+        method: 'DELETE',
+    }),
+});

package/dist/cjs/admin/authn.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = (client) => ({
+    basicLogin: (user) => client.request({
+        url: '/auth/login/basic',
+        method: 'POST',
+        auth: {
+            username: user.username,
+            password: user.password,
+        },
+        data: user,
+    }),
+    self: () => client.request({
+        url: '/auth/self',
+        method: 'GET',
+    }),
+    token: () => client.request({
+        url: '/auth/token',
+        method: 'GET',
+    }),
+    logout: () => client.request({
+        url: '/auth/logout',
+        method: 'PUT',
+    }),
+});

package/dist/cjs/admin/authz.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = (client) => ({
+    queryUserByRole: (roleId) => client.request({
+        url: `/auth/role/${roleId}/user`,
+        method: 'GET',
+    }),
+    bindUserToRole: (roleUsers) => client.request({
+        url: '/auth/role/-/user',
+        method: 'PUT',
+        data: roleUsers,
+    }),
+    releaseRoleUser: (roleUsers) => client.request({
+        url: '/auth/role/-/user',
+        method: 'DELETE',
+        data: roleUsers,
+    }),
+    queryPermissionByRole: (roleId) => client.request({
+        url: `/auth/role/${roleId}/permission`,
+        method: 'GET',
+    }),
+    bindPermissionToRole: (rolePermissions) => client.request({
+        url: '/auth/role/-/permission',
+        method: 'PUT',
+        data: rolePermissions,
+    }),
+    releaseRolePermission: (rolePermissions) => client.request({
+        url: '/auth/role/-/permission',
+        method: 'DELETE',
+        data: rolePermissions,
+    }),
+    queryRoleByUser: (userId) => client.request({
+        url: `/auth/user/${userId}/role`,
+        method: 'GET',
+    }),
+    queryRoleByPermission: (permission) => client.request({
+        url: '/auth/permission/-/role',
+        method: 'GET',
+        params: { permission },
+    }),
+});

package/dist/cjs/admin/crypto.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = ({ request }) => ({
+    passwordStrength: (password, { username }) => request({
+        url: '/password-strength',
+        method: 'GET',
+        params: { password, username, },
+    }),
+});

package/dist/cjs/admin/dict.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = (client) => ({
+    addDict: (dict) => client.request({
+        url: '/dict',
+        method: 'POST',
+        data: dict,
+    }),
+    getDictTagList: (odata) => client.request({
+        url: '/dict',
+        method: 'GET',
+        params: odata,
+    }),
+    getDictTreeByTag: (tag) => client.request({
+        url: `/dict/tag/${tag}`,
+        method: 'GET',
+    }),
+    modifyDict: (dict) => client.request({
+        url: '/dict',
+        method: 'PUT',
+        data: dict,
+    }),
+    updateDictStatus: (ids, enabled) => client.request({
+        url: '/dict/update-status',
+        method: 'PUT',
+        params: {
+            enabled,
+        },
+        data: ids,
+    }),
+    removeDict: (ids) => client.request({
+        url: '/dict',
+        method: 'DELETE',
+        data: ids,
+    }),
+});

package/dist/cjs/admin/index.js

@@ -0,0 +1,55 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+const app_1 = __importDefault(require("./app"));
+const authn_1 = __importDefault(require("./authn"));
+const authz_1 = __importDefault(require("./authz"));
+const crypto_1 = __importDefault(require("./crypto"));
+const dict_1 = __importDefault(require("./dict"));
+const role_1 = __importDefault(require("./role"));
+const setting_1 = __importDefault(require("./setting"));
+const user_1 = __importDefault(require("./user"));
+exports.default = (config) => {
+    const instance = axios_1.default.create(config);
+    return {
+        /**
+         * 拦截器方法
+         */
+        interceptors: instance.interceptors,
+        /**
+         * 应用管理相关接口
+         */
+        app: (0, app_1.default)(instance),
+        /**
+         * 认证相关接口
+         */
+        authn: (0, authn_1.default)(instance),
+        /**
+         * 授权相关接口
+         */
+        authz: (0, authz_1.default)(instance),
+        /**
+         * 加密相关接口
+         */
+        crypto: (0, crypto_1.default)(instance),
+        /**
+         * 字典相关接口
+         */
+        dict: (0, dict_1.default)(instance),
+        /**
+         * 角色管理接口
+         */
+        role: (0, role_1.default)(instance),
+        /**
+         * 业务参数管理接口
+         */
+        setting: (0, setting_1.default)(instance),
+        /**
+         * 用户相关接口
+         */
+        user: (0, user_1.default)(instance),
+    };
+};

package/dist/cjs/admin/role.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = (client) => ({
+    addRole: (role) => client.request({
+        url: '/role',
+        method: 'POST',
+        data: role,
+    }),
+    listAllRole: () => client.request({
+        url: '/role',
+        method: 'GET',
+    }),
+    deleteRole: (id) => client.request({
+        url: `/role/${id}`,
+        method: 'DELETE',
+    }),
+    listMyRole: () => client.request({
+        url: '/role/mine',
+        method: 'GET',
+    }),
+});

package/dist/cjs/admin/setting.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = (client) => ({
+    addSetting: (setting) => client.request({
+        url: '/setting',
+        method: 'POST',
+        data: setting,
+    }),
+    listSetting: () => client.request({
+        url: '/setting',
+        method: 'GET',
+    }),
+    querySettingByCode: (code) => client.request({
+        url: `/setting/${code}`,
+        method: 'GET',
+    }),
+    updateSchema: (setting) => client.request({
+        url: '/setting/schema',
+        method: 'PUT',
+        data: setting,
+    }),
+    updateValue: (setting) => client.request({
+        url: '/setting/value',
+        method: 'PUT',
+        data: setting,
+    }),
+    deleteSetting: (id) => client.request({
+        url: `/setting/${id}`,
+        method: 'DELETE',
+    }),
+});

package/dist/cjs/admin/user.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = ({ request }) => ({
+    register: (user) => request({
+        url: '/user/register',
+        method: 'POST',
+        data: user,
+    }),
+});

package/dist/cjs/dev/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+const locale_1 = __importDefault(require("./locale"));
+exports.default = (config) => {
+    const instance = axios_1.default.create(config);
+    return {
+        /**
+         * 拦截器方法
+         */
+        interceptors: instance.interceptors,
+        /**
+         * 国际化相关接口
+         */
+        locale: (0, locale_1.default)(instance),
+    };
+};

package/dist/cjs/dev/locale.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = (client) => ({
+    addLanguage: (language) => client.request({
+        url: '/language',
+        method: 'POST',
+        data: language,
+    }),
+    queryLanguageList: () => client.request({
+        url: '/language',
+        method: 'GET',
+    }),
+    updateLanguage: (language) => client.request({
+        url: '/language',
+        method: 'PUT',
+        data: language,
+    }),
+    deleteLanguage: (id) => client.request({
+        url: `/language/${id}`,
+        method: 'DELETE',
+    }),
+    addI18nMessage: (i18nMessage) => client.request({
+        url: '/i18n',
+        method: 'POST',
+        data: i18nMessage,
+    }),
+    listI18nNamespace: () => client.request({
+        url: '/i18n',
+        method: 'GET',
+    }),
+    queryI18nMessageList: (namespace, odata) => client.request({
+        url: `/i18n/${namespace}`,
+        method: 'GET',
+        params: odata,
+    }),
+    updateI18nMessage: (i18nMessage) => client.request({
+        url: '/i18n',
+        method: 'PUT',
+        data: i18nMessage,
+    }),
+    deleteI18nMessage: (id) => client.request({
+        url: `/i18n/${id}`,
+        method: 'DELETE',
+    }),
+    queryTranslation: (namespace, messageKey) => client.request({
+        url: `/i18n/${namespace}/${messageKey}`,
+        method: 'GET',
+    }),
+    upsertTranslation: (translation) => client.request({
+        url: '/locale',
+        method: 'PUT',
+        data: translation,
+    }),
+    loadTranslation: (language, namespace) => client.request({
+        url: `/locale/${language}/${namespace}`,
+        method: 'GET',
+    })
+});

package/dist/cjs/file/attachment.js

@@ -0,0 +1,69 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AttachmentStatus = void 0;
+const upload_1 = require("./upload");
+var AttachmentStatus;
+(function (AttachmentStatus) {
+    AttachmentStatus["UPLOADING"] = "UPLOADING";
+    AttachmentStatus["DONE"] = "DONE";
+})(AttachmentStatus || (exports.AttachmentStatus = AttachmentStatus = {}));
+exports.default = (client) => ({
+    addAttachment: (file, bizType, bizId) => __awaiter(void 0, void 0, void 0, function* () {
+        yield (0, upload_1.checksum)(file);
+        const req = {
+            name: file.name,
+            checksum: file.checksum,
+            size: file.size,
+            type: file.type,
+            bizType,
+            bizId,
+        };
+        return client.request({
+            url: '/attachment',
+            method: 'POST',
+            data: req,
+            params: { crc: file.crc },
+        });
+    }),
+    getUploadInfo: (id, checksum, fileSize) => client.request({
+        url: `/attachment/${id}/resume`,
+        method: 'GET',
+        params: { checksum, fileSize },
+    }),
+    getUploadEndpoint: (id) => client.request({
+        url: `/attachment/${id}/endpoint/upload`,
+        method: 'GET',
+        params: { partNumber: 0 },
+    }),
+    getMultipartUploadEndpoint: (id, partNumber, crc) => client.request({
+        url: `/attachment/${id}/endpoint/upload`,
+        method: 'GET',
+        params: { partNumber, crc },
+    }),
+    finishUpload: (id) => client.request({
+        url: `/attachment/${id}/status/done`,
+        method: 'PUT',
+    }),
+    queryAttachmentByBiz: (bizType, bizId) => client.request({
+        url: `/attachment/list`,
+        method: 'GET',
+        params: { bizType, bizId, },
+    }),
+    getDownloadEndpoint: (id) => client.request({
+        url: `/attachment/${id}/endpoint/download`,
+        method: 'GET',
+    }),
+    deleteAttachment: (id) => client.request({
+        url: `/attachment/${id}`,
+        method: 'DELETE',
+    }),
+});

package/dist/cjs/file/index.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AttachmentStatus = exports.FileProvider = void 0;
+const axios_1 = __importDefault(require("axios"));
+const attachment_1 = __importDefault(require("./attachment"));
+const upload_1 = require("./upload");
+exports.default = (config) => {
+    const instance = axios_1.default.create(config);
+    const attachmentApi = (0, attachment_1.default)(instance);
+    return {
+        /**
+         * 拦截器方法
+         */
+        interceptors: instance.interceptors,
+        /**
+         * 附件管理接口
+         */
+        attachment: attachmentApi,
+        /**
+         * 文件上传
+         * @param file 文件
+         * @param bizType 业务类型
+         * @param bizId 业务编码
+         */
+        upload: (0, upload_1.upload)(instance, attachmentApi),
+    };
+};
+var FileProvider;
+(function (FileProvider) {
+    FileProvider["FS"] = "FS";
+    FileProvider["S3"] = "S3";
+})(FileProvider || (exports.FileProvider = FileProvider = {}));
+var attachment_2 = require("./attachment");
+Object.defineProperty(exports, "AttachmentStatus", { enumerable: true, get: function () { return attachment_2.AttachmentStatus; } });

package/dist/cjs/file/upload.js

@@ -0,0 +1,111 @@
+"use strict";
+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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checksum = checksum;
+exports.upload = upload;
+const crypto_js_1 = __importDefault(require("crypto-js"));
+const js_crc_1 = require("js-crc");
+/**
+ * 计算文件的校验和
+ * @param file 文件
+ * @returns 文件的SHA256值
+ */
+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(() => crypto_js_1.default
+                .SHA256(crypto_js_1.default.lib.WordArray.create(arrayBuffer))
+                .toString(crypto_js_1.default.enc.Base64))
+                .then(checksum => {
+                file.checksum = checksum;
+            }),
+            Promise.resolve()
+                .then(() => crypto_js_1.default.enc.Base64.stringify(crypto_js_1.default.enc.Hex.parse(js_crc_1.crc32.hex(arrayBuffer))))
+                .then(crc => {
+                file.crc = crc;
+            }),
+        ]))
+            .then(() => file);
+    });
+}
+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 = crypto_js_1.default.enc.Base64.stringify(crypto_js_1.default.enc.Hex.parse(js_crc_1.crc32.hex(content)));
+                parts.push({ content, crc });
+            }
+            const content = arrayBuffer.slice((partCount - 1) * partSize, file.size);
+            const crc = crypto_js_1.default.enc.Base64.stringify(crypto_js_1.default.enc.Hex.parse(js_crc_1.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 = crypto_js_1.default
+                    .SHA256(crypto_js_1.default.lib.WordArray.create(part.content))
+                    .toString(crypto_js_1.default.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/cjs/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZerowebDevClient = exports.AttachmentStatus = exports.FileProvider = exports.ZerowebFileClient = exports.SubscriptionStatus = exports.OpenapiStatus = exports.ZerowebOpenClient = exports.ZerowebAdminClient = exports.ServiceType = exports.MenuType = exports.ZerowebMetadataClient = void 0;
+var metadata_1 = require("./metadata");
+Object.defineProperty(exports, "ZerowebMetadataClient", { enumerable: true, get: function () { return __importDefault(metadata_1).default; } });
+Object.defineProperty(exports, "MenuType", { enumerable: true, get: function () { return metadata_1.MenuType; } });
+Object.defineProperty(exports, "ServiceType", { enumerable: true, get: function () { return metadata_1.ServiceType; } });
+var admin_1 = require("./admin");
+Object.defineProperty(exports, "ZerowebAdminClient", { enumerable: true, get: function () { return __importDefault(admin_1).default; } });
+var open_1 = require("./open");
+Object.defineProperty(exports, "ZerowebOpenClient", { enumerable: true, get: function () { return __importDefault(open_1).default; } });
+Object.defineProperty(exports, "OpenapiStatus", { enumerable: true, get: function () { return open_1.OpenapiStatus; } });
+Object.defineProperty(exports, "SubscriptionStatus", { enumerable: true, get: function () { return open_1.SubscriptionStatus; } });
+var file_1 = require("./file");
+Object.defineProperty(exports, "ZerowebFileClient", { enumerable: true, get: function () { return __importDefault(file_1).default; } });
+Object.defineProperty(exports, "FileProvider", { enumerable: true, get: function () { return file_1.FileProvider; } });
+Object.defineProperty(exports, "AttachmentStatus", { enumerable: true, get: function () { return file_1.AttachmentStatus; } });
+var dev_1 = require("./dev");
+Object.defineProperty(exports, "ZerowebDevClient", { enumerable: true, get: function () { return __importDefault(dev_1).default; } });