@wetoria/siyuan-sdk 0.0.2

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * SiYuan SDK
+ */
+export * from './api/index.js';
+export type * from './core/index.js';
+export * from './core/index.js';
+export * from './types/index.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,gBAAgB,CAAA;AAC9B,mBAAmB,iBAAiB,CAAA;AACpC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,kBAAkB,CAAA"}

package/dist/index.js

@@ -0,0 +1,7 @@
+/**
+ * SiYuan SDK
+ */
+export * from './api/index.js';
+export * from './core/index.js';
+export * from './types/index.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,gBAAgB,CAAA;AAE9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,kBAAkB,CAAA"}

package/dist/types/index.d.ts

@@ -0,0 +1,88 @@
+/**
+ * Frequently used data structures in SiYuan
+ */
+export type DocumentId = string;
+export type BlockId = string;
+export type NotebookId = string;
+export type PreviousID = BlockId;
+export type ParentID = BlockId | DocumentId;
+export interface Notebook {
+    id: NotebookId;
+    name: string;
+    icon: string;
+    sort: number;
+    closed: boolean;
+}
+export interface NotebookConf {
+    name: string;
+    closed: boolean;
+    refCreateSavePath: string;
+    createDocNameTemplate: string;
+    dailyNoteSavePath: string;
+    dailyNoteTemplatePath: string;
+}
+export type BlockType = "d" | "s" | "h" | "t" | "i" | "p" | "f" | "audio" | "video" | "other";
+export type BlockSubType = "d1" | "d2" | "s1" | "s2" | "s3" | "t1" | "t2" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "table" | "task" | "toggle" | "latex" | "quote" | "html" | "code" | "footnote" | "cite" | "collection" | "bookmark" | "attachment" | "comment" | "mindmap" | "spreadsheet" | "calendar" | "image" | "audio" | "video" | "other";
+export interface Block {
+    id: BlockId;
+    parent_id?: BlockId;
+    root_id: DocumentId;
+    hash: string;
+    box: string;
+    path: string;
+    hpath: string;
+    name: string;
+    alias: string;
+    memo: string;
+    tag: string;
+    content: string;
+    fcontent?: string;
+    markdown: string;
+    length: number;
+    type: BlockType;
+    subtype: BlockSubType;
+    /**
+     * string of { [key: string]: string }
+     * For instance: "{: custom-type=\"query-code\" id=\"20230613234017-zkw3pr0\" updated=\"20230613234509\"}"
+     */
+    ial?: string;
+    sort: number;
+    created: string;
+    updated: string;
+}
+export interface doOperation {
+    action: string;
+    data: string;
+    id: BlockId;
+    parentID: BlockId | DocumentId;
+    previousID: BlockId;
+    retData: null;
+}
+declare global {
+    interface Window {
+        siyuan: {
+            notebooks: any;
+            menus: any;
+            dialogs: any;
+            blockPanels: any;
+            storage: any;
+            user: any;
+            ws: any;
+            languages: any;
+            config: import('siyuan').Config.IConf;
+        };
+    }
+}
+export interface IBreadcrumb {
+    id: string;
+    name: string;
+    type: string;
+    subType: string;
+    children: any;
+}
+export interface backlinkData {
+    dom: string;
+    blockPaths: IBreadcrumb[];
+    expand: boolean;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAA;AAC/B,MAAM,MAAM,OAAO,GAAG,MAAM,CAAA;AAC5B,MAAM,MAAM,UAAU,GAAG,MAAM,CAAA;AAC/B,MAAM,MAAM,UAAU,GAAG,OAAO,CAAA;AAChC,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAA;AAE3C,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,UAAU,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,OAAO,CAAA;IACf,iBAAiB,EAAE,MAAM,CAAA;IACzB,qBAAqB,EAAE,MAAM,CAAA;IAC7B,iBAAiB,EAAE,MAAM,CAAA;IACzB,qBAAqB,EAAE,MAAM,CAAA;CAC9B;AAED,MAAM,MAAM,SAAS,GACjB,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,OAAO,GACP,OAAO,GACP,OAAO,CAAA;AAEX,MAAM,MAAM,YAAY,GACpB,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,MAAM,GACN,QAAQ,GACR,OAAO,GACP,OAAO,GACP,MAAM,GACN,MAAM,GACN,UAAU,GACV,MAAM,GACN,YAAY,GACZ,UAAU,GACV,YAAY,GACZ,SAAS,GACT,SAAS,GACT,aAAa,GACb,UAAU,GACV,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,CAAA;AAEX,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,OAAO,CAAA;IACX,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,OAAO,EAAE,UAAU,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,SAAS,CAAA;IACf,OAAO,EAAE,YAAY,CAAA;IACrB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,OAAO,CAAA;IACX,QAAQ,EAAE,OAAO,GAAG,UAAU,CAAA;IAC9B,UAAU,EAAE,OAAO,CAAA;IACnB,OAAO,EAAE,IAAI,CAAA;CACd;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,MAAM,EAAE;YACN,SAAS,EAAE,GAAG,CAAA;YACd,KAAK,EAAE,GAAG,CAAA;YACV,OAAO,EAAE,GAAG,CAAA;YACZ,WAAW,EAAE,GAAG,CAAA;YAChB,OAAO,EAAE,GAAG,CAAA;YACZ,IAAI,EAAE,GAAG,CAAA;YACT,EAAE,EAAE,GAAG,CAAA;YACP,SAAS,EAAE,GAAG,CAAA;YACd,MAAM,EAAE,OAAO,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAA;SACtC,CAAA;KACF;CACF;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,GAAG,CAAA;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAA;IACX,UAAU,EAAE,WAAW,EAAE,CAAA;IACzB,MAAM,EAAE,OAAO,CAAA;CAChB"}

package/dist/types/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":""}

package/dist/utils/index.d.ts

@@ -0,0 +1,2 @@
+export declare function trimSqlBlank(sql: string): string;
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,UAEvC"}

package/dist/utils/index.js

@@ -0,0 +1,4 @@
+export function trimSqlBlank(sql) {
+    return sql.replace(/\s+/g, ' ').trim();
+}
+//# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,YAAY,CAAC,GAAW;IACtC,OAAO,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;AACxC,CAAC"}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@wetoria/siyuan-sdk",
+  "version": "0.0.2",
+  "description": "SiYuan SDK",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "README.md"
+  ],
+  "keywords": [
+    "siyuan",
+    "sdk",
+    "api"
+  ],
+  "author": "Wetoria",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "peerDependencies": {
+    "siyuan": "^1.1.5"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "clean": "rm -rf dist"
+  }
+}

