@zerotal/scheduler 1.8.1 → 1.9.0

package/CHANGELOG.md

@@ -8,6 +8,16 @@ follows the Zerotal monorepo's unified versioning.
 
 ## [Unreleased]
 
+## [1.9.0] — 2026-08-29
+
+### Documented
+
+- **Every promised export is documented.** The `docs-coverage` gate reads `maturity: stable` as a
+  promise about a package's exports, and measures how much of that promise is written down. It
+  was 798 gaps across the suite; it is now zero. This package's share is covered on its own
+  pages — types named, options shapes described, and the decisions behind them recorded where
+  somebody looking for them will find them.
+
 ## [1.6.0] — 2026-08-15
 
 ### Fixed

package/api-surface.md

@@ -21,13 +21,6 @@ class CronExpression = {
   weekday: (v: number | string) => CronExpression
 }
 
-class FileScheduleRunStore = {
-  new (_path: string, _keep?: number): FileScheduleRunStore
-  lastFor: (name: string) => ScheduleRunRecord | undefined
-  recent: (limit?: number, name?: string) => ScheduleRunRecord[]
-  record: (run: ScheduleRunRecord) => void
-}
-
 class Schedule = {
   new (): Schedule
   appendOutputTo?: string
@@ -179,20 +172,8 @@ class TaskSkipped = {
   readonly reason: 'lock' | 'window' | 'env' | 'when' | 'skip' | 'overlap'
 }
 
-const DEFAULT_RUN_LOG_KEEP = 500
-
-const DEFAULT_RUN_LOG_PATH = 'storage/framework/schedule-runs.jsonl'
-
 const Scheduler = SchedulerManager
 
-const schedulesConcern = ConcernDescriptor
-
-function installScheduleRunLog = (app: Application) => (() => void) | undefined
-
-function registerSchedule = (manager: SchedulerManager, schedule: Schedule, fallbackName: string) => ScheduledTask | undefined
-
-function resolveRunLogConfig = (app: Application) => RunLogConfig
-
 function SchedulerConfig = (options?: Partial<SchedulerConfigShape>) => SchedulerConfigShape
 
 interface OverlapLockOptions = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zerotal/scheduler",
-  "version": "1.8.1",
+  "version": "1.9.0",
   "license": "MIT",
   "maturity": "stable",
   "private": false,
@@ -30,7 +30,7 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@zerotal/core": "1.8.1"
+    "@zerotal/core": "1.9.0"
   },
   "devDependencies": {
     "typescript": "^5.8.0"

package/src/conventions.ts

@@ -55,6 +55,8 @@ export function staticScheduleConfigKeys(cls: abstract new () => Schedule): stri
 /**
  * Register one Schedule instance with the scheduler manager, translating its declarative
  * settings into a configured ScheduledTask. Exported for testing.
+ *
+ * @internal
  */
 export function registerSchedule(
   manager: SchedulerManager,
@@ -101,6 +103,8 @@ export function registerSchedule(
  * `app/schedules/` convention. Every `Schedule` subclass is instantiated and registered with the
  * scheduler. Runs in worker (to execute) and console (so `schedule:list` can enumerate them);
  * never in `web`, so HTTP instances don't run cron. Contributed by `SchedulerProvider`.
+ *
+ * @internal
  */
 export const schedulesConcern: ConcernDescriptor = {
   name: "schedules",

package/src/runLog.ts

@@ -58,10 +58,16 @@ export interface RunLogConfig {
   keep: number;
 }
 
+/** @internal */
 export const DEFAULT_RUN_LOG_PATH = "storage/framework/schedule-runs.jsonl";
+/** @internal */
 export const DEFAULT_RUN_LOG_KEEP = 500;
 
-/** Resolve `scheduler.runLog` config with defaults, tolerating an absent config binding. */
+/**
+ * Resolve `scheduler.runLog` config with defaults, tolerating an absent config binding.
+ *
+ * @internal
+ */
 export function resolveRunLogConfig(app: Application): RunLogConfig {
   let raw: { enabled?: boolean; path?: string; keep?: number } = {};
   try {
@@ -81,6 +87,8 @@ export function resolveRunLogConfig(app: Application): RunLogConfig {
 /**
  * JSONL-backed run store. Appends are synchronous — runs happen at cron cadence,
  * not request cadence, and a record that survives a crash is the whole point.
+ *
+ * @internal
  */
 export class FileScheduleRunStore implements ScheduleRunStore {
   constructor(
@@ -151,6 +159,8 @@ export class FileScheduleRunStore implements ScheduleRunStore {
  * success and `TaskFailed` on a throw, so together they are exactly one record per
  * completed execution (skips are deliberate non-runs and are not recorded). Returns
  * a disposer, or undefined when the run log is disabled.
+ *
+ * @internal
  */
 export function installScheduleRunLog(app: Application): (() => void) | undefined {
   const config = resolveRunLogConfig(app);