@openfin/cloud-api 12.0.0-beta.12 → 12.0.0-beta.14

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.
Files changed (3) hide show
  1. package/dist/index.d.cts +26 -13
  2. package/dist/index.d.ts +26 -13
  3. package/package.json +3 -3
package/dist/index.d.cts CHANGED
@@ -320,18 +320,20 @@ type OnSearchListener = (request: SearchListenerRequest$1) => SearchResponse$1 |
320
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
322
  type SearchAction$1 = {
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;
327
323
  /**
328
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
  */
@@ -558,6 +560,10 @@ declare function getAgentConfiguration<T extends object>(): Promise<SearchAgentC
558
560
  * name: "view-owner",
559
561
  * description: `Go to ${ownerName} in My Web App`,
560
562
  * title: "View Owner",
563
+ * icon: {
564
+ * dark: "data:image/svg+xml,...",
565
+ * light: "data:image/svg+xml,...",
566
+ * },
561
567
  * },
562
568
  * ],
563
569
  * data: {
@@ -625,18 +631,20 @@ type OnSearchRequestListener = (request: SearchListenerRequest) => SearchRespons
625
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.
626
632
  */
627
633
  type SearchAction = {
628
- /**
629
- * URL or data URI of an icon that will be displayed within the action button when HERE is in Light mode.
630
- */
631
- darkIcon?: string;
632
634
  /**
633
635
  * A fuller description of the action that will be displayed in HERE's search UI when the user hovers over the action button.
634
636
  */
635
637
  description?: string;
636
638
  /**
637
- * URL or data URI of an icon that will be displayed within the action button when HERE is in Dark mode.
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.
638
643
  */
639
- lightIcon?: string;
644
+ icon?: string | {
645
+ dark: string;
646
+ light: string;
647
+ };
640
648
  /**
641
649
  * Internal identifier for the action which is used to identify the action in the {@link OnSearchActionListener}.
642
650
  */
@@ -882,6 +890,10 @@ declare const getConfiguration: <T extends Record<string, unknown>>() => Promise
882
890
  * name: "view-owner",
883
891
  * description: `Go to ${ownerName} in My Web App`,
884
892
  * title: "View Owner",
893
+ * icon: {
894
+ * dark: "data:image/svg+xml,...",
895
+ * light: "data:image/svg+xml,...",
896
+ * },
885
897
  * },
886
898
  * ],
887
899
  * data: {
@@ -922,10 +934,11 @@ type index_InteropColorChannel = InteropColorChannel;
922
934
  type index_OnSearchActionListener = OnSearchActionListener;
923
935
  type index_OnSearchRequestListener = OnSearchRequestListener;
924
936
  type index_SearchListenerRequest = SearchListenerRequest;
937
+ type index_SearchResult = SearchResult;
925
938
  declare const index_getConfiguration: typeof getConfiguration;
926
939
  declare const index_register: typeof register;
927
940
  declare namespace index {
928
- 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, index_getConfiguration as getConfiguration, 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 };
929
942
  }
930
943
 
931
944
  declare global {
package/dist/index.d.ts CHANGED
@@ -320,18 +320,20 @@ type OnSearchListener = (request: SearchListenerRequest$1) => SearchResponse$1 |
320
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
322
  type SearchAction$1 = {
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;
327
323
  /**
328
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
  */
@@ -558,6 +560,10 @@ declare function getAgentConfiguration<T extends object>(): Promise<SearchAgentC
558
560
  * name: "view-owner",
559
561
  * description: `Go to ${ownerName} in My Web App`,
560
562
  * title: "View Owner",
563
+ * icon: {
564
+ * dark: "data:image/svg+xml,...",
565
+ * light: "data:image/svg+xml,...",
566
+ * },
561
567
  * },
562
568
  * ],
563
569
  * data: {
@@ -625,18 +631,20 @@ type OnSearchRequestListener = (request: SearchListenerRequest) => SearchRespons
625
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.
626
632
  */
627
633
  type SearchAction = {
628
- /**
629
- * URL or data URI of an icon that will be displayed within the action button when HERE is in Light mode.
630
- */
631
- darkIcon?: string;
632
634
  /**
633
635
  * A fuller description of the action that will be displayed in HERE's search UI when the user hovers over the action button.
634
636
  */
635
637
  description?: string;
636
638
  /**
637
- * URL or data URI of an icon that will be displayed within the action button when HERE is in Dark mode.
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.
638
643
  */
639
- lightIcon?: string;
644
+ icon?: string | {
645
+ dark: string;
646
+ light: string;
647
+ };
640
648
  /**
641
649
  * Internal identifier for the action which is used to identify the action in the {@link OnSearchActionListener}.
642
650
  */
@@ -882,6 +890,10 @@ declare const getConfiguration: <T extends Record<string, unknown>>() => Promise
882
890
  * name: "view-owner",
883
891
  * description: `Go to ${ownerName} in My Web App`,
884
892
  * title: "View Owner",
893
+ * icon: {
894
+ * dark: "data:image/svg+xml,...",
895
+ * light: "data:image/svg+xml,...",
896
+ * },
885
897
  * },
886
898
  * ],
887
899
  * data: {
@@ -922,10 +934,11 @@ type index_InteropColorChannel = InteropColorChannel;
922
934
  type index_OnSearchActionListener = OnSearchActionListener;
923
935
  type index_OnSearchRequestListener = OnSearchRequestListener;
924
936
  type index_SearchListenerRequest = SearchListenerRequest;
937
+ type index_SearchResult = SearchResult;
925
938
  declare const index_getConfiguration: typeof getConfiguration;
926
939
  declare const index_register: typeof register;
927
940
  declare namespace index {
928
- 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, index_getConfiguration as getConfiguration, 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 };
929
942
  }
930
943
 
931
944
  declare global {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/cloud-api",
3
- "version": "12.0.0-beta.12",
3
+ "version": "12.0.0-beta.14",
4
4
  "sideEffects": false,
5
5
  "description": "",
6
6
  "exports": {
@@ -27,10 +27,10 @@
27
27
  "dist"
28
28
  ],
29
29
  "devDependencies": {
30
- "@openfin/core": "44.100.108",
30
+ "@openfin/core": "44.100.109",
31
31
  "@openfin/search-api": "^2.0.1",
32
32
  "@openfin/typedoc-theme": "^2.0.2",
33
- "@openfin/workspace": "24.0.8",
33
+ "@openfin/workspace": "24.0.10",
34
34
  "@typescript-eslint/eslint-plugin": "^8.32.0",
35
35
  "@typescript-eslint/parser": "^8.32.0",
36
36
  "eslint": "^8.57.1",