BINFR-6408: Add pull/push view-bookmarks commands

docs/user-guide/studio-commands.md

@@ -208,3 +208,22 @@ that analysis. Use the ***--help*** flag to see all options for a specific comma
 content-cli pull analysis --help
 content-cli push analysis --help
 ```
+
+## Pull and Push View Bookmarks
+
+Enable users to pull and push view (board) bookmarks using content-cli. For pulling view bookmarks
+you can specify --type (SHARED/ALL), and by default it fetches USER bookmarks.
+
+```
+// Pull view bookmarks
+content-cli pull view-bookmarks --profile my-profile-name --id 73d39112-73ae-4bbe-8051-3c0f14e065ec --type SHARED
+```
+
+After you have pulled your view bookmarks with the --type option,
+it's time to push them inside a view in a different team. You can accomplish this using
+the same command as with pushing other assets to Studio:
+
+```
+// Push view bookmarks to Studio
+content-cli push view-bookmarks -p my-profile-name --id 73d39112-73ae-4bbe-8051-3c0f14e065ec --file studio_view_bookmarks_39c5bb7b-b486-4230-ab01-854a17ddbff2.json
+```

src/commands/view/module.ts

@@ -0,0 +1,39 @@
+/**
+ * Commands related to the View feature.
+ */
+
+import { Configurator, IModule } from "../../core/command/module-handler";
+import { Context } from "../../core/command/cli-context";
+import { Command, OptionValues } from "commander";
+import { ViewBookmarksCommandService } from "./view-bookmarks-command.service";
+
+class Module extends IModule {
+
+    public register(context: Context, configurator: Configurator): void {
+        const pullCommand = configurator.command("pull");
+        pullCommand
+            .command("view-bookmarks")
+            .description("Command to pull view bookmarks")
+            .option("--type <type>", "Type of view bookmarks to pull: USER (default), SHARED, or ALL")
+            .requiredOption("--id <id>", "ID of the view (board) to pull bookmarks from")
+            .action(this.pullViewBookmarks);
+
+        const pushCommand = configurator.command("push");
+        pushCommand
+            .command("view-bookmarks")
+            .description("Command to push view bookmarks to a board")
+            .requiredOption("--id <id>", "ID of the view (board) to push bookmarks into")
+            .requiredOption("-f, --file <file>", "The file to push")
+            .action(this.pushViewBookmarks);
+    }
+
+    private async pullViewBookmarks(context: Context, command: Command, options: OptionValues): Promise<void> {
+        await new ViewBookmarksCommandService(context).pullViewBookmarks(options.id, options.type);
+    }
+
+    private async pushViewBookmarks(context: Context, command: Command, options: OptionValues): Promise<void> {
+        await new ViewBookmarksCommandService(context).pushViewBookmarks(options.id, options.file);
+    }
+}
+
+export = Module;

src/commands/view/view-bookmarks-command.service.ts

@@ -0,0 +1,18 @@
+import { ViewBookmarksManagerFactory } from "./view-bookmarks.manager-factory";
+import { Context } from "../../core/command/cli-context";
+
+export class ViewBookmarksCommandService {
+    private viewBookmarksManagerFactory: ViewBookmarksManagerFactory;
+
+    constructor(context: Context) {
+        this.viewBookmarksManagerFactory = new ViewBookmarksManagerFactory(context);
+    }
+
+    public async pullViewBookmarks(boardId: string, type?: string): Promise<void> {
+        await this.viewBookmarksManagerFactory.createViewBookmarksManager(null, boardId, type).pull();
+    }
+
+    public async pushViewBookmarks(boardId: string, filename: string): Promise<void> {
+        await this.viewBookmarksManagerFactory.createViewBookmarksManager(filename, boardId).push();
+    }
+}

src/commands/view/view-bookmarks.manager-factory.ts

@@ -0,0 +1,37 @@
+import * as fs from "fs";
+import * as path from "path";
+import { ViewBookmarksManager } from "./view-bookmarks.manager";
+import { FatalError, logger } from "../../core/utils/logger";
+import { Context } from "../../core/command/cli-context";
+
+export class ViewBookmarksManagerFactory {
+
+    private readonly context: Context;
+
+    constructor(context: Context) {
+        this.context = context;
+    }
+
+    public createViewBookmarksManager(
+        filename: string,
+        boardId: string,
+        type?: string
+    ): ViewBookmarksManager {
+        const viewBookmarksManager = new ViewBookmarksManager(this.context);
+        viewBookmarksManager.boardId = boardId;
+        type = (type ?? "USER").toUpperCase();
+
+        viewBookmarksManager.type = type;
+        if (filename !== null) {
+            viewBookmarksManager.fileName = this.readFile(filename);
+        }
+        return viewBookmarksManager;
+    }
+
+    private readFile(fileName: string): string {
+        if (!fs.existsSync(path.resolve(process.cwd(), fileName))) {
+            logger.error(new FatalError("The provided file does not exist"));
+        }
+        return path.resolve(process.cwd(), fileName);
+    }
+}

src/commands/view/view-bookmarks.manager.ts

@@ -0,0 +1,63 @@
+import * as fs from "fs";
+import * as FormData from "form-data";
+import { Context } from "../../core/command/cli-context";
+import { BaseManager } from "../../core/http/http-shared/base.manager";
+import { ManagerConfig } from "../../core/http/http-shared/manager-config.interface";
+
+export class ViewBookmarksManager extends BaseManager {
+    private static BASE_URL = "/blueprint/api/bookmarks";
+    private static VIEW_BOOKMARKS_FILE_PREFIX = "studio_view_bookmarks_";
+
+    private _boardId: string;
+    private _fileName: string;
+    private _type: string;
+
+    constructor(context: Context) {
+        super(context);
+    }
+
+    public get fileName(): string {
+        return this._fileName;
+    }
+
+    public set fileName(value: string) {
+        this._fileName = value;
+    }
+
+    public get boardId(): string {
+        return this._boardId;
+    }
+
+    public set boardId(value: string) {
+        this._boardId = value;
+    }
+
+    public get type(): string {
+        return this._type;
+    }
+
+    public set type(value: string) {
+        this._type = value;
+    }
+
+    public getConfig(): ManagerConfig {
+        return {
+            pushUrl: `${ViewBookmarksManager.BASE_URL}/import?boardId=${encodeURIComponent(this.boardId)}`,
+            pullUrl: `${ViewBookmarksManager.BASE_URL}/export?boardId=${encodeURIComponent(this.boardId)}&type=${encodeURIComponent(this.type)}`,
+            exportFileName: `${ViewBookmarksManager.VIEW_BOOKMARKS_FILE_PREFIX}${this.boardId}.json`,
+            onPushSuccessMessage: (): string => {
+                return "View Bookmarks were pushed successfully.";
+            },
+        };
+    }
+
+    public getBody(): any {
+        const formData = new FormData();
+        formData.append("file", fs.createReadStream(this.fileName));
+        return formData;
+    }
+
+    protected getSerializedFileContent(data: any): string {
+        return JSON.stringify(data);
+    }
+}