@genesislcap/foundation-events 14.67.1 → 14.67.3

package/docs/api/foundation-events.md

@@ -0,0 +1,47 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md)
+
+## foundation-events package
+
+## Classes
+
+|  Class | Description |
+|  --- | --- |
+|  [DefaultEventEmitterDI](./foundation-events.defaulteventemitterdi.md) | Default EventEmitterDI. |
+
+## Interfaces
+
+|  Interface | Description |
+|  --- | --- |
+|  [EventEmitterDI](./foundation-events.eventemitterdi.md) | EventEmitterDI interface. |
+|  [TypedEmitter](./foundation-events.typedemitter.md) |  |
+
+## Variables
+
+|  Variable | Description |
+|  --- | --- |
+|  [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) |  |
+|  [EventEmitter](./foundation-events.eventemitter.md) | EventEmitter mixin. |
+|  [getBaseEmitArgs](./foundation-events.getbaseemitargs.md) |  |
+|  [logger](./foundation-events.logger.md) |  |
+|  [registerEmitter](./foundation-events.registeremitter.md) | Register an emitter with the DI. |
+|  [targetFirstSelectedValue](./foundation-events.targetfirstselectedvalue.md) |  |
+|  [targetValue](./foundation-events.targetvalue.md) |  |
+
+## Type Aliases
+
+|  Type Alias | Description |
+|  --- | --- |
+|  [ConstructableTypedEventEmitter](./foundation-events.constructabletypedeventemitter.md) |  |
+|  [CustomEventMap](./foundation-events.customeventmap.md) |  |
+|  [EmitArgs](./foundation-events.emitargs.md) |  |
+|  [EmitOptions](./foundation-events.emitoptions.md) |  |
+|  [EmitOrigin](./foundation-events.emitorigin.md) |  |
+|  [EmitReturn](./foundation-events.emitreturn.md) |  |
+|  [EventDetailMap](./foundation-events.eventdetailmap.md) |  |
+|  [EventEmitterTarget](./foundation-events.eventemittertarget.md) |  |
+|  [KeysMatching](./foundation-events.keysmatching.md) |  |
+

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [registerEmitter](./foundation-events.registeremitter.md)
+
+## registerEmitter variable
+
+Register an emitter with the DI.
+
+**Signature:**
+
+```typescript
+registerEmitter: <TEventDetailMap extends EventDetailMap>() => import("@microsoft/fast-foundation").InterfaceSymbol<EventEmitterDI<TEventDetailMap>>
+```

package/docs/api/foundation-events.targetfirstselectedvalue.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; [targetFirstSelectedValue](./foundation-events.targetfirstselectedvalue.md)
+
+## targetFirstSelectedValue variable
+
+
+**Signature:**
+
+```typescript
+targetFirstSelectedValue: ValueGetter
+```

package/docs/api/foundation-events.targetvalue.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; [targetValue](./foundation-events.targetvalue.md)
+
+## targetValue variable
+
+
+**Signature:**
+
+```typescript
+targetValue: ValueGetter
+```

