@lunora/scheduler 1.0.0-alpha.20 → 1.0.0-alpha.21

package/dist/index.d.mts

@@ -18,7 +18,7 @@ type ArgsOf<F extends FunctionReference> = F extends {
 } ? A : Record<string, unknown>;
 /**
  * Typed reference to a Lunora durable workflow — either the generated
- * `workflows.&lt;name>` reference object (`_generated/api.ts`, which carries the
+ * `workflows.<name>` reference object (`_generated/api.ts`, which carries the
  * `WORKFLOW_*` binding + export name) or, structurally, a `defineWorkflow()`
  * result imported directly. Both are matched by the `isLunoraWorkflow` brand and
  * carry the workflow's `params` in the phantom `__params`, so a `cronJobs()`
@@ -36,7 +36,7 @@ type ArgsOf<F extends FunctionReference> = F extends {
 interface WorkflowReference<Params = Record<string, unknown>> {
   /** Phantom carrier for the workflow's `params` type — drives `cronJobs()` arg inference. Never read at runtime. */
   readonly __params?: Params;
-  /** The `WORKFLOW_*` binding name (present on a generated `workflows.&lt;name>` ref). */
+  /** The `WORKFLOW_*` binding name (present on a generated `workflows.<name>` ref). */
   readonly binding?: string;
   readonly isLunoraWorkflow: true;
   /** The workflow's export/stable name (present on a generated ref; a `defineWorkflow({ name })` override otherwise). */
