@wetoria/siyuan-sdk 0.0.2

package/src/api/filetree/index.ts

@@ -0,0 +1,129 @@
+import type { SyApiMethodResponse } from '../../core/index.js'
+import type {
+  BlockId,
+  NotebookId,
+} from '../../types/index.js'
+import { SiYuanAPI } from '../../core/index.js'
+
+/**
+ * File Tree API 类型定义
+ */
+export interface FileTreeAPI {
+  /**
+   * 创建日记
+   * @path /api/filetree/createDailyNote
+   */
+  createDailyNote: (notebook: NotebookId) => SyApiMethodResponse<{
+    id: string
+  }>
+  /**
+   * 使用 Markdown 创建文档
+   * @path /api/filetree/createDocWithMd
+   */
+  createDocWithMd: (
+    notebook: NotebookId,
+    path: string,
+    markdown: string
+  ) => SyApiMethodResponse<string>
+  /**
+   * 重命名文档
+   * @path /api/filetree/renameDoc
+   */
+  renameDoc: (
+    notebook: NotebookId,
+    path: string,
+    title: string
+  ) => SyApiMethodResponse<string>
+  /**
+   * 删除文档
+   * @path /api/filetree/removeDoc
+   */
+  removeDoc: (
+    notebook: NotebookId,
+    path: string
+  ) => SyApiMethodResponse<any>
+  /**
+   * 移动文档
+   * @path /api/filetree/moveDocs
+   */
+  moveDocs: (
+    fromPaths: string[],
+    toNotebook: NotebookId,
+    toPath: string
+  ) => SyApiMethodResponse<any>
+  /**
+   * 根据路径获取人类可读路径
+   * @path /api/filetree/getHPathByPath
+   */
+  getHPathByPath: (
+    notebook: NotebookId,
+    path: string
+  ) => SyApiMethodResponse<string>
+  /**
+   * 根据块 ID 获取人类可读路径
+   * @path /api/filetree/getHPathByID
+   */
+  getHPathByID: (id: BlockId) => SyApiMethodResponse<string>
+  /**
+   * 根据人类可读路径获取块 ID 列表
+   * @path /api/filetree/getIDsByHPath
+   */
+  getIDsByHPath: (
+    notebook: NotebookId,
+    path: string
+  ) => SyApiMethodResponse<string[]>
+}
+
+SiYuanAPI.prototype.createDailyNote = function (notebook: string) {
+  return this.request('/api/filetree/createDailyNote', { notebook })
+}
+
+SiYuanAPI.prototype.createDocWithMd = function (notebook: string, path: string, markdown: string) {
+  return this.request('/api/filetree/createDocWithMd', {
+    notebook,
+    path,
+    markdown,
+  })
+}
+
+SiYuanAPI.prototype.renameDoc = function (notebook: string, path: string, title: string) {
+  return this.request('/api/filetree/renameDoc', {
+    doc: notebook,
+    path,
+    title,
+  })
+}
+
+SiYuanAPI.prototype.removeDoc = function (notebook: string, path: string) {
+  return this.request('/api/filetree/removeDoc', {
+    notebook,
+    path,
+  })
+}
+
+SiYuanAPI.prototype.moveDocs = function (fromPaths: string[], toNotebook: string, toPath: string) {
+  return this.request('/api/filetree/moveDocs', {
+    fromPaths,
+    toNotebook,
+    toPath,
+  })
+}
+
+SiYuanAPI.prototype.getHPathByPath = function (notebook: string, path: string) {
+  return this.request('/api/filetree/getHPathByPath', {
+    notebook,
+    path,
+  })
+}
+
+SiYuanAPI.prototype.getHPathByID = function (id: string) {
+  return this.request('/api/filetree/getHPathByID', { id })
+}
+
+SiYuanAPI.prototype.getIDsByHPath = function (notebook: string, path: string) {
+  return this.request('/api/filetree/getIDsByHPath', {
+    notebook,
+    path,
+  })
+}
+

package/src/api/index.ts

