@genesislcap/foundation-events 14.67.2 → 14.67.3

package/dist/foundation-events.d.ts

@@ -0,0 +1,246 @@
+import { Binding } from '@microsoft/fast-element';
+import { Constructable } from '@microsoft/fast-element';
+import { Controller } from '@microsoft/fast-element';
+import { ExecutionContext } from '@microsoft/fast-element';
+import { FASTElement } from '@microsoft/fast-element';
+import { InterfaceSymbol } from '@microsoft/fast-foundation';
+import { Logger } from '@genesislcap/foundation-utils';
+
+/**
+ * @deprecated - Use {@link EventEmitterTarget} type instead.
+ * @public
+ */
+export declare type ConstructableTypedEventEmitter = Constructable<FASTElement & HTMLElement>;
+
+/**
+ * `<input>` template emit helper.
+ *
+ * @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')}">
+ * ```
+ *
+ * @public
+ */
+export declare const createInputEmitter: <TEventDetailMap extends EventDetailMap>() => <K extends KeysMatching<TEventDetailMap, string>>(type: K, options?: EmitOptions) => Binding;
+
+/**
+ * `<select>` template emit helper.
+ *
+ * @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')}">
+ * ```
+ *
+ * @public
+ */
+export declare const createSelectEmitter: <TEventDetailMap extends EventDetailMap>() => <K extends KeysMatching<TEventDetailMap, string>>(type: K, options?: EmitOptions) => Binding;
+
+/**
+ * @public
+ */
+export declare const customEvent: <TEventDetail = void>(ctx: ExecutionContext) => CustomEvent<TEventDetail>;
+
+/**
+ * @public
+ */
+export declare type CustomEventMap<TEventDetailMap extends EventDetailMap> = {
+    [K in keyof TEventDetailMap]: CustomEvent<TEventDetailMap[K]>;
+};
+
+/**
+ * Default EventEmitterDI.
+ * @typeParam TEventDetailMap - The {@link EventDetailMap}.
+ * @public
+ */
+export declare class DefaultEventEmitterDI<TEventDetailMap extends EventDetailMap> implements EventEmitterDI<TEventDetailMap> {
+    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;
+}
+
+/**
+ * @public
+ */
+export declare type EmitArgs = [string, {} | undefined, EmitOptions | undefined];
+
+/**
+ * @public
+ */
+export declare type EmitOptions = Omit<CustomEventInit, 'detail'>;
+
+/**
+ * @public
+ */
+export declare type EmitOrigin = FASTElement;
+
+/**
+ * @public
+ */
+export declare type EmitReturn = boolean | void;
+
+/**
+ * @public
+ */
+export declare type EventDetailMap = Record<string, unknown>;
+
+/**
+ * EventEmitter mixin.
+ *
+ * @remarks
+ * Strongly types the components `$emit` method, allowing only the mapped events to be emitted.
+ *
+ * @example
+ * Apply mixin to the base {@link @microsoft/fast-element#FASTElement | FASTElement}
+ *
+ * # Import
+ * ```ts
+ * import { EventEmitter, SomeSystemLevelEventDetailMap } from '@genesislcap/foundation-events';
+ * import { StoreEventDetailMap, TradeEntryEventDetailMap } from '../store'; // < custom app level event maps
+ * ```
+ *
+ * # Create event map
+ * ```ts
+ * type EventMap = SomeSystemLevelEventDetailMap & StoreEventDetailMap & TradeEntryEventDetailMap;
+ * ```
+ *
+ * # Apply Mixin
+ * ```ts
+ * export class MyComponent extends EventEmitter<EventMap>(FASTElement) {
+ *   onSomeComponentEvent() {
+ *     this.$emit('some-allowed-event', { foo: 'expected data structure' });
+ *   }
+ * }
+ * ```
+ *
+ * @example
+ * Apply mixin to a class in the inheritance chain requires a second generic type param.
+ *
+ * # Apply Mixin to MyComponent that extends MyBaseComponent (which might be abstract). Mixin can be applied at different levels.
+ * # Please note there's a current limitation on retaining protected member access with this approach, so apply to base where possible.
+ * # Also, super classes cannot emit typed events via inheritance. Each level must have an explicit map. Devs can use a Union and Pick to create these.
+ * ```ts
+ * export class MyComponent extends EventEmitter<EventMap, MyBaseComponent>(MyBaseComponent) {}
+ * ```
+ *
+ * @privateRemarks
+ * Failed to retain protected member access when the mixin is applied while keeping the typed emitter, we can revisit if needed.
+ * So in the last example, if `MyBaseComponent` had a protected member, `MyComponent` wouldn't be able to access it with the mixin
+ * applied. Public members are fine. It may be a limitation of TypeScript. Suggestions welcome, but be warned it's a time sink.
+ *
+ * @typeParam TEventDetailMap - The {@link EventDetailMap}.
+ * @typeParam TTarget - The target class.
+ * @param Target - The class to apply the mixin to which ultimately extends {@link @microsoft/fast-element#FASTElement | FASTElement}.
+ * @public
+ */
+export declare const EventEmitter: <TEventDetailMap extends EventDetailMap, TTarget extends FASTElement = FASTElement>(Target: EventEmitterTarget<TTarget>) => abstract new (...args: any[]) => {
+    $emit<K extends keyof TEventDetailMap & string>(...args: TEventDetailMap[K] extends void ? [type: K, options?: EmitOptions] : [type: K, detail: TEventDetailMap[K], options?: EmitOptions]): EmitReturn;
+    readonly $fastController: Controller;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
+};
+
+/**
+ * EventEmitterDI interface.
+ *
+ * @remarks
+ * A strongly typed event emitter with events typed to {@link EventDetailMap} pairings. This is closely related to the
+ * {@link EventEmitter} mixin in terms of functionality, however its purpose is different. This allows you to create
+ * pre-configured EventEmitters that can be injected anywhere. These can emit typed events from an origin html element,
+ * without that element needing to be an actual {@link @microsoft/fast-element#FASTElement | FASTElement}. If you are
+ * starting out, we recommend using the {@link EventEmitter} mixin where possible.
+ *
+ * @example Create an emitter within the DI.
+ * ```ts
+ * import {registerEmitter} from '@genesislcap/foundation-events';
+ * ...
+ * export const MyEventEmitter = registerEmitter<MyEventDetailMap>();
+ * ```
+ *
+ * @example Use that emitter.
+ * ```ts
+ * export class MyComponent extends FASTElement {
+ *   @observable someElement!: HTMLElement;
+ *   @MyEventEmitter emitter: MyEventEmitter;
+ *   connectedCallback() {
+ *     this.emitter.emit(this.someElement, 'some-event', {foo: 'bar'});
+ *   }
+ * }
+ * ```
+ *
+ * @typeParam TEventDetailMap - The {@link EventDetailMap}.
+ * @public
+ */
+export declare interface EventEmitterDI<TEventDetailMap extends EventDetailMap> {
+    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;
+}
+
+/**
+ * EventEmitterDI DI key.
+ * @internal
+ */
+export declare const EventEmitterDI: InterfaceSymbol<EventEmitterDI<EventDetailMap>>;
+
+/**
+ * @remarks
+ * Using `abstract` here should cover mixing into both concrete and abstract classes.
+ * @public
+ */
+export declare type EventEmitterTarget<TBase extends FASTElement> = abstract new (...args: any[]) => TBase;
+
+/**
+ * @public
+ */
+export declare const getBaseEmitArgs: (...args: unknown[]) => EmitArgs;
+
+/**
+ * @public
+ */
+export declare type KeysMatching<T, V> = {
+    [K in keyof T]-?: T[K] extends V ? K : never;
+}[keyof T];
+
+/**
+ * @public
+ */
+export declare const logger: Logger;
+
+/**
+ * Register an emitter with the DI.
+ * @typeParam TEventDetailMap - The {@link EventDetailMap}.
+ * @public
+ */
+export declare const registerEmitter: <TEventDetailMap extends EventDetailMap>() => InterfaceSymbol<EventEmitterDI<TEventDetailMap>>;
+
+/**
+ * @public
+ */
+export declare const targetFirstSelectedValue: ValueGetter;
+
+/**
+ * @public
+ */
+export declare const targetValue: ValueGetter;
+
+/**
+ * @public
+ */
+export declare interface TypedEmitter<TEventDetailMap extends EventDetailMap> {
+    $emit<K extends keyof TEventDetailMap & string>(...args: TEventDetailMap[K] extends void ? [type: K, options?: EmitOptions] : [type: K, detail: TEventDetailMap[K], options?: EmitOptions]): EmitReturn;
+}
+
+/**
+ * @internal
+ */
+declare type ValueGetter = (ctx: ExecutionContext) => any;
+
+export { }

