feat: Add typedoc support

.gitignore

@@ -4,6 +4,7 @@
 dist
 tmp
 /out-tsc
+docs
 
 # dependencies
 node_modules

package.json

@@ -5,13 +5,10 @@
   "type": "module",
   "scripts": {
     "build": "nx run-many --target=build",
-    "affected": "nx affected --target=build",
+    "publish": "nx publish <project> [--ver=0.0.1] [--tag=latest]",
     "test": "nx run-many --target=test",
     "lint": "nx run-many --target=lint",
-    "dev:zhi-cli": "node --experimental-specifier-resolution=node --loader ts-node/esm packages/zhi-cli/index.ts",
-    "watch:zhi-cli": "nx run zhi-cli:build --watch",
-    "watch:zhi": "nx run zhi:build --watch",
-    "cli:zhi-cli": "node --experimental-specifier-resolution=node dist/packages/zhi-cli"
+    "doc": "nx doc <project>"
   },
   "private": true,
   "devDependencies": {
@@ -37,6 +34,7 @@
     "nx": "15.8.9",
     "prettier": "^2.6.2",
     "ts-node": "10.9.1",
+    "typedoc": "^0.23.28",
     "typescript": "~4.9.5",
     "vite": "^4.0.1",
     "vite-plugin-dts": "~1.7.1",

packages/zhi-blog-api/project.json

@@ -32,6 +32,13 @@
       "options": {
         "lintFilePatterns": ["packages/zhi-blog-api/**/*.ts"]
       }
+    },
+    "doc": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "typedoc --tsconfig packages/zhi-blog-api/tsconfig.json --out docs/zhi-blog-api packages/zhi-blog-api/src/index.ts"
+      },
+      "dependsOn": ["build"]
     }
   },
   "tags": []

packages/zhi-blog-api/src/index.ts

@@ -26,7 +26,7 @@
 import BlogConfig, { PageType, PasswordType } from "./lib/blogConfig"
 import BlogPlaceholder from "./lib/blogPlaceholder"
 import BlogApi from "./lib/zhi-blog-api"
-import IBlogApi from "./lib/IBlogApi"
+import type { IBlogApi } from "./lib/IBlogApi"
 import Post from "./lib/models/post"
 import UserBlog from "./lib/models/userBlog"
 import SiteConfig from "./lib/models/siteConfig"

packages/zhi-blog-api/src/lib/IBlogApi.ts

@@ -171,4 +171,4 @@ interface IBlogApi {
   newMediaObject(mediaObject: MediaObject): Promise<MediaObject>
 }
 
-export default IBlogApi
+export { IBlogApi }

packages/zhi-blog-api/src/lib/blogApi.ts

@@ -28,7 +28,7 @@ import Post from "./models/post"
 import CategoryInfo from "./models/categoryInfo"
 import { version } from "../../package.json"
 import MediaObject from "./models/mediaObject"
-import IBlogApi from "./IBlogApi"
+import type { IBlogApi } from "./IBlogApi"
 
 /**
  * 博客API

packages/zhi-blog-api/src/lib/enums/postStatusEnum.ts

@@ -30,15 +30,15 @@ enum PostStatusEnum {
   /**
    * 已发布
    */
-  PostStatusEnum_Publish="publish",
+  PostStatusEnum_Publish = "publish",
   /**
    * 草稿
    */
-  PostStatusEnum_Draft="draft",
+  PostStatusEnum_Draft = "draft",
   /**
    * 继承
    */
-  PostStatusEnum_Inherit="inherit"
+  PostStatusEnum_Inherit = "inherit",
 }
 
 export default PostStatusEnum

packages/zhi-blog-api/src/lib/models/mediaObject.ts

@@ -57,10 +57,16 @@
  * @version 1.0.0
  * @since 1.0.0
  */
