@equinor/fusion-framework-module-bookmark 1.2.13 → 2.0.0

package/dist/types/BookmarkClient.d.ts

@@ -0,0 +1,42 @@
+import { type ObservableInput } from 'rxjs';
+/**
+ * Imports the `BookmarksApiClient` and `ApiBookmarkEntityV1` types from the `@equinor/fusion-framework-module-services/bookmarks` package.
+ * These types are used to interact with the Fusion Bookmarks API and represent the API response entities.
+ */
+import type { BookmarksApiClient } from '@equinor/fusion-framework-module-services/bookmarks';
+import type { IBookmarkClient, BookmarksFilter, BookmarkNew, BookmarkUpdate } from './BookmarkClient.interface';
+import type { Bookmark, BookmarkData, BookmarkWithoutData } from './types';
+/**
+ * Represents a client for interacting with the Fusion Bookmarks API.
+ * This class provides methods for retrieving, creating, updating, and deleting bookmarks, as well as managing favorites.
+ *
+ * This implementation consumes the `@equinor/fusion-framework-module-services/bookmarks` package.
+ * This is the default implementation of the bookmarks API client.
+ *
+ * This class is intended to be used by the Fusion framework with the Fusion Core Services (Backend)
+ *
+ * Fetching single and all bookmarks will use Query from '@equinor/fusion-query' to cache the results.
+ *
+ * @note if you wish to implement your own bookmarks API client, you can do so by implementing the {@link IBookmarkClient} interface.
+ */
+export declare class BookmarkClient implements IBookmarkClient {
+    #private;
+    /**
+     * Constructs a new `BookmarkClient` instance with the provided `BookmarksApiClient`.
+     *
+     * @param api - The `BookmarksApiClient` instance to use for making API requests.
+     */
+    constructor(api: BookmarksApiClient<'json$'>, options?: {
+        expire?: number;
+    });
+    getAllBookmarks(filter?: BookmarksFilter): ObservableInput<Bookmark[]>;
+    getBookmarkById(bookmarkId: string): ObservableInput<BookmarkWithoutData>;
+    getBookmarkData<T extends BookmarkData>(bookmarkId: string): ObservableInput<T>;
+    setBookmarkData<T extends BookmarkData | null>(bookmarkId: string, data: T): ObservableInput<T>;
+    createBookmark<T extends BookmarkData>(newBookmark: BookmarkNew<T>): ObservableInput<Bookmark<T>>;
+    updateBookmark<T extends BookmarkData>(bookmarkId: string, updates: BookmarkUpdate<T>): ObservableInput<Bookmark<T>>;
+    deleteBookmark(bookmarkId: string): ObservableInput<boolean>;
+    addBookmarkToFavorites(bookmarkId: string): ObservableInput<boolean>;
+    removeBookmarkFromFavorites(bookmarkId: string): ObservableInput<boolean>;
+    isBookmarkFavorite(bookmarkId: string): ObservableInput<boolean>;
+}

package/dist/types/BookmarkClient.interface.d.ts

