mn-docs-mcp 0.6.2 → 1.1.0

package/src/content/docs/libmn/frame.md

@@ -0,0 +1,279 @@
+---
+title: Frame
+description: LibMN中的Frame对象API文档。
+---
+
+`Frame`是用于统一管理视图布局的工具对象，提供视图frame的读写、定位和尺寸调整等功能。
+
+## 类成员(Class members)
+
+### 属性
+
+无。
+
+### 方法
+
+#### `gen`
+
+##### 类型
+
+```ts
+static gen(x: number,y: number,width: number,height: number): CGRect
+```
+
+##### 说明
+
+根据x、y、width、height生成标准CGRect。该方法只做结构组装，不校正非法尺寸。
+
+##### 参数
+
+| 参数名   | 类型     | 必填 | 说明                               |
+|:---------|:---------|:-----|:-----------------------------------|
+| `x`      | `number` | 是   | 目标x坐标。 |
+| `y`      | `number` | 是   | 目标y坐标。 |
+| `width`  | `number` | 是   | 目标宽度。 |
+| `height` | `number` | 是   | 目标高度。 |
+
+##### 返回值
+
+- 类型:`CGRect`
+- 语义:返回可直接赋给`view.frame`的`CGRect`对象。
+#### `set`
+
+##### 类型
+
+```ts
+static set(view: UIView,x: number,y: number,width: number,height: number): void
+```
+
+##### 说明
+
+一次性设置view的frame四个分量。传入数值会直接覆盖原位置和大小。
+
+##### 参数
+
+| 参数名   | 类型     | 必填 | 说明                               |
+|:---------|:---------|:-----|:-----------------------------------|
+| `view` | `UIView` | 是   | 目标视图对象。       |
+| `x`      | `number` | 是   | 目标x坐标。 |
+| `y`      | `number` | 是   | 目标y坐标。 |
+| `width`  | `number` | 是   | 目标宽度。 |
+| `height` | `number` | 是   | 目标高度。 |
+
+##### 返回值
+
+- 类型:`void`
+- 语义:frame更新完成后立即返回，不提供更新结果回调。
+#### `sameFrame`
+
+##### 类型
+
+```ts
+static sameFrame(frame1: CGRect,frame2: CGRect): boolean
+```
+
+##### 说明
+
+比较两个CGRect是否表示同一位置和尺寸。任一分量不同都会返回false。
+
+##### 参数
+
+| 参数名   | 类型     | 必填 | 说明                         |
+|:---------|:---------|:-----|:-----------------------------|
+| `frame1` | `CGRect` | 是   | 待比较的第一个frame。 |
+| `frame2` | `CGRect` | 是   | 待比较的第二个frame。 |
+
+##### 返回值
+
+- 类型:`boolean`
+- 语义:四个分量都一致时返回`true`，否则返回`false`。
+#### `setX`
+
+##### 类型
+
+```ts
+static setX(view: UIView,x: number): void
+```
+
+##### 说明
+
+仅更新view的x坐标。宽高和y坐标保持原值。
+
+##### 参数
+
+| 参数名 | 类型     | 必填 | 说明                               |
+|:-------|:---------|:-----|:-----------------------------------|
+| `view` | `UIView` | 是   | 目标视图对象。       |
+| `x`    | `number` | 是   | 目标x坐标。 |
+
+##### 返回值
+
+- 类型:`void`
+- 语义:仅更新x坐标后立即返回，不影响其余frame分量。
+#### `setY`
+
+##### 类型
+
+```ts
+static setY(view: UIView,y: number): void
+```
+
+##### 说明
+
+仅更新view的y坐标。宽高和x坐标保持原值。
+
+##### 参数
+
+| 参数名 | 类型     | 必填 | 说明                               |
+|:-------|:---------|:-----|:-----------------------------------|
+| `view` | `UIView` | 是   | 目标视图对象。       |
+| `y`    | `number` | 是   | 目标y坐标。 |
+
+##### 返回值
+
+- 类型:`void`
+- 语义:仅更新y坐标后立即返回，不影响其余frame分量。
+#### `setLoc`
+
+##### 类型
+
+```ts
+static setLoc(view: UIView,x: number,y: number): void
+```
+
+##### 说明
+
+同时更新view的x和y坐标。宽高保持原值。
+
+##### 参数
+
+| 参数名 | 类型     | 必填 | 说明                               |
+|:-------|:---------|:-----|:-----------------------------------|
+| `view` | `UIView` | 是   | 目标视图对象。       |
+| `x`    | `number` | 是   | 目标x坐标。 |
+| `y`    | `number` | 是   | 目标y坐标。 |
+
+##### 返回值
+
+- 类型:`void`
+- 语义:更新x和y坐标后立即返回，宽高保持不变。
+#### `setSize`
+
+##### 类型
+
+```ts
+static setSize(view: UIView,width: number,height: number): void
+```
+
+##### 说明
+
+同时更新view的width和height。位置坐标保持原值。
+
+##### 参数
+
+| 参数名   | 类型     | 必填 | 说明                               |
+|:---------|:---------|:-----|:-----------------------------------|
+| `view` | `UIView` | 是   | 目标视图对象。       |
+| `width`  | `number` | 是   | 目标宽度。 |
+| `height` | `number` | 是   | 目标高度。 |
+
+##### 返回值
+
+- 类型:`void`
+- 语义:更新宽高后立即返回，位置坐标保持不变。
+#### `setWidth`
+
+##### 类型
+
+```ts
+static setWidth(view: UIView,width: number): void
+```
+
+##### 说明
+
+仅更新view的width。x、y和height保持原值。
+
+##### 参数
+
+| 参数名  | 类型     | 必填 | 说明                               |
+|:--------|:---------|:-----|:-----------------------------------|
+| `view` | `UIView` | 是   | 目标视图对象。       |
+| `width` | `number` | 是   | 目标宽度。 |
+
+##### 返回值
+
+- 类型:`void`
+- 语义:仅更新宽度后立即返回，不影响其余frame分量。
+#### `setHeight`
+
+##### 类型
+
+```ts
+static setHeight(view: UIView,height: number): void
+```
+
+##### 说明
+
+仅更新view的height。x、y和width保持原值。
+
+##### 参数
+
+| 参数名   | 类型     | 必填 | 说明                               |
+|:---------|:---------|:-----|:-----------------------------------|
+| `view` | `UIView` | 是   | 目标视图对象。       |
+| `height` | `number` | 是   | 目标高度。 |
+
+##### 返回值
+
+- 类型:`void`
+- 语义:仅更新高度后立即返回，不影响其余frame分量。
+#### `moveX`
+
+##### 类型
+
+```ts
+static moveX(view: UIView,xDiff: number): void
+```
+
+##### 说明
+
+按xDiff在当前基础上平移view。正值向右移动，负值向左移动。
+
+##### 参数
+
+| 参数名  | 类型     | 必填 | 说明                         |
+|:--------|:---------|:-----|:-----------------------------|
+| `view` | `UIView` | 是   | 目标视图对象。 |
+| `xDiff` | `number` | 是   | x方向增量。 |
+
+##### 返回值
+
+- 类型:`void`
+- 语义:按给定增量完成x方向平移后立即返回。
+#### `moveY`
+
+##### 类型
+
+```ts
+static moveY(view: UIView,yDiff: number): void
+```
+
+##### 说明
+
+按yDiff在当前基础上平移view。正值向下移动，负值向上移动。
+
+##### 参数
+
+| 参数名  | 类型     | 必填 | 说明                         |
+|:--------|:---------|:-----|:-----------------------------|
+| `view` | `UIView` | 是   | 目标视图对象。 |
+| `yDiff` | `number` | 是   | y方向增量。 |
+
+##### 返回值
+
+- 类型:`void`
+- 语义:按给定增量完成y方向平移后立即返回。
+
+## 实例成员(Instance members)
+
+无实例成员。

