@nicnocquee/dataqueue 1.33.0 → 1.34.0

package/ai/rules/advanced.md

@@ -0,0 +1,94 @@
+# DataQueue — Advanced Rules
+
+## Step Memoization (ctx.run)
+
+Wrap side-effectful work in `ctx.run(stepName, fn)` for durability. Cached results replay on re-invocation after a wait.
+
+```typescript
+const data = await ctx.run('fetch', async () => fetchFromAPI(url));
+await ctx.waitFor({ hours: 1 });
+await ctx.run('notify', async () => sendNotification(data));
+```
+
+Step names must be unique within a handler and stable across deployments.
+
+## Waits
+
+- `ctx.waitFor({ hours: 24 })` — pause for a duration (seconds, minutes, hours, days, weeks, months, years).
+- `ctx.waitUntil(date)` — pause until a specific date.
+- `ctx.waitForToken(tokenId)` — pause until an external actor completes the token.
+
+Waiting jobs release their worker lock and concurrency slot. They consume no resources.
+
+Wait calls use a positional counter internally. Do not add/remove waits conditionally between re-invocations.
+
+## Token System
+
+```typescript
+const token = await ctx.createToken({ timeout: '48h', tags: ['approval'] });
+const result = await ctx.waitForToken<{ approved: boolean }>(token.id);
+if (result.ok) {
+  /* result.output.approved */
+}
+```
+
+Complete externally: `await queue.completeToken(tokenId, { approved: true })`.
+Expire timed-out tokens: `await queue.expireTimedOutTokens()`.
+
+## Cron Scheduling
+
+```typescript
+await queue.addCronJob({
+  scheduleName: 'daily-cleanup',
+  cronExpression: '0 2 * * *',
+  jobType: 'cleanup',
+  payload: { days: 30 },
+  timezone: 'UTC',
+  allowOverlap: false,
+});
+```
+
+The processor auto-enqueues due cron jobs before each batch. Manage with `pauseCronJob`, `resumeCronJob`, `editCronJob`, `removeCronJob`, `listCronJobs`.
+
+## Timeout Management
+
+- `ctx.prolong(ms)` — proactively reset deadline. `ctx.prolong()` resets to original `timeoutMs`.
+- `ctx.onTimeout(() => ms)` — reactive; return ms to extend, or nothing to let timeout proceed.
+- `forceKillOnTimeout: true` — terminates handler via Worker Thread. Requires Node.js, serializable handler, and disables `ctx.run`/waits/`prolong`/`onTimeout`.
+
+## Tags and Filtering
+
+```typescript
+await queue.addJob({ jobType: 'email', payload, tags: ['welcome', 'user'] });
+const jobs = await queue.getJobsByTags(['welcome'], 'any');
+await queue.cancelAllUpcomingJobs({ tags: { values: ['user'], mode: 'all' } });
+```
+
+Modes: `exact` (exact set), `all` (superset), `any` (intersection), `none` (exclusion).
+
+## Idempotency
+
+```typescript
+await queue.addJob({
+  jobType: 'email',
+  payload,
+  idempotencyKey: `welcome-${userId}`,
+});
+```
+
+Returns existing job ID if key already exists. Key persists until `cleanupOldJobs` removes the job.
+
+## Scaling
+
+- Increase `batchSize` and `concurrency` for higher throughput.
+- Run multiple processor instances with unique `workerId` values — `FOR UPDATE SKIP LOCKED` (PostgreSQL) or Lua scripts (Redis) prevent double-claiming.
+- Use `jobType` filter for specialized workers.
+- Call `cleanupOldJobs` and `reclaimStuckJobs` on intervals.
+
+## Progress Tracking
+
+```typescript
+await ctx.setProgress(50); // 0–100, persisted to DB
+```
+
+Read via `queue.getJob(id)` (`progress` field) or React SDK's `useJob` hook.

package/ai/rules/basic.md