@@ -0,0 +1,56 @@
+import type { ArchiveAPI } from './archive/index.js'
+import type { AssetAPI } from './asset/index.js'
+import type { AttrAPI } from './attr/index.js'
+import type { BlockAPI } from './block/index.js'
+import type { ConvertAPI } from './convert/index.js'
+import type { ExportAPI } from './export/index.js'
+import type { FileAPI } from './file/index.js'
+import type { FileTreeAPI } from './filetree/index.js'
+import type { NetworkAPI } from './network/index.js'
+import type { NotebookAPI } from './notebook/index.js'
+import type { NotificationAPI } from './notification/index.js'
+import type { SqlAPI } from './sql/index.js'
+import type { SqliteAPI } from './sqlite/index.js'
+import type { SystemAPI } from './system/index.js'
+import type { TemplateAPI } from './template/index.js'
+
+// 导入所有 API 实现
+import './archive/index.js'
+import './asset/index.js'
+import './attr/index.js'
+import './block/index.js'
+import './convert/index.js'
+import './export/index.js'
+import './file/index.js'
+import './filetree/index.js'
+import './network/index.js'
+import './notebook/index.js'
+import './notification/index.js'
+import './sql/index.js'
+import './sqlite/index.js'
+import './system/index.js'
+import './template/index.js'
+
+/**
+ * Api types
+ */
+declare module '@wetoria/siyuan-sdk' {
+  interface SiYuanAPI
+    extends
+    ArchiveAPI,
+    AssetAPI,
+    AttrAPI,
+    BlockAPI,
+    ConvertAPI,
+    ExportAPI,
+    FileAPI,
+    FileTreeAPI,
+    NetworkAPI,
+    NotebookAPI,
+    NotificationAPI,
+    SqlAPI,
+    SqliteAPI,
+    SystemAPI,
+    TemplateAPI
+  {}
+}

package/src/api/network/index.ts

@@ -0,0 +1,32 @@
+import type { SyApiMethodResponse } from '../../core/index.js'
+import { SiYuanAPI } from '../../core/index.js'
+
+/**
+ * Network API 类型定义
+ */
+export interface NetworkAPI {
+  /**
+   * 转发代理请求
+   * @path /api/network/forwardProxy
+   */
+  forwardProxy: (
+    url: string,
+    method?: string,
+    payload?: any,
+    headers?: any[],
+    timeout?: number,
+    contentType?: string
+  ) => SyApiMethodResponse<any>
+}
+
+SiYuanAPI.prototype.forwardProxy = function (url: string, method: string = 'GET', payload: any = {}, headers: any[] = [], timeout: number = 7000, contentType: string = 'text/html') {
+  return this.request('/api/network/forwardProxy', {
+    url,
+    method,
+    timeout,
+    contentType,
+    headers,
+    payload,
+  })
+}
+

package/src/api/notebook/index.ts

