@openfin/workspace-platform 13.1.1 → 13.1.3

package/client-api/src/integrations/microsoft.d.ts

@@ -1,25 +1,19 @@
+import { HomeSearchListenerResponse } from '../../../client-api/src/shapes/home';
 import { WorkflowIntegration } from '../../../client-api/src/shapes/integrations';
-import { Microsoft365ConnectionConfig, Microsoft365IntegrationConfig, Microsoft365Workflows, Microsoft365WorkflowType, MicrosoftEntityTypeConfig, MicrosoftSearchWorkflowConfig } from './microsoft.shapes';
+import { Microsoft365ConnectionConfig, Microsoft365IntegrationConfig, Microsoft365Workflows, MicrosoftEntityTypeConfig, MicrosoftSearchWorkflowConfig } from './microsoft.shapes';
 export type { Microsoft365IntegrationConfig, Microsoft365ConnectionConfig, Microsoft365Workflows, MicrosoftSearchWorkflowConfig, MicrosoftEntityTypeConfig };
 /**
  * The Microsoft365WorkflowIntegration class is a WorkflowIntegration that provides Microsoft 365 integration.
  * This integration allows you to search for Microsoft 365 entities and perform actions on them using Home.
  */
 export declare class Microsoft365WorkflowIntegration extends WorkflowIntegration {
-    /** Instance of the Microsoft365Connection class. */
-    private connection;
+    #private;
     /** The configuration object for the integration. */
     config: Microsoft365IntegrationConfig;
     /** The name of the integration. Used for Analytics */
     workflowIntegrationName: string;
     /** The current searchResponse. This can be used to update results. */
-    private searchResponse;
-    /** The minimum length of a query before the search will be triggered. */
-    private readonly minQueryLength;
-    /** Set of all possible filters that can be applied to the search results. This is based on the config provided. */
-    private readonly searchTypePossibleFilters;
-    /** A LRU cache of profile pictures. */
-    private readonly profilePictureCache;
+    searchResponse: HomeSearchListenerResponse | undefined;
     /**
      * Creates an instance of Microsoft365WorkflowIntegration.
      *
@@ -56,13 +50,6 @@ export declare class Microsoft365WorkflowIntegration extends WorkflowIntegration
      * ```
      */
     connect: (config?: Microsoft365ConnectionConfig) => Promise<void>;
-    /**
-     * Gets the Microsoft365Connection instance.
-     *
-     * @returns The Microsoft365Connection instance.
-     */
-    private getConnection;
-    private handleTokenExpiry;
     /**
      * Wrapper around the Microsoft365Connection.executeApiRequest method.
      * If the request fails due to an expired auth token, this method will reconnect and retry the request.
@@ -72,51 +59,6 @@ export declare class Microsoft365WorkflowIntegration extends WorkflowIntegration
      * @returns The response from the Microsoft365Connection.executeApiRequest method.
      */
     private executeApiRequest;
-    private executeBatchApiRequest;
-    /**
-     * Executes a batch API request and maps the response to search results.
-     *
-     * If the request fails, we return an a single error result.
-     */
-    private executeBatchQuery;
-    /**
-     * Maps the response from a batch API request to search results.
-     *
-     * @param batchResponse The response from a batch API request.
-     * @returns An array of search results.
-     */
-    private mapBatchResponseToSearchResults;
-    /**
-     * Handles a search result being focused.
-     * @param result The search result that was focused.
-     */
-    private handleResultFocus;
-    private launchUrlInBrowser;
-    /**
-     * Handles a search result (ChatMessage) action being clicked.
-     * @param result The search result that was clicked.
-     * @returns A promise that resolves when the action has been handled.
-     */
-    private handleChatMessageUserAction;
-    /**
-     * Handles a search result (User) action being clicked.
-     * @param result The search result that was clicked.
-     * @returns A promise that resolves when the action has been handled.
-     */
-    private handleUserAction;
-    /**
-     * Handles a search result being actioned by the user.
-     * @param result The search result that was actioned.
-     */
-    private handleAction;
-    /**
-     * Creates a search result for a user.
-     * Called when a `user` search result is focused in the search results.
-     * @param res The search result to create a user result for.
-     */
-    private createUserResult;
-    private onUserInput;
-    private onResultDispatch;
     /**
      * Initializes a given workflow.
      *
@@ -151,5 +93,5 @@ export declare class Microsoft365WorkflowIntegration extends WorkflowIntegration
      * await microsoft365WorkflowIntegration.initializeWorkflow('search');
      * ```
      */
-    initializeWorkflow: (workflow: Microsoft365WorkflowType) => Promise<void>;
+    initializeWorkflow: (workflow: string) => Promise<void>;
 }

package/client-api/src/integrations/microsoft.shapes.d.ts

@@ -1,3 +1,4 @@
+import { DeepPartial } from '../../../common/src/utils/types';
 import { HomeProvider } from '../../../client-api/src/shapes/home';
 import { IntegrationWorkflows, WorkflowConfig, WorkflowIntegrationConfig } from '../../../client-api/src/shapes/integrations';
 /**
@@ -27,7 +28,7 @@ export interface MicrosoftEntityTypeConfig {
      *
      * @default true
      */
