@coffre/client 0.1.11 → 0.1.13

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.
@@ -234,35 +234,6 @@ type Api = {
234
234
  expiresAt: string;
235
235
  lastUsedAt: string | null;
236
236
  }[];
237
- syncs: {
238
- id: string;
239
- provider: string;
240
- providerLabel: string;
241
- brand: "cloudflare" | "github" | "other" | "railway" | "vercel";
242
- offered: boolean;
243
- destination: string;
244
- config: {
245
- [key: string]: string | number | boolean | null | Json[] | {
246
- [key: string]: Json;
247
- };
248
- };
249
- credential: string;
250
- createdAt: string;
251
- createdBy: string;
252
- paused: boolean;
253
- running: boolean;
254
- lastRunAt: string | null;
255
- lastStatus: "failed" | "ok" | "partial" | null;
256
- lastError: string | null;
257
- synced: number;
258
- pending: number;
259
- skipped: {
260
- key: string;
261
- reason: string;
262
- }[];
263
- project: string;
264
- environment: string;
265
- }[];
266
237
  };
267
238
  };
268
239
  "PUT /members/:member": {
@@ -315,35 +286,6 @@ type Api = {
315
286
  expiresAt: string;
316
287
  lastUsedAt: string | null;
317
288
  }[];
318
- syncs: {
319
- id: string;
320
- provider: string;
321
- providerLabel: string;
322
- brand: "cloudflare" | "github" | "other" | "railway" | "vercel";
323
- offered: boolean;
324
- destination: string;
325
- config: {
326
- [key: string]: string | number | boolean | null | Json[] | {
327
- [key: string]: Json;
328
- };
329
- };
330
- credential: string;
331
- createdAt: string;
332
- createdBy: string;
333
- paused: boolean;
334
- running: boolean;
335
- lastRunAt: string | null;
336
- lastStatus: "failed" | "ok" | "partial" | null;
337
- lastError: string | null;
338
- synced: number;
339
- pending: number;
340
- skipped: {
341
- key: string;
342
- reason: string;
343
- }[];
344
- project: string;
345
- environment: string;
346
- }[];
347
289
  };
348
290
  };
349
291
  };
@@ -454,219 +396,6 @@ type Api = {
454
396
  decided: true;
455
397
  };
456
398
  };
