@equinor/fusion-framework-module-bookmark 2.2.0 → 3.0.0

package/dist/types/bookmark.schemas.d.ts

@@ -1,44 +1,20 @@
 import * as z from 'zod';
-import type { BookmarkData } from './types';
+import type { Bookmark, BookmarkData } from './types';
 export declare const bookmarkUserSchema: z.ZodObject<{
     id: z.ZodString;
     name: z.ZodString;
     mail: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    id: string;
-    name: string;
-    mail?: string | undefined;
-}, {
-    id: string;
-    name: string;
-    mail?: string | undefined;
-}>;
+}, z.core.$strip>;
 export declare const bookmarkSourceSystemSchema: z.ZodObject<{
     identifier: z.ZodString;
     name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     subSystem: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-}, "strip", z.ZodTypeAny, {
-    identifier: string;
-    name?: string | null | undefined;
-    subSystem?: string | null | undefined;
-}, {
-    identifier: string;
-    name?: string | null | undefined;
-    subSystem?: string | null | undefined;
-}>;
+}, z.core.$strip>;
 export declare const bookmarkContextSchema: z.ZodObject<{
     id: z.ZodString;
     name: z.ZodOptional<z.ZodString>;
     type: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    id: string;
-    name?: string | undefined;
-    type?: string | undefined;
-}, {
-    id: string;
-    name?: string | undefined;
-    type?: string | undefined;
-}>;
+}, z.core.$strip>;
 export declare const bookmarkSchema: z.ZodObject<{
     id: z.ZodString;
     name: z.ZodString;
@@ -50,112 +26,24 @@ export declare const bookmarkSchema: z.ZodObject<{
         id: z.ZodString;
         name: z.ZodString;
         mail: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    }, {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    }>;
+    }, z.core.$strip>;
     updated: z.ZodOptional<z.ZodDate>;
     updatedBy: z.ZodOptional<z.ZodObject<{
         id: z.ZodString;
         name: z.ZodString;
         mail: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    }, {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    }>>;
+    }, z.core.$strip>>;
     context: z.ZodOptional<z.ZodObject<{
         id: z.ZodString;
         name: z.ZodOptional<z.ZodString>;
         type: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-        name?: string | undefined;
-        type?: string | undefined;
-    }, {
-        id: string;
-        name?: string | undefined;
-        type?: string | undefined;
-    }>>;
+    }, z.core.$strip>>;
     sourceSystem: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         identifier: z.ZodString;
         name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         subSystem: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    }, "strip", z.ZodTypeAny, {
-        identifier: string;
-        name?: string | null | undefined;
-        subSystem?: string | null | undefined;
-    }, {
-        identifier: string;
-        name?: string | null | undefined;
-        subSystem?: string | null | undefined;
-    }>>>;
-}, "strip", z.ZodTypeAny, {
-    id: string;
-    name: string;
-    appKey: string;
-    created: Date;
-    createdBy: {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    };
-    description?: string | undefined;
-    isShared?: boolean | undefined;
-    updated?: Date | undefined;
-    updatedBy?: {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    } | undefined;
-    context?: {
-        id: string;
-        name?: string | undefined;
-        type?: string | undefined;
-    } | undefined;
-    sourceSystem?: {
-        identifier: string;
-        name?: string | null | undefined;
-        subSystem?: string | null | undefined;
-    } | null | undefined;
-}, {
-    id: string;
-    name: string;
-    appKey: string;
-    created: Date;
-    createdBy: {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    };
-    description?: string | undefined;
-    isShared?: boolean | undefined;
-    updated?: Date | undefined;
-    updatedBy?: {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    } | undefined;
-    context?: {
-        id: string;
-        name?: string | undefined;
-        type?: string | undefined;
-    } | undefined;
-    sourceSystem?: {
-        identifier: string;
-        name?: string | null | undefined;
-        subSystem?: string | null | undefined;
-    } | null | undefined;
-}>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
 export declare const bookmarksSchema: z.ZodArray<z.ZodObject<{
     id: z.ZodString;
     name: z.ZodString;
@@ -167,112 +55,24 @@ export declare const bookmarksSchema: z.ZodArray<z.ZodObject<{
         id: z.ZodString;
         name: z.ZodString;
         mail: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    }, {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    }>;
+    }, z.core.$strip>;
     updated: z.ZodOptional<z.ZodDate>;
     updatedBy: z.ZodOptional<z.ZodObject<{
         id: z.ZodString;
         name: z.ZodString;
         mail: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    }, {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    }>>;
