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

package/dist/index.d.cts

@@ -320,18 +320,20 @@ type OnSearchListener = (request: SearchListenerRequest$1) => SearchResponse$1 |
  * 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.
  */
 type SearchAction$1 = {
-    /**
-     * URL or data URI of an icon that will be displayed within the action button when HERE is in Light mode.
-     */
-    darkIcon?: string;
     /**
      * A fuller description of the action that will be displayed in HERE's search UI when the user hovers over the action button.
      */
     description?: string;
     /**
-     * URL or data URI of an icon that will be displayed within the action button when HERE is in Dark mode.
+     * Icon that will be displayed within the action button in HERE's search UI.
+     *
+     * This can be a URL/data URI string (used for both Light and Dark modes),
+     * or an object containing separate icons for Light and Dark modes.
      */
-    lightIcon?: string;
+    icon?: string | {
+        dark: string;
+        light: string;
+    };
     /**
      * Internal identifier for the action which is used to identify the action in the {@link OnActionListener}.
      */
@@ -558,6 +560,10 @@ declare function getAgentConfiguration<T extends object>(): Promise<SearchAgentC
  *                         name: "view-owner",
  *                         description: `Go to ${ownerName} in My Web App`,
  *                         title: "View Owner",
+ *                         icon: {
+ *                             dark: "data:image/svg+xml,...",
+ *                             light: "data:image/svg+xml,...",
+ *                         },
  *                     },
  *                 ],
  *                 data: {
@@ -625,18 +631,20 @@ type OnSearchRequestListener = (request: SearchListenerRequest) => SearchRespons
  * 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.
  */
 type SearchAction = {
-    /**
-     * URL or data URI of an icon that will be displayed within the action button when HERE is in Light mode.
-     */
-    darkIcon?: string;
     /**
      * A fuller description of the action that will be displayed in HERE's search UI when the user hovers over the action button.
      */
     description?: string;
     /**
-     * URL or data URI of an icon that will be displayed within the action button when HERE is in Dark mode.
+     * Icon that will be displayed within the action button in HERE's search UI.
+     *
+     * This can be a URL/data URI string (used for both Light and Dark modes),
+     * or an object containing separate icons for Light and Dark modes.
      */
-    lightIcon?: string;
+    icon?: string | {
+        dark: string;
+        light: string;
+    };
     /**
      * Internal identifier for the action which is used to identify the action in the {@link OnSearchActionListener}.
      */
@@ -882,6 +890,10 @@ declare const getConfiguration: <T extends Record<string, unknown>>() => Promise
  *                         name: "view-owner",
  *                         description: `Go to ${ownerName} in My Web App`,
  *                         title: "View Owner",
+ *                         icon: {
+ *                             dark: "data:image/svg+xml,...",
+ *                             light: "data:image/svg+xml,...",
+ *                         },
  *                     },
  *                 ],
  *                 data: {
@@ -922,10 +934,11 @@ type index_InteropColorChannel = InteropColorChannel;
 type index_OnSearchActionListener = OnSearchActionListener;
 type index_OnSearchRequestListener = OnSearchRequestListener;
 type index_SearchListenerRequest = SearchListenerRequest;
+type index_SearchResult = SearchResult;
 declare const index_getConfiguration: typeof getConfiguration;
 declare const index_register: typeof register;
 declare namespace index {
-  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 };
+  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 };
 }
 
 declare global {

package/dist/index.d.ts

@@ -320,18 +320,20 @@ type OnSearchListener = (request: SearchListenerRequest$1) => SearchResponse$1 |
  * 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.
  */
 type SearchAction$1 = {
-    /**
-     * URL or data URI of an icon that will be displayed within the action button when HERE is in Light mode.
-     */
-    darkIcon?: string;
     /**
      * A fuller description of the action that will be displayed in HERE's search UI when the user hovers over the action button.
      */
     description?: string;
     /**
-     * URL or data URI of an icon that will be displayed within the action button when HERE is in Dark mode.
+     * Icon that will be displayed within the action button in HERE's search UI.
+     *
+     * This can be a URL/data URI string (used for both Light and Dark modes),
+     * or an object containing separate icons for Light and Dark modes.
      */
-    lightIcon?: string;
+    icon?: string | {
+        dark: string;
+        light: string;
+    };
     /**
      * Internal identifier for the action which is used to identify the action in the {@link OnActionListener}.
      */
@@ -558,6 +560,10 @@ declare function getAgentConfiguration<T extends object>(): Promise<SearchAgentC
  *                         name: "view-owner",
  *                         description: `Go to ${ownerName} in My Web App`,
  *                         title: "View Owner",
+ *                         icon: {
+ *                             dark: "data:image/svg+xml,...",
+ *                             light: "data:image/svg+xml,...",
+ *                         },
  *                     },
  *                 ],
  *                 data: {
@@ -625,18 +631,20 @@ type OnSearchRequestListener = (request: SearchListenerRequest) => SearchRespons
  * 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.
  */
 type SearchAction = {
-    /**
-     * URL or data URI of an icon that will be displayed within the action button when HERE is in Light mode.
-     */
-    darkIcon?: string;
     /**
      * A fuller description of the action that will be displayed in HERE's search UI when the user hovers over the action button.
      */
     description?: string;
     /**
-     * URL or data URI of an icon that will be displayed within the action button when HERE is in Dark mode.
+     * Icon that will be displayed within the action button in HERE's search UI.
+     *
+     * This can be a URL/data URI string (used for both Light and Dark modes),
+     * or an object containing separate icons for Light and Dark modes.
      */
-    lightIcon?: string;
+    icon?: string | {
+        dark: string;
+        light: string;
+    };
     /**
      * Internal identifier for the action which is used to identify the action in the {@link OnSearchActionListener}.
      */
@@ -882,6 +890,10 @@ declare const getConfiguration: <T extends Record<string, unknown>>() => Promise
  *                         name: "view-owner",
  *                         description: `Go to ${ownerName} in My Web App`,
  *                         title: "View Owner",
+ *                         icon: {
+ *                             dark: "data:image/svg+xml,...",
+ *                             light: "data:image/svg+xml,...",
+ *                         },
  *                     },
  *                 ],
  *                 data: {
@@ -922,10 +934,11 @@ type index_InteropColorChannel = InteropColorChannel;
 type index_OnSearchActionListener = OnSearchActionListener;
 type index_OnSearchRequestListener = OnSearchRequestListener;
 type index_SearchListenerRequest = SearchListenerRequest;
+type index_SearchResult = SearchResult;
 declare const index_getConfiguration: typeof getConfiguration;
 declare const index_register: typeof register;
 declare namespace index {
-  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 };
+  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 };
 }
 
 declare global {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/cloud-api",
-    "version": "12.0.0-beta.12",
+    "version": "12.0.0-beta.13",
     "sideEffects": false,
     "description": "",
     "exports": {
@@ -27,10 +27,10 @@
         "dist"
     ],
     "devDependencies": {
-        "@openfin/core": "44.100.108",
+        "@openfin/core": "44.100.109",
         "@openfin/search-api": "^2.0.1",
         "@openfin/typedoc-theme": "^2.0.2",
-        "@openfin/workspace": "24.0.8",
+        "@openfin/workspace": "24.0.9",
         "@typescript-eslint/eslint-plugin": "^8.32.0",
         "@typescript-eslint/parser": "^8.32.0",
         "eslint": "^8.57.1",