@mind-elixir/open-desktop 0.0.3 → 0.0.5

package/README.md

@@ -1,14 +1,6 @@
 # @mind-elixir/open-desktop
 
-一个用于在浏览器中启动 Mind Elixir Desktop 应用并传输思维导图数据的 JavaScript 库。
-
-## 功能特性
-
-- 🚀 自动检测并启动 Mind Elixir Desktop 应用
-- 📡 通过本地服务传输思维导图数据
-- 🔄 智能回退机制：未安装应用时自动跳转到下载页面
-- ⏱️ 可配置的超时和重试机制
-- 📦 TypeScript 支持
+在浏览器中启动 Mind Elixir 应用并传输思维导图数据的 JavaScript 库，支持桌面端、iOS 和 Android。
 
 ## 安装
 
@@ -16,133 +8,72 @@
 npm install @mind-elixir/open-desktop
 ```
 
-或者使用 yarn：
-
-```bash
-yarn add @mind-elixir/open-desktop
-```
-
 ## 使用方法
 
-### 基本用法
-
 ```typescript
 import { launchMindElixir } from '@mind-elixir/open-desktop'
 import type { MindElixirData } from 'mind-elixir'
 
-// 准备思维导图数据
 const mindmapData: MindElixirData = {
   nodeData: {
     id: 'root',
     topic: '中心主题',
-    children: [
-      {
-        id: 'node1',
-        topic: '分支1',
-        children: []
-      },
-      {
-        id: 'node2',
-        topic: '分支2',
-        children: []
-      }
-    ]
+    children: [],
   },
-  linkData: []
+  linkData: [],
 }
 
-// 启动 Mind Elixir 并传输数据
 try {
   await launchMindElixir(mindmapData)
-  console.log('思维导图已成功发送到 Mind Elixir Desktop')
 } catch (error) {
   console.error('启动失败:', error)
 }
 ```
 
-### 高级配置
+### 自定义配置
 
 ```typescript
-import { launchMindElixir } from '@mind-elixir/open-desktop'
-
-const mindmapData = { /* 你的思维导图数据 */ }
-const source = 'https://your-website.com' // 可选：数据来源URL
-
-const options = {
-  appUrl: 'mind-elixir://open',                    // 应用协议URL
-  serviceUrl: 'http://127.0.0.1:6595/create-mindmap', // 服务端点
-  pingUrl: 'http://127.0.0.1:6595/ping',           // 健康检查端点
-  timeout: 10000                                   // 超时时间（毫秒）
-}
-
-try {
-  await launchMindElixir(mindmapData, source, options)
-} catch (error) {
-  if (error.message === '未安装 Mind Elixir Desktop') {
-    // 用户将被自动重定向到下载页面
-    console.log('请安装 Mind Elixir Desktop 应用')
-  } else {
-    console.error('其他错误:', error)
-  }
-}
+import { launchAndCreateMindmap } from '@mind-elixir/open-desktop'
+
+await launchAndCreateMindmap(mindmapData, source, {
+  appUrl: 'mind-elixir://open',
+  serviceUrl: 'http://127.0.0.1:6595/create-mindmap',
+  pingUrl: 'http://127.0.0.1:6595/ping',
+  timeout: 8000, // 应用启动超时（毫秒）
+  settleDelay: 1000, // 服务就绪后等待前端加载完成（毫秒）
+})
 ```
 
-## API 文档
-
-### `launchMindElixir(mindmapData, source?, options?)`
-
-启动 Mind Elixir Desktop 应用并传输思维导图数据。
+## 移动端行为（iOS / Android）
 
-#### 参数
+移动端不使用 `127.0.0.1` 服务。库会把脑图 JSON 编码为 URL-safe Base64，通过 `mind-elixir://create-mindmap` 自定义协议交给 App，因此需要配合支持该协议的 Mind Elixir iOS / Android 版本使用。Android 端由 Manifest 中已注册的 `mind-elixir` scheme 接收，复用 App 的 `getCurrent()` / `onOpenUrl()` 导入逻辑。
 
-- **mindmapData** (`MindElixirData`): 思维导图数据对象
-- **source** (`string`, 可选): 数据来源URL，默认为当前页面URL
-- **options** (`object`, 可选): 配置选项
-  - **appUrl** (`string`): 应用协议URL，默认 `'mind-elixir://open'`
-  - **serviceUrl** (`string`): 服务端点URL，默认 `'http://127.0.0.1:6595/create-mindmap'`
-  - **pingUrl** (`string`): 健康检查端点URL，默认 `'http://127.0.0.1:6595/ping'`
-  - **timeout** (`number`): 服务启动超时时间（毫秒），默认 `8000`
+`launchMindElixir` 必须由点击等用户手势直接触发。移动端 Promise resolve 仅表示已完成 App 唤起，无法确认 App 内是否保存成功，也无法在 App 未安装时自动打开下载页。
 
