@mearl/cloud-types 2.0.0

package/README.md

@@ -0,0 +1,74 @@
+# @mearl/cloud-types
+
+Mearl 云端通信链路的共享类型与常量。
+
+`cloud-client`、`cloud-server`、`cloud-connector` 三端通过 WebSocket 互通，本包定义它们之间消息的**统一协议**（消息结构、心跳、缓冲区上限、各类超时默认值），确保三端对线上格式始终一致。
+
+> 仅供 monorepo 内部使用。
+
+## 导出
+
+### 消息类型
+
+```typescript
+interface CloudMessage {
+  id: string;
+  action: string;
+  data: Record<string, any>;
+  browser?: string;
+  timeoutSec?: number;
+}
+
+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 '@mearl/cloud-types';
+```
+
+## 构建
+
+```bash
+pnpm build      # tsc 编译到 dist/
+pnpm dev        # tsc --watch
+pnpm typecheck  # 仅类型检查
+```
+
+## License
+
+ISC

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+export interface CloudMessage {
+    id: string;
+    action: string;
+    data: Record<string, any>;
+    /**
+     * Target a specific browser on the connector's machine by id / name. Omitted →
+     * the connector's default (most-recently-focused) browser.
+     */
+    browser?: string;
+    /** Action execution timeout forwarded to the local socket client. */
+    timeoutSec?: number;
+}
+export interface CloudResponse {
+    id: string;
+    success: boolean;
+    data?: any;
+    error?: string;
+    versionWarning?: string;
+}
+export interface HeartbeatMessage {
+    type: 'ping' | 'pong';
+    timestamp: number;
+}
+export declare const MAX_BUFFER_SIZE: number;
+export declare const DEFAULT_REQUEST_TIMEOUT = 60;
+export declare const DEFAULT_HEARTBEAT_INTERVAL = 30;
+export declare const DEFAULT_CONNECT_TIMEOUT = 30;
+export declare const DEFAULT_HEARTBEAT_TIMEOUT = 90;
+export declare function isHeartbeatMessage(msg: any): msg is HeartbeatMessage;
+export declare function isCloudMessage(msg: any): msg is CloudMessage;
+export declare function isCloudResponse(msg: any): msg is CloudResponse;

package/dist/index.js

@@ -0,0 +1,14 @@
+export const MAX_BUFFER_SIZE = 10 * 1024 * 1024;
+export const DEFAULT_REQUEST_TIMEOUT = 60;
+export const DEFAULT_HEARTBEAT_INTERVAL = 30;
+export const DEFAULT_CONNECT_TIMEOUT = 30;
+export const DEFAULT_HEARTBEAT_TIMEOUT = 90;
+export function isHeartbeatMessage(msg) {
+    return msg && (msg.type === 'ping' || msg.type === 'pong');
+}
+export function isCloudMessage(msg) {
+    return msg && typeof msg.id === 'string' && typeof msg.action === 'string';
+}
+export function isCloudResponse(msg) {
+    return msg && typeof msg.id === 'string' && typeof msg.success === 'boolean';
+}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@mearl/cloud-types",
+  "version": "2.0.0",
+  "description": "Shared types for Mearl cloud communication packages",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "mearl",
+    "cloud-types"
+  ],
+  "license": "ISC",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.3"
+  },
+  "scripts": {
+    "build": "rm -rf dist/ && tsc",
+    "dev": "tsc --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run"
+  }
+}