+    }, z.core.$strip>>;
     context: z.ZodOptional<z.ZodObject<{
         id: z.ZodString;
         name: z.ZodOptional<z.ZodString>;
         type: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-        name?: string | undefined;
-        type?: string | undefined;
-    }, {
-        id: string;
-        name?: string | undefined;
-        type?: string | undefined;
-    }>>;
+    }, z.core.$strip>>;
     sourceSystem: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         identifier: z.ZodString;
         name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         subSystem: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    }, "strip", z.ZodTypeAny, {
-        identifier: string;
-        name?: string | null | undefined;
-        subSystem?: string | null | undefined;
-    }, {
-        identifier: string;
-        name?: string | null | undefined;
-        subSystem?: string | null | undefined;
-    }>>>;
-}, "strip", z.ZodTypeAny, {
-    id: string;
-    name: string;
-    appKey: string;
-    created: Date;
-    createdBy: {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    };
-    description?: string | undefined;
-    isShared?: boolean | undefined;
-    updated?: Date | undefined;
-    updatedBy?: {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    } | undefined;
-    context?: {
-        id: string;
-        name?: string | undefined;
-        type?: string | undefined;
-    } | undefined;
-    sourceSystem?: {
-        identifier: string;
-        name?: string | null | undefined;
-        subSystem?: string | null | undefined;
-    } | null | undefined;
-}, {
-    id: string;
-    name: string;
-    appKey: string;
-    created: Date;
-    createdBy: {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    };
-    description?: string | undefined;
-    isShared?: boolean | undefined;
-    updated?: Date | undefined;
-    updatedBy?: {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    } | undefined;
-    context?: {
-        id: string;
-        name?: string | undefined;
-        type?: string | undefined;
-    } | undefined;
-    sourceSystem?: {
-        identifier: string;
-        name?: string | null | undefined;
-        subSystem?: string | null | undefined;
-    } | null | undefined;
-}>, "many">;
+    }, z.core.$strip>>>;
+}, z.core.$strip>>;
 export declare const bookmarkWithDataSchema: <T extends BookmarkData = BookmarkData, S extends z.ZodSchema<T> = z.ZodSchema<T>>(schema?: S) => z.ZodObject<{
     id: z.ZodString;
     name: z.ZodString;
@@ -284,179 +84,23 @@ export declare const bookmarkWithDataSchema: <T extends BookmarkData = BookmarkD
         id: z.ZodString;
         name: z.ZodString;
         mail: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    }, {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    }>;
+    }, z.core.$strip>;
     updated: z.ZodOptional<z.ZodDate>;
     updatedBy: z.ZodOptional<z.ZodObject<{
         id: z.ZodString;
         name: z.ZodString;
         mail: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    }, {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    }>>;
+    }, z.core.$strip>>;
     context: z.ZodOptional<z.ZodObject<{
         id: z.ZodString;
         name: z.ZodOptional<z.ZodString>;
         type: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-        name?: string | undefined;
-        type?: string | undefined;
-    }, {
-        id: string;
-        name?: string | undefined;
-        type?: string | undefined;
-    }>>;
+    }, z.core.$strip>>;
     sourceSystem: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         identifier: z.ZodString;
         name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         subSystem: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    }, "strip", z.ZodTypeAny, {
-        identifier: string;
-        name?: string | null | undefined;
-        subSystem?: string | null | undefined;
-    }, {
-        identifier: string;
-        name?: string | null | undefined;
-        subSystem?: string | null | undefined;
-    }>>>;
-} & {
+    }, z.core.$strip>>>;
     payload: S;
