mn-docs-mcp 1.0.0 → 1.1.0

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

@@ -0,0 +1,65 @@
+---
+title: Mustache
+description: 对mustache.js的轻量包装，统一模板渲染与语法解析入口。
+---
+
+`Mustache`是对mustache.js的轻量包装，提供统一的模板渲染与语法解析功能。
+
+## 类成员(Class members)
+
+### 属性
+
+无。
+
+### 方法
+
+#### `render`
+
+#### 类型
+
+```ts
+static render(template: string,config: object): string
+```
+
+#### 说明
+
+- 当你有一段Mustache模板字符串，并且已经准备好渲染数据时，直接调用`render`生成最终文本。
+- 与`parse`不同，`render`会产出可展示字符串，适合生成Markdown、HTML片段或提示文本。
+#### 参数
+
+| 参数名     | 类型                     | 必填 | 说明                 |
+|:-----------|:-------------------------|:-----|:---------------------|
+| `template` | `string`                 | 是   | Mustache模板文本。   |
+| `config`   | `object` | 是   | 模板渲染上下文对象。 |
+
+#### 返回值
+
+- 类型:`string`
+- 语义:渲染后的完整字符串。
+
+#### `parse`
+
+#### 类型
+
+```ts
+static parse(template: string): Array<{type:string,value:string,start:number,end:number}>
+```
+
+#### 说明
+
+- 当你要在渲染前先检查模板语法，或需要缓存模板token时，使用`parse`。
+- 与`render`相比，`parse`不输出最终文本，而是输出词法结果，便于调试复杂模板。
+#### 参数
+
+| 参数名     | 类型     | 必填 | 说明                   |
+|:-----------|:---------|:-----|:-----------------------|
+| `template` | `string` | 是   | 待解析的Mustache模板。 |
+
+#### 返回值
+
+- 类型:`Array<{type:string,value:string,start:number,end:number}>`
+- 语义:模板解析后的token数组。
+
+## 实例成员(Instance members)
+
+无实例成员。

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

