@stonyx/cron 0.2.1-alpha.62 → 0.2.1-alpha.64

package/README.md

@@ -47,6 +47,24 @@ When a job is executed, its next trigger time is updated, and it is re-inserted
 
 > `MinHeap` is also exported as a public subpath (`@stonyx/cron/min-heap`) and can be imported directly for advanced usage.
 
+## Exports
+
+| Import path | What it exports |
+| :--- | :--- |
+| `@stonyx/cron` | `Cron` (default), the interval registry above |
+| `@stonyx/cron/service` | `CronService` (default), see [CronService](#cronservice) |
+| `@stonyx/cron/schedule` | `computeNextRunAtMs`, `validateSchedule`, and the `Schedule` types |
+| `@stonyx/cron/cron-parser` | `parseCronExpression`, `parseField`, `nextOccurrence`, `validateCronExpression` |
+| `@stonyx/cron/job` | `createJob`, `updateJob`, `applyResult`, `isDue`, `markRunning`, `errorBackoffMs`, and the `Job` types |
+| `@stonyx/cron/normalize` | `normalizeJobInput`, `normalizeSchedule`, `normalizePayload`, `recoverFlatParams` |
+| `@stonyx/cron/run-log` | `RunLog` (default) |
+| `@stonyx/cron/locked` | `locked`, `resetLock` |
+| `@stonyx/cron/min-heap` | `MinHeap` (default) |
+
+## Samples
+
+[`test/sample/`](https://github.com/abofs/stonyx-cron/tree/dev/test/sample) is the canonical usage reference for job definitions: legacy `Cron` intervals and every `CronService` schedule kind. It is not included in the npm package.
+
 ## CronService
 
 The default export above is `Cron`: a fire-and-forget interval registry. `@stonyx/cron/service` is a separate, heavier class for jobs that need CRUD, persistence, a run log and error backoff. It is not a drop-in replacement and the two do not share a scheduler.
@@ -97,9 +115,12 @@ Tracked as #35.
 Five consumer-visible changes landed with the phase split (#34). Only the first
 two are visible in the emitted `dist/service.d.ts`; the rest are runtime
 behaviour and a type-checker will not find them for you. The measured
-`dist/service.d.ts` delta against the previous release is exactly three things:
-the class gained `#private;`, `reason` narrowed, and six type declarations
-gained `export`. `dist/main.d.ts` is unchanged.
+`dist/service.d.ts` delta against the previous release is exactly four things:
+the class gained `#private;`, `reason` narrowed, five type declarations gained
+`export` (`JobDueResult`, `ExecuteResult`, `ServiceStatus`, `ListOptions` and
+`OnJobDueCallback`), and `SkipReason` was added as a new exported type — it did
+not exist in the previous release, so it gained nothing. `HeapEntry` remains
+unexported. `dist/main.d.ts` is unchanged.
 
 1. **`ExecuteResult.reason` narrowed** from `string` to `'not due' | 'already running' | 'removed'`, and gained the `'removed'` member. Comparing it against a literal outside the union, or `switch`ing on one, is now a compile error (`TS2367` / `TS2678`). Assigning it into `string | undefined` and spreading it are unaffected. The type is exported as `SkipReason`.
 2. **`CronService` is nominally typed.** It carries ECMAScript hard-private members, so the declarations emit `#private;` and a structurally hand-built test double no longer assigns to `CronService` (`TS2741: Property '#private' is missing`). The break is one-directional: `class X extends CronService` still compiles, and assigning a real `CronService` to your own hand-written interface still compiles. **Migration:** declare your own interface and depend on that instead of a `CronService`-typed mock.

package/dist/main.js

@@ -41,8 +41,8 @@ const MAX_LOGGED_ERROR_LENGTH = 512;
  * `describeError` directly below (`:82`, `:85`), and both are INSIDE that
  * function's own `try`, so a `TypeError` from `value.replace` on a
  * non-string degrades to `'<thrown value could not be rendered>'` and the log
- * record is still produced. `service.ts`'s callers are not so contained: `:692`
- * sits in a bare `catch` with nothing above it, and `:571`'s enclosing `catch`
+ * record is still produced. `service.ts`'s callers are not so contained: `:700`
+ * sits in a bare `catch` with nothing above it, and `:579`'s enclosing `catch`
  * has nothing left to report to — so a throw there destroyed the failure
  * record outright (measured: 0 records for a job that failed). That is why
  * totality was a live defect there and is not one here.

package/package.json

@@ -3,7 +3,7 @@
   "keywords": [
     "stonyx-module"
   ],
-  "version": "0.2.1-alpha.62",
+  "version": "0.2.1-alpha.64",
   "description": "Cron/job scheduler for Stonyx framework",
   "main": "dist/main.js",
   "types": "dist/main.d.ts",
@@ -79,7 +79,7 @@
     "typescript": "^5.8.3"
   },
   "dependencies": {
-    "stonyx": "0.2.3-beta.93"
+    "stonyx": "0.2.3-beta.98"
   },
   "scripts": {
     "build": "tsc",