@flowrensic/temporal-flowrensic-node-sdk 0.6.67 → 0.6.76

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 (63) hide show
  1. package/dist/cjs/client.d.ts +17 -1
  2. package/dist/cjs/client.d.ts.map +1 -1
  3. package/dist/cjs/client.js +65 -2
  4. package/dist/cjs/client.js.map +1 -1
  5. package/dist/cjs/gen/flowrensic/v1/finding_pb.d.ts +588 -52
  6. package/dist/cjs/gen/flowrensic/v1/finding_pb.d.ts.map +1 -1
  7. package/dist/cjs/gen/flowrensic/v1/finding_pb.js +194 -19
  8. package/dist/cjs/gen/flowrensic/v1/finding_pb.js.map +1 -1
  9. package/dist/cjs/gen/flowrensic/v1/server_config_pb.d.ts +177 -0
  10. package/dist/cjs/gen/flowrensic/v1/server_config_pb.d.ts.map +1 -1
  11. package/dist/cjs/gen/flowrensic/v1/server_config_pb.js +19 -4
  12. package/dist/cjs/gen/flowrensic/v1/server_config_pb.js.map +1 -1
  13. package/dist/cjs/gen/flowrensic/v1/services_pb.d.ts +46 -3
  14. package/dist/cjs/gen/flowrensic/v1/services_pb.d.ts.map +1 -1
  15. package/dist/cjs/gen/flowrensic/v1/services_pb.js +1 -1
  16. package/dist/cjs/gen/flowrensic/v1/services_pb.js.map +1 -1
  17. package/dist/cjs/gen/flowrensic/v1/workflow_types_pb.d.ts +33 -0
  18. package/dist/cjs/gen/flowrensic/v1/workflow_types_pb.d.ts.map +1 -1
  19. package/dist/cjs/gen/flowrensic/v1/workflow_types_pb.js +7 -2
  20. package/dist/cjs/gen/flowrensic/v1/workflow_types_pb.js.map +1 -1
  21. package/dist/cjs/index.d.ts +2 -2
  22. package/dist/cjs/index.d.ts.map +1 -1
  23. package/dist/cjs/index.js +7 -1
  24. package/dist/cjs/index.js.map +1 -1
  25. package/dist/cjs/sink.d.ts.map +1 -1
  26. package/dist/cjs/sink.js +1 -1
  27. package/dist/cjs/sink.js.map +1 -1
  28. package/dist/cjs/telemetry.js +1 -1
  29. package/dist/cjs/telemetry.js.map +1 -1
  30. package/dist/cjs/version.d.ts +1 -1
  31. package/dist/cjs/version.js +1 -1
  32. package/dist/esm/client.d.ts +17 -1
  33. package/dist/esm/client.d.ts.map +1 -1
  34. package/dist/esm/client.js +62 -1
  35. package/dist/esm/client.js.map +1 -1
  36. package/dist/esm/gen/flowrensic/v1/finding_pb.d.ts +588 -52
  37. package/dist/esm/gen/flowrensic/v1/finding_pb.d.ts.map +1 -1
  38. package/dist/esm/gen/flowrensic/v1/finding_pb.js +193 -18
  39. package/dist/esm/gen/flowrensic/v1/finding_pb.js.map +1 -1
  40. package/dist/esm/gen/flowrensic/v1/server_config_pb.d.ts +177 -0
  41. package/dist/esm/gen/flowrensic/v1/server_config_pb.d.ts.map +1 -1
  42. package/dist/esm/gen/flowrensic/v1/server_config_pb.js +18 -3
  43. package/dist/esm/gen/flowrensic/v1/server_config_pb.js.map +1 -1
  44. package/dist/esm/gen/flowrensic/v1/services_pb.d.ts +46 -3
  45. package/dist/esm/gen/flowrensic/v1/services_pb.d.ts.map +1 -1
  46. package/dist/esm/gen/flowrensic/v1/services_pb.js +1 -1
  47. package/dist/esm/gen/flowrensic/v1/services_pb.js.map +1 -1
  48. package/dist/esm/gen/flowrensic/v1/workflow_types_pb.d.ts +33 -0
  49. package/dist/esm/gen/flowrensic/v1/workflow_types_pb.d.ts.map +1 -1
  50. package/dist/esm/gen/flowrensic/v1/workflow_types_pb.js +6 -1
  51. package/dist/esm/gen/flowrensic/v1/workflow_types_pb.js.map +1 -1
  52. package/dist/esm/index.d.ts +2 -2
  53. package/dist/esm/index.d.ts.map +1 -1
  54. package/dist/esm/index.js +2 -2
  55. package/dist/esm/index.js.map +1 -1
  56. package/dist/esm/sink.d.ts.map +1 -1
  57. package/dist/esm/sink.js +2 -2
  58. package/dist/esm/sink.js.map +1 -1
  59. package/dist/esm/telemetry.js +1 -1
  60. package/dist/esm/telemetry.js.map +1 -1
  61. package/dist/esm/version.d.ts +1 -1
  62. package/dist/esm/version.js +1 -1
  63. package/package.json +1 -1
