openclaw-nim 0.0.1

package/src/targets.ts

@@ -0,0 +1,94 @@
+/**
+ * Normalize a NIM target to a plain account ID.
+ * Strips common prefixes like "nim:", "user:", etc.
+ */
+export function normalizeNimTarget(target: string): string | null {
+  if (!target || typeof target !== "string") {
+    return null;
+  }
+
+  let normalized = target.trim();
+
+  // Remove common prefixes
+  const prefixes = ["nim:", "user:", "account:", "p2p:"];
+  for (const prefix of prefixes) {
+    if (normalized.toLowerCase().startsWith(prefix)) {
+      normalized = normalized.slice(prefix.length);
+      break;
+    }
+  }
+
+  normalized = normalized.trim();
+
+  if (!normalized) {
+    return null;
+  }
+
+  return normalized;
+}
+
+/**
+ * Check if a string looks like a NIM account ID.
+ * NIM account IDs are alphanumeric strings, typically 1-32 characters.
+ */
+export function looksLikeNimId(value: string): boolean {
+  if (!value || typeof value !== "string") {
+    return false;
+  }
+
+  const normalized = normalizeNimTarget(value);
+  if (!normalized) {
+    return false;
+  }
+
+  // NIM account IDs: alphanumeric, underscores, 1-32 chars
+  return /^[a-zA-Z0-9_]{1,32}$/.test(normalized);
+}
+
+/**
+ * Format a NIM target for display.
+ */
+export function formatNimTarget(target: string): string {
+  const normalized = normalizeNimTarget(target);
+  if (!normalized) {
+    return target;
+  }
+  return `nim:${normalized}`;
+}
+
+/**
+ * Build a session ID for a P2P conversation.
+ */
+export function buildP2pSessionId(account1: string, account2: string): string {
+  // NIM session IDs are typically "p2p-{targetAccount}"
+  return `p2p-${account2}`;
+}
+
+/**
+ * Parse a session ID to extract the target account.
+ */
+export function parseSessionId(sessionId: string): { scene: "p2p" | "team"; targetId: string } | null {
+  if (!sessionId) {
+    return null;
+  }
+
+  if (sessionId.startsWith("p2p-")) {
+    return {
+      scene: "p2p",
+      targetId: sessionId.slice(4),
+    };
+  }
+
+  if (sessionId.startsWith("team-")) {
+    return {
+      scene: "team",
+      targetId: sessionId.slice(5),
+    };
+  }
+
+  // Assume P2P if no prefix
+  return {
+    scene: "p2p",
+    targetId: sessionId,
+  };
+}

package/src/types.ts

