@empathyco/x-components 6.0.0-alpha.18 → 6.0.0-alpha.180

package/js/wiring/wires.factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"wires.factory.js","sources":["../../../src/wiring/wires.factory.ts"],"sourcesContent":["import { Store } from 'vuex';\nimport { RootXStoreState } from '../store/store.types';\nimport { MonadicFunction, NiladicFunction, SubObject } from '../utils/index';\nimport {\n  AnyWire,\n  PayloadFactoryData,\n  Wire,\n  WireParams,\n  WirePayload,\n  WireService,\n  WireServiceWithoutPayload\n} from './wiring.types';\n\n/**\n * Creates a wire that executes the function passed. This function will receive a\n * {@link WireParams} object.\n *\n * @param fn - The function to execute whenever a new value is emitted to the observable.\n * @returns The Wire function.\n * @public\n */\nexport function createWireFromFunction<Payload>(\n  fn: (parameters: WireParams<Payload>) => void\n): Wire<Payload> {\n  return (observable, store) =>\n    observable.subscribe(({ metadata, eventPayload }) => {\n      fn({ eventPayload, store, metadata });\n    });\n}\n\n/**\n * Creates a wire that commits a mutation to the store. This wire receives a function. This function\n * is used to get the actual payload value passed to mutation.\n * This wire can be used in every event, as it does not have a payload type associated.\n *\n * @param mutation - The full mutation path to commit. I.e. `x/searchBox/setQuery`.\n * @param payloadFactory - A function that receives a {@link PayloadFactoryData | object}\n * with the Store state, getters, payload and metadata as parameter.\n * @returns A {@link AnyWire} wire that commits the mutation with the payload returned by the\n * payloadFactory.\n * @public\n */\nexport function wireCommit<Payload>(\n  mutation: string,\n  payloadFactory: (params: PayloadFactoryData<Payload>) => any\n): AnyWire;\n/**\n * Creates a wire that commits a mutation to the store. This wire can receive any value as payload.\n * This wire can be used in every event, as it does not have a payload type associated.\n *\n * @param mutation - The full mutation path to commit. I.e. `x/searchBox/setQuery`.\n * @param staticPayload - A static payload to pass to the mutation.\n * @returns {@link AnyWire} A wire that commits the mutation with the staticPayload payload.\n * @public\n */\nexport function wireCommit(mutation: string, staticPayload: any): AnyWire;\n/**\n * Creates a wire that commits a mutation to the store. This wire will commit to the store the\n * payload that it receives in the observable.\n *\n * @param mutation - The full mutation path to commit. I.e. `x/searchBox/setQuery`.\n * @typeParam Payload - The type of the payload that this wire will receive\n * @returns {@link Wire} A wire that commits the mutation with the payload that it receives\n * in the observable.\n * @public\n */\nexport function wireCommit<Payload>(mutation: string): Wire<Payload>;\n// eslint-disable-next-line jsdoc/require-jsdoc\nexport function wireCommit<Payload>(mutation: string, payload?: Payload): Wire<Payload> {\n  return (observable, store) =>\n    observable.subscribe(createSubscriptionCallback(store, 'commit', mutation, payload));\n}\n\n/**\n * Creates a wire that commits a mutation to the store, but without any payload. This wire can\n * be used in every event, as it does not have a payload type associated.\n *\n * @param mutation - The full mutation path to commit. I.e. `x/searchBox/setQuery`.\n * @returns {@link AnyWire} A wire that commits the mutation without any payload.\n * @public\n */\nexport function wireCommitWithoutPayload(mutation: string): AnyWire {\n  return (observable, store) => observable.subscribe(() => store.commit(mutation));\n}\n\n/**\n * Creates a wire that dispatch an action to the store. This wire receives a function. This function\n * is used to get the actual payload value passed to action.\n * This wire can be used in every event, as it does not have a payload type associated.\n *\n * @param action - The full action path to dispatch. I.e. `x/querySuggestions/fetchSuggestions`.\n * @param payloadFactory - A function that receives a {@link PayloadFactoryData | object}\n * with the Store state, getters, payload and metadata as parameter.\n * @returns A {@link AnyWire} wire that dispatches the action with the payload returned by the\n * payloadFactory.\n * @public\n */\nexport function wireDispatch<Payload>(\n  action: string,\n  payloadFactory: (params: PayloadFactoryData<Payload>) => any\n): AnyWire;\n/**\n * Creates a wire that dispatches an action to the store. This wire can be used in every event,\n * as it does not have a payload type associated.\n *\n * @param action - The full action path to dispatch. I.e. `x/querySuggestions/fetchSuggestions`.\n * @param staticPayload - A static payload to pass to the action which will be dispatched.\n * @returns {@link AnyWire} A wire that dispatches the action with the staticPayload payload.\n * @public\n */\nexport function wireDispatch(action: string, staticPayload: any): AnyWire;\n/**\n * Creates a wire that dispatches an action to the store. This wire will pass the payload\n * received in the observable to the action.\n *\n * @param action - The full action path to dispatch. I.e. `x/querySuggestions/fetchSuggestions`.\n * @typeParam Payload - The type of the payload that this wire will receive\n * @returns {@link Wire} A wire that dispatches the action with the payload that it receives\n * in the observable.\n * @public\n */\nexport function wireDispatch<Payload>(action: string): Wire<Payload>;\n// eslint-disable-next-line jsdoc/require-jsdoc\nexport function wireDispatch<Payload>(action: string, payload?: Payload): Wire<Payload> {\n  return (observable, store) =>\n    observable.subscribe(createSubscriptionCallback(store, 'dispatch', action, payload));\n}\n\n/**\n * Creates a wire that dispatches an action to the store, but without any payload. This wire can\n * be used in every event, as it does not have a payload type associated.\n *\n * @param action - The full action path to dispatch. I.e. `x/querySuggestions/fetchSuggestions`.\n * @returns {@link AnyWire} A wire that dispatches the action without any payload.\n * @public\n */\nexport function wireDispatchWithoutPayload(action: string): AnyWire {\n  return (observable, store) => observable.subscribe(() => store.dispatch(action));\n}\n\n/**\n * Creates a wires factory that can create wires that will invoke the service methods.\n *\n * @param service - The service to invoke its methods.\n * @returns A factory to create wires that invoke the service methods.\n * @public\n */\nexport function wireService<SomeService>(\n  service: SomeService & SubObject<SomeService, MonadicFunction>\n): WireService<SubObject<SomeService, MonadicFunction>> {\n  return (method, payload?) => {\n    return observable =>\n      observable.subscribe(\n        payload !== undefined\n          ? () => service[method](payload)\n          : observablePayload => service[method](observablePayload.eventPayload)\n      );\n  };\n}\n\n/**\n * Creates a wires factory that can create wires that will invoke the service methods but\n * without payload.\n *\n * @param service - The service to invoke its methods.\n * @returns A factory to create wires that invoke the service methods without payload.\n * @public\n */\nexport function wireServiceWithoutPayload<SomeService>(\n  service: SomeService & SubObject<SomeService, NiladicFunction>\n): WireServiceWithoutPayload<SubObject<SomeService, NiladicFunction>> {\n  return method => {\n    return observable => observable.subscribe(() => service[method]());\n  };\n}\n\n/**\n * Creates the callback function for the {@link wireCommit} and {@link wireDispatch}\n * subscriptions. It can be based on the payload as function which retrieves the observable\n * payload from the store, a static payload or the event value from the observable.\n *\n * @param store - The {@link RootXStoreState} store.\n * @param commitOrDispatch - The executor over store. It can be `commit` or `dispatch`.\n * @param mutationOrAction - The mutation or action to commit or dispatch respectively.\n * @param payload - The payload for the store executor. It can be a function which retrieves the\n * payload from the store, a static payload or the event value from the observable.\n * @typeParam Payload - The type of the payload to get the observable event value type.\n * @returns A function to commit or dispatch a payload value over store.\n * @internal\n */\nfunction createSubscriptionCallback<Payload>(\n  store: Store<RootXStoreState>,\n  commitOrDispatch: 'commit' | 'dispatch',\n  mutationOrAction: string,\n  payload?: Payload\n): (observableValue: WirePayload<Payload>) => void {\n  const storeExecutor = store[commitOrDispatch];\n  return typeof payload === 'function'\n    ? wirePayload => {\n        return storeExecutor(\n          mutationOrAction,\n          payload({\n            state: store.state,\n            getters: store.getters,\n            ...wirePayload\n          })\n        );\n      }\n    : payload !== undefined\n    ? () => {\n        storeExecutor(mutationOrAction, payload);\n      }\n    : observableValue => {\n        storeExecutor(mutationOrAction, observableValue.eventPayload);\n      };\n}\n"],"names":[],"mappings":"AAaA;;;;;;;AAOG;AACG,SAAU,sBAAsB,CACpC,EAA6C,EAAA;AAE7C,IAAA,OAAO,CAAC,UAAU,EAAE,KAAK,KACvB,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE,KAAI;QAClD,EAAE,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;AACxC,KAAC,CAAC,CAAC;AACP,CAAC;AAuCD;AACgB,SAAA,UAAU,CAAU,QAAgB,EAAE,OAAiB,EAAA;IACrE,OAAO,CAAC,UAAU,EAAE,KAAK,KACvB,UAAU,CAAC,SAAS,CAAC,0BAA0B,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;AACzF,CAAC;AAED;;;;;;;AAOG;AACG,SAAU,wBAAwB,CAAC,QAAgB,EAAA;IACvD,OAAO,CAAC,UAAU,EAAE,KAAK,KAAK,UAAU,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;AACnF,CAAC;AAuCD;AACgB,SAAA,YAAY,CAAU,MAAc,EAAE,OAAiB,EAAA;IACrE,OAAO,CAAC,UAAU,EAAE,KAAK,KACvB,UAAU,CAAC,SAAS,CAAC,0BAA0B,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AACzF,CAAC;AAED;;;;;;;AAOG;AACG,SAAU,0BAA0B,CAAC,MAAc,EAAA;IACvD,OAAO,CAAC,UAAU,EAAE,KAAK,KAAK,UAAU,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AACnF,CAAC;AAED;;;;;;AAMG;AACG,SAAU,WAAW,CACzB,OAA8D,EAAA;AAE9D,IAAA,OAAO,CAAC,MAAM,EAAE,OAAQ,KAAI;QAC1B,OAAO,UAAU,IACf,UAAU,CAAC,SAAS,CAClB,OAAO,KAAK,SAAS;cACjB,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;AAChC,cAAE,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,iBAAiB,CAAC,YAAY,CAAC,CACzE,CAAC;AACN,KAAC,CAAC;AACJ,CAAC;AAED;;;;;;;AAOG;AACG,SAAU,yBAAyB,CACvC,OAA8D,EAAA;IAE9D,OAAO,MAAM,IAAG;AACd,QAAA,OAAO,UAAU,IAAI,UAAU,CAAC,SAAS,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AACrE,KAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;AAaG;AACH,SAAS,0BAA0B,CACjC,KAA6B,EAC7B,gBAAuC,EACvC,gBAAwB,EACxB,OAAiB,EAAA;AAEjB,IAAA,MAAM,aAAa,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAC9C,OAAO,OAAO,OAAO,KAAK,UAAU;UAChC,WAAW,IAAG;AACZ,YAAA,OAAO,aAAa,CAClB,gBAAgB,EAChB,OAAO,CAAC;gBACN,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,OAAO,EAAE,KAAK,CAAC,OAAO;AACtB,gBAAA,GAAG,WAAW;AACf,aAAA,CAAC,CACH,CAAC;SACH;UACD,OAAO,KAAK,SAAS;cACrB,MAAK;AACH,gBAAA,aAAa,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;aAC1C;cACD,eAAe,IAAG;AAChB,gBAAA,aAAa,CAAC,gBAAgB,EAAE,eAAe,CAAC,YAAY,CAAC,CAAC;AAChE,aAAC,CAAC;AACR;;;;"}
+{"version":3,"file":"wires.factory.js","sources":["../../../src/wiring/wires.factory.ts"],"sourcesContent":["import type { Store } from 'vuex'\nimport type { RootXStoreState } from '../store/store.types'\nimport type { MonadicFunction, NiladicFunction, SubObject } from '../utils/index'\nimport type {\n  AnyWire,\n  PayloadFactoryData,\n  Wire,\n  WireParams,\n  WirePayload,\n  WireService,\n  WireServiceWithoutPayload,\n} from './wiring.types'\n\n/**\n * Creates a wire that executes the function passed. This function will receive a\n * {@link WireParams} object.\n *\n * @param fn - The function to execute whenever a new value is emitted to the observable.\n * @returns The Wire function.\n * @public\n */\nexport function createWireFromFunction<Payload>(\n  fn: (parameters: WireParams<Payload>) => void,\n): Wire<Payload> {\n  return (observable, store) =>\n    observable.subscribe(({ metadata, eventPayload }) => {\n      fn({ eventPayload, store, metadata })\n    })\n}\n\n/**\n * Creates a wire that commits a mutation to the store. This wire receives a function. This function\n * is used to get the actual payload value passed to mutation.\n * This wire can be used in every event, as it does not have a payload type associated.\n *\n * @param mutation - The full mutation path to commit. I.e. `x/searchBox/setQuery`.\n * @param payloadFactory - A function that receives a {@link PayloadFactoryData | object}\n * with the Store state, getters, payload and metadata as parameter.\n * @returns A {@link AnyWire} wire that commits the mutation with the payload returned by the\n * payloadFactory.\n * @public\n */\nexport function wireCommit<Payload>(\n  mutation: string,\n  payloadFactory: (params: PayloadFactoryData<Payload>) => any,\n): AnyWire\n/**\n * Creates a wire that commits a mutation to the store. This wire can receive any value as payload.\n * This wire can be used in every event, as it does not have a payload type associated.\n *\n * @param mutation - The full mutation path to commit. I.e. `x/searchBox/setQuery`.\n * @param staticPayload - A static payload to pass to the mutation.\n * @returns {@link AnyWire} A wire that commits the mutation with the staticPayload payload.\n * @public\n */\nexport function wireCommit(mutation: string, staticPayload: any): AnyWire\n/**\n * Creates a wire that commits a mutation to the store. This wire will commit to the store the\n * payload that it receives in the observable.\n *\n * @param mutation - The full mutation path to commit. I.e. `x/searchBox/setQuery`.\n * @typeParam Payload - The type of the payload that this wire will receive\n * @returns {@link Wire} A wire that commits the mutation with the payload that it receives\n * in the observable.\n * @public\n */\nexport function wireCommit<Payload>(mutation: string): Wire<Payload>\n\nexport function wireCommit<Payload>(mutation: string, payload?: Payload): Wire<Payload> {\n  return (observable, store) =>\n    observable.subscribe(createSubscriptionCallback(store, 'commit', mutation, payload))\n}\n\n/**\n * Creates a wire that commits a mutation to the store, but without any payload. This wire can\n * be used in every event, as it does not have a payload type associated.\n *\n * @param mutation - The full mutation path to commit. I.e. `x/searchBox/setQuery`.\n * @returns {@link AnyWire} A wire that commits the mutation without any payload.\n * @public\n */\nexport function wireCommitWithoutPayload(mutation: string): AnyWire {\n  return (observable, store) => observable.subscribe(() => store.commit(mutation))\n}\n\n/**\n * Creates a wire that dispatch an action to the store. This wire receives a function. This function\n * is used to get the actual payload value passed to action.\n * This wire can be used in every event, as it does not have a payload type associated.\n *\n * @param action - The full action path to dispatch. I.e. `x/querySuggestions/fetchSuggestions`.\n * @param payloadFactory - A function that receives a {@link PayloadFactoryData | object}\n * with the Store state, getters, payload and metadata as parameter.\n * @returns A {@link AnyWire} wire that dispatches the action with the payload returned by the\n * payloadFactory.\n * @public\n */\nexport function wireDispatch<Payload>(\n  action: string,\n  payloadFactory: (params: PayloadFactoryData<Payload>) => any,\n): AnyWire\n/**\n * Creates a wire that dispatches an action to the store. This wire can be used in every event,\n * as it does not have a payload type associated.\n *\n * @param action - The full action path to dispatch. I.e. `x/querySuggestions/fetchSuggestions`.\n * @param staticPayload - A static payload to pass to the action which will be dispatched.\n * @returns {@link AnyWire} A wire that dispatches the action with the staticPayload payload.\n * @public\n */\nexport function wireDispatch(action: string, staticPayload: any): AnyWire\n/**\n * Creates a wire that dispatches an action to the store. This wire will pass the payload\n * received in the observable to the action.\n *\n * @param action - The full action path to dispatch. I.e. `x/querySuggestions/fetchSuggestions`.\n * @typeParam Payload - The type of the payload that this wire will receive\n * @returns {@link Wire} A wire that dispatches the action with the payload that it receives\n * in the observable.\n * @public\n */\nexport function wireDispatch<Payload>(action: string): Wire<Payload>\n\nexport function wireDispatch<Payload>(action: string, payload?: Payload): Wire<Payload> {\n  return (observable, store) =>\n    observable.subscribe(createSubscriptionCallback(store, 'dispatch', action, payload))\n}\n\n/**\n * Creates a wire that dispatches an action to the store, but without any payload. This wire can\n * be used in every event, as it does not have a payload type associated.\n *\n * @param action - The full action path to dispatch. I.e. `x/querySuggestions/fetchSuggestions`.\n * @returns {@link AnyWire} A wire that dispatches the action without any payload.\n * @public\n */\nexport function wireDispatchWithoutPayload(action: string): AnyWire {\n  // eslint-disable-next-line ts/no-unsafe-return,ts/no-misused-promises\n  return (observable, store) => observable.subscribe(async () => store.dispatch(action))\n}\n\n/**\n * Creates a wires factory that can create wires that will invoke the service methods.\n *\n * @param service - The service to invoke its methods.\n * @returns A factory to create wires that invoke the service methods.\n * @public\n */\nexport function wireService<SomeService>(\n  service: SomeService & SubObject<SomeService, MonadicFunction>,\n): WireService<SubObject<SomeService, MonadicFunction>> {\n  return (method, payload?) => {\n    return observable =>\n      observable.subscribe(\n        payload !== undefined\n          ? // eslint-disable-next-line ts/no-unsafe-return\n            () => service[method](payload)\n          : // eslint-disable-next-line ts/no-unsafe-return\n            observablePayload => service[method](observablePayload.eventPayload),\n      )\n  }\n}\n\n/**\n * Creates a wires factory that can create wires that will invoke the service methods but\n * without payload.\n *\n * @param service - The service to invoke its methods.\n * @returns A factory to create wires that invoke the service methods without payload.\n * @public\n */\nexport function wireServiceWithoutPayload<SomeService>(\n  service: SomeService & SubObject<SomeService, NiladicFunction>,\n): WireServiceWithoutPayload<SubObject<SomeService, NiladicFunction>> {\n  return method => {\n    // eslint-disable-next-line ts/no-unsafe-return\n    return observable => observable.subscribe(() => service[method]())\n  }\n}\n\n/**\n * Creates the callback function for the {@link wireCommit} and {@link wireDispatch}\n * subscriptions. It can be based on the payload as function which retrieves the observable\n * payload from the store, a static payload or the event value from the observable.\n *\n * @param store - The {@link RootXStoreState} store.\n * @param commitOrDispatch - The executor over store. It can be `commit` or `dispatch`.\n * @param mutationOrAction - The mutation or action to commit or dispatch respectively.\n * @param payload - The payload for the store executor. It can be a function which retrieves the\n * payload from the store, a static payload or the event value from the observable.\n * @typeParam Payload - The type of the payload to get the observable event value type.\n * @returns A function to commit or dispatch a payload value over store.\n * @internal\n */\nfunction createSubscriptionCallback<Payload>(\n  store: Store<RootXStoreState>,\n  commitOrDispatch: 'commit' | 'dispatch',\n  mutationOrAction: string,\n  payload?: Payload,\n): (observableValue: WirePayload<Payload>) => void {\n  const storeExecutor = store[commitOrDispatch]\n  return typeof payload === 'function'\n    ? async wirePayload => {\n        // eslint-disable-next-line ts/no-unsafe-return\n        return storeExecutor(\n          mutationOrAction,\n          // eslint-disable-next-line ts/no-unsafe-call\n          payload({\n            state: store.state,\n            // eslint-disable-next-line ts/no-unsafe-assignment\n            getters: store.getters,\n            ...wirePayload,\n          }),\n        )\n      }\n    : payload !== undefined\n      ? () => {\n          void storeExecutor(mutationOrAction, payload)\n        }\n      : observableValue => {\n          void storeExecutor(mutationOrAction, observableValue.eventPayload)\n        }\n}\n"],"names":[],"mappings":"AAaA;;;;;;;AAOG;AACG,SAAU,sBAAsB,CACpC,EAA6C,EAAA;AAE7C,IAAA,OAAO,CAAC,UAAU,EAAE,KAAK,KACvB,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE,KAAI;QAClD,EAAE,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAA;AACvC,KAAC,CAAC,CAAA;AACN,CAAC;AAwCe,SAAA,UAAU,CAAU,QAAgB,EAAE,OAAiB,EAAA;IACrE,OAAO,CAAC,UAAU,EAAE,KAAK,KACvB,UAAU,CAAC,SAAS,CAAC,0BAA0B,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAA;AACxF,CAAC;AAED;;;;;;;AAOG;AACG,SAAU,wBAAwB,CAAC,QAAgB,EAAA;IACvD,OAAO,CAAC,UAAU,EAAE,KAAK,KAAK,UAAU,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;AAClF,CAAC;AAwCe,SAAA,YAAY,CAAU,MAAc,EAAE,OAAiB,EAAA;IACrE,OAAO,CAAC,UAAU,EAAE,KAAK,KACvB,UAAU,CAAC,SAAS,CAAC,0BAA0B,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;AACxF,CAAC;AAED;;;;;;;AAOG;AACG,SAAU,0BAA0B,CAAC,MAAc,EAAA;;IAEvD,OAAO,CAAC,UAAU,EAAE,KAAK,KAAK,UAAU,CAAC,SAAS,CAAC,YAAY,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAA;AACxF,CAAC;AAED;;;;;;AAMG;AACG,SAAU,WAAW,CACzB,OAA8D,EAAA;AAE9D,IAAA,OAAO,CAAC,MAAM,EAAE,OAAQ,KAAI;QAC1B,OAAO,UAAU,IACf,UAAU,CAAC,SAAS,CAClB,OAAO,KAAK,SAAS;AACnB;gBACE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;AAChC;AACE;AAAA,gBAAA,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,iBAAiB,CAAC,YAAY,CAAC,CACzE,CAAA;AACL,KAAC,CAAA;AACH,CAAC;AAED;;;;;;;AAOG;AACG,SAAU,yBAAyB,CACvC,OAA8D,EAAA;IAE9D,OAAO,MAAM,IAAG;;AAEd,QAAA,OAAO,UAAU,IAAI,UAAU,CAAC,SAAS,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;AACpE,KAAC,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;AAaG;AACH,SAAS,0BAA0B,CACjC,KAA6B,EAC7B,gBAAuC,EACvC,gBAAwB,EACxB,OAAiB,EAAA;AAEjB,IAAA,MAAM,aAAa,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAA;IAC7C,OAAO,OAAO,OAAO,KAAK,UAAU;AAClC,UAAE,OAAM,WAAW,KAAG;;YAElB,OAAO,aAAa,CAClB,gBAAgB;;AAEhB,YAAA,OAAO,CAAC;gBACN,KAAK,EAAE,KAAK,CAAC,KAAK;;gBAElB,OAAO,EAAE,KAAK,CAAC,OAAO;AACtB,gBAAA,GAAG,WAAW;AACf,aAAA,CAAC,CACH,CAAA;SACF;UACD,OAAO,KAAK,SAAS;cACnB,MAAK;AACH,gBAAA,KAAK,aAAa,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAA;aAC9C;cACD,eAAe,IAAG;gBAChB,KAAK,aAAa,CAAC,gBAAgB,EAAE,eAAe,CAAC,YAAY,CAAC,CAAA;AACpE,aAAC,CAAA;AACT;;;;"}