@@ -7,8 +7,9 @@ import type { Message } from "@bufbuild/protobuf";
7
7
  */
8
8
  export declare const file_flowrensic_v1_finding: GenFile;
9
9
  /**
10
- * Evidence points at the events that justify a finding. Without it a finding is
11
- * an opinion.
10
+ * Evidence is one observation of a finding (FPP-158-R28): one thing a rule
11
+ * saw, at the time of the data, of one unit inside the subject, such as a
12
+ * run or a worker process.
12
13
  *
13
14
  * @generated from message flowrensic.v1.Evidence
14
15
  */
@@ -22,20 +23,20 @@ export type Evidence = Message<"flowrensic.v1.Evidence"> & {
22
23
  */
23
24
  note: string;
24
25
  /**
25
- * The run this entry is about, on a finding of runs. Empty on any other
26
- * finding.
26
+ * The run of the observation, empty when its unit is not a run.
27
27
  *
28
28
  * @generated from field: string run_id = 3;
29
29
  */
30
30
  runId: string;
31
31
  /**
32
- * When the run joined the finding, on a finding of runs.
32
+ * The time of the data the rule saw, the first time on an observation
33
+ * seen again.
33
34
  *
34
35
  * @generated from field: google.protobuf.Timestamp at = 4;
35
36
  */
36
37
  at?: Timestamp | undefined;
37
38
  /**
38
- * The workflow id of that run, on a finding of runs.
39
+ * The workflow id of that run, empty when there is no run.
39
40
  *
40
41
  * @generated from field: string workflow_id = 5;
41
42
  */
@@ -47,12 +48,105 @@ export type Evidence = Message<"flowrensic.v1.Evidence"> & {
47
48
  * @generated from field: string temporal_ui_url = 6;
48
49
  */
49
50
  temporalUiUrl: string;
51
+ /**
52
+ * What the observation is about inside the subject: a run, a worker
53
+ * process, an ephemeral run, an activity type.
54
+ *
55
+ * @generated from field: string unit = 7;
56
+ */
57
+ unit: string;
58
+ /**
59
+ * The time of the newest data that saw it again.
60
+ *
61
+ * @generated from field: google.protobuf.Timestamp last_seen_at = 8;
62
+ */
63
+ lastSeenAt?: Timestamp | undefined;
64
+ /**
65
+ * When it stopped holding and why, on a state observation that stopped.
66
+ * Empty while it holds, and on an observation of a quiet or once class.
67
+ *
68
+ * @generated from field: google.protobuf.Timestamp stopped_at = 9;
69
+ */
70
+ stoppedAt?: Timestamp | undefined;
71
+ /**
72
+ * @generated from field: string stop_reason = 10;
73
+ */
74
+ stopReason: string;
75
+ /**
76
+ * The rule that saw it and the version text of that rule.
77
+ *
78
+ * @generated from field: string rule = 11;
79
+ */
80
+ rule: string;
81
+ /**
82
+ * @generated from field: string rule_version = 12;
83
+ */
84
+ ruleVersion: string;
85
+ /**
86
+ * The number of the episode it belongs to.
87
+ *
88
+ * @generated from field: int32 episode = 13;
89
+ */
90
+ episode: number;
50
91
  };
51
92
  /**
52
93
  * Describes the message flowrensic.v1.Evidence.
53
94
  * Use `create(EvidenceSchema)` to create a new message.
54
95
  */
55
96
  export declare const EvidenceSchema: GenMessage<Evidence>;
97
+ /**
98
+ * FindingEpisode is one stretch of time while the problem of a finding was
99
+ * going on (FPP-158-R27).
100
+ *
101
+ * @generated from message flowrensic.v1.FindingEpisode
102
+ */
103
+ export type FindingEpisode = Message<"flowrensic.v1.FindingEpisode"> & {
104
+ /**
105
+ * Its number, 1 for the first, by start time.
106
+ *
107
+ * @generated from field: int32 number = 1;
108
+ */
109
+ number: number;
110
+ /**
111
+ * @generated from field: google.protobuf.Timestamp started_at = 2;
112
+ */
113
+ startedAt?: Timestamp | undefined;
114
+ /**
115
+ * The time of its newest observation.
116
+ *
117
+ * @generated from field: google.protobuf.Timestamp last_seen_at = 3;
118
+ */
119
+ lastSeenAt?: Timestamp | undefined;
120
+ /**
121
+ * When it ended and why (FPP-158-R35): quiet, cleared, gone, once,
122
+ * deploy, won over, rule retired or turned off. Empty while it goes on.
123
+ *
124
+ * @generated from field: google.protobuf.Timestamp ended_at = 4;
125
+ */
126
+ endedAt?: Timestamp | undefined;
127
+ /**
128
+ * @generated from field: string end_reason = 5;
129
+ */
130
+ endReason: string;
131
+ /**
132
+ * How many observations it holds, the ones retention deleted included.
133
+ *
134
+ * @generated from field: int32 observations = 6;
135
+ */
136
+ observations: number;
137
+ /**
138
+ * How many of them the store still keeps. Given by ListFindingEpisodes
139
+ * only, 0 elsewhere.
140
+ *
141
+ * @generated from field: int32 kept = 7;
142
+ */
143
+ kept: number;
144
+ };
145
+ /**
146
+ * Describes the message flowrensic.v1.FindingEpisode.
147
+ * Use `create(FindingEpisodeSchema)` to create a new message.
148
+ */
149
+ export declare const FindingEpisodeSchema: GenMessage<FindingEpisode>;
56
150
  /**
57
151
  * @generated from message flowrensic.v1.Finding
58
152
  */
@@ -61,10 +155,6 @@ export type Finding = Message<"flowrensic.v1.Finding"> & {
61
155
  * @generated from field: string id = 1;
62
156
  */
63
157
  id: string;
64
- /**
65
- * @generated from field: string run_id = 2;
66
- */
67
- runId: string;
68
158
  /**
69
159
  * @generated from field: flowrensic.v1.FindingClass class = 3;
70
160
  */
@@ -82,6 +172,10 @@ export type Finding = Message<"flowrensic.v1.Finding"> & {
82
172
  */
83
173
  analyzer: string;
84
174
  /**
175
+ * The observations the finding keeps, of every episode, oldest first:
176
+ * at most 100 in a list, one page of them in GetFinding. Each names its
177
+ * episode.
178
+ *
85
179
  * @generated from field: repeated flowrensic.v1.Evidence evidence = 7;
86
180
  */
87
181
  evidence: Evidence[];
@@ -90,14 +184,14 @@ export type Finding = Message<"flowrensic.v1.Finding"> & {
90
184
  */
91
185
  detectedAt?: Timestamp | undefined;
92
186
  /**
93
- * The deploy a finding hangs on. A finding about a deploy carries no run.
187
+ * The deploy a finding hangs on.
94
188
  *
95
189
  * @generated from field: string deploy_id = 9;
96
190
  */
97
191
  deployId: string;
98
192
  /**
99
- * The run's workflow id and type, so a flag names the run without a second
100
- * call. Empty on a finding that hangs on a deploy.
193
+ * The workflow id of the first run the finding held, and its workflow
194
+ * type. Empty on a finding of no run.
101
195
  *
102
196
  * @generated from field: string workflow_id = 10;
103
197
  */
@@ -123,36 +217,16 @@ export type Finding = Message<"flowrensic.v1.Finding"> & {
123
217
  */
124
218
  url: string;
125
219
  /**
126
- * How many runs the finding holds: every run of a finding of runs, 1 for
127
- * any other finding on a run, 0 for a finding on no run.
128
- *
129
- * @generated from field: int32 run_count = 14;
130
- */
131
- runCount: number;
132
- /**
133
- * When the first and the last of those runs came. Empty when it holds none.
134
- *
135
- * @generated from field: google.protobuf.Timestamp first_run_at = 15;
136
- */
137
- firstRunAt?: Timestamp | undefined;
138
- /**
139
- * @generated from field: google.protobuf.Timestamp last_run_at = 16;
140
- */
141
- lastRunAt?: Timestamp | undefined;
142
- /**
143
- * When the finding ended. Empty while it has not ended.
144
- *
145
- * @generated from field: google.protobuf.Timestamp ended_at = 17;
146
- */
147
- endedAt?: Timestamp | undefined;
148
- /**
149
- * Active or archived. Never unspecified on a finding the server gives.
220
+ * Active while its current episode goes on, quiet after (FPP-120-R09).
221
+ * Never unspecified on a finding the server gives.
150
222
  *
151
223
  * @generated from field: flowrensic.v1.FindingStatus status = 18;
152
224
  */
153
225
  status: FindingStatus;
154
226
  /**
155
- * When the finding was archived. Empty while it is active.
227
+ * When the finding was archived, the archived mark beside its status.
228
+ * Empty while it is not archived. An episode that starts after the
229
+ * current one takes the mark off.
156
230
  *
157
231
  * @generated from field: google.protobuf.Timestamp archived_at = 19;
158
232
  */
@@ -169,8 +243,9 @@ export type Finding = Message<"flowrensic.v1.Finding"> & {
169
243
  */
170
244
  mistakenBy: string;
171
245
  /**
172
- * The link to the run the finding names in the Temporal UI of its env,
173
- * empty when it names no run or the env has no Temporal UI.
246
+ * The link in the Temporal UI of its env to the run of the newest
247
+ * observation in evidence, empty when none has a run or the env has no
248
+ * Temporal UI.
174
249
  *
175
250
  * @generated from field: string temporal_ui_url = 22;
176
251
  */
@@ -181,6 +256,69 @@ export type Finding = Message<"flowrensic.v1.Finding"> & {
181
256
  * @generated from field: flowrensic.v1.FindingTag tag = 24;
182
257
  */
183
258
  tag: FindingTag;
259
+ /**
260
+ * The status of the finding's rule now. Never unspecified on a finding the
261
+ * server gives; a rule the server has no descriptor of is retired.
262
+ *
263
+ * @generated from field: flowrensic.v1.RuleStatus rule_status = 25;
264
+ */
265
+ ruleStatus: RuleStatus;
266
+ /**
267
+ * The rule that replaces a deprecated rule, empty when there is none.
268
+ *
269
+ * @generated from field: string replaced_by = 26;
270
+ */
271
+ replacedBy: string;
272
+ /**
273
+ * The version text of the rule that raised the finding, when it was first
274
+ * written: the rule's number, then each setting as name=value, joined by ;.
275
+ *
276
+ * @generated from field: string rule_version = 28;
277
+ */
278
+ ruleVersion: string;
279
+ /**
280
+ * How the rule engine knows the problem is still there (FPP-158-R29):
281
+ * quiet, state or once.
282
+ *
283
+ * @generated from field: string holds_by = 29;
284
+ */
285
+ holdsBy: string;
286
+ /**
287
+ * The current episode, the one that starts last.
288
+ *
289
+ * @generated from field: flowrensic.v1.FindingEpisode episode = 30;
290
+ */
291
+ episode?: FindingEpisode | undefined;
292
+ /**
293
+ * The times of the first and the newest observation of every episode
294
+ * (FPP-158-R05).
295
+ *
296
+ * @generated from field: google.protobuf.Timestamp first_seen_at = 31;
297
+ */
298
+ firstSeenAt?: Timestamp | undefined;
299
+ /**
300
+ * @generated from field: google.protobuf.Timestamp last_seen_at = 32;
301
+ */
302
+ lastSeenAt?: Timestamp | undefined;
303
+ /**
304
+ * The parts of its key (FPP-158-R33): the env, the namespace, the
305
+ * subject and the fingerprint, each empty when the key has none.
306
+ *
307
+ * @generated from field: string env = 33;
308
+ */
309
+ env: string;
310
+ /**
311
+ * @generated from field: string namespace = 34;
312
+ */
313
+ namespace: string;
314
+ /**
315
+ * @generated from field: string subject = 35;
316
+ */
317
+ subject: string;
318
+ /**
319
+ * @generated from field: string fingerprint = 36;
320
+ */
321
+ fingerprint: string;
184
322
  };
185
323
  /**
186
324
  * Describes the message flowrensic.v1.Finding.
@@ -228,8 +366,9 @@ export type ListFindingsRequest = Message<"flowrensic.v1.ListFindingsRequest"> &
228
366
  workflowType: string;
229
367
  /**
230
368
  * The field of Finding the whole list is sorted by, by its name here, such
231
- * as run_count. Empty is detected_at, newest first. Read only when neither
232
- * key is given.
369
+ * as first_seen_at, or observations for the count of the current episode,
370
+ * or archived_at. Empty is detected_at, newest first. Read only when
371
+ * neither key is given.
233
372
  *
234
373
  * @generated from field: string sort = 9;
235
374
  */
@@ -249,8 +388,8 @@ export type ListFindingsRequest = Message<"flowrensic.v1.ListFindingsRequest"> &
249
388
  */
250
389
  storedOnly: boolean;
251
390
  /**
252
- * Keeps only the findings of this status, and is not used when left
253
- * empty. Read only when neither key is given.
391
+ * Keeps only the findings of this status, active or quiet, and is not
392
+ * used when left empty. Read only when neither key is given.
254
393
  *
255
394
  * @generated from field: flowrensic.v1.FindingStatus status = 12;
256
395
  */
@@ -283,6 +422,20 @@ export type ListFindingsRequest = Message<"flowrensic.v1.ListFindingsRequest"> &
283
422
  * @generated from field: flowrensic.v1.PageRequest page = 16;
284
423
  */
285
424
  page?: PageRequest | undefined;
425
+ /**
426
+ * Keeps only the findings of the classes of this group, and is not used
427
+ * when left unspecified. Read only when neither key is given.
428
+ *
429
+ * @generated from field: flowrensic.v1.FindingGroup group = 17;
430
+ */
431
+ group: FindingGroup;
432
+ /**
433
+ * Keeps only the findings with or without the archived mark, and every
434
+ * one when left unspecified. Read only when neither key is given.
435
+ *
436
+ * @generated from field: flowrensic.v1.ArchivedFilter archived = 18;
437
+ */
438
+ archived: ArchivedFilter;
286
439
  };
287
440
  /**
288
441
  * Describes the message flowrensic.v1.ListFindingsRequest.
@@ -313,6 +466,159 @@ export type ListFindingsResponse = Message<"flowrensic.v1.ListFindingsResponse">
313
466
  * Use `create(ListFindingsResponseSchema)` to create a new message.
314
467
  */
315
468
  export declare const ListFindingsResponseSchema: GenMessage<ListFindingsResponse>;
469
+ /**
470
+ * CountFindingGroupsRequest takes the filters of ListFindings that every tab
471
+ * of the Findings page shows. Each is not used when left empty.
472
+ *
473
+ * @generated from message flowrensic.v1.CountFindingGroupsRequest
474
+ */
475
+ export type CountFindingGroupsRequest = Message<"flowrensic.v1.CountFindingGroupsRequest"> & {
476
+ /**
477
+ * @generated from field: flowrensic.v1.Severity severity = 1;
478
+ */
479
+ severity: Severity;
480
+ /**
481
+ * @generated from field: string env = 2;
482
+ */
483
+ env: string;
484
+ /**
485
+ * @generated from field: flowrensic.v1.FindingStatus status = 3;
486
+ */
487
+ status: FindingStatus;
488
+ /**
489
+ * @generated from field: bool mistaken = 4;
490
+ */
491
+ mistaken: boolean;
492
+ /**
493
+ * @generated from field: flowrensic.v1.ArchivedFilter archived = 5;
494
+ */
495
+ archived: ArchivedFilter;
496
+ };
497
+ /**
498
+ * Describes the message flowrensic.v1.CountFindingGroupsRequest.
499
+ * Use `create(CountFindingGroupsRequestSchema)` to create a new message.
500
+ */
501
+ export declare const CountFindingGroupsRequestSchema: GenMessage<CountFindingGroupsRequest>;
502
+ /**
503
+ * FindingGroupCount is one group: its classes, how many findings of the
504
+ * filter are in it, and the worst severity among them.
505
+ *
506
+ * @generated from message flowrensic.v1.FindingGroupCount
507
+ */
508
+ export type FindingGroupCount = Message<"flowrensic.v1.FindingGroupCount"> & {
509
+ /**
510
+ * @generated from field: flowrensic.v1.FindingGroup group = 1;
511
+ */
512
+ group: FindingGroup;
513
+ /**
514
+ * The name the tab shows.
515
+ *
516
+ * @generated from field: string name = 2;
517
+ */
518
+ name: string;
519
+ /**
520
+ * @generated from field: repeated flowrensic.v1.FindingClass classes = 3;
521
+ */
522
+ classes: FindingClass[];
523
+ /**
524
+ * @generated from field: int32 count = 4;
525
+ */
526
+ count: number;
527
+ /**
528
+ * Unspecified when the group holds no finding.
529
+ *
530
+ * @generated from field: flowrensic.v1.Severity worst = 5;
531
+ */
532
+ worst: Severity;
533
+ };
534
+ /**
535
+ * Describes the message flowrensic.v1.FindingGroupCount.
536
+ * Use `create(FindingGroupCountSchema)` to create a new message.
537
+ */
538
+ export declare const FindingGroupCountSchema: GenMessage<FindingGroupCount>;
539
+ /**
540
+ * @generated from message flowrensic.v1.CountFindingGroupsResponse
541
+ */
542
+ export type CountFindingGroupsResponse = Message<"flowrensic.v1.CountFindingGroupsResponse"> & {
543
+ /**
544
+ * The count and the worst severity of the whole list.
545
+ *
546
+ * @generated from field: int32 total = 1;
547
+ */
548
+ total: number;
549
+ /**
550
+ * @generated from field: flowrensic.v1.Severity worst = 2;
551
+ */
552
+ worst: Severity;
553
+ /**
554
+ * One entry per group, in the order of the tabs.
555
+ *
556
+ * @generated from field: repeated flowrensic.v1.FindingGroupCount groups = 3;
557
+ */
558
+ groups: FindingGroupCount[];
559
+ };
560
+ /**
561
+ * Describes the message flowrensic.v1.CountFindingGroupsResponse.
562
+ * Use `create(CountFindingGroupsResponseSchema)` to create a new message.
563
+ */
564
+ export declare const CountFindingGroupsResponseSchema: GenMessage<CountFindingGroupsResponse>;
565
+ /**
566
+ * ExportFindingsRequest asks for the findings ListFindings answers for the
567
+ * same request, keys, filters, sort and page included (FPP-165-R03).
568
+ *
569
+ * @generated from message flowrensic.v1.ExportFindingsRequest
570
+ */
571
+ export type ExportFindingsRequest = Message<"flowrensic.v1.ExportFindingsRequest"> & {
572
+ /**
573
+ * @generated from field: flowrensic.v1.ListFindingsRequest list = 1;
574
+ */
575
+ list?: ListFindingsRequest | undefined;
576
+ /**
577
+ * The format of the document (FPP-165-R05): flowrensic-finding-format,
578
+ * the finding format of FPP-165, which empty means too; ocsf, a JSON array of OCSF
579
+ * Detection Finding records; or sarif, one SARIF 2.1.0 log.
580
+ *
581
+ * @generated from field: string format = 2;
582
+ */
583
+ format: string;
584
+ };
585
+ /**
586
+ * Describes the message flowrensic.v1.ExportFindingsRequest.
587
+ * Use `create(ExportFindingsRequestSchema)` to create a new message.
588
+ */
589
+ export declare const ExportFindingsRequestSchema: GenMessage<ExportFindingsRequest>;
590
+ /**
591
+ * @generated from message flowrensic.v1.ExportFindingsResponse
592
+ */
593
+ export type ExportFindingsResponse = Message<"flowrensic.v1.ExportFindingsResponse"> & {
594
+ /**
595
+ * The findings of the page as one document in the format asked for, as
596
+ * JSON.
597
+ *
598
+ * @generated from field: string document = 1;
599
+ */
600
+ document: string;
601
+ /**
602
+ * Whether the list goes on after this page, and how to ask for the next.
603
+ *
604
+ * @generated from field: flowrensic.v1.PageResponse page = 2;
605
+ */
606
+ page?: PageResponse | undefined;
607
+ /**
608
+ * The URL of the JSON Schema of the document on flowrensic.com, the one
609
+ * place the schemas are stored: the schema of flowrensic-finding-format, or
610
+ * our copy of the official schema of the OCSF or SARIF version the document
611
+ * follows.
612
+ *
613
+ * @generated from field: string schema_url = 3;
614
+ */
615
+ schemaUrl: string;
616
+ };
617
+ /**
618
+ * Describes the message flowrensic.v1.ExportFindingsResponse.
619
+ * Use `create(ExportFindingsResponseSchema)` to create a new message.
620
+ */
621
+ export declare const ExportFindingsResponseSchema: GenMessage<ExportFindingsResponse>;
316
622
  /**
317
623
  * @generated from message flowrensic.v1.ListThresholdsRequest
318
624
  */
@@ -380,7 +686,8 @@ export type GetFindingRequest = Message<"flowrensic.v1.GetFindingRequest"> & {
380
686
  */
381
687
  storedOnly: boolean;
382
688
  /**
383
- * The page of the runs of a finding of runs asked for, in its evidence.
689
+ * The page of the observations of the finding asked for, in its
690
+ * evidence.
384
691
  *
385
692
  * @generated from field: flowrensic.v1.PageRequest runs_page = 3;
386
693
  */
@@ -400,7 +707,8 @@ export type GetFindingResponse = Message<"flowrensic.v1.GetFindingResponse"> & {
400
707
  */
401
708
  finding?: Finding | undefined;
402
709
  /**
403
- * Whether the runs of the finding go on after the ones in its evidence.
710
+ * Whether the observations of the finding go on after the ones in its
711
+ * evidence.
404
712
  *
405
713
  * @generated from field: flowrensic.v1.PageResponse runs_page = 2;
406
714
  */
@@ -420,17 +728,112 @@ export type SetFindingStatusRequest = Message<"flowrensic.v1.SetFindingStatusReq
420
728
  */
421
729
  id: string;
422
730
  /**
423
- * Active or archived. Unspecified is an invalid argument.
731
+ * Archive or unarchive. Unspecified is an invalid argument.
424
732
  *
425
- * @generated from field: flowrensic.v1.FindingStatus status = 2;
733
+ * @generated from field: flowrensic.v1.FindingMark mark = 3;
426
734
  */
427
- status: FindingStatus;
735
+ mark: FindingMark;
428
736
  };
429
737
  /**
430
738
  * Describes the message flowrensic.v1.SetFindingStatusRequest.
431
739
  * Use `create(SetFindingStatusRequestSchema)` to create a new message.
432
740
  */
433
741
  export declare const SetFindingStatusRequestSchema: GenMessage<SetFindingStatusRequest>;
742
+ /**
743
+ * ListFindingEpisodesRequest asks for the episodes of one finding, newest
744
+ * first (FPP-112-R34).
745
+ *
746
+ * @generated from message flowrensic.v1.ListFindingEpisodesRequest
747
+ */
748
+ export type ListFindingEpisodesRequest = Message<"flowrensic.v1.ListFindingEpisodesRequest"> & {
749
+ /**
750
+ * @generated from field: string finding_id = 1;
751
+ */
752
+ findingId: string;
753
+ /**
754
+ * The page of the list asked for.
755
+ *
756
+ * @generated from field: flowrensic.v1.PageRequest page = 2;
757
+ */
758
+ page?: PageRequest | undefined;
759
+ };
760
+ /**
761
+ * Describes the message flowrensic.v1.ListFindingEpisodesRequest.
762
+ * Use `create(ListFindingEpisodesRequestSchema)` to create a new message.
763
+ */
764
+ export declare const ListFindingEpisodesRequestSchema: GenMessage<ListFindingEpisodesRequest>;
765
+ /**
766
+ * @generated from message flowrensic.v1.ListFindingEpisodesResponse
767
+ */
768
+ export type ListFindingEpisodesResponse = Message<"flowrensic.v1.ListFindingEpisodesResponse"> & {
769
+ /**
770
+ * The episodes the store keeps, newest first. One retention deleted is
771
+ * not given.
772
+ *
773
+ * @generated from field: repeated flowrensic.v1.FindingEpisode episodes = 1;
774
+ */
775
+ episodes: FindingEpisode[];
776
+ /**
777
+ * Whether the list goes on after this page, and how to ask for the next.
778
+ *
779
+ * @generated from field: flowrensic.v1.PageResponse page = 2;
780
+ */
781
+ page?: PageResponse | undefined;
782
+ };
783
+ /**
784
+ * Describes the message flowrensic.v1.ListFindingEpisodesResponse.
785
+ * Use `create(ListFindingEpisodesResponseSchema)` to create a new message.
786
+ */
787
+ export declare const ListFindingEpisodesResponseSchema: GenMessage<ListFindingEpisodesResponse>;
788
+ /**
789
+ * ListFindingObservationsRequest asks for the observations of one episode
790
+ * of a finding, newest first (FPP-112-R34).
791
+ *
792
+ * @generated from message flowrensic.v1.ListFindingObservationsRequest
793
+ */
794
+ export type ListFindingObservationsRequest = Message<"flowrensic.v1.ListFindingObservationsRequest"> & {
795
+ /**
796
+ * @generated from field: string finding_id = 1;
797
+ */
798
+ findingId: string;
799
+ /**
800
+ * The number of the episode. Zero is the current episode.
801
+ *
802
+ * @generated from field: int32 episode = 2;
803
+ */
804
+ episode: number;
805
+ /**
806
+ * The page of the list asked for. Zero is 50 observations.
807
+ *
808
+ * @generated from field: flowrensic.v1.PageRequest page = 3;
809
+ */
810
+ page?: PageRequest | undefined;
811
+ };
812
+ /**
813
+ * Describes the message flowrensic.v1.ListFindingObservationsRequest.
814
+ * Use `create(ListFindingObservationsRequestSchema)` to create a new message.
815
+ */
816
+ export declare const ListFindingObservationsRequestSchema: GenMessage<ListFindingObservationsRequest>;
817
+ /**
818
+ * @generated from message flowrensic.v1.ListFindingObservationsResponse
819
+ */
820
+ export type ListFindingObservationsResponse = Message<"flowrensic.v1.ListFindingObservationsResponse"> & {
821
+ /**
822
+ * @generated from field: repeated flowrensic.v1.Evidence observations = 1;
823
+ */
824
+ observations: Evidence[];
825
+ /**
826
+ * Whether the list goes on after this page, and how to ask for the next.
827
+ *
828
+ * @generated from field: flowrensic.v1.PageResponse page = 2;
829
+ */
830
+ page?: PageResponse | undefined;
831
+ };
832
+ /**
833
+ * Describes the message flowrensic.v1.ListFindingObservationsResponse.
834
+ * Use `create(ListFindingObservationsResponseSchema)` to create a new message.
835
+ */
836
+ export declare const ListFindingObservationsResponseSchema: GenMessage<ListFindingObservationsResponse>;
434
837
  /**
435
838
  * @generated from message flowrensic.v1.SetFindingStatusResponse
436
839
  */
@@ -473,6 +876,18 @@ export type Alert = Message<"flowrensic.v1.Alert"> & {
473
876
  * @generated from field: flowrensic.v1.Finding finding = 4;
474
877
  */
475
878
  finding?: Finding | undefined;
879
+ /**
880
+ * The number of the episode of the finding the alert belongs to
881
+ * (FPP-121-R02), and whether that episode is not the first, so the
882
+ * problem came back.
883
+ *
884
+ * @generated from field: int32 episode = 5;
885
+ */
886
+ episode: number;
887
+ /**
888
+ * @generated from field: bool came_back = 6;
889
+ */
890
+ cameBack: boolean;
476
891
  };
477
892
  /**
478
893
  * Describes the message flowrensic.v1.Alert.
@@ -823,7 +1238,13 @@ export declare enum FindingClass {
823
1238
  *
824
1239
  * @generated from enum value: FINDING_CLASS_MIXED_SDK_VERSIONS = 69;
825
1240
  */
826
- MIXED_SDK_VERSIONS = 69
1241
+ MIXED_SDK_VERSIONS = 69,
1242
+ /**
1243
+ * Flowrensic refuses the calls of a worker whose body passes the request limit, FPP-124-R05.
1244
+ *
1245
+ * @generated from enum value: FINDING_CLASS_WORKER_CALLS_TOO_LARGE = 70;
1246
+ */
1247
+ WORKER_CALLS_TOO_LARGE = 70
827
1248
  }
828
1249
  /**
829
1250
  * Describes the enum flowrensic.v1.FindingClass.
@@ -853,6 +1274,38 @@ export declare enum FindingTag {
853
1274
  * Describes the enum flowrensic.v1.FindingTag.
854
1275
  */
855
1276
  export declare const FindingTagSchema: GenEnum<FindingTag>;
1277
+ /**
1278
+ * FindingGroup is what a finding is about, one tab of the Findings page
1279
+ * each. The class decides it, from where its problem is.
1280
+ *
1281
+ * @generated from enum flowrensic.v1.FindingGroup
1282
+ */
1283
+ export declare enum FindingGroup {
1284
+ /**
1285
+ * @generated from enum value: FINDING_GROUP_UNSPECIFIED = 0;
1286
+ */
1287
+ UNSPECIFIED = 0,
1288
+ /**
1289
+ * @generated from enum value: FINDING_GROUP_WORKFLOWS = 1;
1290
+ */
1291
+ WORKFLOWS = 1,
1292
+ /**
1293
+ * @generated from enum value: FINDING_GROUP_WORKERS = 2;
1294
+ */
1295
+ WORKERS = 2,
1296
+ /**
1297
+ * @generated from enum value: FINDING_GROUP_DEPLOYS = 3;
1298
+ */
1299
+ DEPLOYS = 3,
1300
+ /**
1301
+ * @generated from enum value: FINDING_GROUP_FLOWRENSIC = 4;
1302
+ */
1303
+ FLOWRENSIC = 4
1304
+ }
1305
+ /**
1306
+ * Describes the enum flowrensic.v1.FindingGroup.
1307
+ */
1308
+ export declare const FindingGroupSchema: GenEnum<FindingGroup>;
856
1309
  /**
857
1310
  * @generated from enum flowrensic.v1.Severity
858
1311
  */
@@ -879,6 +1332,41 @@ export declare enum Severity {
879
1332
  */
880
1333
  export declare const SeveritySchema: GenEnum<Severity>;
881
1334
  /**
1335
+ * RuleStatus is the status of a rule: it runs, it runs and is phased out, it
1336
+ * does not run, or it runs and its findings raise no alerts.
1337
+ *
1338
+ * @generated from enum flowrensic.v1.RuleStatus
1339
+ */
1340
+ export declare enum RuleStatus {
1341
+ /**
1342
+ * @generated from enum value: RULE_STATUS_UNSPECIFIED = 0;
1343
+ */
1344
+ UNSPECIFIED = 0,
1345
+ /**
1346
+ * @generated from enum value: RULE_STATUS_ACTIVE = 1;
1347
+ */
1348
+ ACTIVE = 1,
1349
+ /**
1350
+ * @generated from enum value: RULE_STATUS_DEPRECATED = 2;
1351
+ */
1352
+ DEPRECATED = 2,
1353
+ /**
1354
+ * @generated from enum value: RULE_STATUS_RETIRED = 3;
1355
+ */
1356
+ RETIRED = 3,
1357
+ /**
1358
+ * @generated from enum value: RULE_STATUS_EXPERIMENTAL = 4;
1359
+ */
1360
+ EXPERIMENTAL = 4
1361
+ }
1362
+ /**
1363
+ * Describes the enum flowrensic.v1.RuleStatus.
1364
+ */
1365
+ export declare const RuleStatusSchema: GenEnum<RuleStatus>;
1366
+ /**
1367
+ * FindingStatus is worked out from the current episode of a finding, never
1368
+ * set by hand (FPP-120-R09): active while it goes on, quiet after.
1369
+ *
882
1370
  * @generated from enum flowrensic.v1.FindingStatus
883
1371
  */
884
1372
  export declare enum FindingStatus {
@@ -891,12 +1379,60 @@ export declare enum FindingStatus {
891
1379
  */
892
1380
  ACTIVE = 1,
893
1381
  /**
894
- * @generated from enum value: FINDING_STATUS_ARCHIVED = 2;
1382
+ * @generated from enum value: FINDING_STATUS_QUIET = 3;
895
1383
  */
896
- ARCHIVED = 2
1384
+ QUIET = 3
897
1385
  }
898
1386
  /**
899
1387
  * Describes the enum flowrensic.v1.FindingStatus.
900
1388
  */
901
1389
  export declare const FindingStatusSchema: GenEnum<FindingStatus>;
1390
+ /**
1391
+ * ArchivedFilter picks findings by the archived mark.
1392
+ *
1393
+ * @generated from enum flowrensic.v1.ArchivedFilter
1394
+ */
1395
+ export declare enum ArchivedFilter {
1396
+ /**
1397
+ * Every finding, archived or not.
1398
+ *
1399
+ * @generated from enum value: ARCHIVED_FILTER_UNSPECIFIED = 0;
1400
+ */
1401
+ UNSPECIFIED = 0,
1402
+ /**
1403
+ * @generated from enum value: ARCHIVED_FILTER_NOT_ARCHIVED = 1;
1404
+ */
1405
+ NOT_ARCHIVED = 1,
1406
+ /**
1407
+ * @generated from enum value: ARCHIVED_FILTER_ARCHIVED = 2;
1408
+ */
1409
+ ARCHIVED = 2
1410
+ }
1411
+ /**
1412
+ * Describes the enum flowrensic.v1.ArchivedFilter.
1413
+ */
1414
+ export declare const ArchivedFilterSchema: GenEnum<ArchivedFilter>;
1415
+ /**
1416
+ * FindingMark is what SetFindingStatus does to the archived mark.
1417
+ *
1418
+ * @generated from enum flowrensic.v1.FindingMark
1419
+ */
1420
+ export declare enum FindingMark {
1421
+ /**
1422
+ * @generated from enum value: FINDING_MARK_UNSPECIFIED = 0;
1423
+ */
1424
+ UNSPECIFIED = 0,
1425
+ /**
1426
+ * @generated from enum value: FINDING_MARK_ARCHIVE = 1;
1427
+ */
1428
+ ARCHIVE = 1,
1429
+ /**
1430
+ * @generated from enum value: FINDING_MARK_UNARCHIVE = 2;
1431
+ */
1432
+ UNARCHIVE = 2
1433
+ }
1434
+ /**
1435
+ * Describes the enum flowrensic.v1.FindingMark.
1436
+ */
1437
+ export declare const FindingMarkSchema: GenEnum<FindingMark>;
902
1438
  //# sourceMappingURL=finding_pb.d.ts.map