@wetoria/siyuan-sdk 0.0.2 → 0.0.4

package/src/types/index.ts

@@ -1,3 +1,4 @@
+export * from './transaction'
 /**
  * Frequently used data structures in SiYuan
  */
@@ -6,6 +7,7 @@ export type BlockId = string
 export type NotebookId = string
 export type PreviousID = BlockId
 export type ParentID = BlockId | DocumentId
+export type DataType = "markdown" | "dom"
 
 export interface Notebook {
   id: NotebookId
@@ -71,6 +73,70 @@ export type BlockSubType =
   | "video"
   | "other"
 
+/**
+ * 块属性接口 - 可以手动修改的属性
+ * 注释掉的内容也存在，这里用于展示全部字段类型，但禁止手动修改
+ */
+export interface IBlockAttrs {
+  // 基础元数据属性
+  "name"?: string // 块名称
+  "alias"?: string // 块别名
+  "memo"?: string // 块备注
+  "bookmark"?: string // 书签
+  "tags"?: string // 标签（多个用逗号分隔）
+
+  // 显示控制属性
+  "fold"?: "1" | "" // 折叠状态
+  "heading-fold"?: "1" | "" // 标题折叠状态
+  "style"?: string // CSS 样式字符串
+  "scroll"?: string // 滚动位置（JSON 格式）
+
+  // 系统属性（通常不应手动修改，但可以设置）
+  "id"?: string // 块 ID（系统自动生成）
+  "title"?: string // 块标题（文档块使用）
+  "updated"?: string // 更新时间（系统自动维护）
+  "type"?: string // 块类型
+  "icon"?: string // 图标
+  "status"?: string // 状态
+
+  // 其他系统属性
+  "refcount"?: string // 引用计数
+  "parent-heading"?: string // 父标题 ID
+  "embed-content"?: string // 嵌入内容
+
+
+  // 属性视图相关
+  "custom-avs"?: string // 属性视图 ID 列表（逗号分隔）
+  "custom-avs-names"?: string // 属性视图名称
+  "data-av-type"?: string // 属性视图类型
+
+  // 闪卡相关
+  "custom-riff-decks"?: string // 闪卡牌组
+
+  // 日记相关
+  [key: `custom-dailynote-${string}`]: string
+
+  // 自定义属性（必须以 custom- 开头）
+  [key: `custom-${string}`]: string
+
+}
+
+/**
+ * 允许设置的块属性类型
+ * 排除了系统自动维护的属性：id、updated、type、status、refcount、parent-heading、embed-content、scroll
+ */
+export type ISettableBlockAttrs = Omit<
+  IBlockAttrs,
+  "id"
+  | "updated"
+  | "type"
+  | "status"
+  | "refcount"
+  | "parent-heading"
+  | "embed-content"
+  | "scroll"
+>
+
 export interface Block {
   id: BlockId
   parent_id?: BlockId
@@ -90,7 +156,7 @@ export interface Block {
   type: BlockType
   subtype: BlockSubType
   /**
-   * string of { [key: string]: string }
+   * 块属性（Inline Attributes List）
    * For instance: "{: custom-type=\"query-code\" id=\"20230613234017-zkw3pr0\" updated=\"20230613234509\"}"
    */
   ial?: string
@@ -99,30 +165,7 @@ export interface Block {
   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
@@ -138,3 +181,21 @@ export interface backlinkData {
   expand: boolean
 }
 
+/**
+ * 子块信息（用于 getChildBlocks 返回值）
+ */
+export interface ChildBlock {
+  id: BlockId
+  type: BlockType
+  content?: string
+  markdown?: string
+}
+
+/**
+ * 块的 DOM 结构（用于 getBlockDOM 返回值）
+ */
+export interface BlockDOM {
+  dom: string
+  id: BlockId
+}
+

package/src/types/transaction/index.ts

@@ -0,0 +1,45 @@
+import {
+  BlockId,
+  DocumentId,
+} from '../index'
+
+export enum ActionTypes {
+  insert = 'insert',
+  update = 'update',
+  delete = 'delete',
+  move = 'move',
+}
+
+export interface doOperation {
+  action: ActionTypes
+  data: string
+  id: BlockId
+  parentID: BlockId | DocumentId
+  previousID: BlockId
+  nextID?: string
+  retData: null
+  blockIDs?: string[] | null
+  blockID?: string
+  deckID?: string
+  avID?: string
+  srcIDs?: string[] | null
+  srcs?: string[] | null
+  isDetached?: boolean
+  ignoreFillFilter?: boolean
+  name?: string
+  type?: string
+  format?: string
+  keyID?: string
+  rowID?: string
+  isTwoWay?: boolean
+  backRelationKeyID?: string
+  removeDest?: boolean
+  layout?: string
+}
+
+
+export interface TransactionItem {
+  timestamp: string
+  doOperations: doOperation[]
+  undoOperations: doOperation[] | null
+}