457
- "GET /syncs/providers": {
458
- input: undefined;
459
- output: {
460
- providers: {
461
- brand: "cloudflare" | "github" | "other" | "railway" | "vercel";
462
- id: string;
463
- credential: {
464
- placeholder: string;
465
- hint: string;
466
- };
467
- label: string;
468
- fields: ({
469
- type: "text";
470
- name: string;
471
- label: string;
472
- placeholder: string;
473
- optional?: boolean;
474
- hint?: string;
475
- when?: {
476
- field: string;
477
- is: string[];
478
- };
479
- } | {
480
- type: "options";
481
- name: string;
482
- label: string;
483
- options: {
484
- value: string;
485
- label: string;
486
- }[];
487
- multiple: boolean;
488
- initial: string[];
489
- hint?: string;
490
- })[];
491
- }[];
492
- };
493
- };
494
- "GET /syncs/:project/:environment": {
495
- input: undefined;
496
- output: {
497
- syncs: {
498
- id: string;
499
- provider: string;
500
- providerLabel: string;
501
- brand: "cloudflare" | "github" | "other" | "railway" | "vercel";
502
- offered: boolean;
503
- destination: string;
504
- config: {
505
- [key: string]: string | number | boolean | null | Json[] | {
506
- [key: string]: Json;
507
- };
508
- };
509
- credential: string;
510
- createdAt: string;
511
- createdBy: string;
512
- paused: boolean;
513
- running: boolean;
514
- lastRunAt: string | null;
515
- lastStatus: "failed" | "ok" | "partial" | null;
516
- lastError: string | null;
517
- synced: number;
518
- pending: number;
519
- skipped: {
520
- key: string;
521
- reason: string;
522
- }[];
523
- }[];
524
- canManage: boolean;
525
- };
526
- };
527
- "POST /syncs/:project/:environment": {
528
- input: {
529
- provider: string;
530
- config: {
531
- [key: string]: unknown;
532
- };
533
- credential: string;
534
- };
535
- output: {
536
- id: string;
537
- provider: string;
538
- providerLabel: string;
539
- brand: "cloudflare" | "github" | "other" | "railway" | "vercel";
540
- offered: boolean;
541
- destination: string;
542
- config: {
543
- [key: string]: string | number | boolean | null | Json[] | {
544
- [key: string]: Json;
545
- };
546
- };
547
- credential: string;
548
- createdAt: string;
549
- createdBy: string;
550
- paused: boolean;
551
- running: boolean;
552
- lastRunAt: string | null;
553
- lastStatus: "failed" | "ok" | "partial" | null;
554
- lastError: string | null;
555
- synced: number;
556
- pending: number;
557
- skipped: {
558
- key: string;
559
- reason: string;
560
- }[];
561
- };
562
- };
563
- "PATCH /syncs/by-id/:id": {
564
- input: {
565
- paused: boolean;
566
- };
567
- output: {
568
- id: string;
569
- provider: string;
570
- providerLabel: string;
571
- brand: "cloudflare" | "github" | "other" | "railway" | "vercel";
572
- offered: boolean;
573
- destination: string;
574
- config: {
575
- [key: string]: string | number | boolean | null | Json[] | {
576
- [key: string]: Json;
577
- };
578
- };
579
- credential: string;
580
- createdAt: string;
581
- createdBy: string;
582
- paused: boolean;
583
- running: boolean;
584
- lastRunAt: string | null;
585
- lastStatus: "failed" | "ok" | "partial" | null;
586
- lastError: string | null;
587
- synced: number;
588
- pending: number;
589
- skipped: {
590
- key: string;
591
- reason: string;
592
- }[];
593
- };
594
- };
595
- "DELETE /syncs/by-id/:id": {
596
- input: undefined;
597
- output: {
598
- id: string;
599
- provider: string;
600
- providerLabel: string;
601
- brand: "cloudflare" | "github" | "other" | "railway" | "vercel";
602
- offered: boolean;
603
- destination: string;
604
- config: {
605
- [key: string]: string | number | boolean | null | Json[] | {
606
- [key: string]: Json;
607
- };
608
- };
609
- credential: string;
610
- createdAt: string;
611
- createdBy: string;
612
- paused: boolean;
613
- running: boolean;
614
- lastRunAt: string | null;
615
- lastStatus: "failed" | "ok" | "partial" | null;
616
- lastError: string | null;
617
- synced: number;
618
- pending: number;
619
- skipped: {
620
- key: string;
621
- reason: string;
622
- }[];
623
- };
624
- };
625
- "POST /syncs/by-id/:id/runs": {
626
- input: undefined;
627
- output: {
628
- sync: {
629
- id: string;
630
- provider: string;
631
- providerLabel: string;
632
- brand: "cloudflare" | "github" | "other" | "railway" | "vercel";
633
- offered: boolean;
634
- destination: string;
635
- config: {
636
- [key: string]: string | number | boolean | null | Json[] | {
637
- [key: string]: Json;
638
- };
639
- };
640
- credential: string;
641
- createdAt: string;
642
- createdBy: string;
643
- paused: boolean;
644
- running: boolean;
645
- lastRunAt: string | null;
646
- lastStatus: "failed" | "ok" | "partial" | null;
647
- lastError: string | null;
648
- synced: number;
649
- pending: number;
650
- skipped: {
651
- key: string;
652
- reason: string;
653
- }[];
654
- };
655
- outcome: {
656
- status: "busy";
657
- } | {
658
- status: "failed" | "ok" | "partial";
659
- upserted: string[];
660
- deleted: string[];
661
- failed: {
662
- key: string;
663
- operation: "delete" | "upsert";
664
- message: string;
665
- }[];
666
- error: string | null;
667
- };
668
- };
669
- };
670
399
  "GET /audit": {
671
400
  input: {
672
401
  path?: string;
@@ -864,35 +593,6 @@ type OffboardingReport = {
864
593
  expiresAt: string;
865
594
  lastUsedAt: string | null;
866
595
  }[];
867
- syncs: {
868
- id: string;
869
- provider: string;
870
- providerLabel: string;
871
- brand: "cloudflare" | "github" | "other" | "railway" | "vercel";
872
- offered: boolean;
873
- destination: string;
874
- config: {
875
- [key: string]: string | number | boolean | null | Json[] | {
876
- [key: string]: Json;
877
- };
878
- };
879
- credential: string;
880
- createdAt: string;
881
- createdBy: string;
882
- paused: boolean;
883
- running: boolean;
884
- lastRunAt: string | null;
885
- lastStatus: "failed" | "ok" | "partial" | null;
886
- lastError: string | null;
887
- synced: number;
888
- pending: number;
889
- skipped: {
890
- key: string;
891
- reason: string;
892
- }[];
893
- project: string;
894
- environment: string;
895
- }[];
896
596
  };
897
597
  type ProjectSummary = {
898
598
  slug: string;
@@ -915,19 +615,6 @@ type RemovedMember = {
915
615
  principalId: string;
916
616
  toRotate: number;
917
617
  };
918
- type RunOutcome = {
919
- status: "busy";
920
- } | {
921
- status: "failed" | "ok" | "partial";
922
- upserted: string[];
923
- deleted: string[];
924
- failed: {
925
- key: string;
926
- operation: "delete" | "upsert";
927
- message: string;
928
- }[];
929
- error: string | null;
930
- };
931
618
  type SecretKey = {
932
619
  key: string;
933
620
  archived: boolean;
@@ -974,110 +661,6 @@ type SetResult = {
974
661
  };
975
662
  };
976
663
  };
977
- type SyncField = {
978
- type: "text";
979
- name: string;
980
- label: string;
981
- placeholder: string;
982
- optional?: boolean;
983
- hint?: string;
984
- when?: {
985
- field: string;
986
- is: string[];
987
- };
988
- } | {
989
- type: "options";
990
- name: string;
991
- label: string;
992
- options: {
993
- value: string;
994
- label: string;
995
- }[];
996
- multiple: boolean;
997
- initial: string[];
998
- hint?: string;
999
- };
1000
- type SyncProviderInfo = {
1001
- brand: "cloudflare" | "github" | "other" | "railway" | "vercel";
1002
- id: string;
1003
- credential: {
1004
- placeholder: string;
1005
- hint: string;
1006
- };
1007
- label: string;
1008
- fields: ({
1009
- type: "text";
1010
- name: string;
1011
- label: string;
1012
- placeholder: string;
1013
- optional?: boolean;
1014
- hint?: string;
1015
- when?: {
1016
- field: string;
1017
- is: string[];
1018
- };
1019
- } | {
1020
- type: "options";
1021
- name: string;
1022
- label: string;
1023
- options: {
1024
- value: string;
1025
- label: string;
1026
- }[];
1027
- multiple: boolean;
1028
- initial: string[];
1029
- hint?: string;
1030
- })[];
1031
- };
1032
- type SyncView = {
1033
- id: string;
1034
- provider: string;
1035
- providerLabel: string;
1036
- brand: "cloudflare" | "github" | "other" | "railway" | "vercel";
1037
- offered: boolean;
1038
- destination: string;
1039
- config: {
1040
- [key: string]: string | number | boolean | null | Json[] | {
1041
- [key: string]: Json;
1042
- };
1043
- };
1044
- credential: string;
1045
- createdAt: string;
1046
- createdBy: string;
1047
- paused: boolean;
1048
- running: boolean;
1049
- lastRunAt: string | null;
1050
- lastStatus: "failed" | "ok" | "partial" | null;
1051
- lastError: string | null;
1052
- synced: number;
1053
- pending: number;
1054
- skipped: {
1055
- key: string;
1056
- reason: string;
1057
- }[];
1058
- };
1059
- type Json = string | number | boolean | null | Json[] | {
1060
- [key: string]: Json;
1061
- };
1062
- //#endregion
1063
- //#region src/sync-fields.d.ts
1064
- type FormValues = Record<string, string | string[]>;
1065
- declare function initialValues(provider: SyncProviderInfo): FormValues;
1066
- /** Whether the rest of the form makes the field meaningful. */
1067
- declare function isAsked(field: SyncField, values: FormValues): boolean;
1068
- /** The label of the first required field left empty, or null when the form can be sent. */
1069
- declare function firstMissing(provider: SyncProviderInfo, values: FormValues): string | null;
1070
- /**
1071
- * The provider's config. Text is trimmed, and an optional field left empty
1072
- * is left out rather than sent as "", which the server rightly refuses.
1073
- */
1074
- declare function configFromForm(provider: SyncProviderInfo, values: FormValues): Record<string, unknown>;
1075
- /**
1076
- * The config from `name=value` arguments, as the CLI takes them. A field with
1077
- * several options takes them comma-separated, and one left out gets what the
1078
- * form preselects. Text goes as typed, for the server to check.
1079
- */
1080
- declare function configFromArguments(provider: SyncProviderInfo, assignments: readonly string[]): Record<string, unknown>;
1081
664
  //#endregion
1082
665
  //#region src/index.d.ts
1083
666
  type RouteKey = keyof Api;
@@ -1297,35 +880,6 @@ declare function createClient(options: ClientOptions): {
1297
880
  expiresAt: string;
1298
881
  lastUsedAt: string | null;
1299
882
  }[];
1300
- syncs: {
1301
- id: string;
1302
- provider: string;
1303
- providerLabel: string;
1304
- brand: "cloudflare" | "github" | "other" | "railway" | "vercel";
1305
- offered: boolean;
1306
- destination: string;
1307
- config: {
1308
- [key: string]: string | number | boolean | null | Json[] | {
1309
- [key: string]: Json;
1310
- };
1311
- };
1312
- credential: string;
1313
- createdAt: string;
1314
- createdBy: string;
1315
- paused: boolean;
1316
- running: boolean;
1317
- lastRunAt: string | null;
1318
- lastStatus: "failed" | "ok" | "partial" | null;
1319
- lastError: string | null;
1320
- synced: number;
1321
- pending: number;
1322
- skipped: {
1323
- key: string;
1324
- reason: string;
1325
- }[];
1326
- project: string;
1327
- environment: string;
1328
- }[];
1329
883
  }>;