@@ -161,8 +161,8 @@ interface Scheduler {
   /**
    * Schedule `target` to run once, `delayMs` from now. `target` is a function
    * {@link FunctionReference} (dispatched as a one-shot) or a durable
-   * {@link WorkflowReference} — the generated `workflows.&lt;name>` /
-   * `agents.&lt;name>` ref — which starts a fresh instance on fire (args become
+   * {@link WorkflowReference} — the generated `workflows.<name>` /
+   * `agents.<name>` ref — which starts a fresh instance on fire (args become
    * its `params`). {@link ScheduleTargetArgs} infers the accepted args from
    * whichever target was passed.
    */
@@ -241,7 +241,7 @@ interface WorkpoolOptions extends LunoraSchedulerOptions {
   maxConcurrency: number;
   /**
    * Pool name — the concurrency counter is keyed by this inside the
-   * SchedulerDO storage (`pool:&lt;name>`). Default `default`.
+   * SchedulerDO storage (`pool:<name>`). Default `default`.
    */
   name?: string;
 }
@@ -265,7 +265,7 @@ interface Workpool {
     id: string;
     scheduledFor: number;
   }>;
-  /** The pool's name (the `pool:&lt;name>` storage key suffix). */
+  /** The pool's name (the `pool:<name>` storage key suffix). */
   readonly name: string;
   /** Inspect the pool's current state — `inFlight` slots used and the configured `maxConcurrency`. */
   status: () => Promise<{
@@ -376,7 +376,7 @@ declare const createScheduler: (options: LunoraSchedulerOptions) => Scheduler;
  * `@convex-dev/workpool`. Mirrors `createScheduler`'s `namespace` /
  * `originUrl` / `instanceName` options and is built on the SAME `SchedulerDO`:
  * a workpool is just a NAMED logical pool inside that DO (concurrency counter
- * keyed by {@link WorkpoolOptions.name} under the `pool:&lt;name>` storage key).
+ * keyed by {@link WorkpoolOptions.name} under the `pool:<name>` storage key).
  * It needs no extra Durable Object or wrangler binding beyond the SchedulerDO
  * the scheduler already uses.
  *
@@ -511,20 +511,20 @@ interface CronJobsBuilder {
   /**
    * Raw cron expression escape hatch (5- or 6-field, full cron-parser grammar).
    * The target may be a function (`internal.file.fn`) or a durable workflow
-   * (`workflows.&lt;name>`); a workflow's `args` are inferred from its `params`.
+   * (`workflows.<name>`); a workflow's `args` are inferred from its `params`.
    */
   cron: <T extends CronTarget>(name: string, cronExpr: string, target: T, args?: CronTargetArgs<T>) => CronJobsBuilder;
-  /** Daily at `hourUTC:minuteUTC` (UTC). The target may be a function or a durable workflow (`workflows.&lt;name>`). */
+  /** Daily at `hourUTC:minuteUTC` (UTC). The target may be a function or a durable workflow (`workflows.<name>`). */
   daily: <T extends CronTarget>(name: string, schedule: DailySchedule, target: T, args?: CronTargetArgs<T>) => CronJobsBuilder;
-  /** Hourly at `minuteUTC` past the hour. The target may be a function or a durable workflow (`workflows.&lt;name>`). */
+  /** Hourly at `minuteUTC` past the hour. The target may be a function or a durable workflow (`workflows.<name>`). */
   hourly: <T extends CronTarget>(name: string, schedule: HourlySchedule, target: T, args?: CronTargetArgs<T>) => CronJobsBuilder;
-  /** Every `{ seconds | minutes | hours }`. The target may be a function or a durable workflow (`workflows.&lt;name>`). */
+  /** Every `{ seconds | minutes | hours }`. The target may be a function or a durable workflow (`workflows.<name>`). */
   interval: <T extends CronTarget>(name: string, schedule: IntervalSchedule, target: T, args?: CronTargetArgs<T>) => CronJobsBuilder;
   /** Snapshot of the registered jobs, in declaration order. */
   jobs: () => ReadonlyArray<CronJob>;
-  /** Monthly on `day` at `hourUTC:minuteUTC` (UTC). The target may be a function or a durable workflow (`workflows.&lt;name>`). */
+  /** Monthly on `day` at `hourUTC:minuteUTC` (UTC). The target may be a function or a durable workflow (`workflows.<name>`). */
   monthly: <T extends CronTarget>(name: string, schedule: MonthlySchedule, target: T, args?: CronTargetArgs<T>) => CronJobsBuilder;
-  /** Weekly on `dayOfWeek` at `hourUTC:minuteUTC` (UTC). The target may be a function or a durable workflow (`workflows.&lt;name>`). */
+  /** Weekly on `dayOfWeek` at `hourUTC:minuteUTC` (UTC). The target may be a function or a durable workflow (`workflows.<name>`). */
   weekly: <T extends CronTarget>(name: string, schedule: WeeklySchedule, target: T, args?: CronTargetArgs<T>) => CronJobsBuilder;
 }
 /**
@@ -597,7 +597,7 @@ interface SchedulerEnv {
   /**
    * Fallback bearer token attached to the dispatch when
    * {@link SchedulerEnv.LUNORA_SCHEDULER_SECRET} is not configured. Sent as
-   * `authorization: Bearer &lt;token>`.
+   * `authorization: Bearer <token>`.
    */
   LUNORA_ADMIN_TOKEN?: string;
   /**
@@ -624,7 +624,7 @@ interface SchedulerPoolStatus {
   inFlight: number;
   /** The pool's concurrency cap. */
   maxConcurrency: number;
-  /** The logical workpool name (the `pool:&lt;name>` suffix). */
+  /** The logical workpool name (the `pool:<name>` suffix). */
   name: string;
   /** Pending jobs routed to this pool but not yet dispatched. */
   queued: number;
@@ -639,13 +639,13 @@ interface SchedulerStatus {
   backlog: number;
   /** Sum of every pool's `inFlight` count — the total held concurrency slots. */
   inFlight: number;
-  /** Per-pool backlog breakdown, one entry per `pool:&lt;name>` record. */
+  /** Per-pool backlog breakdown, one entry per `pool:<name>` record. */
   pools: SchedulerPoolStatus[];
 }
 /**
  * Durable Object that stores pending scheduled invocations sorted by their
  * `scheduledFor` time and fires them via HTTP on alarm. Storage layout:
- * `id:&lt;id>` maps to {@link ScheduleRecord}; `t:&lt;paddedTime>:&lt;id>` maps to the
+ * `id:<id>` maps to {@link ScheduleRecord}; `t:<paddedTime>:<id>` maps to the
  * id (used as a sorted index).
  *
  * On every mutation the DO recomputes the earliest pending task and updates
@@ -835,7 +835,7 @@ declare class SchedulerDO {
    * under a `dead:` key for manual inspection.
    */
   private recordRetry;
-  /** Read the durable `pool:&lt;name>` row, defaulting to a fresh `inFlight: 0` pool. */
+  /** Read the durable `pool:<name>` row, defaulting to a fresh `inFlight: 0` pool. */
   private loadPool;
   private savePool;
   /**
@@ -857,7 +857,7 @@ declare class SchedulerDO {
   private handlePoolStatus;
   /**
    * `GET /status` — the app-level backlog signal that powers the studio's
-   * SLO view. Enumerates every durable `pool:&lt;name>` row for its `inFlight`/
+   * SLO view. Enumerates every durable `pool:<name>` row for its `inFlight`/
    * `maxConcurrency` semaphore, counts the pending (not-yet-dispatched) jobs
    * routed to each pool with the same single-pass scan {@link handlePoolStatus}
    * uses, and rolls those up into app-wide `backlog` (sum of `queued`) and
@@ -866,7 +866,7 @@ declare class SchedulerDO {
    * Pools that have rows but no queued jobs still appear (with `queued: 0`) so
    * a saturated-but-idle pool stays visible; a pool that only ever existed as
    * queued jobs without a persisted row is unreachable here (the schedule path
-   * always writes a `pool:&lt;name>` row before the job's header), so a single
+   * always writes a `pool:<name>` row before the job's header), so a single
    * scan over `pool:` plus a cursor loop over `id:` is sufficient.
    */
   private handleStatus;
@@ -875,7 +875,7 @@ declare class SchedulerDO {
   private handleList;
   /**
    * `GET /dead` — list the dead-letter records: jobs that exhausted their
-   * retry budget ({@link recordRetry}) and were parked under `dead:&lt;id>`
+   * retry budget ({@link recordRetry}) and were parked under `dead:<id>`
    * instead of being silently dropped. These never appear in `/list` (their
    * `id:` header is deleted on park), so this is the ONLY way the studio can
    * surface — and recover — a permanently-failed job.
@@ -896,7 +896,7 @@ declare class SchedulerDO {
    */
   private handleDeadCancel;
   /**
-   * Resolve a single pending job by id via a direct `id:&lt;id>` storage read —
+   * Resolve a single pending job by id via a direct `id:<id>` storage read —
    * O(1), versus scanning the whole `/list` view. Responds `{ record }` on a
    * hit and `{}` on a miss (an absent `record` field — JSON has no `undefined`
    * — which the client reads back as `null`).

package/dist/index.d.ts

@@ -18,7 +18,7 @@ type ArgsOf<F extends FunctionReference> = F extends {
 } ? A : Record<string, unknown>;
 /**
  * Typed reference to a Lunora durable workflow — either the generated
- * `workflows.&lt;name>` reference object (`_generated/api.ts`, which carries the
+ * `workflows.<name>` reference object (`_generated/api.ts`, which carries the
  * `WORKFLOW_*` binding + export name) or, structurally, a `defineWorkflow()`
  * result imported directly. Both are matched by the `isLunoraWorkflow` brand and
  * carry the workflow's `params` in the phantom `__params`, so a `cronJobs()`
@@ -36,7 +36,7 @@ type ArgsOf<F extends FunctionReference> = F extends {
 interface WorkflowReference<Params = Record<string, unknown>> {
   /** Phantom carrier for the workflow's `params` type — drives `cronJobs()` arg inference. Never read at runtime. */
   readonly __params?: Params;
-  /** The `WORKFLOW_*` binding name (present on a generated `workflows.&lt;name>` ref). */
+  /** The `WORKFLOW_*` binding name (present on a generated `workflows.<name>` ref). */
   readonly binding?: string;
   readonly isLunoraWorkflow: true;
   /** The workflow's export/stable name (present on a generated ref; a `defineWorkflow({ name })` override otherwise). */
@@ -161,8 +161,8 @@ interface Scheduler {
   /**
    * Schedule `target` to run once, `delayMs` from now. `target` is a function
    * {@link FunctionReference} (dispatched as a one-shot) or a durable
-   * {@link WorkflowReference} — the generated `workflows.&lt;name>` /
-   * `agents.&lt;name>` ref — which starts a fresh instance on fire (args become
+   * {@link WorkflowReference} — the generated `workflows.<name>` /
+   * `agents.<name>` ref — which starts a fresh instance on fire (args become
    * its `params`). {@link ScheduleTargetArgs} infers the accepted args from
    * whichever target was passed.
    */
@@ -241,7 +241,7 @@ interface WorkpoolOptions extends LunoraSchedulerOptions {
   maxConcurrency: number;
   /**
    * Pool name — the concurrency counter is keyed by this inside the
-   * SchedulerDO storage (`pool:&lt;name>`). Default `default`.
+   * SchedulerDO storage (`pool:<name>`). Default `default`.
    */
   name?: string;
 }
@@ -265,7 +265,7 @@ interface Workpool {
     id: string;
     scheduledFor: number;
   }>;
-  /** The pool's name (the `pool:&lt;name>` storage key suffix). */
+  /** The pool's name (the `pool:<name>` storage key suffix). */
   readonly name: string;
   /** Inspect the pool's current state — `inFlight` slots used and the configured `maxConcurrency`. */
   status: () => Promise<{
@@ -376,7 +376,7 @@ declare const createScheduler: (options: LunoraSchedulerOptions) => Scheduler;
  * `@convex-dev/workpool`. Mirrors `createScheduler`'s `namespace` /
  * `originUrl` / `instanceName` options and is built on the SAME `SchedulerDO`:
  * a workpool is just a NAMED logical pool inside that DO (concurrency counter
- * keyed by {@link WorkpoolOptions.name} under the `pool:&lt;name>` storage key).
+ * keyed by {@link WorkpoolOptions.name} under the `pool:<name>` storage key).
  * It needs no extra Durable Object or wrangler binding beyond the SchedulerDO
  * the scheduler already uses.
  *
@@ -511,20 +511,20 @@ interface CronJobsBuilder {
   /**
    * Raw cron expression escape hatch (5- or 6-field, full cron-parser grammar).
    * The target may be a function (`internal.file.fn`) or a durable workflow
-   * (`workflows.&lt;name>`); a workflow's `args` are inferred from its `params`.
+   * (`workflows.<name>`); a workflow's `args` are inferred from its `params`.
    */
   cron: <T extends CronTarget>(name: string, cronExpr: string, target: T, args?: CronTargetArgs<T>) => CronJobsBuilder;
-  /** Daily at `hourUTC:minuteUTC` (UTC). The target may be a function or a durable workflow (`workflows.&lt;name>`). */
+  /** Daily at `hourUTC:minuteUTC` (UTC). The target may be a function or a durable workflow (`workflows.<name>`). */
   daily: <T extends CronTarget>(name: string, schedule: DailySchedule, target: T, args?: CronTargetArgs<T>) => CronJobsBuilder;
-  /** Hourly at `minuteUTC` past the hour. The target may be a function or a durable workflow (`workflows.&lt;name>`). */
+  /** Hourly at `minuteUTC` past the hour. The target may be a function or a durable workflow (`workflows.<name>`). */
   hourly: <T extends CronTarget>(name: string, schedule: HourlySchedule, target: T, args?: CronTargetArgs<T>) => CronJobsBuilder;
-  /** Every `{ seconds | minutes | hours }`. The target may be a function or a durable workflow (`workflows.&lt;name>`). */
+  /** Every `{ seconds | minutes | hours }`. The target may be a function or a durable workflow (`workflows.<name>`). */
   interval: <T extends CronTarget>(name: string, schedule: IntervalSchedule, target: T, args?: CronTargetArgs<T>) => CronJobsBuilder;
   /** Snapshot of the registered jobs, in declaration order. */
   jobs: () => ReadonlyArray<CronJob>;
-  /** Monthly on `day` at `hourUTC:minuteUTC` (UTC). The target may be a function or a durable workflow (`workflows.&lt;name>`). */
+  /** Monthly on `day` at `hourUTC:minuteUTC` (UTC). The target may be a function or a durable workflow (`workflows.<name>`). */
   monthly: <T extends CronTarget>(name: string, schedule: MonthlySchedule, target: T, args?: CronTargetArgs<T>) => CronJobsBuilder;
-  /** Weekly on `dayOfWeek` at `hourUTC:minuteUTC` (UTC). The target may be a function or a durable workflow (`workflows.&lt;name>`). */
+  /** Weekly on `dayOfWeek` at `hourUTC:minuteUTC` (UTC). The target may be a function or a durable workflow (`workflows.<name>`). */
   weekly: <T extends CronTarget>(name: string, schedule: WeeklySchedule, target: T, args?: CronTargetArgs<T>) => CronJobsBuilder;
 }
 /**
@@ -597,7 +597,7 @@ interface SchedulerEnv {
   /**
    * Fallback bearer token attached to the dispatch when
    * {@link SchedulerEnv.LUNORA_SCHEDULER_SECRET} is not configured. Sent as
-   * `authorization: Bearer &lt;token>`.
+   * `authorization: Bearer <token>`.
    */
   LUNORA_ADMIN_TOKEN?: string;
   /**
@@ -624,7 +624,7 @@ interface SchedulerPoolStatus {
   inFlight: number;
   /** The pool's concurrency cap. */
   maxConcurrency: number;
-  /** The logical workpool name (the `pool:&lt;name>` suffix). */
+  /** The logical workpool name (the `pool:<name>` suffix). */
   name: string;
   /** Pending jobs routed to this pool but not yet dispatched. */
   queued: number;
@@ -639,13 +639,13 @@ interface SchedulerStatus {
   backlog: number;
   /** Sum of every pool's `inFlight` count — the total held concurrency slots. */
   inFlight: number;
-  /** Per-pool backlog breakdown, one entry per `pool:&lt;name>` record. */
+  /** Per-pool backlog breakdown, one entry per `pool:<name>` record. */
   pools: SchedulerPoolStatus[];
 }
 /**
  * Durable Object that stores pending scheduled invocations sorted by their
  * `scheduledFor` time and fires them via HTTP on alarm. Storage layout:
- * `id:&lt;id>` maps to {@link ScheduleRecord}; `t:&lt;paddedTime>:&lt;id>` maps to the
+ * `id:<id>` maps to {@link ScheduleRecord}; `t:<paddedTime>:<id>` maps to the
  * id (used as a sorted index).
  *
  * On every mutation the DO recomputes the earliest pending task and updates
@@ -835,7 +835,7 @@ declare class SchedulerDO {
    * under a `dead:` key for manual inspection.
    */
   private recordRetry;
-  /** Read the durable `pool:&lt;name>` row, defaulting to a fresh `inFlight: 0` pool. */
+  /** Read the durable `pool:<name>` row, defaulting to a fresh `inFlight: 0` pool. */
   private loadPool;
   private savePool;
   /**
@@ -857,7 +857,7 @@ declare class SchedulerDO {
   private handlePoolStatus;
   /**
    * `GET /status` — the app-level backlog signal that powers the studio's
-   * SLO view. Enumerates every durable `pool:&lt;name>` row for its `inFlight`/
+   * SLO view. Enumerates every durable `pool:<name>` row for its `inFlight`/
    * `maxConcurrency` semaphore, counts the pending (not-yet-dispatched) jobs
    * routed to each pool with the same single-pass scan {@link handlePoolStatus}
    * uses, and rolls those up into app-wide `backlog` (sum of `queued`) and
@@ -866,7 +866,7 @@ declare class SchedulerDO {
    * Pools that have rows but no queued jobs still appear (with `queued: 0`) so
    * a saturated-but-idle pool stays visible; a pool that only ever existed as
    * queued jobs without a persisted row is unreachable here (the schedule path
-   * always writes a `pool:&lt;name>` row before the job's header), so a single
+   * always writes a `pool:<name>` row before the job's header), so a single
    * scan over `pool:` plus a cursor loop over `id:` is sufficient.
    */
   private handleStatus;
@@ -875,7 +875,7 @@ declare class SchedulerDO {
   private handleList;
   /**
    * `GET /dead` — list the dead-letter records: jobs that exhausted their
-   * retry budget ({@link recordRetry}) and were parked under `dead:&lt;id>`
+   * retry budget ({@link recordRetry}) and were parked under `dead:<id>`
    * instead of being silently dropped. These never appear in `/list` (their
    * `id:` header is deleted on park), so this is the ONLY way the studio can
    * surface — and recover — a permanently-failed job.
@@ -896,7 +896,7 @@ declare class SchedulerDO {
    */
   private handleDeadCancel;
   /**
-   * Resolve a single pending job by id via a direct `id:&lt;id>` storage read —
+   * Resolve a single pending job by id via a direct `id:<id>` storage read —
    * O(1), versus scanning the whole `/list` view. Responds `{ record }` on a
    * hit and `{}` on a miss (an absent `record` field — JSON has no `undefined`
    * — which the client reads back as `null`).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lunora/scheduler",
-  "version": "1.0.0-alpha.20",
+  "version": "1.0.0-alpha.21",
   "description": "Scheduling for Lunora: runAfter / runAt and Cron Triggers via SchedulerDO",
   "keywords": [
     "cloudflare",
@@ -46,8 +46,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@lunora/errors": "1.0.0-alpha.13",
-    "@lunora/platform": "1.0.0-alpha.5",
+    "@lunora/errors": "1.0.0-alpha.14",
+    "@lunora/platform": "1.0.0-alpha.6",
     "cron-parser": "5.6.2"
   },
   "engines": {