Loader.ts

import { DesktopAgent, WebDesktopAgentType } from '@finos/fdc3-standard';
import { GetAgentParams } from '@finos/fdc3-standard';

/**
 * Represents the common interface for a loading strategy
 */
export interface Loader {
  /**
   * Promise will either resolve to a DesktopAgent or reject with an error
   */
  get(options: GetAgentParams): Promise<DesktopAgentSelection>;

  cancel(): Promise<void>;

  name: string;
}

/** Specific partial of DesktopAgentDetails defining the details that Loaders
 *  must return with a DesktopAgent to be put into SessionStorage at the end
 *  of the process.
 */
export interface DesktopAgentSelection {
  agent: DesktopAgent;
  details: {
    agentType: WebDesktopAgentType;
    identityUrl: string;
    actualUrl: string;
    agentUrl?: string;
    appId: string;
    instanceId: string;
    instanceUuid: string;
  };
}