@dofe/sso-contracts 0.1.2 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +38 -28
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -82,11 +82,7 @@ throw ApiExceptionV2.fromCode(TeamErrorCode.TeamNotFound);
82
82
  ### 前端错误处理
83
83
 
84
84
  ```typescript
85
- import {
86
- TeamErrorCode,
87
- handleApiError,
88
- createErrorHandler,
89
- } from '@repo/contracts/errors';
85
+ import { TeamErrorCode, handleApiError, createErrorHandler } from '@repo/contracts/errors';
90
86
 
91
87
  // 创建类型安全的错误处理器
92
88
  const teamErrorHandler = createErrorHandler({
@@ -211,43 +207,56 @@ pnpm --filter @repo/contracts build
211
207
  本包在 workspace 内使用名称 `@repo/contracts`,发布到 npmjs 时使用名称 `@dofe/sso-contracts`。
212
208
 
213
209
  发布脚本会自动处理名称转换:
210
+
214
211
  - `prepack` - 发布前将名称改为 `@dofe/sso-contracts`
215
212
  - `postpack` - 发布后恢复为 `@repo/contracts`
216
213
 
217
214
  ### 发布命令
218
215
 
216
+ #### 从根目录发布(推荐)
217
+
219
218
  ```bash
220
- # 进入 contracts 目录
221
- cd sso.dofe.ai/packages/contracts
219
+ # sso.dofe.ai 根目录执行
222
220
 
223
- # 发布 patch 版本 (0.1.0 → 0.1.1)
224
- pnpm release:patch
221
+ # 发布单个包
222
+ pnpm release:contracts # 发布 @dofe/sso-contracts
223
+ pnpm release:contracts:otp # 带 OTP 发布
224
+
225
+ # 批量发布所有包
226
+ pnpm release:all # 发布 contracts、hooks、ui
227
+ pnpm release:all:otp # 带 OTP 批量发布
228
+ ```
225
229
 
226
- # 发布 minor 版本 (0.1.0 → 0.2.0)
227
- pnpm release:minor
230
+ #### 从包目录发布
228
231
 
229
- # 发布 major 版本 (0.1.0 → 1.0.0)
230
- pnpm release:major
232
+ ```bash
233
+ # 进入 contracts 目录
234
+ cd sso.dofe.ai/packages/contracts
231
235
 
232
- # 带 OTP 发布(如果启用了 2FA)
233
- npm publish --access public --otp=<你的OTP码>
236
+ # 手动发布流程
237
+ pnpm build
238
+ node scripts/prepack.mjs
239
+ npm publish --access public --ignore-scripts --otp=<你的OTP码>
240
+ node scripts/postpack.mjs
234
241
  ```
235
242
 
236
- ### 发布流程详解
243
+ ### 从根目录发布流程详解
237
244
 
238
245
  ```bash
239
- pnpm release:patch
246
+ pnpm release:contracts:otp
240
247
  ```
241
248
 
242
249
  执行步骤:
243
- 1. `npm version patch` - 升级版本号
244
- 2. `pnpm run prepack` - 将 package.json 名称改为 `@dofe/sso-contracts`
245
- 3. `npm publish --access public` - 发布到 npmjs
246
- 4. `pnpm run postpack` - 恢复 package.json 名称为 `@repo/contracts`
250
+
251
+ 1. 进入 `packages/contracts` 目录
252
+ 2. 运行 `prepack` 修改 package.json(名称改为 `@dofe/sso-contracts`)
253
+ 3. 执行 `npm publish --access public --ignore-scripts --otp`
254
+ 4. 运行 `postpack` 恢复 package.json 原始状态
247
255
 
248
256
  ### 前置条件
249
257
 
250
258
  1. npm 账户登录:
259
+
251
260
  ```bash
252
261
  npm login
253
262
  ```
@@ -276,14 +285,14 @@ import { internalContract } from '@dofe/sso-contracts/api';
276
285
 
277
286
  ### 可用导出
278
287
 
279
- | 导出路径 | 内容 |
280
- |---------|------|
281
- | `@dofe/sso-contracts` | 所有 schemas、contracts、errors |
282
- | `@dofe/sso-contracts/api` | API contracts |
283
- | `@dofe/sso-contracts/schemas` | Zod schemas |
288
+ | 导出路径 | 内容 |
289
+ | -------------------------------------- | ---------------------------------- |
290
+ | `@dofe/sso-contracts` | 所有 schemas、contracts、errors |
291
+ | `@dofe/sso-contracts/api` | API contracts |
292
+ | `@dofe/sso-contracts/schemas` | Zod schemas |
284
293
  | `@dofe/sso-contracts/schemas/internal` | Internal API schemas (Tenant/Team) |
285
- | `@dofe/sso-contracts/errors` | Error codes |
286
- | `@dofe/sso-contracts/base` | Base utilities (createApiResponse) |
294
+ | `@dofe/sso-contracts/errors` | Error codes |
295
+ | `@dofe/sso-contracts/base` | Base utilities (createApiResponse) |
287
296
 
288
297
  ### 常见问题
289
298
 
@@ -294,6 +303,7 @@ A: 确保 npm 账户有权限发布 `@dofe` scope 包。需要先在 npmjs 创
294
303
  **Q: 发布失败 "Package already exists"**
295
304
 
296
305
  A: 版本号已存在,需要升级版本:
306
+
297
307
  ```bash
298
308
  pnpm release:patch
299
309
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dofe/sso-contracts",
3
- "version": "0.1.2",
3
+ "version": "0.1.4",
4
4
  "description": "SSO API contracts and schemas for DofeAI platform",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",