@@ -0,0 +1,90 @@
+# DataQueue — Basic Rules
+
+## Imports
+
+Always import from `@nicnocquee/dataqueue`. There is no subpath like `/v2` or `/v3`.
+
+```typescript
+import { initJobQueue, JobHandlers } from '@nicnocquee/dataqueue';
+```
+
+## PayloadMap Pattern
+
+Define an object type where keys are job type strings and values are payload shapes. This powers type-safe `addJob`, `createProcessor`, and handler completeness checking.
+
+```typescript
+type JobPayloadMap = {
+  send_email: { to: string; subject: string; body: string };
+  generate_report: { reportId: string; userId: string };
+};
+```
+
+## Initialization (Singleton)
+
+Never call `initJobQueue` per request — each call creates a new database connection pool. Use a module-level singleton:
+
+```typescript
+import { initJobQueue } from '@nicnocquee/dataqueue';
+
+let jobQueue: ReturnType<typeof initJobQueue<JobPayloadMap>> | null = null;
+
+export const getJobQueue = () => {
+  if (!jobQueue) {
+    jobQueue = initJobQueue<JobPayloadMap>({
+      databaseConfig: { connectionString: process.env.PG_DATAQUEUE_DATABASE },
+    });
+  }
+  return jobQueue;
+};
+```
+
+For Redis, set `backend: 'redis'` and use `redisConfig` with `url` or `host`/`port`/`password`. Install `ioredis` as a peer dependency.
+
+## Handlers
+
+Type handlers as `JobHandlers<PayloadMap>` so TypeScript enforces a handler for every job type.
+
+```typescript
+export const jobHandlers: JobHandlers<JobPayloadMap> = {
+  send_email: async (payload, signal, ctx) => {
+    await sendEmail(payload.to, payload.subject, payload.body);
+  },
+  generate_report: async (payload) => {
+    await generateReport(payload.reportId, payload.userId);
+  },
+};
+```
+
+Handler signature: `(payload: T, signal: AbortSignal, ctx: JobContext) => Promise<void>`. You can omit arguments you don't need.
+
+## Processing
+
+**Serverless** — call `processor.start()` which processes one batch and stops:
+
+```typescript
+const processor = queue.createProcessor(handlers, {
+  batchSize: 10,
+  concurrency: 3,
+});
+await processor.start();
+```
+
+**Long-running** — call `processor.startInBackground()` which polls continuously:
+
+```typescript
+processor.startInBackground();
+process.on('SIGTERM', async () => {
+  await processor.stopAndDrain(30000);
+  queue.getPool().end(); // or queue.getRedisClient().quit() for Redis
+  process.exit(0);
+});
+```
+
+## Common Mistakes
+
+1. Creating `initJobQueue` per request — use a singleton.
+2. Missing handler for a job type — fails with `NoHandler`. Type as `JobHandlers<PayloadMap>`.
+3. Not checking `signal.aborted` in long handlers — timed-out jobs keep running.
+4. Forgetting `reclaimStuckJobs()` — crashed workers leave jobs stuck.
+5. Skipping migrations (PostgreSQL) — run `dataqueue-cli migrate` first. Redis needs none.
+6. Using `stop()` instead of `stopAndDrain()` — leaves in-flight jobs stuck.

package/ai/rules/react-dashboard.md

