@productcraft/flags 0.5.0 → 0.6.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.
Files changed (48) hide show
  1. package/README.md +16 -13
  2. package/api.md +572 -4
  3. package/dist/browser/{chunk-OOX7EUCT.js → chunk-OUAC4WID.js} +584 -8
  4. package/dist/browser/chunk-OUAC4WID.js.map +1 -0
  5. package/dist/{chunk-RJIVAOBG.cjs → browser/chunk-UYL3NMDA.cjs} +584 -8
  6. package/dist/browser/chunk-UYL3NMDA.cjs.map +1 -0
  7. package/dist/browser/index.cjs +4 -4
  8. package/dist/browser/index.cjs.map +1 -1
  9. package/dist/browser/index.js +2 -2
  10. package/dist/browser/index.js.map +1 -1
  11. package/dist/browser/management.cjs +2 -2
  12. package/dist/browser/management.js +1 -1
  13. package/dist/browser/testing.cjs +845 -0
  14. package/dist/browser/testing.cjs.map +1 -1
  15. package/dist/browser/testing.js +845 -0
  16. package/dist/browser/testing.js.map +1 -1
  17. package/dist/{browser/chunk-XZK57G7L.cjs → chunk-5SDZWOUP.cjs} +584 -8
  18. package/dist/chunk-5SDZWOUP.cjs.map +1 -0
  19. package/dist/{chunk-CGVDMKEE.js → chunk-7BOM23MI.js} +3 -3
  20. package/dist/{chunk-CGVDMKEE.js.map → chunk-7BOM23MI.js.map} +1 -1
  21. package/dist/{chunk-XNJ5OX4X.js → chunk-JGSMXA3G.js} +584 -8
  22. package/dist/chunk-JGSMXA3G.js.map +1 -0
  23. package/dist/{chunk-L3AOANTB.cjs → chunk-SHMDNO4G.cjs} +3 -3
  24. package/dist/{chunk-L3AOANTB.cjs.map → chunk-SHMDNO4G.cjs.map} +1 -1
  25. package/dist/{client-BWi7PASW.d.cts → client-DVKdRqhR.d.cts} +7751 -3218
  26. package/dist/{client-BWi7PASW.d.ts → client-DVKdRqhR.d.ts} +7751 -3218
  27. package/dist/index.cjs +9 -9
  28. package/dist/index.cjs.map +1 -1
  29. package/dist/index.d.cts +1 -1
  30. package/dist/index.d.ts +1 -1
  31. package/dist/index.js +3 -3
  32. package/dist/index.js.map +1 -1
  33. package/dist/management.cjs +2 -2
  34. package/dist/management.d.cts +1 -1
  35. package/dist/management.d.ts +1 -1
  36. package/dist/management.js +1 -1
  37. package/dist/testing.cjs +848 -3
  38. package/dist/testing.cjs.map +1 -1
  39. package/dist/testing.d.cts +2 -2
  40. package/dist/testing.d.ts +2 -2
  41. package/dist/testing.js +846 -1
  42. package/dist/testing.js.map +1 -1
  43. package/manifest.json +316 -1
  44. package/package.json +1 -1
  45. package/dist/browser/chunk-OOX7EUCT.js.map +0 -1
  46. package/dist/browser/chunk-XZK57G7L.cjs.map +0 -1
  47. package/dist/chunk-RJIVAOBG.cjs.map +0 -1
  48. package/dist/chunk-XNJ5OX4X.js.map +0 -1
