@equinor/fusion-framework-module-services 7.2.1 → 8.0.0

package/dist/esm/module.js

@@ -1,8 +1,14 @@
 import { ApiConfigurator } from './configurator';
 import { ApiProvider } from './provider';
+/** Module registration key used to identify the services module. */
 export const moduleKey = 'services';
 /**
- * Method to trying to resolve method for creating an IHttpClient
+ * Creates the default {@link ApiClientFactory} by attempting named HTTP clients
+ * first, then falling back to service-discovery.
+ *
+ * @param http - The HTTP client provider from the `http` module.
+ * @param serviceDiscovery - Optional service-discovery provider for automatic client resolution.
+ * @returns A factory function that creates named HTTP clients.
  */
 const createDefaultClient = (http, serviceDiscovery) => async (name) => {
     if (http.hasClient(name)) {
@@ -14,7 +20,11 @@ const createDefaultClient = (http, serviceDiscovery) => async (name) => {
     throw Error(`failed to create http client for service ${name}`);
 };
 /**
- *  Configure http-client
+ * Services module definition.
+ *
+ * Registers the `'services'` module, wires up the {@link ApiConfigurator},
+ * and initializes the {@link ApiProvider} with an HTTP client factory
+ * resolved from the `http` and optional `serviceDiscovery` modules.
  */
 export const module = {
     name: moduleKey,
@@ -37,8 +47,18 @@ export const module = {
     },
 };
 /**
- * Method for enabling the Service module
- * @param config - configuration object
+ * Registers the services module with the framework configurator.
+ *
+ * Call this during app configuration to make the services module
+ * available at runtime.
+ *
+ * @param config - The framework modules configurator.
+ *
+ * @example
+ * ```ts
+ * import { enableServices } from '@equinor/fusion-framework-module-services';
+ * configurator.addConfig(enableServices);
+ * ```
  */
 export const enableServices = (
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -46,12 +66,24 @@ config) => {
     config.addConfig({ module });
 };
 /**
+ * Creates a module configuration object for the services module
+ * with a custom configuration callback.
+ *
+ * Use this when you need to customise the services module (for example,
+ * supplying a custom `createClient` factory).
+ *
+ * @param configure - Callback that receives the {@link IApiConfigurator} for customisation.
+ * @returns A module configurator object that can be passed to `addConfig`.
+ *
  * @example
  * ```ts
- * config.addConfig(x => x.createClient(...));
+ * import { configureServices } from '@equinor/fusion-framework-module-services';
+ * configurator.addConfig(
+ *   configureServices((cfg) => {
+ *     cfg.createClient = myCustomClientFactory;
+ *   }),
+ * );
  * ```
- * @param configure - Callback for configuring the module
- * @returns Configuration object
  */
 export const configureServices = (configure) => {
     return {

package/dist/esm/module.js.map

@@ -1 +1 @@
-{"version":3,"file":"module.js","sourceRoot":"","sources":["../../src/module.ts"],"names":[],"mappings":"AAWA,OAAO,EAAyB,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACxE,OAAO,EAAqB,WAAW,EAAE,MAAM,YAAY,CAAC;AAM5D,MAAM,CAAC,MAAM,SAAS,GAAsB,UAAU,CAAC;AASvD;;GAEG;AACH,MAAM,mBAAmB,GACvB,CAAC,IAAyB,EAAE,gBAA2C,EAAoB,EAAE,CAC7F,KAAK,EAAE,IAAY,EAAE,EAAE;IACrB,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IACD,IAAI,gBAAgB,EAAE,CAAC;QACrB,OAAO,gBAAgB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,KAAK,CAAC,4CAA4C,IAAI,EAAE,CAAC,CAAC;AAClE,CAAC,CAAC;AAEJ;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAmB;IACpC,IAAI,EAAE,SAAS;IACf,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,eAAe,EAAE;IACtC,UAAU,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,SAAS,EAAE,EAAE,EAAE;QAChE,sGAAsG;QACtG,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;YACzB,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,MAAM,CAAC,CAAC;YAC3C,MAAM,gBAAgB,GAAyC,SAAS,CAAC,kBAAkB,CAAC;gBAC1F,CAAC,CAAC,qDAAqD;oBACrD,MAAM,eAAe,CAAC,kBAAkB,CAAC;gBAC3C,CAAC,CAAC,oDAAoD;oBACpD,GAAG,EAAE,gBAAgB,CAAC;YAE1B,MAAM,CAAC,YAAY,GAAG,mBAAmB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;QACpE,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;YACzB,MAAM,KAAK,CAAC,+CAA+C,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,IAAI,WAAW,CAAC,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;IAChE,CAAC;CACF,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;AAC5B,8DAA8D;AAC9D,MAAsC,EAChC,EAAE;IACR,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,SAAmD,EACd,EAAE;IACvC,OAAO;QACL,MAAM;QACN,SAAS;KACV,CAAC;AACJ,CAAC,CAAC;AAQF,eAAe,MAAM,CAAC"}
+{"version":3,"file":"module.js","sourceRoot":"","sources":["../../src/module.ts"],"names":[],"mappings":"AAWA,OAAO,EAAyB,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACxE,OAAO,EAAqB,WAAW,EAAE,MAAM,YAAY,CAAC;AAO5D,oEAAoE;AACpE,MAAM,CAAC,MAAM,SAAS,GAAsB,UAAU,CAAC;AAgBvD;;;;;;;GAOG;AACH,MAAM,mBAAmB,GACvB,CAAC,IAAyB,EAAE,gBAA2C,EAAoB,EAAE,CAC7F,KAAK,EAAE,IAAY,EAAE,EAAE;IACrB,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IACD,IAAI,gBAAgB,EAAE,CAAC;QACrB,OAAO,gBAAgB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,KAAK,CAAC,4CAA4C,IAAI,EAAE,CAAC,CAAC;AAClE,CAAC,CAAC;AAEJ;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,MAAM,GAAmB;IACpC,IAAI,EAAE,SAAS;IACf,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,eAAe,EAAE;IACtC,UAAU,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,SAAS,EAAE,EAAE,EAAE;QAChE,sGAAsG;QACtG,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;YACzB,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,MAAM,CAAC,CAAC;YAC3C,MAAM,gBAAgB,GAAyC,SAAS,CAAC,kBAAkB,CAAC;gBAC1F,CAAC,CAAC,qDAAqD;oBACrD,MAAM,eAAe,CAAC,kBAAkB,CAAC;gBAC3C,CAAC,CAAC,oDAAoD;oBACpD,GAAG,EAAE,gBAAgB,CAAC;YAE1B,MAAM,CAAC,YAAY,GAAG,mBAAmB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;QACpE,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;YACzB,MAAM,KAAK,CAAC,+CAA+C,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,IAAI,WAAW,CAAC,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;IAChE,CAAC;CACF,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;AAC5B,8DAA8D;AAC9D,MAAsC,EAChC,EAAE;IACR,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,SAAmD,EACd,EAAE;IACvC,OAAO;QACL,MAAM;QACN,SAAS;KACV,CAAC;AACJ,CAAC,CAAC;AAQF,eAAe,MAAM,CAAC"}

package/dist/esm/notification/client.js

@@ -2,67 +2,109 @@ import { createNotification, deleteNotification, getNotificationById, getNotific
 import { ApiVersion } from './static';
 import updateUserNotificationSettings from './settings/put';
 import getUserNotificationSettings from './settings/get';
+/**
+ * Typed API client for the Fusion notification service.
+ *
+ * Provides methods for notification CRUD operations, marking notifications
+ * as seen, and managing user notification settings.
+ *
+ * @template TMethod - The client execution method (`'json'` or `'json$'`).
+ * @template TClient - The underlying HTTP client type.
+ */
 export class NotificationApiClient {
     _client;
     _method;
+    /** Returns the {@link ApiVersion} enum for version-constant access. */
     get Version() {
         return ApiVersion;
     }
+    /**
+     * @param _client - The HTTP client used to execute requests.
+     * @param _method - The execution method (`'json'` or `'json$'`).
+     */
     constructor(_client, _method) {
         this._client = _client;
         this._method = _method;
     }
     /**
-     * Fetch all notifications
-     * @see {@link getAll/client}
+     * Fetch all notifications for the current user.
+     *
+     * @template TVersion - The API version key.
+     * @template TResult - The expected response type.
+     * @param version - API version to use.
+     * @returns All notifications matching the query.
      */
     getAll(version, ...args) {
         const fn = getNotifications(this._client, version, this._method);
         return fn(...args);
     }
     /**
-     * Fetch notification by id
-     * @see {@link getById/client}
+     * Fetch a single notification by its identifier.
+     *
+     * @template TVersion - The API version key.
+     * @template TResult - The expected response type.
+     * @param version - API version to use.
+     * @returns The notification with the specified ID.
      */
     getById(version, ...args) {
         const fn = getNotificationById(this._client, version, this._method);
         return fn(...args);
     }
     /**
-     * Set notification seen by user
-     * @see {@link setSeenByUser/client}
+     * Mark a notification as seen by the current user.
+     *
+     * @template TVersion - The API version key.
+     * @template TResult - The expected response type.
+     * @param version - API version to use.
+     * @returns The updated notification.
      */
     setSeenByUser(version, ...args) {
         const fn = updateSeenByUser(this._client, version, this._method);
         return fn(...args);
     }
     /**
-     * Create a notification
-     * @see {@link create/client}
+     * Create a new notification.
+     *
+     * @template TVersion - The API version key.
+     * @template TResult - The expected response type.
+     * @param version - API version to use.
+     * @returns The created notification.
      */
     create(version, ...args) {
         const fn = createNotification(this._client, version, this._method);
         return fn(...args);
     }
     /**
-     * Delete a notification
-     * @see {@link delete/client}
+     * Delete a notification by its identifier.
+     *
+     * @template TVersion - The API version key.
+     * @template TResult - The expected response type.
+     * @param version - API version to use.
+     * @returns The deletion result.
      */
     delete(version, ...args) {
         const fn = deleteNotification(this._client, version, this._method);
         return fn(...args);
     }
     /**
-     * Get users notification settings
-     * @see {@link getSettings/client}
+     * Retrieve the current user's notification settings.
+     *
+     * @template TVersion - The API version key.
+     * @template TResult - The expected response type.
+     * @param version - API version to use.
+     * @returns The user's notification settings.
      */
     getSettings(version, ...args) {
         const fn = getUserNotificationSettings(this._client, version, this._method);
         return fn(...args);
     }
     /**
-     * Update user notification settings
-     * @see {@link updateSettings/client}
+     * Update the current user's notification settings.
+     *
+     * @template TVersion - The API version key.
+     * @template TResult - The expected response type.
+     * @param version - API version to use.
+     * @returns The updated notification settings.
      */
     updateSettings(version, ...args) {
         const fn = updateUserNotificationSettings(this._client, version, this._method);

package/dist/esm/notification/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/notification/client.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAKtC,OAAO,8BAGN,MAAM,gBAAgB,CAAC;AACxB,OAAO,2BAGN,MAAM,gBAAgB,CAAC;AAExB,MAAM,OAAO,qBAAqB;IASpB;IACA;IANZ,IAAI,OAAO;QACT,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,YACY,OAAgB,EAChB,OAAgB;QADhB,YAAO,GAAP,OAAO,CAAS;QAChB,YAAO,GAAP,OAAO,CAAS;IACzB,CAAC;IAEJ;;;OAGG;IACI,MAAM,CAIX,OAAiB,EACjB,GAAG,IAAyE;QAE5E,MAAM,EAAE,GAAG,gBAAgB,CAA6B,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7F,OAAO,EAAE,CAAU,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,OAAO,CAIZ,OAAiB,EACjB,GAAG,IAAwE;QAE3E,MAAM,EAAE,GAAG,mBAAmB,CAA6B,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAChG,OAAO,EAAE,CAAU,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,aAAa,CAIlB,OAAiB,EACjB,GAAG,IAA0E;QAE7E,MAAM,EAAE,GAAG,gBAAgB,CAA6B,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7F,OAAO,EAAE,CAAU,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,MAAM,CAIX,OAAiB,EACjB,GAAG,IAAyE;QAE5E,MAAM,EAAE,GAAG,kBAAkB,CAA6B,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/F,OAAO,EAAE,CAAU,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACI,MAAM,CAIX,OAAiB,EACjB,GAAG,IAA2E;QAE9E,MAAM,EAAE,GAAG,kBAAkB,CAA6B,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/F,OAAO,EAAE,CAAU,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;IACD;;;OAGG;IACI,WAAW,CAIhB,OAAiB,EACjB,GAAG,IAAoF;QAEvF,MAAM,EAAE,GAAG,2BAA2B,CACpC,IAAI,CAAC,OAAO,EACZ,OAAO,EACP,IAAI,CAAC,OAAO,CACb,CAAC;QACF,OAAO,EAAE,CAAU,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;IACD;;;OAGG;IACI,cAAc,CAInB,OAAiB,EACjB,GAAG,IAAoF;QAEvF,MAAM,EAAE,GAAG,8BAA8B,CACvC,IAAI,CAAC,OAAO,EACZ,OAAO,EACP,IAAI,CAAC,OAAO,CACb,CAAC;QACF,OAAO,EAAE,CAAU,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;CACF;AAED,eAAe,qBAAqB,CAAC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/notification/client.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAKtC,OAAO,8BAGN,MAAM,gBAAgB,CAAC;AACxB,OAAO,2BAGN,MAAM,gBAAgB,CAAC;AAExB;;;;;;;;GAQG;AACH,MAAM,OAAO,qBAAqB;IAcpB;IACA;IAXZ,uEAAuE;IACvE,IAAI,OAAO;QACT,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;OAGG;IACH,YACY,OAAgB,EAChB,OAAgB;QADhB,YAAO,GAAP,OAAO,CAAS;QAChB,YAAO,GAAP,OAAO,CAAS;IACzB,CAAC;IAEJ;;;;;;;OAOG;IACI,MAAM,CAIX,OAAiB,EACjB,GAAG,IAAyE;QAE5E,MAAM,EAAE,GAAG,gBAAgB,CAA6B,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7F,OAAO,EAAE,CAAU,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;OAOG;IACI,OAAO,CAIZ,OAAiB,EACjB,GAAG,IAAwE;QAE3E,MAAM,EAAE,GAAG,mBAAmB,CAA6B,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAChG,OAAO,EAAE,CAAU,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;OAOG;IACI,aAAa,CAIlB,OAAiB,EACjB,GAAG,IAA0E;QAE7E,MAAM,EAAE,GAAG,gBAAgB,CAA6B,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7F,OAAO,EAAE,CAAU,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAIX,OAAiB,EACjB,GAAG,IAAyE;QAE5E,MAAM,EAAE,GAAG,kBAAkB,CAA6B,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/F,OAAO,EAAE,CAAU,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAIX,OAAiB,EACjB,GAAG,IAA2E;QAE9E,MAAM,EAAE,GAAG,kBAAkB,CAA6B,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/F,OAAO,EAAE,CAAU,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;IACD;;;;;;;OAOG;IACI,WAAW,CAIhB,OAAiB,EACjB,GAAG,IAAoF;QAEvF,MAAM,EAAE,GAAG,2BAA2B,CACpC,IAAI,CAAC,OAAO,EACZ,OAAO,EACP,IAAI,CAAC,OAAO,CACb,CAAC;QACF,OAAO,EAAE,CAAU,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;IACD;;;;;;;OAOG;IACI,cAAc,CAInB,OAAiB,EACjB,GAAG,IAAoF;QAEvF,MAAM,EAAE,GAAG,8BAA8B,CACvC,IAAI,CAAC,OAAO,EACZ,OAAO,EACP,IAAI,CAAC,OAAO,CACb,CAAC;QACF,OAAO,EAAE,CAAU,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;CACF;AAED,eAAe,qBAAqB,CAAC"}

package/dist/esm/notification/index.js

@@ -1,3 +1,17 @@
+/**
+ * @packageDocumentation
+ *
+ * Notification API client and types.
+ *
+ * Provides {@link NotificationApiClient} for creating, fetching, deleting
+ * notifications, marking them as seen, and managing user notification
+ * settings, with versioned endpoints (`v1`, `v2`).
+ *
+ * @example
+ * ```ts
+ * import { NotificationApiClient } from '@equinor/fusion-framework-module-services/notification';
+ * ```
+ */
 export { NotificationApiClient, default } from './client';
 export { ApiVersion } from './static';
 export * from './api-models';

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/notification/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAE1D,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/notification/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,qBAAqB,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAE1D,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC"}

package/dist/esm/notification/static.js

@@ -1,8 +1,9 @@
-/** index of api versions of context service */
+/** Supported API versions for the notification service. */
 export var ApiVersion;
 (function (ApiVersion) {
+    /** Notification API version 1.0. */
     ApiVersion["v1"] = "1.0";
-    /** not in use atm */
+    /** Notification API version 2.0 (not currently in use). */
     ApiVersion["v2"] = "2.0";
 })(ApiVersion || (ApiVersion = {}));
 //# sourceMappingURL=static.js.map

package/dist/esm/notification/static.js.map

@@ -1 +1 @@
-{"version":3,"file":"static.js","sourceRoot":"","sources":["../../../src/notification/static.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAC/C,MAAM,CAAN,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,wBAAU,CAAA;IACV,qBAAqB;IACrB,wBAAU,CAAA;AACZ,CAAC,EAJW,UAAU,KAAV,UAAU,QAIrB"}
+{"version":3,"file":"static.js","sourceRoot":"","sources":["../../../src/notification/static.ts"],"names":[],"mappings":"AAAA,2DAA2D;AAC3D,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,oCAAoC;IACpC,wBAAU,CAAA;IACV,2DAA2D;IAC3D,wBAAU,CAAA;AACZ,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB"}

package/dist/esm/people/client.js

@@ -4,44 +4,97 @@ import { client as personQueryClient, } from './query';
 import { client as personPhotoClient, } from './person-photo';
 import { client as personSuggestClient, } from './suggest';
 import { client as personResolveClient, } from './resolve';
+/**
+ * Typed API client for the Fusion people service.
+ *
+ * Provides methods for fetching person details, querying persons,
+ * retrieving profile photos, getting suggestions, and resolving
+ * person identifiers.
+ *
+ * @template TClient - The underlying HTTP client type.
+ */
 export class PeopleApiClient {
     _client;
+    /** Returns the {@link ApiVersion} enum for version-constant access. */
     get Version() {
         return ApiVersion;
     }
+    /** @param _client - The HTTP client used to execute people requests. */
     constructor(_client) {
         this._client = _client;
     }
     /**
-     * Fetch person by id
+     * Fetch detailed information about a person by their Azure unique ID.
+     *
+     * @template TVersion - The API version key (e.g. `'v4'`).
+     * @template TArgs - Request argument type.
+     * @template TResult - Expected response type.
+     * @template TMethod - Client execution method (`'json'` or `'json$'`).
+     * @param version - API version to use.
+     * @param method - Client execution method.
+     * @param args - Request arguments including `azureId`.
+     * @param init - Optional request init overrides.
+     * @returns The person details.
      */
     get(version, method, args, init) {
         const fn = personDetailClient(this._client, version, method);
         return fn(args, init);
     }
     /**
-     * Query person service
+     * Search for persons matching query criteria.
+     *
+     * @template TVersion - The API version key (e.g. `'v2'`).
+     * @template TArgs - Request argument type.
+     * @template TResult - Expected response type.
+     * @template TMethod - Client execution method.
+     * @param version - API version to use.
+     * @param method - Client execution method.
+     * @param args - Request arguments including `search` string.
+     * @param init - Optional request init overrides.
+     * @returns An array of matching person entities.
      */
     query(version, method, args, init) {
         const fn = personQueryClient(this._client, version, method);
         return fn(args, init);
     }
     /**
-     * Photo person service
+     * Fetch a person's profile photo as binary blob data.
+     *
+     * @template TVersion - The API version key (e.g. `'v2'`).
+     * @template TArgs - Request argument type.
+     * @template TResult - Expected response type.
+     * @template TMethod - Client execution method (`'blob'` or `'blob$'`).
+     * @param version - API version to use.
+     * @param method - Client execution method.
+     * @param args - Request arguments including `azureId`.
+     * @param init - Optional request init overrides.
+     * @returns The person's photo as a blob.
      */
     photo(version, method, args, init) {
         const fn = personPhotoClient(this._client, version, method);
         return fn(args, init);
     }
     /**
-     * Suggest person service
+     * Fetch person suggestions (type-ahead / autocomplete).
+     *
+     * @template TResult - Expected response type.
+     * @template TMethod - Client execution method.
+     * @param method - Client execution method.
+     * @param init - Optional request init overrides.
+     * @returns Paginated suggestion results.
      */
     suggest(method, init) {
         const fn = personSuggestClient(this._client, method);
         return fn(init);
     }
     /**
-     * Resolve person service
+     * Resolve person identifiers to account information.
+     *
+     * @template TResult - Expected response type.
+     * @template TMethod - Client execution method.
+     * @param method - Client execution method.
+     * @param init - Optional request init overrides.
+     * @returns Array of resolved person results.
      */
     resolve(method, init) {
         const fn = personResolveClient(this._client, method);

package/dist/esm/people/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/people/client.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,OAAO,EACL,MAAM,IAAI,kBAAkB,GAK7B,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EACL,MAAM,IAAI,iBAAiB,GAK5B,MAAM,SAAS,CAAC;AAEjB,OAAO,EACL,MAAM,IAAI,iBAAiB,GAK5B,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACL,MAAM,IAAI,mBAAmB,GAG9B,MAAM,WAAW,CAAC;AAEnB,OAAO,EACL,MAAM,IAAI,mBAAmB,GAG9B,MAAM,WAAW,CAAC;AAEnB,MAAM,OAAO,eAAe;IAQJ;IAJtB,IAAI,OAAO;QACT,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,YAAsB,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;IAAG,CAAC;IAE1C;;OAEG;IACI,GAAG,CAMR,OAAiB,EACjB,MAAe,EACf,IAAW,EACX,IAA0C;QAE1C,MAAM,EAAE,GAAG,kBAAkB,CAAoC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAChG,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,KAAK,CAMV,OAAiB,EACjB,MAAe,EACf,IAAW,EACX,IAA0C;QAE1C,MAAM,EAAE,GAAG,iBAAiB,CAA6B,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QACxF,OAAO,EAAE,CAAU,IAAI,EAAE,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,KAAK,CAMV,OAAiB,EACjB,MAAe,EACf,IAAW,EACX,IAA0C;QAE1C,MAAM,EAAE,GAAG,iBAAiB,CAA6B,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QACxF,OAAO,EAAE,CAAU,IAAI,EAAE,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,OAAO,CAIZ,MAAe,EACf,IAA0C;QAE1C,MAAM,EAAE,GAAG,mBAAmB,CAAmB,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACvE,OAAO,EAAE,CAAU,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,OAAO,CAIZ,MAAe,EACf,IAA0C;QAE1C,MAAM,EAAE,GAAG,mBAAmB,CAAmB,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACvE,OAAO,EAAE,CAAU,IAAI,CAAC,CAAC;IAC3B,CAAC;CACF;AAED,eAAe,eAAe,CAAC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/people/client.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,OAAO,EACL,MAAM,IAAI,kBAAkB,GAK7B,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EACL,MAAM,IAAI,iBAAiB,GAK5B,MAAM,SAAS,CAAC;AAEjB,OAAO,EACL,MAAM,IAAI,iBAAiB,GAK5B,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACL,MAAM,IAAI,mBAAmB,GAG9B,MAAM,WAAW,CAAC;AAEnB,OAAO,EACL,MAAM,IAAI,mBAAmB,GAG9B,MAAM,WAAW,CAAC;AAEnB;;;;;;;;GAQG;AACH,MAAM,OAAO,eAAe;IAUJ;IANtB,uEAAuE;IACvE,IAAI,OAAO;QACT,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,wEAAwE;IACxE,YAAsB,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;IAAG,CAAC;IAE1C;;;;;;;;;;;;OAYG;IACI,GAAG,CAMR,OAAiB,EACjB,MAAe,EACf,IAAW,EACX,IAA0C;QAE1C,MAAM,EAAE,GAAG,kBAAkB,CAAoC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAChG,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAMV,OAAiB,EACjB,MAAe,EACf,IAAW,EACX,IAA0C;QAE1C,MAAM,EAAE,GAAG,iBAAiB,CAA6B,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QACxF,OAAO,EAAE,CAAU,IAAI,EAAE,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAMV,OAAiB,EACjB,MAAe,EACf,IAAW,EACX,IAA0C;QAE1C,MAAM,EAAE,GAAG,iBAAiB,CAA6B,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QACxF,OAAO,EAAE,CAAU,IAAI,EAAE,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;OAQG;IACI,OAAO,CAIZ,MAAe,EACf,IAA0C;QAE1C,MAAM,EAAE,GAAG,mBAAmB,CAAmB,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACvE,OAAO,EAAE,CAAU,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;;;;OAQG;IACI,OAAO,CAIZ,MAAe,EACf,IAA0C;QAE1C,MAAM,EAAE,GAAG,mBAAmB,CAAmB,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACvE,OAAO,EAAE,CAAU,IAAI,CAAC,CAAC;IAC3B,CAAC;CACF;AAED,eAAe,eAAe,CAAC"}

package/dist/esm/people/index.js

@@ -1,3 +1,16 @@
+/**
+ * @packageDocumentation
+ *
+ * People API client and types.
+ *
+ * Provides {@link PeopleApiClient} for person lookups, search, photo retrieval,
+ * suggestions, and identifier resolution, with versioned endpoints (`v2`, `v4`).
+ *
+ * @example
+ * ```ts
+ * import { PeopleApiClient } from '@equinor/fusion-framework-module-services/people';
+ * ```
+ */
 export { PeopleApiClient, default } from './client';
 export { ApiVersion } from './static';
 export * from './api-models';

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/people/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAEpD,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/people/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAEpD,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,cAAc,cAAc,CAAC"}

package/dist/esm/people/person-details/client.js

@@ -1,9 +1,15 @@
 import { generateParameters } from './generate-parameters';
 /**
- * Method for fetching context item from context service
- * @param client - client for execution of request
- * @param version - version of API to call
- * @param method - client method to call
+ * Creates a curried function that fetches detailed person information.
+ *
+ * @template TVersion - Supported API version (e.g. `'v4'`).
+ * @template TMethod - Client execution method (`'json'` or `'json$'`).
+ * @template TClient - The underlying HTTP client type.
+ * @template TArgs - Request argument type.
+ * @param client - HTTP client used to execute the request.
+ * @param version - API version to call.
+ * @param method - Client method to use (defaults to `'json'`).
+ * @returns A function that accepts person detail args and returns the result.
  */
 export const client = (client, version, method = 'json') => (args, init) => client[method](...generateParameters(version, args, init));
 export default client;

package/dist/esm/people/person-details/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/people/person-details/client.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAK3D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,MAAM,GACjB,CAME,MAAe,EACf,OAAiB,EACjB,SAAkB,MAAiB,EACnC,EAAE,CACJ,CACE,IAAW,EACX,IAAoC,EACI,EAAE,CAC1C,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,kBAAkB,CAAuB,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAK9E,CAAC;AAEN,eAAe,MAAM,CAAC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/people/person-details/client.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAK3D;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,MAAM,GACjB,CAME,MAAe,EACf,OAAiB,EACjB,SAAkB,MAAiB,EACnC,EAAE,CACJ,CACE,IAAW,EACX,IAAoC,EACI,EAAE,CAC1C,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,kBAAkB,CAAuB,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAK9E,CAAC;AAEN,eAAe,MAAM,CAAC"}

package/dist/esm/people/person-photo/client.js

@@ -1,9 +1,15 @@
 import { generateParameters } from './generate-parameters';
 /**
- * Method for fetching context item from context service
- * @param client - client for execution of request
- * @param version - version of API to call
- * @param method - client method to call
+ * Creates a curried function that fetches a person's profile photo.
+ *
+ * @template TVersion - Supported API version (e.g. `'v2'`).
+ * @template TMethod - Client execution method (`'blob'` or `'blob$'`).
+ * @template TClient - The underlying HTTP client type.
+ * @template TArgs - Request argument type.
+ * @param client - HTTP client used to execute the request.
+ * @param version - API version to call.
+ * @param method - Client method to use (defaults to `'blob'`).
+ * @returns A function that accepts photo args and returns blob data.
  */
 export const client = (client, version, method = 'blob') => (args, init) => {
     return client[method](...generateParameters(version, args, init));

package/dist/esm/people/person-photo/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/people/person-photo/client.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAK3D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,MAAM,GACjB,CAME,MAAe,EACf,OAAiB,EACjB,SAAkB,MAAiB,EACnC,EAAE,CACJ,CACE,IAAW,EACX,IAAoC,EACN,EAAE;IAChC,OAAO,MAAM,CAAC,MAAM,CAAC,CACnB,GAAG,kBAAkB,CAAuB,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CACjC,CAAC;AACpC,CAAC,CAAC;AAEJ,eAAe,MAAM,CAAC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/people/person-photo/client.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAK3D;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,MAAM,GACjB,CAME,MAAe,EACf,OAAiB,EACjB,SAAkB,MAAiB,EACnC,EAAE,CACJ,CACE,IAAW,EACX,IAAoC,EACN,EAAE;IAChC,OAAO,MAAM,CAAC,MAAM,CAAC,CACnB,GAAG,kBAAkB,CAAuB,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CACjC,CAAC;AACpC,CAAC,CAAC;AAEJ,eAAe,MAAM,CAAC"}

package/dist/esm/people/query/client.js

@@ -1,9 +1,15 @@
 import { generateParameters } from './generate-parameters';
 /**
- * Method for fetching context item from context service
- * @param client - client for execution of request
- * @param version - version of API to call
- * @param method - client method to call
+ * Creates a curried function that queries the people service.
+ *
+ * @template TVersion - Supported API version (e.g. `'v2'`).
+ * @template TMethod - Client execution method.
+ * @template TClient - The underlying HTTP client type.
+ * @template TArgs - Request argument type.
+ * @param client - HTTP client used to execute the request.
+ * @param version - API version to call.
+ * @param method - Client method to use (defaults to `'json'`).
+ * @returns A function that accepts query args and returns person results.
  */
 export const client = (client, version, method = 'json') => (args, init) => client[method](...generateParameters(version, args, init));
 export default client;

package/dist/esm/people/query/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/people/query/client.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAK3D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,MAAM,GACjB,CAME,MAAe,EACf,OAAiB,EACjB,SAAkB,MAAiB,EACnC,EAAE,CACJ,CACE,IAAW,EACX,IAAoC,EACH,EAAE,CACnC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,kBAAkB,CAAuB,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAI9E,CAAC;AAEN,eAAe,MAAM,CAAC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/people/query/client.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAK3D;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,MAAM,GACjB,CAME,MAAe,EACf,OAAiB,EACjB,SAAkB,MAAiB,EACnC,EAAE,CACJ,CACE,IAAW,EACX,IAAoC,EACH,EAAE,CACnC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,kBAAkB,CAAuB,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAI9E,CAAC;AAEN,eAAe,MAAM,CAAC"}

package/dist/esm/people/static.js

@@ -1,6 +1,9 @@
+/** Supported API versions for the people service. */
 export var ApiVersion;
 (function (ApiVersion) {
+    /** People API version 2.0. */
     ApiVersion["v2"] = "2.0";
+    /** People API version 4.0. */
     ApiVersion["v4"] = "4.0";
 })(ApiVersion || (ApiVersion = {}));
 //# sourceMappingURL=static.js.map

package/dist/esm/people/static.js.map

@@ -1 +1 @@
-{"version":3,"file":"static.js","sourceRoot":"","sources":["../../../src/people/static.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,wBAAU,CAAA;IACV,wBAAU,CAAA;AACZ,CAAC,EAHW,UAAU,KAAV,UAAU,QAGrB"}
+{"version":3,"file":"static.js","sourceRoot":"","sources":["../../../src/people/static.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,8BAA8B;IAC9B,wBAAU,CAAA;IACV,8BAA8B;IAC9B,wBAAU,CAAA;AACZ,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB"}

package/dist/esm/people/utils.js

@@ -10,6 +10,25 @@ const requiredApiPersonAttributes = {
         'azureUniqueId',
     ],
 };
+/**
+ * Creates a type-guard function that validates whether a value conforms
+ * to the {@link ApiPerson} shape for a given API version.
+ *
+ * The guard checks that the value contains all required attributes
+ * defined for the specified version.
+ *
+ * @template V - API version key (e.g. `'v2'` or `'v4'`).
+ * @param version - The API version to validate against.
+ * @returns A type-guard function that narrows `T` to `ApiPerson<V>`.
+ *
+ * @example
+ * ```ts
+ * const isV4Person = isApiPerson('v4');
+ * if (isV4Person(data)) {
+ *   console.log(data.azureUniqueId);
+ * }
+ * ```
+ */
 export const isApiPerson = (version) => {
     /** todo add options for more strict check */
     return (value) => {

package/dist/esm/people/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/people/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,4EAA4E;AAE5E,MAAM,2BAA2B,GAAG;IAClC,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE;QACf,eAAe;QACf,kEAAkE;KAC5B;IACxC,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE;QACf,kEAAkE;QAClE,eAAe;KACuB;CACzC,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAoC,OAAU,EAAE,EAAE;IAC3E,6CAA6C;IAC7C,OAAO,CAAI,KAAQ,EAA+C,EAAE;QAClE,2DAA2D;QAC3D,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAe,CAAC,CAAC;QAC1C,MAAM,YAAY,GAAG,2BAA2B,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;QACtE,MAAM,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/D,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/people/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,4EAA4E;AAE5E,MAAM,2BAA2B,GAAG;IAClC,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE;QACf,eAAe;QACf,kEAAkE;KAC5B;IACxC,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE;QACf,kEAAkE;QAClE,eAAe;KACuB;CACzC,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAoC,OAAU,EAAE,EAAE;IAC3E,6CAA6C;IAC7C,OAAO,CAAI,KAAQ,EAA+C,EAAE;QAClE,2DAA2D;QAC3D,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAe,CAAC,CAAC;QAC1C,MAAM,YAAY,GAAG,2BAA2B,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;QACtE,MAAM,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/D,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC,CAAC"}

package/dist/esm/provider.js

@@ -4,16 +4,41 @@ import { ContextApiClient } from './context';
 import BookmarksApiClient from './bookmarks/client';
 import { NotificationApiClient } from './notification';
 import { PeopleApiClient } from './people/client';
-// TODO move to own file
+/**
+ * Error thrown when an API response indicates a non-OK HTTP status.
+ *
+ * Contains the full {@link ApiProviderErrorResponse} (status, headers, body)
+ * so callers can inspect the failure details.
+ *
+ * @example
+ * ```ts
+ * try {
+ *   await provider.createNotificationClient('json');
+ * } catch (err) {
+ *   if (err instanceof ApiProviderError) {
+ *     console.error(err.response.status, err.response.data);
+ *   }
+ * }
+ * ```
+ */
 export class ApiProviderError extends Error {
+    /** Structured HTTP response data associated with this error. */
     response;
+    /**
+     * @param msg - Human-readable error message.
+     * @param response - The parsed HTTP response details.
+     * @param options - Standard `ErrorOptions` (e.g. `cause`).
+     */
     constructor(msg, response, options) {
         super(msg, options);
         this.response = response;
         this.name = 'ApiProviderError';
     }
 }
-// TODO move to own file
+/**
+ * Validates that an HTTP response has an OK status.
+ * Throws an {@link ApiProviderError} with parsed body data when the response is not OK.
+ */
 const validateResponse = async (response) => {
     if (!response.ok) {
         const { headers, status, statusText, type, url, bodyUsed } = response;
@@ -29,6 +54,16 @@ const validateResponse = async (response) => {
         });
     }
 };
+/**
+ * Default implementation of {@link IApiProvider}.
+ *
+ * Manages the lifecycle of domain-specific API clients (bookmarks, context,
+ * notification, people) by resolving named HTTP clients through the
+ * configured {@link ApiClientFactory} and attaching response-validation
+ * middleware.
+ *
+ * @template TClient - The underlying HTTP client type.
+ */
 export class ApiProvider extends BaseModuleProvider {
     _createClientFn;
     constructor(config) {

package/dist/esm/provider.js.map

@@ -1 +1 @@
-{"version":3,"file":"provider.js","sourceRoot":"","sources":["../../src/provider.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAK/E,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,kBAAkB,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AA2ClD,wBAAwB;AACxB,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IAChC,QAAQ,CAA2B;IAE5C,YAAY,GAAW,EAAE,QAAkC,EAAE,OAAsB;QACjF,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACpB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;IACjC,CAAC;CACF;AAED,wBAAwB;AACxB,MAAM,gBAAgB,GAAG,KAAK,EAAE,QAAkB,EAAE,EAAE;IACpD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,QAAQ,CAAC;QACtE,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjF,MAAM,IAAI,GAAG,CAAC,QAAQ,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAC/E,MAAM,IAAI,gBAAgB,CAAC,gDAAgD,EAAE;YAC3E,OAAO;YACP,MAAM;YACN,UAAU;YACV,IAAI;YACJ,GAAG;YACH,IAAI;SACL,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC;AAMF,MAAM,OAAO,WACX,SAAQ,kBAA8C;IAG5C,eAAe,CAA4B;IACrD,YAAY,MAAkC;QAC5C,KAAK,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;QAC3B,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,YAAY,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,wBAAwB,CACnC,MAAe;QAEf,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;QAC9D,UAAU,CAAC,eAAe,CAAC,GAAG,CAAC,sBAAsB,EAAE,gBAAgB,CAAC,CAAC;QACzE,OAAO,IAAI,qBAAqB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAEM,KAAK,CAAC,qBAAqB,CAChC,MAAe;QAEf,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QAC3D,sDAAsD;QACtD,uEAAuE;QACvE,4EAA4E;QAC5E,OAAO,IAAI,kBAAkB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAC9B,MAAe;QAEf,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QACzD,UAAU,CAAC,eAAe,CAAC,GAAG,CAAC,sBAAsB,EAAE,gBAAgB,CAAC,CAAC;QACzE,OAAO,IAAI,gBAAgB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IACM,KAAK,CAAC,kBAAkB;QAC7B,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QACxD,UAAU,CAAC,eAAe,CAAC,GAAG,CAAC,sBAAsB,EAAE,gBAAgB,CAAC,CAAC;QACzE,OAAO,IAAI,eAAe,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;CACF"}
+{"version":3,"file":"provider.js","sourceRoot":"","sources":["../../src/provider.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAK/E,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,kBAAkB,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AA0ElD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IACzC,gEAAgE;IACvD,QAAQ,CAA2B;IAE5C;;;;OAIG;IACH,YAAY,GAAW,EAAE,QAAkC,EAAE,OAAsB;QACjF,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACpB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;IACjC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,gBAAgB,GAAG,KAAK,EAAE,QAAkB,EAAE,EAAE;IACpD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,QAAQ,CAAC;QACtE,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjF,MAAM,IAAI,GAAG,CAAC,QAAQ,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAC/E,MAAM,IAAI,gBAAgB,CAAC,gDAAgD,EAAE;YAC3E,OAAO;YACP,MAAM;YACN,UAAU;YACV,IAAI;YACJ,GAAG;YACH,IAAI;SACL,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC;AAWF;;;;;;;;;GASG;AACH,MAAM,OAAO,WACX,SAAQ,kBAA8C;IAG5C,eAAe,CAA4B;IACrD,YAAY,MAAkC;QAC5C,KAAK,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;QAC3B,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,YAAY,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,wBAAwB,CACnC,MAAe;QAEf,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;QAC9D,UAAU,CAAC,eAAe,CAAC,GAAG,CAAC,sBAAsB,EAAE,gBAAgB,CAAC,CAAC;QACzE,OAAO,IAAI,qBAAqB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAEM,KAAK,CAAC,qBAAqB,CAChC,MAAe;QAEf,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QAC3D,sDAAsD;QACtD,uEAAuE;QACvE,4EAA4E;QAC5E,OAAO,IAAI,kBAAkB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAC9B,MAAe;QAEf,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QACzD,UAAU,CAAC,eAAe,CAAC,GAAG,CAAC,sBAAsB,EAAE,gBAAgB,CAAC,CAAC;QACzE,OAAO,IAAI,gBAAgB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IACM,KAAK,CAAC,kBAAkB;QAC7B,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QACxD,UAAU,CAAC,eAAe,CAAC,GAAG,CAAC,sBAAsB,EAAE,gBAAgB,CAAC,CAAC;QACzE,OAAO,IAAI,eAAe,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;CACF"}

package/dist/esm/utils.js

@@ -1,11 +1,6 @@
 import { jsonSelector, } from '@equinor/fusion-framework-module-http/selectors';
 /**
- * Extracts the correct API version from the provided `apiVersions` object based on the given `version` parameter.
- *
- * @param apiVersions - An object mapping API version strings to their corresponding versions.
- * @param version - The version string to extract.
- * @returns The extracted API version, or throws an error if the version is not supported.
- */
+ * Resolves an API version string from a named key or raw version value.\n *\n * Looks up `version` as a key in `apiVersions` first; if not found,\n * searches the object values for a direct match. Throws when neither\n * lookup succeeds.\n *\n * @template TApiVersions - Record mapping version names to version strings.\n * @template TAllowedApiVersion - Allowed version constraint.\n * @template TVersion - The version string provided by the caller.\n * @param apiVersions - Map of version names to version strings.\n * @param version - Version key or raw version string to resolve.\n * @returns The resolved API version string.\n * @throws {Error} When the version is not found in `apiVersions`.\n *\n * @example\n * ```ts\n * enum ApiVersions { v1 = '1.0', v2 = '2.0' }\n * extractVersion(ApiVersions, 'v1'); // '1.0'\n * extractVersion(ApiVersions, '1.0'); // '1.0'\n * ```\n */
 export const extractVersion = (apiVersions, version) => {
     if (version in apiVersions) {
         return apiVersions[version];
@@ -17,10 +12,6 @@ export const extractVersion = (apiVersions, version) => {
     return extractedVersion;
 };
 /**
- * Creates a response selector that parses the response body using the provided Zod schema.
- *
- * @param schema - The Zod schema to use for parsing the response body.
- * @returns A response selector function that parses the response body using the provided schema.
- */
+ * Creates a response selector that parses the HTTP response body with a Zod schema.\n *\n * Combines the built-in `jsonSelector` with Zod validation, ensuring the\n * response body matches the expected shape at runtime.\n *\n * @template Output - The validated output type produced by the schema.\n * @param schema - The Zod schema used to parse and validate the response body.\n * @returns A `ResponseSelector` that extracts JSON and runs it through `schema.parse`.\n *\n * @example\n * ```ts\n * import { z } from 'zod';\n * const UserSchema = z.object({ id: z.string(), name: z.string() });\n * const selector = schemaSelector(UserSchema);\n * ```\n */
 export const schemaSelector = (schema) => async (response) => schema.parse(await jsonSelector(response));
 //# sourceMappingURL=utils.js.map