-}, "strip", z.ZodTypeAny, z.objectUtil.addQuestionMarks<z.baseObjectOutputType<{
-    id: z.ZodString;
-    name: z.ZodString;
-    appKey: z.ZodString;
-    description: z.ZodOptional<z.ZodString>;
-    isShared: z.ZodOptional<z.ZodBoolean>;
-    created: z.ZodDate;
-    createdBy: z.ZodObject<{
-        id: z.ZodString;
-        name: z.ZodString;
-        mail: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    }, {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    }>;
-    updated: z.ZodOptional<z.ZodDate>;
-    updatedBy: z.ZodOptional<z.ZodObject<{
-        id: z.ZodString;
-        name: z.ZodString;
-        mail: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    }, {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    }>>;
-    context: z.ZodOptional<z.ZodObject<{
-        id: z.ZodString;
-        name: z.ZodOptional<z.ZodString>;
-        type: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-        name?: string | undefined;
-        type?: string | undefined;
-    }, {
-        id: string;
-        name?: string | undefined;
-        type?: string | undefined;
-    }>>;
-    sourceSystem: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-        identifier: z.ZodString;
-        name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        subSystem: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    }, "strip", z.ZodTypeAny, {
-        identifier: string;
-        name?: string | null | undefined;
-        subSystem?: string | null | undefined;
-    }, {
-        identifier: string;
-        name?: string | null | undefined;
-        subSystem?: string | null | undefined;
-    }>>>;
-} & {
-    payload: S;
-}>, any> extends infer T_1 ? { [k in keyof T_1]: T_1[k]; } : never, z.baseObjectInputType<{
-    id: z.ZodString;
-    name: z.ZodString;
-    appKey: z.ZodString;
-    description: z.ZodOptional<z.ZodString>;
-    isShared: z.ZodOptional<z.ZodBoolean>;
-    created: z.ZodDate;
-    createdBy: z.ZodObject<{
-        id: z.ZodString;
-        name: z.ZodString;
-        mail: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    }, {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    }>;
-    updated: z.ZodOptional<z.ZodDate>;
-    updatedBy: z.ZodOptional<z.ZodObject<{
-        id: z.ZodString;
-        name: z.ZodString;
-        mail: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    }, {
-        id: string;
-        name: string;
-        mail?: string | undefined;
-    }>>;
-    context: z.ZodOptional<z.ZodObject<{
-        id: z.ZodString;
-        name: z.ZodOptional<z.ZodString>;
-        type: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-        name?: string | undefined;
-        type?: string | undefined;
-    }, {
-        id: string;
-        name?: string | undefined;
-        type?: string | undefined;
-    }>>;
-    sourceSystem: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-        identifier: z.ZodString;
-        name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        subSystem: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    }, "strip", z.ZodTypeAny, {
-        identifier: string;
-        name?: string | null | undefined;
-        subSystem?: string | null | undefined;
-    }, {
-        identifier: string;
-        name?: string | null | undefined;
-        subSystem?: string | null | undefined;
-    }>>>;
-} & {
-    payload: S;
-}> extends infer T_2 ? { [k_1 in keyof T_2]: T_2[k_1]; } : never>;
+}, z.core.$strip>;
+export declare const parseBookmark: <T extends BookmarkData>(value: unknown) => Bookmark<T>;

package/dist/types/types.d.ts

@@ -1,39 +1,117 @@
-import type z from 'zod';
-import type { bookmarkContextSchema, bookmarkSchema, bookmarkSourceSystemSchema, bookmarksSchema, bookmarkUserSchema } from './bookmark.schemas';
-import type { bookmarkConfigSchema } from './bookmark-config.schema';
+import type { ILogger, LogLevel } from '@equinor/fusion-log';
+import type { IEventModuleProvider } from '@equinor/fusion-framework-module-event';
+import type { IBookmarkProvider } from './BookmarkProvider.interface';
+import type { IBookmarkClient } from './BookmarkClient.interface';
 /**
  * Represents the source system for a bookmark.
  */
-export type SourceSystem = z.infer<typeof bookmarkSourceSystemSchema>;
+export interface SourceSystem {
+    /** Unique identifier for the source system */
+    identifier: string;
+    /** Human-readable name of the source system */
+    name?: string | null;
+    /** Sub-system identifier */
+    subSystem?: string | null;
+}
 /**
  * Represents the data associated with a bookmark.
  * This is a generic type that can hold any arbitrary data as a key-value map.
  */
-export type BookmarkData = Record<string, any> | string;
+export type BookmarkData = Record<string, unknown> | string;
 /**
- * Represents a collection of bookmarks.
+ * Represents a user associated with a bookmark.
+ */
+export interface BookmarkUser {
+    /** Unique identifier for the user */
+    id: string;
+    /** Display name of the user */
+    name: string;
+    /** Email address of the user */
+    mail?: string;
+}
+/**
+ * Represents the context associated with a bookmark.
  */
-export type Bookmarks = z.infer<typeof bookmarksSchema>;
+export interface BookmarkContext {
+    /** Unique identifier for the context */
+    id: string;
+    /** Human-readable name of the context */
+    name?: string;
+    /** Type of the context */
+    type?: string;
+}
 /**
  * Represents a bookmark without any associated data.
  */
