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

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Change Log
 
+## 4.1.0
+
+### Minor Changes
+
+- f663b46: Add a purpose-built mock, exported from a new `/mock` subpath (`@equinor/fusion-framework-module-bookmark/mock`).
+  
+  `enableBookmarkMock` swaps in an in-memory `IBookmarkClient` behind the real `BookmarkModuleConfigurator`, `BookmarkProvider`, and store flows — create, update, delete, and favourite calls all reach the mock client through the real flow logic, not a stand-in. `BookmarkMockConfigurator` adds a bookmark-domain vocabulary for seeding state:
+  
+  ```typescript
+  import { enableBookmarkMock } from '@equinor/fusion-framework-module-bookmark/mock';
+  
+  enableBookmarkMock(configurator, (builder) => {
+    builder.setBookmarks([
+      {
+        id: 'bookmark-1',
+        name: 'My Bookmark',
+        appKey: 'my-app',
+        payload: {},
+        created: new Date(),
+        createdBy: { id: 'mock-user', name: 'Mock User' },
+      },
+    ]);
+    builder.setCurrentBookmark('bookmark-1');
+    builder.setFavorite('bookmark-1', true);
+  });
+  ```
+  
+  The whole real builder API stays available, including `setClient`, so an explicit call to it still replaces the mock client outright. When no real `app`/`context` module is registered alongside the mock, `resolve.application`/`resolve.context` fall back to trivial resolvers automatically, since the module's config schema requires both.
+  
+  Related: equinor/fusion-core-tasks#1667.
+
 ## 4.0.4
 
 ### Patch Changes

package/README.md