@@ -0,0 +1,93 @@
+import type { SyApiMethodResponse } from '../../core/index.js'
+import type { NotebookId } from '../../types/index.js'
+import { SiYuanAPI } from '../../core/index.js'
+
+/**
+ * Notebook API 类型定义
+ */
+export interface NotebookAPI {
+  /**
+   * 列出所有笔记本
+   * @path /api/notebook/lsNotebooks
+   */
+  lsNotebooks: () => SyApiMethodResponse<any>
+  /**
+   * 打开笔记本
+   * @path /api/notebook/openNotebook
+   */
+  openNotebook: (notebook: NotebookId) => SyApiMethodResponse<any>
+  /**
+   * 关闭笔记本
+   * @path /api/notebook/closeNotebook
+   */
+  closeNotebook: (notebook: NotebookId) => SyApiMethodResponse<any>
+  /**
+   * 重命名笔记本
+   * @path /api/notebook/renameNotebook
+   */
+  renameNotebook: (
+    notebook: NotebookId,
+    name: string
+  ) => SyApiMethodResponse<any>
+  /**
+   * 创建笔记本
+   * @path /api/notebook/createNotebook
+   */
+  createNotebook: (name: string) => SyApiMethodResponse<any>
+  /**
+   * 删除笔记本
+   * @path /api/notebook/removeNotebook
+   */
+  removeNotebook: (notebook: NotebookId) => SyApiMethodResponse<any>
+  /**
+   * 获取笔记本配置
+   * @path /api/notebook/getNotebookConf
+   */
+  getNotebookConf: (notebook: NotebookId) => SyApiMethodResponse<any>
+  /**
+   * 设置笔记本配置
+   * @path /api/notebook/setNotebookConf
+   */
+  setNotebookConf: (
+    notebook: NotebookId,
+    conf: any
+  ) => SyApiMethodResponse<any>
+}
+
+SiYuanAPI.prototype.lsNotebooks = function () {
+  return this.request('/api/notebook/lsNotebooks', '')
+}
+
+SiYuanAPI.prototype.openNotebook = function (notebook: string) {
+  return this.request('/api/notebook/openNotebook', { notebook })
+}
+
+SiYuanAPI.prototype.closeNotebook = function (notebook: string) {
+  return this.request('/api/notebook/closeNotebook', { notebook })
+}
+
+SiYuanAPI.prototype.renameNotebook = function (notebook: string, name: string) {
+  return this.request('/api/notebook/renameNotebook', {
+    notebook,
+    name,
+  })
+}
+
+SiYuanAPI.prototype.createNotebook = function (name: string) {
+  return this.request('/api/notebook/createNotebook', { name })
+}
+
+SiYuanAPI.prototype.removeNotebook = function (notebook: string) {
+  return this.request('/api/notebook/removeNotebook', { notebook })
+}
+
+SiYuanAPI.prototype.getNotebookConf = function (notebook: string) {
+  return this.request('/api/notebook/getNotebookConf', { notebook })
+}
+
+SiYuanAPI.prototype.setNotebookConf = function (notebook: string, conf: any) {
+  return this.request('/api/notebook/setNotebookConf', {
+    notebook,
+    conf,
+  })
+}

package/src/api/notification/index.ts

@@ -0,0 +1,33 @@
+import type { SyApiMethodResponse } from '../../core/index.js'
+import { SiYuanAPI } from '../../core/index.js'
+
+/**
+ * Notification API 类型定义
+ */
+export interface NotificationAPI {
+  /**
+   * 推送消息通知
+   * @path /api/notification/pushMsg
+   */
+  pushMsg: (msg: string, timeout?: number) => SyApiMethodResponse<any>
+  /**
+   * 推送错误消息通知
+   * @path /api/notification/pushErrMsg
+   */
+  pushErrMsg: (msg: string, timeout?: number) => SyApiMethodResponse<any>
+}
+
+SiYuanAPI.prototype.pushMsg = function (msg: string, timeout: number = 7000) {
+  return this.request('/api/notification/pushMsg', {
+    msg,
+    timeout,
+  })
+}
+
+SiYuanAPI.prototype.pushErrMsg = function (msg: string, timeout: number = 7000) {
+  return this.request('/api/notification/pushErrMsg', {
+    msg,
+    timeout,
+  })
+}
+

package/src/api/sql/index.ts