package/docs/.gitattributes

@@ -0,0 +1,2 @@
+*.md -diff
+*.md linguist-generated

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

@@ -0,0 +1,16 @@
+<!-- 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

@@ -0,0 +1,27 @@
+<!-- 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 variable
+
+`<input>` template emit helper.
+
+**Signature:**
+
+```typescript
+createInputEmitter: <TEventDetailMap extends EventDetailMap>() => <K extends KeysMatching<TEventDetailMap, string>>(type: K, options?: EmitOptions) => 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

@@ -0,0 +1,27 @@
+<!-- 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 variable
+
+`<select>` template emit helper.
+
+**Signature:**
+
+```typescript
+createSelectEmitter: <TEventDetailMap extends EventDetailMap>() => <K extends KeysMatching<TEventDetailMap, string>>(type: K, options?: EmitOptions) => 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

@@ -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; [customEvent](./foundation-events.customevent.md)
+
+## customEvent variable
+
+
+**Signature:**
+
+```typescript
+customEvent: <TEventDetail = void>(ctx: ExecutionContext) => CustomEvent<TEventDetail>
+```

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

@@ -0,0 +1,16 @@
+<!-- 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

@@ -0,0 +1,22 @@
+<!-- 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
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  args | 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)<!-- -->\] |  |
+
+**Returns:**
+
+[EmitReturn](./foundation-events.emitreturn.md)
+

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