@@ -0,0 +1,83 @@
+# DataQueue — React & Dashboard Rules
+
+## React SDK (@nicnocquee/dataqueue-react)
+
+Install: `npm install @nicnocquee/dataqueue-react` (requires React 18+).
+
+### useJob Hook
+
+```tsx
+'use client';
+import { useJob } from '@nicnocquee/dataqueue-react';
+
+const { status, progress, data, isLoading, error } = useJob(jobId, {
+  fetcher: (id) =>
+    fetch(`/api/jobs/${id}`)
+      .then((r) => r.json())
+      .then((d) => d.job),
+  pollingInterval: 1000,
+  onComplete: (job) => {
+    /* job completed */
+  },
+  onFailed: (job) => {
+    /* job failed */
+  },
+});
+```
+
+Polling auto-stops on terminal statuses (`completed`, `failed`, `cancelled`).
+
+### DataqueueProvider
+
+Wrap app in `DataqueueProvider` to share `fetcher` and `pollingInterval`:
+
+```tsx
+<DataqueueProvider fetcher={fetcher} pollingInterval={2000}>
+  {children}
+</DataqueueProvider>
+```
+
+### API Route (Next.js)
+
+```typescript
+// app/api/jobs/[id]/route.ts
+export async function GET(
+  _req: Request,
+  { params }: { params: Promise<{ id: string }> },
+) {
+  const { id } = await params;
+  const job = await getJobQueue().getJob(Number(id));
+  if (!job) return NextResponse.json({ error: 'Not found' }, { status: 404 });
+  return NextResponse.json({ job });
+}
+```
+
+## Dashboard (@nicnocquee/dataqueue-dashboard)
+
+Install: `npm install @nicnocquee/dataqueue-dashboard`.
+
+### Setup (Next.js App Router)
+
+```typescript
+// app/admin/dataqueue/[[...path]]/route.ts
+import { createDataqueueDashboard } from '@nicnocquee/dataqueue-dashboard/next';
+import { getJobQueue, jobHandlers } from '@/lib/queue';
+
+const { GET, POST } = createDataqueueDashboard({
+  jobQueue: getJobQueue(),
+  jobHandlers,
+  basePath: '/admin/dataqueue',
+});
+
+export { GET, POST };
+```
+
+`basePath` must match the route directory path.
+
+### Protection
+
+Wrap handlers with your auth middleware before exporting GET/POST.
+
+## Progress Tracking
+
+Use `ctx.setProgress(percent)` in handlers (0–100). The value appears in `useJob`'s `progress` field and the dashboard detail view.

package/ai/skills/dataqueue-advanced/SKILL.md

