queuebear 0.1.1 → 0.1.2

package/README.md

@@ -13,7 +13,6 @@ npm install queuebear
 ```typescript
 import { QueueBear, serve } from "queuebear";
 
-// Create client (defaults to https://api.queuebear.com)
 const qb = new QueueBear({
   apiKey: "qb_live_xxx",
   projectId: "proj_xxx",
@@ -24,12 +23,12 @@ const qb = new QueueBear({
 
 The SDK provides access to all QueueBear APIs:
 
-| API | Description |
-|-----|-------------|
-| `qb.messages` | Publish and manage webhook messages |
-| `qb.schedules` | Create and manage cron-based recurring jobs |
-| `qb.dlq` | Manage failed messages in the dead letter queue |
-| `qb.workflows` | Trigger and manage durable workflows |
+| API            | Description                                     |
+| -------------- | ----------------------------------------------- |
+| `qb.messages`  | Publish and manage webhook messages             |
+| `qb.schedules` | Create and manage cron-based recurring jobs     |
+| `qb.dlq`       | Manage failed messages in the dead letter queue |
+| `qb.workflows` | Trigger and manage durable workflows            |
 
 ---
 
@@ -44,13 +43,13 @@ const { messageId } = await qb.messages.publish(
   "https://api.example.com/webhook",
   { event: "user.created", userId: "123" },
   {
-    delay: "30s",                    // Delay before delivery
-    retries: 5,                      // Number of retry attempts
-    method: "POST",                  // HTTP method
+    delay: "30s", // Delay before delivery
+    retries: 5, // Number of retry attempts
+    method: "POST", // HTTP method
     headers: { "X-API-Key": "secret" }, // Headers to forward
-    callbackUrl: "https://...",      // Success callback
+    callbackUrl: "https://...", // Success callback
     failureCallbackUrl: "https://...", // Failure callback
-    deduplicationId: "unique-id",    // Prevent duplicate messages
+    deduplicationId: "unique-id", // Prevent duplicate messages
   }
 );
 ```