-    message: boolean;
+    message?: boolean;
     /**
      * Whether or not to include messages (Teams Messages) in the search results.
      *
@@ -39,12 +40,12 @@ export interface MicrosoftEntityTypeConfig {
      *
      * @default true
      */
-    chatMessage: boolean;
+    chatMessage?: boolean;
     /**
      * Whether or not to include files (OneDrive Files) in the search results.
      * @default true
      */
-    drive: boolean;
+    drive?: boolean;
     /**
      * Whether or not to include events (Outlook Calendar Events) in the search results.
      *
@@ -53,7 +54,7 @@ export interface MicrosoftEntityTypeConfig {
      *
      * @default true
      */
-    event: boolean;
+    event?: boolean;
     /**
      * Whether or not to include users (People) in the search results.
      *
@@ -62,7 +63,7 @@ export interface MicrosoftEntityTypeConfig {
      *
      * @default true
      */
-    user: boolean;
+    user?: boolean;
     /**
      * Whether or not to include contacts (Outlook Contacts) in the search results.
      *
@@ -71,14 +72,14 @@ export interface MicrosoftEntityTypeConfig {
      *
      * @default true
      */
-    contact: boolean;
+    contact?: boolean;
     /**
      * Whether or not to include lists (SharePoint Lists) in the search results.
      *
      * `'Sites.Read.All' OR 'Sites.ReadWrite.All' AND 'Mail.ReadWrite.Shared'` OAuth scope is required to access this data.
      * @default true
      */
-    list: boolean;
+    list?: boolean;
 }
 /**
  * Configuration object for the Microsoft 365 Search workflow integration.
@@ -93,7 +94,7 @@ export interface MicrosoftSearchWorkflowConfig extends WorkflowConfig {
      *
      * See {@link HomeProvider} for configuration options.
      */
-    homeProvider?: Omit<HomeProvider, 'onUserInput' | 'onResultDispatch'>;
+    homeProvider?: DeepPartial<Omit<HomeProvider, 'onUserInput' | 'onResultDispatch'>>;
     /**
      * Configuration object for the Microsoft 365 entity types to include in the search results.
      *
@@ -101,7 +102,7 @@ export interface MicrosoftSearchWorkflowConfig extends WorkflowConfig {
      *
      * See {@link MicrosoftEntityTypeConfig} for configuration options.
      */
-    MicrosoftEntityTypeConfig?: MicrosoftEntityTypeConfig;
+    microsoftEntityTypeConfig?: MicrosoftEntityTypeConfig;
     /**
      * The `msteams://` deep link can be used to open a Microsoft Teams chat in the Microsoft Teams desktop application.
      *
@@ -144,4 +145,3 @@ export interface Microsoft365IntegrationConfig extends WorkflowIntegrationConfig
     connect: Microsoft365ConnectionConfig;
     workflows?: Microsoft365Workflows;
 }
-export declare type Microsoft365WorkflowType = 'search';

package/client-api/src/integrations/microsoft.utils.d.ts

@@ -37,6 +37,12 @@ export declare const MICROSOFT_365_SEARCH_RESULT_ACTIONS: {
  * @returns An array of CLIFilter objects representing the validated filters.
  */
 export declare const getValidFilters: (req: Parameters<HomeProvider['onUserInput']>[0], searchTypePossibleFilters: Set<Microsoft365DocumentType>) => CLIFilter[];
+export declare const getValidContactFilters: (users: MicrosoftGraphTypes.User[], req: Parameters<HomeProvider['onUserInput']>[0]) => CLIFilter[];
+export declare const getContactFiltersFromRequest: (req: Parameters<HomeProvider['onUserInput']>[0]) => {
+    department: string[];
+    jobTitle: string[];
+};
+export declare const filterContactFromRequest: (items: MicrosoftGraphTypes.User[], filter: ReturnType<typeof getContactFiltersFromRequest>) => MicrosoftGraphTypes.User[];
 /**
  * Extracts type filters from the input request.
  *

package/client-api/src/shapes/integrations.d.ts

@@ -22,13 +22,11 @@ export interface WorkflowDependencies {
 export interface WorkflowIntegrationConfig {
     connect: unknown;
     workflows?: IntegrationWorkflows;
-    dependencies?: WorkflowDependencies;
 }
 export declare abstract class WorkflowIntegration {
-    workspacePlatformAPI: any;
+    #private;
     workflowIntegrationName: string;
     config: WorkflowIntegrationConfig;
-    private initializedWorkflows;
     constructor(config: WorkflowIntegrationConfig);
     connect: (config?: any) => Promise<void>;
     _initializeWorkflows: (config?: WorkflowIntegrationConfig) => Promise<void>;

package/client-api-platform/src/shapes.d.ts

@@ -13,6 +13,7 @@ export type { AttachedPage, Page, PageLayout, PageLayoutDetails, PageWithUpdatab
 export { PanelPosition } from '../../common/src/api/pages/shapes';
 export type { CustomThemes, CustomThemeOptions, CustomThemeOptionsWithScheme, CustomPaletteSet } from '../../common/src/api/theming';
 export type { AnalyticsEvent } from '../../common/src/utils/usage-register';
+export type { WorkflowIntegration } from '../../client-api/src/shapes/integrations';
 /**
  * Request for creating a saved page in persistent storage.
  */