package/docs/api/foundation-events.typedemitter._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; [TypedEmitter](./foundation-events.typedemitter.md) &gt; [$emit](./foundation-events.typedemitter._emit.md)
+
+## TypedEmitter.$emit() method
+
+**Signature:**
+
+```typescript
+$emit<K extends keyof TEventDetailMap & string>(...args: TEventDetailMap[K] extends void ? [type: K, options?: EmitOptions] : [type: K, detail: TEventDetailMap[K], options?: EmitOptions]): EmitReturn;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  args | TEventDetailMap\[K\] extends void ? \[type: K, options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->\] : \[type: K, detail: TEventDetailMap\[K\], options?: [EmitOptions](./foundation-events.emitoptions.md)<!-- -->\] |  |
+
+**Returns:**
+
+[EmitReturn](./foundation-events.emitreturn.md)
+

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

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-events](./foundation-events.md) &gt; [TypedEmitter](./foundation-events.typedemitter.md)
+
+## TypedEmitter interface
+
+
+**Signature:**
+
+```typescript
+export interface TypedEmitter<TEventDetailMap extends EventDetailMap> 
+```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [$emit(args)](./foundation-events.typedemitter._emit.md) |  |
+

package/docs/api/index.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+|  Package | Description |
+|  --- | --- |
+|  [@genesislcap/foundation-events](./foundation-events.md) |  |
+

package/docs/api-report.md

@@ -0,0 +1,106 @@
+## API Report File for "@genesislcap/foundation-events"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+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';
+
+// @public @deprecated (undocumented)
+export type ConstructableTypedEventEmitter = Constructable<FASTElement & HTMLElement>;
+
+// @public
+export const createInputEmitter: <TEventDetailMap extends EventDetailMap>() => <K extends KeysMatching<TEventDetailMap, string>>(type: K, options?: EmitOptions) => Binding;
+
+// @public
+export const createSelectEmitter: <TEventDetailMap extends EventDetailMap>() => <K extends KeysMatching<TEventDetailMap, string>>(type: K, options?: EmitOptions) => Binding;
+
+// @public (undocumented)
+export const customEvent: <TEventDetail = void>(ctx: ExecutionContext) => CustomEvent<TEventDetail>;
+
+// @public (undocumented)
+export type CustomEventMap<TEventDetailMap extends EventDetailMap> = {
+    [K in keyof TEventDetailMap]: CustomEvent<TEventDetailMap[K]>;
+};
+
+// @public
+export class DefaultEventEmitterDI<TEventDetailMap extends EventDetailMap> implements EventEmitterDI<TEventDetailMap> {
+    // (undocumented)
+    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 (undocumented)
+export type EmitArgs = [string, {} | undefined, EmitOptions | undefined];
+
+// @public (undocumented)
+export type EmitOptions = Omit<CustomEventInit, 'detail'>;
+
+// @public (undocumented)
+export type EmitOrigin = FASTElement;
+
+// @public (undocumented)
+export type EmitReturn = boolean | void;
+
+// @public (undocumented)
+export type EventDetailMap = Record<string, unknown>;
+
+// @public
+export 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;
+};
+
+// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "EventEmitterDI" because one of its declarations is marked as @internal
+//
+// @public
+export interface EventEmitterDI<TEventDetailMap extends EventDetailMap> {
+    // (undocumented)
+    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;
+}
+
+// @internal
+export const EventEmitterDI: InterfaceSymbol<EventEmitterDI<EventDetailMap>>;
+
+// @public (undocumented)
+export type EventEmitterTarget<TBase extends FASTElement> = abstract new (...args: any[]) => TBase;
+
+// @public (undocumented)
+export const getBaseEmitArgs: (...args: unknown[]) => EmitArgs;
+
+// @public (undocumented)
+export type KeysMatching<T, V> = {
+    [K in keyof T]-?: T[K] extends V ? K : never;
+}[keyof T];
+
+// @public (undocumented)
+export const logger: Logger;
+
+// @public
+export const registerEmitter: <TEventDetailMap extends EventDetailMap>() => InterfaceSymbol<EventEmitterDI<TEventDetailMap>>;
+
+// Warning: (ae-forgotten-export) The symbol "ValueGetter" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+export const targetFirstSelectedValue: ValueGetter;
+
+// @public (undocumented)
+export const targetValue: ValueGetter;
+
+// @public (undocumented)
+export interface TypedEmitter<TEventDetailMap extends EventDetailMap> {
+    // (undocumented)
+    $emit<K extends keyof TEventDetailMap & string>(...args: TEventDetailMap[K] extends void ? [type: K, options?: EmitOptions] : [type: K, detail: TEventDetailMap[K], options?: EmitOptions]): EmitReturn;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/package.json

@@ -1,17 +1,28 @@
 {
   "name": "@genesislcap/foundation-events",
   "description": "Genesis Foundation Events",
-  "version": "14.67.1",
+  "version": "14.67.3",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
   "types": "dist/dts/index.d.ts",
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/dts/index.d.ts",
+      "default": "./dist/esm/index.js"
+    },
+    "./package.json": "./package.json"
+  },
   "config": {
     "PORT": 3060
   },
   "scripts": {
     "build": "genx build -b ts",
     "build:rollup": "genx build -b rollup",
+    "build:rollup:stats": "genx analyze -b rollup",
     "build:webpack": "genx build",
     "build:webpack:stats": "genx analyze",
     "clean": "rimraf dist tsconfig.tsbuildinfo",
@@ -19,13 +30,22 @@
     "dev:rollup": "genx dev -b rollup",
     "dev:tsc": "genx dev -b ts",
     "dev:webpack": "genx dev -b webpack",
-    "serve": "genx serve"
+    "serve": "genx serve",
+    "test": "tsc & genx test",
+    "test:coverage": "genx test --coverage",
+    "test:coverage:browser": "genx test --coverage --browser",
+    "test:unit:browser": "genx test --browser",
+    "test:unit:browser:watch": "genx test --browser --watch",
+    "test:unit:watch": "genx test --watch",
+    "test:debug": "genx test --debug"
   },
   "devDependencies": {
-    "@genesislcap/genx": "14.67.1",
+    "@genesislcap/foundation-testing": "14.67.3",
+    "@genesislcap/genx": "14.67.3",
     "rimraf": "^3.0.2"
   },
   "dependencies": {
+    "@genesislcap/foundation-utils": "14.67.3",
     "@microsoft/fast-element": "^1.7.0",
     "@microsoft/fast-foundation": "^2.33.2",
     "tslib": "^2.3.1"
@@ -38,5 +58,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "48c43de401b3389f943b27170af4bef907846156"
+  "gitHead": "c966344d844d58c44dc9963214ed68bfd24abe65"
 }