@genesislcap/foundation-events 14.241.0 → 14.242.0

package/dist/dts/eventEmitter/emitterFunction.d.ts

@@ -0,0 +1,56 @@
+import { EmitOptions, EventDetailMap } from '../types';
+/**
+ * emitter function.
+ *
+ * This is the functional equivalent of the strongly typed `.emit` function created with the {@link EventEmitter} mixin.
+ *
+ * @public
+ *
+ * @remarks
+ * This is useful if you need to emit an event from an arbitrary location. For example, if you want to emit an event
+ * from a button on a custom grid cell renderer you can use this to get strong typing rather than having to dependency
+ * inject a reference to the class which uses the {@link EventEmitter} mixin multiple levels into the renderer.
+ *
+ * @example
+ * Apply mixin to the base {@link @microsoft/fast-element#FASTElement | FASTElement}
+ *
+ * # Import
+ * ```ts
+ * import { emitter, SomeSystemLevelEventDetailMap } from '@genesislcap/foundation-events';
+ * import { StoreEventDetailMap, TradeEntryEventDetailMap } from '../store'; // < custom app level event maps
+ * ```
+ *
+ * # Create event map
+ * ```ts
+ * type EventMap = SomeSystemLevelEventDetailMap & StoreEventDetailMap & TradeEntryEventDetailMap;
+ * ```
+ *
+ * # Use the functional emitter. For example in a custom button action on a grid cell
+ * ```ts
+ * const customAction = {
+ *   name: `<rapid-button name="download" size="lg"></rapid-button>`
+ *   callback: (button: HTMLElement, data: RowData) =>
+ *     emitter<EventMap>().emit(
+ *       button,
+ *       'some-allowed-event',
+ *       { foo: 'expected data structure' },
+ *    ),
+ * }
+ * ```
+ *
+ * @privateRemarks
+ * The reason it's a function which returns an object with another function is to create the best developer ergonomics
+ * accounting for TypeScript. This setup allows you to only set one type parameter to control the strong typing, if we
+ * were to add it all onto the same function you'd either have to specify multiple type parameters (repeating yourself)
+ * or if we used implicits it wouldn't type check the payload against the type correctly.
+ *
+ * @typeParam TEventDetailMap - The {@link EventDetailMap}.
+ * @param orign - the `HTMLElement` to dispatch the event from. Ensure this correctly relates to the component you've attatched the corresponding event listener to.
+ * @param type - the key in `TEventDetailMap` which is the event name from the detail map
+ * @param detail - *optional* param `TEventDetailMap[K]` which is the payload corresponding to the event `type`
+ * @param options - *optional* param {@link EmitOptions} to set event options. Default `{ composed: true, bubbles: true, cancelable: true, }`
+ */
+export declare const emitter: <TEventDetailMap extends EventDetailMap>() => {
+    emit: <K extends keyof TEventDetailMap>(...args: TEventDetailMap[K] extends void ? [origin: HTMLElement, type: K, options?: EmitOptions] : [origin: HTMLElement, type: K, detail: TEventDetailMap[K], options?: EmitOptions]) => void;
+};
+//# sourceMappingURL=emitterFunction.d.ts.map

package/dist/dts/eventEmitter/emitterFunction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"emitterFunction.d.ts","sourceRoot":"","sources":["../../../src/eventEmitter/emitterFunction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,cAAc,EAAiB,MAAM,UAAU,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,eAAO,MAAM,OAAO;qOAKf,IAAI;CAuBP,CAAC"}

package/dist/dts/eventEmitter/index.d.ts

@@ -1,3 +1,4 @@
+export * from './emitterFunction';
 export * from './eventEmitterDI';
 export * from './eventEmitterMixin';
 //# sourceMappingURL=index.d.ts.map

package/dist/dts/eventEmitter/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/eventEmitter/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/eventEmitter/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC"}

package/dist/dts/types.d.ts

