@genesislcap/foundation-events 14.408.0 → 14.409.0

package/README.md

@@ -1,115 +1,25 @@
-# Genesis Foundation Events
+# @genesislcap/foundation-events
 
-`foundation-events` contains strongly typed [event emitting utilities](./src/eventEmitter/README.md) and interfaces.
-
-- Contains [event emitting utilities](./src/eventEmitter/README.md).
-- Contains common system level:
-  - Custom event types
-  - Custom event [detail interfaces](https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent/detail)
-  - Custom event type to detail maps
-
-```typescript
-export interface ZooEventDetail {
-  animals: Animal[];
-  location: string;
-}
-
-export type MyEventDetailMap = {
-  'domain-foo': void; // < no detail
-  'domain-bar': boolean; // < boolean detail
-  'domain-zoo': ZooEventDetail; // < ZooEventDetail detail (more than one prop on details)
-  'domain-zoo-animals': Animal[]; // array of Animals detail
-  'domain-coo': number; // < number
-}
-```
-
-## Event naming
-
-We need to come up with an event naming strategy that scales well, avoids clashing, and sets out well known system
-events for our micro frontends handle. Ideally these should be additive as we evolve to avoid breaking changes. For
-example a user will always login, logout, etc, and these should be the same across all apps and not need to change much.
-Payloads themselves may be more likely to change overtime, and we need to figure out how to deal with that.
-
-Some notes on possible topic / event naming conventions. Note these show . delimiter but we'd probably use -
-
-[https://devshawn.com/blog/apache-kafka-topic-naming-conventions/](https://devshawn.com/blog/apache-kafka-topic-naming-conventions/)
-
-```
-<data-center>.<domain>.<classification>.<description>.<version>
-```
-
-```
-aws.analytics.fct.pageviews.0
-azure.comms.fct.gps.0
-dc1.identity.cdc.users.1
-gcp.notifications.cmd.emails.3
-gcp.notifications.sys.email-cache.0
-```
-
-Note: using version in the naming seems controversial, further reading required.
-
-```
-public.com.xeotek.sales.ecommerce.shoppingcarts
-public.sales.ecommerce.shoppingcarts
-private.risk.portfolio.analysis.loans.csvimport
-```
-
-As a phase of processing:
-```
-  org.ntent.addelivery.pageview-incoming
-  org.ntent.addelivery.pageview-filtered
-  org.ntent.addelivery.pageview-duplicate
-  org.ntent.addelivery.pageview-clean
-```
-
-To separate "instances" of a particular kind of activity:
-```
-  org.ntent.addelivery.feedrequest-feed1
-  org.ntent.addelivery.feedrequest-feed2
-  org.ntent.addelivery.feedrequest-feed3
-```
-
-To denote the type of "statistic":
-```
-  org.ntent.addelivery.filterstats-knownoffender
-  org.ntent.addelivery.filterstats-bot
-  org.ntent.addelivery.filterstats-clickrate
-```
-
-
-### [Module Federation Details](https://webpack.js.org/concepts/module-federation):
-
-| Remote Name           | Port  |
-| --------------------- | ----- |
-| foundationEvents      | 3060  |
-
-[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
-[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/)
+Documentation for this package is published on the Genesis docs site:
 
+**Docs: [Utility methods](https://docs.genesis.global/docs/develop/client-capabilities/utility-methods/)**
 
 ## Installation
 
-To enable this module in your application, follow the steps below.
-
-1. Add `@genesislcap/foundation-events` as a dependency in your `package.json` file. Whenever you change the dependencies of your project, ensure you run the `$ npm run bootstrap` command again. You can find more information in the [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) page.
+Add the package to your `package.json` dependencies. After changing dependencies, run `npm run bootstrap` (or your project's equivalent). See [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) for more information.
 
 ```json
 {
-  ...
   "dependencies": {
-    ...
     "@genesislcap/foundation-events": "latest"
-    ...
-  },
-  ...
+  }
 }
 ```
 
-## [API Docs](./docs/api/index.md)
-
 ## License
 
 Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.
 
 ### Licensed components
+
 Genesis low-code platform

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-events",
   "description": "Genesis Foundation Events",
-  "version": "14.408.0",
+  "version": "14.409.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -51,16 +51,16 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.408.0",
-    "@genesislcap/genx": "14.408.0",
-    "@genesislcap/rollup-builder": "14.408.0",
-    "@genesislcap/ts-builder": "14.408.0",
-    "@genesislcap/uvu-playwright-builder": "14.408.0",
-    "@genesislcap/vite-builder": "14.408.0",
-    "@genesislcap/webpack-builder": "14.408.0"
+    "@genesislcap/foundation-testing": "14.409.0",
+    "@genesislcap/genx": "14.409.0",
+    "@genesislcap/rollup-builder": "14.409.0",
+    "@genesislcap/ts-builder": "14.409.0",
+    "@genesislcap/uvu-playwright-builder": "14.409.0",
+    "@genesislcap/vite-builder": "14.409.0",
+    "@genesislcap/webpack-builder": "14.409.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-logger": "14.408.0",
+    "@genesislcap/foundation-logger": "14.409.0",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.50.0"
   },
@@ -72,5 +72,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "26b08831fd001b4ee95c8a0d3364a18c0ec4005b"
+  "gitHead": "cbe0459d170f27c35a7de18cec415947aedf4da5"
 }

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

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [ConstructableTypedEventEmitter](./foundation-events.constructabletypedeventemitter.md)
-
-## ConstructableTypedEventEmitter type
-
-> Warning: This API is now obsolete.
-> 
-> - Use [EventEmitterTarget](./foundation-events.eventemittertarget.md) type instead.
-> 
-
-**Signature:**
-
-```typescript
-export type ConstructableTypedEventEmitter = Constructable<FASTElement & HTMLElement>;
-```

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

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [createInputEmitter](./foundation-events.createinputemitter.md)
-
-## createInputEmitter() function
-
-`<input>` template emit helper.
-
-**Signature:**
-
-```typescript
-createInputEmitter: <TEventDetailMap extends EventDetailMap>() => <K extends KeysMatching<TEventDetailMap, string>>(type: K, options?: EmitOptions) => Binding
-```
-**Returns:**
-
-&lt;K extends [KeysMatching](./foundation-events.keysmatching.md)<!-- -->&lt;TEventDetailMap, string&gt;&gt;(type: K, options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->) =&gt; Binding
-
-## Remarks
-
-In some.template.ts file you create the helper upfront by passing in the full event map.
-
-## Example
-
-
-```ts
-const inputEmit = createInputEmitter<EventMap>();
-...
-<zero-text-field @change="${inputEmit('some-input-changed')}">
-```
-

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

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [createSelectEmitter](./foundation-events.createselectemitter.md)
-
-## createSelectEmitter() function
-
-`<select>` template emit helper.
-
-**Signature:**
-
-```typescript
-createSelectEmitter: <TEventDetailMap extends EventDetailMap>() => <K extends KeysMatching<TEventDetailMap, string>>(type: K, options?: EmitOptions) => Binding
-```
-**Returns:**
-
-&lt;K extends [KeysMatching](./foundation-events.keysmatching.md)<!-- -->&lt;TEventDetailMap, string&gt;&gt;(type: K, options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->) =&gt; Binding
-
-## Remarks
-
-In some.template.ts file you create the helper upfront by passing in the full event map.
-
-## Example
-
-
-```ts
-const selectEmit = createSelectEmitter<EventMap>();
-...
-<zero-select @change="${selectEmit('some-select-changed')}">
-```
-

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

@@ -1,51 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [customEvent](./foundation-events.customevent.md)
-
-## customEvent() function
-
-
-**Signature:**
-
-```typescript
-customEvent: <TEventDetail = void>(ctx: ExecutionContext) => CustomEvent<TEventDetail>
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-ctx
-
-
-</td><td>
-
-ExecutionContext
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-CustomEvent&lt;TEventDetail&gt;
-

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

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [CustomEventMap](./foundation-events.customeventmap.md)
-
-## CustomEventMap type
-
-
-**Signature:**
-
-```typescript
-export type CustomEventMap<TEventDetailMap extends EventDetailMap> = {
-    [K in keyof TEventDetailMap]: CustomEvent<TEventDetailMap[K]>;
-};
-```
-**References:** [EventDetailMap](./foundation-events.eventdetailmap.md)
-

package/docs/api/foundation-events.defaulteventemitterdi.emit.md

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [DefaultEventEmitterDI](./foundation-events.defaulteventemitterdi.md) &gt; [emit](./foundation-events.defaulteventemitterdi.emit.md)
-
-## DefaultEventEmitterDI.emit() method
-
-**Signature:**
-
-```typescript
-emit<K extends keyof TEventDetailMap>(...args: TEventDetailMap[K] extends void ? [origin: EmitOrigin, type: K, options?: EmitOptions] : [origin: EmitOrigin, type: K, detail: TEventDetailMap[K], options?: EmitOptions]): EmitReturn;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-args
-
-
-</td><td>
-
-TEventDetailMap\[K\] extends void ? \[origin: [EmitOrigin](./foundation-events.emitorigin.md)<!-- -->, type: K, options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->\] : \[origin: [EmitOrigin](./foundation-events.emitorigin.md)<!-- -->, type: K, detail: TEventDetailMap\[K\], options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->\]
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-[EmitReturn](./foundation-events.emitreturn.md)
-

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

@@ -1,47 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [DefaultEventEmitterDI](./foundation-events.defaulteventemitterdi.md)
-
-## DefaultEventEmitterDI class
-
-Default EventEmitterDI.
-
-**Signature:**
-
-```typescript
-export declare class DefaultEventEmitterDI<TEventDetailMap extends EventDetailMap> implements EventEmitterDI<TEventDetailMap> 
-```
-**Implements:** [EventEmitterDI](./foundation-events.eventemitterdi.md)<!-- -->&lt;TEventDetailMap&gt;
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[emit(args)](./foundation-events.defaulteventemitterdi.emit.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [EmitArgs](./foundation-events.emitargs.md)
-
-## EmitArgs type
-
-
-**Signature:**
-
-```typescript
-export type EmitArgs = [string, {} | undefined, EmitOptions | undefined];
-```
-**References:** [EmitOptions](./foundation-events.emitoptions.md)
-

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

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [EmitOptions](./foundation-events.emitoptions.md)
-
-## EmitOptions type
-
-
-**Signature:**
-
-```typescript
-export type EmitOptions = Omit<CustomEventInit, 'detail'> & {
-    broadcast?: boolean;
-};
-```

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

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [EmitOrigin](./foundation-events.emitorigin.md)
-
-## EmitOrigin type
-
-
-**Signature:**
-
-```typescript
-export type EmitOrigin = FASTElement;
-```

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

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

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

@@ -1,54 +0,0 @@
-<!-- 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() function
-
-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;
-}
-```
-**Returns:**
-
-{ emit: &lt;K extends keyof TEventDetailMap&gt;(...args: TEventDetailMap\[K\] extends void ? \[origin: HTMLElement, type: K, options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->\] : \[origin: HTMLElement, type: K, detail: TEventDetailMap\[K\], options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->\]) =&gt; 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.eventdetailmap.md

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [EventDetailMap](./foundation-events.eventdetailmap.md)
-
-## EventDetailMap type
-
-
-**Signature:**
-
-```typescript
-export type EventDetailMap = Record<string, unknown>;
-```