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

package/dist/types/BookmarkProvider.reducer.d.ts

@@ -0,0 +1,302 @@
+import { type BookmarkState } from './BookmarkProvider.store';
+import { BookmarkFlowError } from './BookmarkProvider.error';
+/**
+ * Creates a reducer for managing the state of bookmarks.
+ *
+ * @todo add fast-deep-equal to compare bookmarks
+ *
+ * @param initialState - The initial state of the bookmarks.
+ * @returns A reducer function for managing the bookmarks state.
+ */
+export declare const createBookmarkReducer: (initialState?: Partial<BookmarkState>) => import("@equinor/fusion-observable").ReducerWithInitialState<BookmarkState, {
+    payload: import("@equinor/fusion-observable").Action;
+    type: "action_aborted";
+} | {
+    payload: {
+        name: string;
+        id: string;
+        appKey: string;
+        created: Date;
+        createdBy: {
+            azureUniqueId: string;
+            name: string;
+            mail?: string | undefined;
+            phoneNumber?: string | undefined;
+            jobTitle?: string | undefined;
+            accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+            accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+        };
+        description?: string | undefined;
+        isShared?: boolean | undefined;
+        updated?: Date | undefined;
+        updatedBy?: {
+            azureUniqueId: string;
+            name: string;
+            mail?: string | undefined;
+            phoneNumber?: string | undefined;
+            jobTitle?: string | undefined;
+            accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+            accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+        } | undefined;
+        context?: {
+            id: string;
+            name?: string | undefined;
+            type?: string | undefined;
+        } | undefined;
+        sourceSystem?: {
+            identifier: string;
+            name?: string | undefined;
+            subSystem?: string | undefined;
+        } | undefined;
+    };
+    type: "update_bookmark";
+} | {
+    payload: {
+        name: string;
+        id: string;
+        appKey: string;
+        created: Date;
+        createdBy: {
+            azureUniqueId: string;
+            name: string;
+            mail?: string | undefined;
+            phoneNumber?: string | undefined;
+            jobTitle?: string | undefined;
+            accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+            accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+        };
+        description?: string | undefined;
+        isShared?: boolean | undefined;
+        updated?: Date | undefined;
+        updatedBy?: {
+            azureUniqueId: string;
+            name: string;
+            mail?: string | undefined;
+            phoneNumber?: string | undefined;
+            jobTitle?: string | undefined;
+            accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+            accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+        } | undefined;
+        context?: {
+            id: string;
+            name?: string | undefined;
+            type?: string | undefined;
+        } | undefined;
+        sourceSystem?: {
+            identifier: string;
+            name?: string | undefined;
+            subSystem?: string | undefined;
+        } | undefined;
+        payload?: any;
+    } | null;
+    type: "set_current_bookmark";
+} | import("@equinor/fusion-observable").PayloadAction<string, "fetch_bookmark::request", {
+    ref: string;
+} | undefined, never> | import("@equinor/fusion-observable").PayloadAction<string, "fetch_bookmark_payload::request", {
+    ref: string;
+} | undefined, never> | import("@equinor/fusion-observable").PayloadAction<import("./BookmarkClient.interface").BookmarksFilter | undefined, "fetch_bookmarks::request", {
+    ref: string;
+} | undefined, never> | import("@equinor/fusion-observable").PayloadAction<{
+    bookmarkId: string;
+    updates: import("./BookmarkClient.interface").BookmarkUpdate;
+}, "update_bookmark::request", {
+    ref: string;
+}, never> | import("@equinor/fusion-observable").PayloadAction<import("./BookmarkClient.interface").BookmarkNew, "create_bookmark::request", {
+    ref: string;
+}, never> | import("@equinor/fusion-observable").PayloadAction<string, "delete_bookmark::request", {
+    ref: string;
+}, never> | import("@equinor/fusion-observable").PayloadAction<string, "remove_bookmark::request", {
+    ref: string;
+}, never> | import("@equinor/fusion-observable").PayloadAction<string, "add_favourite_bookmark::request", {
+    ref: string;
+}, never> | import("@equinor/fusion-observable").PayloadAction<string, "remove_favourite_bookmark::request", {
+    ref: string;
+}, never> | import("@equinor/fusion-observable").PayloadAction<{
+    name: string;
+    id: string;
+    appKey: string;
+    created: Date;
+    createdBy: {
+        azureUniqueId: string;
+        name: string;
+        mail?: string | undefined;
+        phoneNumber?: string | undefined;
+        jobTitle?: string | undefined;
+        accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+        accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+    };
+    description?: string | undefined;
+    isShared?: boolean | undefined;
+    updated?: Date | undefined;
+    updatedBy?: {
+        azureUniqueId: string;
+        name: string;
+        mail?: string | undefined;
+        phoneNumber?: string | undefined;
+        jobTitle?: string | undefined;
+        accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+        accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+    } | undefined;
+    context?: {
+        id: string;
+        name?: string | undefined;
+        type?: string | undefined;
+    } | undefined;
+    sourceSystem?: {
+        identifier: string;
+        name?: string | undefined;
+        subSystem?: string | undefined;
+    } | undefined;
+}, "fetch_bookmark::success", {
+    ref: string;
+} | undefined, never> | import("@equinor/fusion-observable").PayloadAction<BookmarkFlowError, "fetch_bookmark::failure", {
+    ref: string;
+} | undefined, never> | import("@equinor/fusion-observable").PayloadAction<{
+    bookmarkId: string;
+    data: import("./types").BookmarkData;
+}, "fetch_bookmark_payload::success", {
+    ref: string;
+} | undefined, never> | import("@equinor/fusion-observable").PayloadAction<BookmarkFlowError, "fetch_bookmark_payload::failure", {
+    ref: string;
+} | undefined, never> | import("@equinor/fusion-observable").PayloadAction<{
+    name: string;
+    id: string;
+    appKey: string;
+    created: Date;
+    createdBy: {
+        azureUniqueId: string;
+        name: string;
+        mail?: string | undefined;
+        phoneNumber?: string | undefined;
+        jobTitle?: string | undefined;
+        accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+        accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+    };
+    description?: string | undefined;
+    isShared?: boolean | undefined;
+    updated?: Date | undefined;
+    updatedBy?: {
+        azureUniqueId: string;
+        name: string;
+        mail?: string | undefined;
+        phoneNumber?: string | undefined;
+        jobTitle?: string | undefined;
+        accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+        accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+    } | undefined;
+    context?: {
+        id: string;
+        name?: string | undefined;
+        type?: string | undefined;
+    } | undefined;
+    sourceSystem?: {
+        identifier: string;
+        name?: string | undefined;
+        subSystem?: string | undefined;
+    } | undefined;
+}[], "fetch_bookmarks::success", {
+    ref: string;
+} | undefined, never> | import("@equinor/fusion-observable").PayloadAction<BookmarkFlowError, "fetch_bookmarks::failure", {
+    ref: string;
+} | undefined, never> | import("@equinor/fusion-observable").PayloadAction<{
+    name: string;
+    id: string;
+    appKey: string;
+    created: Date;
+    createdBy: {
+        azureUniqueId: string;
+        name: string;
+        mail?: string | undefined;
+        phoneNumber?: string | undefined;
+        jobTitle?: string | undefined;
+        accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+        accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+    };
+    description?: string | undefined;
+    isShared?: boolean | undefined;
+    updated?: Date | undefined;
+    updatedBy?: {
+        azureUniqueId: string;
+        name: string;
+        mail?: string | undefined;
+        phoneNumber?: string | undefined;
+        jobTitle?: string | undefined;
+        accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+        accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+    } | undefined;
+    context?: {
+        id: string;
+        name?: string | undefined;
+        type?: string | undefined;
+    } | undefined;
+    sourceSystem?: {
+        identifier: string;
+        name?: string | undefined;
+        subSystem?: string | undefined;
+    } | undefined;
+    payload?: any;
+}, "update_bookmark::success", {
+    ref: string;
+}, never> | import("@equinor/fusion-observable").PayloadAction<BookmarkFlowError, "update_bookmark::failure", {
+    ref: string;
+}, never> | import("@equinor/fusion-observable").PayloadAction<{
+    name: string;
+    id: string;
+    appKey: string;
+    created: Date;
+    createdBy: {
+        azureUniqueId: string;
+        name: string;
+        mail?: string | undefined;
+        phoneNumber?: string | undefined;
+        jobTitle?: string | undefined;
+        accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+        accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+    };
+    description?: string | undefined;
+    isShared?: boolean | undefined;
+    updated?: Date | undefined;
+    updatedBy?: {
+        azureUniqueId: string;
+        name: string;
+        mail?: string | undefined;
+        phoneNumber?: string | undefined;
+        jobTitle?: string | undefined;
+        accountType?: "Employee" | "Consultant" | "External" | "Application" | "Local" | undefined;
+        accountClassification?: "External" | "Unclassified" | "Internal" | undefined;
+    } | undefined;
+    context?: {
+        id: string;
+        name?: string | undefined;
+        type?: string | undefined;
+    } | undefined;
+    sourceSystem?: {
+        identifier: string;
+        name?: string | undefined;
+        subSystem?: string | undefined;
+    } | undefined;
+    payload?: any;
+}, "create_bookmark::success", {
+    ref: string;
+}, never> | import("@equinor/fusion-observable").PayloadAction<BookmarkFlowError, "create_bookmark::failure", {
+    ref: string;
+}, never> | import("@equinor/fusion-observable").PayloadAction<string, "delete_bookmark::success", {
+    ref: string;
+}, never> | import("@equinor/fusion-observable").PayloadAction<BookmarkFlowError, "delete_bookmark::failure", {
+    ref: string;
+}, never> | import("@equinor/fusion-observable").PayloadAction<{
+    type: "delete_bookmark" | "remove_favourite_bookmark";
+    bookmarkId: string;
+}, "remove_bookmark::success", {
+    ref: string;
+}, never> | import("@equinor/fusion-observable").PayloadAction<BookmarkFlowError, "remove_bookmark::failure", {
+    ref: string;
+}, never> | import("@equinor/fusion-observable").PayloadAction<string, "add_favourite_bookmark::success", {
+    ref: string;
+}, never> | import("@equinor/fusion-observable").PayloadAction<BookmarkFlowError, "add_favourite_bookmark::failure", {
+    ref: string;
+}, never> | import("@equinor/fusion-observable").PayloadAction<string, "remove_favourite_bookmark::success", {
+    ref: string;
+}, never> | import("@equinor/fusion-observable").PayloadAction<BookmarkFlowError, "remove_favourite_bookmark::failure", {
+    ref: string;
+}, never>>;