@@ -0,0 +1,139 @@
+import { type ObservableInput } from 'rxjs';
+import type { Bookmark, BookmarkData, BookmarkWithoutData } from './types';
+/**
+ * Defines the shape of a filter for querying bookmarks.
+ * @property {string} [appKey] - The app key to filter bookmarks by.
+ * @property {string} [contextId] - The context ID to filter bookmarks by.
+ * @property {object} [sourceSystem] - The source system to filter bookmarks by.
+ * @property {string} [sourceSystem.identifier] - The identifier of the source system.
+ * @property {string} [sourceSystem.name] - The name of the source system.
+ * @property {string} [sourceSystem.subSystem] - The sub-system of the source system.
+ */
+export type BookmarksFilter = {
+    appKey?: string;
+    contextId?: string;
+    sourceSystem?: {
+        identifier?: string;
+        name?: string;
+        subSystem?: string;
+    };
+};
+/**
+ * Defines the shape of an update to an existing bookmark.
+ * @template T - The type of the payload data for the bookmark.
+ * @property {string} [name] - The updated name of the bookmark.
+ * @property {string} [description] - The updated description of the bookmark.
+ * @property {boolean} [isShared] - Whether the bookmark is shared or not.
+ * @property {T} [payload] - The updated payload data for the bookmark.
+ */
+export type BookmarkUpdate<T extends BookmarkData = BookmarkData> = {
+    name?: string;
+    description?: string;
+    isShared?: boolean;
+    payload?: T | null;
+    sourceSystem?: {
+        identifier: string;
+        name?: string | null;
+        subSystem?: string | null;
+    } | null;
+};
+/**
+ * Defines the shape of a new bookmark to be created.
+ * @template T - The type of the payload data for the bookmark.
+ * @property {string} name - The name of the bookmark.
+ * @property {string} appKey - The app key associated with the bookmark.
+ * @property {string} [description] - The description of the bookmark.
+ * @property {boolean} [isShared] - Whether the bookmark is shared or not.
+ * @property {string} [contextId] - The context ID associated with the bookmark.
+ * @property {object} [sourceSystem] - Information about the source system of the bookmark.
+ * @property {string} [sourceSystem.identifier] - The identifier of the source system.
+ * @property {string} [sourceSystem.name] - The name of the source system.
+ * @property {string} [sourceSystem.subSystem] - The sub-system of the source system.
+ * @property {T} [payload] - The payload data for the bookmark.
+ */
+export type BookmarkNew<T extends BookmarkData = BookmarkData> = {
+    name: string;
+    appKey: string;
+    description?: string;
+    isShared?: boolean;
+    contextId?: string;
+    sourceSystem?: {
+        identifier: string;
+        name?: string;
+        subSystem?: string;
+    };
+    payload?: T;
+};
+/**
+ * Defines the interface for a Bookmarks client, which provides methods for managing bookmarks.
+ */
+export interface IBookmarkClient {
+    /**
+     * Retrieves all bookmarks for the current user.
+     * @template TPayload - The type of the payload data for the bookmarks.
+     * @param args - Optional arguments to filter or customize the bookmark retrieval.
+     * @returns An observable input containing an array of bookmarks.
+     */
+    getAllBookmarks: (filter?: BookmarksFilter) => ObservableInput<Array<Bookmark>>;
+    /**
+     * Retrieves a single bookmark by id.
+     * @template TPayload - The type of the payload data for the bookmark.
+     * @param bookmarkId - The id of the bookmark to retrieve.
+     * @returns An observable input containing the requested bookmark.
+     */
+    getBookmarkById: (bookmarkId: string) => ObservableInput<BookmarkWithoutData>;
+    /**
+     * Retrieves the bookmark data for the specified bookmark ID.
+     *
+     * @param bookmarkId - The ID of the bookmark to retrieve data for.
+     * @returns An observable that emits the bookmark data.
+     */
+    getBookmarkData: <T extends BookmarkData>(bookmarkId: string) => ObservableInput<T>;
+    /**
+     * Updates the data associated with a bookmark.
+     *
+     * @template T - The type of the data to be associated with the bookmark. Can be a record or null.
+     * @param bookmarkId - The ID of the bookmark to update.
+     * @param data - The new data to be associated with the bookmark.
+     * @returns An observable that emits the updated data.
+     */
+    setBookmarkData<T extends BookmarkData | null>(bookmarkId: string, data: T): ObservableInput<T>;
+    /**
+     * Adds a bookmark to the current user's favorites.
+     * @param bookmarkId - The id of the bookmark to add to favorites.
+     * @returns An observable input containing a boolean indicating whether the operation was successful.
+     */
+    addBookmarkToFavorites: (bookmarkId: string) => ObservableInput<boolean>;
+    /**
+     * Removes a bookmark from the current user's favorites.
+     * @param bookmarkId - The id of the bookmark to remove from favorites.
+     * @returns An observable input containing a boolean indicating whether the operation was successful.
+     */
+    removeBookmarkFromFavorites: (bookmarkId: string) => ObservableInput<boolean>;
+    /**
+     * Verifies whether a bookmark is a favorite of the current user.
+     * @param bookmarkId - The id of the bookmark to verify.
+     * @returns An observable input containing a boolean indicating whether the bookmark is a favorite.
+     */
+    isBookmarkFavorite: (bookmarkId: string) => ObservableInput<boolean>;
+    /**
+     * Creates a new bookmark.
+     * @template TPayload - The type of the payload data for the bookmark.
+     * @param bookmark - The bookmark data to create.
+     * @returns An observable input containing the created bookmark.
+     */
+    createBookmark: <T extends BookmarkData>(bookmark: BookmarkNew<T>) => ObservableInput<Bookmark<T>>;
+    /**
+     * Updates an existing bookmark.
+     * @template TPayload - The type of the payload data for the bookmark.
+     * @param bookmark - The bookmark data to update.
+     * @returns An observable input containing the updated bookmark.
+     */
+    updateBookmark: <T extends BookmarkData>(bookmarkId: string, updates: BookmarkUpdate<T>) => ObservableInput<Bookmark<T>>;
+    /**
+     * Deletes a bookmark by id.
+     * @param bookmarkId - The id of the bookmark to delete.
+     * @returns An observable input containing a boolean indicating whether the operation was successful.
+     */
+    deleteBookmark: (bookmarkId: string) => ObservableInput<boolean>;
+}

package/dist/types/BookmarkConfigurator.d.ts