1330
884
  add: (member: string, input?: RouteInput<"PUT /members/:member">) => Promise<{
1331
885
  member: string;
@@ -1371,35 +925,6 @@ declare function createClient(options: ClientOptions): {
1371
925
  expiresAt: string;
1372
926
  lastUsedAt: string | null;
1373
927
  }[];
1374
- syncs: {
1375
- id: string;
1376
- provider: string;
1377
- providerLabel: string;
1378
- brand: "cloudflare" | "github" | "other" | "railway" | "vercel";
1379
- offered: boolean;
1380
- destination: string;
1381
- config: {
1382
- [key: string]: string | number | boolean | null | Json[] | {
1383
- [key: string]: Json;
1384
- };
1385
- };
1386
- credential: string;
1387
- createdAt: string;
1388
- createdBy: string;
1389
- paused: boolean;
1390
- running: boolean;
1391
- lastRunAt: string | null;
1392
- lastStatus: "failed" | "ok" | "partial" | null;
1393
- lastError: string | null;
1394
- synced: number;
1395
- pending: number;
1396
- skipped: {
1397
- key: string;
1398
- reason: string;
1399
- }[];
1400
- project: string;
1401
- environment: string;
1402
- }[];
1403
928
  };
1404
929
  }>;
1405
930
  };
