@coffre/client 0.10.2 → 0.11.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
  };
@@ -441,6 +444,7 @@ type Api = {
441
444
  [key: string]: string;
442
445
  };
443
446
  sensitive: string[];
447
+ useOnly: string[];
444
448
  version: string | null;
445
449
  };
446
450
  };
@@ -559,6 +563,9 @@ type Api = {
559
563
  scope: null | {
560
564
  [key: string]: string;
561
565
  };
566
+ session?: {
567
+ bindingId: string | null;
568
+ };
562
569
  }[];
563
570
  references: {
564
571
  id: string;
@@ -701,6 +708,9 @@ type Api = {
701
708
  scope: null | {
702
709
  [key: string]: string;
703
710
  };
711
+ session?: {
712
+ bindingId: string | null;
713
+ };
704
714
  }[];
705
715
  references: {
706
716
  id: string;
@@ -736,6 +746,9 @@ type Api = {
736
746
  scope: null | {
737
747
  [key: string]: string;
738
748
  };
749
+ session?: {
750
+ bindingId: string | null;
751
+ };
739
752
  }[];
740
753
  };
741
754
  };
@@ -749,16 +762,18 @@ type Api = {
749
762
  };
750
763
  };
751
764
  output: {
752
- id: string;
753
- token: string;
754
- expiresAt: string;
755
765
  scope: {
756
766
  [key: string]: string;
757
767
  };
768
+ withheld?: string[];
758
769
  } | {
770
+ id: string;
771
+ token: string;
772
+ expiresAt: string;
759
773
  scope: {
760
774
  [key: string]: string;
761
775
  };
776
+ withheld?: string[];
762
777
  };
763
778
  };