package/src/api/archive/index.ts

@@ -0,0 +1,26 @@
+import {
+  SiYuanAPI,
+  SyApiMethodResponse,
+} from '../../core/index.js'
+
+/**
+ * Archive API 类型定义
+ */
+export interface ArchiveAPI {
+  /**
+   * 解压 ZIP 文件
+   * @path /api/archive/unzip
+   */
+  unzip: <T = any>(
+    zipPath: string,
+    path: string
+  ) => SyApiMethodResponse<T>
+}
+
+SiYuanAPI.prototype.unzip = function <T = any>(zipPath: string, path: string): SyApiMethodResponse<T> {
+  return this.request('/api/archive/unzip', {
+    zipPath,
+    path,
+  })
+}
+

package/src/api/asset/index.ts

@@ -0,0 +1,26 @@
+import type { SyApiMethodResponse } from '../../core/index.js'
+import { SiYuanAPI } from '../../core/index.js'
+
+/**
+ * Asset Files API 类型定义
+ */
+export interface AssetAPI {
+  /**
+   * 上传资源文件
+   * @path /api/asset/upload
+   */
+  upload: (
+    assetsDirPath: string,
+    files: any[]
+  ) => SyApiMethodResponse<any>
+}
+
+SiYuanAPI.prototype.upload = function (assetsDirPath: string, files: any[]) {
+  const form = new FormData()
+  form.append('assetsDirPath', assetsDirPath)
+  for (const file of files) {
+    form.append('file[]', file)
+  }
+  return this.request('/api/asset/upload', form)
+}
+

package/src/api/attr/index.ts