package/src/content/docs/libmn/headers.md

@@ -0,0 +1,234 @@
+---
+title: Headers
+description: LibMN中的Headers对象API文档。
+---
+
+`Headers`是HTTP头容器，实现了追加、覆盖、读取和可迭代遍历能力，键名统一按小写存储。
+
+## 构造函数
+
+```ts
+new Headers(init?: Headers|Array<[string,string]>|Record<string,string>)
+```
+
+构造一个新的Headers实例。
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `init` | `Headers\|Array<[string,string]>\|Record<string,string>` | 否 | 初始头集合。 |
+
+## 类成员(Class members)
+
+无类成员。
+
+## 实例成员(Instance members)
+
+### 属性
+
+无。
+
+### 方法
+
+#### `append`
+
+##### 类型
+
+```ts
+append(name: string,value: string|number|boolean): void
+```
+
+##### 说明
+
+向同名头追加值，不会覆盖旧值，结果使用逗号拼接。
+
+##### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `name` | `string` | 是 | 头名称。 |
+| `value` | `string\|number\|boolean` | 是 | 头值，会被转换为字符串。 |
+
+##### 返回值
+
+- 类型:`void`
+- 语义:无返回值。
+
+#### `delete`
+
+##### 类型
+
+```ts
+delete(name: string): void
+```
+
+##### 说明
+
+删除指定头。
+
+##### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `name` | `string` | 是 | 头名称。 |
+
+##### 返回值
+
+- 类型:`void`
+- 语义:无返回值。
+
+#### `get`
+
+##### 类型
+
+```ts
+get(name: string): string|null
+```
+
+##### 说明
+
+读取指定头值，不存在时返回`null`。
+
+##### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `name` | `string` | 是 | 头名称。 |
+
+##### 返回值
+
+- 类型:`string|null`
+- 语义:返回对应头值或`null`。
+
+#### `has`
+
+##### 类型
+
+```ts
+has(name: string): boolean
+```
+
+##### 说明
+
+判断是否存在指定头。
+
+##### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `name` | `string` | 是 | 头名称。 |
+
+##### 返回值
+
+- 类型:`boolean`
+- 语义:存在时返回`true`。
+
+#### `set`
+
+##### 类型
+
+```ts
+set(name: string,value: string|number|boolean): void
+```
+
+##### 说明
+
+设置指定头，若已存在则覆盖旧值。
+
+##### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `name` | `string` | 是 | 头名称。 |
+| `value` | `string\|number\|boolean` | 是 | 头值，会被转换为字符串。 |
+
+##### 返回值
+
+- 类型:`void`
+- 语义:无返回值。
+
+#### `forEach`
+
+##### 类型
+
+```ts
+forEach(callback: (value: string,key: string,parent: Headers) => void,thisArg?: any): void
+```
+
+##### 说明
+
+遍历全部头键值对，遍历顺序与内部`Map`一致。
+
+##### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `callback` | `(value: string,key: string,parent: Headers) => void` | 是 | 遍历回调。 |
+| `thisArg` | `any` | 否 | 回调执行时的`this`上下文。 |
+
+##### 返回值
+
+- 类型:`void`
+- 语义:无返回值。
+
+#### `keys`
+
+##### 类型
+
+```ts
+keys(): IterableIterator<string>
+```
+
+##### 说明
+
+返回头名迭代器。
+
+##### 参数
+
+无。
+
+##### 返回值
+
+- 类型:`IterableIterator<string>`
+- 语义:可迭代的头名集合。
+
+#### `values`
+
+##### 类型
+
+```ts
+values(): IterableIterator<string>
+```
+
+##### 说明
+
+返回头值迭代器。
+
+##### 参数
+
+无。
+
+##### 返回值
+
+- 类型:`IterableIterator<string>`
+- 语义:可迭代的头值集合。
+
+#### `entries`
+
+##### 类型
+
+```ts
+entries(): IterableIterator<[string,string]>
+```
+
+##### 说明
+
+返回头键值对迭代器。
+
+##### 参数
+
+无。
+
+##### 返回值
+
+- 类型:`IterableIterator<[string,string]>`
+- 语义:可迭代的头键值对集合。