@@ -0,0 +1,211 @@
+---
+name: dataqueue-advanced
+description: Advanced DataQueue patterns — step memoization, waits, tokens, cron, timeouts, tags, idempotency.
+---
+
+# DataQueue Advanced Patterns
+
+## Step Memoization with ctx.run()
+
+Wrap side-effectful work in `ctx.run(stepName, fn)`. Results are cached in the database — when the handler re-runs after a wait, completed steps replay from cache without re-executing.
+
+```typescript
+const handler = async (payload, signal, ctx) => {
+  const data = await ctx.run('fetch-data', async () => {
+    return await fetchFromAPI(payload.url);
+  });
+
+  await ctx.run('send-notification', async () => {
+    await notify(data.userId, data.message);
+  });
+};
+```
+
+**Rules:**
+
+- Step names must be unique within a handler.
+- Step names must be stable across deployments while jobs are waiting.
+- Step order must not change conditionally between re-invocations.
+
+## Time-Based Waits
+
+### waitFor (duration)
+
+```typescript
+const handler = async (payload, signal, ctx) => {
+  await ctx.run('step-1', async () => {
+    /* ... */
+  });
+  await ctx.waitFor({ hours: 24 });
+  await ctx.run('step-2', async () => {
+    /* ... */
+  });
+};
+```
+
+Duration fields: `seconds`, `minutes`, `hours`, `days`, `weeks`, `months`, `years` (additive).
+
+### waitUntil (date)
+
+```typescript
+await ctx.waitUntil(new Date('2025-03-01T09:00:00Z'));
+```
+
+### How waits work internally
+
+1. Handler throws a `WaitSignal` internally.
+2. Job moves to `'waiting'` status — worker lock is released.
+3. After the wait expires, job becomes `'pending'` again.
+4. Handler re-runs from top; `ctx.run()` replays cached steps.
+
+Waiting jobs are idle — they hold no lock, no concurrency slot, no resources.
+
+## Token-Based Waits (Human-in-the-Loop)
+
+Create a token, send it to an external actor, and wait for them to complete it.
+
+```typescript
+const handler = async (payload, signal, ctx) => {
+  const token = await ctx.run('create-token', async () => {
+    return await ctx.createToken({ timeout: '48h', tags: ['approval'] });
+  });
+
+  await ctx.run('notify', async () => {
+    await sendSlack(`Approve: ${token.id}`);
+  });
+
+  const result = await ctx.waitForToken<{ approved: boolean }>(token.id);
+  if (result.ok) {
+    await ctx.run('process', async () => {
+      if (result.output.approved) await approve(payload.id);
+    });
+  }
+};
+```
+
+Complete tokens externally:
+
+```typescript
+await queue.completeToken(tokenId, { approved: true });
+```
+
+Expire timed-out tokens periodically:
+
+```typescript
+await queue.expireTimedOutTokens();
+```
+
+## Cron Scheduling
+
+```typescript
+const cronId = await queue.addCronJob({
+  scheduleName: 'daily-report',
+  cronExpression: '0 9 * * *',
+  jobType: 'generate_report',
+  payload: { reportId: 'daily', userId: 'system' },
+  timezone: 'America/New_York',
+  allowOverlap: false,
+});
+```
+
+The processor automatically enqueues due cron jobs before each batch — no manual triggering needed.
+
+Manage schedules:
+
+```typescript
+await queue.pauseCronJob(cronId);
+await queue.resumeCronJob(cronId);
+await queue.editCronJob(cronId, { cronExpression: '0 */2 * * *' });
+await queue.removeCronJob(cronId);
+const schedules = await queue.listCronJobs('active');
+```
+
+## Timeout Management
+
+### Proactive — ctx.prolong()
+
+```typescript
+const handler = async (payload, signal, ctx) => {
+  ctx.prolong(60_000); // set deadline to 60s from now
+  await doHeavyWork();
+  ctx.prolong(); // reset to original timeoutMs
+};
+```
+
+### Reactive — ctx.onTimeout()
+
+```typescript
+const handler = async (payload, signal, ctx) => {
+  let step = 0;
+  ctx.onTimeout(() => {
+    if (step < 3) return 30_000; // extend 30s
+  });
+  step = 1;
+  await doStep1();
+  step = 2;
+  await doStep2();
+  step = 3;
+  await doStep3();
+};
+```
+
+Both update `locked_at` in the DB, preventing premature reclamation.
+
+### Force Kill on Timeout
+
+```typescript
+await queue.addJob({
+  jobType: 'task',
+  payload: {
+    /* ... */
+  },
+  timeoutMs: 5000,
+  forceKillOnTimeout: true,
+});
+```
+
+**Limitations of forceKillOnTimeout:**
+
+- Requires Node.js (not Bun).
+- Handler must be serializable (no closures over external variables).
+- `prolong`, `onTimeout`, `ctx.run`, waits are NOT available.
+
+## Tags
+
+```typescript
+await queue.addJob({
+  jobType: 'email',
+  payload: {
+    /* ... */
+  },
+  tags: ['welcome', 'onboarding'],
+});
+
+const jobs = await queue.getJobsByTags(['welcome'], 'any');
+await queue.cancelAllUpcomingJobs({
+  tags: { values: ['onboarding'], mode: 'all' },
+});
+```
+
+Tag query modes: `'exact'`, `'all'`, `'any'`, `'none'`.
+
+## Idempotency
+
+```typescript
+const jobId = await queue.addJob({
+  jobType: 'email',
+  payload: { to: 'user@example.com', subject: 'Welcome', body: '...' },
+  idempotencyKey: `welcome-${userId}`,
+});
+```
+
+If a job with the same key exists, returns the existing job ID. Key is unique across all statuses until `cleanupOldJobs` removes it.
+
+## Maintenance
+
+```typescript
+await queue.reclaimStuckJobs(10); // reclaim jobs stuck > 10 min
+await queue.cleanupOldJobs(30); // delete completed jobs > 30 days
+await queue.cleanupOldJobEvents(30); // delete old events > 30 days
+await queue.expireTimedOutTokens(); // expire overdue tokens
+```

package/ai/skills/dataqueue-core/SKILL.md