-#### 返回值
+脑图内容会包含在自定义协议 URL 中。此方式适合小中型脑图；包含大量图片或正文的超大型脑图可能受到系统 URL 长度限制，应改用一次性云端中转或系统文件分享。Android 的 Intent 数据还会经过共享的 Binder 事务缓冲区（约 1MB），更应保持 URL 精简。
 
-返回一个 `Promise<void>`，成功时解析，失败时抛出错误。
+## API
 
-#### 错误处理
+### `launchMindElixir(mindmapData, source?, options?)`
 
-- `"未安装 Mind Elixir Desktop"`: 检测到用户未安装应用，会自动打开下载页面
-- `"服务启动超时"`: 应用启动超时
-- `"发送思维导图数据失败"`: 数据传输失败
+启动 Mind Elixir Desktop 应用并传输思维导图数据。`launchAndCreateMindmap` 为其别名。
 
-## 工作原理
+| 参数 | 类型 | 说明 |
+| --- | --- | --- |
+| `mindmapData` | `MindElixirData` | 思维导图数据 |
+| `source` | `string` | 数据来源 URL，默认当前页面 URL |
+| `options.appUrl` | `string` | 应用协议 URL |
+| `options.serviceUrl` | `string` | 服务端点 URL |
+| `options.pingUrl` | `string` | 健康检查端点 URL |
+| `options.timeout` | `number` | 应用启动超时，默认 `8000` |
+| `options.settleDelay` | `number` | 服务就绪后等待时间，默认 `1000` |
 
-1. **应用检测**: 使用自定义协议 `mind-elixir://` 尝试启动桌面应用
-2. **回退机制**: 如果应用未安装，自动重定向到 Mind Elixir Desktop 下载页面
-3. **服务等待**: 等待本地服务 (端口 6595) 启动并可用
-4. **数据传输**: 通过 HTTP POST 请求将思维导图数据发送到本地服务
+返回 `Promise<void>`。桌面端未安装应用时，会自动打开下载页面，并抛出错误 `"未安装 Mind Elixir Desktop"`；其他失败场景分别抛出 `"服务启动超时"` 或 `"发送思维导图数据失败"`。移动端的完成语义见上方“移动端行为（iOS / Android）”。
 
 ## 系统要求
 
 - 现代浏览器（支持 ES2017+）
