feat: support folder crud commands

Author: EastSun5566

package.json

@@ -7,7 +7,7 @@
   },
   "bugs": "https://github.com/hackmdio/hackmd-cli/issues",
   "dependencies": {
-    "@hackmd/api": "^2.5.0",
+    "@hackmd/api": "2.5.0-beta.20260430192828.99a5117",
     "@hackmd/oclif-plugin-autocomplete": "^2.1.9-fish",
     "@oclif/core": "2.8.2",
     "@oclif/plugin-help": "5.2.9",

pnpm-lock.yaml

@@ -0,0 +1,67 @@
+
+import type {CreateUserFolderBody} from '@hackmd/api'
+
+import {Flags, ux} from '@oclif/core'
+
+import HackMDCommand from '../../command'
+import {
+  folderColor,
+  folderDescription,
+  folderIcon,
+  folderName,
+  parentFolderId,
+} from '../../flags'
+
+export default class Create extends HackMDCommand {
+  static description = 'Create a folder'
+  static flags = {
+    color: folderColor,
+    description: folderDescription,
+    help: Flags.help({char: 'h'}),
+    icon: folderIcon,
+    name: folderName,
+    parentFolderId,
+    ...ux.table.flags(),
+  }
+
+  async run() {
+    const {flags} = await this.parse(Create)
+    const {color, description, icon, name, parentFolderId} = flags
+
+    if (!name) {
+      this.error('Flag name could not be empty')
+    }
+
+    const payload: CreateUserFolderBody = {
+      color,
+      description,
+      icon,
+      name,
+      parentFolderId,
+    }
+
+    try {
+      const APIClient = await this.getAPIClient()
+      const folder = await APIClient.createFolder(payload)
+
+      ux.table([folder], {
+        color: {},
+        description: {},
+        icon: {},
+        id: {
+          header: 'ID',
+        },
+        name: {},
+        parentFolderId: {
+          header: 'Parent Folder ID',
+        },
+      }, {
+        printLine: this.log.bind(this),
+        ...flags,
+      })
+    } catch (error) {
+      this.log('Create folder failed')
+      this.error(error as Error)
+    }
+  }
+}

src/commands/folders/create.ts

@@ -0,0 +1,29 @@
+import {Flags} from '@oclif/core'
+
+import HackMDCommand from '../../command'
+import {folderId} from '../../flags'
+
+export default class Delete extends HackMDCommand {
+  static description = 'Delete a folder'
+  static flags = {
+    folderId,
+    help: Flags.help({char: 'h'}),
+  }
+
+  async run() {
+    const {flags} = await this.parse(Delete)
+    const {folderId} = flags
+
+    if (!folderId) {
+      this.error('Flag folderId could not be empty')
+    }
+
+    try {
+      const APIClient = await this.getAPIClient()
+      await APIClient.deleteFolder(folderId)
+    } catch (error) {
+      this.log('Delete folder failed')
+      this.error(error as Error)
+    }
+  }
+}

src/commands/folders/delete.ts

@@ -0,0 +1,41 @@
+import {Flags, ux} from '@oclif/core'
+
+import HackMDCommand from '../../command'
+import {folderId} from '../../flags'
+
+export default class IndexCommand extends HackMDCommand {
+  static description = 'HackMD folders commands'
+  static flags = {
+    folderId,
+    help: Flags.help({char: 'h'}),
+    ...ux.table.flags(),
+  }
+
+  async run() {
+    const {flags} = await this.parse(IndexCommand)
+
+    try {
+      const APIClient = await this.getAPIClient()
+      const folders = flags.folderId ? [await APIClient.getFolder(flags.folderId)] : await APIClient.getFolderList()
+
+      ux.table(folders, {
+        color: {},
+        description: {},
+        icon: {},
+        id: {
+          header: 'ID',
+        },
+        name: {},
+        parentFolderId: {
+          header: 'Parent Folder ID',
+        },
+      }, {
+        printLine: this.log.bind(this),
+        ...flags,
+      })
+    } catch (error) {
+      this.log('Fetch folders failed')
+      this.error(error as Error)
+    }
+  }
+}

src/commands/folders/index.ts

@@ -0,0 +1,35 @@
+import {Flags} from '@oclif/core'
+
+import HackMDCommand from '../../command'
+import {folderOrder} from '../../flags'
+import {parseFolderOrder} from '../../utils'
+
+export default class Order extends HackMDCommand {
+  static description = 'Get or update folder order'
+  static flags = {
+    help: Flags.help({char: 'h'}),
+    order: folderOrder,
+  }
+
+  async run() {
+    const {flags} = await this.parse(Order)
+
+    try {
+      const APIClient = await this.getAPIClient()
+
+      if (flags.order) {
+        await APIClient.updateFolderOrder({
+          order: parseFolderOrder(flags.order),
+        })
+        this.log('Folder order updated')
+        return
+      }
+
+      const order = await APIClient.getFolderOrder()
+      this.log(JSON.stringify(order, null, 2))
+    } catch (error) {
+      this.log('Update folder order failed')
+      this.error(error as Error)
+    }
+  }
+}

src/commands/folders/order.ts

@@ -0,0 +1,68 @@
+import type {UpdateUserFolderBody} from '@hackmd/api'
+
+import {Flags, ux} from '@oclif/core'
+
+import HackMDCommand from '../../command'
+import {
+  folderColor,
+  folderDescription,
+  folderIcon,
+  folderId,
+  folderName,
+  parentFolderId,
+} from '../../flags'
+
+export default class Update extends HackMDCommand {
+  static description = 'Update folder'
+  static flags = {
+    color: folderColor,
+    description: folderDescription,
+    folderId,
+    help: Flags.help({char: 'h'}),
+    icon: folderIcon,
+    name: folderName,
+    parentFolderId,
+    ...ux.table.flags(),
+  }
+
+  async run() {
+    const {flags} = await this.parse(Update)
+    const {color, description, folderId, icon, name, parentFolderId} = flags
+
+    if (!folderId) {
+      this.error('Flag folderId could not be empty')
+    }
+
+    const payload: UpdateUserFolderBody = {
+      color,
+      description,
+      icon,
+      name,
+      parentFolderId,
+    }
+
+    try {
+      const APIClient = await this.getAPIClient()
+      const folder = await APIClient.updateFolder(folderId, payload)
+
+      ux.table([folder], {
+        color: {},
+        description: {},
+        icon: {},
+        id: {
+          header: 'ID',
+        },
+        name: {},
+        parentFolderId: {
+          header: 'Parent Folder ID',
+        },
+      }, {
+        printLine: this.log.bind(this),
+        ...flags,
+      })
+    } catch (error) {
+      this.log('Update folder failed')
+      this.error(error as Error)
+    }
+  }
+}

src/commands/folders/update.ts

@@ -1,8 +1,9 @@
-import {
+import type {
   CommentPermissionType,
   CreateNoteOptions,
   NotePermissionRole,
-} from '@hackmd/api/dist/type'
+} from '@hackmd/api'
+
 import {Flags, ux} from '@oclif/core'
 import * as fs from 'node:fs'
 
@@ -13,6 +14,7 @@ import {
   noteContent,
   notePermission,
   noteTitle,
+  parentFolderId,
 } from '../../flags'
 import {openEditor} from '../../open-editor'
 import {safeStdinRead, temporaryMD} from '../../utils'
@@ -34,6 +36,7 @@ raUuSTetT5uQbqQfLnz9lA A new note                       gvfz2UB5THiKABQJQnLs6Q
     content: noteContent,
     editor,
     help: Flags.help({char: 'h'}),
+    parentFolderId,
     readPermission: notePermission,
     title: noteTitle,
     writePermission: notePermission,
@@ -47,6 +50,7 @@ raUuSTetT5uQbqQfLnz9lA A new note                       gvfz2UB5THiKABQJQnLs6Q
     const options: CreateNoteOptions = {
       commentPermission: flags.commentPermission as CommentPermissionType,
       content: pipeString || flags.content,
+      parentFolderId: flags.parentFolderId,
       readPermission: flags.readPermission as NotePermissionRole,
       title: flags.title,
       writePermission: flags.writePermission as NotePermissionRole,

src/commands/notes/create.ts

@@ -1,7 +1,9 @@
+import type {UpdateNoteOptions} from '@hackmd/api'
+
 import {Flags} from '@oclif/core'
 
 import HackMDCommand from '../../command'
-import {noteContent, noteId} from '../../flags'
+import {noteContent, noteId, parentFolderId} from '../../flags'
 
 export default class Update extends HackMDCommand {
   static description = 'Update note content'
@@ -12,19 +14,25 @@ export default class Update extends HackMDCommand {
     content: noteContent,
     help: Flags.help({char: 'h'}),
     noteId,
+    parentFolderId,
   }
 
   async run() {
     const {flags} = await this.parse(Update)
-    const {content, noteId} = flags
+    const {content, noteId, parentFolderId} = flags
 
     if (!noteId) {
       this.error('Flag noteId could not be empty')
     }
 
+    const payload: UpdateNoteOptions = {
+      content,
+      parentFolderId,
+    }
+
     try {
       const APIClient = await this.getAPIClient()
-      await APIClient.updateNoteContent(noteId, content)
+      await APIClient.updateNote(noteId, payload)
     } catch (error) {
       this.log('Update note content failed')
       this.error(error as Error)