@brewer/dj-common 1.0.0-beta.0 → 1.0.0-beta.1

package/package.json

@@ -1,11 +1,16 @@
 {
   "name": "@brewer/dj-common",
-  "version": "1.0.0-beta.0",
+  "version": "1.0.0-beta.1",
   "description": "多端通用的公共方法库，支持 PC、H5、APP 等平台",
   "type": "module",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
   "exports": {
     ".": {
       "import": "./dist/index.esm.js",

package/.claude/settings.local.json

@@ -1,28 +0,0 @@
-{
-  "permissions": {
-    "allow": [
-      "Bash(npm install:*)",
-      "Bash(npm run build:*)",
-      "Bash(npx husky init)",
-      "Bash(git init:*)",
-      "Bash(git add:*)",
-      "Bash(git commit:*)",
-      "Bash(npx eslint:*)",
-      "Bash(npx lint-staged:*)",
-      "Bash(npx prettier:*)",
-      "Bash(git reset:*)",
-      "Bash(npm run release:dry-run:*)",
-      "Bash(npm token:*)",
-      "Bash(node:*)",
-      "Bash(npm whoami:*)",
-      "Bash(git checkout:*)",
-      "Bash(npm run lint)",
-      "Bash(npx standard-version --prerelease beta)",
-      "Bash(npm publish:*)",
-      "Bash(npm view:*)",
-      "Bash(git push:*)",
-      "Bash(ls:*)",
-      "Bash(git tag:*)"
-    ]
-  }
-}

package/.gitattributes

@@ -1,19 +0,0 @@
-# 强制所有文本文件使用 LF 换行符
-* text=auto eol=lf
-
-# 明确指定文件类型
-*.ts text eol=lf
-*.js text eol=lf
-*.json text eol=lf
-*.md text eol=lf
-*.yml text eol=lf
-*.yaml text eol=lf
-
-# 二进制文件
-*.png binary
-*.jpg binary
-*.jpeg binary
-*.gif binary
-*.ico binary
-*.woff binary
-*.woff2 binary

package/.github/workflows/release.yml

@@ -1,56 +0,0 @@
-name: Release
-
-on:
-  push:
-    tags:
-      - 'v*' # 当推送 v 开头的 tag 时触发，如 v1.0.0
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-
-    permissions:
-      contents: write # 需要写权限来创建 release
-
-    steps:
-      - name: 检出代码
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0 # 获取完整的 git 历史，用于生成 CHANGELOG
-
-      - name: 设置 Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '22.x'
-          registry-url: 'https://registry.npmjs.org'
-          cache: 'npm'
-
-      - name: 指定 npm registry 为官方源
-        run: npm config set registry https://registry.npmjs.org
-
-      - name: 安装依赖
-        run: npm install
-
-      - name: 运行 ESLint 检查
-        run: npm run lint
-
-      - name: 构建项目
-        run: npm run build
-
-      - name: 发布到 NPM
-        run: |
-          if [[ ${{ github.ref }} == refs/tags/*-beta.* ]]; then
-            npm publish --tag beta --access public
-          else
-            npm publish --access public
-          fi
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-
-      - name: 创建 GitHub Release
-        uses: softprops/action-gh-release@v1
-        with:
-          body_path: CHANGELOG.md
-          generate_release_notes: true
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.husky/commit-msg

@@ -1 +0,0 @@
-npx --no -- commitlint --edit $1

package/.husky/pre-commit

@@ -1 +0,0 @@
-npx lint-staged

package/.lintstagedrc.json

@@ -1,4 +0,0 @@
-{
-  "*.{js,jsx,ts,tsx}": ["eslint --fix", "prettier --write"],
-  "*.{json,md,yml,yaml}": ["prettier --write"]
-}

package/.prettierignore

@@ -1,4 +0,0 @@
-node_modules
-dist
-*.min.js
-package-lock.json

package/.prettierrc

@@ -1,9 +0,0 @@
-{
-  "semi": false,
-  "singleQuote": true,
-  "printWidth": 120,
-  "tabWidth": 2,
-  "trailingComma": "es5",
-  "arrowParens": "always",
-  "endOfLine": "lf"
-}

package/.versionrc.json

@@ -1,22 +0,0 @@
-{
-  "header": "# 更新日志\n\n所有重要的变更都将记录在此文件中。\n\n",
-  "types": [
-    { "type": "feat", "section": "✨ 新功能" },
-    { "type": "fix", "section": "🐛 Bug 修复" },
-    { "type": "perf", "section": "⚡ 性能优化" },
-    { "type": "refactor", "section": "♻️ 代码重构" },
-    { "type": "docs", "section": "📝 文档更新" },
-    { "type": "style", "section": "💄 代码格式" },
-    { "type": "test", "section": "✅ 测试" },
-    { "type": "build", "section": "📦 构建" },
-    { "type": "ci", "section": "👷 CI" },
-    { "type": "chore", "section": "🔧 其他" }
-  ],
-  "skip": {
-    "bump": false,
-    "changelog": false,
-    "commit": false,
-    "tag": false
-  },
-  "releaseCommitMessageFormat": "chore(release): {{currentTag}} [skip ci]"
-}

package/commitlint.config.cjs

@@ -1,23 +0,0 @@
-module.exports = {
-  extends: ['@commitlint/config-conventional'],
-  rules: {
-    'type-enum': [
-      2,
-      'always',
-      [
-        'feat',     // 新功能
-        'fix',      // 修复 bug
-        'docs',     // 文档更新
-        'style',    // 代码格式（不影响代码运行的变动）
-        'refactor', // 重构（既不是新增功能，也不是修复 bug）
-        'perf',     // 性能优化
-        'test',     // 增加测试
-        'build',    // 构建过程或辅助工具的变动
-        'ci',       // CI 配置文件和脚本的变动
-        'chore',    // 其他不修改 src 或 test 的变动
-        'revert',   // 回退
-      ],
-    ],
-    'subject-case': [0], // 不限制主题大小写
-  },
-}

package/docs/README.md

@@ -1,80 +0,0 @@
-# @brewer/dj-common API 文档
-
-> 多端通用的公共方法库 API 文档
-
-## 快速开始
-
-```bash
-npm install @brewer/dj-common
-```
-
-## 模块列表
-
-### WebSocket 相关
-
-- [WebSocketClient](./api/WebSocketClient.md) - 通用 WebSocket 客户端基类
-- [MessageSocket](./api/MessageSocket.md) - 业务层 WebSocket 封装
-
-## 使用指南
-
-### 基础使用
-
-```typescript
-import { WebSocketClient } from '@brewer/dj-common'
-
-const client = new WebSocketClient({
-  heartbeatInterval: 30000,
-  autoReconnect: true,
-})
-
-client.on('message', (data) => {
-  console.log('收到消息:', data)
-})
-
-client.connect('ws://localhost:8080')
-```
-
-### 类型安全
-
-所有模块都提供完整的 TypeScript 类型定义：
-
-```typescript
-import { WebSocketClient, WebSocketConfig, MessageData } from '@brewer/dj-common'
-
-const config: WebSocketConfig = {
-  heartbeatInterval: 30000,
-  maxReconnectAttempts: 10,
-}
-
-const client = new WebSocketClient(config)
-
-client.on<{ content: string }>('message', (data) => {
-  // data 类型为 { content: string }
-  console.log(data.content)
-})
-```
-
-## 特性
-
-- 📘 **TypeScript** - 完整的类型定义
-- 📦 **多格式支持** - ESM 和 CommonJS
-- 🔌 **按需引入** - Tree-shaking 支持
-- 🔧 **可配置** - 灵活的配置选项
-- 🔄 **自动重连** - 智能重连机制
-- 💓 **心跳检测** - 保持连接活性
-
-## 相关链接
-
-- [GitHub 仓库](https://github.com/beerui/dj-common)
-- [NPM 包](https://www.npmjs.com/package/@brewer/dj-common)
-- [更新日志](../CHANGELOG.md)
-- [开发指南](../DEVELOPMENT.md)
-- [测试指南](../TESTING.md)
-
-## 贡献
-
-欢迎贡献代码！请查看 [开发指南](../DEVELOPMENT.md) 了解如何参与开发。
-
-## 许可证
-
-MIT © BeerUi

package/eslint.config.js

@@ -1,76 +0,0 @@
-import js from '@eslint/js'
-import typescript from '@typescript-eslint/eslint-plugin'
-import typescriptParser from '@typescript-eslint/parser'
-import prettier from 'eslint-plugin-prettier'
-import prettierConfig from 'eslint-config-prettier'
-
-export default [
-  // 全局忽略文件
-  {
-    ignores: ['node_modules/**', 'dist/**', 'examples/**'],
-  },
-
-  // JavaScript/TypeScript 通用配置
-  {
-    files: ['**/*.{js,mjs,cjs,ts}'],
-    ignores: ['**/*.config.{js,mjs,cjs}'], // 忽略配置文件
-    languageOptions: {
-      ecmaVersion: 'latest',
-      sourceType: 'module',
-      parser: typescriptParser,
-      parserOptions: {
-        project: './tsconfig.json',
-      },
-      globals: {
-        // 浏览器环境
-        window: 'readonly',
-        document: 'readonly',
-        navigator: 'readonly',
-        // Node.js 环境
-        process: 'readonly',
-        __dirname: 'readonly',
-        __filename: 'readonly',
-        module: 'readonly',
-        require: 'readonly',
-        exports: 'writable',
-        global: 'readonly',
-        // ES2021
-        console: 'readonly',
-        // 定时器相关（浏览器和 Node.js 都有）
-        setTimeout: 'readonly',
-        clearTimeout: 'readonly',
-        setInterval: 'readonly',
-        clearInterval: 'readonly',
-        setImmediate: 'readonly',
-        clearImmediate: 'readonly',
-      },
-    },
-    plugins: {
-      '@typescript-eslint': typescript,
-      prettier: prettier,
-    },
-    rules: {
-      // ESLint 推荐规则
-      ...js.configs.recommended.rules,
-      // TypeScript 推荐规则
-      ...typescript.configs.recommended.rules,
-      // Prettier 配置
-      ...prettierConfig.rules,
-
-      // 自定义规则
-      'no-console': 'off',
-      'no-unused-vars': 'off',
-      '@typescript-eslint/no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
-      '@typescript-eslint/no-explicit-any': 'warn',
-      'prettier/prettier': 'warn',
-    },
-  },
-
-  // .js 和 .cjs 文件特殊配置
-  {
-    files: ['**/*.{js,cjs}'],
-    rules: {
-      '@typescript-eslint/no-var-requires': 'off',
-    },
-  },
-]

package/examples/basic-test/README.md

@@ -1,39 +0,0 @@
-# dj-common 测试示例
-
-这是一个简单的测试项目，用于验证 dj-common 包是否正常工作。
-
-## 运行测试
-
-在项目根目录（dj-common）执行：
-
-```bash
-# 1. 构建项目
-npm run build
-
-# 2. 运行测试
-node examples/basic-test/index.js
-```
-
-## 测试内容
-
-- ✅ 创建 WebSocketClient 实例
-- ✅ 注册消息回调
-- ✅ 检查模块导出
-
-## 使用 npm link 测试
-
-如果想在其他项目中测试：
-
-```bash
-# 在 dj-common 根目录
-npm link
-
-# 在其他项目中
-npm link @brewer/dj-common
-```
-
-然后就可以像正常安装的包一样使用了：
-
-```javascript
-import { WebSocketClient } from '@brewer/dj-common'
-```

package/examples/basic-test/index.js

@@ -1,56 +0,0 @@
-// 基础测试示例
-import { WebSocketClient } from '../../dist/index.esm.js'
-
-console.log('🧪 开始测试 dj-common...\n')
-
-// 测试 1: 创建实例
-console.log('✓ 测试 1: 创建 WebSocketClient 实例')
-try {
-  const client = new WebSocketClient({
-    heartbeatInterval: 30000,
-    maxReconnectAttempts: 5,
-    autoReconnect: true,
-  })
-  console.log('  ✅ 实例创建成功')
-  console.log('  配置:', {
-    heartbeatInterval: 30000,
-    maxReconnectAttempts: 5,
-    autoReconnect: true,
-  })
-} catch (error) {
-  console.error('  ❌ 实例创建失败:', error.message)
-  process.exit(1)
-}
-
-// 测试 2: 注册消息回调
-console.log('\n✓ 测试 2: 注册消息回调')
-try {
-  const client = new WebSocketClient()
-  client.on('test-message', (data) => {
-    console.log('收到消息:', data)
-  })
-  console.log('  ✅ 消息回调注册成功')
-} catch (error) {
-  console.error('  ❌ 消息回调注册失败:', error.message)
-  process.exit(1)
-}
-
-// 测试 3: 检查类型导出
-console.log('\n✓ 测试 3: 检查导出')
-try {
-  console.log('  ✅ WebSocketClient 已导出')
-  console.log('  类型:', typeof WebSocketClient)
-} catch (error) {
-  console.error('  ❌ 导出检查失败:', error.message)
-  process.exit(1)
-}
-
-console.log('\n🎉 所有测试通过！\n')
-console.log('💡 提示：')
-console.log('  - 要测试 WebSocket 连接，需要启动一个 WebSocket 服务器')
-console.log('  - 然后取消注释下面的连接代码\n')
-
-// 实际连接测试（需要 WebSocket 服务器）
-// console.log('✓ 测试 4: 连接 WebSocket 服务器')
-// const client = new WebSocketClient()
-// client.connect('ws://localhost:8080')

package/examples/basic-test/package.json

@@ -1,10 +0,0 @@
-{
-  "name": "@brewer/dj-common-test",
-  "version": "1.0.0",
-  "private": true,
-  "description": "Test example for @brewer/dj-common",
-  "type": "module",
-  "scripts": {
-    "test": "node index.js"
-  }
-}

package/scripts/release.sh

@@ -1,98 +0,0 @@
-#!/bin/bash
-
-# 发布脚本 - 自动化 npm 包发布流程
-
-set -e
-
-echo "🚀 开始发布流程..."
-echo ""
-
-# 1. 检查是否在 git 仓库中
-if [ ! -d ".git" ]; then
-  echo "❌ 错误: 当前目录不是 git 仓库"
-  exit 1
-fi
-
-# 2. 检查是否有未提交的更改
-if [[ -n $(git status -s) ]]; then
-  echo "❌ 错误: 有未提交的更改，请先提交或暂存"
-  git status -s
-  exit 1
-fi
-
-# 3. 确保在主分支
-CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
-if [ "$CURRENT_BRANCH" != "main" ] && [ "$CURRENT_BRANCH" != "master" ]; then
-  echo "⚠️  警告: 当前不在 main/master 分支"
-  read -p "是否继续? (y/N) " -n 1 -r
-  echo
-  if [[ ! $REPLY =~ ^[Yy]$ ]]; then
-    exit 1
-  fi
-fi
-
-# 4. 拉取最新代码
-echo "📥 拉取最新代码..."
-git pull origin $CURRENT_BRANCH || true
-echo ""
-
-# 5. 运行代码检查
-echo "🔍 运行代码检查..."
-npm run lint
-echo ""
-
-# 6. 运行构建
-echo "📦 构建项目..."
-npm run build
-echo ""
-
-# 7. 选择版本类型
-echo "请选择版本更新类型:"
-echo "  1) patch (bug 修复) - 1.0.0 -> 1.0.1"
-echo "  2) minor (新功能)   - 1.0.0 -> 1.1.0"
-echo "  3) major (破坏性更新) - 1.0.0 -> 2.0.0"
-echo "  4) custom (自定义)"
-echo ""
-read -p "请输入选项 (1-4): " version_type
-
-case $version_type in
-  1)
-    npm run release:patch
-    ;;
-  2)
-    npm run release:minor
-    ;;
-  3)
-    npm run release:major
-    ;;
-  4)
-    read -p "请输入版本号 (如 1.2.3): " custom_version
-    npm run release -- --release-as $custom_version
-    ;;
-  *)
-    echo "❌ 无效的选项"
-    exit 1
-    ;;
-esac
-
-echo ""
-
-# 8. 推送到远程仓库
-echo "📤 推送到远程仓库..."
-git push --follow-tags origin $CURRENT_BRANCH
-echo ""
-
-# 9. 发布到 npm
-read -p "是否发布到 npm? (y/N) " -n 1 -r
-echo
-if [[ $REPLY =~ ^[Yy]$ ]]; then
-  echo "📦 发布到 npm..."
-  npm publish
-  echo ""
-  echo "✅ 发布成功!"
-else
-  echo "⏭️  跳过 npm 发布"
-fi
-
-echo ""
-echo "🎉 发布流程完成!"

package/tsconfig.json

@@ -1,25 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "ESNext",
-    "lib": ["ES2020", "DOM"],
-    "declaration": true,
-    "declarationMap": true,
-    "outDir": "./dist",
-    "rootDir": "./src",
-    "removeComments": false,
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "moduleResolution": "node",
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist", "**/*.spec.ts"]
-}