@@ -0,0 +1,59 @@
+import type { SyApiMethodResponse } from '../../core/index.js'
+import type { BlockId } from '../../types/index.js'
+import { SiYuanAPI } from '../../core/index.js'
+
+/**
+ * Attributes API 类型定义
+ */
+export interface AttrAPI {
+  /**
+   * 设置块属性
+   * @path /api/attr/setBlockAttrs
+   */
+  setBlockAttrs: (
+    id: BlockId,
+    attrs: { [key: string]: string }
+  ) => SyApiMethodResponse<any>
+  /**
+   * 获取块属性
+   * @path /api/attr/getBlockAttrs
+   */
+  getBlockAttrs: (id: BlockId) => SyApiMethodResponse<{
+    [key: string]: string
+  }>
+  /**
+   * 批量设置块属性
+   * @path /api/attr/batchSetBlockAttrs
+   */
+  batchSetBlockAttrs: (blockAttrs: Array<{
+    id: BlockId
+    attrs: { [key: string]: string }
+  }>) => SyApiMethodResponse<any>
+  /**
+   * 批量获取块属性
+   * @path /api/attr/batchGetBlockAttrs
+   */
+  batchGetBlockAttrs: (ids: BlockId[]) => SyApiMethodResponse<{
+    [key: string]: string
+  }>
+}
+
+SiYuanAPI.prototype.setBlockAttrs = function (id: string, attrs: { [key: string]: string }) {
+  return this.request('/api/attr/setBlockAttrs', {
+    id,
+    attrs,
+  })
+}
+
+SiYuanAPI.prototype.getBlockAttrs = function (id: string) {
+  return this.request('/api/attr/getBlockAttrs', { id })
+}
+
+SiYuanAPI.prototype.batchSetBlockAttrs = function (blockAttrs: Array<{ id: string, attrs: { [key: string]: string } }>) {
+  return this.request('/api/attr/batchSetBlockAttrs', { blockAttrs })
+}
+
+SiYuanAPI.prototype.batchGetBlockAttrs = function (ids: string[]) {
+  return this.request('/api/attr/batchGetBlockAttrs', { ids })
+}
+

package/src/api/block/index.ts

