@genesislcap/foundation-store 14.117.0 → 14.118.0

package/dist/foundation-store.api.json

@@ -822,7 +822,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-store!AbstractStore#createAsyncListener:member",
-              "docComment": "/**\n * Creates an async event listener.\n *\n * @remarks\n *\n * You can think of this like an `effect` in the redux sense. You should not commit values to the store in these, instead raise subsequent events to be handled synchronously, where commits are allowed.\n *\n * @param key - The event key from the store fragment's event detail map.\n *\n * @param token - The async function handling the event.\n *\n * @typeParam TDetail - The CustomEvent detail.\n *\n * @returns The event listener.\n *\n * @public\n */\n",
+              "docComment": "/**\n * Creates an async event listener.\n *\n * @remarks\n *\n * You can think of this like an `effect` in the redux sense. You should not commit values to the store in these, instead raise subsequent events to be handled synchronously, where commits are allowed.\n *\n * @param keys - The event key or keys from the store fragment's event detail map.\n *\n * @param token - The async function handling the event.\n *\n * @typeParam TDetail - The CustomEvent detail.\n *\n * @returns The event listener.\n *\n * @example\n *\n * Creating an interface defined handler for a single event key.\n * ```ts\n * onDomainAction = this.createAsyncListener<DomainActionDetail>(\n *   'domain-action',\n *   async ({ id, message }) =>\n *     this.invokeAsyncAPI(\n *       async () => this.domainService.action(id, message),\n *       'domain-action-error',\n *       'domain-action-success'\n *     )\n * );\n * ```\n *\n * @example\n *\n * Creating an anonymous handler in the constructor for multiple event keys.\n * ```ts\n * this.createAsyncListener(\n *   [\n *     'columns-changed',\n *     'types-changed',\n *     'max-rows-changed',\n *     'max-view-changed',\n *     'order-by-changed',\n *     'reverse-changed',\n *   ],\n *   async (_, { type }) => this.emit('domain-load')\n * );\n * ```\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -830,7 +830,25 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "<TDetail = void, TReturn = void>(key: keyof (TEventDetailMap & TInternalEventDetailMap), token: (detail: TDetail) => "
+                  "text": "<TDetail = void, TReturn = void>(keys: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "KeyOrKeys",
+                  "canonicalReference": "@genesislcap/foundation-store!KeyOrKeys:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<TEventDetailMap & TInternalEventDetailMap>, token: (detail: TDetail, event?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "CustomEvent",
+                  "canonicalReference": "!CustomEvent:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<TDetail>) => "
                 },
                 {
                   "kind": "Reference",
@@ -857,7 +875,7 @@
               "name": "createAsyncListener",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 5
+                "endIndex": 9
               },
               "isStatic": false,
               "isProtected": true,
@@ -866,7 +884,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-store!AbstractStore#createErrorListener:member",
-              "docComment": "/**\n * Creates an error event listener.\n *\n * @remarks\n *\n * This logs and stores errors by event key in the store fragment's {@link ErrorMap}, allowing multiple errors to co-exist, and be presentable to the user via the UI for further action or dismissal.\n *\n * @param key - The event key from the store fragment's event detail map.\n *\n * @param token - The function handling the event.\n *\n * @typeParam TDetail - The CustomEvent detail.\n *\n * @returns The event listener.\n *\n * @public\n */\n",
+              "docComment": "/**\n * Creates an error event listener.\n *\n * @remarks\n *\n * This logs and stores errors by event key in the store fragment's {@link ErrorMap}, allowing multiple errors to co-exist, and be presentable to the user via the UI for further action or dismissal.\n *\n * @param keys - The event key or keys from the store fragment's event detail map.\n *\n * @param token - The function handling the event.\n *\n * @typeParam TDetail - The CustomEvent detail.\n *\n * @returns The event listener.\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -892,7 +910,25 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ">(key: keyof (TEventDetailMap & TInternalEventDetailMap), token?: (detail: TDetail) => void) => "
+                  "text": ">(keys: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "KeyOrKeys",
+                  "canonicalReference": "@genesislcap/foundation-store!KeyOrKeys:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<TEventDetailMap & TInternalEventDetailMap>, token?: (detail: TDetail, event?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "CustomEvent",
+                  "canonicalReference": "!CustomEvent:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<TDetail>) => void) => "
                 },
                 {
                   "kind": "Reference",
@@ -910,7 +946,7 @@
               "name": "createErrorListener",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 7
+                "endIndex": 11
               },
               "isStatic": false,
               "isProtected": true,