@@ -0,0 +1,21 @@
+<!-- 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
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [emit(args)](./foundation-events.defaulteventemitterdi.emit.md) |  |  |
+

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

@@ -0,0 +1,14 @@
+<!-- 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

@@ -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; [EmitOptions](./foundation-events.emitoptions.md)
+
+## EmitOptions type
+
+
+**Signature:**
+
+```typescript
+export type EmitOptions = Omit<CustomEventInit, 'detail'>;
+```

package/docs/api/foundation-events.emitorigin.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; [EmitOrigin](./foundation-events.emitorigin.md)
+
+## EmitOrigin type
+
+
+**Signature:**
+
+```typescript
+export type EmitOrigin = FASTElement;
+```

package/docs/api/foundation-events.emitreturn.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; [EmitReturn](./foundation-events.emitreturn.md)
+
+## EmitReturn type
+
+
+**Signature:**
+
+```typescript
+export type EmitReturn = boolean | void;
+```

package/docs/api/foundation-events.eventdetailmap.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; [EventDetailMap](./foundation-events.eventdetailmap.md)
+
+## EventDetailMap type
+
+
+**Signature:**
+
+```typescript
+export type EventDetailMap = Record<string, unknown>;
+```

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

@@ -0,0 +1,59 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [EventEmitter](./foundation-events.eventemitter.md)
+
+## EventEmitter variable
+
+EventEmitter mixin.
+
+**Signature:**
+
+```typescript
+EventEmitter: <TEventDetailMap extends EventDetailMap, TTarget extends FASTElement = FASTElement>(Target: EventEmitterTarget<TTarget>) => abstract new (...args: any[]) => {
+    $emit<K extends keyof TEventDetailMap & string>(...args: TEventDetailMap[K] extends void ? [type: K, options?: EmitOptions] : [type: K, detail: TEventDetailMap[K], options?: EmitOptions]): EmitReturn;
+    readonly $fastController: import("@microsoft/fast-element").Controller;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
+}
+```
+
+## Remarks
+
+Strongly types the components `$emit` method, allowing only the mapped events to be emitted.
+
+## Example 1
+
+Apply mixin to the base 
+
+\# Import
+
+```ts
+import { EventEmitter, SomeSystemLevelEventDetailMap } from '@genesislcap/foundation-events';
+import { StoreEventDetailMap, TradeEntryEventDetailMap } from '../store'; // < custom app level event maps
+```
+\# Create event map
+
+```ts
+type EventMap = SomeSystemLevelEventDetailMap & StoreEventDetailMap & TradeEntryEventDetailMap;
+```
+\# Apply Mixin
+
+```ts
+export class MyComponent extends EventEmitter<EventMap>(FASTElement) {
+  onSomeComponentEvent() {
+    this.$emit('some-allowed-event', { foo: 'expected data structure' });
+  }
+}
+```
+
+## Example 2
+
+Apply mixin to a class in the inheritance chain requires a second generic type param.
+
+\# Apply Mixin to MyComponent that extends MyBaseComponent (which might be abstract). Mixin can be applied at different levels. \# Please note there's a current limitation on retaining protected member access with this approach, so apply to base where possible. \# Also, super classes cannot emit typed events via inheritance. Each level must have an explicit map. Devs can use a Union and Pick to create these.
+
+```ts
+export class MyComponent extends EventEmitter<EventMap, MyBaseComponent>(MyBaseComponent) {}
+```
+

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

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [EventEmitterDI](./foundation-events.eventemitterdi.md) &gt; [emit](./foundation-events.eventemitterdi.emit.md)
+
+## EventEmitterDI.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
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  args | 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)<!-- -->\] |  |
+
+**Returns:**
+
+[EmitReturn](./foundation-events.emitreturn.md)
+

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