@@ -0,0 +1,352 @@
+---
+title: Response
+description: LibMN中的Response对象API文档。
+---
+
+`Response`用于封装`MNConnection.fetchDev`系列方法的响应结果，提供状态字段、头管理和正文解析方法。
+
+## 构造函数
+
+```ts
+new Response(data?: NSData|null,init?: {
+  status?: number
+  statusText?: string
+  headers?: Headers|Array<[string,string]>|Record<string,string>
+  type?: string
+  url?: string
+  redirected?: boolean
+  error?: string
+})
+```
+
+构造一个新的Response实例。
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `data` | `NSData\|null` | 否 | 响应体数据。传`null`表示空响应体。 |
+| `init` | `object` | 否 | 响应元信息配置。 |
+
+## 类成员(Class members)
+
+### 属性
+
+无。
+
+### 方法
+
+#### `redirect`
+
+##### 类型
+
+```ts
+static redirect(url: string,status?: number): Response
+```
+
+##### 说明
+
+创建一个重定向响应对象，仅允许301、302、303、307、308状态码。
+
+##### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `url` | `string` | 是 | 重定向目标地址。 |
+| `status` | `number` | 否 | 重定向状态码，默认302。 |
+
+##### 返回值
+
+- 类型:`Response`
+- 语义:返回新的重定向响应对象。
+
+#### `error`
+
+##### 类型
+
+```ts
+static error(): Response
+```
+
+##### 说明
+
+创建一个错误响应对象，状态码固定为0，`type`固定为`error`。
+
+##### 参数
+
+无。
+
+##### 返回值
+
+- 类型:`Response`
+- 语义:返回错误响应对象。
+
+#### `new`
+
+##### 类型
+
+```ts
+static new(res: NSHTTPURLResponse,data: NSData,err: NSError,url?: string): Response
+```
+
+##### 说明
+
+把原生网络回调参数封装为`Response`对象。
+
+##### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `res` | `NSHTTPURLResponse` | 是 | 原生响应对象。 |
+| `data` | `NSData` | 是 | 原始响应体。 |
+| `err` | `NSError` | 是 | 原生错误对象。 |
+| `url` | `string` | 否 | 请求URL。 |
+
+##### 返回值
+
+- 类型:`Response`
+- 语义:返回封装后的响应对象。
+
+## 实例成员(Instance members)
+
+### 属性
+
+#### `hasJSONResult`
+
+##### 类型
+
+```ts
+get hasJSONResult(): boolean
+```
+
+##### 说明
+
+判断当前响应体是否可解析为非空JSON对象。
+
+##### 返回值
+
+- 类型:`boolean`
+- 语义:可解析且非空时返回`true`。
+
+### 方法
+
+#### `copy`
+
+##### 类型
+
+```ts
+copy(): void
+```
+
+##### 说明
+
+把`asJSONObject()`结果复制到剪贴板，便于调试查看。
+
+##### 参数
+
+无。
+
+##### 返回值
+
+- 类型:`void`
+- 语义:无返回值。
+
+#### `asJSONObject`
+
+##### 类型
+
+```ts
+asJSONObject(): {
+  status: number
+  statusText: string
+  statusCodeDescription: string
+  headers: Headers
+  type: string
+  url: string
+  error?: string
+  text?: string|Promise<string>
+  json?: any
+  bodySize?: number
+}|undefined
+```
+
+##### 说明
+
+将当前响应转为便于展示和记录的结构化对象。
+
+##### 参数
+
+无。
+
+##### 返回值
+
+- 类型:`object|undefined`
+- 语义:成功时返回结构化对象，异常时返回`undefined`。
+
+#### `_parseBody`
+
+##### 类型
+
+```ts
+_parseBody(body: Uint8Array|string|FormData|null): Uint8Array|null
+```
+
+##### 说明
+
+将不同输入体归一化为`Uint8Array`。
+
+##### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `body` | `Uint8Array\|string\|FormData\|null` | 是 | 待转换的输入体。 |
+
+##### 返回值
+
+- 类型:`Uint8Array|null`
+- 语义:可解析时返回字节数组，否则返回`null`。
+
+#### `_setBodyUsed`
+
+##### 类型
+
+```ts
+_setBodyUsed(): void
+```
+
+##### 说明
+
+内部标记方法。当前实现中该方法提前返回，不会真正改变`_bodyUsed`。
+
+##### 参数
+
+无。
+
+##### 返回值
+
+- 类型:`void`
+- 语义:无返回值。
+
+#### `arrayBuffer`
+
+##### 类型
+
+```ts
+arrayBuffer(): Promise<ArrayBuffer>
+```
+
+##### 说明
+
+将响应体转换为`ArrayBuffer`。
+
+##### 参数
+
+无。
+
+##### 返回值
+
+- 类型:`Promise<ArrayBuffer>`
+- 语义:返回异步数组缓冲区结果。
+
+#### `blob`
+
+##### 类型
+
+```ts
+blob(): Promise<Blob>
+```
+
+##### 说明
+
+将响应体转换为`Blob`，并携带`content-type`头中的MIME类型。
+
+##### 参数
+
+无。
+
+##### 返回值
+
+- 类型:`Promise<Blob>`
+- 语义:返回异步Blob结果。
+
+#### `json`
+
+##### 类型
+
+```ts
+json(): any
+```
+
+##### 说明
+
+将响应体解析为JSON对象。解析失败时返回`SyntaxError`对象。
+
+##### 参数
+
+无。
+
+##### 返回值
+
+- 类型:`any`
+- 语义:通常为JSON对象，失败时为错误对象。
+
+#### `text`
+
+##### 类型
+
+```ts
+text(): string|Promise<string>
+```
+
+##### 说明
+
+将响应体转换为字符串。无响应体时返回空字符串Promise。
+
+##### 参数
+
+无。
+
+##### 返回值
+
+- 类型:`string|Promise<string>`
+- 语义:返回文本结果或其Promise。
+
+#### `formData`
+
+##### 类型
+
+```ts
+formData(): Promise<FormData>
+```
+
+##### 说明
+
+把`application/x-www-form-urlencoded`形式文本解析为`FormData`。
+
+##### 参数
+
+无。
+
+##### 返回值
+
+- 类型:`Promise<FormData>`
+- 语义:返回异步FormData结果。
+
+#### `clone`
+
+##### 类型
+
+```ts
+clone(): Response
+```
+
+##### 说明
+
+克隆当前响应对象。若响应体已被消费会抛出`TypeError`。
+
+##### 参数
+
+无。
+
+##### 返回值
+
+- 类型:`Response`
+- 语义:返回克隆后的新响应对象。