@@ -232,6 +232,48 @@ enableBookmark(configurator, (builder) => {
 });
 ```
 
+## Testing
+
+Import from `@equinor/fusion-framework-module-bookmark/mock` to seed bookmarks in-process instead of calling a real API. The real `BookmarkModuleConfigurator`, `BookmarkProvider`, and store flows still run — only `IBookmarkClient` is substituted with an in-memory implementation.
+
+### Defaults
+
+- The in-memory client starts with no bookmarks or favorites.
+- No current bookmark is selected unless `setCurrentBookmark` names a seeded bookmark.
+- Create, update, delete, and favorite operations mutate the in-memory client through the real provider flows.
+- Without real `app` or `context` modules, deterministic fallback resolvers satisfy the bookmark config schema.
+
+```ts
+import { enableBookmarkMock } from '@equinor/fusion-framework-module-bookmark/mock';
+
+enableBookmarkMock(configurator, (builder) => {
+  builder.setBookmarks([
+    {
+      id: 'bookmark-1',
+      name: 'My Bookmark',
+      appKey: 'my-app',
+      payload: {},
+      created: new Date(),
+      createdBy: { id: 'mock-user', name: 'Mock User' },
+    },
+  ]);
+  builder.setCurrentBookmark('bookmark-1');
+  builder.setFavorite('bookmark-1', true);
+});
+```
+
+`setBookmarks` seeds the bookmarks `getAllBookmarks`/`getBookmarkById`/`getBookmarkData` resolve. `setCurrentBookmark` declares which seeded bookmark `currentBookmark`/`currentBookmark$` report as active on initialization. `setFavorite` seeds `isBookmarkInFavorites`. Create, update, delete, and favourite calls all reach the in-memory client through the real flows — nothing is stubbed out.
+
+The whole real builder API stays available, including `setClient`, so an explicit call to it still replaces the mock client outright:
+
+```ts
+enableBookmarkMock(configurator, (builder) => {
+  builder.setClient(myOwnBookmarkClient);
+});
+```
+
+If no real `app` or `context` module is registered alongside the mock, `resolve.application`/`resolve.context` fall back to trivial resolvers automatically, since the module's config schema requires both. Registering a real `app`/`context` module still wins.
+
 ## Error Handling
 
 The module exposes two error classes:

package/dist/esm/__tests__/mock/bookmark-mock.test.js

@@ -0,0 +1,151 @@
+import { firstValueFrom, from } from 'rxjs';
+import { describe, expect, it } from 'vitest';
+import { ModulesConfigurator } from '@equinor/fusion-framework-module';
+import { BookmarkModuleConfigurator } from '../../BookmarkModuleConfigurator';
+import { BookmarkProvider } from '../../BookmarkProvider';
+import { module as realModule } from '../../bookmark-module';
+import { BookmarkMockClient, BookmarkMockConfigurator, bookmarkMockModule, enableBookmarkMock, } from '../../mock';
+/** A fully-formed seeded bookmark, so tests only override what they care about. */
+const createBookmark = (overrides = {}) => ({
+    id: 'bookmark-1',
+    name: 'My Bookmark',
+    appKey: 'test-app',
+    created: new Date('2024-01-01T00:00:00.000Z'),
+    createdBy: { id: 'seed-user', name: 'Seed User' },
+    ...overrides,
+});
+/**
+ * Initializes the mock module through the real module system.
+ *
+ * @remarks
+ * Deliberately avoids hand-building initialization arguments — faking the
+ * module system is the very cost this mock removes.
+ *
+ * @param configure - Optional callback to seed bookmarks, current bookmark, or favorites.
+ * @returns The `IBookmarkProvider` the module produced.
+ */
+const initializeMockWith = async (configure) => {
+    const configurator = new ModulesConfigurator([]);
+    enableBookmarkMock(configurator, configure);
+    const instances = await configurator.initialize();
+    return instances.bookmark;
+};
+/**
+ * Resolves the first value of an `IBookmarkProvider` call.
+ *
+ * @remarks
+ * `IBookmarkProvider`'s methods are typed as `ObservableInput`, not `Observable`,
+ * so this wraps with `from()` before handing off to `firstValueFrom`.
+ *
+ * @template T - The value the observable input emits.
+ * @param input - The observable input to resolve.
+ * @returns A promise resolving to the first emitted value.
+ */
+const firstValue = (input) => firstValueFrom(from(input));
+describe('bookmarkMockModule', () => {
+    it('changes nothing but the configurator', () => {
+        expect(bookmarkMockModule.name).toBe(realModule.name);
+        expect(bookmarkMockModule.version).toBe(realModule.version);
+        // The production initializer, untouched — the mock has no lifecycle of its own
+        expect(bookmarkMockModule.initialize).toBe(realModule.initialize);
+    });
+    it('builds a real BookmarkModuleConfigurator, so the whole builder stays available', () => {
+        const configurator = bookmarkMockModule.configure?.();
+        expect(configurator).toBeInstanceOf(BookmarkModuleConfigurator);
+        expect(configurator).toBeInstanceOf(BookmarkMockConfigurator);
+    });
+});
+describe('enableBookmarkMock', () => {
+    it('produces the real BookmarkProvider, not a stand-in', async () => {
+        const provider = await initializeMockWith();
+        expect(provider).toBeInstanceOf(BookmarkProvider);
+    });
+    it('replaces a bookmark module that is already registered', async () => {
+        // A FrameworkConfigurator pre-registers the real bookmark module, so the
+        // mock is only useful if registering it afterwards wins
+        const configurator = new ModulesConfigurator([realModule]);
+        enableBookmarkMock(configurator, (builder) => {
+            builder.setBookmarks([createBookmark()]);
+        });
+        const instances = await configurator.initialize();
+        const provider = instances.bookmark;
+        const bookmarks = await firstValue(provider.getAllBookmarks());
+        expect(bookmarks).toHaveLength(1);
+    });
+    it('reflects seeded bookmarks with no real HTTP', async () => {
+        const seeded = createBookmark();
+        const provider = await initializeMockWith((builder) => {
+            builder.setBookmarks([seeded]);
+        });
+        const bookmarks = await firstValue(provider.getAllBookmarks());
+        expect(bookmarks.map((b) => b.id)).toEqual([seeded.id]);
+    });
+    it('reflects the seeded current bookmark', async () => {
+        const seeded = createBookmark();
+        const provider = await initializeMockWith((builder) => {
+            builder.setBookmarks([seeded]);
+            builder.setCurrentBookmark(seeded.id);
+        });
+        expect(provider.currentBookmark?.id).toBe(seeded.id);
+    });
+    it('leaves the current bookmark unset when none is seeded', async () => {
+        const provider = await initializeMockWith((builder) => {
+            builder.setBookmarks([createBookmark()]);
+        });
+        expect(provider.currentBookmark).toBeNull();
+    });
+    it('reflects a seeded favorite', async () => {
+        const seeded = createBookmark();
+        const provider = await initializeMockWith((builder) => {
+            builder.setBookmarks([seeded]);
+            builder.setFavorite(seeded.id, true);
+        });
+        await expect(firstValue(provider.isBookmarkInFavorites(seeded.id))).resolves.toBe(true);
+    });
+    it('creates a bookmark through the real create flow', async () => {
+        const provider = await initializeMockWith();
+        // without a payload generator, generatePayload() never emits and the create
+        // flow would hang forever waiting on it
+        provider.addPayloadGenerator(() => { });
+        const created = await firstValue(provider.createBookmark({ name: 'New Bookmark', appKey: 'test-app' }));
+        expect(created.name).toBe('New Bookmark');
+        const bookmarks = await firstValue(provider.getAllBookmarks());
+        expect(bookmarks.map((b) => b.id)).toContain(created.id);
+    });
+    it('updates a bookmark through the real update flow', async () => {
+        const seeded = createBookmark();
+        const provider = await initializeMockWith((builder) => {
+            builder.setBookmarks([seeded]);
+        });
+        // the update reducer only applies to bookmarks already tracked in the store,
+        // so fetch once first to seed it
+        await firstValue(provider.getAllBookmarks());
+        const updated = await firstValue(provider.updateBookmark(seeded.id, { name: 'Renamed' }, { excludePayloadGeneration: true }));
+        expect(updated.name).toBe('Renamed');
+    });
+    it('surfaces a missing bookmark as an observable error through the real fetch flow', async () => {
+        const provider = await initializeMockWith();
+        await expect(firstValue(provider.getBookmark('missing-bookmark'))).rejects.toThrow();
+    });
+    it('deletes a bookmark through the real delete flow', async () => {
+        const seeded = createBookmark();
+        const provider = await initializeMockWith((builder) => {
+            builder.setBookmarks([seeded]);
+        });
+        await firstValue(provider.deleteBookmark(seeded.id));
+        const bookmarks = await firstValue(provider.getAllBookmarks());
+        expect(bookmarks.map((b) => b.id)).not.toContain(seeded.id);
+    });
+    it('lets setClient() replace the mock client outright', async () => {
+        const ownClient = new BookmarkMockClient();
+        ownClient.setBookmarks([createBookmark({ id: 'own-bookmark' })]);
+        const provider = await initializeMockWith((builder) => {
+            // the escape hatch is inherited unchanged from BookmarkModuleConfigurator
+            builder.setBookmarks([createBookmark({ id: 'ignored-bookmark' })]);
+            builder.setClient(ownClient);
+        });
+        const bookmarks = await firstValue(provider.getAllBookmarks());
+        expect(bookmarks.map((b) => b.id)).toEqual(['own-bookmark']);
+    });
+});
+//# sourceMappingURL=bookmark-mock.test.js.map

package/dist/esm/__tests__/mock/bookmark-mock.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bookmark-mock.test.js","sourceRoot":"","sources":["../../../../src/__tests__/mock/bookmark-mock.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,IAAI,EAAwB,MAAM,MAAM,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE9C,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAEvE,OAAO,EAAE,0BAA0B,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,OAAO,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAG7D,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EACxB,kBAAkB,EAClB,kBAAkB,GACnB,MAAM,YAAY,CAAC;AAEpB,mFAAmF;AACnF,MAAM,cAAc,GAAG,CAAC,SAAS,GAAsB,EAAE,EAAY,EAAE,CAAC,CAAC;IACvE,EAAE,EAAE,YAAY;IAChB,IAAI,EAAE,aAAa;IACnB,MAAM,EAAE,UAAU;IAClB,OAAO,EAAE,IAAI,IAAI,CAAC,0BAA0B,CAAC;IAC7C,SAAS,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,EAAE;IACjD,GAAG,SAAS;CACb,CAAC,CAAC;AAEH;;;;;;;;;GASG;AACH,MAAM,kBAAkB,GAAG,KAAK,EAC9B,SAAuD,EAC3B,EAAE;IAC9B,MAAM,YAAY,GAAG,IAAI,mBAAmB,CAAC,EAAE,CAAC,CAAC;IACjD,kBAAkB,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;IAC5C,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,UAAU,EAAE,CAAC;IAClD,OAAQ,SAAwD,CAAC,QAAQ,CAAC;AAC5E,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,UAAU,GAAG,CAAI,KAAyB,EAAc,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;AAE7F,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACtD,MAAM,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5D,+EAA+E;QAC/E,MAAM,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gFAAgF,EAAE,GAAG,EAAE;QACxF,MAAM,YAAY,GAAG,kBAAkB,CAAC,SAAS,EAAE,EAAE,CAAC;QAEtD,MAAM,CAAC,YAAY,CAAC,CAAC,cAAc,CAAC,0BAA0B,CAAC,CAAC;QAChE,MAAM,CAAC,YAAY,CAAC,CAAC,cAAc,CAAC,wBAAwB,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;QAClE,MAAM,QAAQ,GAAG,MAAM,kBAAkB,EAAE,CAAC;QAE5C,MAAM,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACrE,yEAAyE;QACzE,wDAAwD;QACxD,MAAM,YAAY,GAAG,IAAI,mBAAmB,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;QAC3D,kBAAkB,CAAC,YAAY,EAAE,CAAC,OAAO,EAAE,EAAE;YAC3C,OAAO,CAAC,YAAY,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,UAAU,EAAE,CAAC;QAClD,MAAM,QAAQ,GAAI,SAAwD,CAAC,QAAQ,CAAC;QAEpF,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC,CAAC;QAC/D,MAAM,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC3D,MAAM,MAAM,GAAG,cAAc,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,MAAM,kBAAkB,CAAC,CAAC,OAAO,EAAE,EAAE;YACpD,OAAO,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC,CAAC;QAC/D,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;QACpD,MAAM,MAAM,GAAG,cAAc,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,MAAM,kBAAkB,CAAC,CAAC,OAAO,EAAE,EAAE;YACpD,OAAO,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;YAC/B,OAAO,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,QAAQ,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACrE,MAAM,QAAQ,GAAG,MAAM,kBAAkB,CAAC,CAAC,OAAO,EAAE,EAAE;YACpD,OAAO,CAAC,YAAY,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;QAC1C,MAAM,MAAM,GAAG,cAAc,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,MAAM,kBAAkB,CAAC,CAAC,OAAO,EAAE,EAAE;YACpD,OAAO,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;YAC/B,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,MAAM,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,QAAQ,GAAG,MAAM,kBAAkB,EAAE,CAAC;QAC5C,4EAA4E;QAC5E,wCAAwC;QACxC,QAAQ,CAAC,mBAAmB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAEvC,MAAM,OAAO,GAAG,MAAM,UAAU,CAC9B,QAAQ,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CACtE,CAAC;QAEF,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC1C,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC,CAAC;QAC/D,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,MAAM,GAAG,cAAc,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,MAAM,kBAAkB,CAAC,CAAC,OAAO,EAAE,EAAE;YACpD,OAAO,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QACH,6EAA6E;QAC7E,iCAAiC;QACjC,MAAM,UAAU,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC,CAAC;QAE7C,MAAM,OAAO,GAAG,MAAM,UAAU,CAC9B,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC,CAC5F,CAAC;QAEF,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gFAAgF,EAAE,KAAK,IAAI,EAAE;QAC9F,MAAM,QAAQ,GAAG,MAAM,kBAAkB,EAAE,CAAC;QAE5C,MAAM,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IACvF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,MAAM,GAAG,cAAc,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,MAAM,kBAAkB,CAAC,CAAC,OAAO,EAAE,EAAE;YACpD,OAAO,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,MAAM,UAAU,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QAErD,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC,CAAC;QAC/D,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACjE,MAAM,SAAS,GAAG,IAAI,kBAAkB,EAAE,CAAC;QAC3C,SAAS,CAAC,YAAY,CAAC,CAAC,cAAc,CAAC,EAAE,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC;QAEjE,MAAM,QAAQ,GAAG,MAAM,kBAAkB,CAAC,CAAC,OAAO,EAAE,EAAE;YACpD,0EAA0E;YAC1E,OAAO,CAAC,YAAY,CAAC,CAAC,cAAc,CAAC,EAAE,EAAE,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,CAAC;YACnE,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC,CAAC;QAC/D,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/esm/mock/BookmarkMockClient.js

@@ -0,0 +1,281 @@
+import { of, throwError } from 'rxjs';
+import { v4 as generateGUID } from 'uuid';
+/** Attributed to every bookmark the mock client creates or updates. */
+const mockUser = { id: 'mock-user', name: 'Mock User' };
+/**
+ * Strips the `payload` field from a bookmark, mirroring what the real
+ * `BookmarkClient` does before returning a {@link BookmarkWithoutData}.
+ *
+ * @param bookmark - The bookmark to strip.
+ * @returns The bookmark without its payload.
+ */
+const stripPayload = (bookmark) => {
+    const { payload: _payload, ...rest } = bookmark;
+    return rest;
+};
+/**
+ * Checks whether a seeded bookmark matches the given {@link BookmarksFilter}.
+ *
+ * @remarks
+ * `appKey`, `contextId`, and `sourceSystem` are checked, mirroring what the real
+ * `BookmarkProvider` resolves and passes through as a filter (`BookmarkProvider.getAllBookmarks`
+ * always includes `sourceSystem`, so it must be matched even though it's rarely set explicitly).
+ *
+ * @param bookmark - The seeded bookmark to test.
+ * @param filter - The filter to match against, if any.
+ * @returns `true` when the bookmark satisfies every constraint in `filter`.
+ */
+const matchesFilter = (bookmark, filter) => {
+    // no filter means every seeded bookmark matches
+    if (!filter)
+        return true;
+    // an appKey constraint excludes bookmarks attributed to a different app
+    if (filter.appKey && bookmark.appKey !== filter.appKey)
+        return false;
+    // a contextId constraint excludes bookmarks attributed to a different context
+    if (filter.contextId && bookmark.context?.id !== filter.contextId)
+        return false;
+    // a sourceSystem constraint excludes bookmarks attributed to a different source system
+    if (filter.sourceSystem) {
+        const { identifier, name, subSystem } = filter.sourceSystem;
+        // an identifier constraint excludes bookmarks attributed to a different source system identifier
+        if (identifier && bookmark.sourceSystem?.identifier !== identifier)
+            return false;
+        // a name constraint excludes bookmarks attributed to a different source system name
+        if (name !== undefined && bookmark.sourceSystem?.name !== name)
+            return false;
+        // a subSystem constraint excludes bookmarks attributed to a different source sub-system
+        if (subSystem !== undefined && bookmark.sourceSystem?.subSystem !== subSystem)
+            return false;
+    }
+    return true;
+};
+/**
+ * Runs `fn` synchronously and reports the outcome as an {@link ObservableInput},
+ * so a mock method can `throw` for a "not found" case exactly like the async
+ * real client would reject.
+ *
+ * @template T - The value `fn` produces.
+ * @param fn - The synchronous operation to run.
+ * @returns An observable emitting `fn`'s result, or erroring with what it threw.
+ */
+const resultOf = (fn) => {
+    try {
+        return of(fn());
+    }
+    catch (error) {
+        return throwError(() => error);
+    }
+};
+/**
+ * In-memory {@link IBookmarkClient} backed by a `Map` of seeded bookmarks and a
+ * `Set` of favorite ids.
+ *
+ * @remarks
+ * Used by {@link BookmarkMockConfigurator} to swap out the real API client
+ * while leaving `BookmarkProvider` and the `bookmark-flows/` epics running
+ * unmodified — every create, update, delete, and favorite call still goes
+ * through the real flow logic, only the underlying data source is in-memory.
+ */
+export class BookmarkMockClient {
+    #bookmarks = new Map();
+    #favorites = new Set();
+    /**
+     * Replaces the seeded bookmarks with the given collection, keyed by `id`.
+     *
+     * @param items - The bookmarks to seed. Replaces any previously seeded bookmarks.
+     */
+    setBookmarks(items) {
+        this.#bookmarks = new Map(Array.from(items, (item) => [item.id, item]));
+    }
+    /**
+     * Marks a seeded bookmark as a favorite, or clears it.
+     *
+     * @param bookmarkId - The id of the bookmark to update.
+     * @param isFavorite - `true` to favorite the bookmark, `false` to clear it.
+     */
+    setFavorite(bookmarkId, isFavorite) {
+        // track favorites as a set membership rather than a boolean field on the bookmark
+        if (isFavorite) {
+            this.#favorites.add(bookmarkId);
+        }
+        else {
+            this.#favorites.delete(bookmarkId);
+        }
+    }
+    /**
+     * Looks up a seeded bookmark by id without going through the `ObservableInput` API.
+     *
+     * @param bookmarkId - The id of the bookmark to look up.
+     * @returns The seeded bookmark, or `undefined` when no bookmark was seeded for that id.
+     */
+    getBookmark(bookmarkId) {
+        return this.#bookmarks.get(bookmarkId);
+    }
+    /**
+     * Looks up a seeded bookmark by id, throwing when none was seeded.
+     *
+     * @param bookmarkId - The id of the bookmark to look up.
+     * @returns The seeded bookmark.
+     * @throws {Error} When no bookmark was seeded for `bookmarkId`.
+     */
+    #requireBookmark(bookmarkId) {
+        const bookmark = this.#bookmarks.get(bookmarkId);
+        // fail loudly so a missing seed reads as a test setup bug, not a silent no-op
+        if (!bookmark) {
+            throw new Error(`BookmarkMockClient: no bookmark seeded for id '${bookmarkId}'`);
+        }
+        return bookmark;
+    }
+    /**
+     * Returns every seeded bookmark that matches `filter`, without its payload.
+     *
+     * @remarks
+     * The real client strips payloads from list results (see `BookmarkClient.getAllBookmarks`),
+     * so the mock does the same here even though the interface's declared return type is `Bookmark[]`.
+     *
+     * @param filter - Optional constraints to narrow the returned bookmarks.
+     * @returns The matching bookmarks, without their payloads.
+     */
+    getAllBookmarks(filter) {
+        return resultOf(() => Array.from(this.#bookmarks.values())
+            // only bookmarks matching every constraint in `filter` are returned
+            .filter((bookmark) => matchesFilter(bookmark, filter))
+            // list results never include payloads, mirroring the real client
+            .map(stripPayload));
+    }
+    /**
+     * Returns a seeded bookmark by id, without its payload.
+     *
+     * @param bookmarkId - The id of the bookmark to look up.
+     * @returns The bookmark without its payload.
+     * @throws {Error} When no bookmark was seeded for `bookmarkId`.
+     */
+    getBookmarkById(bookmarkId) {
+        return resultOf(() => stripPayload(this.#requireBookmark(bookmarkId)));
+    }
+    /**
+     * Returns the payload data of a seeded bookmark.
+     *
+     * @template T - The shape of the bookmark's payload.
+     * @param bookmarkId - The id of the bookmark to look up.
+     * @returns The bookmark's payload.
+     * @throws {Error} When no bookmark was seeded for `bookmarkId`.
+     */
+    getBookmarkData(bookmarkId) {
+        return resultOf(() => this.#requireBookmark(bookmarkId).payload);
+    }
+    /**
+     * Replaces the payload data of a seeded bookmark.
+     *
+     * @template T - The shape of the bookmark's payload.
+     * @param bookmarkId - The id of the bookmark to update.
+     * @param data - The new payload data.
+     * @returns The payload that was set.
+     * @throws {Error} When no bookmark was seeded for `bookmarkId`.
+     */
+    setBookmarkData(bookmarkId, data) {
+        return resultOf(() => {
+            const existing = this.#requireBookmark(bookmarkId);
+            this.#bookmarks.set(bookmarkId, { ...existing, payload: data ?? undefined });
+            return data;
+        });
+    }
+    /**
+     * Marks a seeded bookmark as a favorite.
+     *
+     * @param bookmarkId - The id of the bookmark to favorite.
+     * @returns `true` once the bookmark is marked as a favorite.
+     * @throws {Error} When no bookmark was seeded for `bookmarkId`.
+     */
+    addBookmarkToFavorites(bookmarkId) {
+        return resultOf(() => {
+            this.#requireBookmark(bookmarkId);
+            this.#favorites.add(bookmarkId);
+            return true;
+        });
+    }
+    /**
+     * Clears a seeded bookmark's favorite status.
+     *
+     * @param bookmarkId - The id of the bookmark to unfavorite.
+     * @returns `true` once the bookmark is no longer a favorite.
+     */
+    removeBookmarkFromFavorites(bookmarkId) {
+        return resultOf(() => {
+            this.#favorites.delete(bookmarkId);
+            return true;
+        });
+    }
+    /**
+     * Checks whether a seeded bookmark is currently a favorite.
+     *
+     * @param bookmarkId - The id of the bookmark to check.
+     * @returns `true` when the bookmark is a favorite.
+     */
+    isBookmarkFavorite(bookmarkId) {
+        return of(this.#favorites.has(bookmarkId));
+    }
+    /**
+     * Seeds a new bookmark from create input, generating its id and audit fields.
+     *
+     * @template T - The shape of the bookmark's payload.
+     * @param bookmark - The data to create the bookmark from.
+     * @returns The created bookmark.
+     */
+    createBookmark(bookmark) {
+        return resultOf(() => {
+            // `contextId` is a plain id on the client input, but a `{ id }` object on the bookmark itself
+            const { contextId, ...rest } = bookmark;
+            // merge the create input with generated audit fields and a normalized context
+            const created = {
+                ...rest,
+                id: generateGUID(),
+                created: new Date(),
+                createdBy: mockUser,
+                ...(contextId ? { context: { id: contextId } } : {}),
+            };
+            this.#bookmarks.set(created.id, created);
+            return created;
+        });
+    }
+    /**
+     * Applies updates to a seeded bookmark, stamping new audit fields.
+     *
+     * @template T - The shape of the bookmark's payload.
+     * @param bookmarkId - The id of the bookmark to update.
+     * @param updates - The fields to update.
+     * @returns The updated bookmark.
+     * @throws {Error} When no bookmark was seeded for `bookmarkId`.
+     */
+    updateBookmark(bookmarkId, updates) {
+        return resultOf(() => {
+            const existing = this.#requireBookmark(bookmarkId);
+            // merge the updates onto the existing bookmark, then stamp new audit fields
+            const updated = {
+                ...existing,
+                ...updates,
+                // `payload: null` clears data on a BookmarkUpdate, so normalize it to `undefined` like setBookmarkData does
+                payload: updates.payload === null ? undefined : (updates.payload ?? existing.payload),
+                updated: new Date(),
+                updatedBy: mockUser,
+            };
+            this.#bookmarks.set(bookmarkId, updated);
+            return updated;
+        });
+    }
+    /**
+     * Removes a seeded bookmark and clears its favorite status.
+     *
+     * @param bookmarkId - The id of the bookmark to delete.
+     * @returns `true` when a bookmark was seeded for `bookmarkId` and was removed.
+     */
+    deleteBookmark(bookmarkId) {
+        return resultOf(() => {
+            const existed = this.#bookmarks.delete(bookmarkId);
+            this.#favorites.delete(bookmarkId);
+            return existed;
+        });
+    }
+}
+//# sourceMappingURL=BookmarkMockClient.js.map

package/dist/esm/mock/BookmarkMockClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BookmarkMockClient.js","sourceRoot":"","sources":["../../../src/mock/BookmarkMockClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,UAAU,EAAwB,MAAM,MAAM,CAAC;AAC5D,OAAO,EAAE,EAAE,IAAI,YAAY,EAAE,MAAM,MAAM,CAAC;AAU1C,uEAAuE;AACvE,MAAM,QAAQ,GAAiB,EAAE,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;AAEtE;;;;;;GAMG;AACH,MAAM,YAAY,GAAG,CAAC,QAAkB,EAAuB,EAAE;IAC/D,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,QAAQ,CAAC;IAChD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,aAAa,GAAG,CAAC,QAAkB,EAAE,MAAwB,EAAW,EAAE;IAC9E,gDAAgD;IAChD,IAAI,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC;IACzB,wEAAwE;IACxE,IAAI,MAAM,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IACrE,8EAA8E;IAC9E,IAAI,MAAM,CAAC,SAAS,IAAI,QAAQ,CAAC,OAAO,EAAE,EAAE,KAAK,MAAM,CAAC,SAAS;QAAE,OAAO,KAAK,CAAC;IAChF,uFAAuF;IACvF,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;QACxB,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC,YAAY,CAAC;QAC5D,iGAAiG;QACjG,IAAI,UAAU,IAAI,QAAQ,CAAC,YAAY,EAAE,UAAU,KAAK,UAAU;YAAE,OAAO,KAAK,CAAC;QACjF,oFAAoF;QACpF,IAAI,IAAI,KAAK,SAAS,IAAI,QAAQ,CAAC,YAAY,EAAE,IAAI,KAAK,IAAI;YAAE,OAAO,KAAK,CAAC;QAC7E,wFAAwF;QACxF,IAAI,SAAS,KAAK,SAAS,IAAI,QAAQ,CAAC,YAAY,EAAE,SAAS,KAAK,SAAS;YAAE,OAAO,KAAK,CAAC;IAC9F,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,QAAQ,GAAG,CAAI,EAAW,EAAsB,EAAE;IACtD,IAAI,CAAC;QACH,OAAO,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAClB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,UAAU,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;AACH,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,OAAO,kBAAkB;IAC7B,UAAU,GAAG,IAAI,GAAG,EAAoB,CAAC;IACzC,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;IAE/B;;;;OAIG;IACI,YAAY,CAAC,KAAyB;QAC3C,IAAI,CAAC,UAAU,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,UAAkB,EAAE,UAAmB;QACxD,kFAAkF;QAClF,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAClC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,UAAkB;QACnC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CAAC,UAAkB;QACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACjD,8EAA8E;QAC9E,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,kDAAkD,UAAU,GAAG,CAAC,CAAC;QACnF,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;OASG;IACI,eAAe,CAAC,MAAwB;QAC7C,OAAO,QAAQ,CACb,GAAG,EAAE,CACH,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YAClC,oEAAoE;aACnE,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YACtD,iEAAiE;aAChE,GAAG,CAAC,YAAY,CAAoB,CAC1C,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,eAAe,CAAC,UAAkB;QACvC,OAAO,QAAQ,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;OAOG;IACI,eAAe,CAAyB,UAAkB;QAC/D,OAAO,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,OAAY,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;OAQG;IACI,eAAe,CACpB,UAAkB,EAClB,IAAO;QAEP,OAAO,QAAQ,CAAC,GAAG,EAAE;YACnB,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACnD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,GAAG,QAAQ,EAAE,OAAO,EAAE,IAAI,IAAI,SAAS,EAAE,CAAC,CAAC;YAC7E,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,sBAAsB,CAAC,UAAkB;QAC9C,OAAO,QAAQ,CAAC,GAAG,EAAE;YACnB,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;YAClC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAChC,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,2BAA2B,CAAC,UAAkB;QACnD,OAAO,QAAQ,CAAC,GAAG,EAAE;YACnB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACnC,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,UAAkB;QAC1C,OAAO,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CACnB,QAAwB;QAExB,OAAO,QAAQ,CAAC,GAAG,EAAE;YACnB,8FAA8F;YAC9F,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,QAAQ,CAAC;YACxC,8EAA8E;YAC9E,MAAM,OAAO,GAAgB;gBAC3B,GAAG,IAAI;gBACP,EAAE,EAAE,YAAY,EAAE;gBAClB,OAAO,EAAE,IAAI,IAAI,EAAE;gBACnB,SAAS,EAAE,QAAQ;gBACnB,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACrD,CAAC;YACF,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;YACzC,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACI,cAAc,CACnB,UAAkB,EAClB,OAA0B;QAE1B,OAAO,QAAQ,CAAC,GAAG,EAAE;YACnB,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACnD,4EAA4E;YAC5E,MAAM,OAAO,GAAgB;gBAC3B,GAAG,QAAQ;gBACX,GAAG,OAAO;gBACV,4GAA4G;gBAC5G,OAAO,EAAE,OAAO,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC;gBACrF,OAAO,EAAE,IAAI,IAAI,EAAE;gBACnB,SAAS,EAAE,QAAQ;aACL,CAAC;YACjB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YACzC,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,UAAkB;QACtC,OAAO,QAAQ,CAAC,GAAG,EAAE;YACnB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACnD,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACnC,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}