leadal-auth 0.0.5 → 0.0.6

package/README.md

@@ -1,83 +1,199 @@
-# Leadal Auth - 身份认证管理系统
+# LD-Auth UI - 机构管理组件
 
-一个基于Vue.js 2.x的身份认证管理系统，支持人脸识别、指纹识别和卡片认证等多种认证方式。
+一个基于 Vue 2 和 Element UI 构建的企业级机构管理组件库，提供完整的组织架构和用户管理功能。
 
-## 功能特性
+## ✨ 特性
 
-- 🔐 多种认证方式：人脸识别、指纹识别、卡片认证
-- 🎯 组织架构管理
-- 👥 用户信息管理
-- 📱 响应式设计，支持移动端
-- 🔌 可插拔的认证模块
+- 🌳 **树形机构管理** - 支持无限层级的组织架构树
+- 👥 **用户管理** - 完整的用户增删改查功能
+- 🔐 **权限管理** - 支持多种认证方式（人脸、指纹、身份卡）
+- 📊 **分页查询** - 高效的用户数据分页展示
+- 🎨 **现代化UI** - 基于 Element UI 的美观界面
+- 📦 **组件化** - 可独立使用的 Vue 组件
 
-## 技术栈
+## 🚀 快速开始
 
-- **前端框架**: Vue.js 2.6.14
-- **UI组件库**: Element UI 2.15.14
-- **状态管理**: Vuex 3.1.0
-- **人脸识别**: face-api.js 0.22.2
-- **构建工具**: Vue CLI 5.0
-
-## 快速开始
-
-### 安装依赖
+### 安装
 
 ```bash
-yarn install
-# 或
-npm install
+npm install ld-auth-ui
 ```
 
-### 开发环境运行
+### 基本使用
 
-```bash
-yarn serve
-# 或
-npm run serve
-```
+```javascript
+import Vue from 'vue'
+import LdAuth from 'ld-auth-ui'
+import 'ld-auth-ui/ld-auth.css' // 引入样式文件（必需）
 
-### 生产环境构建
+Vue.use(LdAuth, {
+  baseUrl: 'http://your-api-server.com' // 可选：配置API基础URL
+})
+```
 
-```bash
-yarn build
-# 或
-npm run build
+在模板中使用：
+
+```vue
+<template>
+  <div>
+    <auth-manage :auth-collect="['face', 'finger', 'idCard']">
+      <!-- 自定义插槽内容 -->
+      <template #face>
+        <!-- 人脸采集组件 -->
+      </template>
+      <template #finger>
+        <!-- 指纹采集组件 -->
+      </template>
+      <template #idCard>
+        <!-- 身份卡绑定组件 -->
+      </template>
+    </auth-manage>
+  </div>
+</template>
 ```
 
-### 构建认证包
+## 📖 核心组件
+
+### AuthManage 主组件
+
+机构管理的主要组件，包含机构树和用户管理功能。
+
+**Props:**
+- `authCollect` (Array): 认证方式集合，默认 `['face', 'finger', 'idCard']`
+
+**插槽:**
+- `face`: 人脸采集组件插槽
+- `finger`: 指纹采集组件插槽
+- `idCard`: 身份卡绑定组件插槽
+
+### OrganTree 机构树组件
+
+提供机构的树形展示和管理功能。
+
+**功能:**
+- 懒加载机构树数据
+- 新增/编辑/删除机构
+- 支持无限层级结构
+
+### UserTable 用户管理组件
+
+用户数据的表格展示和批量操作。
+
+**功能:**
+- 分页展示用户列表
+- 用户搜索和筛选
+- 批量操作（启用/禁用/删除/调换机构）
+- 密码重置功能
+
+### UserDrawer 用户详情抽屉
+
+用户信息编辑和认证管理界面。
+
+**功能:**
+- 用户基本信息编辑
+- 多种认证方式管理
+- 支持自定义认证组件
+
+## 🔧 开发
+
+### 环境要求
+
+- Node.js >= 12
+- Vue 2.6+
+- Element UI 2.15+
+
+### 本地开发
 
 ```bash
-yarn package
-# 或
+# 克隆项目
+git clone [repository-url]
+
+# 安装依赖
+npm install
+
+# 启动开发服务器
+npm run serve
+
+# 构建生产版本
+npm run build
+
+# 构建组件库
 npm run package
 ```
 
-## 项目结构
+### 项目结构
 
 ```
 src/
-├── api/           # API接口
-├── components/    # 组件
-│   ├── face-register/     # 人脸注册
-│   ├── finger-register/   # 指纹注册
-│   └── card-register/     # 卡片注册
-├── package/       # 认证包
-├── store/         # Vuex状态管理
-└── utils/         # 工具函数
+├── api/                  # API 接口定义
+├── components/           # 组件库
+│   ├── auth-com.vue     # 认证组件
+│   ├── organ-tree.vue   # 机构树组件
+│   ├── tree-select.vue  # 树形选择器
+│   ├── user-drawer.vue  # 用户详情抽屉
+│   ├── user-info.vue    # 用户信息组件
+│   └── user-table.vue   # 用户表格组件
+├── package/             # 组件库打包入口
+│   └── auth-manage/     # 主组件
+├── store/               # Vuex 状态管理
+├── styles/              # 样式文件
+└── utils/               # 工具函数
+    ├── dict.js          # 数据字典
+    └── request.js       # HTTP 请求封装
 ```
 
-## 配置说明
+## 🌐 API 接口
 
-在 `src/main.js` 中配置认证服务：
+### 机构管理接口
 
-```javascript
-Vue.use(LdAuth, {
-  baseUrl: "http://dftdm.netiler.com",
-  authUrl: "http://dftdm.netiler.com",
-  websocketUrl: "ws://10.1.22.32:38280",
-});
-```
+- `GET /api/fencing-component-api/organization/tree` - 获取机构树
+- `POST /api/fencing-component-api/organization/save` - 保存机构
+- `DELETE /api/fencing-component-api/organization/delete` - 删除机构
+
+### 用户管理接口
+
+- `GET /api/fencing-component-api/user/page/{page}/{size}` - 分页查询用户
+- `POST /api/fencing-component-api/user/save` - 保存用户
+- `DELETE /api/fencing-component-api/user/delete` - 删除用户
+- `POST /api/fencing-component-api/user/update-status` - 更新用户状态
+- `POST /api/fencing-component-api/user/reset-password` - 重置密码
+- `POST /api/fencing-component-api/user/move` - 移动用户
+
+## 📝 数据字典
+
+### 用户性别
+- 0: 男
+- 1: 女  
+- 2: 保密
+
+### 用户类型
+- 0: 系统用户
+- 1: 临时用户
+- 2: 职员
+- 4: 会员
+
+### 密级
+- 0: 非密
+- 1: 一般
+- 2: 重要
+- 3: 核心
+
+### 认证类型
+- face: 人脸采集
+- finger: 指纹采集
+- idCard: 身份卡绑定
+
+## 🎨 样式定制
+
+组件使用 SCSS 进行样式开发，支持主题定制。主要样式文件：
+
+- `src/styles/index.scss` - 全局样式
+- 各组件的 `<style>` 块 - 组件特定样式
 
-## 许可证
+## 🤝 贡献指南
 
-ISC
+1. Fork 本仓库
+2. 创建您的特性分支 (`git checkout -b feature/AmazingFeature`)
+3. 提交您的修改 (`git commit -m 'Add some AmazingFeature'`)
+4. 推送到分支 (`git push origin feature/AmazingFeature`)
+5. 打开一个 Pull Request