@schema-platform/platform-shared 0.0.0-stage → 1.7.18

package/README.md

@@ -1,3 +1,158 @@
-# Temporary Holding Version
+# 平台公共包
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+> 所有前端项目共享的组件、工具和配置
+
+## 它是什么？
+
+`@schema-platform/platform-shared` 是 Schema Platform 的公共基础包，提供所有前端项目（Editor、Flow、AI、UA）共用的：
+
+- **组件** — 统一的 UI 组件
+- **工具** — 通用的工具函数
+- **配置** — 共享的构建配置
+- **样式** — 统一的设计令牌
+
+## 主要内容
+
+### 组件
+
+| 组件 | 说明 |
+|------|------|
+| AppIcon | 统一图标组件（基于 Iconify） |
+| AppDialog | 对话框组件 |
+| LoginView | 登录/注册页面 |
+| AuthCallback | SSO 回调处理 |
+
+### 工具
+
+| 工具 | 说明 |
+|------|------|
+| apiClient | Axios HTTP 客户端 |
+| useAuth | 认证组合函数 |
+| sso | SSO 客户端 |
+
+### Qiankun 微前端
+
+| 模块 | 说明 |
+|------|------|
+| createQiankunApp | 创建 qiankun 子应用 |
+| APP_CONFIGS | 子应用配置表 |
+| buildMicroAppUrl | 生成子应用 URL |
+
+### 样式
+
+| 文件 | 说明 |
+|------|------|
+| tokens.css | 设计令牌 |
+| design-tokens.css | 设计系统变量 |
+
+### 配置
+
+| 工具 | 说明 |
+|------|------|
+| createViteConfig | Vite 配置工厂 |
+| setupElementPlus | Element Plus 配置 |
+
+## 使用方法
+
+### 安装
+
+```bash
+npm install @schema-platform/platform-shared
+```
+
+### 发布（GitHub Packages）
+
+`.npmrc` 使用 `${GITHUB_TOKEN}`。**不要**依赖 `~/.npmrc` 里过期的静态 token。固定流程：
+
+```bash
+cd shared/platform-shared
+pnpm publish:pkg
+```
+
+等价于：`pnpm build` + `GITHUB_TOKEN="$(gh auth token)" npm publish`（需已 `gh auth login`，且 token 含 `write:packages`）。
+
+### 导入组件
+
+```typescript
+// 组件
+import { AppIcon, AppDialog } from '@schema-platform/platform-shared/components/common'
+
+// 工具
+import { apiClient } from '@schema-platform/platform-shared/utils/apiClient'
+import { useAuth } from '@schema-platform/platform-shared/utils/useAuth'
+
+// Qiankun
+import { createQiankunApp } from '@schema-platform/platform-shared/qiankun/createQiankunApp'
+import { APP_CONFIGS } from '@schema-platform/platform-shared/qiankun/config'
+
+// 样式
+import '@schema-platform/platform-shared/styles/tokens.css'
+```
+
+### 使用 AppIcon
+
+```vue
+<template>
+  <AppIcon name="add" />
+  <AppIcon name="delete" />
+  <AppIcon name="edit" />
+</template>
+```
+
+图标名称来自 `platform-shared/utils/iconRegistry.ts` 中注册的图标。
+
+### 使用 apiClient
+
+```typescript
+import { apiClient } from '@schema-platform/platform-shared/utils/apiClient'
+
+// GET 请求
+const data = await apiClient.get('/api/schemas')
+
+// POST 请求
+const result = await apiClient.post('/api/schemas', { name: '测试' })
+```
+
+### 使用 useAuth
+
+```typescript
+import { useAuth } from '@schema-platform/platform-shared/utils/useAuth'
+
+const { user, login, logout, isAuthenticated } = useAuth()
+
+// 登录
+await login({ username: 'admin', password: '123456' })
+
+// 检查登录状态
+if (isAuthenticated.value) {
+  console.log('已登录', user.value)
+}
+```
+
+## 开发
+
+### 安装依赖
+
+```bash
+pnpm install
+```
+
+### 构建
+
+```bash
+pnpm build
+```
+
+### 测试
+
+```bash
+pnpm test
+```
+
+## 版本历史
+
+查看 [CHANGELOG.md](./CHANGELOG.md) 了解版本更新。
+
+## 许可证
+
+MIT