init

src/sy-dtype.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Copyright (c) 2023 frostime. All rights reserved.
+ * https://github.com/frostime/sy-plugin-template-vite
+ */
+
+/**
+ * 思源内部常用的数据格式
+ */
+declare module "sy-dtype" {
+
+    export type DocumentId = string;
+    export type BlockId = string;
+    export type NotebookId = string;
+    export type PreviousID = BlockId;
+    export type ParentID = BlockId | DocumentId;
+
+    export type Notebook = {
+        id: NotebookId;
+        name: string;
+        icon: string;
+        sort: number;
+        closed: boolean;
+    }
+
+    export type 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 type 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;
+        ial?: { [key: string]: string };
+        sort: number;
+        created: string;
+        updated: string;
+    }
+
+    export type doOperation = {
+        action: string;
+        data: string;
+        id: BlockId;
+        parentID: BlockId | DocumentId;
+        previousID: BlockId;
+        retData: null;
+    }
+}