@equinor/fusion-framework-module-bookmark 4.0.3 → 4.1.0-next.0

package/dist/esm/mock/BookmarkMockConfigurator.js

@@ -0,0 +1,138 @@
+import { of } from 'rxjs';
+import { BookmarkModuleConfigurator } from '../BookmarkModuleConfigurator';
+import { BookmarkMockClient } from './BookmarkMockClient';
+/**
+ * Fallback application resolver used when the mock is configured standalone,
+ * without a real `app` module registered.
+ */
+const mockApplicationResolver = async () => ({
+    appKey: 'mock-app',
+});
+/**
+ * Fallback context resolver used when the mock is configured standalone,
+ * without a real `context` module registered.
+ */
+const mockContextResolver = async () => undefined;
+/**
+ * The real bookmark configurator, backed by an in-memory {@link BookmarkMockClient}.
+ *
+ * @remarks
+ * Extends {@link BookmarkModuleConfigurator} directly, so the whole builder API
+ * (source system, filters, resolvers, `setParent`) stays available. Only a
+ * default client is added — through the same
+ * {@link BookmarkModuleConfigurator.setClient | setClient} seam a caller would
+ * use to plug in their own client — so an explicit `setClient()` call still
+ * replaces it outright, exactly as it would on the real configurator.
+ *
+ * Seeded bookmarks and favorites flow through the real `BookmarkProvider` and
+ * `bookmark-flows/` epics unmodified: create, update, delete, and favorite
+ * calls all reach {@link BookmarkMockClient}, not a stand-in.
+ *
+ * @example Seed bookmarks and a current bookmark
+ * ```typescript
+ * enableBookmarkMock(configurator, (builder) => {
+ *   builder.setBookmarks([myBookmark]);
+ *   builder.setCurrentBookmark(myBookmark.id);
+ *   builder.setFavorite(myBookmark.id, true);
+ * });
+ * ```
+ *
+ * @example Take full control of the client
+ * ```typescript
+ * enableBookmarkMock(configurator, (builder) => {
+ *   builder.setClient(myOwnBookmarkClient);
+ * });
+ * ```
+ */
+export class BookmarkMockConfigurator extends BookmarkModuleConfigurator {
+    #client = new BookmarkMockClient();
+    #currentId;
+    /**
+     * Seeds the bookmarks the mock client resolves through `getAllBookmarks`,
+     * `getBookmarkById`, and `getBookmarkData`.
+     *
+     * @param items - The bookmarks to seed. Replaces any previously seeded bookmarks.
+     * @returns `this`, for chaining.
+     */
+    setBookmarks(items) {
+        this.#client.setBookmarks(items);
+        return this;
+    }
+    /**
+     * Declares which seeded bookmark `IBookmarkProvider.currentBookmark` reports
+     * as active once the module initializes.
+     *
+     * @remarks
+     * `BookmarkProvider` only reads its initial current bookmark from a parent
+     * provider (see {@link BookmarkModuleConfigurator.setParent}), so this
+     * registers a synthetic parent exposing the seeded bookmark — the same seam
+     * a real nested-portal provider would use, just standing in for one.
+     *
+     * @param bookmarkId - The id of a bookmark previously passed to {@link setBookmarks},
+     *   or `undefined` to leave the current bookmark unset.
+     * @returns `this`, for chaining.
+     */
+    setCurrentBookmark(bookmarkId) {
+        this.#currentId = bookmarkId;
+        return this;
+    }
+    /**
+     * Marks a seeded bookmark as a favorite, or clears it, reflected through
+     * `IBookmarkClient.isBookmarkFavorite`.
+     *
+     * @param bookmarkId - The id of the bookmark to update.
+     * @param isFavorite - `true` to favorite the bookmark, `false` to clear it. Defaults to `true`.
+     * @returns `this`, for chaining.
+     */
+    setFavorite(bookmarkId, isFavorite = true) {
+        this.#client.setFavorite(bookmarkId, isFavorite);
+        return this;
+    }
+    /**
+     * Installs the mock client and a synthetic current-bookmark parent before
+     * building the configuration, unless the caller already declared their own.
+     *
+     * @remarks
+     * Also falls back to trivial application/context resolvers when neither an
+     * `app` nor a `context` module is registered alongside this mock — both are
+     * required by {@link BookmarkModuleConfig}'s schema, but a standalone test
+     * has no reason to pull in either module just to satisfy it. Registering a
+     * real `app`/`context` module still wins, exactly as it does on the real
+     * configurator.
+     *
+     * @param init - The config builder callback arguments.
+     * @param initial - An optional initial config to merge into the returned config.
+     * @returns The observable configuration, produced by the real configurator.
+     */
+    _createConfig(init, initial) {
+        // only stand in a mock client when the caller hasn't set their own
+        if (!this._has('client')) {
+            this.setClient(this.#client);
+        }
+        // only stand in a synthetic parent when a current bookmark was seeded and
+        // the caller hasn't declared their own parent provider
+        if (this.#currentId && !this._has('parent')) {
+            const current = this.#client.getBookmark(this.#currentId) ?? null;
+            const parent = {
+                currentBookmark: current,
+                currentBookmark$: of(current),
+            };
+            this.setParent(parent);
+        }
+        // no app module means the real default resolver would resolve to `undefined`, which fails
+        // the required `resolve.application` schema field — but `initial.resolve.application` may
+        // already carry a resolver inherited from a parent config, which must not be overwritten
+        if (!this._has('resolve.application') &&
+            !initial?.resolve?.application &&
+            !init.hasModule('app')) {
+            this.setApplicationResolver(async () => mockApplicationResolver);
+        }
+        // no context module means the real default resolver would resolve to `undefined`, which
+        // fails the required `resolve.context` schema field — same inherited-config caveat as above
+        if (!this._has('resolve.context') && !initial?.resolve?.context && !init.hasModule('context')) {
+            this.setContextResolver(async () => mockContextResolver);
+        }
+        return super._createConfig(init, initial);
+    }
+}
+//# sourceMappingURL=BookmarkMockConfigurator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BookmarkMockConfigurator.js","sourceRoot":"","sources":["../../../src/mock/BookmarkMockConfigurator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,MAAM,CAAC;AAI1B,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAI3E,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D;;;GAGG;AACH,MAAM,uBAAuB,GAAmD,KAAK,IAAI,EAAE,CAAC,CAAC;IAC3F,MAAM,EAAE,UAAU;CACnB,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,mBAAmB,GAA+C,KAAK,IAAI,EAAE,CAAC,SAAS,CAAC;AAE9F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,OAAO,wBAAyB,SAAQ,0BAA0B;IACtE,OAAO,GAAG,IAAI,kBAAkB,EAAE,CAAC;IACnC,UAAU,CAAU;IAEpB;;;;;;OAMG;IACI,YAAY,CAAC,KAAyB;QAC3C,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,kBAAkB,CAAC,UAA8B;QACtD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACI,WAAW,CAAC,UAAkB,EAAE,UAAU,GAAG,IAAI;QACtD,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QACjD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACgB,aAAa,CAC9B,IAA+B,EAC/B,OAAuC;QAEvC,mEAAmE;QACnE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/B,CAAC;QAED,0EAA0E;QAC1E,uDAAuD;QACvD,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC;YAClE,MAAM,MAAM,GAAoE;gBAC9E,eAAe,EAAE,OAAO;gBACxB,gBAAgB,EAAE,EAAE,CAAC,OAAO,CAAC;aAC9B,CAAC;YACF,IAAI,CAAC,SAAS,CAAC,MAA2B,CAAC,CAAC;QAC9C,CAAC;QAED,0FAA0F;QAC1F,0FAA0F;QAC1F,yFAAyF;QACzF,IACE,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC;YACjC,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW;YAC9B,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EACtB,CAAC;YACD,IAAI,CAAC,sBAAsB,CAAC,KAAK,IAAI,EAAE,CAAC,uBAAuB,CAAC,CAAC;QACnE,CAAC;QAED,wFAAwF;QACxF,4FAA4F;QAC5F,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9F,IAAI,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAAE,CAAC,mBAAmB,CAAC,CAAC;QAC3D,CAAC;QAED,OAAO,KAAK,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;CACF"}

package/dist/esm/mock/index.js

@@ -0,0 +1,26 @@
+/**
+ * Mock bookmark module for tests: real provider, real configurator, in-memory client.
+ *
+ * @remarks
+ * Substituting `IBookmarkClient` is the smallest change that removes the
+ * Fusion Core Services backend from a test. Everything above it — the
+ * `BookmarkProvider` store, `bookmark-flows/` epics, payload generators, and
+ * events — is the production code path.
+ *
+ * @example
+ * ```typescript
+ * import { enableBookmarkMock } from '@equinor/fusion-framework-module-bookmark/mock';
+ *
+ * enableBookmarkMock(configurator, (builder) => {
+ *   builder.setBookmarks([myBookmark]);
+ *   builder.setCurrentBookmark(myBookmark.id);
+ *   builder.setFavorite(myBookmark.id, true);
+ * });
+ * ```
+ *
+ * @packageDocumentation
+ */
+export { BookmarkMockClient } from './BookmarkMockClient';
+export { BookmarkMockConfigurator } from './BookmarkMockConfigurator';
+export { enableBookmarkMock, bookmarkMockModule } from './module';
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/mock/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAA6B,MAAM,UAAU,CAAC"}

package/dist/esm/mock/module.js

@@ -0,0 +1,42 @@
+import { module } 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 = {
+    ...module,
+    configure: () => new BookmarkMockConfigurator(),
+};
+/**
+ * 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 = (configurator, configure) => {
+    configurator.addConfig({ module: bookmarkMockModule, configure });
+};
+//# sourceMappingURL=module.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"module.js","sourceRoot":"","sources":["../../../src/mock/module.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAuB,MAAM,oBAAoB,CAAC;AAEjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtE;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAmB;IAChD,GAAG,MAAM;IACT,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,wBAAwB,EAAE;CAChD,CAAC;AAYF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAIhC,YAAkD,EAClD,SAAsC,EAChC,EAAE;IACR,YAAY,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,kBAAkB,EAAE,SAAS,EAE7D,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/esm/version.js

@@ -1,3 +1,3 @@
 // Generated by genversion.
-export const version = '4.0.3';
+export const version = '4.1.0-next.0';
 //# sourceMappingURL=version.js.map

package/dist/esm/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,2BAA2B;AAC3B,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,2BAA2B;AAC3B,MAAM,CAAC,MAAM,OAAO,GAAG,cAAc,CAAC"}