@@ -59,7 +58,7 @@ const { messageId } = await qb.messages.publish(
 
 ```typescript
 const message = await qb.messages.get(messageId);
-console.log(message.status);       // "pending" | "completed" | "failed"
+console.log(message.status); // "pending" | "completed" | "failed"
 console.log(message.deliveryLogs); // Delivery attempt history
 ```
 
@@ -101,7 +100,7 @@ Create cron-based recurring jobs.
 ```typescript
 const schedule = await qb.schedules.create({
   destination: "https://api.example.com/cron-job",
-  cron: "0 9 * * *",              // Daily at 9 AM
+  cron: "0 9 * * *", // Daily at 9 AM
   timezone: "America/New_York",
   method: "POST",
   body: JSON.stringify({ type: "daily-report" }),
@@ -113,14 +112,14 @@ const schedule = await qb.schedules.create({
 
 ### Common Cron Expressions
 
-| Expression | Description |
-|------------|-------------|
-| `* * * * *` | Every minute |
-| `0 * * * *` | Every hour |
-| `0 9 * * *` | Daily at 9:00 AM |
-| `0 9 * * 1-5` | Weekdays at 9:00 AM |
-| `0 0 1 * *` | First day of each month |
-| `0 */6 * * *` | Every 6 hours |
+| Expression    | Description             |
+| ------------- | ----------------------- |
+| `* * * * *`   | Every minute            |
+| `0 * * * *`   | Every hour              |
+| `0 9 * * *`   | Daily at 9:00 AM        |
+| `0 9 * * 1-5` | Weekdays at 9:00 AM     |
+| `0 0 1 * *`   | First day of each month |
+| `0 */6 * * *` | Every 6 hours           |
 
 ### List Schedules
 
@@ -160,15 +159,15 @@ for (const entry of entries) {
 
 ```typescript
 const entry = await qb.dlq.get(dlqId);
-console.log(entry.body);           // Original message body
-console.log(entry.totalAttempts);  // Number of failed attempts
+console.log(entry.body); // Original message body
+console.log(entry.totalAttempts); // Number of failed attempts
 ```
 
 ### Retry a Failed Message
 
 ```typescript
 const result = await qb.dlq.retry(dlqId);
-console.log(result.newMessageId);  // New message created
+console.log(result.newMessageId); // New message created
 ```
 
 ### Delete Entry / Purge All
@@ -192,6 +191,7 @@ console.log(`Retried ${results.length} entries`);
 Build durable, fault-tolerant workflows with automatic step caching.
 
 Workflows consist of two parts:
+
 1. **Workflow endpoint** - Created with `serve()`, handles workflow execution
 2. **Client** - Uses `qb.workflows` to trigger and manage workflow runs
 
@@ -212,32 +212,36 @@ export const POST = serve<InputType>(async (context) => {
 
 **Parameters:**
 
-| Parameter | Type | Description |
-|-----------|------|-------------|
+| Parameter | Type                                          | Description            |
+| --------- | --------------------------------------------- | ---------------------- |
 | `handler` | `(context: WorkflowContext<T>) => Promise<R>` | Your workflow function |
-| `options` | `ServeOptions` | Optional configuration |
+| `options` | `ServeOptions`                                | Optional configuration |
 
 **Options:**
 
-| Option | Type | Description |
-|--------|------|-------------|
-| `signingSecret` | `string` | Secret to verify requests come from QueueBear |
-| `baseUrl` | `string` | Override QueueBear base URL (auto-detected if not set) |
+| Option          | Type     | Description                                            |
+| --------------- | -------- | ------------------------------------------------------ |
+| `signingSecret` | `string` | Secret to verify requests come from QueueBear          |
+| `baseUrl`       | `string` | Override QueueBear base URL (auto-detected if not set) |
 
 ### Framework Integration
 
 **Next.js (App Router)**
+
 ```typescript
 // app/api/workflows/my-workflow/route.ts
 import { serve } from "queuebear";
 
 export const POST = serve(async (context) => {
-  await context.run("step-1", async () => { /* ... */ });
+  await context.run("step-1", async () => {
+    /* ... */
+  });
   return { success: true };
 });
 ```
 
 **Express**
+
 ```typescript
 import express from "express";
 import { serve } from "queuebear";
@@ -246,21 +250,26 @@ const app = express();
 app.use(express.json());
 
 const handler = serve(async (context) => {
-  await context.run("step-1", async () => { /* ... */ });
+  await context.run("step-1", async () => {
+    /* ... */
+  });
   return { success: true };
 });
 
 app.post("/api/workflows/my-workflow", async (req, res) => {
-  const response = await handler(new Request(req.url, {
-    method: "POST",
-    headers: req.headers as HeadersInit,
-    body: JSON.stringify(req.body),
-  }));
+  const response = await handler(
+    new Request(req.url, {
+      method: "POST",
+      headers: req.headers as HeadersInit,
+      body: JSON.stringify(req.body),
+    })
+  );
   res.status(response.status).json(await response.json());
 });
 ```
 
 **Hono**
+
 ```typescript
 import { Hono } from "hono";
 import { serve } from "queuebear";
@@ -268,7 +277,9 @@ import { serve } from "queuebear";
 const app = new Hono();
 
 const handler = serve(async (context) => {
-  await context.run("step-1", async () => { /* ... */ });
+  await context.run("step-1", async () => {
+    /* ... */
+  });
   return { success: true };
 });
 
@@ -291,26 +302,29 @@ interface OnboardingInput {
   email: string;
 }
 
-export const POST = serve<OnboardingInput>(async (context) => {
-  const { userId, email } = context.input;
+export const POST = serve<OnboardingInput>(
+  async (context) => {
+    const { userId, email } = context.input;
 
-  // Step 1: Send welcome email (cached if already done)
-  await context.run("send-welcome", async () => {
-    await sendEmail(email, "welcome");
-  });
+    // Step 1: Send welcome email (cached if already done)
+    await context.run("send-welcome", async () => {
+      await sendEmail(email, "welcome");
+    });
 
-  // Step 2: Wait 3 days
-  await context.sleep("wait-3-days", 60 * 60 * 24 * 3);
+    // Step 2: Wait 3 days
+    await context.sleep("wait-3-days", 60 * 60 * 24 * 3);
 
-  // Step 3: Send tips email
-  await context.run("send-tips", async () => {
-    await sendEmail(email, "tips");
-  });
+    // Step 3: Send tips email
+    await context.run("send-tips", async () => {
+      await sendEmail(email, "tips");
+    });
 
-  return { completed: true };
-}, {
-  signingSecret: process.env.QUEUEBEAR_SIGNING_SECRET,
-});
+    return { completed: true };
+  },
+  {
+    signingSecret: process.env.QUEUEBEAR_SIGNING_SECRET,
+  }
+);
 ```
 
 ### Trigger a Workflow
@@ -332,7 +346,7 @@ const { runId } = await qb.workflows.trigger(
 ```typescript
 const status = await qb.workflows.getStatus(runId);
 console.log(status.status); // "running" | "sleeping" | "completed"
-console.log(status.steps);  // Array of step details
+console.log(status.steps); // Array of step details
 ```
 
 ### Wait for Completion
@@ -415,7 +429,7 @@ Make an HTTP call as a cached step.
 const data = await context.call("fetch-api", {
   url: "https://api.example.com/data",
   method: "POST",
-  headers: { "Authorization": "Bearer xxx" },
+  headers: { Authorization: "Bearer xxx" },
   body: { key: "value" },
 });
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "queuebear",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "QueueBear SDK for message queues, scheduled jobs, and durable workflows",
   "type": "module",
   "main": "./dist/index.js",