@equinor/fusion-framework-module-bookmark 4.1.0 → 4.1.2

package/src/mock/module.ts

@@ -1,64 +0,0 @@
-import type { AnyModule, IModulesConfigurator } from '@equinor/fusion-framework-module';
-
-import { module, type BookmarkModule } from '../bookmark-module';
-
-import { BookmarkMockConfigurator } from './BookmarkMockConfigurator';
-
-/**
- * The bookmark module with a mock, in-memory client instead of a live
- * `@equinor/fusion-framework-module-services` connection.
- *
- * @remarks
- * Only `configure` differs from the real module. `initialize` is the
- * production one, untouched, so the real `BookmarkProvider` and
- * `bookmark-flows/` epics run exactly as they do in production — a test
- * observes the real create/update/delete/favorite flow, not a rehearsal of it.
- */
-export const bookmarkMockModule: BookmarkModule = {
-  ...module,
-  configure: () => new BookmarkMockConfigurator(),
-};
-
-/**
- * Configuration callback for {@link enableBookmarkMock}.
- *
- * @template TRef - Reference type forwarded to the callback, inferred from the configurator.
- */
-export type BookmarkMockConfigFn<TRef = unknown> = (
-  configurator: BookmarkMockConfigurator,
-  ref?: TRef,
-) => void | Promise<void>;
-
-/**
- * Enables the bookmark module against an in-memory mock client, so a test
- * needs no network and no real Fusion Core Services backend.
- *
- * @remarks
- * Registered last, this replaces whichever bookmark module the configurator
- * already carries, so it works on a `FrameworkConfigurator` that pre-registers
- * the real one.
- *
- * @param configurator - The modules configurator to register on.
- * @param configure - Optional callback to seed bookmarks, the current bookmark, or favorites.
- * @template TModules - The array of module descriptors managed by `configurator`.
- * @template TRef - Reference type forwarded to `configure`, inferred from `configurator`.
- *
- * @example
- * ```typescript
- * enableBookmarkMock(configurator, (builder) => {
- *   builder.setBookmarks([myBookmark]);
- *   builder.setCurrentBookmark(myBookmark.id);
- * });
- * ```
- */
-export const enableBookmarkMock = <
-  TModules extends Array<AnyModule> = Array<AnyModule>,
-  TRef = unknown,
->(
-  configurator: IModulesConfigurator<TModules, TRef>,
-  configure?: BookmarkMockConfigFn<TRef>,
-): void => {
-  configurator.addConfig({ module: bookmarkMockModule, configure } as {
-    module: BookmarkModule;
-  });
-};

package/src/types.ts

@@ -1,121 +0,0 @@
-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 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, unknown> | string;
-
-/**
- * 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 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 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.
- */
-// biome-ignore lint/suspicious/noExplicitAny: must be any to support all bookmark data types
-export interface Bookmark<T extends BookmarkData = any> extends BookmarkWithoutData {
-  /** Optional payload data associated with the bookmark */
-  payload?: T;
-}
-
-/**
- * Represents a collection of bookmarks.
- */
-export type Bookmarks = BookmarkWithoutData[];
-
-/**
- * Represents the configuration options for a bookmark module.
- */
-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/src/version.ts

@@ -1,2 +0,0 @@
-// Generated by genversion.
-export const version = '4.1.0';

package/tsconfig.json

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

package/vitest.config.ts

@@ -1,11 +0,0 @@
-import { defineProject } from 'vitest/config';
-
-import { name, version } from './package.json' with { type: 'json' };
-
-export default defineProject({
-  test: {
-    environment: 'node',
-    include: ['src/__tests__/**/*.test.ts'],
-    name: `${name}@${version}`,
-  },
-});