@mtop-devtools/cloud-types - npm Package Compare versions

Comparing version 1.38.1 to 1.38.2

README.md

+# @mtop-devtools/cloud-types
+
+Mtop DevTools 云端通信链路的共享类型与常量。
+
+`cloud-client`、`cloud-server`、`cloud-connector` 三端通过 WebSocket 互通，本包定义它们之间消息的**统一协议**（消息结构、心跳、缓冲区上限、各类超时默认值），确保三端对线上格式始终一致。
+
+> 仅供 monorepo 内部使用。
+
+## 导出
+
+### 消息类型
+
+```typescript
+interface CloudMessage {
+  id: string;
+  action: string;
+  data: Record<string, any>;
+}
+
+interface CloudResponse {
+  id: string;
+  success: boolean;
+  data?: any;
+  error?: string;
+  versionWarning?: string;
+}
+
+interface HeartbeatMessage {
+  type: 'ping' | 'pong';
+  timestamp: number;
+}
+```
+
+### 类型守卫
+
+```typescript
+isHeartbeatMessage(msg): msg is HeartbeatMessage
+isCloudMessage(msg): msg is CloudMessage
+isCloudResponse(msg): msg is CloudResponse
+```
+
+### 常量
+
+```typescript
+MAX_BUFFER_SIZE            // 10 MB，单条消息缓冲上限
+DEFAULT_REQUEST_TIMEOUT    // 60s
+DEFAULT_CONNECT_TIMEOUT    // 30s
+DEFAULT_HEARTBEAT_INTERVAL // 30s
+DEFAULT_HEARTBEAT_TIMEOUT  // 90s
+```
+
+## 使用
+
+```typescript
+import { type CloudMessage, isCloudResponse, DEFAULT_REQUEST_TIMEOUT } from '@mtop-devtools/cloud-types';
+```
+
+## 构建
+
+```bash
+pnpm build      # tsc 编译到 dist/
+pnpm dev        # tsc --watch
+pnpm typecheck  # 仅类型检查
+```
+
+## License
+
+ISC

package.json

 {
   "name": "@mtop-devtools/cloud-types",
-  "version": "1.38.1",
+  "version": "1.38.2",
   "description": "Shared types for Mtop DevTools cloud communication packages",
@@ -5,0 +5,0 @@ "type": "module",

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Improved metrics

Total package byte prevSize

3449

67.43%

Number of package files

4

33.33%

Number of medium quality alerts

1

-50%

Number of lines in readme file

69

Infinity%

No dependency changes