@@ -0,0 +1,48 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [EventEmitterDI](./foundation-events.eventemitterdi.md)
+
+## EventEmitterDI interface
+
+EventEmitterDI interface.
+
+**Signature:**
+
+```typescript
+export interface EventEmitterDI<TEventDetailMap extends EventDetailMap> 
+```
+
+## Remarks
+
+A strongly typed event emitter with events typed to [EventDetailMap](./foundation-events.eventdetailmap.md) pairings. This is closely related to the [EventEmitter](./foundation-events.eventemitter.md) mixin in terms of functionality, however its purpose is different. This allows you to create pre-configured EventEmitters that can be injected anywhere. These can emit typed events from an origin html element, without that element needing to be an actual . If you are starting out, we recommend using the [EventEmitter](./foundation-events.eventemitter.md) mixin where possible.
+
+## Example 1
+
+Create an emitter within the DI.
+
+```ts
+import {registerEmitter} from '@genesislcap/foundation-events';
+...
+export const MyEventEmitter = registerEmitter<MyEventDetailMap>();
+```
+
+## Example 2
+
+Use that emitter.
+
+```ts
+export class MyComponent extends FASTElement {
+  @observable someElement!: HTMLElement;
+  @MyEventEmitter emitter: MyEventEmitter;
+  connectedCallback() {
+    this.emitter.emit(this.someElement, 'some-event', {foo: 'bar'});
+  }
+}
+```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [emit(args)](./foundation-events.eventemitterdi.emit.md) |  |
+

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

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [EventEmitterTarget](./foundation-events.eventemittertarget.md)
+
+## EventEmitterTarget type
+
+**Signature:**
+
+```typescript
+export type EventEmitterTarget<TBase extends FASTElement> = abstract new (...args: any[]) => TBase;
+```
+
+## Remarks
+
+Using `abstract` here should cover mixing into both concrete and abstract classes.
+

package/docs/api/foundation-events.getbaseemitargs.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; [getBaseEmitArgs](./foundation-events.getbaseemitargs.md)
+
+## getBaseEmitArgs variable
+
+
+**Signature:**
+
+```typescript
+getBaseEmitArgs: (...args: unknown[]) => EmitArgs
+```

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

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [KeysMatching](./foundation-events.keysmatching.md)
+
+## KeysMatching type
+
+
+**Signature:**
+
+```typescript
+export type KeysMatching<T, V> = {
+    [K in keyof T]-?: T[K] extends V ? K : never;
+}[keyof T];
+```

package/docs/api/foundation-events.logger.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; [logger](./foundation-events.logger.md)
+
+## logger variable
+
+
+**Signature:**
+
+```typescript
+logger: import("@genesislcap/foundation-utils").Logger
+```