package/manifest.json CHANGED
@@ -1,5 +1,140 @@
1
1
  {
2
2
  "operations": {
3
+ "ChangeRequestsController_apply": {
4
+ "actor": null,
5
+ "deprecated": false,
6
+ "http": "POST /v1/workspaces/{workspace_id}/change-requests/{change_request_id}/apply",
7
+ "idempotent": false,
8
+ "method": "apply",
9
+ "paginated": false,
10
+ "params": null,
11
+ "poll": null,
12
+ "public": false,
13
+ "resource": "changeRequests",
14
+ "scope": null,
15
+ "signature": "flags.changeRequests.apply(changeRequestId, options?): Flags.ChangeRequest",
16
+ "snippet": "const changeRequest = await flags.changeRequests.apply(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
17
+ },
18
+ "ChangeRequestsController_approve": {
19
+ "actor": null,
20
+ "deprecated": false,
21
+ "http": "POST /v1/workspaces/{workspace_id}/change-requests/{change_request_id}/approve",
22
+ "idempotent": false,
23
+ "method": "approve",
24
+ "paginated": false,
25
+ "params": "Flags.ChangeRequestApproveParams",
26
+ "poll": null,
27
+ "public": false,
28
+ "resource": "changeRequests",
29
+ "scope": null,
30
+ "signature": "flags.changeRequests.approve(changeRequestId, params?, options?): Flags.ChangeRequest",
31
+ "snippet": "const changeRequest = await flags.changeRequests.approve(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { apply: true });"
32
+ },
33
+ "ChangeRequestsController_cancel": {
34
+ "actor": null,
35
+ "deprecated": false,
36
+ "http": "POST /v1/workspaces/{workspace_id}/change-requests/{change_request_id}/cancel",
37
+ "idempotent": false,
38
+ "method": "cancel",
39
+ "paginated": false,
40
+ "params": "Flags.ChangeRequestCancelParams",
41
+ "poll": null,
42
+ "public": false,
43
+ "resource": "changeRequests",
44
+ "scope": null,
45
+ "signature": "flags.changeRequests.cancel(changeRequestId, params?, options?): Flags.ChangeRequest",
46
+ "snippet": "const changeRequest = await flags.changeRequests.cancel(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { note: \"Roll out the new checkout to everyone (FLAG-142)\" });"
47
+ },
48
+ "ChangeRequestsController_create": {
49
+ "actor": null,
50
+ "deprecated": false,
51
+ "http": "POST /v1/workspaces/{workspace_id}/settings/{setting_id}/values/{environment_id}/change-requests",
52
+ "idempotent": true,
53
+ "method": "create",
54
+ "paginated": false,
55
+ "params": "Flags.SettingsValueChangeRequestCreateParams",
56
+ "poll": null,
57
+ "public": false,
58
+ "resource": "settings.values.changeRequests",
59
+ "scope": null,
60
+ "signature": "flags.settings.values.changeRequests.create(settingId, environmentId, params, options?): Flags.ChangeRequest",
61
+ "snippet": "const changeRequest = await flags.settings.values.changeRequests.create(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { operation: \"patch\", version: 7 });"
62
+ },
63
+ "ChangeRequestsController_get": {
64
+ "actor": null,
65
+ "deprecated": false,
66
+ "http": "GET /v1/workspaces/{workspace_id}/change-requests/{change_request_id}",
67
+ "idempotent": false,
68
+ "method": "retrieve",
69
+ "paginated": false,
70
+ "params": null,
71
+ "poll": null,
72
+ "public": false,
73
+ "resource": "changeRequests",
74
+ "scope": null,
75
+ "signature": "flags.changeRequests.retrieve(changeRequestId, options?): Flags.ChangeRequest",
76
+ "snippet": "const changeRequest = await flags.changeRequests.retrieve(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
77
+ },
78
+ "ChangeRequestsController_list": {
79
+ "actor": null,
80
+ "deprecated": false,
81
+ "http": "GET /v1/workspaces/{workspace_id}/change-requests",
82
+ "idempotent": false,
83
+ "method": "list",
84
+ "paginated": true,
85
+ "params": "Flags.ChangeRequestListParams",
86
+ "poll": null,
87
+ "public": false,
88
+ "resource": "changeRequests",
89
+ "scope": null,
90
+ "signature": "flags.changeRequests.list(params?, options?): PagePromise<Flags.ChangeRequest>",
91
+ "snippet": "for await (const changeRequest of flags.changeRequests.list()) {\n console.log(changeRequest);\n}\nconst page = await flags.changeRequests.list({}, { timeout: 5_000 });"
92
+ },
93
+ "ChangeRequestsController_rebase": {
94
+ "actor": null,
95
+ "deprecated": false,
96
+ "http": "POST /v1/workspaces/{workspace_id}/change-requests/{change_request_id}/rebase",
97
+ "idempotent": false,
98
+ "method": "rebase",
99
+ "paginated": false,
100
+ "params": null,
101
+ "poll": null,
102
+ "public": false,
103
+ "resource": "changeRequests",
104
+ "scope": null,
105
+ "signature": "flags.changeRequests.rebase(changeRequestId, options?): Flags.ChangeRequest",
106
+ "snippet": "const changeRequest = await flags.changeRequests.rebase(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
107
+ },
108
+ "ChangeRequestsController_reject": {
109
+ "actor": null,
110
+ "deprecated": false,
111
+ "http": "POST /v1/workspaces/{workspace_id}/change-requests/{change_request_id}/reject",
112
+ "idempotent": false,
113
+ "method": "reject",
114
+ "paginated": false,
115
+ "params": "Flags.ChangeRequestRejectParams",
116
+ "poll": null,
117
+ "public": false,
118
+ "resource": "changeRequests",
119
+ "scope": null,
120
+ "signature": "flags.changeRequests.reject(changeRequestId, params?, options?): Flags.ChangeRequest",
121
+ "snippet": "const changeRequest = await flags.changeRequests.reject(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { apply: true });"
122
+ },
123
+ "ChangeRequestsController_schedule": {
124
+ "actor": null,
125
+ "deprecated": false,
126
+ "http": "POST /v1/workspaces/{workspace_id}/change-requests/{change_request_id}/schedule",
127
+ "idempotent": false,
128
+ "method": "schedule",
129
+ "paginated": false,
130
+ "params": "Flags.ChangeRequestScheduleParams",
131
+ "poll": null,
132
+ "public": false,
133
+ "resource": "changeRequests",
134
+ "scope": null,
135
+ "signature": "flags.changeRequests.schedule(changeRequestId, params, options?): Flags.ChangeRequest",
136
+ "snippet": "const changeRequest = await flags.changeRequests.schedule(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { run_at: \"2026-11-20T09:00:00.000Z\" });"
137
+ },
3
138
  "ChangesController_export": {
4
139
  "actor": "query",
5
140
  "deprecated": false,
@@ -253,7 +388,7 @@
253
388
  "resource": "projects.environments",
254
389
  "scope": null,
255
390
  "signature": "flags.projects.environments.update(projectId, environmentId, params?, options?): Flags.Environment",
256
- "snippet": "const environment = await flags.projects.environments.update(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { color: \"#e67700\" });"
391
+ "snippet": "const environment = await flags.projects.environments.update(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { approval_policy: \"off\" });"
257
392
  },
258
393
  "EvaluateController_evaluate": {
259
394
  "actor": null,
@@ -435,6 +570,96 @@
435
570
  "signature": "flags.projects.update(projectId, params?, options?): Flags.Project",
436
571
  "snippet": "const project = await flags.projects.update(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { description: \"string\" });"
437
572
  },
573
+ "RampsController_cancel": {
574
+ "actor": null,
575
+ "deprecated": false,
576
+ "http": "POST /v1/workspaces/{workspace_id}/ramps/{ramp_id}/cancel",
577
+ "idempotent": false,
578
+ "method": "cancel",
579
+ "paginated": false,
580
+ "params": "Flags.RampCancelParams",
581
+ "poll": null,
582
+ "public": false,
583
+ "resource": "ramps",
584
+ "scope": null,
585
+ "signature": "flags.ramps.cancel(rampId, params?, options?): Flags.Ramp",
586
+ "snippet": "const ramp = await flags.ramps.cancel(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { note: \"Roll out the new checkout to everyone (FLAG-142)\" });"
587
+ },
588
+ "RampsController_create": {
589
+ "actor": null,
590
+ "deprecated": false,
591
+ "http": "POST /v1/workspaces/{workspace_id}/settings/{setting_id}/values/{environment_id}/ramps",
592
+ "idempotent": true,
593
+ "method": "create",
594
+ "paginated": false,
595
+ "params": "Flags.SettingsValueRampCreateParams",
596
+ "poll": null,
597
+ "public": false,
598
+ "resource": "settings.values.ramps",
599
+ "scope": null,
600
+ "signature": "flags.settings.values.ramps.create(settingId, environmentId, params, options?): Flags.Ramp",
601
+ "snippet": "const ramp = await flags.settings.values.ramps.create(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { steps: [{ at: \"2026-11-20T09:00:00.000Z\", percentage: 25 }], value: true });"
602
+ },
603
+ "RampsController_get": {
604
+ "actor": null,
605
+ "deprecated": false,
606
+ "http": "GET /v1/workspaces/{workspace_id}/ramps/{ramp_id}",
607
+ "idempotent": false,
608
+ "method": "retrieve",
609
+ "paginated": false,
610
+ "params": null,
611
+ "poll": null,
612
+ "public": false,
613
+ "resource": "ramps",
614
+ "scope": null,
615
+ "signature": "flags.ramps.retrieve(rampId, options?): Flags.Ramp",
616
+ "snippet": "const ramp = await flags.ramps.retrieve(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
617
+ },
618
+ "RampsController_list": {
619
+ "actor": null,
620
+ "deprecated": false,
621
+ "http": "GET /v1/workspaces/{workspace_id}/ramps",
622
+ "idempotent": false,
623
+ "method": "list",
624
+ "paginated": true,
625
+ "params": "Flags.RampListParams",
626
+ "poll": null,
627
+ "public": false,
628
+ "resource": "ramps",
629
+ "scope": null,
630
+ "signature": "flags.ramps.list(params?, options?): PagePromise<Flags.Ramp>",
631
+ "snippet": "for await (const ramp of flags.ramps.list()) {\n console.log(ramp);\n}\nconst page = await flags.ramps.list({}, { timeout: 5_000 });"
632
+ },
633
+ "RampsController_pause": {
634
+ "actor": null,
635
+ "deprecated": false,
636
+ "http": "POST /v1/workspaces/{workspace_id}/ramps/{ramp_id}/pause",
637
+ "idempotent": false,
638
+ "method": "pause",
639
+ "paginated": false,
640
+ "params": "Flags.RampPauseParams",
641
+ "poll": null,
642
+ "public": false,
643
+ "resource": "ramps",
644
+ "scope": null,
645
+ "signature": "flags.ramps.pause(rampId, params?, options?): Flags.Ramp",
646
+ "snippet": "const ramp = await flags.ramps.pause(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { note: \"Roll out the new checkout to everyone (FLAG-142)\" });"
647
+ },
648
+ "RampsController_resume": {
649
+ "actor": null,
650
+ "deprecated": false,
651
+ "http": "POST /v1/workspaces/{workspace_id}/ramps/{ramp_id}/resume",
652
+ "idempotent": false,
653
+ "method": "resume",
654
+ "paginated": false,
655
+ "params": "Flags.RampResumeParams",
656
+ "poll": null,
657
+ "public": false,
658
+ "resource": "ramps",
659
+ "scope": null,
660
+ "signature": "flags.ramps.resume(rampId, params?, options?): Flags.Ramp",
661
+ "snippet": "const ramp = await flags.ramps.resume(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { note: \"Roll out the new checkout to everyone (FLAG-142)\" });"
662
+ },
438
663
  "RevisionsController_get": {
439
664
  "actor": null,
440
665
  "deprecated": false,
@@ -465,6 +690,66 @@
465
690
  "signature": "flags.configs.environments.revisions.list(configId, environmentId, params?, options?): PagePromise<Flags.ConfigRevision>",
466
691
  "snippet": "for await (const revision of flags.configs.environments.revisions.list(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\")) {\n console.log(revision);\n}\nconst page = await flags.configs.environments.revisions.list(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", {}, { timeout: 5_000 });"
467
692
  },
693
+ "ScheduledChangesController_cancel": {
694
+ "actor": null,
695
+ "deprecated": false,
696
+ "http": "POST /v1/workspaces/{workspace_id}/scheduled-changes/{scheduled_change_id}/cancel",
697
+ "idempotent": false,
698
+ "method": "cancel",
699
+ "paginated": false,
700
+ "params": "Flags.ScheduledChangeCancelParams",
701
+ "poll": null,
702
+ "public": false,
703
+ "resource": "scheduledChanges",
704
+ "scope": null,
705
+ "signature": "flags.scheduledChanges.cancel(scheduledChangeId, params?, options?): Flags.ScheduledChange",
706
+ "snippet": "const scheduledChange = await flags.scheduledChanges.cancel(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { note: \"Roll out the new checkout to everyone (FLAG-142)\" });"
707
+ },
708
+ "ScheduledChangesController_create": {
709
+ "actor": null,
710
+ "deprecated": false,
711
+ "http": "POST /v1/workspaces/{workspace_id}/settings/{setting_id}/values/{environment_id}/scheduled-changes",
712
+ "idempotent": true,
713
+ "method": "create",
714
+ "paginated": false,
715
+ "params": "Flags.SettingsValueScheduledChangeCreateParams",
716
+ "poll": null,
717
+ "public": false,
718
+ "resource": "settings.values.scheduledChanges",
719
+ "scope": null,
720
+ "signature": "flags.settings.values.scheduledChanges.create(settingId, environmentId, params, options?): Flags.ScheduledChange",
721
+ "snippet": "const scheduledChange = await flags.settings.values.scheduledChanges.create(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", \"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { operation: \"patch\", run_at: \"2026-11-20T09:00:00.000Z\" });"
722
+ },
723
+ "ScheduledChangesController_get": {
724
+ "actor": null,
725
+ "deprecated": false,
726
+ "http": "GET /v1/workspaces/{workspace_id}/scheduled-changes/{scheduled_change_id}",
727
+ "idempotent": false,
728
+ "method": "retrieve",
729
+ "paginated": false,
730
+ "params": null,
731
+ "poll": null,
732
+ "public": false,
733
+ "resource": "scheduledChanges",
734
+ "scope": null,
735
+ "signature": "flags.scheduledChanges.retrieve(scheduledChangeId, options?): Flags.ScheduledChange",
736
+ "snippet": "const scheduledChange = await flags.scheduledChanges.retrieve(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
737
+ },
738
+ "ScheduledChangesController_list": {
739
+ "actor": null,
740
+ "deprecated": false,
741
+ "http": "GET /v1/workspaces/{workspace_id}/scheduled-changes",
742
+ "idempotent": false,
743
+ "method": "list",
744
+ "paginated": true,
745
+ "params": "Flags.ScheduledChangeListParams",
746
+ "poll": null,
747
+ "public": false,
748
+ "resource": "scheduledChanges",
749
+ "scope": null,
750
+ "signature": "flags.scheduledChanges.list(params?, options?): PagePromise<Flags.ScheduledChange>",
751
+ "snippet": "for await (const scheduledChange of flags.scheduledChanges.list()) {\n console.log(scheduledChange);\n}\nconst page = await flags.scheduledChanges.list({}, { timeout: 5_000 });"
752
+ },
468
753
  "SdkKeysController_endGracePeriod": {
469
754
  "actor": null,
470
755
  "deprecated": false,
@@ -690,6 +975,36 @@
690
975
  "signature": "flags.settings.update(settingId, params?, options?): Flags.SettingDetail",
691
976
  "snippet": "const settingDetail = await flags.settings.update(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", { description: \"string\" });"
692
977
  },
978
+ "StaleFlagsController_list": {
979
+ "actor": null,
980
+ "deprecated": false,
981
+ "http": "GET /v1/workspaces/{workspace_id}/projects/{project_id}/stale-flags",
982
+ "idempotent": false,
983
+ "method": "list",
984
+ "paginated": true,
985
+ "params": "Flags.ProjectStaleFlagListParams",
986
+ "poll": null,
987
+ "public": false,
988
+ "resource": "projects.staleFlags",
989
+ "scope": null,
990
+ "signature": "flags.projects.staleFlags.list(projectId, params?, options?): PagePromise<Flags.StaleFlag>",
991
+ "snippet": "for await (const staleFlag of flags.projects.staleFlags.list(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\")) {\n console.log(staleFlag);\n}\nconst page = await flags.projects.staleFlags.list(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\", {}, { timeout: 5_000 });"
992
+ },
993
+ "StaleFlagsController_sendDigest": {
994
+ "actor": null,
995
+ "deprecated": false,
996
+ "http": "POST /v1/workspaces/{workspace_id}/projects/{project_id}/stale-flags/digest",
997
+ "idempotent": false,
998
+ "method": "sendDigest",
999
+ "paginated": false,
1000
+ "params": null,
1001
+ "poll": null,
1002
+ "public": false,
1003
+ "resource": "projects.staleFlags",
1004
+ "scope": null,
1005
+ "signature": "flags.projects.staleFlags.sendDigest(projectId, options?): Flags.StaleDigest",
1006
+ "snippet": "const staleDigest = await flags.projects.staleFlags.sendDigest(\"3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f\");"
1007
+ },
693
1008
  "StatsController_get": {
694
1009
  "actor": null,
695
1010
  "deprecated": false,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@productcraft/flags",
3
- "version": "0.5.0",
3
+ "version": "0.6.0",
4
4
  "description": "Feature flags and remote settings for Node.js, browsers and React Native (ProductCraft Flags): FlagsClient downloads one config per environment and evaluates flags locally, so user attributes never leave your app; plus the generated management client for projects, flags, targeting, segments and SDK keys. A key used in a browser or mobile app makes its whole config public.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",