@equinor/fusion-framework-module-bookmark 0.1.4 → 0.2.1

package/dist/types/bookmark-provider.d.ts

@@ -2,7 +2,7 @@ import { FrameworkEvent, FrameworkEventInit } from '@equinor/fusion-framework-mo
 import { BookmarkClient } from './client/bookmarkClient';
 import { BookmarkModuleConfig } from './configurator';
 import { Observable } from 'rxjs';
-import { Bookmark } from './types';
+import { Bookmark, PatchBookmark, UpdateBookmarkOptions } from './types';
 export interface IBookmarkModuleProvider {
     readonly config: BookmarkModuleConfig;
     readonly currentBookmark$: Observable<Bookmark<any> | undefined>;
@@ -13,9 +13,12 @@ export interface IBookmarkModuleProvider {
     getAllBookmarks(): Observable<Array<Bookmark>>;
     getAllBookmarksAsync(): Promise<Array<Bookmark>>;
     updateBookmark<T>(bookmark: Bookmark<T>): Observable<Bookmark<T>>;
-    updateBookmarkAsync<T>(bookmark: Bookmark<T>): Promise<Bookmark<T>>;
+    updateBookmarkAsync<T>(bookmark: PatchBookmark<T>, options?: UpdateBookmarkOptions): Promise<Bookmark<T> | undefined>;
     deleteBookmarkById(bookmarkId: string): Observable<string>;
     deleteBookmarkByIdAsync(bookmarkId: string): Promise<string>;
+    addBookmarkFavoriteAsync(bookmarkId: string): Promise<void>;
+    removeBookmarkFavoriteAsync(bookmarkId: string): Promise<void>;
+    verifyBookmarkFavoriteAsync(bookmarkId: string): Promise<boolean>;
     setCurrentBookmark<TData>(idOrItem?: string | Bookmark<TData>): void;
     createBookmark<T>(args: {
         name: string;
@@ -40,10 +43,13 @@ export declare class BookmarkModuleProvider implements IBookmarkModuleProvider {
     setCurrentBookmark<TData>(idOrItem?: string | Bookmark<TData>): Promise<void>;
     getAllBookmarks(): Observable<Bookmark<unknown>[]>;
     getAllBookmarksAsync(): Promise<Bookmark<unknown>[]>;
-    updateBookmark<T>(bookmark: Bookmark<T>): Observable<Bookmark<T>>;
-    updateBookmarkAsync<T>(bookmark: Bookmark<T>): Promise<Bookmark<T>>;
+    updateBookmark<T>(bookmark: PatchBookmark<T>): Observable<Bookmark<T>>;
+    updateBookmarkAsync<T>(bookmark: PatchBookmark<T>, options?: UpdateBookmarkOptions): Promise<Bookmark<T> | undefined>;
     deleteBookmarkById(bookmarkId: string): Observable<string>;
     deleteBookmarkByIdAsync(bookmarkId: string): Promise<string>;
+    addBookmarkFavoriteAsync(bookmarkId: string): Promise<void>;
+    removeBookmarkFavoriteAsync(bookmarkId: string): Promise<void>;
+    verifyBookmarkFavoriteAsync(bookmarkId: string): Promise<boolean>;
     addStateCreator<T>(cb: CreateBookmarkFn<T>, key?: keyof T): VoidFunction;
     createBookmark<T>(args: {
         name: string;

package/dist/types/client/bookmarkActions.d.ts

@@ -1,5 +1,5 @@
 import { ActionInstanceMap, ActionTypes } from '@equinor/fusion-observable';
-import { Bookmark, CreateBookmark } from '../types';
+import { Bookmark, CreateBookmark, PatchBookmark } from '../types';
 export declare const actions: {
     getAll: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[isValid: boolean], boolean, "getAll::request", never, never> & {
         success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[bookmarks: Bookmark<unknown>[]], Bookmark<unknown>[], "getAll::success", never, never>;
@@ -8,7 +8,7 @@ export declare const actions: {
     delete: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[id: string], string, "delete::request", never, never> & {
         success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[id: string], string, "delete::success", never, never>;
     };
-    update: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[bookmark: Bookmark<unknown>], Bookmark<unknown>, "update::request", never, never> & {
+    update: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[bookmark: PatchBookmark<unknown>], PatchBookmark<unknown>, "update::request", never, never> & {
         success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[bookmark: Bookmark<unknown>], Bookmark<unknown>, "update::success", never, never>;
     };
     create: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[bookmark: CreateBookmark<unknown>], CreateBookmark<unknown>, "create::request", never, never> & {

package/dist/types/client/bookmarkClient.d.ts

@@ -3,7 +3,7 @@ import { IHttpClient } from '@equinor/fusion-framework-module-http';
 import { BookmarksApiClient } from '@equinor/fusion-framework-module-services/bookmarks';
 import { type QueryCtorOptions } from '@equinor/fusion-query';
 import { Observable } from 'rxjs';
-import { Bookmark, CreateBookmark, GetAllBookmarksParameters, GetBookmarkParameters, SourceSystem } from '../types';
+import { Bookmark, CreateBookmark, GetAllBookmarksParameters, GetBookmarkParameters, PatchBookmark, SourceSystem } from '../types';
 export type BookmarkClientConfig = {
     client: BookmarksApiClient<'fetch', IHttpClient, Bookmark<unknown>>;
     queryClientConfig: {
@@ -30,10 +30,13 @@ export declare class BookmarkClient {
     getBookmarkById<T>(bookmarkId: string): Promise<Bookmark<T>>;
     createBookmark(bookmark: CreateBookmark<unknown>): Observable<Bookmark<unknown>>;
     createBookmarkAsync(bookmark: CreateBookmark<unknown>): Promise<Bookmark<unknown>>;
-    updateBookmark<T>(bookmark: Bookmark<T>): Observable<Bookmark<T>>;
-    updateBookmarkAsync<T>(bookmark: Bookmark<T>): Promise<Bookmark<T>>;
+    updateBookmark<T>(bookmark: PatchBookmark<T>): Observable<Bookmark<T>>;
+    updateBookmarkAsync<T>(bookmark: PatchBookmark<T>): Promise<Bookmark<T>>;
     deleteBookmarkById(bookmarkId: string): Observable<string>;
     deleteBookmarkByIdAsync(bookmarkId: string): Promise<string>;
+    addBookmarkFavoriteAsync(bookmarkId: string): Promise<void>;
+    removeBookmarkFavoriteAsync(bookmarkId: string): Promise<void>;
+    verifyBookmarkFavoriteAsync(bookmarkId: string): Promise<boolean>;
     dispose(): void;
 }
 declare module '@equinor/fusion-framework-module-event' {

package/dist/types/types.d.ts

@@ -1,4 +1,8 @@
 import { QueryFn, QueryCtorOptions } from '@equinor/fusion-query';
+export interface PatchBookmark<TData = unknown> extends Partial<Bookmark<TData>> {
+    id: string;
+    appKey: string;
+}
 export interface Bookmark<TData = unknown> {
     id: string;
     name: string;
@@ -51,4 +55,7 @@ export interface BookmarkQueryClient {
     getAllBookmarks: QueryFn<Array<Bookmark<unknown>>, GetAllBookmarksParameters> | QueryCtorOptions<Array<Bookmark<unknown>>, GetAllBookmarksParameters>;
     getBookmarkById: QueryFn<Bookmark<unknown>, GetBookmarkParameters> | QueryCtorOptions<Bookmark<unknown>, GetBookmarkParameters>;
 }
+export type UpdateBookmarkOptions = {
+    updatePayload: boolean;
+};
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@equinor/fusion-framework-module-bookmark",
-    "version": "0.1.4",
+    "version": "0.2.1",
     "description": "",
     "main": "./dist/esm/index.js",
     "exports": {
@@ -37,12 +37,12 @@
     "devDependencies": {
         "@equinor/fusion-framework-module": "^2.0.0",
         "@equinor/fusion-framework-module-event": "^2.0.0",
-        "@equinor/fusion-framework-module-services": "^2.3.0",
+        "@equinor/fusion-framework-module-services": "^2.3.1",
         "rxjs": "^7.5.7"
     },
     "peerDependencies": {
         "@equinor/fusion-framework-module": ">=1.2.5",
         "rxjs": "^7.5.7"
     },
-    "gitHead": "2cec998dee5e0781c2cc2b327e2e119d12cd0046"
+    "gitHead": "1dd3688d5ac207281d512fcb88fdb9409ad62748"
 }

package/src/bookmark-provider.ts

@@ -10,7 +10,7 @@ import { BookmarkClient } from './client/bookmarkClient';
 
 import { BookmarkModuleConfig } from './configurator';
 import { Observable, Subscription } from 'rxjs';
-import { Bookmark, CreateBookmark } from './types';
+import { Bookmark, CreateBookmark, PatchBookmark, UpdateBookmarkOptions } from './types';
 
 export interface IBookmarkModuleProvider {
     /**
@@ -83,9 +83,13 @@ export interface IBookmarkModuleProvider {
      * @template T - Payload Type
      * @param {string} bookmarkId
      * @param {Bookmark<T>} bookmark
+     * @param {UpdateBookmarkOptions} options - optional options that allow for configuration of bookmark payload update.
      * @return {Promise<Bookmark<T>>} - Promise of a Bookmark
      */
-    updateBookmarkAsync<T>(bookmark: Bookmark<T>): Promise<Bookmark<T>>;
+    updateBookmarkAsync<T>(
+        bookmark: PatchBookmark<T>,
+        options?: UpdateBookmarkOptions
+    ): Promise<Bookmark<T> | undefined>;
 
     /**
      * Function for deleting a bookmark, when successful this will update the bookmark list.
@@ -101,6 +105,27 @@ export interface IBookmarkModuleProvider {
      */
     deleteBookmarkByIdAsync(bookmarkId: string): Promise<string>;
 
+    /**
+     * Function for adding external bookmark to user's bookmarks.
+     * @param {string} bookmarkId
+     * @return {Promise<string>} void
+     */
+    addBookmarkFavoriteAsync(bookmarkId: string): Promise<void>;
+
+    /**
+     * Function for removing external bookmark to user's bookmarks.
+     * @param {string} bookmarkId
+     * @return {Promise<void>} - void
+     */
+    removeBookmarkFavoriteAsync(bookmarkId: string): Promise<void>;
+
+    /**
+     * Function for verifying that a bookmark belongs to the current user.
+     * @param {string} bookmarkId
+     * @return {Promise<string>} - void
+     */
+    verifyBookmarkFavoriteAsync(bookmarkId: string): Promise<boolean>;
+
     /**
      * Function for setting the current bookmark, when successful this will update the bookmark list.
      * @template TData - Bookmark payload type.
@@ -191,11 +216,21 @@ export class BookmarkModuleProvider implements IBookmarkModuleProvider {
         return this._bookmarkClient.getAllBookmarksAsync();
     }
 
-    public updateBookmark<T>(bookmark: Bookmark<T>): Observable<Bookmark<T>> {
+    public updateBookmark<T>(bookmark: PatchBookmark<T>): Observable<Bookmark<T>> {
         return this._bookmarkClient.updateBookmark<T>(bookmark);
     }
 
-    public async updateBookmarkAsync<T>(bookmark: Bookmark<T>): Promise<Bookmark<T>> {
+    public async updateBookmarkAsync<T>(
+        bookmark: PatchBookmark<T>,
+        options?: UpdateBookmarkOptions
+    ): Promise<Bookmark<T> | undefined> {
+        if (this.#getAppKey() !== bookmark.appKey) {
+            return;
+        }
+
+        if (options?.updatePayload) {
+            bookmark.payload = (await this.#createPayload()) as T;
+        }
         return this._bookmarkClient.updateBookmarkAsync<T>(bookmark);
     }
 
@@ -207,6 +242,18 @@ export class BookmarkModuleProvider implements IBookmarkModuleProvider {
         return this._bookmarkClient.deleteBookmarkByIdAsync(bookmarkId);
     }
 
+    public async addBookmarkFavoriteAsync(bookmarkId: string): Promise<void> {
+        await this._bookmarkClient.addBookmarkFavoriteAsync(bookmarkId);
+    }
+
+    public async removeBookmarkFavoriteAsync(bookmarkId: string): Promise<void> {
+        await this._bookmarkClient.removeBookmarkFavoriteAsync(bookmarkId);
+    }
+
+    public async verifyBookmarkFavoriteAsync(bookmarkId: string): Promise<boolean> {
+        return await this._bookmarkClient.verifyBookmarkFavoriteAsync(bookmarkId);
+    }
+
     public addStateCreator<T>(cb: CreateBookmarkFn<T>, key?: keyof T): VoidFunction {
         const bookmarkCreatorKey = key ? key : '#creator';
 
@@ -232,12 +279,7 @@ export class BookmarkModuleProvider implements IBookmarkModuleProvider {
         const payload = await this.#createPayload();
 
         const contextId = this.config.getContextId && this.config.getContextId();
-        const appKey =
-            this.config.getCurrentAppIdentification && this.config.getCurrentAppIdentification();
-
-        if (!appKey)
-            throw new Error(`There is noe current application selected, can't create bookmark.`);
-
+        const appKey = this.#getAppKey();
         const bookmark: CreateBookmark<unknown> = {
             ...args,
             appKey,
@@ -268,6 +310,16 @@ export class BookmarkModuleProvider implements IBookmarkModuleProvider {
         }, Promise.resolve({}));
     }
 
+    #getAppKey() {
+        const appKey =
+            this.config.getCurrentAppIdentification && this.config.getCurrentAppIdentification();
+
+        if (!appKey)
+            throw new Error(`There is noe current application selected, can't create bookmark.`);
+
+        return appKey;
+    }
+
     public dispose() {
         this.#subscriptions.unsubscribe();
         this._bookmarkClient.dispose();

package/src/client/bookmarkActions.ts

@@ -1,6 +1,6 @@
 import { createAsyncAction, ActionInstanceMap, ActionTypes } from '@equinor/fusion-observable';
 
-import { Bookmark, CreateBookmark } from '../types';
+import { Bookmark, CreateBookmark, PatchBookmark } from '../types';
 
 export const actions = {
     getAll: createAsyncAction(
@@ -16,7 +16,7 @@ export const actions = {
     ),
     update: createAsyncAction(
         'update',
-        (bookmark: Bookmark) => ({ payload: bookmark }),
+        (bookmark: PatchBookmark) => ({ payload: bookmark }),
         (bookmark: Bookmark) => ({ payload: bookmark })
     ),
     create: createAsyncAction(

package/src/client/bookmarkClient.ts

@@ -17,6 +17,7 @@ import {
     CreateBookmark,
     GetAllBookmarksParameters,
     GetBookmarkParameters,
+    PatchBookmark,
     SourceSystem,
 } from '../types';
 import { ActionBuilder, actions } from './bookmarkActions';
@@ -192,7 +193,7 @@ export class BookmarkClient {
         return lastValueFrom(this.createBookmark(bookmark));
     }
 
-    public updateBookmark<T>(bookmark: Bookmark<T>): Observable<Bookmark<T>> {
+    public updateBookmark<T>(bookmark: PatchBookmark<T>): Observable<Bookmark<T>> {
         return new Observable((subscriber) => {
             this.#state.dispatch.update(bookmark);
             subscriber.add(
@@ -205,7 +206,7 @@ export class BookmarkClient {
         });
     }
 
-    public async updateBookmarkAsync<T>(bookmark: Bookmark<T>): Promise<Bookmark<T>> {
+    public async updateBookmarkAsync<T>(bookmark: PatchBookmark<T>): Promise<Bookmark<T>> {
         return lastValueFrom(this.updateBookmark(bookmark));
     }
 
@@ -226,6 +227,20 @@ export class BookmarkClient {
         return lastValueFrom(this.deleteBookmarkById(bookmarkId));
     }
 
+    public async addBookmarkFavoriteAsync(bookmarkId: string): Promise<void> {
+        this.#bookmarkAPiClient.addFavorite('v1', { bookmarkId });
+    }
+
+    public async removeBookmarkFavoriteAsync(bookmarkId: string): Promise<void> {
+        this.#bookmarkAPiClient.removeFavorite('v1', { bookmarkId });
+    }
+
+    public async verifyBookmarkFavoriteAsync(bookmarkId: string): Promise<boolean> {
+        const response = await this.#bookmarkAPiClient.verifyFavorite('v1', { bookmarkId });
+        if (response.ok) return true;
+        return false;
+    }
+
     dispose(): void {
         this.#subscriptions.unsubscribe();
     }

package/src/types.ts

@@ -1,5 +1,9 @@
 import { QueryFn, QueryCtorOptions } from '@equinor/fusion-query';
 
+export interface PatchBookmark<TData = unknown> extends Partial<Bookmark<TData>> {
+    id: string;
+    appKey: string;
+}
 export interface Bookmark<TData = unknown> {
     id: string;
     name: string;
@@ -63,3 +67,7 @@ export interface BookmarkQueryClient {
         | QueryFn<Bookmark<unknown>, GetBookmarkParameters>
         | QueryCtorOptions<Bookmark<unknown>, GetBookmarkParameters>;
 }
+
+export type UpdateBookmarkOptions = {
+    updatePayload: boolean;
+};