@@ -0,0 +1,131 @@
+---
+name: dataqueue-core
+description: Core patterns for using @nicnocquee/dataqueue — typed PayloadMap, init, handlers, adding and processing jobs.
+---
+
+# DataQueue Core Patterns
+
+## Imports
+
+Always import from `@nicnocquee/dataqueue`. There is no v2/v3 subpath.
+
+```typescript
+import { initJobQueue, JobHandlers } from '@nicnocquee/dataqueue';
+```
+
+## Step 1: Define a PayloadMap
+
+Define an object type mapping job type strings to their payload shapes. This is the foundation of type safety — every API method is generic over this map.
+
+```typescript
+export type JobPayloadMap = {
+  send_email: { to: string; subject: string; body: string };
+  generate_report: { reportId: string; userId: string };
+};
+```
+
+## Step 2: Define Handlers
+
+Create a `JobHandlers<PayloadMap>` object. TypeScript enforces that every key in the PayloadMap has a handler. Each handler receives `(payload, signal, ctx)`.
+
+```typescript
+import { JobHandlers } from '@nicnocquee/dataqueue';
+import type { JobPayloadMap } from './types';
+
+export const jobHandlers: JobHandlers<JobPayloadMap> = {
+  send_email: async (payload) => {
+    await sendEmail(payload.to, payload.subject, payload.body);
+  },
+  generate_report: async (payload, signal) => {
+    if (signal.aborted) return;
+    await generateReport(payload.reportId, payload.userId);
+  },
+};
+```
+
+## Step 3: Initialize the Queue (Singleton)
+
+Use a module-level singleton. Each `initJobQueue` call creates a new database pool — never call it per-request.
+
+### PostgreSQL
+
+```typescript
+import { initJobQueue } from '@nicnocquee/dataqueue';
+import type { JobPayloadMap } from './types';
+
+let jobQueue: ReturnType<typeof initJobQueue<JobPayloadMap>> | null = null;
+
+export const getJobQueue = () => {
+  if (!jobQueue) {
+    jobQueue = initJobQueue<JobPayloadMap>({
+      databaseConfig: {
+        connectionString: process.env.PG_DATAQUEUE_DATABASE,
+      },
+    });
+  }
+  return jobQueue;
+};
+```
+
+### Redis
+
+```typescript
+jobQueue = initJobQueue<JobPayloadMap>({
+  backend: 'redis',
+  redisConfig: {
+    url: process.env.REDIS_URL,
+    keyPrefix: 'myapp:',
+  },
+});
+```
+
+## Step 4: Add Jobs
+
+```typescript
+const jobId = await queue.addJob({
+  jobType: 'send_email',
+  payload: { to: 'user@example.com', subject: 'Hi', body: 'Hello' },
+  priority: 10,
+  runAt: new Date(Date.now() + 5000),
+  tags: ['welcome'],
+  idempotencyKey: 'welcome-user-123',
+});
+```
+
+## Step 5: Process Jobs
+
+### Serverless (one-shot)
+
+```typescript
+const processor = queue.createProcessor(handlers, {
+  batchSize: 10,
+  concurrency: 3,
+});
+const processed = await processor.start();
+```
+
+### Long-running server
+
+```typescript
+const processor = queue.createProcessor(handlers, {
+  batchSize: 10,
+  concurrency: 3,
+  pollInterval: 5000,
+});
+processor.startInBackground();
+
+process.on('SIGTERM', async () => {
+  await processor.stopAndDrain(30000);
+  queue.getPool().end();
+  process.exit(0);
+});
+```
+
+## Common Mistakes
+
+1. **Creating a new queue per request** — always use a singleton. Each `initJobQueue` creates a DB pool.
+2. **Missing handler for a job type** — the job fails with `FailureReason.NoHandler`. Let TypeScript enforce completeness by typing handlers as `JobHandlers<PayloadMap>`.
+3. **Not checking `signal.aborted`** — timed-out jobs keep running in the background. Always check the signal in long-running handlers.
+4. **Forgetting `reclaimStuckJobs`** — crashed workers leave jobs stuck in `processing`. Call `reclaimStuckJobs()` periodically.
+5. **Forgetting to run migrations** — PostgreSQL requires `dataqueue-cli migrate` before use. Redis needs no migrations.
+6. **Not calling `stopAndDrain` on shutdown** — use `stopAndDrain()` (not `stop()`) for graceful shutdown to avoid stuck jobs.