@crowdstrike/logscale-search 1.143.0--build-1386--sha-7dd77c28f152f02d096cfff2b59838bf1e98cde4 → 1.143.0--build-1495--sha-1355c819ee5552532633ad01cad6e6969d1624da

package/index.d.ts

@@ -297,6 +297,14 @@ export declare type FieldListColumn = {
     groupByPrefix?: boolean;
 };
 
+/**
+ * Encapsulates information about the LogScale data which has been interacted with,
+ * and which interaction was the source of the event.
+ *
+ * @public
+ */
+export declare type HostInteractionEvent = RowInteractionEvent;
+
 /**
  * LogScale Interactions.
  * See [documentation](https://library.humio.com/data-analysis/dashboards-interactions.html) for more information.
@@ -311,12 +319,12 @@ export declare type Interaction = CustomLinkInteraction | SearchLinkInteraction
  * @public
  */
 export declare type InteractionCondition = {
-    "operator": "present" | "not-present";
-    "fieldName": string;
+    operator: "present" | "not-present";
+    fieldName: string;
 } | {
-    "operator": "starts-with" | "ends-with" | "equal" | "not-equal" | "contains" | "not-contains";
-    "fieldName": string;
-    "argument": string;
+    operator: "starts-with" | "ends-with" | "equal" | "not-equal" | "contains" | "not-contains";
+    fieldName: string;
+    argument: string;
 };
 
 /**
@@ -394,7 +402,7 @@ export declare interface Options extends CommonOptions, SearchViewParams {
      * Note: `hostInteractions` can only be configured through the host application and will not be configurable through the
      * interactions panel inside LogScale.
      */
-    hostInteractions?: Array<Interaction>;
+    hostInteractions?: Array<Interaction | RowInteraction>;
     /**
      * Set custom field interactions available on fields of event.
      *
@@ -548,6 +556,42 @@ export declare type RepoOrViewOption = {
     type: "repo" | "view";
 };
 
+/**
+ * A generic row interaction type which has to be handled by the host application (you).
+ *
+ * The name of the interaction is attached to the corresponding `RowInteractionTarget`
+ * which is generated when interaction is invoked.
+ *
+ * @public
+ */
+export declare type RowInteraction = {
+    type: "row";
+    id: string;
+    /**
+     * A template to render a title for the interaction when rendered in the interactions menu.
+     * This supports [LogScale template expressions](https://library.humio.com/data-analysis/template-language-expressions.html).
+     */
+    titleTemplate: string;
+    conditions?: Array<InteractionCondition> | null;
+};
+
+/**
+ * Event generated from the invocation of a `RowInteraction`.
+ *
+ * @public
+ */
+export declare type RowInteractionEvent = {
+    type: "row";
+    /**
+     * The id of the interaction which was the source of the event.
+     */
+    id: string;
+    /**
+     * The row which has been interacted with.
+     */
+    row: Record<string, string>;
+};
+
 /**
  * Search Link interaction type.
  * If `onNavigationTargetChange` hook is implemented, these interactions will
@@ -596,11 +640,11 @@ export declare class SearchView extends WebcomponentBase<Options> {
     /**
      * Set the state of the SearchView.
      *
-     * @param searchViewParams - the new search view state
+     * @param stateParams - the new state
      *
      * @public
      */
-    setState(searchViewParams: SearchViewParams): void;
+    setState(stateParams: SetStateParams): void;
     /**
      * Set the query string of the SearchView query editor.
      *
@@ -651,6 +695,14 @@ export declare class SearchView extends WebcomponentBase<Options> {
      * @public
      */
     onFieldInteractionInvoked(callback: (eventDetails: FieldInteractionEventDetails) => void | null): void;
+    /**
+     * Implement this hook to receive notifications about invocations of `HostInteractions` of type "row".
+     *
+     * @param callback - function for handling `HostInteractionTarget`.
+     *
+     * @public
+     */
+    onHostInteractionInvoked(callback: (hostInteractionEvent: HostInteractionEvent) => void | null): void;
 }
 
 /**
@@ -715,13 +767,33 @@ export declare type SetQueryStringOptions = {
     run?: boolean;
 };
 
+/**
+ * Params to use when calling SearchView.setState.
+ *
+ * @public
+ */
+export declare type SetStateParams = SearchViewParams & {
+    repoOrViewName?: string;
+    timezone?: string;
+};
+
 /**
  * The shared properties of all interaction types.
  *
  * @public
  */
 export declare type SharedInteractionProperties = {
+    /**
+     * The name of the interaction.
+     * This should be unique.
+     */
     name: string;
+    /**
+     * A template to render a title for the interaction when rendered in the interactions menu.
+     * This supports [LogScale template expressions](https://library.humio.com/data-analysis/template-language-expressions.html).
+     *
+     * If omitted, `name` will be used to render the interaction title.
+     */
     titleTemplate?: string | null;
     conditions?: Array<InteractionCondition> | null;
 };