@productcraft/flags 0.4.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 (58) hide show
  1. package/README.md +51 -13
  2. package/api.md +577 -20
  3. package/dist/{chunk-7237IZU3.js → browser/chunk-OUAC4WID.js} +589 -24
  4. package/dist/browser/chunk-OUAC4WID.js.map +1 -0
  5. package/dist/browser/{chunk-CXYODDHM.cjs → chunk-UYL3NMDA.cjs} +589 -24
  6. package/dist/browser/chunk-UYL3NMDA.cjs.map +1 -0
  7. package/dist/browser/{chunk-72WU42RU.js → chunk-WUZAG2E3.js} +11 -4
  8. package/dist/browser/chunk-WUZAG2E3.js.map +1 -0
  9. package/dist/browser/{chunk-4XCQBTYE.cjs → chunk-YM5K4NHA.cjs} +11 -4
  10. package/dist/browser/chunk-YM5K4NHA.cjs.map +1 -0
  11. package/dist/browser/index.cjs +9 -9
  12. package/dist/browser/index.cjs.map +1 -1
  13. package/dist/browser/index.js +3 -3
  14. package/dist/browser/index.js.map +1 -1
  15. package/dist/browser/management.cjs +2 -2
  16. package/dist/browser/management.js +1 -1
  17. package/dist/browser/testing.cjs +848 -3
  18. package/dist/browser/testing.cjs.map +1 -1
  19. package/dist/browser/testing.js +846 -1
  20. package/dist/browser/testing.js.map +1 -1
  21. package/dist/{chunk-NSAKFGTJ.cjs → chunk-5SDZWOUP.cjs} +589 -24
  22. package/dist/chunk-5SDZWOUP.cjs.map +1 -0
  23. package/dist/{chunk-NB7OGN6R.js → chunk-7BOM23MI.js} +12 -5
  24. package/dist/chunk-7BOM23MI.js.map +1 -0
  25. package/dist/{browser/chunk-TCVKCN3S.js → chunk-JGSMXA3G.js} +589 -24
  26. package/dist/chunk-JGSMXA3G.js.map +1 -0
  27. package/dist/{chunk-Q3P66XRI.cjs → chunk-SHMDNO4G.cjs} +12 -5
  28. package/dist/chunk-SHMDNO4G.cjs.map +1 -0
  29. package/dist/{client-K2zALPGD.d.cts → client-BBiIKiGW.d.cts} +18 -14
  30. package/dist/{client-K2zALPGD.d.ts → client-BBiIKiGW.d.ts} +18 -14
  31. package/dist/{client-BwoMpm8_.d.cts → client-DVKdRqhR.d.cts} +7628 -3034
  32. package/dist/{client-BwoMpm8_.d.ts → client-DVKdRqhR.d.ts} +7628 -3034
  33. package/dist/index.cjs +9 -9
  34. package/dist/index.cjs.map +1 -1
  35. package/dist/index.d.cts +3 -3
  36. package/dist/index.d.ts +3 -3
  37. package/dist/index.js +3 -3
  38. package/dist/index.js.map +1 -1
  39. package/dist/management.cjs +2 -2
  40. package/dist/management.d.cts +1 -1
  41. package/dist/management.d.ts +1 -1
  42. package/dist/management.js +1 -1
  43. package/dist/testing.cjs +848 -3
  44. package/dist/testing.cjs.map +1 -1
  45. package/dist/testing.d.cts +5 -5
  46. package/dist/testing.d.ts +5 -5
  47. package/dist/testing.js +846 -1
  48. package/dist/testing.js.map +1 -1
  49. package/manifest.json +317 -2
  50. package/package.json +2 -2
  51. package/dist/browser/chunk-4XCQBTYE.cjs.map +0 -1
  52. package/dist/browser/chunk-72WU42RU.js.map +0 -1
  53. package/dist/browser/chunk-CXYODDHM.cjs.map +0 -1
  54. package/dist/browser/chunk-TCVKCN3S.js.map +0 -1
  55. package/dist/chunk-7237IZU3.js.map +0 -1
  56. package/dist/chunk-NB7OGN6R.js.map +0 -1
  57. package/dist/chunk-NSAKFGTJ.cjs.map +0 -1
  58. package/dist/chunk-Q3P66XRI.cjs.map +0 -1