-- Mind Elixir Desktop 应用（用于完整功能）
-
-## 开发
-
-```bash
-# 安装依赖
-npm install
-
-# 开发模式（监听文件变化）
-npm run dev
-
-# 构建
-npm run build
-
-# 类型检查
-npm run check-types
-
-# 清理构建文件
-npm run clean
-```
+- Mind Elixir 桌面端，或支持 `create-mindmap` deep link 的 iOS / Android 应用（[下载地址](https://desktop.mind-elixir.com/)）
 
 ## 许可证
 
@@ -151,22 +82,3 @@ MIT License
 ## 相关链接
 
 - [Mind Elixir](https://github.com/ssshooter/mind-elixir-core) - 核心思维导图库
-- [Mind Elixir Desktop](https://desktop.mind-elixir.com/) - 桌面应用下载
-
-## 贡献
-
-欢迎提交 Issue 和 Pull Request！
-
-## 更新日志
-
-### 0.0.1
-
-- 初始版本
-- 支持启动 Mind Elixir Desktop 应用
-- 支持传输思维导图数据
-- 智能回退机制
-
-### 0.0.2
-
-- 导出 openAppWithFallback 方法，可以直接打开地址（无其他操作）
-- launchMindElixir 重命名为 launchAndCreateMindmap

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 import { MindElixirData } from 'mind-elixir';
-export declare function openAppWithFallback(url: string): Promise<unknown>;
 /**
  * 启动 Mind Elixir 并发送思维导图数据
  * @param mindmapData 思维导图数据
@@ -11,10 +10,12 @@ export declare const launchMindElixir: (mindmapData: MindElixirData, source?: st
     serviceUrl?: string;
     pingUrl?: string;
     timeout?: number;
+    settleDelay?: number;
 }) => Promise<void>;
 export declare const launchAndCreateMindmap: (mindmapData: MindElixirData, source?: string, options?: {
     appUrl?: string;
     serviceUrl?: string;
     pingUrl?: string;
     timeout?: number;
+    settleDelay?: number;
 }) => Promise<void>;

package/dist/index.js

@@ -1,49 +1,84 @@
-function a(n) {
-  return new Promise((t, o) => {
-    const i = Date.now(), e = document.createElement("iframe");
-    e.style.display = "none", e.src = n, document.body.appendChild(e), setTimeout(() => {
-      Date.now() - i < 1500 ? (window.open("https://desktop.mind-elixir.com/", "_blank"), o("未安装 Mind Elixir Desktop")) : t(!0);
-    }, 2e3);
-  });
-}
-const c = (n, t = 1e4) => new Promise((o, i) => {
-  const e = Date.now(), r = async () => {
+const a = "https://desktop.mind-elixir.com/", l = "mind-elixir://open", E = "http://127.0.0.1:6595/create-mindmap", h = "http://127.0.0.1:6595/ping";
+const w = () => /iPad|iPhone|iPod|Android/i.test(navigator.userAgent) || // iPadOS 默认使用桌面版 UA，通过触摸点数量区分 Mac。
+navigator.platform === "MacIntel" && navigator.maxTouchPoints > 1, m = () => typeof crypto.randomUUID == "function" ? crypto.randomUUID() : `${Date.now()}-${Math.random().toString(36).slice(2)}`, T = (t) => {
+  const e = new TextEncoder().encode(t);
+  let o = "";
+  for (const n of e) o += String.fromCharCode(n);
+  return btoa(o).replace(/\+/g, "-").replace(/\//g, "_").replace(/=+$/g, "");
+}, U = (t, e, o) => {
+  const n = new URL(t);
+  return n.host = "create-mindmap", n.pathname = "", n.search = "", n.hash = "", n.searchParams.set(
+    "data",
+    T(
+      JSON.stringify({
+        mindmap: JSON.stringify(e),
+        source: o,
+        requestId: m()
+      })
+    )
+  ), n.toString();
+}, c = (t) => {
+  const e = document.createElement("a");
+  e.href = t, e.style.display = "none", document.body.appendChild(e), e.click(), e.remove();
+}, u = () => {
+  window.open(a, "_blank") || (window.location.href = a);
+}, f = (t) => new Promise((e) => setTimeout(e, t)), L = async (t) => {
+  try {
+    return (await fetch(t)).ok;
+  } catch {
+    return !1;
+  }
+}, y = (t, e = 1e4) => new Promise((o, n) => {
+  const i = Date.now(), r = async () => {
     try {
-      if ((await fetch(n)).ok) {
+      if ((await fetch(t)).ok) {
         o();
         return;
       }
     } catch {
     }
-    if (Date.now() - e > t) {
-      i(new Error("服务启动超时"));
+    if (Date.now() - i > e) {
+      n(new Error("服务启动超时"));
       return;
     }
     setTimeout(r, 100);
   };
   r();
-}), p = async (n, t, o = {}) => {
+}), _ = async (t, e, o = {}) => {
   const {
-    appUrl: i = "mind-elixir://open",
-    serviceUrl: e = "http://127.0.0.1:6595/create-mindmap",
-    pingUrl: r = "http://127.0.0.1:6595/ping",
-    timeout: s = 8e3
+    appUrl: n = l,
+    serviceUrl: i = E,
+    pingUrl: r = h,
+    timeout: s = 8e3,
+    settleDelay: p = 1e3
   } = o;
-  if (await a(i), await c(r, s), !(await fetch(e, {
+  if (w()) {
+    c(U(n, t, e || window.location.href));
+    return;
+  }
+  const d = await L(r);
+  if (c(n), !d) {
+    try {
+      await y(r, s);
+    } catch {
+      throw u(), new Error("未安装 Mind Elixir Desktop");
+    }
+    await f(p);
+  }
+  if (!(await fetch(i, {
     method: "POST",
     headers: {
       "Content-Type": "application/json"
     },
     body: JSON.stringify({
-      mindmap: JSON.stringify(n),
-      source: t || window.location.href
+      mindmap: JSON.stringify(t),
+      source: e || window.location.href
     })
   })).ok)
     throw new Error("发送思维导图数据失败");
   console.log("思维导图已成功发送到 Mind Elixir");
-}, d = p;
+}, D = _;
 export {
-  d as launchAndCreateMindmap,
-  p as launchMindElixir,
-  a as openAppWithFallback
+  D as launchAndCreateMindmap,
+  _ as launchMindElixir
 };

package/dist/index.umd.cjs

@@ -1 +1 @@
-(function(e,t){typeof exports=="object"&&typeof module<"u"?t(exports):typeof define=="function"&&define.amd?define(["exports"],t):(e=typeof globalThis<"u"?globalThis:e||self,t(e.OpenDesktop={}))})(this,function(e){"use strict";function t(i){return new Promise((o,r)=>{const s=Date.now(),n=document.createElement("iframe");n.style.display="none",n.src=i,document.body.appendChild(n),setTimeout(()=>{Date.now()-s<1500?(window.open("https://desktop.mind-elixir.com/","_blank"),r("未安装 Mind Elixir Desktop")):o(!0)},2e3)})}const d=(i,o=1e4)=>new Promise((r,s)=>{const n=Date.now(),a=async()=>{try{if((await fetch(i)).ok){r();return}}catch{}if(Date.now()-n>o){s(new Error("服务启动超时"));return}setTimeout(a,100)};a()}),p=async(i,o,r={})=>{const{appUrl:s="mind-elixir://open",serviceUrl:n="http://127.0.0.1:6595/create-mindmap",pingUrl:a="http://127.0.0.1:6595/ping",timeout:c=8e3}=r;if(await t(s),await d(a,c),!(await fetch(n,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify({mindmap:JSON.stringify(i),source:o||window.location.href})})).ok)throw new Error("发送思维导图数据失败");console.log("思维导图已成功发送到 Mind Elixir")},l=p;e.launchAndCreateMindmap=l,e.launchMindElixir=p,e.openAppWithFallback=t,Object.defineProperty(e,Symbol.toStringTag,{value:"Module"})});
+(function(r,i){typeof exports=="object"&&typeof module<"u"?i(exports):typeof define=="function"&&define.amd?define(["exports"],i):(r=typeof globalThis<"u"?globalThis:r||self,i(r.OpenDesktop={}))})(this,function(r){"use strict";const i="https://desktop.mind-elixir.com/",l="mind-elixir://open",f="http://127.0.0.1:6595/create-mindmap",h="http://127.0.0.1:6595/ping",u=()=>/iPad|iPhone|iPod|Android/i.test(navigator.userAgent)||navigator.platform==="MacIntel"&&navigator.maxTouchPoints>1,E=()=>typeof crypto.randomUUID=="function"?crypto.randomUUID():`${Date.now()}-${Math.random().toString(36).slice(2)}`,m=n=>{const e=new TextEncoder().encode(n);let o="";for(const t of e)o+=String.fromCharCode(t);return btoa(o).replace(/\+/g,"-").replace(/\//g,"_").replace(/=+$/g,"")},T=(n,e,o)=>{const t=new URL(n);return t.host="create-mindmap",t.pathname="",t.search="",t.hash="",t.searchParams.set("data",m(JSON.stringify({mindmap:JSON.stringify(e),source:o,requestId:E()}))),t.toString()},d=n=>{const e=document.createElement("a");e.href=n,e.style.display="none",document.body.appendChild(e),e.click(),e.remove()},w=()=>{window.open(i,"_blank")||(window.location.href=i)},U=n=>new Promise(e=>setTimeout(e,n)),y=async n=>{try{return(await fetch(n)).ok}catch{return!1}},L=(n,e=1e4)=>new Promise((o,t)=>{const a=Date.now(),s=async()=>{try{if((await fetch(n)).ok){o();return}}catch{}if(Date.now()-a>e){t(new Error("服务启动超时"));return}setTimeout(s,100)};s()}),p=async(n,e,o={})=>{const{appUrl:t=l,serviceUrl:a=f,pingUrl:s=h,timeout:c=8e3,settleDelay:_=1e3}=o;if(u()){d(T(t,n,e||window.location.href));return}const g=await y(s);if(d(t),!g){try{await L(s,c)}catch{throw w(),new Error("未安装 Mind Elixir Desktop")}await U(_)}if(!(await fetch(a,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify({mindmap:JSON.stringify(n),source:e||window.location.href})})).ok)throw new Error("发送思维导图数据失败");console.log("思维导图已成功发送到 Mind Elixir")},A=p;r.launchAndCreateMindmap=A,r.launchMindElixir=p,Object.defineProperty(r,Symbol.toStringTag,{value:"Module"})});

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@mind-elixir/open-desktop",
   "private": false,
-  "version": "0.0.3",
+  "version": "0.0.5",
   "type": "module",
-  "description": "Import XMind files to MindElixir format",
+  "description": "Launch Mind Elixir and import mind map data from a browser",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "publishConfig": {