package/dist/types/BookmarkProvider.selectors.d.ts

@@ -0,0 +1,34 @@
+import { BookmarkFlowError } from './BookmarkProvider.error';
+import { BookmarkState } from './BookmarkProvider.store';
+import type { Bookmark, BookmarkData } from './types';
+/**
+ * Selects all bookmarks from the application state.
+ */
+export declare const bookmarksSelector: (state: BookmarkState) => Bookmark[];
+/**
+ * Retrieves a bookmark from the state by its ID.
+ */
+export declare const bookmarkSelector: <T extends BookmarkData>(state: BookmarkState, id: string) => Bookmark<T> | undefined;
+/**
+ * Selects the active bookmark from the bookmark state.
+ *
+ * if there is an active bookmark, the function returns the bookmark data.
+ *
+ * if there is no active bookmark, the function returns null.
+ * if the active bookmark was never set, the function returns undefined.
+ */
+export declare const activeBookmarkSelector: <T extends BookmarkData>(state: BookmarkState) => Bookmark<T> | null;
+/**
+ * Selects the status from the bookmark state.
+ *
+ * @param state - The bookmark state.
+ * @returns The status from the bookmark state.
+ */
+export declare const statusSelector: (state: BookmarkState) => BookmarkState["status"];
+/**
+ * Selects and returns an array of bookmark flow errors from the state.
+ *
+ * @param state - The bookmark state.
+ * @returns An array of bookmark flow errors.
+ */
+export declare const errorsSelector: (state: BookmarkState) => Array<BookmarkFlowError>;