@@ -1,5 +1,5 @@
1
- import { User } from '@productcraft/flags-engine';
2
- import { l as OverrideValue, d as FlagsClient } from './client-K2zALPGD.cjs';
1
+ import { UserInput } from '@productcraft/flags-engine';
2
+ import { l as OverrideValue, d as FlagsClient } from './client-BBiIKiGW.cjs';
3
3
  export { SignWebhookParams, SignedWebhook, signWebhook } from '@productcraft/core';
4
4
 
5
5
  /**
@@ -9,13 +9,13 @@ export { SignWebhookParams, SignedWebhook, signWebhook } from '@productcraft/cor
9
9
  *
10
10
  * @example
11
11
  * ```ts
12
- * const { payload, headers } = await signWebhook({ payload: { id: "evt_test_1", type: "config.published", created_at: new Date().toISOString(), data: {} }, secret });
12
+ * const { payload, headers } = await signWebhook({ payload: { id: "evt_test_1", type: "change_request.applied", created_at: new Date().toISOString(), data: {} }, secret });
13
13
  * const res = await fetch("http://localhost:3000/webhooks", { method: "POST", headers, body: payload });
14
14
  * ```
15
15
  */
16
16
 
17
17
  /** Every operation name, as `resource.method`. */
18
- type OperationName = "changes.retrieve" | "changes.revert" | "configs.compare" | "configs.delete" | "configs.environments.copy" | "configs.environments.evaluate" | "configs.environments.revisions.list" | "configs.environments.revisions.retrieve" | "configs.environments.sdkKeys.endGracePeriod" | "configs.environments.sdkKeys.list" | "configs.environments.sdkKeys.reveal" | "configs.environments.sdkKeys.rotate" | "configs.environments.values.list" | "configs.retrieve" | "configs.settings.create" | "configs.settings.list" | "configs.update" | "imports.create" | "limits.retrieve" | "projects.changes.export" | "projects.changes.list" | "projects.configs.create" | "projects.configs.list" | "projects.create" | "projects.delete" | "projects.environments.create" | "projects.environments.delete" | "projects.environments.list" | "projects.environments.retrieve" | "projects.environments.update" | "projects.list" | "projects.retrieve" | "projects.segments.create" | "projects.segments.list" | "projects.update" | "segments.delete" | "segments.retrieve" | "segments.revealConfidential" | "segments.update" | "settings.delete" | "settings.retrieve" | "settings.update" | "settings.values.replace" | "settings.values.retrieve" | "settings.values.revealConfidential" | "settings.values.update" | "stats.retrieve" | "webhooks.endpoints.create" | "webhooks.endpoints.delete" | "webhooks.endpoints.list" | "webhooks.endpoints.retrieve" | "webhooks.endpoints.rotateSecret" | "webhooks.endpoints.test" | "webhooks.endpoints.update" | "webhooks.eventTypes.list" | "webhooks.events.list" | "webhooks.events.replay" | "webhooks.events.retrieve";
18
+ type OperationName = "changeRequests.apply" | "changeRequests.approve" | "changeRequests.cancel" | "changeRequests.list" | "changeRequests.rebase" | "changeRequests.reject" | "changeRequests.retrieve" | "changeRequests.schedule" | "changes.retrieve" | "changes.revert" | "configs.compare" | "configs.delete" | "configs.environments.copy" | "configs.environments.evaluate" | "configs.environments.revisions.list" | "configs.environments.revisions.retrieve" | "configs.environments.sdkKeys.endGracePeriod" | "configs.environments.sdkKeys.list" | "configs.environments.sdkKeys.reveal" | "configs.environments.sdkKeys.rotate" | "configs.environments.values.list" | "configs.retrieve" | "configs.settings.create" | "configs.settings.list" | "configs.update" | "imports.create" | "limits.retrieve" | "projects.changes.export" | "projects.changes.list" | "projects.configs.create" | "projects.configs.list" | "projects.create" | "projects.delete" | "projects.environments.create" | "projects.environments.delete" | "projects.environments.list" | "projects.environments.retrieve" | "projects.environments.update" | "projects.list" | "projects.retrieve" | "projects.segments.create" | "projects.segments.list" | "projects.staleFlags.list" | "projects.staleFlags.sendDigest" | "projects.update" | "ramps.cancel" | "ramps.list" | "ramps.pause" | "ramps.resume" | "ramps.retrieve" | "scheduledChanges.cancel" | "scheduledChanges.list" | "scheduledChanges.retrieve" | "segments.delete" | "segments.retrieve" | "segments.revealConfidential" | "segments.update" | "settings.delete" | "settings.retrieve" | "settings.update" | "settings.values.changeRequests.create" | "settings.values.ramps.create" | "settings.values.replace" | "settings.values.retrieve" | "settings.values.revealConfidential" | "settings.values.scheduledChanges.create" | "settings.values.update" | "stats.retrieve" | "webhooks.endpoints.create" | "webhooks.endpoints.delete" | "webhooks.endpoints.list" | "webhooks.endpoints.retrieve" | "webhooks.endpoints.rotateSecret" | "webhooks.endpoints.test" | "webhooks.endpoints.update" | "webhooks.eventTypes.list" | "webhooks.events.list" | "webhooks.events.replay" | "webhooks.events.retrieve";
19
19
  /** One request the mock received. */
