@coffre/client 0.10.2 → 0.12.0

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.
@@ -73,6 +73,7 @@ type Api = {
73
73
  accessible: boolean;
74
74
  parent: string | null;
75
75
  protected: boolean;
76
+ unprotectable: boolean;
76
77
  personal: boolean;
77
78
  details: null | {
78
79
  archivedAt: string | null;
@@ -274,6 +275,8 @@ type Api = {
274
275
  fallback: boolean;
275
276
  };
276
277
  protected: boolean;
278
+ unprotectable: boolean;
279
+ loosenable: boolean;
277
280
  rotateAfterDays: number | null;
278
281
  };
279
282
  };
@@ -434,6 +437,7 @@ type Api = {
434
437
  "POST /reveals": {
435
438
  input: {
436
439
  path: string;
440
+ keys?: string[];
437
441
  };
438
442
  output: {
439
443
  operationId: string;
@@ -441,6 +445,7 @@ type Api = {
441
445
  [key: string]: string;
442
446
  };
443
447
  sensitive: string[];
448
+ useOnly: string[];
444
449
  version: string | null;
445
450
  };
446
451
  };
@@ -559,6 +564,9 @@ type Api = {
559
564
  scope: null | {
560
565
  [key: string]: string;
561
566
  };
567
+ session?: {
568
+ bindingId: string | null;
569
+ };
562
570
  }[];
563
571
  references: {
564
572
  id: string;
@@ -701,6 +709,9 @@ type Api = {
701
709
  scope: null | {
702
710
  [key: string]: string;
703
711
  };
712
+ session?: {
713
+ bindingId: string | null;
714
+ };
704
715
  }[];
705
716
  references: {
706
717
  id: string;
@@ -736,6 +747,9 @@ type Api = {
736
747
  scope: null | {
737
748
  [key: string]: string;
738
749
  };
750
+ session?: {
751
+ bindingId: string | null;
752
+ };
739
753
  }[];
740
754
  };
741
755
  };
@@ -749,16 +763,18 @@ type Api = {
749
763
  };
750
764
  };
751
765
  output: {
752
- id: string;
753
- token: string;
754
- expiresAt: string;
755
766
  scope: {
756
767
  [key: string]: string;
757
768
  };
769
+ withheld?: string[];
758
770
  } | {
771
+ id: string;
772
+ token: string;
773
+ expiresAt: string;
759
774
  scope: {
760
775
  [key: string]: string;
761
776
  };
777
+ withheld?: string[];
762
778
  };
763
779
  };