@@ -919,7 +955,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-store!AbstractStore#createListener:member",
-              "docComment": "/**\n * Creates an event listener.\n *\n * @remarks\n *\n * You can think of this like a `reducer` in the redux sense. You are allowed to commit values to the store in these synchronous handlers.\n *\n * @param key - The event key from the store fragment's event detail map.\n *\n * @param token - The function handling the event.\n *\n * @typeParam TDetail - The CustomEvent detail.\n *\n * @returns The event listener.\n *\n * @public\n */\n",
+              "docComment": "/**\n * Creates an event listener.\n *\n * @remarks\n *\n * You can think of this like a `reducer` in the redux sense. You are allowed to commit values to the store in these synchronous handlers.\n *\n * @param keys - The event key or keys from the store fragment's event detail map.\n *\n * @param token - The function handling the event.\n *\n * @typeParam TDetail - The CustomEvent detail.\n *\n * @returns The event listener.\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -927,7 +963,25 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "<TDetail = void>(key: keyof (TEventDetailMap & TInternalEventDetailMap), token: (detail: TDetail) => void) => "
+                  "text": "<TDetail = void>(keys: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "KeyOrKeys",
+                  "canonicalReference": "@genesislcap/foundation-store!KeyOrKeys:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<TEventDetailMap & TInternalEventDetailMap>, token: (detail: TDetail, event?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "CustomEvent",
+                  "canonicalReference": "!CustomEvent:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<TDetail>) => void) => "
                 },
                 {
                   "kind": "Reference",
@@ -945,7 +999,7 @@
               "name": "createListener",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 3
+                "endIndex": 7
               },
               "isStatic": false,
               "isProtected": true,