20
20
  interface MockCall {
21
21
  /** The matched operation, or `undefined` when nothing matched (the mock answers 404). */
@@ -49,7 +49,7 @@ interface TestClientOptions {
49
49
  /** Flag and setting values by key. Objects, arrays and null become json settings. */
50
50
  values?: Record<string, OverrideValue>;
51
51
  /** The default user (evaluations of fixed values ignore it; it is there for code that reads it). */
52
- user?: User;
52
+ user?: UserInput;
53
53
  }
54
54
  /** A FlagsClient whose values you set in the test. */
55
55
  declare class TestFlagsClient extends FlagsClient {
package/dist/testing.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { User } from '@productcraft/flags-engine';
2
- import { l as OverrideValue, d as FlagsClient } from './client-K2zALPGD.js';
1
+ import { UserInput } from '@productcraft/flags-engine';
2
+ import { l as OverrideValue, d as FlagsClient } from './client-BBiIKiGW.js';
3
3
  export { SignWebhookParams, SignedWebhook, signWebhook } from '@productcraft/core';
4
4
 
5
5
  /**
@@ -9,13 +9,13 @@ export { SignWebhookParams, SignedWebhook, signWebhook } from '@productcraft/cor
9
9
  *
10
10
  * @example
11
11
  * ```ts
12
- * const { payload, headers } = await signWebhook({ payload: { id: "evt_test_1", type: "config.published", created_at: new Date().toISOString(), data: {} }, secret });
12
+ * const { payload, headers } = await signWebhook({ payload: { id: "evt_test_1", type: "change_request.applied", created_at: new Date().toISOString(), data: {} }, secret });
13
13
  * const res = await fetch("http://localhost:3000/webhooks", { method: "POST", headers, body: payload });
14
14
  * ```
15
15
  */
16
16
 
17
17
  /** Every operation name, as `resource.method`. */
18
- type OperationName = "changes.retrieve" | "changes.revert" | "configs.compare" | "configs.delete" | "configs.environments.copy" | "configs.environments.evaluate" | "configs.environments.revisions.list" | "configs.environments.revisions.retrieve" | "configs.environments.sdkKeys.endGracePeriod" | "configs.environments.sdkKeys.list" | "configs.environments.sdkKeys.reveal" | "configs.environments.sdkKeys.rotate" | "configs.environments.values.list" | "configs.retrieve" | "configs.settings.create" | "configs.settings.list" | "configs.update" | "imports.create" | "limits.retrieve" | "projects.changes.export" | "projects.changes.list" | "projects.configs.create" | "projects.configs.list" | "projects.create" | "projects.delete" | "projects.environments.create" | "projects.environments.delete" | "projects.environments.list" | "projects.environments.retrieve" | "projects.environments.update" | "projects.list" | "projects.retrieve" | "projects.segments.create" | "projects.segments.list" | "projects.update" | "segments.delete" | "segments.retrieve" | "segments.revealConfidential" | "segments.update" | "settings.delete" | "settings.retrieve" | "settings.update" | "settings.values.replace" | "settings.values.retrieve" | "settings.values.revealConfidential" | "settings.values.update" | "stats.retrieve" | "webhooks.endpoints.create" | "webhooks.endpoints.delete" | "webhooks.endpoints.list" | "webhooks.endpoints.retrieve" | "webhooks.endpoints.rotateSecret" | "webhooks.endpoints.test" | "webhooks.endpoints.update" | "webhooks.eventTypes.list" | "webhooks.events.list" | "webhooks.events.replay" | "webhooks.events.retrieve";
18
+ type OperationName = "changeRequests.apply" | "changeRequests.approve" | "changeRequests.cancel" | "changeRequests.list" | "changeRequests.rebase" | "changeRequests.reject" | "changeRequests.retrieve" | "changeRequests.schedule" | "changes.retrieve" | "changes.revert" | "configs.compare" | "configs.delete" | "configs.environments.copy" | "configs.environments.evaluate" | "configs.environments.revisions.list" | "configs.environments.revisions.retrieve" | "configs.environments.sdkKeys.endGracePeriod" | "configs.environments.sdkKeys.list" | "configs.environments.sdkKeys.reveal" | "configs.environments.sdkKeys.rotate" | "configs.environments.values.list" | "configs.retrieve" | "configs.settings.create" | "configs.settings.list" | "configs.update" | "imports.create" | "limits.retrieve" | "projects.changes.export" | "projects.changes.list" | "projects.configs.create" | "projects.configs.list" | "projects.create" | "projects.delete" | "projects.environments.create" | "projects.environments.delete" | "projects.environments.list" | "projects.environments.retrieve" | "projects.environments.update" | "projects.list" | "projects.retrieve" | "projects.segments.create" | "projects.segments.list" | "projects.staleFlags.list" | "projects.staleFlags.sendDigest" | "projects.update" | "ramps.cancel" | "ramps.list" | "ramps.pause" | "ramps.resume" | "ramps.retrieve" | "scheduledChanges.cancel" | "scheduledChanges.list" | "scheduledChanges.retrieve" | "segments.delete" | "segments.retrieve" | "segments.revealConfidential" | "segments.update" | "settings.delete" | "settings.retrieve" | "settings.update" | "settings.values.changeRequests.create" | "settings.values.ramps.create" | "settings.values.replace" | "settings.values.retrieve" | "settings.values.revealConfidential" | "settings.values.scheduledChanges.create" | "settings.values.update" | "stats.retrieve" | "webhooks.endpoints.create" | "webhooks.endpoints.delete" | "webhooks.endpoints.list" | "webhooks.endpoints.retrieve" | "webhooks.endpoints.rotateSecret" | "webhooks.endpoints.test" | "webhooks.endpoints.update" | "webhooks.eventTypes.list" | "webhooks.events.list" | "webhooks.events.replay" | "webhooks.events.retrieve";
19
19
  /** One request the mock received. */
20
20
  interface MockCall {
21
21
  /** The matched operation, or `undefined` when nothing matched (the mock answers 404). */
@@ -49,7 +49,7 @@ interface TestClientOptions {
49
49
  /** Flag and setting values by key. Objects, arrays and null become json settings. */
50
50
  values?: Record<string, OverrideValue>;
51
51
  /** The default user (evaluations of fixed values ignore it; it is there for code that reads it). */
52
- user?: User;
52
+ user?: UserInput;
53
53
  }
54
54
  /** A FlagsClient whose values you set in the test. */
55
55
  declare class TestFlagsClient extends FlagsClient {