@@ -0,0 +1,203 @@
+/**
+ * NIM Types - node-nim SDK 版本
+ */
+
+import type { NimConfigSchema } from "./config-schema.js";
+import type { z } from "zod";
+
+/**
+ * NIM 配置类型
+ */
+export type NimConfig = z.infer<typeof NimConfigSchema>;
+
+/**
+ * NIM 消息类型
+ */
+export type NimMessageType = 
+  | "text"
+  | "image"
+  | "audio"
+  | "video"
+  | "file"
+  | "geo"
+  | "notification"
+  | "custom"
+  | "tip"
+  | "robot"
+  | "unknown";
+
+/**
+ * NIM 会话类型
+ */
+export type NimSessionType = "p2p" | "team" | "superTeam";
+
+/**
+ * NIM 消息事件（从 SDK 回调接收）
+ */
+export interface NimMessageEvent {
+  /** 消息 ID */
+  msgId: string;
+  /** 消息客户端 ID */
+  clientMsgId: string;
+  /** 会话类型 */
+  sessionType: NimSessionType;
+  /** 发送者账号 */
+  from: string;
+  /** 接收者账号/群ID */
+  to: string;
+  /** 消息类型 */
+  type: NimMessageType;
+  /** 文本内容 */
+  text?: string;
+  /** 消息时间戳 (毫秒) */
+  time: number;
+  /** 附件信息 (图片/文件/音视频等) */
+  attach?: NimAttachment;
+  /** 扩展字段 */
+  ext?: Record<string, unknown>;
+  /** 原始消息对象 */
+  rawMsg?: unknown;
+}
+
+/**
+ * NIM 附件信息
+ */
+export interface NimAttachment {
+  /** 文件名 */
+  name?: string;
+  /** 文件大小 */
+  size?: number;
+  /** 文件 URL */
+  url?: string;
+  /** 文件扩展名 */
+  ext?: string;
+  /** 文件 MD5 */
+  md5?: string;
+  /** 图片宽度 */
+  w?: number;
+  /** 图片高度 */
+  h?: number;
+  /** 音视频时长 (秒) */
+  dur?: number;
+  /** 地理位置标题 */
+  title?: string;
+  /** 纬度 */
+  lat?: number;
+  /** 经度 */
+  lng?: number;
+}
+
+/**
+ * NIM 消息上下文（业务层使用）
+ */
+export interface NimMessageContext {
+  /** 唯一标识 */
+  id: string;
+  /** 会话 ID */
+  sessionId: string;
+  /** 会话类型 */
+  sessionType: NimSessionType;
+  /** 发送者 ID */
+  senderId: string;
+  /** 发送者名称 */
+  senderName?: string;
+  /** 消息类型 */
+  type: NimMessageType;
+  /** 文本内容 */
+  text: string;
+  /** 时间戳 */
+  timestamp: number;
+  /** 媒体附件 */
+  attachments?: NimMediaInfo[];
+  /** 是否为私聊 */
+  isDm: boolean;
+  /** 原始事件 */
+  rawEvent: NimMessageEvent;
+}
+
+/**
+ * NIM 媒体信息
+ */
+export interface NimMediaInfo {
+  type: "image" | "file" | "audio" | "video";
+  url: string;
+  name?: string;
+  size?: number;
+  width?: number;
+  height?: number;
+  duration?: number;
+  localPath?: string;
+}
+
+/**
+ * NIM 发送结果
+ */
+export interface NimSendResult {
+  success: boolean;
+  msgId?: string;
+  clientMsgId?: string;
+  error?: string;
+  errorCode?: number;
+}
+
+/**
+ * NIM 探测结果
+ */
+export interface NimProbeResult {
+  connected: boolean;
+  account?: string;
+  error?: string;
+  loginState?: string;
+}
+
+/**
+ * NIM DM 策略
+ */
+export type NimDmPolicy = "open" | "pairing" | "allowlist";
+
+/**
+ * 解析后的 NIM 账户配置
+ */
+export interface ResolvedNimAccount {
+  id: string;
+  appKey: string;
+  account: string;
+  token: string;
+  enabled: boolean;
+  dmPolicy: NimDmPolicy;
+  allowFrom: Array<string | number>;
+}
+
+/**
+ * NIM 客户端实例接口
+ */
+export interface NimClientInstance {
+  /** 是否已初始化 */
+  initialized: boolean;
+  /** 是否已登录 */
+  loggedIn: boolean;
+  /** 当前账号 */
+  account: string;
+  /** 登录 */
+  login(): Promise<boolean>;
+  /** 登出 */
+  logout(): Promise<void>;
+  /** 发送文本消息 */
+  sendText(to: string, text: string, sessionType?: NimSessionType): Promise<NimSendResult>;
+  /** 发送图片消息 */
+  sendImage(to: string, filePath: string, sessionType?: NimSessionType): Promise<NimSendResult>;
+  /** 发送文件消息 */
+  sendFile(to: string, filePath: string, sessionType?: NimSessionType): Promise<NimSendResult>;
+  /** 发送音频消息 */
+  sendAudio(to: string, filePath: string, duration: number, sessionType?: NimSessionType): Promise<NimSendResult>;
+  /** 发送视频消息 */
+  sendVideo(to: string, filePath: string, duration: number, width: number, height: number, sessionType?: NimSessionType): Promise<NimSendResult>;
+  /** 注册消息回调 */
+  onMessage(callback: (msg: NimMessageEvent) => void): void;
+  /** 移除消息回调 */
+  offMessage(callback: (msg: NimMessageEvent) => void): void;
+  /** 注册连接状态回调 */
+  onConnectionChange(callback: (state: string) => void): void;
+  /** 销毁客户端 */
+  destroy(): Promise<void>;
+}