@@ -0,0 +1,100 @@
+import { BaseConfigBuilder, type ConfigBuilderCallback, type ConfigBuilderCallbackArgs, type ModulesInstanceType } from '@equinor/fusion-framework-module';
+import type { AppModuleProvider } from '@equinor/fusion-framework-module-app';
+import { type ILogger, LogLevel } from '@equinor/fusion-log';
+import type { BookmarkModule } from './bookmark-module';
+import type { BookmarkModuleConfig } from './types';
+/**
+ * Configurator for the bookmark module.
+ * This class provides a set of methods for configuring the bookmark module.
+ */
+export declare class BookmarkModuleConfigurator extends BaseConfigBuilder<BookmarkModuleConfig> {
+    #private;
+    defaultExpireTime: number;
+    constructor(options?: {
+        log?: ILogger;
+        ref?: ModulesInstanceType<[BookmarkModule]>;
+    });
+    /**
+     * Sets the log level for the bookmark configurator.
+     *
+     * @param level - The log level to set. Allowed values are:
+     * - 0: No logging
+     * - 1: Error messages only
+     * - 2: Error and warning messages
+     * - 3: Error, warning, and info messages
+     * - 4: Error, warning, info, and debug messages
+     */
+    setLogLevel(level: LogLevel): void;
+    /**
+     * Sets the client for interacting with bookmark operations.
+     * The client argument can be either a client object with predefined methods for bookmark operations or a callback function that creates and returns such a client object.
+     * This method enables the configuration of how the bookmark module interacts with the backend or any other service to perform operations such as getting, creating, or updating bookmarks.
+     *
+     * @param client A client object or a callback function that returns a client object.
+     * - If a callback function is provided, it receives an initializer function as its argument,
+     *   and it should return a Promise that resolves to a client object.
+     * - If a client object is provided directly, it is wrapped in a Promise and used as-is.
+     *
+     * @see {@link BookmarkModuleConfig.client}
+     */
+    setClient(client: ConfigBuilderCallback<BookmarkModuleConfig['client']> | BookmarkModuleConfig['client']): void;
+    /**
+     * Sets the parent configuration for the bookmark module.
+     * This allows the bookmark module to inherit configuration from a parent module.
+     *
+     * @param parent - A callback function or a configuration object that provides the parent configuration.
+     * - If a callback function is provided, it receives an initializer function as its argument and should return a Promise that resolves to the parent configuration object.
+     * - If a configuration object is provided directly, it is wrapped in a Promise and used as-is.
+     */
+    setParent(parent: ConfigBuilderCallback<BookmarkModuleConfig['parent']> | BookmarkModuleConfig['parent']): void;
+    /**
+     * Set the source system for the bookmark module.
+     * This is used to tag bookmarks with their originating system for filtering or categorization purposes.
+     * @param sourceSystem - A callback function that returns the source system or a string value of the source system.
+     *
+     * Example:
+     * ```
+     * configurator.setSourceSystem('MyApplication');
+     * ```
+     * or
+     * ```
+     * configurator.setSourceSystem((init) => 'MyApplication');
+     * ```
+     */
+    setSourceSystem(sourceSystem: ConfigBuilderCallback<BookmarkModuleConfig['sourceSystem']> | BookmarkModuleConfig['sourceSystem']): void;
+    /**
+     * Set the context ID resolver for the bookmark module.
+     * This function is used to resolve the context ID dynamically, allowing for context-aware bookmark operations.
+     * @param cb - A callback function that returns the context ID resolver function.
+     *
+     * Example:
+     * ```
+     * configurator.setContextIdResolver((init) => () => 'currentContextId');
+     * ```
+     */
+    setContextResolver(cb: ConfigBuilderCallback<BookmarkModuleConfig['resolve']['context']>): void;
+    /**
+     * Set the application key resolver for the bookmark module.
+     * This function is used to resolve the application key dynamically, providing a way to associate bookmarks with specific applications.
+     * @param cb - A callback function that returns the application key resolver function.
+     *
+     * Example:
+     * ```
+     * configurator.setApplicationKeyResolver((init) => () => 'myApplicationKey');
+     * ```
+     */
+    setApplicationResolver(cb: ConfigBuilderCallback<BookmarkModuleConfig['resolve']['application']>): void;
+    /**
+     * Sets a filter for the bookmark module.
+     * @param key - The key of the filter to set.
+     * @param value - The value to set for the filter.
+     *
+     * Applied when fetching bookmarks
+     * - application: Only return bookmarks for the resolved application.
+     * - context: Only return bookmarks for the resolved context.
+     */
+    setFilter<TKey extends keyof BookmarkModuleConfig['filters']>(key: TKey, value: BookmarkModuleConfig['filters'][TKey]): void;
+    protected _resolveAppProvider(init: ConfigBuilderCallbackArgs): Promise<AppModuleProvider | undefined>;
+    protected _processConfig(config: Partial<BookmarkModuleConfig>, _init: ConfigBuilderCallbackArgs): Promise<BookmarkModuleConfig>;
+}
+export default BookmarkModuleConfigurator;