@equinor/fusion-framework-module-bookmark 0.1.0

package/src/module.ts

@@ -0,0 +1,40 @@
+import { Module, ModulesInstance } from '@equinor/fusion-framework-module';
+import { EventModule } from '@equinor/fusion-framework-module-event';
+import { ServicesModule } from '@equinor/fusion-framework-module-services';
+import { AppModule } from '@equinor/fusion-framework-module-app';
+import { ContextModule } from '@equinor/fusion-framework-module-context';
+import { BookmarkModuleProvider, IBookmarkModuleProvider } from './bookmark-provider';
+import { BookmarkModuleConfigurator, IBookmarkModuleConfigurator } from './configurator';
+
+export type BookmarkModuleKey = 'bookmark';
+
+export const moduleKey: BookmarkModuleKey = 'bookmark';
+
+export type BookmarkModule = Module<
+    BookmarkModuleKey,
+    IBookmarkModuleProvider,
+    IBookmarkModuleConfigurator,
+    [EventModule, ServicesModule, AppModule, ContextModule]
+>;
+
+export const module: BookmarkModule = {
+    name: moduleKey,
+    configure: () => new BookmarkModuleConfigurator(),
+    initialize: async (args) => {
+        const ref = (args.ref as ModulesInstance<[BookmarkModule]>)?.bookmark;
+        const config = await (args.config as BookmarkModuleConfigurator).createConfig(args, ref);
+
+        return new BookmarkModuleProvider(config, ref);
+    },
+    dispose: (args) => {
+        (args.instance as BookmarkModuleProvider).dispose();
+    },
+};
+
+declare module '@equinor/fusion-framework-module' {
+    interface Modules {
+        bookmark: BookmarkModule;
+    }
+}
+
+export default module;

package/src/types.ts

@@ -0,0 +1,65 @@
+import { QueryFn, QueryCtorOptions } from '@equinor/fusion-query';
+
+export interface Bookmark<TData = unknown> {
+    id: string;
+    name: string;
+    description: string;
+    isShared: boolean;
+    payload: TData;
+    appKey: string;
+    context?: Context;
+    createdBy: CreatedBy;
+    updatedBy: CreatedBy;
+    created: string;
+    updated: string;
+    sourceSystem: SourceSystem;
+}
+
+export type CreateBookmark<TData = unknown> = {
+    /** Display name of the bookmark */
+    name: string;
+    description?: string;
+    /** Is the bookmark shared with others */
+    isShared: boolean;
+    /** Name of the app it belongs too, should correspond to a fusion appkey */
+    appKey: string;
+    contextId?: string;
+    /** Any JSON object to store as the bookmark payload */
+    payload: TData;
+    sourceSystem?: Partial<SourceSystem>;
+};
+
+export interface SourceSystem {
+    identifier: string;
+    name: string;
+    subSystem: string;
+}
+
+interface CreatedBy {
+    azureUniqueId: string;
+    mail: string;
+    name: string;
+    phoneNumber: string;
+    jobTitle: string;
+    accountType: number;
+    accountClassification: number;
+}
+
+interface Context {
+    id: string;
+    name: string;
+    type: string;
+}
+
+export type GetBookmarkParameters = { id: string };
+
+export type GetAllBookmarksParameters = { isValid: boolean };
+
+export interface BookmarkQueryClient {
+    getAllBookmarks:
+        | QueryFn<Array<Bookmark<unknown>>, GetAllBookmarksParameters>
+        | QueryCtorOptions<Array<Bookmark<unknown>>, GetAllBookmarksParameters>;
+    getBookmarkById:
+        | QueryFn<Bookmark<unknown>, GetBookmarkParameters>
+        | QueryCtorOptions<Bookmark<unknown>, GetBookmarkParameters>;
+}

package/src/utils/handle-url.ts

@@ -0,0 +1,13 @@
+const BOOKMARK_SEARCH_PARAM = 'bookmarkId';
+
+export function removeBookmarkIdFromURL(): void {
+    const params = new URLSearchParams(document.location.search);
+    params.delete(BOOKMARK_SEARCH_PARAM);
+
+    document.location.search = params.toString();
+}
+
+export const getBookmarkIdFormURL = (): string | null => {
+    const params = new URLSearchParams(document.location.search);
+    return params.get(BOOKMARK_SEARCH_PARAM);
+};

package/src/utils/index.ts

@@ -0,0 +1 @@
+export { getBookmarkIdFormURL, removeBookmarkIdFromURL } from './handle-url';

package/tsconfig.json

@@ -0,0 +1,36 @@
+{
+  "extends": "../../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "dist/esm",
+    "rootDir": "src",
+    "declarationDir": "./dist/types",
+    "baseUrl": "src",
+  },
+  "references": [
+    {
+      "path": "../../utils/query"
+    },
+    {
+      "path": "../module"
+    },
+    {
+      "path": "../services"
+    },
+    {
+      "path": "../event"
+    },
+    {
+      "path": "../context"
+    },
+    {
+      "path": "../app"
+    },
+  ],
+  "include": [
+    "src/**/*",
+  ],
+  "exclude": [
+    "node_modules",
+    "dist"
+  ]
+}