@@ -0,0 +1,226 @@
+import type { SyApiMethodResponse } from '../../core/index.js'
+import type {
+  BlockId,
+  NotebookId,
+} from '../../types/index.js'
+import { SiYuanAPI } from '../../core/index.js'
+
+/**
+ * Block API 类型定义
+ */
+export interface BlockAPI {
+  /**
+   * 插入块
+   * @path /api/block/insertBlock
+   */
+  insertBlock: (
+    dataType: 'markdown' | 'dom',
+    data: string,
+    nextID?: BlockId,
+    previousID?: BlockId,
+    parentID?: BlockId
+  ) => SyApiMethodResponse<any[]>
+  /**
+   * 在块的开头插入内容
+   * @path /api/block/prependBlock
+   */
+  prependBlock: (
+    dataType: 'markdown' | 'dom',
+    data: string,
+    parentID: BlockId
+  ) => SyApiMethodResponse<any[]>
+  /**
+   * 在块的末尾追加内容
+   * @path /api/block/appendBlock
+   */
+  appendBlock: (
+    dataType: 'markdown' | 'dom',
+    data: string,
+    parentID: BlockId
+  ) => SyApiMethodResponse<any[]>
+  /**
+   * 追加 Markdown 内容到块（便捷方法）
+   * @path wrapper: uses appendBlock
+   */
+  appendMDToBlock: (params: {
+    data: string
+    parentID: BlockId
+  }) => SyApiMethodResponse<any[]>
+  /**
+   * 追加 Markdown 内容到块并返回块 ID（便捷方法）
+   * @path wrapper: uses appendBlock
+   */
+  appendMDToBlockAndGetBlockId: (params: {
+    data: string
+    parentID: BlockId
+  }) => SyApiMethodResponse<string | undefined>
+  /**
+   * 追加内容到日记
+   * @path /api/block/appendDailyNoteBlock
+   */
+  appendDailyNoteBlock: (
+    dataType: 'markdown' | 'dom',
+    data: string,
+    notebook: NotebookId
+  ) => SyApiMethodResponse<any[]>
+  /**
+   * 更新块内容
+   * @path /api/block/updateBlock
+   */
+  updateBlock: (
+    dataType: 'markdown' | 'dom',
+    data: string,
+    id: BlockId
+  ) => SyApiMethodResponse<any[]>
+  /**
+   * 删除块
+   * @path /api/block/deleteBlock
+   */
+  deleteBlock: (id: BlockId) => SyApiMethodResponse<any[]>
+  /**
+   * 移动块
+   * @path /api/block/moveBlock
+   */
+  moveBlock: (
+    id: BlockId,
+    previousID?: BlockId,
+    parentID?: BlockId
+  ) => SyApiMethodResponse<any[]>
+  /**
+   * 获取块的 Kramdown 格式
+   * @path /api/block/getBlockKramdown
+   */
+  getBlockKramdown: (id: BlockId) => SyApiMethodResponse<any>
+  /**
+   * 获取子块列表
+   * @path /api/block/getChildBlocks
+   */
+  getChildBlocks: (id: BlockId) => SyApiMethodResponse<any[]>
+  /**
+   * 获取块的索引位置
+   * @path /api/block/getBlocksIndexes
+   */
+  getBlocksIndexes: (ids: BlockId[]) => SyApiMethodResponse<{
+    [key: string]: number
+  }>
+  /**
+   * 转移块引用
+   * @path /api/block/transferBlockRef
+   */
+  transferBlockRef: (
+    fromID: BlockId,
+    toID: BlockId,
+    refIDs: BlockId[]
+  ) => SyApiMethodResponse<any>
+  /**
+   * 获取块信息（通过 SQL 查询）
+   * @path wrapper: uses sql
+   */
+  getBlockInfo: (id: BlockId) => SyApiMethodResponse<any>
+  /**
+   * 获取块的 DOM 结构
+   * @path /api/block/getBlockDOM
+   */
+  getBlockDOM: (id: BlockId) => SyApiMethodResponse<any>
+}
+
+SiYuanAPI.prototype.insertBlock = function (dataType: 'markdown' | 'dom', data: string, nextID?: string, previousID?: string, parentID?: string) {
+  return this.request('/api/block/insertBlock', {
+    dataType,
+    data,
+    nextID,
+    previousID,
+    parentID,
+  })
+}
+
+SiYuanAPI.prototype.prependBlock = function (dataType: 'markdown' | 'dom', data: string, parentID: string) {
+  return this.request('/api/block/prependBlock', {
+    dataType,
+    data,
+    parentID,
+  })
+}
+
+SiYuanAPI.prototype.appendBlock = function (dataType: 'markdown' | 'dom' = 'markdown', data: string, parentID: string) {
+  return this.request('/api/block/appendBlock', {
+    dataType,
+    data,
+    parentID,
+  })
+}
+
+SiYuanAPI.prototype.appendMDToBlock = function (params: { data: string, parentID: string }) {
+  return this.appendBlock('markdown', params.data, params.parentID)
+}
+
+SiYuanAPI.prototype.appendMDToBlockAndGetBlockId = async function (params: { data: string, parentID: string }) {
+  const res = await this.appendBlock('markdown', params.data, params.parentID)
+  return {
+    code: res.code,
+    msg: res.msg,
+    data: res.data?.[0]?.doOperations?.[0]?.id,
+  }
+}
+
+SiYuanAPI.prototype.appendDailyNoteBlock = function (dataType: 'markdown' | 'dom', data: string, notebook: string) {
+  return this.request('/api/block/appendDailyNoteBlock', {
+    dataType,
+    data,
+    notebook,
+  })
+}
+
+SiYuanAPI.prototype.updateBlock = function (dataType: 'markdown' | 'dom', data: string, id: string) {
+  return this.request('/api/block/updateBlock', {
+    dataType,
+    data,
+    id,
+  })
+}
+
+SiYuanAPI.prototype.deleteBlock = function (id: string) {
+  return this.request('/api/block/deleteBlock', { id })
+}
+
+SiYuanAPI.prototype.moveBlock = function (id: string, previousID?: string, parentID?: string) {
+  return this.request('/api/block/moveBlock', {
+    id,
+    previousID,
+    parentID,
+  })
+}
+
+SiYuanAPI.prototype.getBlockKramdown = function (id: string) {
+  return this.request('/api/block/getBlockKramdown', { id })
+}
+
+SiYuanAPI.prototype.getChildBlocks = function (id: string) {
+  return this.request('/api/block/getChildBlocks', { id })
+}
+
+SiYuanAPI.prototype.getBlocksIndexes = function (ids: string[]) {
+  return this.request('/api/block/getBlocksIndexes', { ids })
+}
+
+SiYuanAPI.prototype.transferBlockRef = function (fromID: string, toID: string, refIDs: string[]) {
+  return this.request('/api/block/transferBlockRef', {
+    fromID,
+    toID,
+    refIDs,
+  })
+}
+
+SiYuanAPI.prototype.getBlockInfo = async function (id: string) {
+  const res = await this.sql(`select * from blocks where id = '${id}'`)
+  return {
+    code: res.code,
+    msg: res.msg,
+    data: res.data?.[0],
+  }
+}
+
+SiYuanAPI.prototype.getBlockDOM = function (id: string) {
+  return this.request('/api/block/getBlockDOM', { id })
+}
+

