@genesislcap/foundation-fdc3 14.301.0 → 14.302.1-alpha-d11831b.0

package/docs/api/foundation-fdc3.md

@@ -6,31 +6,249 @@
 
 ## Classes
 
-|  Class | Description |
-|  --- | --- |
-|  [InteropNotificationsListener](./foundation-fdc3.interopnotificationslistener.md) |  |
+<table><thead><tr><th>
+
+Class
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[Fdc3ContextListener](./foundation-fdc3.fdc3contextlistener.md)
+
+
+</td><td>
+
+**_(ALPHA)_** fdc3-context-listener listen to app channel context
+
+
+</td></tr>
+<tr><td>
+
+[Fdc3IntentListener](./foundation-fdc3.fdc3intentlistener.md)
+
+
+</td><td>
+
+**_(ALPHA)_** fdc3-system-channel-listener Util element to listen to the context on a fdc3 app channel
+
+
+</td></tr>
+<tr><td>
+
+[Fdc3RaiseIntent](./foundation-fdc3.fdc3raiseintent.md)
+
+
+</td><td>
+
+**_(ALPHA)_** fdc3-raise-intent
+
+
+</td></tr>
+<tr><td>
+
+[Fdc3SystemChannelListener](./foundation-fdc3.fdc3systemchannellistener.md)
+
+
+</td><td>
+
+**_(ALPHA)_** fdc3-system-channel-listener Util element to listen to the context on a fdc3 system channel
+
+
+</td></tr>
+<tr><td>
+
+[InteropNotificationsListener](./foundation-fdc3.interopnotificationslistener.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+## Functions
+
+<table><thead><tr><th>
+
+Function
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[interopFoundationNotificationListener(overrideDefinition)](./foundation-fdc3.interopfoundationnotificationlistener.md)
+
+
+</td><td>
+
+The Foundation Interop Notification Listener
+
+
+</td></tr>
+</tbody></table>
 
 ## Interfaces
 
-|  Interface | Description |
-|  --- | --- |
-|  [FDC3](./foundation-fdc3.fdc3.md) | The FDC3 API interface. |
-|  [FDC3AppIntent](./foundation-fdc3.fdc3appintent.md) |  |
-|  [FDC3Channel](./foundation-fdc3.fdc3channel.md) |  |
-|  [FDC3Context](./foundation-fdc3.fdc3context.md) |  |
-|  [FDC3IntentResolution](./foundation-fdc3.fdc3intentresolution.md) |  |
+<table><thead><tr><th>
+
+Interface
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[AppChannelListenerConfig](./foundation-fdc3.appchannellistenerconfig.md)
+
+
+</td><td>
+
+**_(ALPHA)_** fdc3-context-listener listen channel config
+
+
+</td></tr>
+<tr><td>
+
+[FDC3](./foundation-fdc3.fdc3.md)
+
+
+</td><td>
+
+The FDC3 API interface.
+
+
+</td></tr>
+<tr><td>
+
+[FDC3AppIntent](./foundation-fdc3.fdc3appintent.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[FDC3Channel](./foundation-fdc3.fdc3channel.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[FDC3Context](./foundation-fdc3.fdc3context.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[FDC3IntentResolution](./foundation-fdc3.fdc3intentresolution.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[IntentConfig](./foundation-fdc3.intentconfig.md)
+
+
+</td><td>
+
+**_(ALPHA)_** fdc3-intent-listener listen intent config
+
+
+</td></tr>
+<tr><td>
+
+[SystemChannelListenerConfig](./foundation-fdc3.systemchannellistenerconfig.md)
+
+
+</td><td>
+
+**_(ALPHA)_** System channel listener config. System channels are also known as color channels
+
+
+</td></tr>
+</tbody></table>
 
 ## Variables
 
-|  Variable | Description |
-|  --- | --- |
-|  [interopFoundationNotificationListener](./foundation-fdc3.interopfoundationnotificationlistener.md) | The Foundation Interop Notification Listener |
-|  [logger](./foundation-fdc3.logger.md) | Logger for the foundation-fdc3 package |
+<table><thead><tr><th>
+
+Variable
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[logger](./foundation-fdc3.logger.md)
+
+
+</td><td>
+
+Logger for the foundation-fdc3 package
+
+
+</td></tr>
+</tbody></table>
 
 ## Type Aliases
 
-|  Type Alias | Description |
-|  --- | --- |
-|  [FDC3ContextHandler](./foundation-fdc3.fdc3contexthandler.md) |  |
-|  [FDC3Intents](./foundation-fdc3.fdc3intents.md) |  |
+<table><thead><tr><th>
+
+Type Alias
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[FDC3ContextHandler](./foundation-fdc3.fdc3contexthandler.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[FDC3Intents](./foundation-fdc3.fdc3intents.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/foundation-fdc3.systemchannellistenerconfig.callback.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [SystemChannelListenerConfig](./foundation-fdc3.systemchannellistenerconfig.md) &gt; [callback](./foundation-fdc3.systemchannellistenerconfig.callback.md)
+
+## SystemChannelListenerConfig.callback property
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+callback: (any: any) => void;
+```

package/docs/api/foundation-fdc3.systemchannellistenerconfig.channeltype.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [SystemChannelListenerConfig](./foundation-fdc3.systemchannellistenerconfig.md) &gt; [channelType](./foundation-fdc3.systemchannellistenerconfig.channeltype.md)
+
+## SystemChannelListenerConfig.channelType property
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+channelType: string;
+```

package/docs/api/foundation-fdc3.systemchannellistenerconfig.md

@@ -0,0 +1,80 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-fdc3](./foundation-fdc3.md) &gt; [SystemChannelListenerConfig](./foundation-fdc3.systemchannellistenerconfig.md)
+
+## SystemChannelListenerConfig interface
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+System channel listener config. System channels are also known as color channels
+
+**Signature:**
+
+```typescript
+export interface SystemChannelListenerConfig 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[callback](./foundation-fdc3.systemchannellistenerconfig.callback.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(any: any) =&gt; void
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+<tr><td>
+
+[channelType](./foundation-fdc3.systemchannellistenerconfig.channeltype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/index.md

@@ -6,7 +6,25 @@
 
 ## Packages
 
-|  Package | Description |
-|  --- | --- |
-|  [@genesislcap/foundation-fdc3](./foundation-fdc3.md) |  |
+<table><thead><tr><th>
+
+Package
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[@genesislcap/foundation-fdc3](./foundation-fdc3.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api-report.md.api.md

@@ -0,0 +1,281 @@
+## API Report File for "@genesislcap/foundation-fdc3"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { AppIdentifier } from '@finos/fdc3';
+import type { AppIntent } from '@finos/fdc3';
+import type { Channel } from '@finos/fdc3';
+import type { Context } from '@finos/fdc3';
+import type { ContextHandler } from '@finos/fdc3';
+import type { ContextMetadata } from '@finos/fdc3';
+import { Controller } from '@microsoft/fast-element';
+import { DOMContainer } from '@genesislcap/foundation-utils';
+import { FoundationElement } from '@genesislcap/web-core';
+import { FoundationElementRegistry } from '@microsoft/fast-foundation';
+import { FoundationLayoutContainer } from '@genesislcap/foundation-utils';
+import type { IntentHandler } from '@finos/fdc3';
+import type { IntentResolution } from '@finos/fdc3';
+import type { Intents } from '@finos/fdc3';
+import { InterfaceSymbol } from '@microsoft/fast-foundation';
+import { IOConnectDesktop } from '@interopio/desktop';
+import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
+import type { Listener } from '@finos/fdc3';
+import { Logger } from '@genesislcap/foundation-logger';
+import { NotificationDataRow } from '@genesislcap/foundation-notifications';
+import { NotificationListener } from '@genesislcap/foundation-ui';
+import { Observable } from 'rxjs';
+import { OverrideFoundationElementDefinition } from '@microsoft/fast-foundation';
+import type { PrivateChannel } from '@finos/fdc3';
+import type { StandardIntent } from '@finos/fdc3';
+import { ViewTemplate } from '@microsoft/fast-element';
+
+// @alpha
+export interface AppChannelListenerConfig extends SystemChannelListenerConfig {
+    // (undocumented)
+    channelName: string;
+}
+
+export { AppIdentifier }
+
+export { AppIntent }
+
+export { Channel }
+
+export { Context }
+
+export { ContextHandler }
+
+export { ContextMetadata }
+
+// Warning: (ae-internal-missing-underscore) The name "DefaultFDC3" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal
+export class DefaultFDC3 implements FDC3 {
+    constructor();
+    // (undocumented)
+    addChannelListener(channelName: string, channelType: string, callback: (any: any) => void): Promise<Channel>;
+    // (undocumented)
+    addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
+    // (undocumented)
+    addSystemChannelListener(channelType: string, callback: (any: any) => void): Promise<void>;
+    // (undocumented)
+    broadcastOnChannel(channelName: string, type: string, payload: any): Promise<void>;
+    // (undocumented)
+    broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: any) => Promise<void>>;
+    // (undocumented)
+    broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
+    // (undocumented)
+    currentChannel$: Observable<Channel>;
+    // (undocumented)
+    findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
+    // (undocumented)
+    findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
+    // (undocumented)
+    getCurrentChannel(): Promise<Channel>;
+    // (undocumented)
+    getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
+    // (undocumented)
+    handleChannelCurrentContext(channel: Channel | FDC3Channel, contextType: string, listenerCallback: (FDC3Context: any) => any): Promise<void>;
+    // (undocumented)
+    isInteropFdc3: () => boolean;
+    // (undocumented)
+    isReady$: Observable<true>;
+    // (undocumented)
+    isReady: boolean;
+    // (undocumented)
+    joinChannel(channelId: string): Promise<void>;
+    // (undocumented)
+    raiseIntent(context: FDC3Context, intent?: FDC3Intents): Promise<FDC3IntentResolution>;
+    // (undocumented)
+    raiseIntentForContext(context: FDC3Context): Promise<FDC3IntentResolution>;
+}
+
+// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "FDC3" because one of its declarations is marked as @internal
+//
+// @public
+export interface FDC3 {
+    addChannelListener(channelName: string, channelType: string, callback: (any: any) => void): Promise<Channel>;
+    addIntentListeners(listeners: Map<FDC3Intents, FDC3ContextHandler>): void;
+    addSystemChannelListener(channelType: string, callback: (any: any) => void): Promise<void>;
+    broadcastOnChannel(channelName: string, type: string, payload: any): Promise<void>;
+    broadcastOnChannelEventHandler(channelName: string, type: string): Promise<(e: any) => Promise<void>>;
+    broadcastOnCurrentChannel(payload: any, type?: string): Promise<void>;
+    currentChannel$: Observable<FDC3Channel>;
+    findIntent(intent: FDC3Intents, context?: FDC3Context): Promise<FDC3AppIntent>;
+    findIntentsByContext(context: FDC3Context): Promise<FDC3AppIntent[]>;
+    getCurrentChannel(): Promise<Channel>;
+    getOrCreateChannel(channelId: string): Promise<FDC3Channel>;
+    handleChannelCurrentContext(channel: Channel | FDC3Channel, contextType: string, listenerCallback: (FDC3Context: any) => any): Promise<void>;
+    isInteropFdc3: () => boolean;
+    isReady$: Observable<true>;
+    isReady: boolean;
+    joinChannel(channelId: string): Promise<void>;
+    raiseIntent(context: FDC3Context, intent?: FDC3Intents): Promise<FDC3IntentResolution>;
+    raiseIntentForContext(context: FDC3Context): Promise<FDC3IntentResolution>;
+}
+
+// @internal
+export const FDC3: InterfaceSymbol<FDC3>;
+
+// @public @deprecated (undocumented)
+export interface FDC3AppIntent extends AppIntent {
+}
+
+// @public @deprecated (undocumented)
+export interface FDC3Channel extends Channel {
+}
+
+// Warning: (ae-forgotten-export) The symbol "Fdc3ChannelEvent_base" needs to be exported by the entry point index.d.ts
+// Warning: (ae-internal-missing-underscore) The name "Fdc3ChannelEvent" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal
+export class Fdc3ChannelEvent extends Fdc3ChannelEvent_base {
+    // (undocumented)
+    channelName: string;
+    // (undocumented)
+    channelType: string;
+    // (undocumented)
+    connectedCallback(): void;
+    // (undocumented)
+    deepClone(): Node;
+    // (undocumented)
+    disconnectedCallback(): void;
+    // (undocumented)
+    eventName: string;
+    // (undocumented)
+    fdc3: FDC3;
+    // (undocumented)
+    mappingFunction: (any: any) => any;
+}
+
+// @public @deprecated (undocumented)
+export interface FDC3Context extends Context {
+}
+
+// @public @deprecated (undocumented)
+export type FDC3ContextHandler = ContextHandler;
+
+// @alpha
+export class Fdc3ContextListener extends Fdc3SystemChannelListener {
+    // (undocumented)
+    protected addChannelListeners(): void;
+    // (undocumented)
+    config: AppChannelListenerConfig[];
+}
+
+// Warning: (ae-forgotten-export) The symbol "Fdc3IntentListener_base" needs to be exported by the entry point index.d.ts
+//
+// @alpha
+export class Fdc3IntentListener extends Fdc3IntentListener_base {
+    // (undocumented)
+    connectedCallback(): void;
+    // (undocumented)
+    deepClone(): Node;
+    // (undocumented)
+    fdc3: FDC3;
+    // (undocumented)
+    intentConfig: IntentConfig[];
+}
+
+// @public @deprecated (undocumented)
+export interface FDC3IntentResolution extends IntentResolution {
+}
+
+// @public @deprecated (undocumented)
+export type FDC3Intents = Intents;
+
+// Warning: (ae-forgotten-export) The symbol "Fdc3RaiseIntent_base" needs to be exported by the entry point index.d.ts
+//
+// @alpha
+export class Fdc3RaiseIntent extends Fdc3RaiseIntent_base {
+    // (undocumented)
+    connectedCallback(): void;
+    // (undocumented)
+    deepClone(): Node;
+    // (undocumented)
+    disconnectedCallback(): void;
+    // (undocumented)
+    eventName: string;
+    // (undocumented)
+    fdc3: FDC3;
+    // (undocumented)
+    intentName: string;
+    // (undocumented)
+    intentType: string;
+    // (undocumented)
+    mappingFunction: (any: any) => any;
+}
+
+// Warning: (ae-forgotten-export) The symbol "Fdc3SystemChannelListener_base" needs to be exported by the entry point index.d.ts
+//
+// @alpha
+export class Fdc3SystemChannelListener extends Fdc3SystemChannelListener_base {
+    // (undocumented)
+    protected addChannelListeners(): void;
+    // (undocumented)
+    config: SystemChannelListenerConfig[];
+    // (undocumented)
+    connectedCallback(): void;
+    // (undocumented)
+    deepClone(): Node;
+    // (undocumented)
+    disconnectedCallback(): void;
+    // (undocumented)
+    fdc3: FDC3;
+}
+
+// @alpha
+export interface IntentConfig {
+    // (undocumented)
+    callback: (FDC3Context: any) => void;
+    // (undocumented)
+    intent: string;
+}
+
+export { IntentHandler }
+
+export { IntentResolution }
+
+export { Intents }
+
+// @public
+export const interopFoundationNotificationListener: (overrideDefinition?: OverrideFoundationElementDefinition<    {
+baseName: string;
+template: ViewTemplate<NotificationListener, any>;
+shadowOptions: ShadowRootInit;
+}>) => FoundationElementRegistry<    {
+baseName: string;
+template: ViewTemplate<NotificationListener, any>;
+shadowOptions: ShadowRootInit;
+}, typeof InteropNotificationsListener>;
+
+// @public (undocumented)
+export class InteropNotificationsListener extends NotificationListener {
+    // (undocumented)
+    iOConnectNotificationOptions: IOConnectDesktop.Notifications.IOConnectNotificationOptions;
+    // (undocumented)
+    protected showNotificationToast(row: NotificationDataRow): void;
+}
+
+export { Listener }
+
+// @public
+export const logger: Logger;
+
+export { PrivateChannel }
+
+export { StandardIntent }
+
+// @alpha
+export interface SystemChannelListenerConfig {
+    // (undocumented)
+    callback: (any: any) => void;
+    // (undocumented)
+    channelType: string;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```