@ithinkdt/cloud

@ithinkdt/cloud

许可证

MIT

安装

npm i @ithinkdt/cloud

需要您自行安装依赖 vue@3、@ithinkdt/app 与 @ithinkdt/page。

介绍

@ithinkdt/cloud 提供 iThinkDT 平台的云 API 集成能力，包括：

• 认证登录（登录、登出、修改密码、刷新令牌）
• 用户信息与模块权限获取
• 前端应用配置获取
• 国际化资源管理（增删改查）
• 字典数据获取
• 系统参数获取
• 文件上传、下载与预览
• 组织架构与用户查询
• 消息通知（未读计数、分页查询、标记已读/删除）
• 图标渲染
• 租户切换
• CRUD API 工厂

初始化

注册 HTTP 拦截器

建议在应用入口处注册 interceptor 以统一处理认证错误：

import { interceptor } from '@ithinkdt/cloud'

// 注册全局拦截器，自动处理 603/604/605/606 等认证错误
app.use(appCore, {
    // ...
    setup: (app) => {
        interceptor({
            language: () => app.language,
            onAuthError(type, error) {
                // type: 'NOT_VALID_TOKEN_TYPE' | 'REQUEST_TOKEN_ERROR' | 'ACCOUNT_FREEZE_ERROR' | 'LOGIN_EXPIRED'
                console.error(type, error)
            },
        })
    },
})

创建 Cloud API 客户端

import cloud from '@ithinkdt/cloud'

// 创建 cloud 服务，传入系统服务名
const api = cloud('/sys-server')

// 获取所有应用
const apps = await api.getAllApps()

// 获取应用名称
const name = await api.getAppName('admin', 'zh-CN')

// 获取前端配置
const config = await api.getFrontConfig('admin')

// 获取认证工具
const auth = api.authenticator('admin', 'zh-CN')
const userInfo = await auth.login('username', 'password')
const modules = await auth.getUserModules(token)

使用 Composable（推荐）

import { useCloud } from '@ithinkdt/cloud'
import { ref, computed } from 'vue'

const {
    renderLogo,           // 渲染 Logo
    getIconRender,        // 获取图标渲染函数
    notification,         // 消息通知
    getDictByTypes,       // 获取字典
    getSysParams,         // 获取系统参数
    uploadFile,           // 上传文件
    previewFileUrl,       // 文件预览 URL
    downloadFileUrl,      // 文件下载 URL
    getFileInfos,         // 获取文件信息
    removeFile,           // 删除文件
    changeTenant,         // 切换租户
    getModuleResources,   // 获取模块国际化资源
    saveResources,        // 保存国际化资源
    deleteResources,      // 删除国际化资源
    getResources,         // 获取国际化资源
} = useCloud({
    sysServerName: '/sys-server',
    mcServerName: '/mc-server',
    fileServerName: '/file-server',
})

// 获取字典
const dicts = await getDictByTypes(['sex', 'status'], 'zh-CN')

// 获取未读消息数
const unreadCount = await notification.getUnreadCount()

// 上传文件
const fileId = await uploadFile(file, {
    accessRight: 'INTERNAL',
    onProgress: (percent) => console.log(`${percent}%`),
})

// 获取系统参数
const params = await getSysParams('email')

CRUD API 工厂

createCrudApi 提供标准的增删改查接口封装，自动根据资源名生成 RESTful API 调用：

import { createCrudApi } from '@ithinkdt/cloud'

// 快速创建
const userApi = createCrudApi('user')

// 查询列表
const users = await userApi.list({ filter: { status: 1 } })

// 分页查询
const page = await userApi.page({ currentPage: 1, pageSize: 20 })

// 获取详情
const detail = await userApi.get('id-xxx')

// 新增
const newUser = await userApi.save({ name: '张三' })

// 修改
await userApi.put({ id: 'id-xxx', name: '李四' })

// 删除
await userApi.delete('id-xxx')

// 批量删除
await userApi.delete(['id-1', 'id-2'])

自定义 API 路径

const api = createCrudApi({
    resource: 'user',
    list: 'post|json: /api/user/search',
    page: 'post|json: /api/user/page',
    get: 'get: /api/user/detail',
    save: 'post|json: /api/user/create',
    delete: 'post|json: /api/user/remove',
    deletes: 'post|json: /api/user/removeBatch',
})

API 参考

cloud(sysServerName, options?)

创建 Cloud API 客户端。

返回值方法：

authenticator 方法

getFrontConfig 参数

useCloud(options?)

Vue Composable，提供云 API 集成能力。

返回值方法：

notification 消息通知

createCrudApi(resource)

创建标准增删改查接口。

CrudApiOptions 配置：

返回值方法：