@wetoria/siyuan-sdk 0.0.2

package/src/core/index.ts

@@ -0,0 +1,237 @@
+/**
+ * SiYuan SDK - API Client
+ *
+ * Supports maintaining baseURL and token, binding custom fetch, and dynamically adding methods
+ *
+ * 支持维护 baseURL 和 token，绑定自定义 fetch，动态添加方法
+ *
+ */
+
+import { IWebSocketData } from 'siyuan'
+
+
+
+/**
+ * 标准 API 响应格式
+ */
+export interface SyApiResponse<T = any> {
+  code: number
+  msg: string
+  data: T
+}
+
+export type SyApiMethodResponse<T = any> = Promise<SyApiResponse<T> | IWebSocketData>
+
+
+/**
+ * 请求选项
+ */
+export interface RequestOptions {
+  /** 请求方法 */
+  method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'
+  /** 请求头 */
+  headers?: Record<string, string>
+  /** 超时时间（毫秒） */
+  timeout?: number
+}
+
+
+
+
+/**
+ * 基础 Fetch 函数类型（统一的结构）
+ */
+export type SyBaseApiMethod<T = any> = (
+  url: string,
+  data?: any,
+  options?: RequestOptions
+) => SyApiMethodResponse<T>
+
+/**
+ * 自定义 Fetch 函数类型（别名）
+ */
+export type CustomFetch<T = any> = SyBaseApiMethod<T>
+
+
+
+/**
+ * API 配置（两种方式互斥）
+ */
+export type SiYuanAPIConfig =
+  | { baseURL: string, token: string, customFetch?: never }
+  | { baseURL?: never, token?: never, customFetch: SyBaseApiMethod }
+
+
+/**
+ * SiYuan API 客户端
+ */
+export class SiYuanAPI {
+  /** 基础 URL */
+  private baseURL: string
+  /** 认证 Token（与 customFetch 互斥） */
+  private token?: string
+  /** 自定义 fetch 函数（与 token 互斥） */
+  private customFetch?: CustomFetch
+
+
+  constructor(config: SiYuanAPIConfig) {
+    this.setConfig(config)
+  }
+
+  setConfig(config: SiYuanAPIConfig): void {
+    // 根据配置类型设置属性
+    if ('customFetch' in config) {
+      // 使用 customFetch
+      this.baseURL = '' // customFetch 模式下 baseURL 可能不需要
+      this.customFetch = config.customFetch
+      this.token = undefined
+    } else {
+      // 使用 baseURL + token
+      this.baseURL = config.baseURL
+      this.token = config.token
+      this.customFetch = undefined
+    }
+  }
+
+  /**
+   * 获取当前配置
+   */
+  getConfig(): {
+    baseURL: string
+    token?: string
+    customFetch?: CustomFetch
+  } {
+    return {
+      baseURL: this.baseURL,
+      token: this.token,
+      customFetch: this.customFetch,
+    }
+  }
+
+  /**
+   * 默认的 baseFetch 实现（使用标准 fetch）
+   */
+  private async _defaultBaseFetch(
+    url: string,
+    data?: any,
+    options?: RequestOptions,
+  ): Promise<any> {
+    const baseURL = this.baseURL || ''
+    const fullURL = url.startsWith('http')
+      ? url
+      : `${baseURL.replace(/\/$/, '')}${url}`
+
+    const method = options?.method || 'POST'
+    const headers: Record<string, string> = {
+      'Content-Type': 'application/json',
+      ...options?.headers,
+    }
+
+    // 如果有 token，添加到请求头
+    if (this.token) {
+      headers.Authorization = `Token ${this.token}`
+    }
+
+    const requestInit: RequestInit = {
+      method,
+      headers,
+    }
+
+    // 处理请求体
+    if (data !== undefined) {
+      if (data instanceof FormData) {
+        delete headers['Content-Type']
+        requestInit.body = data
+      } else {
+        requestInit.body = JSON.stringify(data)
+      }
+    }
+
+    // 处理超时
+    const timeout = options?.timeout || 30000
+    const controller = new AbortController()
+    const timeoutId = setTimeout(() => controller.abort(), timeout)
+
+    try {
+      const response = await fetch(fullURL, {
+        ...requestInit,
+        signal: controller.signal,
+      })
+
+      clearTimeout(timeoutId)
+
+      if (!response.ok) {
+        throw new Error(`HTTP ${response.status}: ${response.statusText}`)
+      }
+
+      const contentType = response.headers.get('content-type')
+
+      if (contentType && contentType.includes('application/json')) {
+        return await response.json()
+      } else {
+        return await response.text()
+      }
+    } catch (error: any) {
+      clearTimeout(timeoutId)
+      if (error.name === 'AbortError') {
+        throw new Error(`Request timeout after ${timeout}ms`)
+      }
+      throw error
+    }
+  }
+
+  /**
+   * 内部请求方法
+   * 如果存在自定义 fetch，使用自定义 fetch；否则使用默认的 baseFetch（会自动设置 baseURL 和 token）
+   * 返回思源标准格式 SyApiResponse<T>
+   * 此方法为内部方法，禁止外部修改或覆盖
+   * 允许在注入的 API 方法中使用
+   *
+   * @param url - API 端点路径
+   * @param data - 请求数据
+   * @param options - 请求选项
+   * @returns SyApiResponse<T>
+   *
+   * @internal
+   */
+  async request<T = any>(
+    url: string,
+    data?: any,
+    options?: RequestOptions,
+  ): SyApiMethodResponse<T> {
+    // 如果提供了自定义 fetch，使用自定义 fetch
+    if (this.customFetch) {
+      return await this.customFetch(url, data, options) as SyApiResponse<T>
+    }
+
+    // 否则使用默认的 baseFetch
+    return await this._defaultBaseFetch(url, data, options) as SyApiResponse<T>
+  }
+
+
+  async post<T = any>(url: string, data?: any, options?: RequestOptions): SyApiMethodResponse<T> {
+    return await this.request(url, data, {
+      ...options,
+      method: 'POST',
+    }) as SyApiResponse<T>
+  }
+
+
+  /**
+   * 提取响应数据（用于插件模式，直接返回 data）
+   * 如果 code === 0，返回 data；否则返回 null
+   *
+   * @param response - API 响应
+   * @returns 提取的数据或 null
+   */
+  extractData<T>(response: SyApiResponse<T>): T | null {
+    return response.code === 0 ? response.data : null
+  }
+}
+
+/**
+ * 创建 API 实例的便捷函数
+ */
+export function createAPI(config: SiYuanAPIConfig): SiYuanAPI {
+  return new SiYuanAPI(config)
+}

package/src/index.ts

@@ -0,0 +1,9 @@
+/**
+ * SiYuan SDK
+ */
+
+export * from './api/index.js'
+export type * from './core/index.js'
+export * from './core/index.js'
+export * from './types/index.js'
+

package/src/types/index.ts

@@ -0,0 +1,140 @@
+/**
+ * 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
+}
+

package/src/utils/index.ts

@@ -0,0 +1,3 @@
+export function trimSqlBlank(sql: string) {
+  return sql.replace(/\s+/g, ' ').trim()
+}