764
780
  "DELETE /members/:member/tokens/:id": {
@@ -772,7 +788,7 @@ type Api = {
772
788
  output: {
773
789
  bindings: {
774
790
  id: string;
775
- profile: "custom" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab";
791
+ profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
776
792
  issuer: string;
777
793
  jwksUri: string;
778
794
  keys: null | {
@@ -786,6 +802,22 @@ type Api = {
786
802
  scope: null | {
787
803
  [key: string]: string;
788
804
  };
805
+ policy: null | {
806
+ sources?: string[];
807
+ audience?: string;
808
+ keyAudience?: true;
809
+ sessionHours?: number;
810
+ replicas?: number;
811
+ sessionDays?: number;
812
+ overlapMinutes?: number;
813
+ mintedBy?: string;
814
+ approve?: true;
815
+ onContention?: "alert";
816
+ unsignedUploads?: true;
817
+ reads?: {
818
+ [key: string]: "*" | string[];
819
+ };
820
+ };
789
821
  label: string | null;
790
822
  createdAt: string;
791
823
  createdBy: string;
@@ -795,7 +827,7 @@ type Api = {
795
827
  };
796
828
  "POST /members/:member/bindings": {
797
829
  input: {
798
- profile: "custom" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab";
830
+ profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
799
831
  claims: {
800
832
  [key: string]: string | string[];
801
833
  };
@@ -810,9 +842,12 @@ type Api = {
810
842
  [key: string]: unknown;
811
843
  }[];
812
844
  };
845
+ policy?: {
846
+ [key: string]: unknown;
847
+ };
813
848
  };
814
849
  output: {
815
- profile: "custom" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab";
850
+ profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
816
851
  issuer: string;
817
852
  jwksUri: string;
818
853
  keys: null | {
@@ -826,6 +861,23 @@ type Api = {
826
861
  scope: {
827
862
  [key: string]: string;
828
863
  };
864
+ policy: null | {
865
+ sources?: string[];
866
+ audience?: string;
867
+ keyAudience?: true;
868
+ sessionHours?: number;
869
+ replicas?: number;
870
+ sessionDays?: number;
871
+ overlapMinutes?: number;
872
+ mintedBy?: string;
873
+ approve?: true;
874
+ onContention?: "alert";
875
+ unsignedUploads?: true;
876
+ reads?: {
877
+ [key: string]: "*" | string[];
878
+ };
879
+ };
880
+ withheld: string[];
829
881
  replaces: {
830
882
  id: string;
831
883
  why: "asked" | "keys_moved";
@@ -833,7 +885,7 @@ type Api = {
833
885
  } | {
834
886
  binding: {
835
887
  id: string;
836
- profile: "custom" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab";
888
+ profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
837
889
  issuer: string;
838
890
  jwksUri: string;
839
891
  keys: null | {
@@ -847,6 +899,22 @@ type Api = {
847
899
  scope: null | {
848
900
  [key: string]: string;
849
901
  };
902
+ policy: null | {
903
+ sources?: string[];
904
+ audience?: string;
905
+ keyAudience?: true;
906
+ sessionHours?: number;
907
+ replicas?: number;
908
+ sessionDays?: number;
909
+ overlapMinutes?: number;
910
+ mintedBy?: string;
911
+ approve?: true;
912
+ onContention?: "alert";
913
+ unsignedUploads?: true;
914
+ reads?: {
915
+ [key: string]: "*" | string[];
916
+ };
917
+ };
850
918
  label: string | null;
851
919
  createdAt: string;
852
920
  createdBy: string;
@@ -1334,10 +1402,11 @@ type Api = {
1334
1402
  thumbprint: string;
1335
1403
  }[];
1336
1404
  replaces: string[];
1405
+ withheld: string[];
1337
1406
  } | {
1338
1407
  bindings: {
1339
1408
  id: string;
1340
- profile: "custom" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab";
1409
+ profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
1341
1410
  issuer: string;
1342
1411
  jwksUri: string;
1343
1412
  keys: null | {
@@ -1351,6 +1420,22 @@ type Api = {
1351
1420
  scope: null | {
1352
1421
  [key: string]: string;
1353
1422
  };
1423
+ policy: null | {
1424
+ sources?: string[];
1425
+ audience?: string;
1426
+ keyAudience?: true;
1427
+ sessionHours?: number;
1428
+ replicas?: number;
1429
+ sessionDays?: number;
1430
+ overlapMinutes?: number;
1431
+ mintedBy?: string;
1432
+ approve?: true;
1433
+ onContention?: "alert";
1434
+ unsignedUploads?: true;
1435
+ reads?: {
1436
+ [key: string]: "*" | string[];
1437
+ };
1438
+ };
1354
1439
  label: string | null;
1355
1440
  createdAt: string;
1356
1441
  createdBy: string;
@@ -1385,6 +1470,7 @@ type Api = {
1385
1470
  scope: {
1386
1471
  [key: string]: string;
1387
1472
  };
1473
+ withheld?: string[];
1388
1474
  };
1389
1475
  };
1390
1476
  "GET /roles": {
@@ -1583,6 +1669,47 @@ type Api = {
1583
1669
  };
1584
1670
  };
1585
1671
  };
1672
+ "GET /members/:member/bindings/:id/enrollments": {
1673
+ input: undefined;
1674
+ output: never;
1675
+ };
1676
+ "POST /members/:member/bindings/:id/enrollments": {
1677
+ input: {
1678
+ [key: string]: never;
1679
+ };
1680
+ output: never;
1681
+ };
1682
+ "POST /members/:member/bindings/:id/enrollments/:enrollment/promote": {
1683
+ input: {
1684
+ now?: boolean;
1685
+ };
1686
+ output: never;
1687
+ };
1688
+ "POST /members/:member/tokens/:id/approve": {
1689
+ input: undefined;
1690
+ output: never;
1691
+ };
1692
+ "GET /freezes": {
1693
+ input: undefined;
1694
+ output: never;
1695
+ };
1696
+ "POST /freezes": {
1697
+ input: {
1698
+ target: string;
1699
+ reason: string;
1700
+ };
1701
+ output: never;
1702
+ };
1703
+ "DELETE /freezes/:target": {
1704
+ input: undefined;
1705
+ output: never;
1706
+ };
1707
+ "DELETE /handles/:id": {
1708
+ input: undefined;
1709
+ output: {
1710
+ revoked: true;
1711
+ };
1712
+ };
1586
1713
  };
1587
1714
  type AccessValue = string | null | {
1588
1715
  role: string;
@@ -1698,7 +1825,7 @@ type AuthorizationView = {
1698
1825
  days: number;
1699
1826
  };
1700
1827
  type BindingPlan = {
1701
- profile: "custom" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab";
1828
+ profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
1702
1829
  issuer: string;
1703
1830
  jwksUri: string;
1704
1831
  keys: null | {
@@ -1712,6 +1839,23 @@ type BindingPlan = {
1712
1839
  scope: {
1713
1840
  [key: string]: string;
1714
1841
  };
1842
+ policy: null | {
1843
+ sources?: string[];
1844
+ audience?: string;
1845
+ keyAudience?: true;
1846
+ sessionHours?: number;
1847
+ replicas?: number;
1848
+ sessionDays?: number;
1849
+ overlapMinutes?: number;
1850
+ mintedBy?: string;
1851
+ approve?: true;
1852
+ onContention?: "alert";
1853
+ unsignedUploads?: true;
1854
+ reads?: {
1855
+ [key: string]: "*" | string[];
1856
+ };
1857
+ };
1858
+ withheld: string[];
1715
1859
  replaces: {
1716
1860
  id: string;
1717
1861
  why: "asked" | "keys_moved";
@@ -1719,7 +1863,7 @@ type BindingPlan = {
1719
1863
  };
1720
1864
  type BindingView = {
1721
1865
  id: string;
1722
- profile: "custom" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab";
1866
+ profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
1723
1867
  issuer: string;
1724
1868
  jwksUri: string;
1725
1869
  keys: null | {
@@ -1733,6 +1877,22 @@ type BindingView = {
1733
1877
  scope: null | {
1734
1878
  [key: string]: string;
1735
1879
  };
1880
+ policy: null | {
1881
+ sources?: string[];
1882
+ audience?: string;
1883
+ keyAudience?: true;
1884
+ sessionHours?: number;
1885
+ replicas?: number;
1886
+ sessionDays?: number;
1887
+ overlapMinutes?: number;
1888
+ mintedBy?: string;
1889
+ approve?: true;
1890
+ onContention?: "alert";
1891
+ unsignedUploads?: true;
1892
+ reads?: {
1893
+ [key: string]: "*" | string[];
1894
+ };
1895
+ };
1736
1896
  label: string | null;
1737
1897
  createdAt: string;
1738
1898
  createdBy: string;
@@ -1758,6 +1918,7 @@ type KeysPlan = {
1758
1918
  thumbprint: string;
1759
1919
  }[];
1760
1920
  replaces: string[];
1921
+ withheld: string[];
1761
1922
  };
1762
1923
  type Deletion = {
1763
1924
  path: string;
@@ -2041,6 +2202,9 @@ type OffboardingReport = {
2041
2202
  scope: null | {
2042
2203
  [key: string]: string;
2043
2204
  };
2205
+ session?: {
2206
+ bindingId: string | null;
2207
+ };
2044
2208
  }[];
2045
2209
  references: {
2046
2210
  id: string;
@@ -2093,6 +2257,7 @@ type ProjectSummary = {
2093
2257
  accessible: boolean;
2094
2258
  parent: string | null;
2095
2259
  protected: boolean;
2260
+ unprotectable: boolean;
2096
2261
  personal: boolean;
2097
2262
  details: null | {
2098
2263
  archivedAt: string | null;
@@ -2281,6 +2446,7 @@ type TokenPlan = {
2281
2446
  scope: {
2282
2447
  [key: string]: string;
2283
2448
  };
2449
+ withheld?: string[];
2284
2450
  };
2285
2451
  type TokenRow = {
2286
2452
  id: string;
@@ -2294,6 +2460,9 @@ type TokenRow = {
2294
2460
  scope: null | {
2295
2461
  [key: string]: string;
2296
2462
  };
2463
+ session?: {
2464
+ bindingId: string | null;
2465
+ };
2297
2466
  };
2298
2467
  //#endregion
2299
2468
  //#region src/age.d.ts
@@ -2463,6 +2632,7 @@ declare function createClient(options: ClientOptions): {
2463
2632
  accessible: boolean;
2464
2633
  parent: string | null;
2465
2634
  protected: boolean;
2635
+ unprotectable: boolean;
2466
2636
  personal: boolean;
2467
2637
  details: null | {
2468
2638
  archivedAt: string | null;
@@ -2542,7 +2712,7 @@ declare function createClient(options: ClientOptions): {
2542
2712
  /**
2543
2713
  * Protected, a person holds their role's protected column there
2544
2714
  * (docs/design/roles.md); whoever manages the project's environments
2545
- * protects one, and only an Owner of the whole instance unprotects it.
2715
+ * protects one, and only an Owner of its project, or of the whole instance, unprotects it.
2546
2716
  */
2547
2717
  protect: (path: string, on?: boolean) => Promise<{
2548
2718
  environment: {
@@ -2643,7 +2813,9 @@ declare function createClient(options: ClientOptions): {
2643
2813
  versionId: string | null;
2644
2814
  generated: null | {
2645
2815
  recipe: string;
2646
- pair?: {
2816
+ pair?
2817
+ /** Who I am, and every place I can reach. */
2818
+ /** Who I am, and every place I can reach. */ : {
2647
2819
  private: string;
2648
2820
  public: string;
2649
2821
  };
@@ -2665,15 +2837,18 @@ declare function createClient(options: ClientOptions): {
2665
2837
  fallback: boolean;
2666
2838
  };
2667
2839
  protected: boolean;
2840
+ unprotectable: boolean;
2841
+ loosenable: boolean;
2668
2842
  rotateAfterDays: number | null;
2669
2843
  }>;
2670
- /** Decrypts one secret, or every secret in an environment. Logged in your name. */
2671
- reveal: (path: string) => Promise<{
2844
+ /** Decrypts one secret, or every secret in an environment, or, `keys` named, those of it only. Logged in your name. */
2845
+ reveal: (path: string, keys?: string[]) => Promise<{
2672
2846
  operationId: string;
2673
2847
  values: {
2674
2848
  [key: string]: string;
2675
2849
  };
2676
2850
  sensitive: string[];
2851
+ useOnly: string[];
2677
2852
  version: string | null;
2678
2853
  }>;
2679
2854
  /** One transaction, a version and an audit entry per key; `null` archives. */
@@ -2867,6 +3042,9 @@ declare function createClient(options: ClientOptions): {
2867
3042
  scope: null | {
2868
3043
  [key: string]: string;
2869
3044
  };
3045
+ session?: {
3046
+ bindingId: string | null;
3047
+ };
2870
3048
  }[];
2871
3049
  references: {
2872
3050
  id: string;
@@ -3014,6 +3192,9 @@ declare function createClient(options: ClientOptions): {
3014
3192
  scope: null | {
3015
3193
  [key: string]: string;
3016
3194
  };
3195
+ session?: {
3196
+ bindingId: string | null;
3197
+ };
3017
3198
  }[];
3018
3199
  references: {
3019
3200
  id: string;
@@ -3052,6 +3233,9 @@ declare function createClient(options: ClientOptions): {
3052
3233
  scope: null | {
3053
3234
  [key: string]: string;
3054
3235
  };
3236
+ session?: {
3237
+ bindingId: string | null;
3238
+ };
3055
3239
  }[];
3056
3240
  }>;
3057
3241
  /** What the token would reach, as the server would issue it now; issues nothing. */
@@ -3077,6 +3261,11 @@ declare function createClient(options: ClientOptions): {
3077
3261
  scope: {
3078
3262
  [key: string]: string;
3079
3263
  };
3264
+ withheld?: string[];
3265
+ }>;
3266
+ /** Ends a handle of the caller's own, as `coffre run` does once its command ends. */
3267
+ revoke: (id: string) => Promise<{
3268
+ revoked: true;
3080
3269
  }>;
3081
3270
  };
3082
3271
  /** Trust bindings: which CI runs may sign in as a service, by their platform's ID token. */
@@ -3084,7 +3273,7 @@ declare function createClient(options: ClientOptions): {
3084
3273
  list: (member: string) => Promise<{
3085
3274
  bindings: {
3086
3275
  id: string;
3087
- profile: "custom" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab";
3276
+ profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
3088
3277
  issuer: string;
3089
3278
  jwksUri: string;
3090
3279
  keys: null | {
@@ -3098,6 +3287,29 @@ declare function createClient(options: ClientOptions): {
3098
3287
  scope: null | {
3099
3288
  [key: string]: string;
3100
3289
  };
3290
+ policy: null | {
3291
+ sources?: string[];
3292
+ audience?: string;
3293
+ keyAudience?: true;
3294
+ sessionHours?: number;
3295
+ replicas?: number;
3296
+ sessionDays?: number;
3297
+ overlapMinutes?: number;
3298
+ mintedBy?
3299
+ /**
3300
+ * The instance's roles, in two columns, an environment's that is not
3301
+ * protected and one's that is (docs/design/roles.md). Any member lists
3302
+ * them; an Owner of the whole instance edits them. `instance` is about
3303
+ * instance roles, a person's across every project in their scope.
3304
+ */
3305
+ : string;
3306
+ approve?: true;
3307
+ onContention?: "alert";
3308
+ unsignedUploads?: true;
3309
+ reads?: {
3310
+ [key: string]: "*" | string[];
3311
+ };
3312
+ };
3101
3313
  label: string | null;
3102
3314
  createdAt: string;
3103
3315
  createdBy: string;
package/dist/index.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- import { $ as RolesView, A as Decision, B as KeysPlan, C as ApprovalView, D as BindingPlan, E as AuthorizationView, F as DryRunResult, G as MissingKey, H as Me, I as EnvironmentView, J as ProjectSummary, K as OffboardingReport, L as IdentityRow, M as DeletionResult, N as DismissedKey, O as BindingView, P as DryRunOutcome, Q as RoleView, R as ImpactLine, S as Api, T as AuthInfo, U as Member, V as ListedReference, W as MemberAccess, X as RemovedMember, Y as ReferenceView, Z as RoleImpact, _ as byFolder, a as Params, at as TokenRow, b as olderThan, c as RouteOutput, d as planImport, et as SecretKey, f as Unreachable, g as shownMember, h as serviceName, i as ImportAction, it as TokenPlan, j as Deletion, k as ConnectedApp, l as Transport, m as apiMember, n as CoffreClient, nt as SessionRow, o as RouteInput, ot as WorkloadIds, p as unreachable, q as PersonalConfig, r as CoffreError, rt as SetResult, s as RouteKey, t as ClientOptions, tt as SecretVersion, u as createClient, v as foldersOf, w as AuditEntryView, x as AccessValue, y as ageInDays, z as InheritResult } from "./index-D86fJBDd.js";
1
+ import { $ as RolesView, A as Decision, B as KeysPlan, C as ApprovalView, D as BindingPlan, E as AuthorizationView, F as DryRunResult, G as MissingKey, H as Me, I as EnvironmentView, J as ProjectSummary, K as OffboardingReport, L as IdentityRow, M as DeletionResult, N as DismissedKey, O as BindingView, P as DryRunOutcome, Q as RoleView, R as ImpactLine, S as Api, T as AuthInfo, U as Member, V as ListedReference, W as MemberAccess, X as RemovedMember, Y as ReferenceView, Z as RoleImpact, _ as byFolder, a as Params, at as TokenRow, b as olderThan, c as RouteOutput, d as planImport, et as SecretKey, f as Unreachable, g as shownMember, h as serviceName, i as ImportAction, it as TokenPlan, j as Deletion, k as ConnectedApp, l as Transport, m as apiMember, n as CoffreClient, nt as SessionRow, o as RouteInput, ot as WorkloadIds, p as unreachable, q as PersonalConfig, r as CoffreError, rt as SetResult, s as RouteKey, t as ClientOptions, tt as SecretVersion, u as createClient, v as foldersOf, w as AuditEntryView, x as AccessValue, y as ageInDays, z as InheritResult } from "./index-DxSvWq3r.js";
2
2
  export { type AccessValue, type Api, type ApprovalView, type AuditEntryView, type AuthInfo, type AuthorizationView, type BindingPlan, type BindingView, ClientOptions, CoffreClient, CoffreError, type ConnectedApp, type Decision, type Deletion, type DeletionResult, type DismissedKey, type DryRunOutcome, type DryRunResult, type EnvironmentView, type IdentityRow, type ImpactLine, ImportAction, type InheritResult, type KeysPlan, type ListedReference, type Me, type Member, type MemberAccess, type MissingKey, type OffboardingReport, Params, type PersonalConfig, type ProjectSummary, type ReferenceView, type RemovedMember, type RoleImpact, type RoleView, type RolesView, RouteInput, RouteKey, RouteOutput, type SecretKey, type SecretVersion, type SessionRow, type SetResult, type TokenPlan, type TokenRow, Transport, Unreachable, type WorkloadIds, ageInDays, apiMember, byFolder, createClient, foldersOf, olderThan, planImport, serviceName, shownMember, unreachable };