package/src/content/docs/libmn/runtime-assets.md

@@ -0,0 +1,64 @@
+---
+title: RuntimeAssets
+description: Runtime的资源路径解析器，用于把相对路径转换为插件目录绝对路径。
+---
+
+`RuntimeAssets`负责把插件内部资源路径解析为可访问路径，通常通过`Runtime.assets`调用。
+
+## 类成员(Class members)
+
+### 属性
+
+无。
+
+### 方法
+
+#### `init`
+
+##### 类型
+
+```ts
+static init(extensionPath: string): void
+```
+
+##### 说明
+
+初始化资源根目录。`Runtime.init`内部会调用该方法。
+
+##### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `extensionPath` | `string` | 是 | 插件根目录绝对路径。 |
+
+##### 返回值
+
+- 类型:`void`
+- 语义:无返回值。
+
+#### `resolve`
+
+##### 类型
+
+```ts
+static resolve(path?: string): string
+```
+
+##### 说明
+
+将相对路径拼接到插件根目录。未传`path`时返回插件根目录本身。
+
+##### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `path` | `string` | 否 | 相对资源路径。 |
+
+##### 返回值
+
+- 类型:`string`
+- 语义:返回可访问的绝对路径字符串。
+
+## 实例成员(Instance members)
+
+无实例成员。

package/src/content/docs/libmn/runtime-web-view-host.md

@@ -0,0 +1,77 @@
+---
+title: RuntimeWebViewHost
+description: 面向WebView的轻量封装，处理本地文件加载与脚本执行。
+---
+
+`RuntimeWebViewHost`是面向WebView的轻量封装对象，处理本地文件加载与脚本执行，简化WebView操作的重复代码。
+
+## 构造函数
+
+```ts
+new RuntimeWebViewHost(options?: { view?: UIView; webview?: UIWebView })
+```
+
+构造一个新的RuntimeWebViewHost实例。
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `options` | `{ view?: UIView; webview?: UIWebView }` | 否 | 宿主视图与WebView引用。最关键的是`webview`。 |
+
+## 类成员(Class members)
+
+无类成员。
+
+## 实例成员(Instance members)
+
+### 属性
+
+无。
+
+### 方法
+
+#### `loadFile`
+
+##### 类型
+
+```ts
+loadFile(path: string): void
+```
+
+##### 说明
+
+- 当你要让WebView加载插件目录里的本地文件，例如`index.html`，使用这个方法。
+- 与直接调用原生`loadFileURL...`相比，这里会先通过`Runtime.assets.resolve`解析相对路径，并统一可读目录权限。
+##### 参数
+
+| 参数名 | 类型     | 必填 | 说明                                                 |
+|:-------|:---------|:-----|:-----------------------------------------------------|
+| `path` | `string` | 是   | 相对插件资源根目录的文件路径，如`pages/index.html`。 |
+
+##### 返回值
+
+- 类型:`void`
+- 语义:无返回值。
+
+#### `runJavaScript`
+
+##### 类型
+
+```ts
+runJavaScript(script: string): void
+```
+
+##### 说明
+
+- 当你需要从宿主层主动驱动WebView执行一段JS代码时，使用这个方法。
+- 与`loadFile`不同，它不负责页面切换，只负责在当前页面上下文里执行脚本。
+##### 参数
+
+| 参数名   | 类型     | 必填 | 说明                           |
+|:---------|:---------|:-----|:-------------------------------|
+| `script` | `string` | 是   | 要执行的JavaScript源码字符串。 |
+
+##### 返回值
+
+- 类型:`void`
+- 语义:方法本身不返回脚本结果。
+

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