package/dist/types/BookmarkProvider.store.d.ts

@@ -0,0 +1,30 @@
+import { FlowSubject, type ActionBaseType } from '@equinor/fusion-observable';
+import { type BookmarkActions } from './BookmarkProvider.actions';
+import { type BookmarkFlowError } from './BookmarkProvider.error';
+import type { IBookmarkClient } from './BookmarkClient.interface';
+import type { Bookmark, BookmarkWithoutData } from './types';
+/**
+ * Represents the state of the BookmarkProvider store.
+ */
+export type BookmarkState = {
+    status: Set<ActionBaseType<BookmarkActions>>;
+    errors: Record<ActionBaseType<BookmarkActions>, BookmarkFlowError>;
+    currentBookmark?: Bookmark | null;
+    bookmarks: Record<string, BookmarkWithoutData>;
+};
+/**
+ * Represents the store for bookmarks, which is a flow subject that manages the state and actions for bookmarks.
+ */
+export type BookmarkStore = FlowSubject<BookmarkState, BookmarkActions>;
+/**
+ * Creates a new BookmarkStore instance with the provided initial state and client.
+ *
+ * @param args - An object containing the initial state and client for the bookmark store.
+ * @param args.initial - The initial state for the bookmark store.
+ * @param args.client - The IBookmarkClient instance to bookmark store flows.
+ * @returns A new BookmarkStore instance.
+ */
+export declare const createBookmarkStore: (args: {
+    initial?: Partial<BookmarkState>;
+    client: IBookmarkClient;
+}) => BookmarkStore;

package/dist/types/bookmark-config.schema.d.ts