764
779
  "DELETE /members/:member/tokens/:id": {
@@ -772,7 +787,7 @@ type Api = {
772
787
  output: {
773
788
  bindings: {
774
789
  id: string;
775
- profile: "custom" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab";
790
+ profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
776
791
  issuer: string;
777
792
  jwksUri: string;
778
793
  keys: null | {
@@ -786,6 +801,22 @@ type Api = {
786
801
  scope: null | {
787
802
  [key: string]: string;
788
803
  };
804
+ policy: null | {
805
+ sources?: string[];
806
+ audience?: string;
807
+ keyAudience?: true;
808
+ sessionHours?: number;
809
+ replicas?: number;
810
+ sessionDays?: number;
811
+ overlapMinutes?: number;
812
+ mintedBy?: string;
813
+ approve?: true;
814
+ onContention?: "alert";
815
+ unsignedUploads?: true;
816
+ reads?: {
817
+ [key: string]: "*" | string[];
818
+ };
819
+ };
789
820
  label: string | null;
790
821
  createdAt: string;
791
822
  createdBy: string;
@@ -795,7 +826,7 @@ type Api = {
795
826
  };
796
827
  "POST /members/:member/bindings": {
797
828
  input: {
798
- profile: "custom" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab";
829
+ profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
799
830
  claims: {
800
831
  [key: string]: string | string[];
801
832
  };
@@ -810,9 +841,12 @@ type Api = {
810
841
  [key: string]: unknown;
811
842
  }[];
812
843
  };
844
+ policy?: {
845
+ [key: string]: unknown;
846
+ };
813
847
  };
814
848
  output: {
815
- profile: "custom" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab";
849
+ profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
816
850
  issuer: string;
817
851
  jwksUri: string;
818
852
  keys: null | {
@@ -826,6 +860,23 @@ type Api = {
826
860
  scope: {
827
861
  [key: string]: string;
828
862
  };
863
+ policy: null | {
864
+ sources?: string[];
865
+ audience?: string;
866
+ keyAudience?: true;
867
+ sessionHours?: number;
868
+ replicas?: number;
869
+ sessionDays?: number;
870
+ overlapMinutes?: number;
871
+ mintedBy?: string;
872
+ approve?: true;
873
+ onContention?: "alert";
874
+ unsignedUploads?: true;
875
+ reads?: {
876
+ [key: string]: "*" | string[];
877
+ };
878
+ };
879
+ withheld: string[];
829
880
  replaces: {
830
881
  id: string;
831
882
  why: "asked" | "keys_moved";
@@ -833,7 +884,7 @@ type Api = {
833
884
  } | {
834
885
  binding: {
835
886
  id: string;
836
- profile: "custom" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab";
887
+ profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
837
888
  issuer: string;
838
889
  jwksUri: string;
839
890
  keys: null | {
@@ -847,6 +898,22 @@ type Api = {
847
898
  scope: null | {
848
899
  [key: string]: string;
849
900
  };
901
+ policy: null | {
902
+ sources?: string[];
903
+ audience?: string;
904
+ keyAudience?: true;
905
+ sessionHours?: number;
906
+ replicas?: number;
907
+ sessionDays?: number;
908
+ overlapMinutes?: number;
909
+ mintedBy?: string;
910
+ approve?: true;
911
+ onContention?: "alert";
912
+ unsignedUploads?: true;
913
+ reads?: {
914
+ [key: string]: "*" | string[];
915
+ };
916
+ };
850
917
  label: string | null;
851
918
  createdAt: string;
852
919
  createdBy: string;
@@ -1334,10 +1401,11 @@ type Api = {
1334
1401
  thumbprint: string;
1335
1402
  }[];
1336
1403
  replaces: string[];
1404
+ withheld: string[];
1337
1405
  } | {
1338
1406
  bindings: {
1339
1407
  id: string;
1340
- profile: "custom" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab";
1408
+ profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
1341
1409
  issuer: string;
1342
1410
  jwksUri: string;
1343
1411
  keys: null | {
@@ -1351,6 +1419,22 @@ type Api = {
1351
1419
  scope: null | {
1352
1420
  [key: string]: string;
1353
1421
  };
1422
+ policy: null | {
1423
+ sources?: string[];
1424
+ audience?: string;
1425
+ keyAudience?: true;
1426
+ sessionHours?: number;
1427
+ replicas?: number;
1428
+ sessionDays?: number;
1429
+ overlapMinutes?: number;
1430
+ mintedBy?: string;
1431
+ approve?: true;
1432
+ onContention?: "alert";
1433
+ unsignedUploads?: true;
1434
+ reads?: {
1435
+ [key: string]: "*" | string[];
1436
+ };
1437
+ };
1354
1438
  label: string | null;
1355
1439
  createdAt: string;
1356
1440
  createdBy: string;
@@ -1385,6 +1469,7 @@ type Api = {
1385
1469
  scope: {
1386
1470
  [key: string]: string;
1387
1471
  };
1472
+ withheld?: string[];
1388
1473
  };
1389
1474
  };
1390
1475
  "GET /roles": {
@@ -1583,6 +1668,47 @@ type Api = {
1583
1668
  };
1584
1669
  };
1585
1670
  };
1671
+ "GET /members/:member/bindings/:id/enrollments": {
1672
+ input: undefined;
1673
+ output: never;
1674
+ };
1675
+ "POST /members/:member/bindings/:id/enrollments": {
1676
+ input: {
1677
+ [key: string]: never;
1678
+ };
1679
+ output: never;
1680
+ };
1681
+ "POST /members/:member/bindings/:id/enrollments/:enrollment/promote": {
1682
+ input: {
1683
+ now?: boolean;
1684
+ };
1685
+ output: never;
1686
+ };
1687
+ "POST /members/:member/tokens/:id/approve": {
1688
+ input: undefined;
1689
+ output: never;
1690
+ };
1691
+ "GET /freezes": {
1692
+ input: undefined;
1693
+ output: never;
1694
+ };
1695
+ "POST /freezes": {
1696
+ input: {
1697
+ target: string;
1698
+ reason: string;
1699
+ };
1700
+ output: never;
1701
+ };
1702
+ "DELETE /freezes/:target": {
1703
+ input: undefined;
1704
+ output: never;
1705
+ };
1706
+ "DELETE /handles/:id": {
1707
+ input: undefined;
1708
+ output: {
1709
+ revoked: true;
1710
+ };
1711
+ };
1586
1712
  };
1587
1713
  type AccessValue = string | null | {
1588
1714
  role: string;
@@ -1698,7 +1824,7 @@ type AuthorizationView = {
1698
1824
  days: number;
1699
1825
  };
1700
1826
  type BindingPlan = {
1701
- profile: "custom" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab";
1827
+ profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
1702
1828
  issuer: string;
1703
1829
  jwksUri: string;
1704
1830
  keys: null | {
@@ -1712,6 +1838,23 @@ type BindingPlan = {
1712
1838
  scope: {
1713
1839
  [key: string]: string;
1714
1840
  };
1841
+ policy: null | {
1842
+ sources?: string[];
1843
+ audience?: string;
1844
+ keyAudience?: true;
1845
+ sessionHours?: number;
1846
+ replicas?: number;
1847
+ sessionDays?: number;
1848
+ overlapMinutes?: number;
1849
+ mintedBy?: string;
1850
+ approve?: true;
1851
+ onContention?: "alert";
1852
+ unsignedUploads?: true;
1853
+ reads?: {
1854
+ [key: string]: "*" | string[];
1855
+ };
1856
+ };
1857
+ withheld: string[];
1715
1858
  replaces: {
1716
1859
  id: string;
1717
1860
  why: "asked" | "keys_moved";
@@ -1719,7 +1862,7 @@ type BindingPlan = {
1719
1862
  };
1720
1863
  type BindingView = {
1721
1864
  id: string;
1722
- profile: "custom" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab";
1865
+ profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
1723
1866
  issuer: string;
1724
1867
  jwksUri: string;
1725
1868
  keys: null | {
@@ -1733,6 +1876,22 @@ type BindingView = {
1733
1876
  scope: null | {
1734
1877
  [key: string]: string;
1735
1878
  };
1879
+ policy: null | {
1880
+ sources?: string[];
1881
+ audience?: string;
1882
+ keyAudience?: true;
1883
+ sessionHours?: number;
1884
+ replicas?: number;
1885
+ sessionDays?: number;
1886
+ overlapMinutes?: number;
1887
+ mintedBy?: string;
1888
+ approve?: true;
1889
+ onContention?: "alert";
1890
+ unsignedUploads?: true;
1891
+ reads?: {
1892
+ [key: string]: "*" | string[];
1893
+ };
1894
+ };
1736
1895
  label: string | null;
1737
1896
  createdAt: string;
1738
1897
  createdBy: string;
@@ -1758,6 +1917,7 @@ type KeysPlan = {
1758
1917
  thumbprint: string;
1759
1918
  }[];
1760
1919
  replaces: string[];
1920
+ withheld: string[];
1761
1921
  };
1762
1922
  type Deletion = {
1763
1923
  path: string;
@@ -2041,6 +2201,9 @@ type OffboardingReport = {
2041
2201
  scope: null | {
2042
2202
  [key: string]: string;
2043
2203
  };
2204
+ session?: {
2205
+ bindingId: string | null;
2206
+ };
2044
2207
  }[];
2045
2208
  references: {
2046
2209
  id: string;
@@ -2093,6 +2256,7 @@ type ProjectSummary = {
2093
2256
  accessible: boolean;
2094
2257
  parent: string | null;
2095
2258
  protected: boolean;
2259
+ unprotectable: boolean;
2096
2260
  personal: boolean;
2097
2261
  details: null | {
2098
2262
  archivedAt: string | null;
@@ -2281,6 +2445,7 @@ type TokenPlan = {
2281
2445
  scope: {
2282
2446
  [key: string]: string;
2283
2447
  };
2448
+ withheld?: string[];
2284
2449
  };
2285
2450
  type TokenRow = {
2286
2451
  id: string;
@@ -2294,6 +2459,9 @@ type TokenRow = {
2294
2459
  scope: null | {
2295
2460
  [key: string]: string;
2296
2461
  };
2462
+ session?: {
2463
+ bindingId: string | null;
2464
+ };
2297
2465
  };
2298
2466
  //#endregion
2299
2467
  //#region src/age.d.ts
@@ -2463,6 +2631,7 @@ declare function createClient(options: ClientOptions): {
2463
2631
  accessible: boolean;
2464
2632
  parent: string | null;
2465
2633
  protected: boolean;
2634
+ unprotectable: boolean;
2466
2635
  personal: boolean;
2467
2636
  details: null | {
2468
2637
  archivedAt: string | null;
@@ -2542,7 +2711,7 @@ declare function createClient(options: ClientOptions): {
2542
2711
  /**
2543
2712
  * Protected, a person holds their role's protected column there
2544
2713
  * (docs/design/roles.md); whoever manages the project's environments
2545
- * protects one, and only an Owner of the whole instance unprotects it.
2714
+ * protects one, and only an Owner of its project, or of the whole instance, unprotects it.
2546
2715
  */
2547
2716
  protect: (path: string, on?: boolean) => Promise<{
2548
2717
  environment: {
@@ -2643,7 +2812,9 @@ declare function createClient(options: ClientOptions): {
2643
2812
  versionId: string | null;
2644
2813
  generated: null | {
2645
2814
  recipe: string;
2646
- pair?: {
2815
+ pair?
2816
+ /** Who I am, and every place I can reach. */
2817
+ /** Who I am, and every place I can reach. */ : {
2647
2818
  private: string;
2648
2819
  public: string;
2649
2820
  };
@@ -2665,6 +2836,8 @@ declare function createClient(options: ClientOptions): {
2665
2836
  fallback: boolean;
2666
2837
  };
2667
2838
  protected: boolean;
2839
+ unprotectable: boolean;
2840
+ loosenable: boolean;
2668
2841
  rotateAfterDays: number | null;
2669
2842
  }>;
2670
2843
  /** Decrypts one secret, or every secret in an environment. Logged in your name. */
@@ -2674,6 +2847,7 @@ declare function createClient(options: ClientOptions): {
2674
2847
  [key: string]: string;
2675
2848
  };
2676
2849
  sensitive: string[];
2850
+ useOnly: string[];
2677
2851
  version: string | null;
2678
2852
  }>;
2679
2853
  /** One transaction, a version and an audit entry per key; `null` archives. */
@@ -2867,6 +3041,9 @@ declare function createClient(options: ClientOptions): {
2867
3041
  scope: null | {
2868
3042
  [key: string]: string;
2869
3043
  };
3044
+ session?: {
3045
+ bindingId: string | null;
3046
+ };
2870
3047
  }[];
2871
3048
  references: {
2872
3049
  id: string;
@@ -3014,6 +3191,9 @@ declare function createClient(options: ClientOptions): {
3014
3191
  scope: null | {
3015
3192
  [key: string]: string;
3016
3193
  };
3194
+ session?: {
3195
+ bindingId: string | null;
3196
+ };
3017
3197
  }[];
3018
3198
  references: {
3019
3199
  id: string;
@@ -3052,6 +3232,9 @@ declare function createClient(options: ClientOptions): {
3052
3232
  scope: null | {
3053
3233
  [key: string]: string;
3054
3234
  };
3235
+ session?: {
3236
+ bindingId: string | null;
3237
+ };
3055
3238
  }[];
3056
3239
  }>;
3057
3240
  /** What the token would reach, as the server would issue it now; issues nothing. */
@@ -3077,6 +3260,11 @@ declare function createClient(options: ClientOptions): {
3077
3260
  scope: {
3078
3261
  [key: string]: string;
3079
3262
  };
3263
+ withheld?: string[];
3264
+ }>;
3265
+ /** Ends a handle of the caller's own, as `coffre run` does once its command ends. */
3266
+ revoke: (id: string) => Promise<{
3267
+ revoked: true;
3080
3268
  }>;
3081
3269
  };
3082
3270
  /** Trust bindings: which CI runs may sign in as a service, by their platform's ID token. */
@@ -3084,7 +3272,7 @@ declare function createClient(options: ClientOptions): {
3084
3272
  list: (member: string) => Promise<{
3085
3273
  bindings: {
3086
3274
  id: string;
3087
- profile: "custom" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab";
3275
+ profile: "aws" | "azure" | "cloudflare" | "custom" | "enrollment" | "fly" | "gcp" | "github" | "github-reusable" | "github-reusable-organization" | "gitlab" | "kubernetes" | "vercel";
3088
3276
  issuer: string;
3089
3277
  jwksUri: string;
3090
3278
  keys: null | {
@@ -3098,6 +3286,27 @@ declare function createClient(options: ClientOptions): {
3098
3286
  scope: null | {
3099
3287
  [key: string]: string;
3100
3288
  };
3289
+ policy: null | {
3290
+ sources?: string[];
3291
+ audience?: string;
3292
+ keyAudience?: true;
3293
+ sessionHours?: number;
3294
+ replicas?: number;
3295
+ sessionDays? /**
3296
+ * The instance's roles, in two columns, an environment's that is not
3297
+ * protected and one's that is (docs/design/roles.md). Any member lists
3298
+ * them; an Owner of the whole instance edits them. `instance` is about
3299
+ * instance roles, a person's across every project in their scope.
3300
+ */ : number;
3301
+ overlapMinutes?: number;
3302
+ mintedBy?: string;
3303
+ approve?: true;
3304
+ onContention?: "alert";
3305
+ unsignedUploads?: true;
3306
+ reads?: {
3307
+ [key: string]: "*" | string[];
3308
+ };
3309
+ };
3101
3310
  label: string | null;
3102
3311
  createdAt: string;
3103
3312
  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--nfmYCFv.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 };