@@ -0,0 +1,65 @@
+import type {
+  Block,
+  BlockId,
+} from '../../types/index.js'
+import {
+  SiYuanAPI,
+  SyApiMethodResponse,
+} from '../../core/index.js'
+import { trimSqlBlank } from '../../utils/index.js'
+
+/**
+ * SQL API 类型定义
+ */
+export interface SqlAPI {
+  /**
+   * Execute SQL query
+   *
+   * @path /api/query/sql
+   * @param stmt - SQL statement to execute
+   * @param options - The options for the SQL query
+   * @param options.trim - Whether to trim the SQL string
+   * @default true
+   * @returns {T[]} result of the SQL query
+   */
+  sql: <T = any>(
+    stmt: string,
+    options?: {
+      trim?: boolean
+    }
+  ) => SyApiMethodResponse<T[]>
+  /**
+   * Get block by block_id (through SQL query)
+   *
+   * @path wrapper: uses sql
+   * @param {BlockId} blockId - block_id
+   * @returns {Block | null} block data - Block or null
+   */
+  getBlockByID: (blockId: BlockId) => SyApiMethodResponse<Block | null>
+}
+
+
+SiYuanAPI.prototype.sql = function <T = any>(
+  stmt: string,
+  options: {
+    trim?: boolean
+  } = {},
+): SyApiMethodResponse<T[]> {
+  const {
+    trim = true,
+  } = options
+  const finalStmt = trim ? trimSqlBlank(stmt) : stmt
+  return this.request('/api/query/sql', {
+    stmt: finalStmt,
+  })
+}
+
+SiYuanAPI.prototype.getBlockByID = async function (blockId: string) {
+  const res = await this.sql(`select * from blocks where id ='${blockId}'`)
+  return {
+    code: res.code,
+    msg: res.msg,
+    data: res.data?.[0] ?? null,
+  }
+}
+

package/src/api/sqlite/index.ts

@@ -0,0 +1,20 @@
+import type {
+  SyApiMethodResponse,
+} from '../../core/index.js'
+import { SiYuanAPI } from '../../core/index.js'
+
+/**
+ * Sqlite API 类型定义
+ */
+export interface SqliteAPI {
+  /**
+   * 刷新事务
+   * @path /api/sqlite/flushTransaction
+   */
+  flushTransactions: () => SyApiMethodResponse<any>
+}
+
+SiYuanAPI.prototype.flushTransactions = function () {
+  return this.request('/api/sqlite/flushTransaction', {})
+}
+

package/src/api/system/index.ts

@@ -0,0 +1,46 @@
+import type { SyApiMethodResponse } from '../../core/index.js'
+
+import { SiYuanAPI } from '../../core/index.js'
+
+/**
+ * System API 类型定义
+ */
+export interface SystemAPI {
+  /**
+   * 获取启动进度
+   * @path /api/system/bootProgress
+   */
+  bootProgress: () => SyApiMethodResponse<any>
+  /**
+   * 获取版本号
+   * @path /api/system/version
+   */
+  version: () => SyApiMethodResponse<string>
+  /**
+   * 获取当前时间戳
+   * @path /api/system/currentTime
+   */
+  currentTime: () => SyApiMethodResponse<number>
+  /**
+   * 执行同步
+   * @path /api/sync/performSync
+   */
+  performSync: () => SyApiMethodResponse<number>
+}
+
+SiYuanAPI.prototype.bootProgress = function () {
+  return this.request('/api/system/bootProgress', {})
+}
+
+SiYuanAPI.prototype.version = function () {
+  return this.request('/api/system/version', {})
+}
+
+SiYuanAPI.prototype.currentTime = function () {
+  return this.request('/api/system/currentTime', {})
+}
+
+SiYuanAPI.prototype.performSync = function () {
+  return this.request('/api/sync/performSync', {})
+}
+

package/src/api/template/index.ts

@@ -0,0 +1,32 @@
+import type { SyApiMethodResponse } from '../../core/index.js'
+import type { DocumentId } from '../../types/index.js'
+
+import { SiYuanAPI } from '../../core/index.js'
+
+/**
+ * Template API 类型定义
+ */
+export interface TemplateAPI {
+  /**
+   * 渲染模板
+   * @path /api/template/render
+   */
+  render: (id: DocumentId, path: string) => SyApiMethodResponse<any>
+  /**
+   * 渲染 Sprig 模板
+   * @path /api/template/renderSprig
+   */
+  renderSprig: (template: string) => SyApiMethodResponse<string>
+}
+
+SiYuanAPI.prototype.render = function (id: string, path: string) {
+  return this.request('/api/template/render', {
+    id,
+    path,
+  })
+}
+
+SiYuanAPI.prototype.renderSprig = function (template: string) {
+  return this.request('/api/template/renderSprig', { template })
+}
+