@coffre/client 0.4.6 → 0.5.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.
package/src/index.ts CHANGED
@@ -10,7 +10,7 @@
10
10
  * its own handling of Cloudflare Access redirects. A request that never
11
11
  * reaches the instance throws `Unreachable`, which says why.
12
12
  */
13
- import type { Api, AuthInfo, BindingPlan, BindingView, DeletionResult, DryRunOutcome, DryRunResult, SetResult } from './api.ts';
13
+ import type { Api, AuthInfo, BindingPlan, BindingView, DeletionResult, DryRunOutcome, DryRunResult, SetResult, TokenPlan } from './api.ts';
14
14
  import { Unreachable } from './reach.ts';
15
15
 
16
16
  export type {
@@ -30,10 +30,10 @@ export type {
30
30
  DryRunOutcome,
31
31
  DryRunResult,
32
32
  IdentityRow,
33
- InheritedGrant,
34
33
  ListedReference,
35
34
  Me,
36
35
  Member,
36
+ MemberAccess,
37
37
  MissingKey,
38
38
  OffboardingReport,
39
39
  ProjectSummary,
@@ -44,6 +44,7 @@ export type {
44
44
  ServiceTokenRow,
45
45
  SessionRow,
46
46
  SetResult,
47
+ TokenPlan,
47
48
  WorkloadIds,
48
49
  } from './api.ts';
49
50
 
@@ -246,6 +247,8 @@ export function createClient(options: ClientOptions) {
246
247
  list: (path?: string) => call('GET /members', {}, { path }),
247
248
  /** What they hold, and what to rotate if they leave. */
248
249
  get: (member: string) => call('GET /members/:member', { member }),
250
+ /** Their instance role and scope, and the grants you manage, in one read. */
251
+ access: (member: string) => call('GET /members/:member/access', { member }),
249
252
  add: (member: string, input: RouteInput<'PUT /members/:member'> = {}) =>
250
253
  call('PUT /members/:member', { member }, input),
251
254
  /** Offboards; returns what to rotate. */
@@ -254,9 +257,14 @@ export function createClient(options: ClientOptions) {
254
257
 
255
258
  tokens: {
256
259
  list: (member: string) => call('GET /members/:member/tokens', { member }),
260
+ /** What the token would reach, as the server would issue it now; issues nothing. */
261
+ preview: (member: string, input: RouteInput<'POST /members/:member/tokens'>) => {
262
+ const [method, route] = address('POST /members/:member/tokens', { member });
263
+ return send(method, `${route}?dryRun=1`, input) as Promise<TokenPlan>;
264
+ },
257
265
  /** The value is in the answer, and only there. */
258
266
  issue: (member: string, input: RouteInput<'POST /members/:member/tokens'>) =>
259
- call('POST /members/:member/tokens', { member }, input),
267
+ call('POST /members/:member/tokens', { member }, input) as Promise<Extract<RouteOutput<'POST /members/:member/tokens'>, { token: string }>>,
260
268
  revoke: (member: string, id: string) => call('DELETE /members/:member/tokens/:id', { member, id }),
261
269
  },
262
270
 
@@ -344,6 +352,12 @@ export function createClient(options: ClientOptions) {
344
352
  disconnect: (id: string) => call('DELETE /apps/:id', { id }),
345
353
  },
346
354
 
355
+ /** The instance's settings, for those who run it: where people set up service accounts themselves. */
356
+ settings: {
357
+ get: () => call('GET /settings', {}),
358
+ set: (input: RouteInput<'PUT /settings'>) => call('PUT /settings', {}, input),
359
+ },
360
+
347
361
  audit: {
348
362
  list: (query: RouteInput<'GET /audit'> = {}) => call('GET /audit', {}, query),
349
363
  verify: () => call('GET /audit/verification', {}),
package/src/routes.ts CHANGED
@@ -37,9 +37,11 @@ export function getCalls({ places, secrets, members, services }: Subjects): GetC
37
37
  ...(first === undefined ? [] : [{ params: {}, input: { path: first.project } }, { params: {}, input: { path: `${first.project}/${first.environment}` } }]),
38
38
  ],
39
39
  'GET /members/:member': members.map((member) => ({ params: { member } })),
40
+ 'GET /members/:member/access': members.map((member) => ({ params: { member } })),
40
41
  'GET /members/:member/tokens': services.map((member) => ({ params: { member } })),
41
42
  'GET /members/:member/bindings': services.map((member) => ({ params: { member } })),
42
43
  'GET /workloads/lookup': [{ params: {}, input: { github: 'acme/api' } }],
44
+ 'GET /settings': [{ params: {} }],
43
45
  'GET /sessions': [{ params: {} }],
44
46
  'GET /identities': [{ params: {} }],
45
47
  'GET /device-logins/:code': [{ params: { code: 'BCDF-GHJK' } }],
@@ -87,6 +89,7 @@ const EVERY_ROUTE: { [K in RouteKey]: true } = {
87
89
  'POST /reveals': true,
88
90
  'GET /members': true,
89
91
  'GET /members/:member': true,
92
+ 'GET /members/:member/access': true,
90
93
  'PUT /members/:member': true,
91
94
  'DELETE /members/:member': true,
92
95
  'GET /members/:member/tokens': true,
@@ -96,6 +99,8 @@ const EVERY_ROUTE: { [K in RouteKey]: true } = {
96
99
  'POST /members/:member/bindings': true,
97
100
  'DELETE /members/:member/bindings/:id': true,
98
101
  'GET /workloads/lookup': true,
102
+ 'GET /settings': true,
103
+ 'PUT /settings': true,
99
104
  'PATCH /access/:member': true,
100
105
  'GET /sessions': true,
101
106
  'DELETE /sessions/:id': true,