Added stuff from FDC3 project for demo -- ready to demo

Author: robmoffat

package-lock.json

@@ -18,8 +18,7 @@
     "vite": "^5.0.2"
   },
   "dependencies": {
-    "@kite9/fdc3": "2.2.0-beta.23",
-    "@kite9/fdc3-web-impl": "2.2.0-beta.23",
+    "@kite9/fdc3": "2.2.0-beta.24",
     "@types/react-dom": "^18.2.25",
     "@types/uuid": "^9.0.8",
     "@types/ws": "^8.5.10",

package.json

@@ -1,4 +1,4 @@
-import { InstanceID } from "@kite9/fdc3-web-impl"
+import { InstanceID } from "../ftw/ServerContext"
 import { Socket } from "socket.io-client"
 import { FDC3_APP_EVENT, FDC3_DA_EVENT } from "../server/da/message-types"
 

src/app/util.ts

@@ -3,7 +3,7 @@ import { Icon } from "../icon/icon";
 import { getServerState } from "../state/ServerState";
 import * as styles from "./styles.module.css";
 import { Popup, PopupButton } from "../popups/popup";
-import { DirectoryApp } from "@kite9/fdc3-web-impl";
+import { DirectoryApp } from "../../ftw/directory/DirectoryInterface";
 import { getAppState } from "../state/AppState";
 
 const DEFAULT_ICON = "/static/icons/control/choose-app.svg";

src/client/appd/appd.tsx

@@ -1,6 +1,6 @@
 import { Frame } from "./frame/frame";
 import { createRoot } from "react-dom/client";
-import { getClientState } from "./state/clientState";
+import { getClientState } from "./state/ClientState";
 import { getAppState } from "./state/AppState";
 import "../../static/fonts/DM_Sans/DM_Sans.css";
 import { getServerState } from "./state/ServerState";

src/client/index.tsx

@@ -1,7 +1,7 @@
 import { BrowserTypes } from "@kite9/fdc3";
 import { getClientState } from "./ClientState"
 import { getServerState } from "./ServerState"
-import { DirectoryApp } from "@kite9/fdc3-web-impl";
+import { DirectoryApp } from "../../ftw/directory/DirectoryInterface";
 import { v4 as uuid } from 'uuid'
 
 type WebConnectionProtocol1Hello = BrowserTypes.WebConnectionProtocol1Hello

src/client/state/AppState.ts

@@ -1,4 +1,4 @@
-import { DirectoryApp } from "@kite9/fdc3-web-impl";
+import { DirectoryApp } from "../../ftw";
 import { getClientState } from "./ClientState";
 import { DA_DIRECTORY_LISTING, DA_HELLO, DA_REGISTER_APP_LAUNCH, DesktopAgentDirectoryListingArgs, DesktopAgentHelloArgs, DesktopAgentRegisterAppLaunchArgs, SAIL_APP_OPEN, SAIL_CHANNEL_CHANGE, SAIL_INTENT_RESOLVE, SailAppOpenArgs, SailChannelChangeArgs, SailIntentResolveArgs } from "../../server/da/message-types";
 import { io, Socket } from "socket.io-client"
@@ -20,7 +20,7 @@ export interface ServerState {
 
     getApplications(): Promise<DirectoryApp[]>
 
-    setAppChannel(instanceId: string, channel: string): Promise<void>
+    setUserChannel(instanceId: string, channel: string): Promise<void>
 
     intentChosen(ai: AppIdentifier | null, intent: string | null): Promise<void>
 }
@@ -83,7 +83,7 @@ class ServerStateImpl implements ServerState {
         })
     }
 