package/src/content/docs/libmn/index.md

@@ -0,0 +1,60 @@
+---
+title: LibMN
+description: 基于AddonLib源码整理的LibMN完整API导航与阅读路线。
+---
+LibMN是一个面向MarginNote插件开发的运行时基础库，由林立飞的MNUtils裁剪而来，未来会合并至Marginnote本体中。
+
+合并后本文档会更新如下面这段话，也许...
+
+> LibMN已于Marginnote4的v4.x.x合并至本体，
+
+## 阅读路线
+
+如果你第一次接触LibMN，建议按这个顺序看:
+
+1. [Runtime](/libmn/runtime/)与[RuntimeAssets](/libmn/runtime-assets/)，先建立“插件生命周期+路由分发”的主线认知。
+2. [MNUtil](/libmn/mnutil/)，看通用能力入口，特别是窗口、文件、URL、网络与弹窗相关能力。
+3. [MNNote](/libmn/mnnote/)、[MNNotebook](/libmn/mnnotebook/)、[MNDocument](/libmn/mndocument/)，建立数据模型与写入路径。
+4. [MNWebview](/libmn/mnwebview/)、[MNButton](/libmn/mnbutton/)、[Menu](/libmn/menu/)，处理交互层构建。
+5. [LibMN Internal Exposed](/libmn/internal-exposed/)与[LibMN Vendor Globals](/libmn/vendor-globals/)，理解内部成员和第三方依赖边界。
+
+## 类别索引
+
+### 运行时与入口
+
+- [Runtime](/libmn/runtime/)
+- [RuntimeAssets](/libmn/runtime-assets/)
+- [RuntimeWebViewHost](/libmn/runtime-web-view-host/)
+
+### 数据模型封装
+
+- [MNNote](/libmn/mnnote/)
+- [MNComment](/libmn/mncomment/)
+- [MNNotebook](/libmn/mnnotebook/)
+- [MNDocument](/libmn/mndocument/)
+
+### 通用能力与工具
+
+- [MNUtil](/libmn/mnutil/)
+- [DataConverter](/libmn/data-converter/)
+- [Locale](/libmn/locale/)
+- [Headers](/libmn/headers/)
+- [Response](/libmn/response/)
+- [Mustache](/libmn/mustache/)
+
+### UI与交互封装
+
+- [MNWebview](/libmn/mnwebview/)
+- [MNButton](/libmn/mnbutton/)
+- [MNExtensionPanel](/libmn/mnextension-panel/)
+- [Menu](/libmn/menu/)
+- [Frame](/libmn/frame/)
+
+### 通信与辅助
+
+- [MNConnection](/libmn/mnconnection/)
+
+### 边界与依赖
+
+- [LibMN Internal Exposed](/libmn/internal-exposed/)
+- [LibMN Vendor Globals](/libmn/vendor-globals/)