@@ -0,0 +1,118 @@
+import { z } from 'zod';
+import { LogLevel, type ILogger } from '@equinor/fusion-log';
+import type { IEventModuleProvider } from '@equinor/fusion-framework-module-event';
+import type { BookmarkProvider } from './BookmarkProvider';
+import type { IBookmarkClient } from './BookmarkClient.interface';
+export declare const bookmarkConfigSchema: z.ZodObject<{
+    log: z.ZodOptional<z.ZodType<ILogger, z.ZodTypeDef, ILogger>>;
+    logLevel: z.ZodOptional<z.ZodNativeEnum<typeof LogLevel>>;
+    eventProvider: z.ZodOptional<z.ZodType<IEventModuleProvider, z.ZodTypeDef, IEventModuleProvider>>;
+    sourceSystem: z.ZodOptional<z.ZodObject<{
+        identifier: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        subSystem: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        identifier: string;
+        name?: string | undefined;
+        subSystem?: string | undefined;
+    }, {
+        identifier: string;
+        name?: string | undefined;
+        subSystem?: string | undefined;
+    }>>;
+    parent: z.ZodNullable<z.ZodOptional<z.ZodType<BookmarkProvider, z.ZodTypeDef, BookmarkProvider>>>;
+    client: z.ZodType<IBookmarkClient, z.ZodTypeDef, IBookmarkClient>;
+    resolve: z.ZodObject<{
+        context: z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodPromise<z.ZodOptional<z.ZodObject<{
+            id: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+        }, {
+            id: string;
+        }>>>>;
+        application: z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodPromise<z.ZodOptional<z.ZodObject<{
+            appKey: z.ZodString;
+            name: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            appKey: string;
+            name?: string | undefined;
+        }, {
+            appKey: string;
+            name?: string | undefined;
+        }>>>>;
+    }, "strip", z.ZodTypeAny, {
+        context: (...args: unknown[]) => Promise<{
+            id: string;
+        } | undefined>;
+        application: (...args: unknown[]) => Promise<{
+            appKey: string;
+            name?: string | undefined;
+        } | undefined>;
+    }, {
+        context: (...args: unknown[]) => Promise<{
+            id: string;
+        } | undefined>;
+        application: (...args: unknown[]) => Promise<{
+            appKey: string;
+            name?: string | undefined;
+        } | undefined>;
+    }>;
+    filters: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        context: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        application: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    }, "strip", z.ZodTypeAny, {
+        context: boolean;
+        application: boolean;
+    }, {
+        context?: boolean | undefined;
+        application?: boolean | undefined;
+    }>>>;
+}, "strip", z.ZodTypeAny, {
+    client: IBookmarkClient;
+    resolve: {
+        context: (...args: unknown[]) => Promise<{
+            id: string;
+        } | undefined>;
+        application: (...args: unknown[]) => Promise<{
+            appKey: string;
+            name?: string | undefined;
+        } | undefined>;
+    };
+    filters: {
+        context: boolean;
+        application: boolean;
+    };
+    sourceSystem?: {
+        identifier: string;
+        name?: string | undefined;
+        subSystem?: string | undefined;
+    } | undefined;
+    log?: ILogger | undefined;
+    logLevel?: LogLevel | undefined;
+    eventProvider?: IEventModuleProvider | undefined;
+    parent?: BookmarkProvider | null | undefined;
+}, {
+    client: IBookmarkClient;
+    resolve: {
+        context: (...args: unknown[]) => Promise<{
+            id: string;
+        } | undefined>;
+        application: (...args: unknown[]) => Promise<{
+            appKey: string;
+            name?: string | undefined;
+        } | undefined>;
+    };
+    sourceSystem?: {
+        identifier: string;
+        name?: string | undefined;
+        subSystem?: string | undefined;
+    } | undefined;
+    log?: ILogger | undefined;
+    logLevel?: LogLevel | undefined;
+    eventProvider?: IEventModuleProvider | undefined;
+    parent?: BookmarkProvider | null | undefined;
+    filters?: {
+        context?: boolean | undefined;
+        application?: boolean | undefined;
+    } | undefined;
+}>;

package/dist/types/{module.d.ts → bookmark-module.d.ts}

@@ -3,11 +3,11 @@ 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 { IBookmarkModuleProvider } from './bookmark-provider';
-import { IBookmarkModuleConfigurator } from './configurator';
+import { BookmarkProvider } from './BookmarkProvider';
+import { BookmarkModuleConfigurator } from './BookmarkConfigurator';
 export type BookmarkModuleKey = 'bookmark';
 export declare const moduleKey: BookmarkModuleKey;
-export type BookmarkModule = Module<BookmarkModuleKey, IBookmarkModuleProvider, IBookmarkModuleConfigurator, [
+export type BookmarkModule = Module<BookmarkModuleKey, BookmarkProvider, BookmarkModuleConfigurator, [
     EventModule,
     ServicesModule,
     AppModule,