@crowdstrike/logscale-search 1.126.0--build-684--sha-1de8e2885c1117489d131c478ebf5a572b6881cf → 1.135.0--build-1077--sha-96faf780527e4e787b35aa7b6885ca30cce9d302

package/index.d.ts

@@ -120,6 +120,7 @@ export declare type CustomLinkInteraction = {
  */
 export declare type DashbboardNavigationTarget = {
     type: "dashboard";
+    openInNewTab: boolean;
     targetInfo: DashboardNavigationTargetInfo;
 };
 
@@ -227,12 +228,6 @@ export declare type EditState = {
 } | {
     dashboardId: string;
     widgetId?: string;
-} | {
-    alertId: string;
-} | {
-    filterAlertId: string;
-} | {
-    scheduledSearchId: string;
 };
 
 /**
@@ -255,6 +250,35 @@ export declare type FieldColumn = {
     header?: string;
 };
 
+/**
+ * A field interaction consists of an `id` used to correlate interaction events to source `FieldInteraction`,
+ * and a `label` used to create the label in the field interaction context menu generating clicking a field on an event.
+ *
+ * The `id` field corresponds to the `interactionId` field on `FieldInteractionEventDetails`.
+ *
+ * @public
+ */
+export declare type FieldInteraction = {
+    id: string;
+    label: string;
+};
+
+/**
+ * Event details for the invocation of a `FieldInteraction`.
+ *
+ * - The `interactionId` field matches the `id` field of a `FieldInteraction`
+ * and is used to identify the source `FieldInteraction`of the event.
+ * - The `fieldName` field is the name of the field which was clicked on.
+ * - The `fieldValue` field carries the value of the field which was clicked on.
+ *
+ * @public
+ */
+export declare type FieldInteractionEventDetails = {
+    interactionId: string;
+    fieldName: string;
+    fieldValue: JsonValue;
+};
+
 /**
  * A column type for displaying all field values.
  *
@@ -290,6 +314,22 @@ export declare type InteractionCondition = {
     "argument": string;
 };
 
+/**
+ * A typed representation a JSON object.
+ *
+ * @public
+ */
+export declare type JsonObject = {
+    [key: string]: JsonValue;
+};
+
+/**
+ * A typed representation of JSON value.
+ *
+ * @public
+ */
+export declare type JsonValue = string | number | boolean | Array<JsonValue> | JsonObject;
+
 /**
  * The NavigationTarget type specifies the target of a LogScale navigation event.
  * These are handled by the `onNavigationTargetChange` hook. Sources of Navigation targets are:
@@ -311,7 +351,7 @@ export declare interface Options extends CommonOptions, SearchViewParams {
     /** Name of LogScale repository or view */
     repoOrViewName: string;
     /** Will initialize the webcomponent in light or dark mode. The theme can be switched through the `setTheme()` method after initialization. */
-    theme: 'light' | 'dark';
+    theme: "light" | "dark";
     /** If the LSP websocket server is accessed from a different URL than the `apiUrl`, you can set this. */
     lspURL?: string;
     /** If provided, this token will be passed in the Authentication header as a Bearer token.
@@ -350,6 +390,13 @@ export declare interface Options extends CommonOptions, SearchViewParams {
      * interactions panel inside LogScale.
      */
     hostInteractions?: Array<Interaction>;
+    /**
+     * Set custom field interactions available on fields of event.
+     *
+     * Implement the `onFieldInteractionInvoked` hook on the SearchView instance
+     * to react to events related to custom field interactions,
+     */
+    fieldInteractions?: Array<FieldInteraction>;
     /**
      * Hook for handling LogScale navigation targets, e.g. navigating from SearchView to Dashboard or vice versa.
      *
@@ -395,22 +442,6 @@ export declare interface Options extends CommonOptions, SearchViewParams {
     showInteractionsPanel?: boolean;
 }
 
-/**
- * A value for a visualization configuration option.
- *
- * @public
- */
-export declare type OptionValue = string | number | boolean | Array<OptionValue> | OptionValues;
-
-/**
- * Options for visualization configuration.
- *
- * @public
- */
-export declare type OptionValues = {
-    [key: string]: OptionValue;
-};
-
 /**
  * LogScale parameter values is a map with parameter ids as keys,
  * and either a string or a string array as single / multi value parameter args, respectively.
@@ -427,12 +458,12 @@ export declare type ParameterValues = Record<string, string | string[]>;
 export declare type Query = {
     queryString: string;
     /** Arguments for parameters in `query`. */
-    arguments?: {
+    parameterArgs?: {
         [key: string]: string;
     };
     start: string;
     end?: string;
-    isLive: boolean;
+    live: boolean;
     around?: QueryPaginationOptions;
 };
 
@@ -486,6 +517,7 @@ export declare type SearchLinkInteraction = {
  */
 export declare type SearchNavigationTarget = {
     type: "search";
+    openInNewTab: boolean;
     targetInfo: SearchNavigationTargetInfo;
 };
 
@@ -548,6 +580,14 @@ export declare class SearchView extends WebcomponentBase<Options> {
      * @public
      */
     onSearchViewStateChanged(callback: (searchViewState: SearchNavigationTargetInfo) => void | null): void;
+    /**
+     * Implement this hook to receive notifications about invocations of `FieldInteractions` configured on `Options`.
+     *
+     * @param callback - function for handling notifications of `FieldInteraction` invocations.
+     *
+     * @public
+     */
+    onFieldInteractionInvoked(callback: (eventDetails: FieldInteractionEventDetails) => void | null): void;
 }
 
 /**
@@ -559,7 +599,7 @@ export declare class SearchView extends WebcomponentBase<Options> {
  */
 export declare interface SearchViewParams {
     /** The query string set in the query editor. */
-    query?: string;
+    queryString?: string;
     /** Start of time window used when querying. */
     start?: string;
     /** End of time window used when querying. */
@@ -595,11 +635,12 @@ export declare interface SearchViewParams {
 /**
  * A LogScale widget with configuration.
  *
- * @public */
+ * @public
+ */
 export declare type SearchViewVisualization = {
     type?: WidgetType;
     /** The configuration options of a LogScale visualization. */
-    options?: OptionValues;
+    options?: JsonObject;
 };
 
 /**