-interface MediaObject {
+class MediaObject {
   name: string
   type: string
   bits: Buffer
+
+  constructor(name: string, type: string, bits: Buffer) {
+    this.name = name
+    this.type = type
+    this.bits = bits
+  }
 }
 
 export default MediaObject

packages/zhi-siyuan-api/project.json

@@ -32,6 +32,13 @@
       "options": {
         "lintFilePatterns": ["packages/zhi-siyuan-api/**/*.ts"]
       }
+    },
+    "doc": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "typedoc --tsconfig packages/zhi-siyuan-api/tsconfig.json --out docs/zhi-siyuan-api packages/zhi-siyuan-api/src/index.ts"
+      },
+      "dependsOn": ["build"]
     }
   },
   "tags": []

packages/zhi-siyuan-api/src/index.ts

@@ -1,5 +1,5 @@
 import SiyuanApi from "./lib/zhi-siyuan-api"
-import { SiyuanData } from "./lib/siyuanKernelApi"
+import type { SiyuanData } from "./lib/ISiyuanKernelApi"
 
 export default SiyuanApi
 export { SiyuanData }

packages/zhi-siyuan-api/src/lib/siYuanApiAdaptor.ts

@@ -25,6 +25,8 @@
 
 import { CategoryInfo, IBlogApi, MediaObject, Post, UserBlog } from "zhi-blog-api"
 import SiyuanKernelApi from "./siyuanKernelApi"
+import Env from "zhi-env"
+import SiyuanConfig from "./siyuanConfig"
 
 /**
  * 思源笔记API适配器
@@ -36,8 +38,13 @@ import SiyuanKernelApi from "./siyuanKernelApi"
 class SiYuanApiAdaptor implements IBlogApi {
   private siyuanKernelApi
 
-  constructor() {
-    this.siyuanKernelApi = new SiyuanKernelApi()
+  /**
+   * 初始化思源 API 适配器
+   *
+   * @param cfg - 环境变量 或者 配置项
+   */
+  constructor(cfg: Env | SiyuanConfig) {
+    this.siyuanKernelApi = new SiyuanKernelApi(cfg)
   }
 
   async deletePost(postid: string): Promise<boolean> {

packages/zhi-siyuan-api/src/lib/siyuanApi.ts

@@ -48,11 +48,10 @@ class SiyuanApi {
   /**
    * 构造思源 API对象
    *
-   * @param env - 可选，注意：serverApi必须传递env才能使用
-   * @param cfg - 可选，注意：y优先级比环境变量高
+   * @param cfg - 环境变量 或者 配置项
    */
-  constructor(env?: Env, cfg?: SiyuanConfig) {
-    this.kernelApi = new SiyuanKernelApi(env, cfg)
+  constructor(cfg: Env | SiyuanConfig) {
+    this.kernelApi = new SiyuanKernelApi(cfg)
     this.clientApi = new SiyuanClientApi()
   }
 }

packages/zhi-siyuan-api/src/lib/siyuanKernelApi.ts

@@ -29,7 +29,7 @@ import LogFactory, { DefaultLogger, EnvHelper, LogLevelEnum } from "zhi-log"
 import { name, version } from "../../package.json"
 import ZhiCommon from "zhi-common"
 import SiyuanConstants from "./siyuanConstants"
-import ISiyuanKernelApi, { SiyuanData } from "./ISiyuanKernelApi"
+import ISiyuanKernelApi, { type SiyuanData } from "./ISiyuanKernelApi"
 
 /**
  * 思源笔记服务端API v2.8.2

packages/zhi-siyuan-api/src/lib/siyuanPlaceholder.ts

@@ -23,13 +23,11 @@
  * questions.
  */
 
-import { BlogPlaceholder } from "zhi-blog-api";
+import { BlogPlaceholder } from "zhi-blog-api"
 
 /**
  * 思源笔记操作提示
  */
-class SiyuanPlaceholder extends BlogPlaceholder{
-
-}
+class SiyuanPlaceholder extends BlogPlaceholder {}
 
 export default SiyuanPlaceholder