package/src/api/convert/index.ts

@@ -0,0 +1,18 @@
+import type { SyApiMethodResponse } from '../../core/index.js'
+import { SiYuanAPI } from '../../core/index.js'
+
+/**
+ * Convert API 类型定义
+ */
+export interface ConvertAPI {
+  /**
+   * 使用 Pandoc 转换文档
+   * @path /api/convert/pandoc
+   */
+  pandoc: (args: string[]) => SyApiMethodResponse<any>
+}
+
+SiYuanAPI.prototype.pandoc = function (args: string[]) {
+  return this.request('/api/convert/pandoc', { args })
+}
+

package/src/api/export/index.ts

@@ -0,0 +1,36 @@
+import type { SyApiMethodResponse } from '../../core/index.js'
+import type { DocumentId } from '../../types/index.js'
+
+// 实现
+import { SiYuanAPI } from '../../core/index.js'
+
+/**
+ * Export API 类型定义
+ */
+export interface ExportAPI {
+  /**
+   * 导出 Markdown 内容
+   * @path /api/export/exportMdContent
+   */
+  exportMdContent: (id: DocumentId) => SyApiMethodResponse<any>
+  /**
+   * 导出资源文件
+   * @path /api/export/exportResources
+   */
+  exportResources: (
+    paths: string[],
+    name: string
+  ) => SyApiMethodResponse<any>
+}
+
+SiYuanAPI.prototype.exportMdContent = function (id: string) {
+  return this.request('/api/export/exportMdContent', { id })
+}
+
+SiYuanAPI.prototype.exportResources = function (paths: string[], name: string) {
+  return this.request('/api/export/exportResources', {
+    paths,
+    name,
+  })
+}
+

package/src/api/file/index.ts

@@ -0,0 +1,59 @@
+import {
+  SiYuanAPI,
+  SyApiMethodResponse,
+} from '../../core/index.js'
+
+/**
+ * File API 类型定义
+ */
+export interface FileAPI {
+  /**
+   * 获取文件内容
+   * @path /api/file/getFile
+   */
+  getFile: (path: string) => SyApiMethodResponse<any>
+  /**
+   * 上传/创建文件
+   * @path /api/file/putFile
+   */
+  putFile: (path: string, isDir: boolean, file: any) => SyApiMethodResponse<any>
+  /**
+   * 删除文件
+   * @path /api/file/removeFile
+   */
+  removeFile: (path: string) => SyApiMethodResponse<any>
+  /**
+   * 读取目录
+   * @path /api/file/readDir
+   */
+  readDir: (path: string) => SyApiMethodResponse<any>
+}
+
+SiYuanAPI.prototype.getFile = async function (path: string) {
+  try {
+    return await this.request('/api/file/getFile', { path })
+  } catch {
+    return {
+      code: -1,
+      msg: 'Failed to get file',
+      data: null,
+    }
+  }
+}
+
+SiYuanAPI.prototype.putFile = function (path: string, isDir: boolean, file: any) {
+  const form = new FormData()
+  form.append('path', path)
+  form.append('isDir', isDir.toString())
+  form.append('file', file)
+  return this.request('/api/file/putFile', form)
+}
+
+SiYuanAPI.prototype.removeFile = function (path: string) {
+  return this.request('/api/file/removeFile', { path })
+}
+
+SiYuanAPI.prototype.readDir = function (path: string) {
+  return this.request('/api/file/readDir', { path })
+}
+