package/js/wiring/wires.operators.js

@@ -1,126 +1,126 @@
 import { filter as filter$1, debounce as debounce$1, throttle as throttle$1, map } from 'rxjs/operators';
 import { createTimer, normalizeTime } from './wires-operators.utils.js';
 
-/**
- * Creates a {@link Wire} that is only executed whenever the condition in the filterFn is true.
- *
- * @param wire - The wire to filter.
- * @param filterFn - A function which must return a boolean and that will be executed every time
- * the wire is called.
- * @returns The Wire function filter.
- *
- * @public
- */
-function filter(wire, filterFn) {
-    return (observable, store, on) => wire(observable.pipe(filter$1(wirePayload => filterFn({ ...wirePayload, store }))), store, on);
-}
-/**
- * Creates a {@link Wire} that is only executed when the payload is truthy. A truthy value is
- * whatever is not a {@link https://developer.mozilla.org/en-US/docs/Glossary/Falsy | falsy value}.
- *
- * @param wire - The wire to avoid executing when the payload is falsy.
- * @returns The Wire function falsy filter.
- *
- * @public
- */
-function filterFalsyPayload(wire) {
-    return filter(wire, ({ eventPayload }) => !!eventPayload);
-}
-/**
- * Creates a {@link Wire} that is only executed when the payload is a
- * {@link https://developer.mozilla.org/en-US/docs/Glossary/Falsy | falsy value}.
- *
- * @param wire - The wire to avoid executing when the payload is truthy.
- * @returns The Wire function truthy filter.
- *
- * @public
- */
-function filterTruthyPayload(wire) {
-    return filter(wire, ({ eventPayload }) => !eventPayload);
-}
-/**
- * Creates a {@link Wire} that is only executed if the event is emitted from a {@link XModule}
- * that is included
- * in the `whitelist` array passed as parameter.
- *
- * @param wire - The wire to filter using the whitelist.
- * @param whitelist - An array of {@link XModuleName} or null.
- * @returns The Wire function with whitelisted modules filter.
- *
- * @public
- */
-function filterWhitelistedModules(wire, whitelist) {
-    const whitelistSet = new Set(whitelist);
-    return filter(wire, ({ metadata }) => whitelistSet.has(metadata.moduleName));
-}
-/**
- * Creates a {@link Wire} that is only executed if the event is emitted from a {@link XModule}
- * that is NOT included
- * in the `blacklist` array passed as parameter.
- *
- * @param wire - The wire to filter using the whitelist.
- * @param blacklist - An array of {@link XModuleName} or null.
- * @returns The Wire function with blacklisted modules filter.
- *
- * @public
- */
-function filterBlacklistedModules(wire, blacklist) {
-    const blacklistSet = new Set(blacklist);
-    return filter(wire, ({ metadata }) => !blacklistSet.has(metadata.moduleName));
-}
-/**
- * Creates a debounced {@link Wire}. Being debounced means that it will only be executed after
- * the time given by `timeInMs` has passed without invoking it.
- *
- * @param wire - The wire to debounce.
- * @param timeInMs - The time in milliseconds to debounce the wire execution or a function to
- * retrieve it from the store.
- * @param options - Options to configure this wire with, like an event to force it or cancel it.
- * @returns The Wire function with a debounced timing.
- *
- * @public
- */
-function debounce(wire, timeInMs, options = {}) {
-    return (observable, store, on) => {
-        return wire(observable.pipe(debounce$1(() => createTimer(normalizeTime(timeInMs, store), options, on))), store, on);
-    };
-}
-/**
- * Creates a throttled {@link Wire}. Being throttled means that it will only be executed once
- * every couple of milliseconds given by the `timeInMs` parameter.
- *
- * @param wire - The wire to throttle.
- * @param timeInMs - The time in milliseconds to throttle the wire execution or a function to
- * retrieve it from the store.
- * @param options - Options to configure this wire with, like an event to force it or cancel it.
- * @returns The Wire function with a throttle timing.
- *
- * @public
- */
-function throttle(wire, timeInMs, options = {}) {
-    return (observable, store, on) => {
-        return wire(observable.pipe(throttle$1(() => createTimer(normalizeTime(timeInMs, store), options, on), {
-            leading: true,
-            trailing: true
-        })), store, on);
-    };
-}
-/**
- * Creates a {@link Wire} from other `toWire` wire. It uses `mapFn` to transform the
- * `FromPayload` received to `ToPayload` which `toWire` requires. This is
- * useful to reuse wires in different Events where the payload doesn't fit exactly.
- *
- * @param toWire - The wire which the new Wire is created from.
- * @param mapFn - Function to map the payload from `FromPayload` to `ToPayload`.
- * @returns A new {@link Wire}.
- *
- * @public
- */
-function mapWire(toWire, mapFn) {
-    return (observable, ...restWireParams) => toWire(observable.pipe(map(({ eventPayload, ...restWirePayload }) => ({
-        eventPayload: mapFn(eventPayload),
-        ...restWirePayload
-    }))), ...restWireParams);
+/**
+ * Creates a {@link Wire} that is only executed whenever the condition in the filterFn is true.
+ *
+ * @param wire - The wire to filter.
+ * @param filterFn - A function which must return a boolean and that will be executed every time
+ * the wire is called.
+ * @returns The Wire function filter.
+ *
+ * @public
+ */
+function filter(wire, filterFn) {
+    return (observable, store, on) => wire(observable.pipe(filter$1(wirePayload => filterFn({ ...wirePayload, store }))), store, on);
+}
+/**
+ * Creates a {@link Wire} that is only executed when the payload is truthy. A truthy value is
+ * whatever is not a {@link https://developer.mozilla.org/en-US/docs/Glossary/Falsy | falsy value}.
+ *
+ * @param wire - The wire to avoid executing when the payload is falsy.
+ * @returns The Wire function falsy filter.
+ *
+ * @public
+ */
+function filterFalsyPayload(wire) {
+    return filter(wire, ({ eventPayload }) => !!eventPayload);
+}
+/**
+ * Creates a {@link Wire} that is only executed when the payload is a
+ * {@link https://developer.mozilla.org/en-US/docs/Glossary/Falsy | falsy value}.
+ *
+ * @param wire - The wire to avoid executing when the payload is truthy.
+ * @returns The Wire function truthy filter.
+ *
+ * @public
+ */
+function filterTruthyPayload(wire) {
+    return filter(wire, ({ eventPayload }) => !eventPayload);
+}
+/**
+ * Creates a {@link Wire} that is only executed if the event is emitted from a {@link XModule}
+ * that is included
+ * in the `whitelist` array passed as parameter.
+ *
+ * @param wire - The wire to filter using the whitelist.
+ * @param whitelist - An array of {@link XModuleName} or null.
+ * @returns The Wire function with whitelisted modules filter.
+ *
+ * @public
+ */
+function filterWhitelistedModules(wire, whitelist) {
+    const whitelistSet = new Set(whitelist);
+    return filter(wire, ({ metadata }) => whitelistSet.has(metadata.moduleName));
+}
+/**
+ * Creates a {@link Wire} that is only executed if the event is emitted from a {@link XModule}
+ * that is NOT included
+ * in the `blacklist` array passed as parameter.
+ *
+ * @param wire - The wire to filter using the whitelist.
+ * @param blacklist - An array of {@link XModuleName} or null.
+ * @returns The Wire function with blacklisted modules filter.
+ *
+ * @public
+ */
+function filterBlacklistedModules(wire, blacklist) {
+    const blacklistSet = new Set(blacklist);
+    return filter(wire, ({ metadata }) => !blacklistSet.has(metadata.moduleName));
+}
+/**
+ * Creates a debounced {@link Wire}. Being debounced means that it will only be executed after
+ * the time given by `timeInMs` has passed without invoking it.
+ *
+ * @param wire - The wire to debounce.
+ * @param timeInMs - The time in milliseconds to debounce the wire execution or a function to
+ * retrieve it from the store.
+ * @param options - Options to configure this wire with, like an event to force it or cancel it.
+ * @returns The Wire function with a debounced timing.
+ *
+ * @public
+ */
+function debounce(wire, timeInMs, options = {}) {
+    return (observable, store, on) => {
+        return wire(observable.pipe(debounce$1(() => createTimer(normalizeTime(timeInMs, store), options, on))), store, on);
+    };
+}
+/**
+ * Creates a throttled {@link Wire}. Being throttled means that it will only be executed once
+ * every couple of milliseconds given by the `timeInMs` parameter.
+ *
+ * @param wire - The wire to throttle.
+ * @param timeInMs - The time in milliseconds to throttle the wire execution or a function to
+ * retrieve it from the store.
+ * @param options - Options to configure this wire with, like an event to force it or cancel it.
+ * @returns The Wire function with a throttle timing.
+ *
+ * @public
+ */
+function throttle(wire, timeInMs, options = {}) {
+    return (observable, store, on) => {
+        return wire(observable.pipe(throttle$1(() => createTimer(normalizeTime(timeInMs, store), options, on), {
+            leading: true,
+            trailing: true,
+        })), store, on);
+    };
+}
+/**
+ * Creates a {@link Wire} from other `toWire` wire. It uses `mapFn` to transform the
+ * `FromPayload` received to `ToPayload` which `toWire` requires. This is
+ * useful to reuse wires in different Events where the payload doesn't fit exactly.
+ *
+ * @param toWire - The wire which the new Wire is created from.
+ * @param mapFn - Function to map the payload from `FromPayload` to `ToPayload`.
+ * @returns A new {@link Wire}.
+ *
+ * @public
+ */
+function mapWire(toWire, mapFn) {
+    return (observable, ...restWireParams) => toWire(observable.pipe(map(({ eventPayload, ...restWirePayload }) => ({
+        eventPayload: mapFn(eventPayload),
+        ...restWirePayload,
+    }))), ...restWireParams);
 }
 
 export { debounce, filter, filterBlacklistedModules, filterFalsyPayload, filterTruthyPayload, filterWhitelistedModules, mapWire, throttle };

package/js/wiring/wires.operators.js.map

@@ -1 +1 @@
-{"version":3,"file":"wires.operators.js","sources":["../../../src/wiring/wires.operators.ts"],"sourcesContent":["import {\n  debounce as debounceRx,\n  filter as filterRx,\n  map,\n  throttle as throttleRx\n} from 'rxjs/operators';\nimport { XModuleName } from '../x-modules/x-modules.types';\nimport { createTimer, normalizeTime } from './wires-operators.utils';\nimport { TimedWireOperatorOptions, TimeSelector, Wire, WireParams } from './wiring.types';\n\n/**\n * Creates a {@link Wire} that is only executed whenever the condition in the filterFn is true.\n *\n * @param wire - The wire to filter.\n * @param filterFn - A function which must return a boolean and that will be executed every time\n * the wire is called.\n * @returns The Wire function filter.\n *\n * @public\n */\nexport function filter<Payload>(\n  wire: Wire<Payload>,\n  filterFn: (parameters: WireParams<Payload>) => boolean\n): Wire<Payload> {\n  return (observable, store, on) =>\n    wire(observable.pipe(filterRx(wirePayload => filterFn({ ...wirePayload, store }))), store, on);\n}\n\n/**\n * Creates a {@link Wire} that is only executed when the payload is truthy. A truthy value is\n * whatever is not a {@link https://developer.mozilla.org/en-US/docs/Glossary/Falsy | falsy value}.\n *\n * @param wire - The wire to avoid executing when the payload is falsy.\n * @returns The Wire function falsy filter.\n *\n * @public\n */\nexport function filterFalsyPayload<Payload>(\n  wire: Wire<Exclude<Payload, null | undefined | false | 0 | ''>>\n): Wire<Payload> {\n  return filter(wire, ({ eventPayload }) => !!eventPayload) as Wire<Payload>;\n}\n\n/**\n * Creates a {@link Wire} that is only executed when the payload is a\n * {@link https://developer.mozilla.org/en-US/docs/Glossary/Falsy | falsy value}.\n *\n * @param wire - The wire to avoid executing when the payload is truthy.\n * @returns The Wire function truthy filter.\n *\n * @public\n */\nexport function filterTruthyPayload<Payload>(wire: Wire<Payload>): Wire<Payload> {\n  return filter(wire, ({ eventPayload }) => !eventPayload);\n}\n\n/**\n * Creates a {@link Wire} that is only executed if the event is emitted from a {@link XModule}\n * that is included\n * in the `whitelist` array passed as parameter.\n *\n * @param wire - The wire to filter using the whitelist.\n * @param whitelist - An array of {@link XModuleName} or null.\n * @returns The Wire function with whitelisted modules filter.\n *\n * @public\n */\nexport function filterWhitelistedModules<Payload>(\n  wire: Wire<Payload>,\n  whitelist: Array<XModuleName | null>\n): Wire<Payload> {\n  const whitelistSet = new Set(whitelist);\n  return filter(wire, ({ metadata }) => whitelistSet.has(metadata.moduleName));\n}\n\n/**\n * Creates a {@link Wire} that is only executed if the event is emitted from a {@link XModule}\n * that is NOT included\n * in the `blacklist` array passed as parameter.\n *\n * @param wire - The wire to filter using the whitelist.\n * @param blacklist - An array of {@link XModuleName} or null.\n * @returns The Wire function with blacklisted modules filter.\n *\n * @public\n */\nexport function filterBlacklistedModules<Payload>(\n  wire: Wire<Payload>,\n  blacklist: Array<XModuleName | null>\n): Wire<Payload> {\n  const blacklistSet = new Set(blacklist);\n  return filter(wire, ({ metadata }) => !blacklistSet.has(metadata.moduleName));\n}\n\n/**\n * Creates a debounced {@link Wire}. Being debounced means that it will only be executed after\n * the time given by `timeInMs` has passed without invoking it.\n *\n * @param wire - The wire to debounce.\n * @param timeInMs - The time in milliseconds to debounce the wire execution or a function to\n * retrieve it from the store.\n * @param options - Options to configure this wire with, like an event to force it or cancel it.\n * @returns The Wire function with a debounced timing.\n *\n * @public\n */\nexport function debounce<Payload>(\n  wire: Wire<Payload>,\n  timeInMs: TimeSelector | number,\n  options: TimedWireOperatorOptions = {}\n): Wire<Payload> {\n  return (observable, store, on) => {\n    return wire(\n      observable.pipe(debounceRx(() => createTimer(normalizeTime(timeInMs, store), options, on))),\n      store,\n      on\n    );\n  };\n}\n\n/**\n * Creates a throttled {@link Wire}. Being throttled means that it will only be executed once\n * every couple of milliseconds given by the `timeInMs` parameter.\n *\n * @param wire - The wire to throttle.\n * @param timeInMs - The time in milliseconds to throttle the wire execution or a function to\n * retrieve it from the store.\n * @param options - Options to configure this wire with, like an event to force it or cancel it.\n * @returns The Wire function with a throttle timing.\n *\n * @public\n */\nexport function throttle<Payload>(\n  wire: Wire<Payload>,\n  timeInMs: TimeSelector | number,\n  options: TimedWireOperatorOptions = {}\n): Wire<Payload> {\n  return (observable, store, on) => {\n    return wire(\n      observable.pipe(\n        throttleRx(() => createTimer(normalizeTime(timeInMs, store), options, on), {\n          leading: true,\n          trailing: true\n        })\n      ),\n      store,\n      on\n    );\n  };\n}\n\n/**\n * Creates a {@link Wire} from other `toWire` wire. It uses `mapFn` to transform the\n * `FromPayload` received to `ToPayload` which `toWire` requires. This is\n * useful to reuse wires in different Events where the payload doesn't fit exactly.\n *\n * @param toWire - The wire which the new Wire is created from.\n * @param mapFn - Function to map the payload from `FromPayload` to `ToPayload`.\n * @returns A new {@link Wire}.\n *\n * @public\n */\nexport function mapWire<FromPayload, ToPayload>(\n  toWire: Wire<ToPayload>,\n  mapFn: (payload: FromPayload) => ToPayload\n): Wire<FromPayload> {\n  return (observable, ...restWireParams) =>\n    toWire(\n      observable.pipe(\n        map(({ eventPayload, ...restWirePayload }) => ({\n          eventPayload: mapFn(eventPayload),\n          ...restWirePayload\n        }))\n      ),\n      ...restWireParams\n    );\n}\n"],"names":["filterRx","debounceRx","throttleRx"],"mappings":";;;AAUA;;;;;;;;;AASG;AACa,SAAA,MAAM,CACpB,IAAmB,EACnB,QAAsD,EAAA;AAEtD,IAAA,OAAO,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,KAC3B,IAAI,CAAC,UAAU,CAAC,IAAI,CAACA,QAAQ,CAAC,WAAW,IAAI,QAAQ,CAAC,EAAE,GAAG,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;AACnG,CAAC;AAED;;;;;;;;AAQG;AACG,SAAU,kBAAkB,CAChC,IAA+D,EAAA;AAE/D,IAAA,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC,YAAY,CAAkB,CAAC;AAC7E,CAAC;AAED;;;;;;;;AAQG;AACG,SAAU,mBAAmB,CAAU,IAAmB,EAAA;AAC9D,IAAA,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;;;;;;AAUG;AACa,SAAA,wBAAwB,CACtC,IAAmB,EACnB,SAAoC,EAAA;AAEpC,IAAA,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;IACxC,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,KAAK,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;AAC/E,CAAC;AAED;;;;;;;;;;AAUG;AACa,SAAA,wBAAwB,CACtC,IAAmB,EACnB,SAAoC,EAAA;AAEpC,IAAA,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;IACxC,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;AAChF,CAAC;AAED;;;;;;;;;;;AAWG;AACG,SAAU,QAAQ,CACtB,IAAmB,EACnB,QAA+B,EAC/B,UAAoC,EAAE,EAAA;AAEtC,IAAA,OAAO,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,KAAI;AAC/B,QAAA,OAAO,IAAI,CACT,UAAU,CAAC,IAAI,CAACC,UAAU,CAAC,MAAM,WAAW,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,EAC3F,KAAK,EACL,EAAE,CACH,CAAC;AACJ,KAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;AAWG;AACG,SAAU,QAAQ,CACtB,IAAmB,EACnB,QAA+B,EAC/B,UAAoC,EAAE,EAAA;AAEtC,IAAA,OAAO,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,KAAI;QAC/B,OAAO,IAAI,CACT,UAAU,CAAC,IAAI,CACbC,UAAU,CAAC,MAAM,WAAW,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,OAAO,EAAE,EAAE,CAAC,EAAE;AACzE,YAAA,OAAO,EAAE,IAAI;AACb,YAAA,QAAQ,EAAE,IAAI;AACf,SAAA,CAAC,CACH,EACD,KAAK,EACL,EAAE,CACH,CAAC;AACJ,KAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;AAUG;AACa,SAAA,OAAO,CACrB,MAAuB,EACvB,KAA0C,EAAA;IAE1C,OAAO,CAAC,UAAU,EAAE,GAAG,cAAc,KACnC,MAAM,CACJ,UAAU,CAAC,IAAI,CACb,GAAG,CAAC,CAAC,EAAE,YAAY,EAAE,GAAG,eAAe,EAAE,MAAM;AAC7C,QAAA,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC;AACjC,QAAA,GAAG,eAAe;AACnB,KAAA,CAAC,CAAC,CACJ,EACD,GAAG,cAAc,CAClB,CAAC;AACN;;;;"}
+{"version":3,"file":"wires.operators.js","sources":["../../../src/wiring/wires.operators.ts"],"sourcesContent":["import type { XModuleName } from '../x-modules/x-modules.types'\nimport type { TimedWireOperatorOptions, TimeSelector, Wire, WireParams } from './wiring.types'\nimport {\n  debounce as debounceRx,\n  filter as filterRx,\n  map,\n  throttle as throttleRx,\n} from 'rxjs/operators'\nimport { createTimer, normalizeTime } from './wires-operators.utils'\n\n/**\n * Creates a {@link Wire} that is only executed whenever the condition in the filterFn is true.\n *\n * @param wire - The wire to filter.\n * @param filterFn - A function which must return a boolean and that will be executed every time\n * the wire is called.\n * @returns The Wire function filter.\n *\n * @public\n */\nexport function filter<Payload>(\n  wire: Wire<Payload>,\n  filterFn: (parameters: WireParams<Payload>) => boolean,\n): Wire<Payload> {\n  return (observable, store, on) =>\n    wire(observable.pipe(filterRx(wirePayload => filterFn({ ...wirePayload, store }))), store, on)\n}\n\n/**\n * Creates a {@link Wire} that is only executed when the payload is truthy. A truthy value is\n * whatever is not a {@link https://developer.mozilla.org/en-US/docs/Glossary/Falsy | falsy value}.\n *\n * @param wire - The wire to avoid executing when the payload is falsy.\n * @returns The Wire function falsy filter.\n *\n * @public\n */\nexport function filterFalsyPayload<Payload>(\n  wire: Wire<Exclude<Payload, null | undefined | false | 0 | ''>>,\n): Wire<Payload> {\n  return filter(wire, ({ eventPayload }) => !!eventPayload) as Wire<Payload>\n}\n\n/**\n * Creates a {@link Wire} that is only executed when the payload is a\n * {@link https://developer.mozilla.org/en-US/docs/Glossary/Falsy | falsy value}.\n *\n * @param wire - The wire to avoid executing when the payload is truthy.\n * @returns The Wire function truthy filter.\n *\n * @public\n */\nexport function filterTruthyPayload<Payload>(wire: Wire<Payload>): Wire<Payload> {\n  return filter(wire, ({ eventPayload }) => !eventPayload)\n}\n\n/**\n * Creates a {@link Wire} that is only executed if the event is emitted from a {@link XModule}\n * that is included\n * in the `whitelist` array passed as parameter.\n *\n * @param wire - The wire to filter using the whitelist.\n * @param whitelist - An array of {@link XModuleName} or null.\n * @returns The Wire function with whitelisted modules filter.\n *\n * @public\n */\nexport function filterWhitelistedModules<Payload>(\n  wire: Wire<Payload>,\n  whitelist: Array<XModuleName | null>,\n): Wire<Payload> {\n  const whitelistSet = new Set(whitelist)\n  return filter(wire, ({ metadata }) => whitelistSet.has(metadata.moduleName))\n}\n\n/**\n * Creates a {@link Wire} that is only executed if the event is emitted from a {@link XModule}\n * that is NOT included\n * in the `blacklist` array passed as parameter.\n *\n * @param wire - The wire to filter using the whitelist.\n * @param blacklist - An array of {@link XModuleName} or null.\n * @returns The Wire function with blacklisted modules filter.\n *\n * @public\n */\nexport function filterBlacklistedModules<Payload>(\n  wire: Wire<Payload>,\n  blacklist: Array<XModuleName | null>,\n): Wire<Payload> {\n  const blacklistSet = new Set(blacklist)\n  return filter(wire, ({ metadata }) => !blacklistSet.has(metadata.moduleName))\n}\n\n/**\n * Creates a debounced {@link Wire}. Being debounced means that it will only be executed after\n * the time given by `timeInMs` has passed without invoking it.\n *\n * @param wire - The wire to debounce.\n * @param timeInMs - The time in milliseconds to debounce the wire execution or a function to\n * retrieve it from the store.\n * @param options - Options to configure this wire with, like an event to force it or cancel it.\n * @returns The Wire function with a debounced timing.\n *\n * @public\n */\nexport function debounce<Payload>(\n  wire: Wire<Payload>,\n  timeInMs: TimeSelector | number,\n  options: TimedWireOperatorOptions = {},\n): Wire<Payload> {\n  return (observable, store, on) => {\n    return wire(\n      observable.pipe(debounceRx(() => createTimer(normalizeTime(timeInMs, store), options, on))),\n      store,\n      on,\n    )\n  }\n}\n\n/**\n * Creates a throttled {@link Wire}. Being throttled means that it will only be executed once\n * every couple of milliseconds given by the `timeInMs` parameter.\n *\n * @param wire - The wire to throttle.\n * @param timeInMs - The time in milliseconds to throttle the wire execution or a function to\n * retrieve it from the store.\n * @param options - Options to configure this wire with, like an event to force it or cancel it.\n * @returns The Wire function with a throttle timing.\n *\n * @public\n */\nexport function throttle<Payload>(\n  wire: Wire<Payload>,\n  timeInMs: TimeSelector | number,\n  options: TimedWireOperatorOptions = {},\n): Wire<Payload> {\n  return (observable, store, on) => {\n    return wire(\n      observable.pipe(\n        throttleRx(() => createTimer(normalizeTime(timeInMs, store), options, on), {\n          leading: true,\n          trailing: true,\n        }),\n      ),\n      store,\n      on,\n    )\n  }\n}\n\n/**\n * Creates a {@link Wire} from other `toWire` wire. It uses `mapFn` to transform the\n * `FromPayload` received to `ToPayload` which `toWire` requires. This is\n * useful to reuse wires in different Events where the payload doesn't fit exactly.\n *\n * @param toWire - The wire which the new Wire is created from.\n * @param mapFn - Function to map the payload from `FromPayload` to `ToPayload`.\n * @returns A new {@link Wire}.\n *\n * @public\n */\nexport function mapWire<FromPayload, ToPayload>(\n  toWire: Wire<ToPayload>,\n  mapFn: (payload: FromPayload) => ToPayload,\n): Wire<FromPayload> {\n  return (observable, ...restWireParams) =>\n    toWire(\n      observable.pipe(\n        map(({ eventPayload, ...restWirePayload }) => ({\n          eventPayload: mapFn(eventPayload),\n          ...restWirePayload,\n        })),\n      ),\n      ...restWireParams,\n    )\n}\n"],"names":["filterRx","debounceRx","throttleRx"],"mappings":";;;AAUA;;;;;;;;;AASG;AACa,SAAA,MAAM,CACpB,IAAmB,EACnB,QAAsD,EAAA;AAEtD,IAAA,OAAO,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,KAC3B,IAAI,CAAC,UAAU,CAAC,IAAI,CAACA,QAAQ,CAAC,WAAW,IAAI,QAAQ,CAAC,EAAE,GAAG,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAA;AAClG,CAAC;AAED;;;;;;;;AAQG;AACG,SAAU,kBAAkB,CAChC,IAA+D,EAAA;AAE/D,IAAA,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC,YAAY,CAAkB,CAAA;AAC5E,CAAC;AAED;;;;;;;;AAQG;AACG,SAAU,mBAAmB,CAAU,IAAmB,EAAA;AAC9D,IAAA,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC,CAAA;AAC1D,CAAC;AAED;;;;;;;;;;AAUG;AACa,SAAA,wBAAwB,CACtC,IAAmB,EACnB,SAAoC,EAAA;AAEpC,IAAA,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAA;IACvC,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,KAAK,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAA;AAC9E,CAAC;AAED;;;;;;;;;;AAUG;AACa,SAAA,wBAAwB,CACtC,IAAmB,EACnB,SAAoC,EAAA;AAEpC,IAAA,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAA;IACvC,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAA;AAC/E,CAAC;AAED;;;;;;;;;;;AAWG;AACG,SAAU,QAAQ,CACtB,IAAmB,EACnB,QAA+B,EAC/B,UAAoC,EAAE,EAAA;AAEtC,IAAA,OAAO,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,KAAI;AAC/B,QAAA,OAAO,IAAI,CACT,UAAU,CAAC,IAAI,CAACC,UAAU,CAAC,MAAM,WAAW,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,EAC3F,KAAK,EACL,EAAE,CACH,CAAA;AACH,KAAC,CAAA;AACH,CAAC;AAED;;;;;;;;;;;AAWG;AACG,SAAU,QAAQ,CACtB,IAAmB,EACnB,QAA+B,EAC/B,UAAoC,EAAE,EAAA;AAEtC,IAAA,OAAO,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,KAAI;QAC/B,OAAO,IAAI,CACT,UAAU,CAAC,IAAI,CACbC,UAAU,CAAC,MAAM,WAAW,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,OAAO,EAAE,EAAE,CAAC,EAAE;AACzE,YAAA,OAAO,EAAE,IAAI;AACb,YAAA,QAAQ,EAAE,IAAI;AACf,SAAA,CAAC,CACH,EACD,KAAK,EACL,EAAE,CACH,CAAA;AACH,KAAC,CAAA;AACH,CAAC;AAED;;;;;;;;;;AAUG;AACa,SAAA,OAAO,CACrB,MAAuB,EACvB,KAA0C,EAAA;IAE1C,OAAO,CAAC,UAAU,EAAE,GAAG,cAAc,KACnC,MAAM,CACJ,UAAU,CAAC,IAAI,CACb,GAAG,CAAC,CAAC,EAAE,YAAY,EAAE,GAAG,eAAe,EAAE,MAAM;AAC7C,QAAA,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC;AACjC,QAAA,GAAG,eAAe;AACnB,KAAA,CAAC,CAAC,CACJ,EACD,GAAG,cAAc,CAClB,CAAA;AACL;;;;"}

package/js/wiring/wiring.utils.js

@@ -1,34 +1,34 @@
 import { getGettersProxy } from '../store/utils/getters-proxy.utils.js';
 
-/**
- * Util function to generate type-safe wiring.
- * If TypeScript ever accepts the PR about generic type inference this function can be removed.
- *
- * @param wiring - The wiring to create.
- * @returns Type-safe wiring.
- *
- * @public
- */
-function createWiring(wiring) {
-    return wiring;
-}
-/**
- * Returns an object with the getters and state of a module of store defined by the moduleName
- * parameter.
- *
- * @param state - The Vuex store State.
- * @param getters - The Vuex store Getters.
- * @param moduleName - The {@link XModuleName} of the module.
- * @returns The {@link StoreModuleStateAndGetters} with the Getters and the State of the
- * {@link XStoreModule | Store Module} defined by moduleName.
- *
- * @public
- */
-function getStateAndGettersFromModule(state, getters, moduleName) {
-    return {
-        state: state.x[moduleName],
-        getters: getGettersProxy(getters, moduleName)
-    };
+/**
+ * Util function to generate type-safe wiring.
+ * If TypeScript ever accepts the PR about generic type inference this function can be removed.
+ *
+ * @param wiring - The wiring to create.
+ * @returns Type-safe wiring.
+ *
+ * @public
+ */
+function createWiring(wiring) {
+    return wiring;
+}
+/**
+ * Returns an object with the getters and state of a module of store defined by the moduleName
+ * parameter.
+ *
+ * @param state - The Vuex store State.
+ * @param getters - The Vuex store Getters.
+ * @param moduleName - The {@link XModuleName} of the module.
+ * @returns The {@link StoreModuleStateAndGetters} with the Getters and the State of the
+ * {@link XStoreModule | Store Module} defined by moduleName.
+ *
+ * @public
+ */
+function getStateAndGettersFromModule(state, getters, moduleName) {
+    return {
+        state: state.x[moduleName],
+        getters: getGettersProxy(getters, moduleName),
+    };
 }
 
 export { createWiring, getStateAndGettersFromModule };

package/js/wiring/wiring.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"wiring.utils.js","sources":["../../../src/wiring/wiring.utils.ts"],"sourcesContent":["import { Dictionary } from '@empathyco/x-utils';\nimport { RootXStoreState, StoreModuleStateAndGetters } from '../store/store.types';\nimport { getGettersProxy } from '../store/utils/getters-proxy.utils';\nimport { ExtractState, XModuleName } from '../x-modules/x-modules.types';\nimport { Wiring } from './wiring.types';\n\n/**\n * Util function to generate type-safe wiring.\n * If TypeScript ever accepts the PR about generic type inference this function can be removed.\n *\n * @param wiring - The wiring to create.\n * @returns Type-safe wiring.\n *\n * @public\n */\nexport function createWiring<T extends Partial<Wiring>>(wiring: T): T {\n  return wiring;\n}\n\n/**\n * Returns an object with the getters and state of a module of store defined by the moduleName\n * parameter.\n *\n * @param state - The Vuex store State.\n * @param getters - The Vuex store Getters.\n * @param moduleName - The {@link XModuleName} of the module.\n * @returns The {@link StoreModuleStateAndGetters} with the Getters and the State of the\n * {@link XStoreModule | Store Module} defined by moduleName.\n *\n * @public\n */\nexport function getStateAndGettersFromModule<ModuleName extends XModuleName>(\n  state: RootXStoreState,\n  getters: Dictionary,\n  moduleName: ModuleName\n): StoreModuleStateAndGetters<ModuleName> {\n  return {\n    state: state.x[moduleName] as unknown as ExtractState<ModuleName>,\n    getters: getGettersProxy(getters, moduleName)\n  };\n}\n"],"names":[],"mappings":";;AAMA;;;;;;;;AAQG;AACG,SAAU,YAAY,CAA4B,MAAS,EAAA;AAC/D,IAAA,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;AAWG;SACa,4BAA4B,CAC1C,KAAsB,EACtB,OAAmB,EACnB,UAAsB,EAAA;IAEtB,OAAO;AACL,QAAA,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,UAAU,CAAwC;AACjE,QAAA,OAAO,EAAE,eAAe,CAAC,OAAO,EAAE,UAAU,CAAC;KAC9C,CAAC;AACJ;;;;"}
+{"version":3,"file":"wiring.utils.js","sources":["../../../src/wiring/wiring.utils.ts"],"sourcesContent":["import type { Dictionary } from '@empathyco/x-utils'\nimport type { RootXStoreState, StoreModuleStateAndGetters } from '../store/store.types'\nimport type { ExtractState, XModuleName } from '../x-modules/x-modules.types'\nimport type { Wiring } from './wiring.types'\nimport { getGettersProxy } from '../store/utils/getters-proxy.utils'\n\n/**\n * Util function to generate type-safe wiring.\n * If TypeScript ever accepts the PR about generic type inference this function can be removed.\n *\n * @param wiring - The wiring to create.\n * @returns Type-safe wiring.\n *\n * @public\n */\nexport function createWiring<T extends Partial<Wiring>>(wiring: T): T {\n  return wiring\n}\n\n/**\n * Returns an object with the getters and state of a module of store defined by the moduleName\n * parameter.\n *\n * @param state - The Vuex store State.\n * @param getters - The Vuex store Getters.\n * @param moduleName - The {@link XModuleName} of the module.\n * @returns The {@link StoreModuleStateAndGetters} with the Getters and the State of the\n * {@link XStoreModule | Store Module} defined by moduleName.\n *\n * @public\n */\nexport function getStateAndGettersFromModule<ModuleName extends XModuleName>(\n  state: RootXStoreState,\n  getters: Dictionary,\n  moduleName: ModuleName,\n): StoreModuleStateAndGetters<ModuleName> {\n  return {\n    state: state.x[moduleName] as unknown as ExtractState<ModuleName>,\n    getters: getGettersProxy(getters, moduleName),\n  }\n}\n"],"names":[],"mappings":";;AAMA;;;;;;;;AAQG;AACG,SAAU,YAAY,CAA4B,MAAS,EAAA;AAC/D,IAAA,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;;;;;;;;AAWG;SACa,4BAA4B,CAC1C,KAAsB,EACtB,OAAmB,EACnB,UAAsB,EAAA;IAEtB,OAAO;AACL,QAAA,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,UAAU,CAAwC;AACjE,QAAA,OAAO,EAAE,eAAe,CAAC,OAAO,EAAE,UAAU,CAAC;KAC9C,CAAA;AACH;;;;"}

package/js/x-bus/x-bus.js

@@ -0,0 +1,181 @@
+import { ReplaySubject } from 'rxjs';
+import { map } from 'rxjs/operators';
+import { BaseXPriorityQueue } from './x-priority-queue/x-priority-queue.js';
+
+/**
+ * A default {@link XBus} implementation using a
+ * {@link XPriorityQueue | priority queue} as its data structure to
+ * prioritise the emission of events. The priorities are preconfigured based on event naming.
+ *
+ * @public
+ */
+class XPriorityBus {
+    /**
+     * Creates a new instance of a {@link XPriorityBus}.
+     *
+     * @param config - A configuration object to initialise the bus.
+     * - param config.queue - A {@link XPriorityQueue | priority queue} to store the events.
+     * - param config.priorities - A Dictionary defining the priorities associated to a given string.
+     * - param config.emitCallbacks - A list of functions to execute when an event is emitted.
+     * - param config.defaultEventPriority - A default priority to assigned to an event.
+     */
+    constructor(config = {}) {
+        /**
+         * A dictionary to store the created event emitters.
+         *
+         * @internal
+         */
+        this.emitters = {};
+        /**
+         * A list of pending pop operations timeout identifiers.
+         *
+         * @internal
+         */
+        this.pendingPopsIds = [];
+        this.queue =
+            config.queue ??
+                new BaseXPriorityQueue();
+        this.priorities = config.priorities ?? {};
+        this.emitCallbacks = config.emitCallbacks ?? [];
+        this.defaultEventPriority = config.defaultEventPriority ?? Number.MIN_SAFE_INTEGER;
+    }
+    /**
+     * Emits an event. See {@link XBus.emit}.
+     *
+     * @param event - Event to be emitted.
+     * @param payload - Event payload.
+     * @param metadata - Extra event data.
+     *
+     * @returns A promise that is resolved the moment the event is emitted.
+     */
+    // eslint-disable-next-line ts/promise-function-async
+    emit(event, 
+    // TODO: Fix optional argument.
+    payload, metadata = {}) {
+        return new Promise(resolve => {
+            this.queue.push(event, this.getEventPriority(event, metadata), {
+                // This type assertion is done because payload is optional.
+                eventPayload: payload,
+                eventMetadata: metadata,
+                replaceable: metadata.replaceable || false,
+                // @ts-expect-error TODO: Fix type.
+                resolve,
+            });
+            this.flushQueue();
+        });
+    }
+    /**.
+     * Retrieves the event priority based on:
+     * - the defined event metadata priority
+     * - the priority associated to the matching preconfigured priority key
+     * - the configured {@link XPriorityBus.defaultEventPriority | defaultEventPriority} is assigned (by default, the min safe integer).
+     *
+     * @param event - The event to get the priority from.
+     * @param metadata - The event metadata.
+     *
+     * @returns The priority for the given event.
+     *
+     * @internal
+     */
+    getEventPriority(event, metadata) {
+        if (metadata.priority != null) {
+            return metadata.priority;
+        }
+        const matchingKey = Object.keys(this.priorities).find(key => String(event).includes(key));
+        if (matchingKey) {
+            return this.priorities[matchingKey];
+        }
+        return this.defaultEventPriority;
+    }
+    /**
+     * Processes the events stored in the
+     * {@link XPriorityQueue | priority queue} and resolves each event
+     * whenever it is emitted.
+     *
+     * @remarks If another 'flushQueue' operation is running, it is discarded and a new one is
+     * executed. The pending popping operations are also discarded.
+     *
+     * @internal
+     */
+    flushQueue() {
+        clearTimeout(this.pendingFlushId);
+        this.clearPendingPopsIds();
+        this.pendingFlushId = window.setTimeout(() => {
+            for (let i = 0; i < this.queue.size(); ++i) {
+                const popTimeoutId = window.setTimeout(() => {
+                    const { key, data: { eventPayload, eventMetadata, resolve }, } = this.queue.pop();
+                    const emitter = this.getEmitter(key);
+                    const payloadObj = {
+                        eventPayload,
+                        metadata: eventMetadata,
+                    };
+                    emitter.next(payloadObj);
+                    this.emitCallbacks.forEach(callback => {
+                        callback(key, payloadObj);
+                    });
+                    resolve({ event: key, ...payloadObj });
+                    this.pendingPopsIds = this.pendingPopsIds.filter(timeoutId => timeoutId !== popTimeoutId);
+                });
+                this.pendingPopsIds.push(popTimeoutId);
+            }
+        });
+    }
+    /**
+     * Discards existing pending pop operations and empties the array.
+     *
+     * @internal
+     */
+    clearPendingPopsIds() {
+        this.pendingPopsIds.forEach(clearTimeout);
+        this.pendingPopsIds.length = 0;
+    }
+    /**
+     * Retrieves an observable for the event. See {@link XBus.on}.
+     *
+     * @param event - Event to retrieve the observable for.
+     * @param withMetadata - Option to retrieve an observable with extra data about the event.
+     *
+     * @returns The emitter for the event passed.
+     */
+    on(event, withMetadata = false) {
+        // TODO: This type should work, but inference isn't working as expected. Check when updating ts.
+        return withMetadata
+            ? // @ts-expect-error Type is not assignable to type EventPayload<SomeEvents, SomeEvent
+                this.getEmitter(event).asObservable()
+            : this.getEmitter(event).pipe(map(
+            // eslint-disable-next-line ts/no-unsafe-return
+            value => value.eventPayload));
+    }
+    /**
+     * Retrieves an event {@link Emitter} for the given event.
+     *
+     * @param event - The event to retrieve the {@link Emitter} for.
+     *
+     * @returns The {@link Emitters} for the passed event.
+     *
+     * @internal
+     */
+    getEmitter(event) {
+        if (!this.emitters[event]) {
+            this.createEmitter(event);
+        }
+        return this.emitters[event];
+    }
+    /**
+     * Creates an event {@link Emitter} for the given event.
+     *
+     * @remarks The emitter is implemented with a
+     * {@Link https://www.learnrxjs.io/learn-rxjs/subjects/replaysubject | ReplaySubject} to allow any
+     * new subscriber receive the last emitted value.
+     *
+     * @param event - The event to create the {@link Emitter} for.
+     *
+     * @internal
+     */
+    createEmitter(event) {
+        this.emitters[event] = new ReplaySubject(1);
+    }
+}
+
+export { XPriorityBus };
+//# sourceMappingURL=x-bus.js.map

package/js/x-bus/x-bus.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"x-bus.js","sources":["../../../src/x-bus/x-bus.ts"],"sourcesContent":["import type { AnyFunction, Dictionary } from '@empathyco/x-utils'\nimport type { Observable } from 'rxjs'\nimport type {\n  EmittedData,\n  Emitter,\n  Emitters,\n  EventPayload,\n  Priority,\n  SubjectPayload,\n  XBus,\n  XPriorityBusEventMetadata,\n  XPriorityQueueNodeData,\n} from './x-bus.types'\nimport type { XPriorityQueue } from './x-priority-queue'\nimport { ReplaySubject } from 'rxjs'\nimport { map } from 'rxjs/operators'\nimport { BaseXPriorityQueue } from './x-priority-queue'\n\n/**\n * A default {@link XBus} implementation using a\n * {@link XPriorityQueue | priority queue} as its data structure to\n * prioritise the emission of events. The priorities are preconfigured based on event naming.\n *\n * @public\n */\nexport class XPriorityBus<\n  SomeEvents extends Dictionary,\n  SomeEventMetadata extends XPriorityBusEventMetadata,\n> implements XBus<SomeEvents, SomeEventMetadata>\n{\n  /**\n   * A {@link XPriorityQueue | priority queue} to store the events to\n   * emit.\n   *\n   * @internal\n   */\n  protected queue: XPriorityQueue<SomeEvents, XPriorityQueueNodeData<SomeEvents, SomeEventMetadata>>\n\n  /**\n   * A dictionary associating a priority to a key.\n   *\n   * @example\n   * ```ts\n   * const priorities: Dictionary<number> = {\n   *   '^StartsWith': 2,\n   *   Contains: 4,\n   *   EndWith$: 8\n   * }\n   * ```\n   *\n   * @internal\n   */\n  protected priorities: Dictionary<Priority>\n\n  /**\n   * The default value to use as priority for an event that doesn't have defined neither a custom\n   * priority nor its name doesn't match any key of the {@link XPriorityBus.priorities | priorities} dictionary.\n   *\n   * @internal\n   */\n  protected defaultEventPriority: number\n\n  /**\n   * A list of functions to execute when an event is emitted.\n   *\n   * @internal\n   */\n  protected emitCallbacks: AnyFunction[]\n\n  /**\n   * A dictionary to store the created event emitters.\n   *\n   * @internal\n   */\n  protected emitters: Emitters<SomeEvents, SomeEventMetadata> = {}\n\n  /**\n   * A pending flush operation timeout identifier or undefined if there's none pending.\n   *\n   * @internal\n   */\n  protected pendingFlushId?: number\n\n  /**\n   * A list of pending pop operations timeout identifiers.\n   *\n   * @internal\n   */\n  protected pendingPopsIds: number[] = []\n\n  /**\n   * Creates a new instance of a {@link XPriorityBus}.\n   *\n   * @param config - A configuration object to initialise the bus.\n   * - param config.queue - A {@link XPriorityQueue | priority queue} to store the events.\n   * - param config.priorities - A Dictionary defining the priorities associated to a given string.\n   * - param config.emitCallbacks - A list of functions to execute when an event is emitted.\n   * - param config.defaultEventPriority - A default priority to assigned to an event.\n   */\n  public constructor(\n    config: {\n      queue?: XPriorityQueue<SomeEvents, XPriorityQueueNodeData<SomeEvents, SomeEventMetadata>>\n      priorities?: Dictionary<number>\n      emitCallbacks?: AnyFunction[]\n      defaultEventPriority?: number\n    } = {},\n  ) {\n    this.queue =\n      config.queue ??\n      new BaseXPriorityQueue<SomeEvents, XPriorityQueueNodeData<SomeEvents, SomeEventMetadata>>()\n    this.priorities = config.priorities ?? {}\n    this.emitCallbacks = config.emitCallbacks ?? []\n    this.defaultEventPriority = config.defaultEventPriority ?? Number.MIN_SAFE_INTEGER\n  }\n\n  /**\n   * Emits an event. See {@link XBus.emit}.\n   *\n   * @param event - Event to be emitted.\n   * @param payload - Event payload.\n   * @param metadata - Extra event data.\n   *\n   * @returns A promise that is resolved the moment the event is emitted.\n   */\n  // eslint-disable-next-line ts/promise-function-async\n  emit<SomeEvent extends keyof SomeEvents>(\n    event: SomeEvent,\n    // TODO: Fix optional argument.\n    payload?: EventPayload<SomeEvents, SomeEvent>,\n    metadata = {} as SomeEventMetadata,\n  ): Promise<EmittedData<SomeEvents, SomeEvent, SomeEventMetadata>> {\n    return new Promise(resolve => {\n      this.queue.push(event, this.getEventPriority(event, metadata), {\n        // This type assertion is done because payload is optional.\n        eventPayload: payload as EventPayload<SomeEvents, SomeEvent>,\n        eventMetadata: metadata,\n        replaceable: metadata.replaceable || false,\n        // @ts-expect-error TODO: Fix type.\n        resolve,\n      })\n\n      this.flushQueue()\n    })\n  }\n\n  /**.\n   * Retrieves the event priority based on:\n   * - the defined event metadata priority\n   * - the priority associated to the matching preconfigured priority key\n   * - the configured {@link XPriorityBus.defaultEventPriority | defaultEventPriority} is assigned (by default, the min safe integer).\n   *\n   * @param event - The event to get the priority from.\n   * @param metadata - The event metadata.\n   *\n   * @returns The priority for the given event.\n   *\n   * @internal\n   */\n  protected getEventPriority(event: keyof SomeEvents, metadata: SomeEventMetadata): Priority {\n    if (metadata.priority != null) {\n      return metadata.priority\n    }\n\n    const matchingKey = Object.keys(this.priorities).find(key => String(event).includes(key))\n    if (matchingKey) {\n      return this.priorities[matchingKey]\n    }\n\n    return this.defaultEventPriority\n  }\n\n  /**\n   * Processes the events stored in the\n   * {@link XPriorityQueue | priority queue} and resolves each event\n   * whenever it is emitted.\n   *\n   * @remarks If another 'flushQueue' operation is running, it is discarded and a new one is\n   * executed. The pending popping operations are also discarded.\n   *\n   * @internal\n   */\n  protected flushQueue(): void {\n    clearTimeout(this.pendingFlushId)\n    this.clearPendingPopsIds()\n\n    this.pendingFlushId = window.setTimeout(() => {\n      for (let i = 0; i < this.queue.size(); ++i) {\n        const popTimeoutId = window.setTimeout(() => {\n          const {\n            key,\n            data: { eventPayload, eventMetadata, resolve },\n          } = this.queue.pop()!\n          const emitter = this.getEmitter(key)\n          const payloadObj = {\n            eventPayload,\n            metadata: eventMetadata,\n          }\n\n          emitter.next(payloadObj)\n\n          this.emitCallbacks.forEach(callback => {\n            callback(key, payloadObj)\n          })\n          resolve({ event: key, ...payloadObj })\n\n          this.pendingPopsIds = this.pendingPopsIds.filter(timeoutId => timeoutId !== popTimeoutId)\n        })\n\n        this.pendingPopsIds.push(popTimeoutId)\n      }\n    })\n  }\n\n  /**\n   * Discards existing pending pop operations and empties the array.\n   *\n   * @internal\n   */\n  private clearPendingPopsIds(): void {\n    this.pendingPopsIds.forEach(clearTimeout)\n    this.pendingPopsIds.length = 0\n  }\n\n  /**\n   * Retrieves an observable for the event. See {@link XBus.on}.\n   *\n   * @param event - Event to retrieve the observable for.\n   * @param withMetadata - Option to retrieve an observable with extra data about the event.\n   *\n   * @returns The emitter for the event passed.\n   */\n  on<SomeEvent extends keyof SomeEvents>(\n    event: SomeEvent,\n    withMetadata = false,\n  ): typeof withMetadata extends true\n    ? Observable<SubjectPayload<EventPayload<SomeEvents, SomeEvent>, SomeEventMetadata>>\n    : Observable<EventPayload<SomeEvents, SomeEvent>> {\n    // TODO: This type should work, but inference isn't working as expected. Check when updating ts.\n    return withMetadata\n      ? // @ts-expect-error Type is not assignable to type EventPayload<SomeEvents, SomeEvent\n        this.getEmitter(event).asObservable()\n      : this.getEmitter(event).pipe(\n          map<\n            SubjectPayload<EventPayload<SomeEvents, SomeEvent>, SomeEventMetadata>,\n            EventPayload<SomeEvents, SomeEvent>\n          >(\n            // eslint-disable-next-line ts/no-unsafe-return\n            value => value.eventPayload,\n          ),\n        )\n  }\n\n  /**\n   * Retrieves an event {@link Emitter} for the given event.\n   *\n   * @param event - The event to retrieve the {@link Emitter} for.\n   *\n   * @returns The {@link Emitters} for the passed event.\n   *\n   * @internal\n   */\n  protected getEmitter<SomeEvent extends keyof SomeEvents>(\n    event: SomeEvent,\n  ): Emitter<SomeEvents, SomeEvent, SomeEventMetadata> {\n    if (!this.emitters[event]) {\n      this.createEmitter(event)\n    }\n\n    return this.emitters[event]!\n  }\n\n  /**\n   * Creates an event {@link Emitter} for the given event.\n   *\n   * @remarks The emitter is implemented with a\n   * {@Link https://www.learnrxjs.io/learn-rxjs/subjects/replaysubject | ReplaySubject} to allow any\n   * new subscriber receive the last emitted value.\n   *\n   * @param event - The event to create the {@link Emitter} for.\n   *\n   * @internal\n   */\n  protected createEmitter<SomeEvent extends keyof SomeEvents>(event: SomeEvent): void {\n    this.emitters[event] = new ReplaySubject<\n      SubjectPayload<EventPayload<SomeEvents, SomeEvent>, SomeEventMetadata>\n    >(1)\n  }\n}\n"],"names":[],"mappings":";;;;AAkBA;;;;;;AAMG;MACU,YAAY,CAAA;AAiEvB;;;;;;;;AAQG;AACH,IAAA,WAAA,CACE,SAKI,EAAE,EAAA;AApCR;;;;AAIG;QACO,IAAQ,CAAA,QAAA,GAA4C,EAAE,CAAA;AAShE;;;;AAIG;QACO,IAAc,CAAA,cAAA,GAAa,EAAE,CAAA;AAmBrC,QAAA,IAAI,CAAC,KAAK;AACR,YAAA,MAAM,CAAC,KAAK;gBACZ,IAAI,kBAAkB,EAAqE,CAAA;QAC7F,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,IAAI,EAAE,CAAA;QACzC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,IAAI,EAAE,CAAA;QAC/C,IAAI,CAAC,oBAAoB,GAAG,MAAM,CAAC,oBAAoB,IAAI,MAAM,CAAC,gBAAgB,CAAA;KACnF;AAED;;;;;;;;AAQG;;AAEH,IAAA,IAAI,CACF,KAAgB;;IAEhB,OAA6C,EAC7C,WAAW,EAAuB,EAAA;AAElC,QAAA,OAAO,IAAI,OAAO,CAAC,OAAO,IAAG;AAC3B,YAAA,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE;;AAE7D,gBAAA,YAAY,EAAE,OAA8C;AAC5D,gBAAA,aAAa,EAAE,QAAQ;AACvB,gBAAA,WAAW,EAAE,QAAQ,CAAC,WAAW,IAAI,KAAK;;gBAE1C,OAAO;AACR,aAAA,CAAC,CAAA;YAEF,IAAI,CAAC,UAAU,EAAE,CAAA;AACnB,SAAC,CAAC,CAAA;KACH;AAED;;;;;;;;;;;;AAYG;IACO,gBAAgB,CAAC,KAAuB,EAAE,QAA2B,EAAA;AAC7E,QAAA,IAAI,QAAQ,CAAC,QAAQ,IAAI,IAAI,EAAE;YAC7B,OAAO,QAAQ,CAAC,QAAQ,CAAA;SACzB;QAED,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAA;QACzF,IAAI,WAAW,EAAE;AACf,YAAA,OAAO,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAA;SACpC;QAED,OAAO,IAAI,CAAC,oBAAoB,CAAA;KACjC;AAED;;;;;;;;;AASG;IACO,UAAU,GAAA;AAClB,QAAA,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;QACjC,IAAI,CAAC,mBAAmB,EAAE,CAAA;QAE1B,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,UAAU,CAAC,MAAK;AAC3C,YAAA,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,EAAE;AAC1C,gBAAA,MAAM,YAAY,GAAG,MAAM,CAAC,UAAU,CAAC,MAAK;oBAC1C,MAAM,EACJ,GAAG,EACH,IAAI,EAAE,EAAE,YAAY,EAAE,aAAa,EAAE,OAAO,EAAE,GAC/C,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,EAAG,CAAA;oBACrB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;AACpC,oBAAA,MAAM,UAAU,GAAG;wBACjB,YAAY;AACZ,wBAAA,QAAQ,EAAE,aAAa;qBACxB,CAAA;AAED,oBAAA,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;AAExB,oBAAA,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,QAAQ,IAAG;AACpC,wBAAA,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC,CAAA;AAC3B,qBAAC,CAAC,CAAA;oBACF,OAAO,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,UAAU,EAAE,CAAC,CAAA;AAEtC,oBAAA,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,SAAS,IAAI,SAAS,KAAK,YAAY,CAAC,CAAA;AAC3F,iBAAC,CAAC,CAAA;AAEF,gBAAA,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;aACvC;AACH,SAAC,CAAC,CAAA;KACH;AAED;;;;AAIG;IACK,mBAAmB,GAAA;AACzB,QAAA,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;AACzC,QAAA,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAA;KAC/B;AAED;;;;;;;AAOG;AACH,IAAA,EAAE,CACA,KAAgB,EAChB,YAAY,GAAG,KAAK,EAAA;;AAKpB,QAAA,OAAO,YAAY;AACjB;AACE,gBAAA,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,YAAY,EAAE;cACrC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,CACzB,GAAG;;YAKD,KAAK,IAAI,KAAK,CAAC,YAAY,CAC5B,CACF,CAAA;KACN;AAED;;;;;;;;AAQG;AACO,IAAA,UAAU,CAClB,KAAgB,EAAA;QAEhB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;AACzB,YAAA,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;SAC1B;AAED,QAAA,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAE,CAAA;KAC7B;AAED;;;;;;;;;;AAUG;AACO,IAAA,aAAa,CAAqC,KAAgB,EAAA;QAC1E,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,IAAI,aAAa,CAEtC,CAAC,CAAC,CAAA;KACL;AACF;;;;"}