@openfin/cloud-api 0.0.1-alpha.cb4210c → 0.0.1-alpha.cb6804f

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as OpenFin from '@openfin/core';
2
- import OpenFin__default from '@openfin/core';
2
+ import OpenFin__default, { OpenFin as OpenFin$1 } from '@openfin/core';
3
3
  import * as NotificationsTypes from '@openfin/workspace/notifications';
4
4
 
5
5
  /**
@@ -298,40 +298,42 @@ declare function launchSupertab(id: string): Promise<void>;
298
298
  declare function launchWorkspace(id: string): Promise<void>;
299
299
 
300
300
  /**
301
- * Function that is called when the Search Agent receives an action from Here™’s search UI that has been triggered by the user on one of the Agents search results.
301
+ * Function that is called when the Search Agent receives an action from HERE's search UI that has been triggered by the user on one of the Agent's search results.
302
302
  *
303
303
  * @param action The action that was triggered.
304
304
  * @param result The search result that the action was triggered on.
305
305
  *
306
- * @returns Result that includes the URL that Here™ should navigate to, or `undefined` if no navigation is required.
306
+ * @returns Result that includes the URL that HERE should navigate to, or `undefined` if no navigation is required.
307
307
  */
308
- type OnActionListener = (action: SearchAction, result: SearchResult) => SearchResultActionResponse | Promise<SearchResultActionResponse>;
308
+ type OnActionListener = (action: SearchAction$1, result: SearchResult$1) => SearchResultActionResponse$1 | Promise<SearchResultActionResponse$1>;
309
309
  /**
310
- * Function that is called when the Search Agent receives a query from Here™’s search UI
310
+ * Function that is called when the Search Agent receives a query from HERE's search UI
311
311
  *
312
312
  * @param request Search request data that includes the query.
313
313
  *
314
314
  * @returns Search response data that includes the search results.
315
315
  */
316
- type OnSearchListener = (request: SearchListenerRequest) => SearchResponse | Promise<SearchResponse>;
316
+ type OnSearchListener = (request: SearchListenerRequest$1) => SearchResponse$1 | Promise<SearchResponse$1>;
317
317
  /**
318
318
  * An action that can be triggered by a user on a search result returned by a Search Agent.
319
319
  *
320
- * Actions are displayed as buttons alongside search results in Here™’s search UI. That is, except for the first action, which is hidden as it is triggered automatically when the user selects the search result.
320
+ * Actions are displayed as buttons alongside search results in HERE's search UI. That is, except for the first action, which is hidden as it is triggered automatically when the user selects the search result.
321
321
  */