@@ -0,0 +1,178 @@
+---
+title: Runtime
+description: LibMN运行时总入口，负责生命周期注册、路由分发与资源路径能力挂载。
+---
+
+`Runtime`是运行时总入口，负责生命周期注册、路由分发与资源路径能力挂载。
+
+## 类成员(Class members)
+
+### 属性
+
+| 字段名 | 类型 | 说明 |
+|:-------|:-----|:-----|
+| `lifecycleHandlers` | `Array<Record<string, (...args: any[]) => any>>` | 保存所有已注册的生命周期处理器对象。 |
+| `routeHandlers` | `Record<string, (...args: any[]) => any>` | 保存路由名到处理函数的映射。 |
+| `initialized` | `boolean` | 标记Runtime是否已完成初始化。 |
+| `assets` | `typeof RuntimeAssets` | 暴露路径解析工具`RuntimeAssets`。 |
+
+### 方法
+
+#### `init`
+
+##### 类型
+
+```ts
+static init(context: string): typeof Runtime
+```
+
+##### 说明
+
+- 作用:在插件启动时写入扩展目录，并同步初始化`Runtime.assets`。
+##### 参数
+
+| 参数名    | 类型     | 必填 | 说明                                           |
+|:----------|:---------|:-----|:-----------------------------------------------|
+| `context` | `string` | 是   | 插件主目录路径，`addon.js`里由`mainPath`传入。 |
+
+##### 返回值
+
+- 类型:`typeof Runtime`
+- 语义:返回`Runtime`自身，便于链式调用。
+
+#### `ensureInitialized`
+
+##### 类型
+
+```ts
+static ensureInitialized(): void
+```
+
+##### 说明
+
+- 作用:在关键流程开始前显式检查Runtime初始化状态。
+##### 参数
+
+无。
+
+##### 返回值
+
+- 类型:`void`
+- 语义:通过检查时无返回值，未通过直接抛出`Error`。
+
+#### `registerLifecycle`
+
+##### 类型
+
+```ts
+static registerLifecycle(handler: Record<string, (...args: any[]) => any>): Record<string, (...args: any[]) => any>
+```
+
+##### 说明
+
+- 作用:注册一个生命周期处理器对象。
+##### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `handler` | `Record<string, (...args: any[]) => any>` | 是 | 处理器对象，键名对应生命周期名，如`sceneWillConnect`。 |
+
+##### 返回值
+
+- 类型:`T`
+- 语义:返回原始`handler`，可用于保存引用或测试断言。
+
+#### `emitLifecycle`
+
+##### 类型
+
+```ts
+static emitLifecycle(name: string, ...args: any[]): any[]
+```
+
+##### 说明
+
+- 作用:按生命周期名批量触发所有已注册处理器。
+##### 参数
+
+| 参数名 | 类型        | 必填 | 说明                     |
+|:-------|:------------|:-----|:-------------------------|
+| `name` | `string`    | 是   | 生命周期名。             |
+| `args` | `any[]` | 否   | 透传给处理器方法的参数。 |
+
+##### 返回值
+
+- 类型:`any[]`
+- 语义:返回每个处理器的返回值数组。未实现该生命周期的处理器会对应`undefined`。
+
+#### `registerRoute`
+
+##### 类型
+
+```ts
+static registerRoute(name: string, handler: (...args: any[]) => any): (...args: any[]) => any
+```
+
+##### 说明
+
+- 作用:注册路由处理函数。
+##### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `name` | `string` | 是 | 路由名，会成为`routeHandlers[name]`的键。 |
+| `handler` | `(...args: any[]) => any` | 是 | 对应路由执行函数。 |
+
+##### 返回值
+
+- 类型:`T`
+- 语义:返回注册进去的处理函数本身。
+
+#### `handleRoute`
+
+##### 类型
+
+```ts
+static handleRoute(name: string, ...args: any[]): any
+```
+
+##### 说明
+
+- 作用:执行已注册路由。
+##### 参数
+
+| 参数名 | 类型        | 必填 | 说明                       |
+|:-------|:------------|:-----|:---------------------------|
+| `name` | `string`    | 是   | 要执行的路由名。           |
+| `args` | `any[]` | 否   | 透传给路由处理函数的参数。 |
+
+##### 返回值
+
+- 类型:`any`
+- 语义:返回对应路由处理函数的返回值。
+
+#### `createWebViewHost`
+
+##### 类型
+
+```ts
+static createWebViewHost(options?: { view?: UIView; webview?: UIWebView }): RuntimeWebViewHost
+```
+
+##### 说明
+
+- 作用:创建`RuntimeWebViewHost`实例，统一管理WebView文件加载与脚本执行。
+##### 参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+|:---|:---|:---|:---|
+| `options` | `{ view?: UIView; webview?: UIWebView }` | 否 | 视图与WebView容器，默认空对象。 |
+
+##### 返回值
+
+- 类型:`RuntimeWebViewHost`
+- 语义:返回可调用`loadFile`和`runJavaScript`的Host实例。
+
+## 实例成员(Instance members)
+
+无实例成员。