package/src/content/docs/libmn/internal-exposed.md

@@ -0,0 +1,46 @@
+---
+title: LibMN Internal Exposed
+description: LibMN中可见但不建议业务长期依赖的内部成员说明。
+---
+
+本页记录`Internal`级成员。这些成员主要用于启动胶水层和生命周期桥接，能用但不承诺稳定兼容。
+
+## RuntimeAddon
+
+`RuntimeAddon`由`addon.js`中的`JSB.defineClass`创建，核心职责是把MarginNote生命周期事件转发给`Runtime.emitLifecycle(...)`。
+
+### 实例生命周期入口
+
+- `sceneWillConnect(): Promise<void>`场景连接时触发，内部会注册广播监听并转发生命周期事件。
+- `sceneDidDisconnect(): void`场景断开时触发。
+- `notebookWillOpen(notebookId: string): void`笔记本打开前触发。
+- `notebookWillClose(notebookId: string): void`笔记本关闭前触发。
+- `documentDidOpen(documentController: DocumentController): void`文档打开后触发。
+- `documentWillClose(documentController: DocumentController): void`文档关闭前触发。
+- `controllerWillLayoutSubviews(controller: UIViewController): void`控制器布局前触发。
+- `onAddonBroadcast(notification: { userInfo: { message: string }; window: UIWindow; name: string }): Promise<object|void>`接收广播并按路由分发。命中路由处理器时返回对应处理结果，其他场景返回`void`。
+- `queryAddonCommandStatus(): object|boolean|void`查询工具栏命令状态。返回值来自生命周期回调链中首个真值结果。
+
+### 类生命周期入口
+
+- `addonDidConnect(): void`插件连接完成时触发。
+- `addonWillDisconnect(): void`插件断连前触发。
+- `applicationWillEnterForeground(): void`应用进入前台时触发。
+- `applicationDidEnterBackground(): void`应用进入后台时触发。
+
+## 其他Internal成员
+
+| 名称 | 来源 | 角色定位 | 实务建议 |
+|:---|:---|:---|:---|
+| `__mnRuntimeModules` | `main.js` | 模块幂等加载标记表 | 仅启动逻辑使用，不在业务层读写。 |
+| `setTimeout` | `mnutils.js` | JSCore环境下的兼容定时器注入 | 仅作兼容手段，复杂定时任务优先用更可控方案。 |
+| `clearTimeout` | `mnutils.js` | 对应的兼容清理函数 | 与上同，不用于复杂调度。 |
+| `atob` | `mnutils.js` | Base64解码兼容入口 | 二进制处理优先走DataConverter能力。 |
+| `getRuntimeAddon` | `addon.js` | 返回当前`self`上下文的内部函数 | 不作为公共API暴露，不建议业务层调用。 |
+| `RuntimeAddon` | `addon.js` | 生命周期桥接主类 | 作为系统入口存在，不作为业务对象直接实例化。 |
+
+## 使用边界建议
+
+- 业务代码优先依赖`Runtime`、`MNUtil`、`MNNote`等稳定入口。
+- 如必须触达Internal成员，建议固定AddonLib版本并在升级后逐项回归。
+- Internal成员变更时不保证向后兼容。