@@ -1485,196 +1010,6 @@ declare function createClient(options: ClientOptions): {
1485
1010
  decided: true;
1486
1011
  }>;
1487
1012
  };
1488
- syncs: {
1489
- /** Where a sync can push on this instance, and what each asks for. */
1490
- providers: () => Promise<{
1491
- providers: {
1492
- brand: "cloudflare" | "github" | "other" | "railway" | "vercel";
1493
- id: string;
1494
- credential: {
1495
- placeholder: string;
1496
- hint: string;
1497
- };
1498
- label: string;
1499
- fields: ({
1500
- type: "text";
1501
- name: string;
1502
- label: string;
1503
- placeholder: string;
1504
- optional?: boolean;
1505
- hint?: string;
1506
- when?: {
1507
- field: string;
1508
- is: string[];
1509
- };
1510
- } | {
1511
- type: "options";
1512
- name: string;
1513
- label: string;
1514
- options: {
1515
- value: string;
1516
- label: string;
1517
- }[];
1518
- multiple: boolean;
1519
- initial: string[];
1520
- hint?: string;
1521
- })[];
1522
- }[];
1523
- }>;
1524
- list: (path: string) => Promise<{
1525
- syncs: {
1526
- id: string;
1527
- provider: string;
1528
- providerLabel: string;
1529
- brand: "cloudflare" | "github" | "other" | "railway" | "vercel";
1530
- offered: boolean;
1531
- destination: string;
1532
- config: {
1533
- [key: string]: string | number | boolean | null | Json[] | {
1534
- [key: string]: Json;
1535
- };
1536
- };
1537
- credential: string;
1538
- createdAt: string;
1539
- createdBy: string;
1540
- paused: boolean;
1541
- running: boolean;
1542
- lastRunAt: string | null;
1543
- lastStatus: "failed" | "ok" | "partial" | null;
1544
- lastError: string | null;
1545
- synced: number;
1546
- pending: number;
1547
- skipped: {
1548
- key: string;
1549
- reason: string;
1550
- }[];
1551
- }[];
1552
- canManage: boolean;
1553
- }>;
1554
- add: (path: string, input: RouteInput<"POST /syncs/:project/:environment">) => Promise<{
1555
- id: string;
1556
- provider: string;
1557
- providerLabel: string;
1558
- brand: "cloudflare" | "github" | "other" | "railway" | "vercel";
1559
- offered: boolean;
1560
- destination: string;
1561
- config: {
1562
- [key: string]: string | number | boolean | null | Json[] | {
1563
- [key: string]: Json;
1564
- };
1565
- };
1566
- credential: string;
1567
- createdAt: string;
1568
- createdBy: string;
1569
- paused: boolean;
1570
- running: boolean;
1571
- lastRunAt: string | null;
1572
- lastStatus: "failed" | "ok" | "partial" | null;
1573
- lastError: string | null;
1574
- synced: number;
1575
- pending: number;
1576
- skipped: {
1577
- key: string;
1578
- reason: string;
1579
- }[];
1580
- }>;
1581
- update: (id: string, patch: RouteInput<"PATCH /syncs/by-id/:id">) => Promise<{
1582
- id: string;
1583
- provider: string;
1584
- providerLabel: string;
1585
- brand: "cloudflare" | "github" | "other" | "railway" | "vercel";
1586
- offered: boolean;
1587
- destination: string;
1588
- config: {
1589
- [key: string]: string | number | boolean | null | Json[] | {
1590
- [key: string]: Json;
1591
- };
1592
- };
1593
- credential: string;
1594
- createdAt: string;
1595
- createdBy: string;
1596
- paused: boolean;
1597
- running: boolean;
1598
- lastRunAt: string | null;
1599
- lastStatus: "failed" | "ok" | "partial" | null;
1600
- lastError: string | null;
1601
- synced: number;
1602
- pending: number;
1603
- skipped: {
1604
- key: string;
1605
- reason: string;
1606
- }[];
1607
- }>;
1608
- remove: (id: string) => Promise<{
1609
- id: string;
1610
- provider: string;
1611
- providerLabel: string;
1612
- brand: "cloudflare" | "github" | "other" | "railway" | "vercel";
1613
- offered: boolean;
1614
- destination: string;
1615
- config: {
1616
- [key: string]: string | number | boolean | null | Json[] | {
1617
- [key: string]: Json;
1618
- };
1619
- };
1620
- credential: string;
1621
- createdAt: string;
1622
- createdBy: string;
1623
- paused: boolean;
1624
- running: boolean;
1625
- lastRunAt: string | null;
1626
- lastStatus: "failed" | "ok" | "partial" | null;
1627
- lastError: string | null;
1628
- synced: number;
1629
- pending: number;
1630
- skipped: {
1631
- key: string;
1632
- reason: string;
1633
- }[];
1634
- }>;
1635
- run: (id: string) => Promise<{
1636
- sync: {
1637
- id: string;
1638
- provider: string;
1639
- providerLabel: string;
1640
- brand: "cloudflare" | "github" | "other" | "railway" | "vercel";
1641
- offered: boolean;
1642
- destination: string;
1643
- config: {
1644
- [key: string]: string | number | boolean | null | Json[] | {
1645
- [key: string]: Json;
1646
- };
1647
- };
1648
- credential: string;
1649
- createdAt: string;
1650
- createdBy: string;
1651
- paused: boolean;
1652
- running: boolean;
1653
- lastRunAt: string | null;
1654
- lastStatus: "failed" | "ok" | "partial" | null;
1655
- lastError: string | null;
1656
- synced: number;
1657
- pending: number;
1658
- skipped: {
1659
- key: string;
1660
- reason: string;
1661
- }[];
1662
- };
1663
- outcome: {
1664
- status: "busy";
1665
- } | {
1666
- status: "failed" | "ok" | "partial";
1667
- upserted: string[];
1668
- deleted: string[];
1669
- failed: {
1670
- key: string;
1671
- operation: "delete" | "upsert";
1672
- message: string;
1673
- }[];
1674
- error: string | null;
1675
- };
1676
- }>;
1677
- };
1678
1013
  audit: {
1679
1014
  list: (query?: RouteInput<"GET /audit">) => Promise<{
1680
1015
  entries: {
@@ -1762,4 +1097,4 @@ declare function planImport(coffre: CoffreClient, path: string, entries: readonl
1762
1097
  changes: Record<string, string>;
1763
1098
  }>;
1764
1099
  //#endregion
1765
- export { RemovedMember as A, DryRunResult as C, Member as D, Me as E, SessionRow as F, SetResult as I, SyncField as L, SecretKey as M, SecretVersion as N, OffboardingReport as O, ServiceTokenRow as P, SyncProviderInfo as R, DryRunOutcome as S, Json as T, isAsked as _, Params as a, AuditEntryView as b, RouteOutput as c, planImport as d, FormValues as f, initialValues as g, firstMissing as h, ImportAction as i, RunOutcome as j, ProjectSummary as k, Transport as l, configFromForm as m, CoffreClient as n, RouteInput as o, configFromArguments as p, CoffreError as r, RouteKey as s, ClientOptions as t, createClient as u, AccessValue as v, IdentityRow as w, AuthInfo as x, Api as y, SyncView as z };
1100
+ export { RemovedMember as C, SessionRow as D, ServiceTokenRow as E, SetResult as O, ProjectSummary as S, SecretVersion as T, DryRunResult as _, Params as a, Member as b, RouteOutput as c, planImport as d, AccessValue as f, DryRunOutcome as g, AuthInfo as h, ImportAction as i, Transport as l, AuditEntryView as m, CoffreClient as n, RouteInput as o, Api as p, CoffreError as r, RouteKey as s, ClientOptions as t, createClient as u, IdentityRow as v, SecretKey as w, OffboardingReport as x, Me as y };