@openfin/workspace 13.1.2 → 13.1.4

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

@@ -1,19 +1,16 @@
-import { HomeSearchListenerResponse } from '../../../client-api/src/shapes/home';
-import { WorkflowIntegration } from '../../../client-api/src/shapes/integrations';
+import { BaseWorkflowIntegration, WorkflowIntegration } from '../../../client-api/src/shapes/integrations';
 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 {
+export declare class Microsoft365WorkflowIntegration extends BaseWorkflowIntegration implements WorkflowIntegration {
     #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. */
-    searchResponse: HomeSearchListenerResponse | undefined;
     /**
      * Creates an instance of Microsoft365WorkflowIntegration.
      *

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';
 /**
@@ -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.
      *

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

@@ -23,12 +23,25 @@ export interface WorkflowIntegrationConfig {
     connect: unknown;
     workflows?: IntegrationWorkflows;
 }
-export declare abstract class WorkflowIntegration {
+export interface WorkflowIntegration {
+    /**
+     * Name of the Workflow Integration
+     * @example "Microsoft365"
+     */
+    workflowIntegrationName: string;
+    /**
+     * The config for the Workflow Integration
+     */
+    config: WorkflowIntegrationConfig;
+    connect: (config?: any) => Promise<void>;
+    initializeWorkflow: (workflow: string) => Promise<void>;
+    _initializeWorkflows: (config?: WorkflowIntegrationConfig) => Promise<void>;
+}
+export declare abstract class BaseWorkflowIntegration {
     #private;
     workflowIntegrationName: string;
     config: WorkflowIntegrationConfig;
     constructor(config: WorkflowIntegrationConfig);
-    connect: (config?: any) => Promise<void>;
     _initializeWorkflows: (config?: WorkflowIntegrationConfig) => Promise<void>;
     initializeWorkflow(workflow: string): Promise<void>;
 }

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

@@ -5,7 +5,7 @@ import { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/
 import type { AttachedPage, Page, PageWithUpdatableRuntimeAttribs } from '../../common/src/api/pages/shapes';
 import type { CustomThemes } from '../../common/src/api/theming';
 import type { App, DockProviderConfigWithIdentity, StoreButtonConfig } from '../../client-api/src/shapes';
-import { WorkflowIntegration } from '../../client-api/src/shapes/integrations';
+import type { WorkflowIntegration } from '../../client-api/src/shapes/integrations';
 export { AppManifestType } from '../../client-api/src/shapes';
 export type { App, AppIntent, Image } from '../../client-api/src/shapes';
 export type { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';

package/common/src/utils/ttl-cache.d.ts

@@ -0,0 +1,35 @@
+/**
+ * TTLCache class that provides a simple cache mechanism with TTL (Time To Live) functionality.
+ * It also maintains a maximum capacity and evicts the oldest entry when the capacity is reached.
+ */
+export default class TTLCache<T> {
+    #private;
+    /**
+     * TTLCache constructor.
+     * @param ttl - Time to live in milliseconds. Defaults to 300000 (5 minutes).
+     * @param capacity - Maximum capacity of the cache. Defaults to 100.
+     */
+    constructor(ttl?: number, capacity?: number);
+    /**
+     * Retrieves a value from the cache.
+     * @param key - The key to identify the cached item.
+     * @returns The cached item or null if the item does not exist or is expired.
+     */
+    get(key: string): T | null;
+    /**
+     * Stores a value in the cache.
+     * If the cache is at capacity, the oldest entry will be removed.
+     * @param key - The key to identify the item to be cached.
+     * @param value - The value to be cached.
+     */
+    put(key: string, value: T): void;
+    /**
+     * Removes a value from the cache.
+     * @param key - The key identifying the item to be removed.
+     */
+    remove(key: string): void;
+    /**
+     * Clears the entire cache.
+     */
+    clear(): void;
+}