@crowdstrike/logscale-dashboard 1.126.0--build-684--sha-1de8e2885c1117489d131c478ebf5a572b6881cf → 1.135.0--build-1077--sha-96faf780527e4e787b35aa7b6885ca30cce9d302
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/index.d.ts +48 -27
- package/index.js +684 -641
- package/index.js.map +2 -2
- package/package.json +1 -1
package/index.d.ts
CHANGED
@@ -89,6 +89,7 @@ export declare type CustomLinkInteraction = {
|
|
89
89
|
*/
|
90
90
|
export declare type DashbboardNavigationTarget = {
|
91
91
|
type: "dashboard";
|
92
|
+
openInNewTab: boolean;
|
92
93
|
targetInfo: DashboardNavigationTargetInfo;
|
93
94
|
};
|
94
95
|
|
@@ -98,6 +99,14 @@ export declare type DashbboardNavigationTarget = {
|
|
98
99
|
* @public
|
99
100
|
*/
|
100
101
|
export declare class Dashboard extends WebcomponentBase<Options> {
|
102
|
+
/**
|
103
|
+
* Set the state of a dashboard.
|
104
|
+
*
|
105
|
+
* @param dashboardParams - the new dashboard state
|
106
|
+
*
|
107
|
+
* @public
|
108
|
+
*/
|
109
|
+
setState(dashboardParams: DashboardParams): void;
|
101
110
|
/**
|
102
111
|
* Set parameter values on dashboard.
|
103
112
|
*
|
@@ -222,12 +231,6 @@ export declare type EditState = {
|
|
222
231
|
} | {
|
223
232
|
dashboardId: string;
|
224
233
|
widgetId?: string;
|
225
|
-
} | {
|
226
|
-
alertId: string;
|
227
|
-
} | {
|
228
|
-
filterAlertId: string;
|
229
|
-
} | {
|
230
|
-
scheduledSearchId: string;
|
231
234
|
};
|
232
235
|
|
233
236
|
/**
|
@@ -252,6 +255,22 @@ export declare type InteractionCondition = {
|
|
252
255
|
"argument": string;
|
253
256
|
};
|
254
257
|
|
258
|
+
/**
|
259
|
+
* A typed representation a JSON object.
|
260
|
+
*
|
261
|
+
* @public
|
262
|
+
*/
|
263
|
+
export declare type JsonObject = {
|
264
|
+
[key: string]: JsonValue;
|
265
|
+
};
|
266
|
+
|
267
|
+
/**
|
268
|
+
* A typed representation of JSON value.
|
269
|
+
*
|
270
|
+
* @public
|
271
|
+
*/
|
272
|
+
export declare type JsonValue = string | number | boolean | Array<JsonValue> | JsonObject;
|
273
|
+
|
255
274
|
/**
|
256
275
|
* The NavigationTarget type specifies the target of a LogScale navigation event.
|
257
276
|
* These are handled by the `onNavigationTargetChange` hook. Sources of Navigation targets are:
|
@@ -324,6 +343,12 @@ export declare interface Options extends CommonOptions, DashboardParams {
|
|
324
343
|
* @param navigationTarget
|
325
344
|
*/
|
326
345
|
onNavigationTargetChange?: (navigationTarget: NavigationTarget) => void;
|
346
|
+
/**
|
347
|
+
* List of LogScale repositories and views available for selection
|
348
|
+
* e.g. when selecting target repository of
|
349
|
+
* a LogScale [interaction](https://library.humio.com/data-analysis/dashboards-interactions.html).
|
350
|
+
*/
|
351
|
+
reposAndViews?: RepoOrViewOption[];
|
327
352
|
/**
|
328
353
|
* Optional flag to show title bar on dashboards.
|
329
354
|
* Defaults to `false`.
|
@@ -332,22 +357,6 @@ export declare interface Options extends CommonOptions, DashboardParams {
|
|
332
357
|
showTitleBar?: boolean;
|
333
358
|
}
|
334
359
|
|
335
|
-
/**
|
336
|
-
* A value for a visualization configuration option.
|
337
|
-
*
|
338
|
-
* @public
|
339
|
-
*/
|
340
|
-
export declare type OptionValue = string | number | boolean | Array<OptionValue> | OptionValues;
|
341
|
-
|
342
|
-
/**
|
343
|
-
* Options for visualization configuration.
|
344
|
-
*
|
345
|
-
* @public
|
346
|
-
*/
|
347
|
-
export declare type OptionValues = {
|
348
|
-
[key: string]: OptionValue;
|
349
|
-
};
|
350
|
-
|
351
360
|
/**
|
352
361
|
* LogScale parameter values is a map with parameter ids as keys,
|
353
362
|
* and either a string or a string array as single / multi value parameter args, respectively.
|
@@ -364,12 +373,12 @@ export declare type ParameterValues = Record<string, string | string[]>;
|
|
364
373
|
export declare type Query = {
|
365
374
|
queryString: string;
|
366
375
|
/** Arguments for parameters in `query`. */
|
367
|
-
|
376
|
+
parameterArgs?: {
|
368
377
|
[key: string]: string;
|
369
378
|
};
|
370
379
|
start: string;
|
371
380
|
end?: string;
|
372
|
-
|
381
|
+
live: boolean;
|
373
382
|
around?: QueryPaginationOptions;
|
374
383
|
};
|
375
384
|
|
@@ -389,6 +398,16 @@ export declare type QueryPaginationOptions = {
|
|
389
398
|
numberOfEventsAfter: number;
|
390
399
|
};
|
391
400
|
|
401
|
+
/**
|
402
|
+
* A repository or view option for the LogScale Search view Repository or View selector.
|
403
|
+
*
|
404
|
+
* @public */
|
405
|
+
declare type RepoOrViewOption = {
|
406
|
+
name: string;
|
407
|
+
label: string;
|
408
|
+
type: "repo" | "view";
|
409
|
+
};
|
410
|
+
|
392
411
|
/**
|
393
412
|
* Search Link interaction type.
|
394
413
|
* If `onNavigationTargetChange` hook is implemented, these interactions will
|
@@ -413,6 +432,7 @@ export declare type SearchLinkInteraction = {
|
|
413
432
|
*/
|
414
433
|
export declare type SearchNavigationTarget = {
|
415
434
|
type: "search";
|
435
|
+
openInNewTab: boolean;
|
416
436
|
targetInfo: SearchNavigationTargetInfo;
|
417
437
|
};
|
418
438
|
|
@@ -436,7 +456,7 @@ export declare type SearchNavigationTargetInfo = SearchViewParams & {
|
|
436
456
|
*/
|
437
457
|
export declare interface SearchViewParams {
|
438
458
|
/** The query string set in the query editor. */
|
439
|
-
|
459
|
+
queryString?: string;
|
440
460
|
/** Start of time window used when querying. */
|
441
461
|
start?: string;
|
442
462
|
/** End of time window used when querying. */
|
@@ -472,11 +492,12 @@ export declare interface SearchViewParams {
|
|
472
492
|
/**
|
473
493
|
* A LogScale widget with configuration.
|
474
494
|
*
|
475
|
-
* @public
|
495
|
+
* @public
|
496
|
+
*/
|
476
497
|
export declare type SearchViewVisualization = {
|
477
498
|
type?: WidgetType;
|
478
499
|
/** The configuration options of a LogScale visualization. */
|
479
|
-
options?:
|
500
|
+
options?: JsonObject;
|
480
501
|
};
|
481
502
|
|
482
503
|
/**
|