-    async setAppChannel(instanceId: string): Promise<void> {
+    async setUserChannel(instanceId: string): Promise<void> {
         const userSessionId = getClientState().getUserSessionID()
         await fetch("/setAppChannel", {
             method: "POST",

src/client/state/ServerState.ts

@@ -1,9 +1,9 @@
-import { ChannelState, DirectoryApp } from "@kite9/fdc3-web-impl"
+import { ChannelState, DirectoryApp } from "../../ftw/directory/DirectoryInterface";
 import { GridStackPosition } from "gridstack"
 import { v4 as uuidv4 } from 'uuid';
 import { DesktopAgentHelloArgs } from "../../server/da/message-types";
 import { AppIntent, Context, DisplayMetadata } from "@kite9/fdc3";
-import { ChannelType } from "@kite9/fdc3-web-impl/dist/src/handlers/BroadcastHandler";
+import { ChannelType } from "../../ftw/handlers/BroadcastHandler";
 import { getServerState } from "./ServerState";
 
 const STORAGE_KEY = "sail-client-state"
@@ -147,7 +147,7 @@ abstract class AbstractClientState implements ClientState {
                 x: -1,
                 y: -1,
                 w: 6,
-                h: 4,
+                h: 8,
                 title: detail.title,
                 tabId: this.activeTabId,
                 panelId: instanceId,

src/client/state/clientState.ts

@@ -0,0 +1,61 @@
+import { FDC3Server } from "./FDC3Server";
+import { InstanceID, ServerContext } from "./ServerContext";
+import { BroadcastHandler, ChannelState } from "./handlers/BroadcastHandler";
+import { IntentHandler } from "./handlers/IntentHandler";
+import { Directory } from "./directory/DirectoryInterface";
+import { OpenHandler } from "./handlers/OpenHandler";
+import { BrowserTypes } from "@kite9/fdc3-schema";
+import { HeartbeatHandler } from "./handlers/HeartbeatHandler";
+
+type AppRequestMessage = BrowserTypes.AppRequestMessage
+type WebConnectionProtocol4ValidateAppIdentity = BrowserTypes.WebConnectionProtocol4ValidateAppIdentity
+
+export interface MessageHandler {
+
+    /**
+     * Handles an AgentRequestMessage from the messaging source
+     */
+    accept(msg: any, sc: ServerContext<any>, from: InstanceID): void
+
+    shutdown(): void
+}
+
+/**
+ * This defers all functionality to either MessageHandler's or the ServerContext objects.
+ */
+export class BasicFDC3Server implements FDC3Server {
+
+    private handlers: MessageHandler[]
+    private sc: ServerContext<any>
+
+    constructor(handlers: MessageHandler[], sc: ServerContext<any>) {
+        this.handlers = handlers
+        this.sc = sc;
+    }
+
+    receive(message: AppRequestMessage | WebConnectionProtocol4ValidateAppIdentity, from: InstanceID): void {
+        // this.sc.log(`MessageReceived: \n ${JSON.stringify(message, null, 2)}`)
+        this.handlers.forEach(h => h.accept(message, this.sc, from))
+    }
+
+    shutdown(): void {
+        this.handlers.forEach(h => h.shutdown())
+    }
+}
+
+export class DefaultFDC3Server extends BasicFDC3Server {
+
+    constructor(sc: ServerContext<any>, directory: Directory, userChannels: ChannelState[], heartbeats: boolean, intentTimeoutMs: number = 20000, openHandlerTimeoutMs: number = 3000) {
+        const handlers: MessageHandler[] = [
+            new BroadcastHandler(userChannels),
+            new IntentHandler(directory, intentTimeoutMs),
+            new OpenHandler(directory, openHandlerTimeoutMs),
+        ]
+
+        if (heartbeats) {
+            handlers.push(new HeartbeatHandler(openHandlerTimeoutMs / 4, openHandlerTimeoutMs / 2, openHandlerTimeoutMs))
+        }
+
+        super(handlers, sc)
+    }
+}

src/ftw/BasicFDC3Server.ts

@@ -0,0 +1,13 @@
+import { InstanceID } from "./ServerContext";
+import { BrowserTypes } from "@kite9/fdc3-schema";
+
+type AppRequestMessage = BrowserTypes.AppRequestMessage
+
+export interface FDC3Server {
+
+  /**
+   * Receive an incoming message
+   */
+  receive(message: AppRequestMessage, from: InstanceID): void
+
+}

src/ftw/FDC3Server.ts

@@ -0,0 +1,98 @@
+import { AppIntent, AppIdentifier } from "@kite9/fdc3-standard";
+import { Context } from "@kite9/fdc3-context";
+
+
+/**
+ * This is a unique, long, unguessable string that identifies a particular instance of an app.
+ * All messages arriving at the desktop agent will have this UUID attached to them.
+ * It is important that this is unguessable as it is a "password" of sorts used to 
+ * identify the app between reconnections.
+ */
+export type InstanceID = string
+
+/**
+ * Handles messaging to apps and opening apps
+ */
+export interface ServerContext<X extends AppIdentifier> {
+
+    /**
+     * UUID for outgoing message
+     */
+    createUUID(): string;
+
+    /**
+     * Post an outgoing message to a particular app
+     */
+    post(message: object, instanceId: InstanceID): Promise<void>
+
+    /**
+     * Post an outgoing message to a particular app
+     */
+    post(message: object, instanceId: InstanceID): Promise<void>
+
+    /**
+     * Opens a new instance of an application.  
+     * Promise completes once the application window is opened
+     */
+    open(appId: string): Promise<InstanceID>
+
+    /**
+     * Registers a particular instance id with a given app id
+     */
+    setInstanceDetails(uuid: InstanceID, details: X): void
+
+    /**
+     * Returns the UUID for a particular instance of an app.
+     * This is used in situations where an app is reconnecting to the same desktop agent.
+     */
+    getInstanceDetails(uuid: InstanceID): X | undefined
+
+    /**
+     * Registers an app as connected to the desktop agent. 
+     */
+    setAppConnected(app: AppIdentifier): Promise<void>
+
+    /**
+     * Unregisters the app as connected to the desktop agent.
+     */
+    setAppDisconnected(app: AppIdentifier): Promise<void>
+
+    /**
+     * Returns the list of apps open and connected to FDC3 at the current time.
+     * Note, it is the implementor's job to ensure this list is
+     * up-to-date in the event of app crashes or disconnections.
+     */
+    getConnectedApps(): Promise<AppIdentifier[]>
+
+    /**
+     * Helper function for determining if an app is currently open and connected to the da
+     */
+    isAppConnected(app: AppIdentifier): Promise<boolean>
+
+    /**
+     * Allows you to write a log message somewhere
+     */
+    log(message: string): void
+
+    /**
+     * Name of the provider of this desktop agent server
+     */
+    provider(): string
+
+    /**
+     * Version of the provider of this desktop agent server
+     */
+    providerVersion(): string
+
+    /**
+     * Supported version of the FDC3 API of the desktop agent server.
+     */
+    fdc3Version(): string
+
+    /**
+     * This is called prior to returning intents to the client.  It is a
+     * an opportunity for the server to either present an intent resolver 
+     * or otherwise mess with the availble intents, or do nothing.
+     */
+    narrowIntents(appIntents: AppIntent[], context: Context): Promise<AppIntent[]>
+}