@@ -1103,6 +1157,113 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-store!AbstractStore#invokeAsyncAPI:member(1)",
+              "docComment": "/**\n * A convenience method to invoke an async api and emit success and error events.\n *\n * @remarks\n *\n * The async api function should throw when it encounters an error.\n *\n * @param api - The async service api function.\n *\n * @param error - The event key from the store fragment's event detail map.\n *\n * @param success - The event key from the store fragment's event detail map.\n *\n * @example\n * ```ts\n * onLoad = this.createAsyncListener('domain-load', async () =>\n *  this.invokeAsyncAPI(\n *    async () => {\n *      !this.domainService.initialized && (await this.domainService.initialize(this.asDomainServiceInit()));\n *      return this.domainService.list();\n *    },\n *    'domain-load-error',\n *    'domain-load-success'\n *  )\n * );\n * ```\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected invokeAsyncAPI<TResult>(api: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "() => "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<TResult>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", error: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "keyof (TEventDetailMap & TInternalEventDetailMap)"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", success?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "keyof (TEventDetailMap & TInternalEventDetailMap)"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<void>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "typeParameters": [
+                {
+                  "typeParameterName": "TResult",
+                  "constraintTokenRange": {
+                    "startIndex": 0,
+                    "endIndex": 0
+                  },
+                  "defaultTypeTokenRange": {
+                    "startIndex": 0,
+                    "endIndex": 0
+                  }
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 9,
+                "endIndex": 11
+              },
+              "releaseTag": "Public",
+              "isProtected": true,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "api",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "error",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "success",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 7,
+                    "endIndex": 8
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "invokeAsyncAPI"
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-store!AbstractStore#name:member",
@@ -1537,7 +1698,7 @@
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-store!ErrorDetailMap:type",
-          "docComment": "/**\n * @public\n */\n",
+          "docComment": "/**\n * @deprecated\n *\n * - Use `ErrorDetailMap` from `@genesislcap/foundation-utils` instead.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1568,7 +1729,7 @@
         {
           "kind": "Interface",
           "canonicalReference": "@genesislcap/foundation-store!ErrorMap:interface",
-          "docComment": "/**\n * @public\n */\n",
+          "docComment": "/**\n * @deprecated\n *\n * - Use `ErrorMap` from `@genesislcap/foundation-utils` instead.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1733,7 +1894,7 @@
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-store!ErrorMapLogger:type",
-          "docComment": "/**\n * @public\n */\n",
+          "docComment": "/**\n * @deprecated\n *\n * - Use `ErrorMapLogger` from `@genesislcap/foundation-utils` instead.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1759,7 +1920,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-store!registerStore:var",
-          "docComment": "/**\n * Creates a dependency injection key for the store being registered.\n *\n * @param Base - The store fragment class.\n *\n * @param name - The name of your store fragment, mostly used for internal logging.\n *\n * @returns The created key.\n *\n * @example\n * ```ts\n * export const TradeEntry = registerStore(DefaultTradeEntry, 'TradeEntry');\n * ```\n *\n * @public\n */\n",
+          "docComment": "/**\n * Creates a dependency injection key for the store being registered.\n *\n * @param Base - The store fragment class.\n *\n * @param name - The name of your store fragment, mostly used for internal logging.\n *\n * @returns The created key.\n *\n * @example\n * ```ts\n * export const TradeEntry = registerStore<TradeEntry>(DefaultTradeEntry, 'TradeEntry');\n * ```\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",

package/dist/foundation-store.d.ts

@@ -20,6 +20,10 @@ export declare abstract class AbstractStore<TStore extends Store, TEventDetailMa
     /**
      * The store fragment's event listener map.
      *
+     * @remarks
+     * Keyed by listener to allow events to have multiple listeners for cleaner logic flows.
+     * See multiple event keys example in `createAsyncListener`.
+     *
      * @internal
      */
     private eventListenerMap;
@@ -117,18 +121,39 @@ export declare abstract class AbstractStore<TStore extends Store, TEventDetailMa
      */
     private logEvent;
     /**
-     * Sets event listeners on the store fragment's internal map.
-     * @param key - The event key from the store fragment's event detail map.
-     * @param listener - The event listener.
-     * @returns The event listener.
+     * Creates an event listener by type.
+     *
+     * @typeParam TDetail - The CustomEvent detail.
+     * @param type - The type of event listener to create. See {@link EventListenerType}.
+     * @param keys - The event key or keys from the store fragment's event detail map.
+     * @param token - The function handling the event.
+     * @returns The event listener when one key is passed or undefined.
      *
      * @internal
      */
-    private mappedListener;
+    private createListenerType;
+    /**
+     * Creates an event listener envelope.
+     *
+     * @remarks
+     * These wrap the provided token.
+     *
+     * @typeParam TDetail - The CustomEvent detail.
+     * @param listenerType - The type of event listener to create. See {@link EventListenerType}.
+     * @param token - The function handling the event.
+     * @returns An event listener.
+     *
+     * @internal
+     */
+    private createListenerEnvelope;
     /**
      * Creates an event listener.
+     *
+     * @remarks
+     * See the `createAsyncListener` for usage examples.
+     *
      * @typeParam TDetail - The CustomEvent detail.
-     * @param key - The event key from the store fragment's event detail map.
+     * @param keys - The event key or keys from the store fragment's event detail map.
      * @param token - The function handling the event.
      * @returns The event listener.
      *
@@ -137,11 +162,42 @@ export declare abstract class AbstractStore<TStore extends Store, TEventDetailMa
      * You can think of this like a `reducer` in the redux sense. You are allowed to commit values to the store in these
      * synchronous handlers.
      */
-    protected createListener: <TDetail = void>(key: keyof (TEventDetailMap & TInternalEventDetailMap), token: (detail: TDetail) => void) => EventListener;
+    protected createListener: <TDetail = void>(keys: KeyOrKeys<TEventDetailMap & TInternalEventDetailMap>, token: (detail: TDetail, event?: CustomEvent<TDetail>) => void) => EventListener;
     /**
      * Creates an async event listener.
+     *
+     * @example
+     * Creating an interface defined handler for a single event key.
+     * ```ts
+     * onDomainAction = this.createAsyncListener<DomainActionDetail>(
+     *   'domain-action',
+     *   async ({ id, message }) =>
+     *     this.invokeAsyncAPI(
+     *       async () => this.domainService.action(id, message),
+     *       'domain-action-error',
+     *       'domain-action-success'
+     *     )
+     * );
+     * ```
+     *
+     * @example
+     * Creating an anonymous handler in the constructor for multiple event keys.
+     * ```ts
+     * this.createAsyncListener(
+     *   [
+     *     'columns-changed',
+     *     'types-changed',
+     *     'max-rows-changed',
+     *     'max-view-changed',
+     *     'order-by-changed',
+     *     'reverse-changed',
+     *   ],
+     *   async (_, { type }) => this.emit('domain-load')
+     * );
+     * ```
+     *
      * @typeParam TDetail - The CustomEvent detail.
-     * @param key - The event key from the store fragment's event detail map.
+     * @param keys - The event key or keys from the store fragment's event detail map.
      * @param token - The async function handling the event.
      * @returns The event listener.
      *
@@ -150,11 +206,11 @@ export declare abstract class AbstractStore<TStore extends Store, TEventDetailMa
      * You can think of this like an `effect` in the redux sense. You should not commit values to the store in these,
      * instead raise subsequent events to be handled synchronously, where commits are allowed.
      */
-    protected createAsyncListener: <TDetail = void, TReturn = void>(key: keyof (TEventDetailMap & TInternalEventDetailMap), token: (detail: TDetail) => Promise<TReturn>) => EventListener;
+    protected createAsyncListener: <TDetail = void, TReturn = void>(keys: KeyOrKeys<TEventDetailMap & TInternalEventDetailMap>, token: (detail: TDetail, event?: CustomEvent<TDetail>) => Promise<TReturn>) => EventListener;
     /**
      * Creates an error event listener.
      * @typeParam TDetail - The CustomEvent detail.
-     * @param key - The event key from the store fragment's event detail map.
+     * @param keys - The event key or keys from the store fragment's event detail map.
      * @param token - The function handling the event.
      * @returns The event listener.
      *
@@ -163,7 +219,7 @@ export declare abstract class AbstractStore<TStore extends Store, TEventDetailMa
      * This logs and stores errors by event key in the store fragment's {@link ErrorMap}, allowing multiple errors to
      * co-exist, and be presentable to the user via the UI for further action or dismissal.
      */
-    protected createErrorListener: <TDetail extends Error = Error>(key: keyof (TEventDetailMap & TInternalEventDetailMap), token?: (detail: TDetail) => void) => EventListener;
+    protected createErrorListener: <TDetail extends Error = Error>(keys: KeyOrKeys<TEventDetailMap & TInternalEventDetailMap>, token?: (detail: TDetail, event?: CustomEvent<TDetail>) => void) => EventListener;
     /**
      * Add the store fragment's event listeners to the root element.
      * @param element - The store root element.
@@ -195,6 +251,32 @@ export declare abstract class AbstractStore<TStore extends Store, TEventDetailMa
      * fragments.
      */
     protected emit<K extends keyof (TEventDetailMap & TInternalEventDetailMap) & string>(...args: (TEventDetailMap & TInternalEventDetailMap)[K] extends void ? [key: K] : [key: K, detail: (TEventDetailMap & TInternalEventDetailMap)[K]]): void;
+    /**
+     * A convenience method to invoke an async api and emit success and error events.
+     *
+     * @remarks
+     * The async api function should throw when it encounters an error.
+     *
+     * @example
+     * ```ts
+     * onLoad = this.createAsyncListener('domain-load', async () =>
+     *  this.invokeAsyncAPI(
+     *    async () => {
+     *      !this.domainService.initialized && (await this.domainService.initialize(this.asDomainServiceInit()));
+     *      return this.domainService.list();
+     *    },
+     *    'domain-load-error',
+     *    'domain-load-success'
+     *  )
+     * );
+     * ```
+     *
+     * @param api - The async service api function.
+     * @param error - The event key from the store fragment's event detail map.
+     * @param success - The event key from the store fragment's event detail map.
+     * @public
+     */
+    protected invokeAsyncAPI<TResult>(api: () => Promise<TResult>, error: keyof (TEventDetailMap & TInternalEventDetailMap), success?: keyof (TEventDetailMap & TInternalEventDetailMap)): Promise<void>;
 }
 
 /**
@@ -242,11 +324,13 @@ export declare abstract class AbstractStoreRoot<TStore extends StoreRoot, TEvent
 export declare const createErrorMap: <TErrorDetailMap extends ErrorDetailMap>(logger: ErrorMapLogger) => ErrorMap<TErrorDetailMap>;
 
 /**
+ * @deprecated - Use `ErrorDetailMap` from `@genesislcap/foundation-utils` instead.
  * @public
  */
 export declare type ErrorDetailMap = Record<string, unknown>;
 
 /**
+ * @deprecated - Use `ErrorMap` from `@genesislcap/foundation-utils` instead.
  * @public
  */
 export declare interface ErrorMap<TErrorDetailMap extends ErrorDetailMap> extends Pick<Map<keyof TErrorDetailMap, Error>, 'get' | 'has' | 'delete' | 'clear' | 'size'> {
@@ -268,10 +352,27 @@ export declare interface ErrorMap<TErrorDetailMap extends ErrorDetailMap> extend
 }
 
 /**
+ * @deprecated - Use `ErrorMapLogger` from `@genesislcap/foundation-utils` instead.
  * @public
  */
 export declare type ErrorMapLogger = (...args: any[]) => void;
 
