@coffre/client 0.9.0 → 0.10.1

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.
@@ -47,14 +47,14 @@ type Api = {
47
47
  label: string;
48
48
  expiresAt: string;
49
49
  scope: {
50
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
50
+ [key: string]: string;
51
51
  };
52
52
  };
53
53
  credentialExpiresAt: string | null;
54
54
  environments: {
55
55
  project: string;
56
56
  environment: string;
57
- permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.write")[];
57
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
58
58
  }[];
59
59
  };
60
60
  };
@@ -66,12 +66,13 @@ type Api = {
66
66
  name: string;
67
67
  archivedAt: string | null;
68
68
  folder: string | null;
69
- permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.write")[];
69
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
70
70
  environments: {
71
71
  slug: string;
72
72
  name: string;
73
73
  accessible: boolean;
74
74
  parent: string | null;
75
+ protected: boolean;
75
76
  personal: boolean;
76
77
  details: null | {
77
78
  archivedAt: string | null;
@@ -146,6 +147,7 @@ type Api = {
146
147
  slug: string;
147
148
  name: string;
148
149
  archivedAt: string | null;
150
+ protected: boolean;
149
151
  };
150
152
  created: boolean;
151
153
  forked: null | {
@@ -162,12 +164,14 @@ type Api = {
162
164
  name?: string;
163
165
  archived?: boolean;
164
166
  slug?: string;
167
+ protected?: boolean;
165
168
  };
166
169
  output: {
167
170
  environment: {
168
171
  slug: string;
169
172
  name: string;
170
173
  archivedAt: string | null;
174
+ protected: boolean;
171
175
  };
172
176
  };
173
177
  };
@@ -225,7 +229,7 @@ type Api = {
225
229
  "GET /secrets/:project/:environment": {
226
230
  input: undefined;
227
231
  output: {
228
- permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.write")[];
232
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
229
233
  keys: {
230
234
  key: string;
231
235
  reference: null | {
@@ -254,6 +258,8 @@ type Api = {
254
258
  };
255
259
  };
256
260
  value: string | null;
261
+ sensitivity: "plain" | "secret" | "sensitive" | null;
262
+ readable: boolean;
257
263
  parent: null | {
258
264
  from: string;
259
265
  state: "inherited" | "overridden" | "removed";
@@ -267,6 +273,7 @@ type Api = {
267
273
  of: string;
268
274
  fallback: boolean;
269
275
  };
276
+ protected: boolean;
270
277
  rotateAfterDays: number | null;
271
278
  };
272
279
  };
@@ -282,10 +289,17 @@ type Api = {
282
289
  };
283
290
  };
284
291
  replaces?: string;
292
+ sensitivity?: "secret" | "sensitive";
285
293
  } | {
286
294
  value: string;
287
295
  plain: true;
288
296
  replaces?: string;
297
+ } | {
298
+ value: string;
299
+ sensitivity: "plain" | "secret" | "sensitive";
300
+ replaces?: string;
301
+ } | {
302
+ sensitivity: "plain" | "secret" | "sensitive";
289
303
  } | {
290
304
  ref: string;
291
305
  };
@@ -295,6 +309,7 @@ type Api = {
295
309
  keys: {
296
310
  [key: string]: {
297
311
  version: number;
312
+ sensitivity: "plain" | "secret" | "sensitive";
298
313
  } | {
299
314
  archived: true;
300
315
  } | {
@@ -334,6 +349,7 @@ type Api = {
334
349
  kek: string;
335
350
  recipe: string | null;
336
351
  plain: boolean;
352
+ sensitivity: "plain" | "secret" | "sensitive";
337
353
  }[];
338
354
  };
339
355
  };
@@ -424,6 +440,7 @@ type Api = {
424
440
  values: {
425
441
  [key: string]: string;
426
442
  };
443
+ sensitive: string[];
427
444
  version: string | null;
428
445
  };
429
446
  };
@@ -457,9 +474,9 @@ type Api = {
457
474
  id: string;
458
475
  project: string;
459
476
  environment: string | null;
460
- role: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
477
+ role: string;
461
478
  roleName: string;
462
- permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.write")[];
479
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
463
480
  expiresAt: string | null;
464
481
  }[];
465
482
  }[];
@@ -516,7 +533,7 @@ type Api = {
516
533
  expiresAt: string;
517
534
  lastUsedAt: string | null;
518
535
  scope: null | {
519
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
536
+ [key: string]: string;
520
537
  };
521
538
  }[];
522
539
  apps: {
@@ -540,7 +557,7 @@ type Api = {
540
557
  lastUsedAt: string | null;
541
558
  lastUsedIp: string | null;
542
559
  scope: null | {
543
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
560
+ [key: string]: string;
544
561
  };
545
562
  }[];
546
563
  references: {
@@ -577,8 +594,8 @@ type Api = {
577
594
  };
578
595
  };
579
596
  access?: {
580
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer" | null | {
581
- role: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
597
+ [key: string]: string | null | {
598
+ role: string;
582
599
  until: string | null;
583
600
  };
584
601
  };
@@ -658,7 +675,7 @@ type Api = {
658
675
  expiresAt: string;
659
676
  lastUsedAt: string | null;
660
677
  scope: null | {
661
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
678
+ [key: string]: string;
662
679
  };
663
680
  }[];
664
681
  apps: {
@@ -682,7 +699,7 @@ type Api = {
682
699
  lastUsedAt: string | null;
683
700
  lastUsedIp: string | null;
684
701
  scope: null | {
685
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
702
+ [key: string]: string;
686
703
  };
687
704
  }[];
688
705
  references: {
@@ -717,7 +734,7 @@ type Api = {
717
734
  lastUsedAt: string | null;
718
735
  lastUsedIp: string | null;
719
736
  scope: null | {
720
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
737
+ [key: string]: string;
721
738
  };
722
739
  }[];
723
740
  };
@@ -728,7 +745,7 @@ type Api = {
728
745
  expiresInDays?: number;
729
746
  expiresInMinutes?: number;
730
747
  scope?: {
731
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
748
+ [key: string]: string;
732
749
  };
733
750
  };
734
751
  output: {
@@ -736,11 +753,11 @@ type Api = {
736
753
  token: string;
737
754
  expiresAt: string;
738
755
  scope: {
739
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
756
+ [key: string]: string;
740
757
  };
741
758
  } | {
742
759
  scope: {
743
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
760
+ [key: string]: string;
744
761
  };
745
762
  };
746
763
  };
@@ -767,7 +784,7 @@ type Api = {
767
784
  [key: string]: string | string[];
768
785
  };
769
786
  scope: null | {
770
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
787
+ [key: string]: string;
771
788
  };
772
789
  label: string | null;
773
790
  createdAt: string;
@@ -784,7 +801,7 @@ type Api = {
784
801
  };
785
802
  issuer?: string | null;
786
803
  scope?: {
787
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
804
+ [key: string]: string;
788
805
  };
789
806
  label?: string | null;
790
807
  replaces?: string[];
@@ -807,7 +824,7 @@ type Api = {
807
824
  [key: string]: string | string[];
808
825
  };
809
826
  scope: {
810
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
827
+ [key: string]: string;
811
828
  };
812
829
  replaces: {
813
830
  id: string;
@@ -828,7 +845,7 @@ type Api = {
828
845
  [key: string]: string | string[];
829
846
  };
830
847
  scope: null | {
831
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
848
+ [key: string]: string;
832
849
  };
833
850
  label: string | null;
834
851
  createdAt: string;
@@ -865,8 +882,8 @@ type Api = {
865
882
  };
866
883
  "PATCH /access/:member": {
867
884
  input: {
868
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer" | null | {
869
- role: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
885
+ [key: string]: string | null | {
886
+ role: string;
870
887
  until: string | null;
871
888
  };
872
889
  };
@@ -1083,11 +1100,16 @@ type Api = {
1083
1100
  };
1084
1101
  };
1085
1102
  "GET /audit/verification": {
1086
- input: undefined;
1103
+ input: {
1104
+ from?: string;
1105
+ };
1087
1106
  output: {
1088
1107
  ok: true;
1089
1108
  through: number | null;
1090
1109
  entries: number;
1110
+ from: number;
1111
+ remaining: number;
1112
+ next?: string | null;
1091
1113
  checkpoint: null | {
1092
1114
  seq: number;
1093
1115
  signedAt: string;
@@ -1215,9 +1237,9 @@ type Api = {
1215
1237
  id: string;
1216
1238
  project: string;
1217
1239
  environment: string | null;
1218
- role: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
1240
+ role: string;
1219
1241
  roleName: string;
1220
- permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.write")[];
1242
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1221
1243
  expiresAt: string | null;
1222
1244
  }[];
1223
1245
  };
@@ -1327,7 +1349,7 @@ type Api = {
1327
1349
  [key: string]: string | string[];
1328
1350
  };
1329
1351
  scope: null | {
1330
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
1352
+ [key: string]: string;
1331
1353
  };
1332
1354
  label: string | null;
1333
1355
  createdAt: string;
@@ -1361,13 +1383,209 @@ type Api = {
1361
1383
  token: string;
1362
1384
  expiresAt: string;
1363
1385
  scope: {
1364
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
1386
+ [key: string]: string;
1387
+ };
1388
+ };
1389
+ };
1390
+ "GET /roles": {
1391
+ input: undefined;
1392
+ output: {
1393
+ roles: {
1394
+ name: string;
1395
+ description: string;
1396
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1397
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1398
+ id: string;
1399
+ builtin: boolean;
1400
+ edited: boolean;
1401
+ fixed: boolean;
1402
+ default: null | {
1403
+ name: string;
1404
+ description: string;
1405
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1406
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1407
+ };
1408
+ assignableToEnvironment: boolean;
1409
+ grants: number;
1410
+ }[];
1411
+ instanceRoles: {
1412
+ name: string;
1413
+ description: string;
1414
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1415
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1416
+ id: string;
1417
+ builtin: boolean;
1418
+ edited: boolean;
1419
+ fixed: boolean;
1420
+ default: null | {
1421
+ name: string;
1422
+ description: string;
1423
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1424
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1425
+ };
1426
+ assignableToEnvironment: boolean;
1427
+ grants: number;
1428
+ }[];
1429
+ editable: boolean;
1430
+ };
1431
+ };
1432
+ "PUT /roles/:role": {
1433
+ input: {
1434
+ name: string;
1435
+ description: string;
1436
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1437
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1438
+ };
1439
+ output: {
1440
+ impact: {
1441
+ change: "narrows" | "widens";
1442
+ permission: "audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write";
1443
+ protected: boolean;
1444
+ people: number;
1445
+ services: number;
1446
+ environments: number;
1447
+ projects: number;
1448
+ examples: string[];
1449
+ }[];
1450
+ sentence: string;
1451
+ revision: string;
1452
+ } | {
1453
+ role: null | {
1454
+ name: string;
1455
+ description: string;
1456
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1457
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1458
+ id: string;
1459
+ builtin: boolean;
1460
+ edited: boolean;
1461
+ fixed: boolean;
1462
+ default: null | {
1463
+ name: string;
1464
+ description: string;
1465
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1466
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1467
+ };
1468
+ assignableToEnvironment: boolean;
1469
+ grants: number;
1470
+ };
1471
+ };
1472
+ };
1473
+ "DELETE /roles/:role": {
1474
+ input: undefined;
1475
+ output: {
1476
+ impact: {
1477
+ change: "narrows" | "widens";
1478
+ permission: "audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write";
1479
+ protected: boolean;
1480
+ people: number;
1481
+ services: number;
1482
+ environments: number;
1483
+ projects: number;
1484
+ examples: string[];
1485
+ }[];
1486
+ sentence: string;
1487
+ revision: string;
1488
+ } | {
1489
+ role: null | {
1490
+ name: string;
1491
+ description: string;
1492
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1493
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1494
+ id: string;
1495
+ builtin: boolean;
1496
+ edited: boolean;
1497
+ fixed: boolean;
1498
+ default: null | {
1499
+ name: string;
1500
+ description: string;
1501
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1502
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1503
+ };
1504
+ assignableToEnvironment: boolean;
1505
+ grants: number;
1506
+ };
1507
+ };
1508
+ };
1509
+ "PUT /instance-roles/:role": {
1510
+ input: {
1511
+ name: string;
1512
+ description: string;
1513
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1514
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1515
+ };
1516
+ output: {
1517
+ impact: {
1518
+ change: "narrows" | "widens";
1519
+ permission: "audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write";
1520
+ protected: boolean;
1521
+ people: number;
1522
+ services: number;
1523
+ environments: number;
1524
+ projects: number;
1525
+ examples: string[];
1526
+ }[];
1527
+ sentence: string;
1528
+ revision: string;
1529
+ } | {
1530
+ role: null | {
1531
+ name: string;
1532
+ description: string;
1533
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1534
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1535
+ id: string;
1536
+ builtin: boolean;
1537
+ edited: boolean;
1538
+ fixed: boolean;
1539
+ default: null | {
1540
+ name: string;
1541
+ description: string;
1542
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1543
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1544
+ };
1545
+ assignableToEnvironment: boolean;
1546
+ grants: number;
1547
+ };
1548
+ };
1549
+ };
1550
+ "DELETE /instance-roles/:role": {
1551
+ input: undefined;
1552
+ output: {
1553
+ impact: {
1554
+ change: "narrows" | "widens";
1555
+ permission: "audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write";
1556
+ protected: boolean;
1557
+ people: number;
1558
+ services: number;
1559
+ environments: number;
1560
+ projects: number;
1561
+ examples: string[];
1562
+ }[];
1563
+ sentence: string;
1564
+ revision: string;
1565
+ } | {
1566
+ role: null | {
1567
+ name: string;
1568
+ description: string;
1569
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1570
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1571
+ id: string;
1572
+ builtin: boolean;
1573
+ edited: boolean;
1574
+ fixed: boolean;
1575
+ default: null | {
1576
+ name: string;
1577
+ description: string;
1578
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1579
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1580
+ };
1581
+ assignableToEnvironment: boolean;
1582
+ grants: number;
1365
1583
  };
1366
1584
  };
1367
1585
  };
1368
1586
  };
1369
- type AccessValue = "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer" | null | {
1370
- role: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
1587
+ type AccessValue = string | null | {
1588
+ role: string;
1371
1589
  until: string | null;
1372
1590
  };
1373
1591
  type ApprovalView = {
@@ -1492,7 +1710,7 @@ type BindingPlan = {
1492
1710
  [key: string]: string | string[];
1493
1711
  };
1494
1712
  scope: {
1495
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
1713
+ [key: string]: string;
1496
1714
  };
1497
1715
  replaces: {
1498
1716
  id: string;
@@ -1513,7 +1731,7 @@ type BindingView = {
1513
1731
  [key: string]: string | string[];
1514
1732
  };
1515
1733
  scope: null | {
1516
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
1734
+ [key: string]: string;
1517
1735
  };
1518
1736
  label: string | null;
1519
1737
  createdAt: string;
@@ -1678,14 +1896,14 @@ type Me = {
1678
1896
  label: string;
1679
1897
  expiresAt: string;
1680
1898
  scope: {
1681
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
1899
+ [key: string]: string;
1682
1900
  };
1683
1901
  };
1684
1902
  credentialExpiresAt: string | null;
1685
1903
  environments: {
1686
1904
  project: string;
1687
1905
  environment: string;
1688
- permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.write")[];
1906
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1689
1907
  }[];
1690
1908
  };
1691
1909
  type Member = {
@@ -1713,9 +1931,9 @@ type Member = {
1713
1931
  id: string;
1714
1932
  project: string;
1715
1933
  environment: string | null;
1716
- role: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
1934
+ role: string;
1717
1935
  roleName: string;
1718
- permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.write")[];
1936
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1719
1937
  expiresAt: string | null;
1720
1938
  }[];
1721
1939
  };
@@ -1742,9 +1960,9 @@ type MemberAccess = {
1742
1960
  id: string;
1743
1961
  project: string;
1744
1962
  environment: string | null;
1745
- role: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
1963
+ role: string;
1746
1964
  roleName: string;
1747
- permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.write")[];
1965
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1748
1966
  expiresAt: string | null;
1749
1967
  }[];
1750
1968
  };
@@ -1797,7 +2015,7 @@ type OffboardingReport = {
1797
2015
  expiresAt: string;
1798
2016
  lastUsedAt: string | null;
1799
2017
  scope: null | {
1800
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
2018
+ [key: string]: string;
1801
2019
  };
1802
2020
  }[];
1803
2021
  apps: {
@@ -1821,7 +2039,7 @@ type OffboardingReport = {
1821
2039
  lastUsedAt: string | null;
1822
2040
  lastUsedIp: string | null;
1823
2041
  scope: null | {
1824
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
2042
+ [key: string]: string;
1825
2043
  };
1826
2044
  }[];
1827
2045
  references: {
@@ -1868,12 +2086,13 @@ type ProjectSummary = {
1868
2086
  name: string;
1869
2087
  archivedAt: string | null;
1870
2088
  folder: string | null;
1871
- permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.write")[];
2089
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
1872
2090
  environments: {
1873
2091
  slug: string;
1874
2092
  name: string;
1875
2093
  accessible: boolean;
1876
2094
  parent: string | null;
2095
+ protected: boolean;
1877
2096
  personal: boolean;
1878
2097
  details: null | {
1879
2098
  archivedAt: string | null;
@@ -1898,6 +2117,93 @@ type RemovedMember = {
1898
2117
  principalId: string;
1899
2118
  toRotate: number;
1900
2119
  };
2120
+ type ImpactLine = {
2121
+ change: "narrows" | "widens";
2122
+ permission: "audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write";
2123
+ protected: boolean;
2124
+ people: number;
2125
+ services: number;
2126
+ environments: number;
2127
+ projects: number;
2128
+ examples: string[];
2129
+ };
2130
+ type RoleImpact = {
2131
+ impact: {
2132
+ change: "narrows" | "widens";
2133
+ permission: "audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write";
2134
+ protected: boolean;
2135
+ people: number;
2136
+ services: number;
2137
+ environments: number;
2138
+ projects: number;
2139
+ examples: string[];
2140
+ }[];
2141
+ sentence: string;
2142
+ revision: string;
2143
+ };
2144
+ type RoleView = {
2145
+ name: string;
2146
+ description: string;
2147
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
2148
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
2149
+ id: string;
2150
+ builtin: boolean;
2151
+ edited: boolean;
2152
+ fixed: boolean;
2153
+ default: null | {
2154
+ name: string;
2155
+ description: string;
2156
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
2157
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
2158
+ };
2159
+ assignableToEnvironment: boolean;
2160
+ grants: number;
2161
+ };
2162
+ type RolesView = {
2163
+ roles: {
2164
+ name: string;
2165
+ description: string;
2166
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
2167
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
2168
+ id: string;
2169
+ builtin: boolean;
2170
+ edited: boolean;
2171
+ fixed: boolean;
2172
+ default: null | {
2173
+ name: string;
2174
+ description: string;
2175
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
2176
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
2177
+ };
2178
+ assignableToEnvironment: boolean;
2179
+ grants: number;
2180
+ }[];
2181
+ instanceRoles: {
2182
+ name: string;
2183
+ description: string;
2184
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
2185
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
2186
+ id: string;
2187
+ builtin: boolean;
2188
+ edited: boolean;
2189
+ fixed: boolean;
2190
+ default: null | {
2191
+ name: string;
2192
+ description: string;
2193
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
2194
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
2195
+ };
2196
+ assignableToEnvironment: boolean;
2197
+ grants: number;
2198
+ }[];
2199
+ editable: boolean;
2200
+ };
2201
+ type EnvironmentView = {
2202
+ slug: string;
2203
+ name: string;
2204
+ archivedAt: string | null;
2205
+ protected: boolean;
2206
+ };
1901
2207
  type SecretKey = {
1902
2208
  key: string;
1903
2209
  reference: null | {
@@ -1926,6 +2232,8 @@ type SecretKey = {
1926
2232
  };
1927
2233
  };
1928
2234
  value: string | null;
2235
+ sensitivity: "plain" | "secret" | "sensitive" | null;
2236
+ readable: boolean;
1929
2237
  parent: null | {
1930
2238
  from: string;
1931
2239
  state: "inherited" | "overridden" | "removed";
@@ -1942,6 +2250,7 @@ type SecretVersion = {
1942
2250
  kek: string;
1943
2251
  recipe: string | null;
1944
2252
  plain: boolean;
2253
+ sensitivity: "plain" | "secret" | "sensitive";
1945
2254
  };
1946
2255
  type SessionRow = {
1947
2256
  id: string;
@@ -1960,6 +2269,7 @@ type SetResult = {
1960
2269
  keys: {
1961
2270
  [key: string]: {
1962
2271
  version: number;
2272
+ sensitivity: "plain" | "secret" | "sensitive";
1963
2273
  } | {
1964
2274
  archived: true;
1965
2275
  } | {
@@ -1969,7 +2279,7 @@ type SetResult = {
1969
2279
  };
1970
2280
  type TokenPlan = {
1971
2281
  scope: {
1972
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
2282
+ [key: string]: string;
1973
2283
  };
1974
2284
  };
1975
2285
  type TokenRow = {
@@ -1982,7 +2292,7 @@ type TokenRow = {
1982
2292
  lastUsedAt: string | null;
1983
2293
  lastUsedIp: string | null;
1984
2294
  scope: null | {
1985
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
2295
+ [key: string]: string;
1986
2296
  };
1987
2297
  };
1988
2298
  //#endregion
@@ -2074,6 +2384,11 @@ declare class CoffreError extends Error {
2074
2384
  constructor(status: number, code: string, message: string, reason?: string);
2075
2385
  }
2076
2386
  type Args<K extends RouteKey> = RouteInput<K> extends undefined ? [params: Params<K>, input?: undefined] : Partial<RouteInput<K>> extends RouteInput<K> ? [params: Params<K>, input?: RouteInput<K>] : [params: Params<K>, input: RouteInput<K>];
2387
+ /** A role's change confirmed: an instance role's, and the `revision` of the policy its preview answered with. */
2388
+ type Confirmed = {
2389
+ instance?: boolean;
2390
+ revision?: string;
2391
+ };
2077
2392
  declare function createClient(options: ClientOptions): {
2078
2393
  call: <K extends RouteKey>(key: K, ...[params, input]: Args<K>) => Promise<RouteOutput<K>>;
2079
2394
  /** How this instance signs people in. Answers anyone, signed in or not. */
@@ -2123,14 +2438,14 @@ declare function createClient(options: ClientOptions): {
2123
2438
  label: string;
2124
2439
  expiresAt: string;
2125
2440
  scope: {
2126
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
2441
+ [key: string]: string;
2127
2442
  };
2128
2443
  };
2129
2444
  credentialExpiresAt: string | null;
2130
2445
  environments: {
2131
2446
  project: string;
2132
2447
  environment: string;
2133
- permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.write")[];
2448
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
2134
2449
  }[];
2135
2450
  }>;
2136
2451
  projects: {
@@ -2141,12 +2456,13 @@ declare function createClient(options: ClientOptions): {
2141
2456
  name: string;
2142
2457
  archivedAt: string | null;
2143
2458
  folder: string | null;
2144
- permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.write")[];
2459
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
2145
2460
  environments: {
2146
2461
  slug: string;
2147
2462
  name: string;
2148
2463
  accessible: boolean;
2149
2464
  parent: string | null;
2465
+ protected: boolean;
2150
2466
  personal: boolean;
2151
2467
  details: null | {
2152
2468
  archivedAt: string | null;
@@ -2204,6 +2520,7 @@ declare function createClient(options: ClientOptions): {
2204
2520
  slug: string;
2205
2521
  name: string;
2206
2522
  archivedAt: string | null;
2523
+ protected: boolean;
2207
2524
  };
2208
2525
  created: boolean;
2209
2526
  forked: null | {
@@ -2219,6 +2536,20 @@ declare function createClient(options: ClientOptions): {
2219
2536
  slug: string;
2220
2537
  name: string;
2221
2538
  archivedAt: string | null;
2539
+ protected: boolean;
2540
+ };
2541
+ }>;
2542
+ /**
2543
+ * Protected, a person holds their role's protected column there
2544
+ * (docs/design/roles.md); whoever manages the project's environments
2545
+ * protects one, and only an Owner of the whole instance unprotects it.
2546
+ */
2547
+ protect: (path: string, on?: boolean) => Promise<{
2548
+ environment: {
2549
+ slug: string;
2550
+ name: string;
2551
+ archivedAt: string | null;
2552
+ protected: boolean;
2222
2553
  };
2223
2554
  }>;
2224
2555
  /** What deleting an archived environment would erase and revoke; changes nothing. */
@@ -2289,7 +2620,7 @@ declare function createClient(options: ClientOptions): {
2289
2620
  secrets: {
2290
2621
  /** Keys, versions and who changed what; never values. */
2291
2622
  list: (path: string) => Promise<{
2292
- permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.write")[];
2623
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
2293
2624
  keys: {
2294
2625
  key: string;
2295
2626
  reference: null | {
@@ -2318,6 +2649,8 @@ declare function createClient(options: ClientOptions): {
2318
2649
  };
2319
2650
  };
2320
2651
  value: string | null;
2652
+ sensitivity: "plain" | "secret" | "sensitive" | null;
2653
+ readable: boolean;
2321
2654
  parent: null | {
2322
2655
  from: string;
2323
2656
  state: "inherited" | "overridden" | "removed";
@@ -2331,6 +2664,7 @@ declare function createClient(options: ClientOptions): {
2331
2664
  of: string;
2332
2665
  fallback: boolean;
2333
2666
  };
2667
+ protected: boolean;
2334
2668
  rotateAfterDays: number | null;
2335
2669
  }>;
2336
2670
  /** Decrypts one secret, or every secret in an environment. Logged in your name. */
@@ -2339,6 +2673,7 @@ declare function createClient(options: ClientOptions): {
2339
2673
  values: {
2340
2674
  [key: string]: string;
2341
2675
  };
2676
+ sensitive: string[];
2342
2677
  version: string | null;
2343
2678
  }>;
2344
2679
  /** One transaction, a version and an audit entry per key; `null` archives. */
@@ -2360,6 +2695,7 @@ declare function createClient(options: ClientOptions): {
2360
2695
  kek: string;
2361
2696
  recipe: string | null;
2362
2697
  plain: boolean;
2698
+ sensitivity: "plain" | "secret" | "sensitive";
2363
2699
  }[];
2364
2700
  }>;
2365
2701
  /** A new version holding the old one's value. */
@@ -2448,9 +2784,9 @@ declare function createClient(options: ClientOptions): {
2448
2784
  id: string;
2449
2785
  project: string;
2450
2786
  environment: string | null;
2451
- role: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
2787
+ role: string;
2452
2788
  roleName: string;
2453
- permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.write")[];
2789
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
2454
2790
  expiresAt: string | null;
2455
2791
  }[];
2456
2792
  }[];
@@ -2505,7 +2841,7 @@ declare function createClient(options: ClientOptions): {
2505
2841
  expiresAt: string;
2506
2842
  lastUsedAt: string | null;
2507
2843
  scope: null | {
2508
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
2844
+ [key: string]: string;
2509
2845
  };
2510
2846
  }[];
2511
2847
  apps: {
@@ -2529,7 +2865,7 @@ declare function createClient(options: ClientOptions): {
2529
2865
  lastUsedAt: string | null;
2530
2866
  lastUsedIp: string | null;
2531
2867
  scope: null | {
2532
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
2868
+ [key: string]: string;
2533
2869
  };
2534
2870
  }[];
2535
2871
  references: {
@@ -2573,9 +2909,9 @@ declare function createClient(options: ClientOptions): {
2573
2909
  id: string;
2574
2910
  project: string;
2575
2911
  environment: string | null;
2576
- role: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
2912
+ role: string;
2577
2913
  roleName: string;
2578
- permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.write")[];
2914
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
2579
2915
  expiresAt: string | null;
2580
2916
  }[];
2581
2917
  }>;
@@ -2652,7 +2988,7 @@ declare function createClient(options: ClientOptions): {
2652
2988
  expiresAt: string;
2653
2989
  lastUsedAt: string | null;
2654
2990
  scope: null | {
2655
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
2991
+ [key: string]: string;
2656
2992
  };
2657
2993
  }[];
2658
2994
  apps: {
@@ -2676,7 +3012,7 @@ declare function createClient(options: ClientOptions): {
2676
3012
  lastUsedAt: string | null;
2677
3013
  lastUsedIp: string | null;
2678
3014
  scope: null | {
2679
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
3015
+ [key: string]: string;
2680
3016
  };
2681
3017
  }[];
2682
3018
  references: {
@@ -2714,7 +3050,7 @@ declare function createClient(options: ClientOptions): {
2714
3050
  lastUsedAt: string | null;
2715
3051
  lastUsedIp: string | null;
2716
3052
  scope: null | {
2717
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
3053
+ [key: string]: string;
2718
3054
  };
2719
3055
  }[];
2720
3056
  }>;
@@ -2729,7 +3065,7 @@ declare function createClient(options: ClientOptions): {
2729
3065
  }>;
2730
3066
  };
2731
3067
  /**
2732
- * Handles: stand-ins a person's app holds in place of an environment's
3068
+ * Handles: placeholders a person's app holds in place of an environment's
2733
3069
  * values, which only the credential proxy (`/use`) takes. The value is
2734
3070
  * in the answer, and only there; it is revoked as a token is.
2735
3071
  */
@@ -2739,7 +3075,7 @@ declare function createClient(options: ClientOptions): {
2739
3075
  token: string;
2740
3076
  expiresAt: string;
2741
3077
  scope: {
2742
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
3078
+ [key: string]: string;
2743
3079
  };
2744
3080
  }>;
2745
3081
  };
@@ -2760,7 +3096,7 @@ declare function createClient(options: ClientOptions): {
2760
3096
  [key: string]: string | string[];
2761
3097
  };
2762
3098
  scope: null | {
2763
- [key: string]: "access-manager" | "auditor" | "developer" | "maintainer" | "owner" | "viewer";
3099
+ [key: string]: string;
2764
3100
  };
2765
3101
  label: string | null;
2766
3102
  createdAt: string;
@@ -3029,6 +3365,73 @@ declare function createClient(options: ClientOptions): {
3029
3365
  disconnected: true;
3030
3366
  }>;
3031
3367
  };
3368
+ /**
3369
+ * The instance's roles, in two columns, an environment's that is not
3370
+ * protected and one's that is (docs/design/roles.md). Any member lists
3371
+ * them; an Owner of the whole instance edits them. `instance` is about
3372
+ * instance roles, a person's across every project in their scope.
3373
+ */
3374
+ roles: {
3375
+ list: () => Promise<{
3376
+ roles: {
3377
+ name: string;
3378
+ description: string;
3379
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
3380
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
3381
+ id: string;
3382
+ builtin: boolean;
3383
+ edited: boolean;
3384
+ fixed: boolean;
3385
+ default: null | {
3386
+ name: string;
3387
+ description: string;
3388
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
3389
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
3390
+ };
3391
+ assignableToEnvironment: boolean;
3392
+ grants: number;
3393
+ }[];
3394
+ instanceRoles: {
3395
+ name: string;
3396
+ description: string;
3397
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
3398
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
3399
+ id: string;
3400
+ builtin: boolean;
3401
+ edited: boolean;
3402
+ fixed: boolean;
3403
+ default: null | {
3404
+ name: string;
3405
+ description: string;
3406
+ permissions: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
3407
+ protected: ("audit.read" | "environment.manage" | "grant.manage" | "project.manage" | "secret.archive" | "secret.read" | "secret.use" | "secret.write")[];
3408
+ };
3409
+ assignableToEnvironment: boolean;
3410
+ grants: number;
3411
+ }[];
3412
+ editable: boolean;
3413
+ }>;
3414
+ /** What defining the role so would do to everyone it reaches; changes nothing. */
3415
+ preview: (role: string, definition: RouteInput<"PUT /roles/:role">, { instance }?: {
3416
+ instance?: boolean | undefined;
3417
+ }) => Promise<RoleImpact>;
3418
+ /**
3419
+ * A built-in role edited, or one an Owner makes. With its preview's
3420
+ * `revision`, made as previewed, or refused (409 `policy_changed`)
3421
+ * if the policy changed since: preview it again.
3422
+ */
3423
+ set: (role: string, definition: RouteInput<"PUT /roles/:role">, { instance, revision }?: Confirmed) => Promise<{
3424
+ role: RouteOutput<"GET /roles">["roles"][number] | null;
3425
+ }>;
3426
+ /** What putting it back as it ships, or deleting one an Owner made, would do; changes nothing. */
3427
+ previewReset: (role: string, { instance }?: {
3428
+ instance?: boolean | undefined;
3429
+ }) => Promise<RoleImpact>;
3430
+ /** A built-in role back as it ships; one an Owner made, deleted, while no grant names it. With its preview's `revision`, as `set`. */
3431
+ reset: (role: string, { instance, revision }?: Confirmed) => Promise<{
3432
+ role: RouteOutput<"GET /roles">["roles"][number] | null;
3433
+ }>;
3434
+ };
3032
3435
  /** The instance's settings, for those who run it: where people set up service accounts themselves. */
3033
3436
  settings: {
3034
3437
  get: () => Promise<{
@@ -3104,10 +3507,42 @@ declare function createClient(options: ClientOptions): {
3104
3507
  count: number;
3105
3508
  }[];
3106
3509
  }>;
3107
- verify: () => Promise<{
3510
+ /**
3511
+ * Whether the log holds, from the newest checkpoint; or, with `from`, a
3512
+ * stretch of the walk from the first entry: `start`, then each `next`
3513
+ * until it is null (`verifyWhole`).
3514
+ */
3515
+ verify: (query?: RouteInput<"GET /audit/verification">) => Promise<{
3516
+ ok: true;
3517
+ through: number | null;
3518
+ entries: number;
3519
+ from: number;
3520
+ remaining: number;
3521
+ next?: string | null;
3522
+ checkpoint: null | {
3523
+ seq: number;
3524
+ signedAt: string;
3525
+ };
3526
+ pending?: number;
3527
+ } | {
3528
+ ok: false;
3529
+ through: number | null;
3530
+ failedAtSeq: number | null;
3531
+ author: "app" | "vault";
3532
+ reason: string;
3533
+ }>;
3534
+ /**
3535
+ * The walk from the first entry to the head, a stretch a request, each
3536
+ * as long as the server walks in one: the first stretch that fails, or
3537
+ * the last. `onStretch` sees each verdict as it comes.
3538
+ */
3539
+ verifyWhole: (onStretch?: (verdict: RouteOutput<"GET /audit/verification">) => void) => Promise<{
3108
3540
  ok: true;
3109
3541
  through: number | null;
3110
3542
  entries: number;
3543
+ from: number;
3544
+ remaining: number;
3545
+ next?: string | null;
3111
3546
  checkpoint: null | {
3112
3547
  seq: number;
3113
3548
  signedAt: string;
@@ -3162,4 +3597,4 @@ declare function planImport(coffre: CoffreClient, path: string, entries: readonl
3162
3597
  changes: Record<string, string>;
3163
3598
  }>;
3164
3599
  //#endregion
3165
- export { TokenPlan as $, Decision as A, Me as B, ApprovalView as C, BindingPlan as D, AuthorizationView as E, DryRunResult as F, PersonalConfig as G, MemberAccess as H, IdentityRow as I, RemovedMember as J, ProjectSummary as K, InheritResult as L, DeletionResult as M, DismissedKey as N, BindingView as O, DryRunOutcome as P, SetResult as Q, KeysPlan as R, Api as S, AuthInfo as T, MissingKey as U, Member as V, OffboardingReport as W, SecretVersion as X, SecretKey as Y, SessionRow as Z, byFolder as _, Params as a, olderThan as b, RouteOutput as c, planImport as d, TokenRow as et, Unreachable as f, shownMember as g, serviceName as h, ImportAction as i, Deletion as j, ConnectedApp as k, Transport as l, apiMember as m, CoffreClient as n, RouteInput as o, unreachable as p, ReferenceView as q, CoffreError as r, RouteKey as s, ClientOptions as t, WorkloadIds as tt, createClient as u, foldersOf as v, AuditEntryView as w, AccessValue as x, ageInDays as y, ListedReference as z };
3600
+ export { RolesView as $, Decision as A, KeysPlan as B, ApprovalView as C, BindingPlan as D, AuthorizationView as E, DryRunResult as F, MissingKey as G, Me as H, EnvironmentView as I, ProjectSummary as J, OffboardingReport as K, IdentityRow as L, DeletionResult as M, DismissedKey as N, BindingView as O, DryRunOutcome as P, RoleView as Q, ImpactLine as R, Api as S, AuthInfo as T, Member as U, ListedReference as V, MemberAccess as W, RemovedMember as X, ReferenceView as Y, RoleImpact as Z, byFolder as _, Params as a, TokenRow as at, olderThan as b, RouteOutput as c, planImport as d, SecretKey as et, Unreachable as f, shownMember as g, serviceName as h, ImportAction as i, TokenPlan as it, Deletion as j, ConnectedApp as k, Transport as l, apiMember as m, CoffreClient as n, SessionRow as nt, RouteInput as o, WorkloadIds as ot, unreachable as p, PersonalConfig as q, CoffreError as r, SetResult as rt, RouteKey as s, ClientOptions as t, SecretVersion as tt, createClient as u, foldersOf as v, AuditEntryView as w, AccessValue as x, ageInDays as y, InheritResult as z };