@cronvello/sdk 0.1.3 → 0.2.0

package/dist/index.d.cts

@@ -2,6 +2,8 @@ import { T as Transport, P as PublicJob, J as JobCreateBody, a as JobUpdateBody,
 export { o as CallbackStatus, p as CronvelloHooks, q as CronvelloJobConfig, r as CronvelloJobConfigWithKey, s as CronvelloJobContext, t as CronvelloJobHandler, u as CronvelloJobsInput, v as CronvelloLogger, w as CronvelloRunSource, E as ExecutionMode, H as HttpMethod, x as JobStatus, y as Pagination, z as ReconcileTaskChange, B as RegistryReconcileChange, G as RegistryTaskInput, I as RunStatus, K as RunType, L as SuccessCriteria, N as Urgency } from './dispatch-handler-DazGcFHz.cjs';
 import { ExpressDispatchHandler } from './express.cjs';
 import { NextRouteHandler } from './next.cjs';
+import { LocalEngineOptions, DashboardOptions, LocalEngine } from './dev.cjs';
+export { NextOccurrenceOptions, PreviewOptions, nextOccurrence, previewSchedule } from './dev.cjs';
 
 /**
  * Low-level, fully-typed client for the Cronvello public `/v1` API.
@@ -154,9 +156,30 @@ interface CronvelloApp {
     expressHandler(): ExpressDispatchHandler;
     /** Next.js App Router (Route Handler) for the dispatch endpoint. */
     nextHandler(): NextRouteHandler;
+    /**
+     * Start the **local engine** — run your jobs on this machine with no account, no cloud, no
+     * network. Each job's next fire time is computed from its schedule (timezone/DST-aware) and its
+     * handler runs locally, with overlap protection, per-run timeout, and retry/backoff enforced just
+     * like the cloud. Returns the engine handle (history, snapshot, `stop()`); powers `cronvello dev`.
+     *
+     * Pass `autoStart: false` to construct the engine without starting it (the CLI does this to render
+     * the job table first). Existing `sync()` / dispatch paths are untouched.
+     */
+    dev(options?: DevOptions): LocalEngine;
     /** The registry keys, for diagnostics. */
     keys(): string[];
 }
+/** Options for {@link CronvelloApp.dev}. */
+interface DevOptions extends LocalEngineOptions {
+    /** Start the scheduler immediately (default true). Set false to start it yourself later. */
+    autoStart?: boolean;
+    /**
+     * Also start the local web dashboard alongside the engine. `true` uses the defaults
+     * (`http://127.0.0.1:4747`); pass an object to set `port`/`host`. `engine.stop()` closes it too.
+     * The dashboard module is loaded lazily, so it never weighs down the main bundle.
+     */
+    dashboard?: boolean | DashboardOptions;
+}
 /** Config for `defineCronvello.fromEnv` — the three secret fields become optional (read from env). */
 type CronvelloEnvConfig = Omit<CronvelloAppConfig, "apiKey" | "dispatchSecret" | "appUrl"> & Partial<Pick<CronvelloAppConfig, "apiKey" | "dispatchSecret" | "appUrl">>;
 declare function defineCronvello(config: CronvelloAppConfig): CronvelloApp;

package/dist/index.d.ts

@@ -2,6 +2,8 @@ import { T as Transport, P as PublicJob, J as JobCreateBody, a as JobUpdateBody,
 export { o as CallbackStatus, p as CronvelloHooks, q as CronvelloJobConfig, r as CronvelloJobConfigWithKey, s as CronvelloJobContext, t as CronvelloJobHandler, u as CronvelloJobsInput, v as CronvelloLogger, w as CronvelloRunSource, E as ExecutionMode, H as HttpMethod, x as JobStatus, y as Pagination, z as ReconcileTaskChange, B as RegistryReconcileChange, G as RegistryTaskInput, I as RunStatus, K as RunType, L as SuccessCriteria, N as Urgency } from './dispatch-handler-DazGcFHz.js';
 import { ExpressDispatchHandler } from './express.js';
 import { NextRouteHandler } from './next.js';
+import { LocalEngineOptions, DashboardOptions, LocalEngine } from './dev.js';
+export { NextOccurrenceOptions, PreviewOptions, nextOccurrence, previewSchedule } from './dev.js';
 
 /**
  * Low-level, fully-typed client for the Cronvello public `/v1` API.
@@ -154,9 +156,30 @@ interface CronvelloApp {
     expressHandler(): ExpressDispatchHandler;
     /** Next.js App Router (Route Handler) for the dispatch endpoint. */
     nextHandler(): NextRouteHandler;
+    /**
+     * Start the **local engine** — run your jobs on this machine with no account, no cloud, no
+     * network. Each job's next fire time is computed from its schedule (timezone/DST-aware) and its
+     * handler runs locally, with overlap protection, per-run timeout, and retry/backoff enforced just
+     * like the cloud. Returns the engine handle (history, snapshot, `stop()`); powers `cronvello dev`.
+     *
+     * Pass `autoStart: false` to construct the engine without starting it (the CLI does this to render
+     * the job table first). Existing `sync()` / dispatch paths are untouched.
+     */
+    dev(options?: DevOptions): LocalEngine;
     /** The registry keys, for diagnostics. */
     keys(): string[];
 }
+/** Options for {@link CronvelloApp.dev}. */
+interface DevOptions extends LocalEngineOptions {
+    /** Start the scheduler immediately (default true). Set false to start it yourself later. */
+    autoStart?: boolean;
+    /**
+     * Also start the local web dashboard alongside the engine. `true` uses the defaults
+     * (`http://127.0.0.1:4747`); pass an object to set `port`/`host`. `engine.stop()` closes it too.
+     * The dashboard module is loaded lazily, so it never weighs down the main bundle.
+     */
+    dashboard?: boolean | DashboardOptions;
+}
 /** Config for `defineCronvello.fromEnv` — the three secret fields become optional (read from env). */
 type CronvelloEnvConfig = Omit<CronvelloAppConfig, "apiKey" | "dispatchSecret" | "appUrl"> & Partial<Pick<CronvelloAppConfig, "apiKey" | "dispatchSecret" | "appUrl">>;
 declare function defineCronvello(config: CronvelloAppConfig): CronvelloApp;