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

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

@@ -0,0 +1,525 @@
+import { Action, type ActionTypes } from '@equinor/fusion-observable';
+import type { BookmarkData } from './types';
+import { BookmarkNew, BookmarkUpdate, type BookmarksFilter } from './BookmarkClient.interface';
+import { type BookmarkFlowError } from './BookmarkProvider.error';
+/**
+ * Represents the metadata associated with a bookmark action.
+ */
+type BookmarkActionMeta = {
+    ref: string;
+};
+/**
+ * Actions related to the BookmarkProvider provider state.
+ *
+ * Exports a set of actions that can be used to manage bookmarks.
+ */
+export declare const bookmarkActions: {
+    aborted: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[action: Action], Action, "action_aborted", never, never>;
+    setBookmark: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[bookmark: {
+        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;
+    }], {
+        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;
+    }, "update_bookmark", never, never>;
+    setCurrentBookmark: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[bookmark: {
+        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], {
+        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, "set_current_bookmark", never, never>;
+    fetchBookmark: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[bookmarkId: string, meta?: BookmarkActionMeta | undefined], string, "fetch_bookmark::request", never, BookmarkActionMeta | undefined> & {
+        success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[bookmark: {
+            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;
+        }, meta?: BookmarkActionMeta | undefined], {
+            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", never, BookmarkActionMeta | undefined>;
+        failure: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[error: BookmarkFlowError, meta?: BookmarkActionMeta | undefined], BookmarkFlowError, "fetch_bookmark::failure", never, BookmarkActionMeta | undefined>;
+    };
+    fetchBookmarkData: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[bookmarkId: string, meta?: BookmarkActionMeta | undefined], string, "fetch_bookmark_payload::request", never, BookmarkActionMeta | undefined> & {
+        success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[bookmarkId: string, data: BookmarkData, meta?: BookmarkActionMeta | undefined], {
+            bookmarkId: string;
+            data: BookmarkData;
+        }, "fetch_bookmark_payload::success", never, BookmarkActionMeta | undefined>;
+        failure: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[error: BookmarkFlowError, meta?: BookmarkActionMeta | undefined], BookmarkFlowError, "fetch_bookmark_payload::failure", never, BookmarkActionMeta | undefined>;
+    };
+    fetchBookmarks: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[filter?: BookmarksFilter | undefined, meta?: BookmarkActionMeta | undefined], BookmarksFilter | undefined, "fetch_bookmarks::request", never, BookmarkActionMeta | undefined> & {
+        success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[bookmarks: {
+            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;
+        }[], meta?: BookmarkActionMeta | undefined], {
+            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", never, BookmarkActionMeta | undefined>;
+        failure: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[error: BookmarkFlowError, meta?: BookmarkActionMeta | undefined], BookmarkFlowError, "fetch_bookmarks::failure", never, BookmarkActionMeta | undefined>;
+    };
+    updateBookmark: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[payload: {
+        bookmarkId: string;
+        updates: BookmarkUpdate;
+    }, meta: BookmarkActionMeta], {
+        bookmarkId: string;
+        updates: BookmarkUpdate;
+    }, "update_bookmark::request", never, BookmarkActionMeta> & {
+        success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[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;
+        }, meta: BookmarkActionMeta], {
+            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", never, BookmarkActionMeta>;
+        failure: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[payload: BookmarkFlowError, meta: BookmarkActionMeta], BookmarkFlowError, "update_bookmark::failure", never, BookmarkActionMeta>;
+    };
+    createBookmark: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[payload: BookmarkNew, meta: BookmarkActionMeta], BookmarkNew, "create_bookmark::request", never, BookmarkActionMeta> & {
+        success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[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;
+        }, meta: BookmarkActionMeta], {
+            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", never, BookmarkActionMeta>;
+        failure: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[payload: BookmarkFlowError, meta: BookmarkActionMeta], BookmarkFlowError, "create_bookmark::failure", never, BookmarkActionMeta>;
+    };
+    deleteBookmark: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[bookmarkId: string, meta?: BookmarkActionMeta | undefined], string, "delete_bookmark::request", never, {
+        ref: string;
+    }> & {
+        success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[bookmarkId: string, meta?: BookmarkActionMeta | undefined], string, "delete_bookmark::success", never, {
+            ref: string;
+        }>;
+        failure: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[payload: BookmarkFlowError, meta: BookmarkActionMeta], BookmarkFlowError, "delete_bookmark::failure", never, BookmarkActionMeta>;
+    };
+    removeBookmark: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[bookmarkId: string, meta?: BookmarkActionMeta | undefined], string, "remove_bookmark::request", never, {
+        ref: string;
+    }> & {
+        success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[payload: {
+            type: "delete_bookmark" | "remove_favourite_bookmark";
+            bookmarkId: string;
+        }, meta: BookmarkActionMeta], {
+            type: "delete_bookmark" | "remove_favourite_bookmark";
+            bookmarkId: string;
+        }, "remove_bookmark::success", never, BookmarkActionMeta>;
+        failure: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[payload: BookmarkFlowError, meta: BookmarkActionMeta], BookmarkFlowError, "remove_bookmark::failure", never, BookmarkActionMeta>;
+    };
+    addBookmarkAsFavourite: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[bookmarkId: string, meta?: BookmarkActionMeta | undefined], string, "add_favourite_bookmark::request", never, {
+        ref: string;
+    }> & {
+        success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[bookmarkId: string, meta?: BookmarkActionMeta | undefined], string, "add_favourite_bookmark::success", never, {
+            ref: string;
+        }>;
+        failure: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[error: BookmarkFlowError, meta: BookmarkActionMeta], BookmarkFlowError, "add_favourite_bookmark::failure", never, BookmarkActionMeta>;
+    };
+    removeBookmarkAsFavourite: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[bookmarkId: string, meta?: BookmarkActionMeta | undefined], string, "remove_favourite_bookmark::request", never, {
+        ref: string;
+    }> & {
+        success: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[bookmarkId: string, meta?: BookmarkActionMeta | undefined], string, "remove_favourite_bookmark::success", never, {
+            ref: string;
+        }>;
+        failure: import("@equinor/fusion-observable").ActionCreatorWithPreparedPayload<[error: BookmarkFlowError, meta: BookmarkActionMeta], BookmarkFlowError, "remove_favourite_bookmark::failure", never, BookmarkActionMeta>;
+    };
+};
+export type BookmarkActions = ActionTypes<typeof bookmarkActions>;
+export {};