322
- type SearchAction = {
323
- /**
324
- * URL or data URI of an icon that will be displayed within the action button when Here™ is in Light mode.
325
- */
326
- darkIcon?: string;
322
+ type SearchAction$1 = {
327
323
  /**
328
- * A fuller description of the action that will be displayed in Here™’s search UI when the user hovers over the action button.
324
+ * A fuller description of the action that will be displayed in HERE's search UI when the user hovers over the action button.
329
325
  */
330
326
  description?: string;
331
327
  /**
332
- * URL or data URI of an icon that will be displayed within the action button when Here™ is in Dark mode.
328
+ * Icon that will be displayed within the action button in HERE's search UI.
329
+ *
330
+ * This can be a URL/data URI string (used for both Light and Dark modes),
331
+ * or an object containing separate icons for Light and Dark modes.
333
332
  */
334
- lightIcon?: string;
333
+ icon?: string | {
334
+ dark: string;
335
+ light: string;
336
+ };
335
337
  /**
336
338
  * Internal identifier for the action which is used to identify the action in the {@link OnActionListener}.
337
339
  */
@@ -342,34 +344,61 @@ type SearchAction = {
342
344
  title?: string;
343
345
  };
344
346
  /**
345
- * A Search Agent returns search results to Here™’s search UI in response to user input, and acts on the users actions regarding those results.
347
+ * A Search Agent returns search results to HERE's search UI in response to user input, and acts on the user's actions regarding those results.
348
+ *
349
+ * @deprecated Use {@link Agent} instead.
346
350
  */
347
351
  type SearchAgent = {
348
- /**
349
- * The Search Agent’s custom configuration data configured via the Admin Console.
350
- */
351
- readonly customData: unknown;
352
352
  /**
353
353
  * Sets whether or not the Search Agent is ready to provide search results.
354
354
  *
355
355
  * When a Search Agent is first registered, it will not receive search queries until it is set as ready by calling this function.
356
356
  *
357
357
  * @param ready Whether the Search Agent is ready to provide search results (defaults to `true`).
358
+ *
359
+ * @deprecated Use {@link Agent.setIsReady} instead.
358
360
  */
359
361
  isReady: (ready?: boolean) => Promise<void>;
360
362
  };
363
+ /**
364
+ * The Search Agent's configuration data as configured in the HERE Admin Console.
365
+ *
366
+ * @typeParam T Type definition for the `customData` property, containing any custom configuration data specific to the Search Agent.
367
+ */
368
+ type SearchAgentConfigurationData<T> = {
369
+ /**
370
+ * Custom configuration data specific to the Search Agent.
371
+ */
372
+ customData?: T;
373
+ /**
374
+ * Optional description of the Search Agent.
375
+ */
376
+ description?: string;
377
+ /**
378
+ * Unique identifier for the Search Agent.
379
+ */
380
+ id: string;
381
+ /**
382
+ * The display title of the Search Agent.
383
+ */
384
+ title: string;
385
+ /**
386
+ * The URL of the Search Agent.
387
+ */
388
+ url: string;
389
+ };
361
390
  /**
362
391
  * Configuration provided when registering a Search Agent.
363
392
  */
364
393
  type SearchAgentRegistrationConfig = {
365
394
  /**
366
- * This listener is called when the Search Agent receives an action from Here™’s search UI that has been triggered by the user on one of the Agents search results.
395
+ * This listener is called when the Search Agent receives an action from HERE's search UI that has been triggered by the user on one of the Agent's search results.
367
396
  *
368
- * The listener returns a response back to Here™ that includes a URL to navigate to.
397
+ * The listener returns a response back to HERE that includes a URL to navigate to.
369
398
  */
370
399
  onAction: OnActionListener;
371
400
  /**
372
- * This listener is called when the Search Agent receives a query from Here™’s search UI and returns relevant search results.
401
+ * This listener is called when the Search Agent receives a query from HERE's search UI and returns relevant search results.
373
402
  *
374
403
  * Note: When the Search Agent is not ready this listener will not be called.
375
404
  */
@@ -378,13 +407,13 @@ type SearchAgentRegistrationConfig = {
378
407
  /**
379
408
  * Search request data provided to the {@link OnSearchListener}.
380
409
  */
381
- type SearchListenerRequest = {
410
+ type SearchListenerRequest$1 = {
382
411
  /**
383
412
  * Provides additional context for the search request.
384
413
  */
385
- context: SearchRequestContext;
414
+ context: SearchRequestContext$1;
386
415
  /**
387
- * The query entered by the user in Here™’s search UI.
416
+ * The query entered by the user in HERE's search UI.
388
417
  */
389
418
  query: string;
390
419
  /**
@@ -395,7 +424,7 @@ type SearchListenerRequest = {
395
424
  /**
396
425
  * Context data included with a search request.
397
426
  */
398
- type SearchRequestContext = {
427
+ type SearchRequestContext$1 = {
399
428
  /**
400
429
  * The page number of the search results to return.
401
430
  */
@@ -404,30 +433,34 @@ type SearchRequestContext = {
404
433
  * The number of search results to return per page.
405
434
  */
406
435
  pageSize: number;
436
+ /**
437
+ * The unique ID of the query.
438
+ */
439
+ queryId: string;
407
440
  };
408
441
  /**
409
442
  * Return type of the {@link OnSearchListener}.
410
443
  */
411
- type SearchResponse = {
444
+ type SearchResponse$1 = {
412
445
  /**
413
- * The search results to display in Here™’s search UI.
446
+ * The search results to display in HERE's search UI.
414
447
  */
415
- results: SearchResult[];
448
+ results: SearchResult$1[];
416
449
  };
417
450
  /**
418
451
  * A search result returned by a Search Agent in response to a search request.
419
452
  */
420
- type SearchResult = {
453
+ type SearchResult$1 = {
421
454
  /**
422
455
  * Actions that can be triggered by the user against the search result.
423
456
  */
424
- actions: SearchAction[];
457
+ actions: SearchAction$1[];
425
458
  /**
426
459
  * Additional data that can be used by the {@link OnActionListener} when an action is triggered.
427
460
  */
428
461
  data?: Record<string, unknown>;
429
462
  /**
430
- * URL or data URI of an icon that will be displayed with the search result in Here™’s search UI.
463
+ * URL or data URI of an icon that will be displayed with the search result in HERE's search UI.
431
464
  */
432
465
  icon?: string;
433
466
  /**
@@ -435,26 +468,48 @@ type SearchResult = {
435
468
  */
436
469
  key: string;
437
470
  /**
438
- * Secondary text that will be displayed with the search result in Here™’s search UI.
471
+ * Secondary text that will be displayed with the search result in HERE's search UI.
439
472
  */
440
473
  label?: string;
441
474
  /**
442
- * Primary text that will be displayed with the search result in Here™’s search UI.
475
+ * Primary text that will be displayed with the search result in HERE's search UI.
443
476
  */
444
477
  title: string;
445
478
  };
446
479
  /**
447
480
  * Return type of the {@link OnActionListener}.
448
481
  */
449
- type SearchResultActionResponse = {
482
+ type SearchResultActionResponse$1 = {
450
483
  /**
451
- * URL that Here™ should navigate to.
484
+ * URL that HERE should navigate to.
452
485
  */
453
486
  url: string;
454
487
  } | undefined;
455
488
 
456
489
  /**
457
- * Registers a Search Agent that will provide search results to Here™’s search UI in response to user input and act on the user’s actions regarding those results.
490
+ * Retrieves the Search Agent's configuration data, as has been configured in the HERE Admin Console.
491
+ *
492
+ * @returns A promise that resolves with an object containing properties that match the Search Agent’s configuration.
493
+ *
494
+ * @example Retrieving the Search Agent’s configuration data:
495
+ * ```ts
496
+ * import { Search } from "@openfin/cloud-api";
497
+ *
498
+ * // Get the configuration data
499
+ * const configData = await Search.getAgentConfiguration<{ customField1: string, customField2: string }>();
500
+ *
501
+ * // Pick out the standard configuration properties
502
+ * const { customData, description, id, title, url } = configData;
503
+ *
504
+ * // Pick out the custom configuration properties
505
+ * if (customData) {
506
+ * const { customField1, customField2 } = customData;
507
+ * }
508
+ * ```
509
+ */
510
+ declare function getAgentConfiguration<T extends object>(): Promise<SearchAgentConfigurationData<T>>;
511
+ /**
512
+ * Registers a Search Agent that will provide search results to HERE's search UI in response to user input and act on the user's actions regarding those results.
458
513
  *
459
514
  * @param config The configuration for the Search Agent.
460
515
  *
@@ -462,6 +517,8 @@ type SearchResultActionResponse = {
462
517
  *
463
518
  * @example Registering a basic Search Agent:
464
519
  * ```ts
520
+ * import { Search } from "@openfin/cloud-api";
521
+ *
465
522
  * // Handle incoming action and return a response that includes the URL to navigate to
466
523
  * const onAction: Search.OnActionListener = (action, result) => {
467
524
  * const { name } = action;
@@ -503,6 +560,10 @@ type SearchResultActionResponse = {
503
560
  * name: "view-owner",
504
561
  * description: `Go to ${ownerName} in My Web App`,
505
562
  * title: "View Owner",
563
+ * icon: {
564
+ * dark: "data:image/svg+xml,...",
565
+ * light: "data:image/svg+xml,...",
566
+ * },
506
567
  * },
507
568
  * ],
508
569
  * data: {
@@ -532,22 +593,352 @@ type SearchResultActionResponse = {
532
593
  * // Set the Search Agent as ready to receive search requests
533
594
  * await searchAgent.isReady();
534
595
  * ```
596
+ *
597
+ * @deprecated Use `Agent.register` instead.
598
+ */
599
+ declare function register$1(config: SearchAgentRegistrationConfig): Promise<SearchAgent>;
600
+
601
+ type index$1_OnActionListener = OnActionListener;
602
+ type index$1_OnSearchListener = OnSearchListener;
603
+ type index$1_SearchAgent = SearchAgent;
604
+ type index$1_SearchAgentConfigurationData<T> = SearchAgentConfigurationData<T>;
605
+ type index$1_SearchAgentRegistrationConfig = SearchAgentRegistrationConfig;
606
+ declare const index$1_getAgentConfiguration: typeof getAgentConfiguration;
607
+ declare namespace index$1 {
608
+ export { type index$1_OnActionListener as OnActionListener, type index$1_OnSearchListener as OnSearchListener, type SearchAction$1 as SearchAction, type index$1_SearchAgent as SearchAgent, type index$1_SearchAgentConfigurationData as SearchAgentConfigurationData, type index$1_SearchAgentRegistrationConfig as SearchAgentRegistrationConfig, type SearchListenerRequest$1 as SearchListenerRequest, type SearchRequestContext$1 as SearchRequestContext, type SearchResponse$1 as SearchResponse, type SearchResult$1 as SearchResult, type SearchResultActionResponse$1 as SearchResultActionResponse, index$1_getAgentConfiguration as getAgentConfiguration, register$1 as register };
609
+ }
610
+
611
+ /**
612
+ * Function that is called when the Agent receives an action from HERE's search UI that has been triggered by the user on one of the Agent's search results.
613
+ *
614
+ * @param action The action that was triggered.
615
+ * @param result The search result that the action was triggered on.
616
+ *
617
+ * @returns Result that includes the URL that HERE should navigate to, or `undefined` if no navigation is required.
618
+ */
619
+ type OnSearchActionListener = (action: SearchAction, result: SearchResult) => SearchResultActionResponse | Promise<SearchResultActionResponse>;
620
+ /**
621
+ * Function that is called when the Agent receives a query from HERE's search UI
622
+ *
623
+ * @param request Search request data that includes the query.
624
+ *
625
+ * @returns Search response data that includes the search results.
626
+ */
627
+ type OnSearchRequestListener = (request: SearchListenerRequest) => SearchResponse | Promise<SearchResponse>;
628
+ /**
629
+ * An action that can be triggered by a user on a search result returned by a Agent.
630
+ *
631
+ * Actions are displayed as buttons alongside search results in HERE's search UI. That is, except for the first action, which is hidden as it is triggered automatically when the user selects the search result.
632
+ */
633
+ type SearchAction = {
634
+ /**
635
+ * A fuller description of the action that will be displayed in HERE's search UI when the user hovers over the action button.
636
+ */
637
+ description?: string;
638
+ /**
639
+ * Icon that will be displayed within the action button in HERE's search UI.
640
+ *
641
+ * This can be a URL/data URI string (used for both Light and Dark modes),
642
+ * or an object containing separate icons for Light and Dark modes.
643
+ */
644
+ icon?: string | {
645
+ dark: string;
646
+ light: string;
647
+ };
648
+ /**
649
+ * Internal identifier for the action which is used to identify the action in the {@link OnSearchActionListener}.
650
+ */
651
+ name: string;
652
+ /**
653
+ * Compact title of the action displayed within the action button.
654
+ */
655
+ title?: string;
656
+ };
657
+ /**
658
+ * Search request data provided to the {@link OnSearchRequestListener}.
659
+ */
660
+ type SearchListenerRequest = {
661
+ /**
662
+ * Provides additional context for the search request.
663
+ */
664
+ context: SearchRequestContext;
665
+ /**
666
+ * The query entered by the user in HERE's search UI.
667
+ */
668
+ query: string;
669
+ /**
670
+ * Provide this signal to any `fetch` requests executed in the {@link OnSearchRequestListener} function as a result of this search request, so that they will be automatically cancelled if a new search request is received before they complete.
671
+ */
672
+ signal: AbortSignal;
673
+ };
674
+ /**
675
+ * Context data included with a search request.
676
+ */
677
+ type SearchRequestContext = {
678
+ /**
679
+ * Filters to apply to the search results.
680
+ */
681
+ filters: string[];
682
+ /**
683
+ * The locale of the client.
684
+ */
685
+ locale: string;
686
+ /**
687
+ * The page number of the search results to return.
688
+ */
689
+ pageNumber: number;
690
+ /**
691
+ * The number of search results to return per page.
692
+ */
693
+ pageSize: number;
694
+ /**
695
+ * The unique ID of the query.
696
+ */
697
+ queryId: string;
698
+ /**
699
+ * The timezone of the client.
700
+ */
701
+ timeZone: string;
702
+ };
703
+ /**
704
+ * Return type of the {@link OnSearchRequestListener}.
705
+ */
706
+ type SearchResponse = {
707
+ /**
708
+ * The search results to display in HERE's search UI.
709
+ */
710
+ results: SearchResult[];
711
+ };
712
+ /**
713
+ * A search result returned by a Agent in response to a search request.
714
+ */
715
+ type SearchResult = {
716
+ /**
717
+ * Actions that can be triggered by the user against the search result.
718
+ */
719
+ actions: SearchAction[];
720
+ /**
721
+ * Additional data that can be used by the {@link OnSearchActionListener} when an action is triggered.
722
+ */
723
+ data?: Record<string, unknown>;
724
+ /**
725
+ * URL or data URI of an icon that will be displayed with the search result in HERE's search UI.
726
+ */
727
+ icon?: string;
728
+ /**
729
+ * Unique identifier for the search result.
730
+ */
731
+ key: string;
732
+ /**
733
+ * Secondary text that will be displayed with the search result in HERE's search UI.
734
+ */
735
+ label?: string;
736
+ /**
737
+ * Primary text that will be displayed with the search result in HERE's search UI.
738
+ */
739
+ title: string;
740
+ };
741
+ /**
742
+ * Return type of the {@link OnSearchActionListener}.
743
+ */
744
+ type SearchResultActionResponse = {
745
+ /**
746
+ * URL that HERE should navigate to.
747
+ */
748
+ url: string;
749
+ } | undefined;
750
+
751
+ type Agent = {
752
+ /**
753
+ * The features supported by the Agent.
754
+ */
755
+ features: AgentFeatures;
756
+ /**
757
+ * Joins the agent to a specific interop channel.
758
+ *
759
+ * @throws {InteropFeatureNotSupportedError} if the interop feature is not supported by the agent.
760
+ */
761
+ joinInteropChannel: (channelName: InteropColorChannel) => Promise<void>;
762
+ /**
763
+ * Sets whether or not the Agent is ready.
764
+ *
765
+ * @param ready Whether the Agent is ready (defaults to `true`).
766
+ */
767
+ setIsReady: (ready?: boolean) => Promise<void>;
768
+ };
769
+ /**
770
+ * The features supported by the Agent.
771
+ */
772
+ type AgentFeatures = {
773
+ interop?: {
774
+ defaultChannel?: InteropColorChannel;
775
+ fdc3Version: OpenFin$1.FDC3.Version;
776
+ };
777
+ search?: {
778
+ filters?: AgentSearchFilter[];
779
+ supportsPaging: boolean;
780
+ };
781
+ };
782
+ /**
783
+ * Configuration provided when registering a Agent.
784
+ */
785
+ type AgentRegistrationConfig = {
786
+ /**
787
+ * Search configuration required if the Agent supports search functionality.
788
+ */
789
+ search?: {
790
+ /**
791
+ * This listener is called when the Agent receives an action from HERE's search UI that has been triggered by the user on one of the Agent's search results.
792
+ *
793
+ * The listener returns a response back to HERE that includes a URL to navigate to.
794
+ */
795
+ onAction: OnSearchActionListener;
796
+ /**
797
+ * This listener is called when the Agent receives a query from HERE's search UI and returns relevant search results.
798
+ *
799
+ * Note: When the Agent is not ready this listener will not be called.
800
+ */
801
+ onSearch: OnSearchRequestListener;
802
+ };
803
+ };
804
+ /**
805
+ * A filter that can be applied to the Agent’s search results.
806
+ */
807
+ type AgentSearchFilter = {
808
+ icon?: string | {
809
+ dark: string;
810
+ light: string;
811
+ };
812
+ id: string;
813
+ title: string;
814
+ };
815
+ type InteropColorChannel = 'blue' | 'indigo' | 'pink' | 'teal' | 'green' | 'orange' | 'red' | 'yellow' | 'gray' | 'none';
816
+
817
+ /**
818
+ * Retrieves the Agent's configuration data, as has been configured in the HERE Admin Console.
819
+ *
820
+ * @returns A promise that resolves with an object containing properties that match the Agent’s configuration.
821
+ *
822
+ * @example Retrieving the Agent’s configuration data:
823
+ * ```ts
824
+ * import { Agent } from "@openfin/cloud-api";
825
+ *
826
+ * // Get the configuration data
827
+ * const configData = await Agent.getConfiguration<{ customField1: string, customField2: string }>();
828
+ *
829
+ * // Pick out the standard configuration properties
830
+ * const { customData, description, id, title, url } = configData;
831
+ *
832
+ * // Pick out the custom configuration properties
833
+ * if (customData) {
834
+ * const { customField1, customField2 } = customData;
835
+ * }
836
+ * ```
837
+ */
838
+ declare const getConfiguration: <T extends Record<string, unknown>>() => Promise<T>;
839
+ /**
840
+ * Registers an Agent.
841
+ *
842
+ * @param config The configuration for the Agent.
843
+ *
844
+ * @returns A promise that resolves with the Agent.
845
+ *
846
+ * @example Registering an Agent that will provide search results:
847
+ * ```ts
848
+ * import { Agent } from "@openfin/cloud-api";
849
+ *
850
+ * // Handle incoming action and return a response that includes the URL to navigate to
851
+ * const onAction: Agent.OnSearchActionListener = (action, result) => {
852
+ * const { name } = action;
853
+ * const { data, key } = result;
854
+ * const { owner, searchResultHostUrl } = data as { owner: { id: string, name: string }, searchResultHostUrl: string };
855
+ * const { id: ownerId } = owner;
856
+ *
857
+ * console.log(`Action "${name}" triggered on search result with key "${key}"`);
858
+ *
859
+ * switch (name) {
860
+ * case "view-owner":
861
+ * return { url: `${searchResultHostUrl}/people/${ownerId}` };
862
+ * case "view-result":
863
+ * return { url: `${searchResultHostUrl}/record/${key}` };
864
+ * default:
865
+ * console.warn(`Unknown action: ${name}`);
866
+ * }
867
+ * };
868
+ *
869
+ * // Handle incoming search request and return relevant search results
870
+ * const onSearch: Agent.OnSearchRequestListener = ({ context, query, signal }) => {
871
+ * const { pageNumber, pageSize } = context;
872
+ * try {
873
+ * let results: Agent.SearchResult[] = [];
874
+ * const url = `https://my-web-app.com/search?q=${query}&page=${pageNumber}&limit=${pageSize}`;
875
+ * const response = await fetch(url, { signal });
876
+ * if (!response.ok) {
877
+ * throw new Error(`Request failed: ${response.status}`);
878
+ * }
879
+ * const { searchResults } = await response.json();
880
+ * results = searchResults.map((result) => {
881
+ * const { iconUrl, id: key, owner, subTitle, title } = result;
882
+ * const { name: ownerName } = owner as { id: string, name: string };
883
+ * return {
884
+ * actions: [
885
+ * {
886
+ * name: "view-result",
887
+ * description: `Go to ${title} in My Web App`,
888
+ * },
889
+ * {
890
+ * name: "view-owner",
891
+ * description: `Go to ${ownerName} in My Web App`,
892
+ * title: "View Owner",
893
+ * icon: {
894
+ * dark: "data:image/svg+xml,...",
895
+ * light: "data:image/svg+xml,...",
896
+ * },
897
+ * },
898
+ * ],
899
+ * data: {
900
+ * owner,
901
+ * searchResultHostUrl: `https://my-web-app.com`,
902
+ * },
903
+ * icon: iconUrl,
904
+ * key,
905
+ * label: subTitle,
906
+ * title,
907
+ * };
908
+ * });
909
+ * console.log("Returning results", results);
910
+ * return { results };
911
+ * } catch (err) {
912
+ * if ((err as Error).name === "AbortError") {
913
+ * // Ignore errors for cancelled requests
914
+ * return { results: [] };
915
+ * }
916
+ * throw err;
917
+ * }
918
+ * };
919
+ *
920
+ * // Register the agent
921
+ * const agent = await Agent.register({ search: { onAction, onSearch } });
922
+ *
923
+ * // Set the Agent as ready to receive requests
924
+ * await agent.isReady();
925
+ * ```
535
926
  */
536
- declare function register(config: SearchAgentRegistrationConfig): Promise<SearchAgent>;
927
+ declare function register(config: AgentRegistrationConfig): Promise<Agent>;
537
928
 
538
- type index_OnActionListener = OnActionListener;
539
- type index_OnSearchListener = OnSearchListener;
540
- type index_SearchAction = SearchAction;
541
- type index_SearchAgent = SearchAgent;
542
- type index_SearchAgentRegistrationConfig = SearchAgentRegistrationConfig;
929
+ type index_Agent = Agent;
930
+ type index_AgentFeatures = AgentFeatures;
931
+ type index_AgentRegistrationConfig = AgentRegistrationConfig;
932
+ type index_AgentSearchFilter = AgentSearchFilter;
933
+ type index_InteropColorChannel = InteropColorChannel;
934
+ type index_OnSearchActionListener = OnSearchActionListener;
935
+ type index_OnSearchRequestListener = OnSearchRequestListener;
543
936
  type index_SearchListenerRequest = SearchListenerRequest;
544
- type index_SearchRequestContext = SearchRequestContext;
545
- type index_SearchResponse = SearchResponse;
546
937
  type index_SearchResult = SearchResult;
547
- type index_SearchResultActionResponse = SearchResultActionResponse;
938
+ declare const index_getConfiguration: typeof getConfiguration;
548
939
  declare const index_register: typeof register;
549
940
  declare namespace index {
550
- export { type index_OnActionListener as OnActionListener, type index_OnSearchListener as OnSearchListener, type index_SearchAction as SearchAction, type index_SearchAgent as SearchAgent, type index_SearchAgentRegistrationConfig as SearchAgentRegistrationConfig, type index_SearchListenerRequest as SearchListenerRequest, type index_SearchRequestContext as SearchRequestContext, type index_SearchResponse as SearchResponse, type index_SearchResult as SearchResult, type index_SearchResultActionResponse as SearchResultActionResponse, index_register as register };
941
+ export { type index_Agent as Agent, type index_AgentFeatures as AgentFeatures, type index_AgentRegistrationConfig as AgentRegistrationConfig, type index_AgentSearchFilter as AgentSearchFilter, type index_InteropColorChannel as InteropColorChannel, type index_OnSearchActionListener as OnSearchActionListener, type index_OnSearchRequestListener as OnSearchRequestListener, type index_SearchListenerRequest as SearchListenerRequest, type index_SearchResult as SearchResult, index_getConfiguration as getConfiguration, index_register as register };
551
942
  }
552
943
 
553
944
  declare global {
@@ -556,4 +947,4 @@ declare global {
556
947
  }
557
948
  }
558
949
 
559
- export { type AppPermissions, type LaunchContentOptions, index as Search, type FlannelChannelProvider as __INTERNAL_FlannelChannelProvider, type FlannelClearNotificationRequest as __INTERNAL_FlannelClearNotificationRequest, type FlannelClearNotificationResponse as __INTERNAL_FlannelClearNotificationResponse, type FlannelCreateNotificationRequest as __INTERNAL_FlannelCreateNotificationRequest, type FlannelCreateNotificationResponse as __INTERNAL_FlannelCreateNotificationResponse, type FlannelUpdateNotificationRequest as __INTERNAL_FlannelUpdateNotificationRequest, type FlannelUpdateNotificationResponse as __INTERNAL_FlannelUpdateNotificationResponse, getAppSettings, getAppUserPermissions, getAppUserSettings, getNotificationsClient, launchContent, launchSupertab, launchWorkspace, setAppUserSettings };
950
+ export { index as Agent, type AppPermissions, type LaunchContentOptions, index$1 as Search, type FlannelChannelProvider as __INTERNAL_FlannelChannelProvider, type FlannelClearNotificationRequest as __INTERNAL_FlannelClearNotificationRequest, type FlannelClearNotificationResponse as __INTERNAL_FlannelClearNotificationResponse, type FlannelCreateNotificationRequest as __INTERNAL_FlannelCreateNotificationRequest, type FlannelCreateNotificationResponse as __INTERNAL_FlannelCreateNotificationResponse, type FlannelUpdateNotificationRequest as __INTERNAL_FlannelUpdateNotificationRequest, type FlannelUpdateNotificationResponse as __INTERNAL_FlannelUpdateNotificationResponse, getAppSettings, getAppUserPermissions, getAppUserSettings, getNotificationsClient, launchContent, launchSupertab, launchWorkspace, setAppUserSettings };