@@ -42,6 +42,10 @@ export interface TypedEmitter<TEventDetailMap extends EventDetailMap> {
 export type CustomEventMap<TEventDetailMap extends EventDetailMap> = {
     [K in keyof TEventDetailMap]: CustomEvent<TEventDetailMap[K]>;
 };
+/**
+ * @public
+ */
+export declare const isEmitOptions: (candidate: EmitOptions | any) => boolean;
 /**
  * @public
  */

package/dist/dts/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAGhG;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,KAAK,SAAS,WAAW,IAAI,QAAQ,MAAM,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,KAAK,CAAC;AAEnG;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG,aAAa,CAAC,WAAW,GAAG,WAAW,CAAC,CAAC;AAEtF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,IAAI,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,EAAE,GAAG,SAAS,EAAE,WAAW,GAAG,SAAS,CAAC,CAAC;AAEzE;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,WAAW,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,eAAe,SAAS,cAAc;IAClE,KAAK,CAAC,CAAC,SAAS,MAAM,eAAe,GAAG,MAAM,EAC5C,GAAG,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GACpC,CAAC,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,GAChC,CAAC,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,GAC/D,UAAU,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,eAAe,SAAS,cAAc,IAAI;KAClE,CAAC,IAAI,MAAM,eAAe,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;CAC9D,CAAC;AAUF;;GAEG;AACH,eAAO,MAAM,eAAe,YAAa,OAAO,EAAE,aAWjD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,6BAA8B,gBAAgB,8BAC9B,CAAC;AAEzC;;GAEG;AACH,KAAK,WAAW,GAAG,CAAC,GAAG,EAAE,gBAAgB,KAAK,GAAG,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,WAAwE,CAAC;AAEnG;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,EAAE,WACO,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,wBAAwB,EAAE,WACmB,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK;CAAE,CAAC,MAAM,CAAC,CAAC,CAAC;AAW3F;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,kBAAkB,qHAnBwC,WAAW,KAAG,OAoBlC,CAAC;AAEpD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,mBAAmB,qHArCuC,WAAW,KAAG,OAsCrB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAGhG;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,KAAK,SAAS,WAAW,IAAI,QAAQ,MAAM,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,KAAK,CAAC;AAEnG;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG,aAAa,CAAC,WAAW,GAAG,WAAW,CAAC,CAAC;AAEtF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,IAAI,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,EAAE,GAAG,SAAS,EAAE,WAAW,GAAG,SAAS,CAAC,CAAC;AAEzE;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,WAAW,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,eAAe,SAAS,cAAc;IAClE,KAAK,CAAC,CAAC,SAAS,MAAM,eAAe,GAAG,MAAM,EAC5C,GAAG,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GACpC,CAAC,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,GAChC,CAAC,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC,GAC/D,UAAU,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,eAAe,SAAS,cAAc,IAAI;KAClE,CAAC,IAAI,MAAM,eAAe,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;CAC9D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa,cAAe,WAAW,GAAG,GAAG,KAAG,OAGtB,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,eAAe,YAAa,OAAO,EAAE,aAWjD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,6BAA8B,gBAAgB,8BAC9B,CAAC;AAEzC;;GAEG;AACH,KAAK,WAAW,GAAG,CAAC,GAAG,EAAE,gBAAgB,KAAK,GAAG,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,WAAwE,CAAC;AAEnG;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,EAAE,WACO,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,wBAAwB,EAAE,WACmB,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK;CAAE,CAAC,MAAM,CAAC,CAAC,CAAC;AAW3F;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,kBAAkB,qHAnBwC,WAAW,KAAG,OAoBlC,CAAC;AAEpD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,mBAAmB,qHArCuC,WAAW,KAAG,OAsCrB,CAAC"}

package/dist/esm/eventEmitter/emitterFunction.js

@@ -0,0 +1,76 @@
+import { isEmitOptions } from '../types';
+/**
+ * emitter function.
+ *
+ * This is the functional equivalent of the strongly typed `.emit` function created with the {@link EventEmitter} mixin.
+ *
+ * @public
+ *
+ * @remarks
+ * This is useful if you need to emit an event from an arbitrary location. For example, if you want to emit an event
+ * from a button on a custom grid cell renderer you can use this to get strong typing rather than having to dependency
+ * inject a reference to the class which uses the {@link EventEmitter} mixin multiple levels into the renderer.
+ *
+ * @example
+ * Apply mixin to the base {@link @microsoft/fast-element#FASTElement | FASTElement}
+ *
+ * # Import
+ * ```ts
+ * import { emitter, SomeSystemLevelEventDetailMap } from '@genesislcap/foundation-events';
+ * import { StoreEventDetailMap, TradeEntryEventDetailMap } from '../store'; // < custom app level event maps
+ * ```
+ *
+ * # Create event map
+ * ```ts
+ * type EventMap = SomeSystemLevelEventDetailMap & StoreEventDetailMap & TradeEntryEventDetailMap;
+ * ```
+ *
+ * # Use the functional emitter. For example in a custom button action on a grid cell
+ * ```ts
+ * const customAction = {
+ *   name: `<rapid-button name="download" size="lg"></rapid-button>`
+ *   callback: (button: HTMLElement, data: RowData) =>
+ *     emitter<EventMap>().emit(
+ *       button,
+ *       'some-allowed-event',
+ *       { foo: 'expected data structure' },
+ *    ),
+ * }
+ * ```
+ *
+ * @privateRemarks
+ * The reason it's a function which returns an object with another function is to create the best developer ergonomics
+ * accounting for TypeScript. This setup allows you to only set one type parameter to control the strong typing, if we
+ * were to add it all onto the same function you'd either have to specify multiple type parameters (repeating yourself)
+ * or if we used implicits it wouldn't type check the payload against the type correctly.
+ *
+ * @typeParam TEventDetailMap - The {@link EventDetailMap}.
+ * @param orign - the `HTMLElement` to dispatch the event from. Ensure this correctly relates to the component you've attatched the corresponding event listener to.
+ * @param type - the key in `TEventDetailMap` which is the event name from the detail map
+ * @param detail - *optional* param `TEventDetailMap[K]` which is the payload corresponding to the event `type`
+ * @param options - *optional* param {@link EmitOptions} to set event options. Default `{ composed: true, bubbles: true, cancelable: true, }`
+ */
+export const emitter = () => ({
+    emit: (...args) => {
+        const baseOpts = {
+            composed: true,
+            bubbles: true,
+            cancelable: true,
+        };
+        const [origin, type, detailOrOpts, maybeOpts] = args;
+        if (maybeOpts) {
+            origin.dispatchEvent(new CustomEvent(type.toString(), Object.assign({ detail: detailOrOpts }, maybeOpts)));
+        }
+        else {
+            if (typeIsEmitOptions(detailOrOpts)) {
+                origin.dispatchEvent(new CustomEvent(type.toString(), detailOrOpts));
+            }
+            else {
+                origin.dispatchEvent(new CustomEvent(type.toString(), Object.assign({ detail: detailOrOpts }, baseOpts)));
+            }
+        }
+    },
+});
+function typeIsEmitOptions(p) {
+    return typeof p === 'object' && isEmitOptions(p);
+}

package/dist/esm/eventEmitter/index.js

@@ -1,2 +1,3 @@
+export * from './emitterFunction';
 export * from './eventEmitterDI';
 export * from './eventEmitterMixin';

package/dist/esm/types.js

@@ -1,7 +1,7 @@
 /**
  * @public
  */
-const isEmitOptions = (candidate) => (candidate === null || candidate === void 0 ? void 0 : candidate.hasOwnProperty('bubbles')) ||
+export const isEmitOptions = (candidate) => (candidate === null || candidate === void 0 ? void 0 : candidate.hasOwnProperty('bubbles')) ||
     (candidate === null || candidate === void 0 ? void 0 : candidate.hasOwnProperty('cancelable')) ||
     (candidate === null || candidate === void 0 ? void 0 : candidate.hasOwnProperty('composed'));
 /**

package/dist/foundation-events.api.json

@@ -722,6 +722,74 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-events!emitter:var",
+          "docComment": "/**\n * emitter function.\n *\n * This is the functional equivalent of the strongly typed `.emit` function created with the {@link EventEmitter} mixin.\n *\n * @remarks\n *\n * This is useful if you need to emit an event from an arbitrary location. For example, if you want to emit an event from a button on a custom grid cell renderer you can use this to get strong typing rather than having to dependency inject a reference to the class which uses the {@link EventEmitter} mixin multiple levels into the renderer.\n *\n * @param orign - the `HTMLElement` to dispatch the event from. Ensure this correctly relates to the component you've attatched the corresponding event listener to.\n *\n * @param type - the key in `TEventDetailMap` which is the event name from the detail map\n *\n * @param detail - *optional* param `TEventDetailMap[K]` which is the payload corresponding to the event `type`\n *\n * @param options - *optional* param {@link EmitOptions} to set event options. Default `{ composed: true, bubbles: true, cancelable: true, }`\n *\n * @typeParam TEventDetailMap - The {@link EventDetailMap}.\n *\n * @example\n *\n * Apply mixin to the base {@link @microsoft/fast-element#FASTElement | FASTElement}\n *\n * # Import\n * ```ts\n * import { emitter, SomeSystemLevelEventDetailMap } from '@genesislcap/foundation-events';\n * import { StoreEventDetailMap, TradeEntryEventDetailMap } from '../store'; // < custom app level event maps\n * ```\n *\n * # Create event map\n * ```ts\n * type EventMap = SomeSystemLevelEventDetailMap & StoreEventDetailMap & TradeEntryEventDetailMap;\n * ```\n *\n * # Use the functional emitter. For example in a custom button action on a grid cell\n * ```ts\n * const customAction = {\n *   name: `<rapid-button name=\"download\" size=\"lg\"></rapid-button>`\n *   callback: (button: HTMLElement, data: RowData) =>\n *     emitter<EventMap>().emit(\n *       button,\n *       'some-allowed-event',\n *       { foo: 'expected data structure' },\n *    ),\n * }\n * ```\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "emitter: "
+            },
+            {
+              "kind": "Content",
+              "text": "<TEventDetailMap extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "EventDetailMap",
+              "canonicalReference": "@genesislcap/foundation-events!EventDetailMap:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">() => {\n    emit: <K extends keyof TEventDetailMap>(...args: TEventDetailMap[K] extends void ? [origin: "
+            },
+            {
+              "kind": "Reference",
+              "text": "HTMLElement",
+              "canonicalReference": "!HTMLElement:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", type: K, options?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "EmitOptions",
+              "canonicalReference": "@genesislcap/foundation-events!EmitOptions:type"
+            },
+            {
+              "kind": "Content",
+              "text": "] : [origin: "
+            },
+            {
+              "kind": "Reference",
+              "text": "HTMLElement",
+              "canonicalReference": "!HTMLElement:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", type: K, detail: TEventDetailMap[K], options?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "EmitOptions",
+              "canonicalReference": "@genesislcap/foundation-events!EmitOptions:type"
+            },
+            {
+              "kind": "Content",
+              "text": "]) => void;\n}"
+            }
+          ],
+          "fileUrlPath": "src/eventEmitter/emitterFunction.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "emitter",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 12
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-events!EventDetailMap:type",
@@ -3911,6 +3979,38 @@
             "endIndex": 3
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-events!isEmitOptions:var",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "isEmitOptions: "
+            },
+            {
+              "kind": "Content",
+              "text": "(candidate: "
+            },
+            {
+              "kind": "Reference",
+              "text": "EmitOptions",
+              "canonicalReference": "@genesislcap/foundation-events!EmitOptions:type"
+            },
+            {
+              "kind": "Content",
+              "text": " | any) => boolean"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "isEmitOptions",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 4
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-events!KeysMatching:type",

package/dist/foundation-events.d.ts

@@ -87,6 +87,61 @@ export declare type EmitOrigin = FASTElement;
  */
 export declare type EmitReturn = boolean | void;
 
+/**
+ * emitter function.
+ *
+ * This is the functional equivalent of the strongly typed `.emit` function created with the {@link EventEmitter} mixin.
+ *
+ * @public
+ *
+ * @remarks
+ * This is useful if you need to emit an event from an arbitrary location. For example, if you want to emit an event
+ * from a button on a custom grid cell renderer you can use this to get strong typing rather than having to dependency
+ * inject a reference to the class which uses the {@link EventEmitter} mixin multiple levels into the renderer.
+ *
+ * @example
+ * Apply mixin to the base {@link @microsoft/fast-element#FASTElement | FASTElement}
+ *
+ * # Import
+ * ```ts
+ * import { emitter, SomeSystemLevelEventDetailMap } from '@genesislcap/foundation-events';
+ * import { StoreEventDetailMap, TradeEntryEventDetailMap } from '../store'; // < custom app level event maps
+ * ```
+ *
+ * # Create event map
+ * ```ts
+ * type EventMap = SomeSystemLevelEventDetailMap & StoreEventDetailMap & TradeEntryEventDetailMap;
+ * ```
+ *
+ * # Use the functional emitter. For example in a custom button action on a grid cell
+ * ```ts
+ * const customAction = {
+ *   name: `<rapid-button name="download" size="lg"></rapid-button>`
+ *   callback: (button: HTMLElement, data: RowData) =>
+ *     emitter<EventMap>().emit(
+ *       button,
+ *       'some-allowed-event',
+ *       { foo: 'expected data structure' },
+ *    ),
+ * }
+ * ```
+ *
+ * @privateRemarks
+ * The reason it's a function which returns an object with another function is to create the best developer ergonomics
+ * accounting for TypeScript. This setup allows you to only set one type parameter to control the strong typing, if we
+ * were to add it all onto the same function you'd either have to specify multiple type parameters (repeating yourself)
+ * or if we used implicits it wouldn't type check the payload against the type correctly.
+ *
+ * @typeParam TEventDetailMap - The {@link EventDetailMap}.
+ * @param orign - the `HTMLElement` to dispatch the event from. Ensure this correctly relates to the component you've attatched the corresponding event listener to.
+ * @param type - the key in `TEventDetailMap` which is the event name from the detail map
+ * @param detail - *optional* param `TEventDetailMap[K]` which is the payload corresponding to the event `type`
+ * @param options - *optional* param {@link EmitOptions} to set event options. Default `{ composed: true, bubbles: true, cancelable: true, }`
+ */
+export declare const emitter: <TEventDetailMap extends EventDetailMap>() => {
+    emit: <K extends keyof TEventDetailMap>(...args: TEventDetailMap[K] extends void ? [origin: HTMLElement, type: K, options?: EmitOptions] : [origin: HTMLElement, type: K, detail: TEventDetailMap[K], options?: EmitOptions]) => void;
+};
+
 /**
  * @public
  */
@@ -510,6 +565,11 @@ export declare type EventEmitterTarget<TBase extends FASTElement> = abstract new
  */
 export declare const getBaseEmitArgs: (...args: unknown[]) => EmitArgs;
 
+/**
+ * @public
+ */
+export declare const isEmitOptions: (candidate: EmitOptions | any) => boolean;
+
 /**
  * @public
  */

package/docs/api/foundation-events.emitter.md

@@ -0,0 +1,51 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [emitter](./foundation-events.emitter.md)
+
+## emitter variable
+
+emitter function.
+
+This is the functional equivalent of the strongly typed `.emit` function created with the [EventEmitter](./foundation-events.eventemitter.md) mixin.
+
+**Signature:**
+
+```typescript
+emitter: <TEventDetailMap extends EventDetailMap>() => {
+    emit: <K extends keyof TEventDetailMap>(...args: TEventDetailMap[K] extends void ? [origin: HTMLElement, type: K, options?: EmitOptions] : [origin: HTMLElement, type: K, detail: TEventDetailMap[K], options?: EmitOptions]) => void;
+}
+```
+
+## Remarks
+
+This is useful if you need to emit an event from an arbitrary location. For example, if you want to emit an event from a button on a custom grid cell renderer you can use this to get strong typing rather than having to dependency inject a reference to the class which uses the [EventEmitter](./foundation-events.eventemitter.md) mixin multiple levels into the renderer.
+
+## Example
+
+Apply mixin to the base 
+
+\# Import
+
+```ts
+import { emitter, SomeSystemLevelEventDetailMap } from '@genesislcap/foundation-events';
+import { StoreEventDetailMap, TradeEntryEventDetailMap } from '../store'; // < custom app level event maps
+```
+\# Create event map
+
+```ts
+type EventMap = SomeSystemLevelEventDetailMap & StoreEventDetailMap & TradeEntryEventDetailMap;
+```
+\# Use the functional emitter. For example in a custom button action on a grid cell
+
+```ts
+const customAction = {
+  name: `<rapid-button name="download" size="lg"></rapid-button>`
+  callback: (button: HTMLElement, data: RowData) =>
+    emitter<EventMap>().emit(
+      button,
+      'some-allowed-event',
+      { foo: 'expected data structure' },
+   ),
+}
+```
+

package/docs/api/foundation-events.isemitoptions.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [isEmitOptions](./foundation-events.isemitoptions.md)
+
+## isEmitOptions variable
+
+
+**Signature:**
+
+```typescript
+isEmitOptions: (candidate: EmitOptions | any) => boolean
+```

package/docs/api/foundation-events.md

@@ -24,8 +24,10 @@
 |  [createInputEmitter](./foundation-events.createinputemitter.md) | <code>&lt;input&gt;</code> template emit helper. |
 |  [createSelectEmitter](./foundation-events.createselectemitter.md) | <code>&lt;select&gt;</code> template emit helper. |
 |  [customEvent](./foundation-events.customevent.md) |  |
+|  [emitter](./foundation-events.emitter.md) | <p>emitter function.</p><p>This is the functional equivalent of the strongly typed <code>.emit</code> function created with the [EventEmitter](./foundation-events.eventemitter.md) mixin.</p> |
 |  [EventEmitter](./foundation-events.eventemitter.md) | EventEmitter mixin. |
 |  [getBaseEmitArgs](./foundation-events.getbaseemitargs.md) |  |
+|  [isEmitOptions](./foundation-events.isemitoptions.md) |  |
 |  [logger](./foundation-events.logger.md) |  |
 |  [registerEmitter](./foundation-events.registeremitter.md) | Register an emitter with the DI. |
 |  [targetChecked](./foundation-events.targetchecked.md) |  |

package/docs/api-report.md

@@ -47,6 +47,11 @@ export type EmitOrigin = FASTElement;
 // @public (undocumented)
 export type EmitReturn = boolean | void;
 
+// @public
+export const emitter: <TEventDetailMap extends EventDetailMap>() => {
+    emit: <K extends keyof TEventDetailMap>(...args: TEventDetailMap[K] extends void ? [origin: HTMLElement, type: K, options?: EmitOptions] : [origin: HTMLElement, type: K, detail: TEventDetailMap[K], options?: EmitOptions]) => void;
+};
+
 // @public (undocumented)
 export type EventDetailMap = Record<string, unknown>;
 
@@ -384,6 +389,9 @@ export type EventEmitterTarget<TBase extends FASTElement> = abstract new (...arg
 // @public (undocumented)
 export const getBaseEmitArgs: (...args: unknown[]) => EmitArgs;
 
+// @public (undocumented)
+export const isEmitOptions: (candidate: EmitOptions | any) => boolean;
+
 // @public (undocumented)
 export type KeysMatching<T, V> = {
     [K in keyof T]-?: T[K] extends V ? K : never;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-events",
   "description": "Genesis Foundation Events",
-  "version": "14.241.0",
+  "version": "14.242.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -49,17 +49,17 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.241.0",
-    "@genesislcap/genx": "14.241.0",
-    "@genesislcap/rollup-builder": "14.241.0",
-    "@genesislcap/ts-builder": "14.241.0",
-    "@genesislcap/uvu-playwright-builder": "14.241.0",
-    "@genesislcap/vite-builder": "14.241.0",
-    "@genesislcap/webpack-builder": "14.241.0",
+    "@genesislcap/foundation-testing": "14.242.0",
+    "@genesislcap/genx": "14.242.0",
+    "@genesislcap/rollup-builder": "14.242.0",
+    "@genesislcap/ts-builder": "14.242.0",
+    "@genesislcap/uvu-playwright-builder": "14.242.0",
+    "@genesislcap/vite-builder": "14.242.0",
+    "@genesislcap/webpack-builder": "14.242.0",
     "rimraf": "^5.0.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-logger": "14.241.0",
+    "@genesislcap/foundation-logger": "14.242.0",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.49.6",
     "tslib": "^2.3.1"
@@ -72,5 +72,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6837efcb9fe40e7044bb23d89368ecdcb20a4f3f"
+  "gitHead": "998546fa7f8fc8da70f534d4445719bef59a2dba"
 }