-export type BookmarkWithoutData = z.infer<typeof bookmarkSchema>;
+export interface BookmarkWithoutData {
+    /** Unique identifier for the bookmark */
+    id: string;
+    /** Name of the bookmark */
+    name: string;
+    /** Application key this bookmark belongs to */
+    appKey: string;
+    /** Optional description of the bookmark */
+    description?: string;
+    /** Whether the bookmark is shared */
+    isShared?: boolean;
+    /** When the bookmark was created */
+    created: Date;
+    /** User who created the bookmark */
+    createdBy: BookmarkUser;
+    /** When the bookmark was last updated */
+    updated?: Date;
+    /** User who last updated the bookmark */
+    updatedBy?: BookmarkUser;
+    /** Context associated with the bookmark */
+    context?: BookmarkContext;
+    /** Source system information */
+    sourceSystem?: SourceSystem | null;
+}
 /**
  * Represents a bookmark with associated data.
  * @template T - The type of the bookmark data.
  */
-export type Bookmark<T extends BookmarkData = any> = BookmarkWithoutData & {
+export interface Bookmark<T extends BookmarkData = any> extends BookmarkWithoutData {
+    /** Optional payload data associated with the bookmark */
     payload?: T;
-};
-/**
- * Represents the configuration options for a bookmark module.
- */
-export type BookmarkModuleConfig = z.infer<typeof bookmarkConfigSchema>;
+}
 /**
- * Represents a user associated with a bookmark.
+ * Represents a collection of bookmarks.
  */
-export type BookmarkUser = z.infer<typeof bookmarkUserSchema>;
+export type Bookmarks = BookmarkWithoutData[];
 /**
- * Represents the context associated with a bookmark.
+ * Represents the configuration options for a bookmark module.
  */
-export type bookmarkContext = z.infer<typeof bookmarkContextSchema>;
+export interface BookmarkModuleConfig {
+    /** Optional logger instance */
+    log?: ILogger;
+    /** Optional log level */
+    logLevel?: LogLevel;
+    /** Optional event provider for handling events */
+    eventProvider?: IEventModuleProvider;
+    /** The source system for the bookmarks */
+    sourceSystem?: SourceSystem;
+    /** Parent Bookmark provider */
+    parent?: IBookmarkProvider | null;
+    /** API client for interacting with bookmarks */
+    client: IBookmarkClient;
+    /** Functions for resolving context and application */
+    resolve: {
+        /** Function to resolve the current context */
+        context: () => Promise<{
+            id: string;
+        } | undefined>;
+        /** Function to resolve the current application */
+        application: () => Promise<{
+            appKey: string;
+            name?: string;
+        } | undefined>;
+    };
+    /** Flags for enabling resolving when fetching bookmarks */
+    filters?: {
+        /** Whether to filter by context */
+        context?: boolean;
+        /** Whether to filter by application */
+        application?: boolean;
+    };
+}

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "2.2.0";
+export declare const version = "3.0.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-module-bookmark",
-  "version": "2.2.0",
+  "version": "3.0.0",
   "description": "",
   "main": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
@@ -38,23 +38,23 @@
   },
   "dependencies": {
     "fast-deep-equal": "^3.1.3",
-    "immer": "^9.0.16",
+    "immer": "^10.1.3",
     "rxjs": "^7.8.1",
-    "uuid": "^11.0.3",
-    "@equinor/fusion-framework-module": "^5.0.0",
-    "@equinor/fusion-observable": "^8.5.1",
-    "@equinor/fusion-query": "^5.2.11",
-    "@equinor/fusion-log": "^1.1.5"
+    "uuid": "^13.0.0",
+    "@equinor/fusion-framework-module": "^5.0.1",
+    "@equinor/fusion-log": "^1.1.7",
+    "@equinor/fusion-query": "^5.2.13",
+    "@equinor/fusion-observable": "^8.5.3"
   },
   "devDependencies": {
-    "@types/uuid": "^9.0.8",
+    "@types/uuid": "^11.0.0",
     "typescript": "^5.8.2",
-    "zod": "^3.25.76",
-    "@equinor/fusion-framework-module-app": "^6.1.17",
+    "zod": "^4.1.8",
+    "@equinor/fusion-framework-module-app": "^7.0.0",
     "@equinor/fusion-framework-module-context": "^7.0.0",
     "@equinor/fusion-framework-module-event": "^4.3.7",
-    "@equinor/fusion-framework-module-http": "^6.3.4",
-    "@equinor/fusion-framework-module-services": "^7.0.0"
+    "@equinor/fusion-framework-module-services": "^7.1.0",
+    "@equinor/fusion-framework-module-http": "^7.0.0"
   },
   "scripts": {
     "build": "tsc -b"