+/**
+ * @internal
+ */
+export declare enum EventListenerType {
+    sync = "sync",
+    async = "async",
+    error = "error"
+}
+
+/**
+ * @typeParam TEventDetailMaps - The store's complete event detail map.
+ *
+ * @internal
+ */
+export declare type KeyOrKeys<TEventDetailMaps extends EventDetailMap> = keyof TEventDetailMaps | (keyof TEventDetailMaps)[];
+
 /**
  * Creates a dependency injection key for the store being registered.
  * @param Base - The store fragment class.
@@ -280,7 +381,7 @@ export declare type ErrorMapLogger = (...args: any[]) => void;
  *
  * @example
  * ```ts
- * export const TradeEntry = registerStore(DefaultTradeEntry, 'TradeEntry');
+ * export const TradeEntry = registerStore<TradeEntry>(DefaultTradeEntry, 'TradeEntry');
  * ```
  *
  * @public

package/docs/api/foundation-store.abstractstore.createasynclistener.md

@@ -9,10 +9,44 @@ Creates an async event listener.
 **Signature:**
 
 ```typescript
-protected createAsyncListener: <TDetail = void, TReturn = void>(key: keyof (TEventDetailMap & TInternalEventDetailMap), token: (detail: TDetail) => Promise<TReturn>) => EventListener;
+protected createAsyncListener: <TDetail = void, TReturn = void>(keys: KeyOrKeys<TEventDetailMap & TInternalEventDetailMap>, token: (detail: TDetail, event?: CustomEvent<TDetail>) => Promise<TReturn>) => EventListener;
 ```
 
 ## Remarks
 
 You can think of this like an `effect` in the redux sense. You should not commit values to the store in these, instead raise subsequent events to be handled synchronously, where commits are allowed.
 
+## Example 1
+
+Creating an interface defined handler for a single event key.
+
+```ts
+onDomainAction = this.createAsyncListener<DomainActionDetail>(
+  'domain-action',
+  async ({ id, message }) =>
+    this.invokeAsyncAPI(
+      async () => this.domainService.action(id, message),
+      'domain-action-error',
+      'domain-action-success'
+    )
+);
+```
+
+## Example 2
+
+Creating an anonymous handler in the constructor for multiple event keys.
+
+```ts
+this.createAsyncListener(
+  [
+    'columns-changed',
+    'types-changed',
+    'max-rows-changed',
+    'max-view-changed',
+    'order-by-changed',
+    'reverse-changed',
+  ],
+  async (_, { type }) => this.emit('domain-load')
+);
+```
+

package/docs/api/foundation-store.abstractstore.createerrorlistener.md

@@ -9,7 +9,7 @@ Creates an error event listener.
 **Signature:**
 
 ```typescript
-protected createErrorListener: <TDetail extends Error = Error>(key: keyof (TEventDetailMap & TInternalEventDetailMap), token?: (detail: TDetail) => void) => EventListener;
+protected createErrorListener: <TDetail extends Error = Error>(keys: KeyOrKeys<TEventDetailMap & TInternalEventDetailMap>, token?: (detail: TDetail, event?: CustomEvent<TDetail>) => void) => EventListener;
 ```
 
 ## Remarks

package/docs/api/foundation-store.abstractstore.createlistener.md

@@ -9,7 +9,7 @@ Creates an event listener.
 **Signature:**
 
 ```typescript
-protected createListener: <TDetail = void>(key: keyof (TEventDetailMap & TInternalEventDetailMap), token: (detail: TDetail) => void) => EventListener;
+protected createListener: <TDetail = void>(keys: KeyOrKeys<TEventDetailMap & TInternalEventDetailMap>, token: (detail: TDetail, event?: CustomEvent<TDetail>) => void) => EventListener;
 ```
 
 ## Remarks

package/docs/api/foundation-store.abstractstore.invokeasyncapi.md

@@ -0,0 +1,46 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-store](./foundation-store.md) &gt; [AbstractStore](./foundation-store.abstractstore.md) &gt; [invokeAsyncAPI](./foundation-store.abstractstore.invokeasyncapi.md)
+
+## AbstractStore.invokeAsyncAPI() method
+
+A convenience method to invoke an async api and emit success and error events.
+
+**Signature:**
+
+```typescript
+protected invokeAsyncAPI<TResult>(api: () => Promise<TResult>, error: keyof (TEventDetailMap & TInternalEventDetailMap), success?: keyof (TEventDetailMap & TInternalEventDetailMap)): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  api | () =&gt; Promise&lt;TResult&gt; | The async service api function. |
+|  error | keyof (TEventDetailMap &amp; TInternalEventDetailMap) | The event key from the store fragment's event detail map. |
+|  success | keyof (TEventDetailMap &amp; TInternalEventDetailMap) | _(Optional)_ The event key from the store fragment's event detail map. |
+
+**Returns:**
+
+Promise&lt;void&gt;
+
+## Remarks
+
+The async api function should throw when it encounters an error.
+
+## Example
+
+
+```ts
+onLoad = this.createAsyncListener('domain-load', async () =>
+ this.invokeAsyncAPI(
+   async () => {
+     !this.domainService.initialized && (await this.domainService.initialize(this.asDomainServiceInit()));
+     return this.domainService.list();
+   },
+   'domain-load-error',
+   'domain-load-success'
+ )
+);
+```
+

package/docs/api/foundation-store.abstractstore.md

@@ -24,9 +24,9 @@ export declare abstract class AbstractStore<TStore extends Store, TEventDetailMa
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [commit](./foundation-store.abstractstore.commit.md) | <p><code>protected</code></p><p><code>readonly</code></p> | this | **_(BETA)_** The value commit proxy. |
-|  [createAsyncListener](./foundation-store.abstractstore.createasynclistener.md) | <code>protected</code> | &lt;TDetail = void, TReturn = void&gt;(key: keyof (TEventDetailMap &amp; TInternalEventDetailMap), token: (detail: TDetail) =&gt; Promise&lt;TReturn&gt;) =&gt; EventListener | Creates an async event listener. |
-|  [createErrorListener](./foundation-store.abstractstore.createerrorlistener.md) | <code>protected</code> | &lt;TDetail extends Error = Error&gt;(key: keyof (TEventDetailMap &amp; TInternalEventDetailMap), token?: (detail: TDetail) =&gt; void) =&gt; EventListener | Creates an error event listener. |
-|  [createListener](./foundation-store.abstractstore.createlistener.md) | <code>protected</code> | &lt;TDetail = void&gt;(key: keyof (TEventDetailMap &amp; TInternalEventDetailMap), token: (detail: TDetail) =&gt; void) =&gt; EventListener | Creates an event listener. |
+|  [createAsyncListener](./foundation-store.abstractstore.createasynclistener.md) | <code>protected</code> | &lt;TDetail = void, TReturn = void&gt;(keys: KeyOrKeys&lt;TEventDetailMap &amp; TInternalEventDetailMap&gt;, token: (detail: TDetail, event?: CustomEvent&lt;TDetail&gt;) =&gt; Promise&lt;TReturn&gt;) =&gt; EventListener | Creates an async event listener. |
+|  [createErrorListener](./foundation-store.abstractstore.createerrorlistener.md) | <code>protected</code> | &lt;TDetail extends Error = Error&gt;(keys: KeyOrKeys&lt;TEventDetailMap &amp; TInternalEventDetailMap&gt;, token?: (detail: TDetail, event?: CustomEvent&lt;TDetail&gt;) =&gt; void) =&gt; EventListener | Creates an error event listener. |
+|  [createListener](./foundation-store.abstractstore.createlistener.md) | <code>protected</code> | &lt;TDetail = void&gt;(keys: KeyOrKeys&lt;TEventDetailMap &amp; TInternalEventDetailMap&gt;, token: (detail: TDetail, event?: CustomEvent&lt;TDetail&gt;) =&gt; void) =&gt; EventListener | Creates an event listener. |
 |  [errors](./foundation-store.abstractstore.errors.md) |  | ErrorMap&lt;TEventDetailMap &amp; TInternalEventDetailMap&gt; | Contains any errors the store may have, see [ErrorMap](./foundation-store.errormap.md)<!-- -->. |
 |  [name](./foundation-store.abstractstore.name.md) | <code>readonly</code> | string | The name of the store fragment. |
 |  [root](./foundation-store.abstractstore.root.md) | <code>protected</code> | TStoreRoot | The store root fragment. |
@@ -43,4 +43,5 @@ export declare abstract class AbstractStore<TStore extends Store, TEventDetailMa
 |  [connect(root)](./foundation-store.abstractstore.connect.md) |  | Connects this store fragment. |
 |  [disconnect(root)](./foundation-store.abstractstore.disconnect.md) |  | Disconnects this store fragment. |
 |  [emit(args)](./foundation-store.abstractstore.emit.md) | <code>protected</code> | Emit events to the stores directly via the standard event flow. |
+|  [invokeAsyncAPI(api, error, success)](./foundation-store.abstractstore.invokeasyncapi.md) | <code>protected</code> | A convenience method to invoke an async api and emit success and error events. |
 

package/docs/api/foundation-store.errordetailmap.md

@@ -4,6 +4,10 @@
 
 ## ErrorDetailMap type
 
+> Warning: This API is now obsolete.
+> 
+> - Use `ErrorDetailMap` from `@genesislcap/foundation-utils` instead.
+> 
 
 **Signature:**
 

package/docs/api/foundation-store.errormap.md

@@ -4,6 +4,10 @@
 
 ## ErrorMap interface
 
+> Warning: This API is now obsolete.
+> 
+> - Use `ErrorMap` from `@genesislcap/foundation-utils` instead.
+> 
 
 **Signature:**
 

package/docs/api/foundation-store.errormaplogger.md

@@ -4,6 +4,10 @@
 
 ## ErrorMapLogger type
 
+> Warning: This API is now obsolete.
+> 
+> - Use `ErrorMapLogger` from `@genesislcap/foundation-utils` instead.
+> 
 
 **Signature:**