@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.
- package/README.md +16 -13
- package/api.md +572 -4
- package/dist/browser/{chunk-OOX7EUCT.js → chunk-OUAC4WID.js} +584 -8
- package/dist/browser/chunk-OUAC4WID.js.map +1 -0
- package/dist/{chunk-RJIVAOBG.cjs → browser/chunk-UYL3NMDA.cjs} +584 -8
- package/dist/browser/chunk-UYL3NMDA.cjs.map +1 -0
- package/dist/browser/index.cjs +4 -4
- package/dist/browser/index.cjs.map +1 -1
- package/dist/browser/index.js +2 -2
- package/dist/browser/index.js.map +1 -1
- package/dist/browser/management.cjs +2 -2
- package/dist/browser/management.js +1 -1
- package/dist/browser/testing.cjs +845 -0
- package/dist/browser/testing.cjs.map +1 -1
- package/dist/browser/testing.js +845 -0
- package/dist/browser/testing.js.map +1 -1
- package/dist/{browser/chunk-XZK57G7L.cjs → chunk-5SDZWOUP.cjs} +584 -8
- package/dist/chunk-5SDZWOUP.cjs.map +1 -0
- package/dist/{chunk-CGVDMKEE.js → chunk-7BOM23MI.js} +3 -3
- package/dist/{chunk-CGVDMKEE.js.map → chunk-7BOM23MI.js.map} +1 -1
- package/dist/{chunk-XNJ5OX4X.js → chunk-JGSMXA3G.js} +584 -8
- package/dist/chunk-JGSMXA3G.js.map +1 -0
- package/dist/{chunk-L3AOANTB.cjs → chunk-SHMDNO4G.cjs} +3 -3
- package/dist/{chunk-L3AOANTB.cjs.map → chunk-SHMDNO4G.cjs.map} +1 -1
- package/dist/{client-BWi7PASW.d.cts → client-DVKdRqhR.d.cts} +7751 -3218
- package/dist/{client-BWi7PASW.d.ts → client-DVKdRqhR.d.ts} +7751 -3218
- package/dist/index.cjs +9 -9
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +3 -3
- package/dist/index.js.map +1 -1
- package/dist/management.cjs +2 -2
- package/dist/management.d.cts +1 -1
- package/dist/management.d.ts +1 -1
- package/dist/management.js +1 -1
- package/dist/testing.cjs +848 -3
- package/dist/testing.cjs.map +1 -1
- package/dist/testing.d.cts +2 -2
- package/dist/testing.d.ts +2 -2
- package/dist/testing.js +846 -1
- package/dist/testing.js.map +1 -1
- package/manifest.json +316 -1
- package/package.json +1 -1
- package/dist/browser/chunk-OOX7EUCT.js.map +0 -1
- package/dist/browser/chunk-XZK57G7L.cjs.map +0 -1
- package/dist/chunk-RJIVAOBG.cjs.map +0 -1
- package/dist/chunk-XNJ5OX4X.js.map +0 -1
package/README.md
CHANGED
|
@@ -271,13 +271,16 @@ The user object has the same shape (`identifier`, `email`, `country`, `custom`);
|
|
|
271
271
|
|
|
272
272
|
Full reference: [api.md](./api.md).
|
|
273
273
|
|
|
274
|
+
- `flags.changeRequests`: `apply`, `approve`, `cancel`, `list`, `rebase`, `reject`, `retrieve`, `schedule`
|
|
274
275
|
- `flags.changes`: `retrieve`, `revert`
|
|
275
276
|
- `flags.configs`: `compare`, `delete`, `environments.copy`, `environments.evaluate`, `environments.revisions.list`, `environments.revisions.retrieve`, `environments.sdkKeys.endGracePeriod`, `environments.sdkKeys.list`, `environments.sdkKeys.reveal`, `environments.sdkKeys.rotate`, `environments.values.list`, `retrieve`, `settings.create`, `settings.list`, `update`
|
|
276
277
|
- `flags.imports`: `create`
|
|
277
278
|
- `flags.limits`: `retrieve`
|
|
278
|
-
- `flags.projects`: `changes.export`, `changes.list`, `configs.create`, `configs.list`, `create`, `delete`, `environments.create`, `environments.delete`, `environments.list`, `environments.retrieve`, `environments.update`, `list`, `retrieve`, `segments.create`, `segments.list`, `update`
|
|
279
|
+
- `flags.projects`: `changes.export`, `changes.list`, `configs.create`, `configs.list`, `create`, `delete`, `environments.create`, `environments.delete`, `environments.list`, `environments.retrieve`, `environments.update`, `list`, `retrieve`, `segments.create`, `segments.list`, `staleFlags.list`, `staleFlags.sendDigest`, `update`
|
|
280
|
+
- `flags.ramps`: `cancel`, `list`, `pause`, `resume`, `retrieve`
|
|
281
|
+
- `flags.scheduledChanges`: `cancel`, `list`, `retrieve`
|
|
279
282
|
- `flags.segments`: `delete`, `retrieve`, `revealConfidential`, `update`
|
|
280
|
-
- `flags.settings`: `delete`, `retrieve`, `update`, `values.replace`, `values.retrieve`, `values.revealConfidential`, `values.update`
|
|
283
|
+
- `flags.settings`: `delete`, `retrieve`, `update`, `values.changeRequests.create`, `values.ramps.create`, `values.replace`, `values.retrieve`, `values.revealConfidential`, `values.scheduledChanges.create`, `values.update`
|
|
281
284
|
- `flags.stats`: `retrieve`
|
|
282
285
|
- `flags.webhooks`: `endpoints.create`, `endpoints.delete`, `endpoints.list`, `endpoints.retrieve`, `endpoints.rotateSecret`, `endpoints.test`, `endpoints.update`, `eventTypes.list`, `events.list`, `events.replay`, `events.retrieve`
|
|
283
286
|
|
|
@@ -288,10 +291,10 @@ List methods return a `PagePromise`: `for await` walks every item across pages,
|
|
|
288
291
|
```ts
|
|
289
292
|
import { Flags } from "@productcraft/flags";
|
|
290
293
|
const flags = new Flags({ apiKey: process.env.PRODUCTCRAFT_API_KEY });
|
|
291
|
-
for await (const item of flags.
|
|
292
|
-
const page = await flags.
|
|
294
|
+
for await (const item of flags.changeRequests.list({ limit: 50 })) console.log(item);
|
|
295
|
+
const page = await flags.changeRequests.list();
|
|
293
296
|
if (page.hasNextPage()) await page.getNextPage();
|
|
294
|
-
const all = await flags.
|
|
297
|
+
const all = await flags.changeRequests.list().toArray({ maxItems: 500 });
|
|
295
298
|
```
|
|
296
299
|
|
|
297
300
|
## Errors
|
|
@@ -302,7 +305,7 @@ Every failure is a class you can catch. `APIError` carries `status`, `code`, `me
|
|
|
302
305
|
import { Flags, NotFoundError, RateLimitError, APIError } from "@productcraft/flags";
|
|
303
306
|
const flags = new Flags();
|
|
304
307
|
try {
|
|
305
|
-
await flags.
|
|
308
|
+
await flags.changeRequests.retrieve("00000000-0000-0000-0000-000000000000");
|
|
306
309
|
} catch (err) {
|
|
307
310
|
if (err instanceof NotFoundError) console.log(err.code, err.requestId, err.docUrl);
|
|
308
311
|
else if (err instanceof RateLimitError) console.log(err.retryAfter);
|
|
@@ -318,7 +321,7 @@ Network errors, 408, 429, 5xx and `409 IDEMPOTENCY_IN_PROGRESS` are retried twic
|
|
|
318
321
|
```ts
|
|
319
322
|
import { Flags } from "@productcraft/flags";
|
|
320
323
|
const flags = new Flags({ maxRetries: 3, timeout: 20_000 });
|
|
321
|
-
await flags.
|
|
324
|
+
await flags.changeRequests.list({}, { maxRetries: 0, signal: AbortSignal.timeout(5_000) });
|
|
322
325
|
```
|
|
323
326
|
|
|
324
327
|
## Idempotency
|
|
@@ -343,7 +346,7 @@ const flags = new Flags();
|
|
|
343
346
|
export async function POST(req: Request) {
|
|
344
347
|
const event = await flags.webhooks.unwrap({ payload: await req.text(), headers: req.headers });
|
|
345
348
|
switch (event.type) {
|
|
346
|
-
case "
|
|
349
|
+
case "change_request.applied":
|
|
347
350
|
console.log(event.data);
|
|
348
351
|
break;
|
|
349
352
|
default:
|
|
@@ -386,7 +389,7 @@ Testing a handler: `webhooks.sign()` signs an event the way ProductCraft does, s
|
|
|
386
389
|
```ts
|
|
387
390
|
import { Flags } from "@productcraft/flags";
|
|
388
391
|
const flags = new Flags({ webhookSecret: "whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw" });
|
|
389
|
-
const { payload, headers } = await flags.webhooks.sign({ payload: { id: "evt_test_1", type: "
|
|
392
|
+
const { payload, headers } = await flags.webhooks.sign({ payload: { id: "evt_test_1", type: "change_request.applied", created_at: new Date().toISOString(), data: {} } });
|
|
390
393
|
const event = await flags.webhooks.unwrap({ payload, headers });
|
|
391
394
|
console.log(event.type);
|
|
392
395
|
```
|
|
@@ -399,9 +402,9 @@ Every returned object has a non-enumerable `lastResponse` (`requestId`, `status`
|
|
|
399
402
|
import { Flags } from "@productcraft/flags";
|
|
400
403
|
const flags = new Flags({ apiKey: process.env.PRODUCTCRAFT_API_KEY });
|
|
401
404
|
const id = "9b2f6c1e-0d6a-4a63-9a43-2f1c3e4d5a6b";
|
|
402
|
-
const obj = await flags.
|
|
405
|
+
const obj = await flags.changeRequests.retrieve(id);
|
|
403
406
|
console.log(obj.lastResponse.requestId);
|
|
404
|
-
const { data, response, requestId, rateLimit } = await flags.
|
|
407
|
+
const { data, response, requestId, rateLimit } = await flags.changeRequests.retrieve(id).withResponse();
|
|
405
408
|
console.log(data, response.status, requestId, rateLimit?.remaining);
|
|
406
409
|
```
|
|
407
410
|
|
|
@@ -414,7 +417,7 @@ import { Flags } from "@productcraft/flags";
|
|
|
414
417
|
import { createMockFetch } from "@productcraft/flags/testing";
|
|
415
418
|
const fetch = createMockFetch();
|
|
416
419
|
const flags = new Flags({ apiKey: "test", workspaceId: "9b2f6c1e-0d6a-4a63-9a43-2f1c3e4d5a6b", fetch });
|
|
417
|
-
await flags.
|
|
420
|
+
await flags.changeRequests.list();
|
|
418
421
|
console.log(fetch.calls.length);
|
|
419
422
|
```
|
|
420
423
|
|
|
@@ -425,7 +428,7 @@ console.log(fetch.calls.length);
|
|
|
425
428
|
```ts
|
|
426
429
|
import { Flags } from "@productcraft/flags";
|
|
427
430
|
const flags = new Flags({ apiKey: process.env.PRODUCTCRAFT_API_KEY });
|
|
428
|
-
const { data, error } = await flags.client.GET("/v1/workspaces/{workspace_id}/
|
|
431
|
+
const { data, error } = await flags.client.GET("/v1/workspaces/{workspace_id}/change-requests", { params: { path: { workspace_id: "9b2f6c1e-0d6a-4a63-9a43-2f1c3e4d5a6b" } } });
|
|
429
432
|
console.log(data, error);
|
|
430
433
|
```
|
|
431
434
|
|