@danypops/vehicle-core 0.9.0 → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -3,4 +3,5 @@ export * from "./vehicle-approvals.js";
3
3
  export * from "./vehicle-contract.js";
4
4
  export * from "./vehicle-errors.js";
5
5
  export * from "./vehicle-jobs.js";
6
+ export * from "./vehicle-scheduler.js";
6
7
  export * from "./vehicle-watchers.js";
package/dist/index.js CHANGED
@@ -3,4 +3,5 @@ export * from "./vehicle-approvals.js";
3
3
  export * from "./vehicle-contract.js";
4
4
  export * from "./vehicle-errors.js";
5
5
  export * from "./vehicle-jobs.js";
6
+ export * from "./vehicle-scheduler.js";
6
7
  export * from "./vehicle-watchers.js";
@@ -0,0 +1,63 @@
1
+ /**
2
+ * "Trigger something at a future time or on a recurring interval,"
3
+ * independent of any specific job's own lifecycle -- a distinct shape from
4
+ * Vehicle Jobs (submit-then-track a unit of work already running). Modeled
5
+ * on ~/Workspace/alef's packages/core/foundry/src/scheduler.ts
6
+ * (defer/repeat/cancel/list), generalized so the fired action is a
7
+ * declarative Vehicle operation invocation or event emission -- never a
8
+ * bespoke callback closure, so it can be persisted and re-armed after a
9
+ * restart the way a closure never could.
10
+ *
11
+ * Pure pieces only: trigger/action shapes and the fire-time arithmetic.
12
+ * Real timers, persistence, and registry wiring live in vehicle-server's
13
+ * VehicleScheduler, the same core/server split vehicle-jobs.ts uses.
14
+ */
15
+ import type { JsonValue } from "./vehicle-contract.js";
16
+ export type VehicleScheduleTrigger = {
17
+ readonly kind: "at";
18
+ readonly at: number;
19
+ } | {
20
+ readonly kind: "every";
21
+ readonly intervalMs: number;
22
+ };
23
+ export type VehicleScheduleAction = {
24
+ readonly kind: "operation";
25
+ readonly name: string;
26
+ readonly version: number;
27
+ readonly input: JsonValue;
28
+ readonly permissions?: readonly string[];
29
+ } | {
30
+ readonly kind: "event";
31
+ readonly name: string;
32
+ readonly version: number;
33
+ readonly payload: JsonValue;
34
+ };
35
+ export interface VehicleScheduledEntry {
36
+ readonly scheduleId: string;
37
+ readonly owner: string;
38
+ readonly trigger: VehicleScheduleTrigger;
39
+ readonly action: VehicleScheduleAction;
40
+ readonly createdAt: number;
41
+ /** For "at": consumed once it fires. For "every": advanced to the next tick after each fire. */
42
+ readonly nextFireAt: number;
43
+ }
44
+ /** Matches WatchRegistry's own historical default (Lector's MAX_WATCHES_PER_WORKSPACE). */
45
+ export declare const DEFAULT_MAX_SCHEDULES_PER_OWNER = 32;
46
+ /** Raised when an owner already has its configured maximum of schedules -- fails closed, the same bounded-resource discipline WatchLimitExceeded already applies to Vehicle Watchers. */
47
+ export declare class VehicleScheduleLimitExceeded extends Error {
48
+ readonly owner: string;
49
+ readonly max: number;
50
+ constructor(owner: string, max: number);
51
+ }
52
+ /** The first fire time for a freshly created schedule. */
53
+ export declare function initialFireAt(trigger: VehicleScheduleTrigger, now: number): number;
54
+ /** The next fire time after a successful fire, or undefined if the entry (a one-shot "at") should be removed instead of re-armed. */
55
+ export declare function nextFireAtAfterFire(trigger: VehicleScheduleTrigger, now: number): number | undefined;
56
+ /**
57
+ * Where a restored entry should be re-armed to. A one-shot "at" entry keeps
58
+ * its original persisted time (fires as soon as possible if overdue -- the
59
+ * one thing it was supposed to do must not be silently lost). A recurring
60
+ * "every" entry resumes its normal cadence from now if it fell behind while
61
+ * the daemon was down, rather than firing once per missed tick.
62
+ */
63
+ export declare function nextFireAtAfterRestore(trigger: VehicleScheduleTrigger, persistedNextFireAt: number, now: number): number;
@@ -0,0 +1,33 @@
1
+ /** Matches WatchRegistry's own historical default (Lector's MAX_WATCHES_PER_WORKSPACE). */
2
+ export const DEFAULT_MAX_SCHEDULES_PER_OWNER = 32;
3
+ /** Raised when an owner already has its configured maximum of schedules -- fails closed, the same bounded-resource discipline WatchLimitExceeded already applies to Vehicle Watchers. */
4
+ export class VehicleScheduleLimitExceeded extends Error {
5
+ owner;
6
+ max;
7
+ constructor(owner, max) {
8
+ super(`owner "${owner}" already has ${max} active schedules -- cancel one before adding another`);
9
+ this.owner = owner;
10
+ this.max = max;
11
+ this.name = "VehicleScheduleLimitExceeded";
12
+ }
13
+ }
14
+ /** The first fire time for a freshly created schedule. */
15
+ export function initialFireAt(trigger, now) {
16
+ return trigger.kind === "at" ? trigger.at : now + trigger.intervalMs;
17
+ }
18
+ /** The next fire time after a successful fire, or undefined if the entry (a one-shot "at") should be removed instead of re-armed. */
19
+ export function nextFireAtAfterFire(trigger, now) {
20
+ return trigger.kind === "every" ? now + trigger.intervalMs : undefined;
21
+ }
22
+ /**
23
+ * Where a restored entry should be re-armed to. A one-shot "at" entry keeps
24
+ * its original persisted time (fires as soon as possible if overdue -- the
25
+ * one thing it was supposed to do must not be silently lost). A recurring
26
+ * "every" entry resumes its normal cadence from now if it fell behind while
27
+ * the daemon was down, rather than firing once per missed tick.
28
+ */
29
+ export function nextFireAtAfterRestore(trigger, persistedNextFireAt, now) {
30
+ if (trigger.kind === "at")
31
+ return persistedNextFireAt;
32
+ return persistedNextFireAt > now ? persistedNextFireAt : now + trigger.intervalMs;
33
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@danypops/vehicle-core",
3
- "version": "0.9.0",
3
+ "version": "0.10.0",
4
4
  "description": "Vehicle's runtime-neutral wire contract: operation descriptors, schema codecs, failure shapes. Zero runtime dependencies, zero Bun-specific code -- the one thing every Vehicle client and server package depends on.",
5
5
  "license": "MIT",
6
6
  "type": "module",
package/src/index.ts CHANGED
@@ -3,4 +3,5 @@ export * from "./vehicle-approvals.js";
3
3
  export * from "./vehicle-contract.js";
4
4
  export * from "./vehicle-errors.js";
5
5
  export * from "./vehicle-jobs.js";
6
+ export * from "./vehicle-scheduler.js";
6
7
  export * from "./vehicle-watchers.js";
@@ -0,0 +1,73 @@
1
+ /**
2
+ * "Trigger something at a future time or on a recurring interval,"
3
+ * independent of any specific job's own lifecycle -- a distinct shape from
4
+ * Vehicle Jobs (submit-then-track a unit of work already running). Modeled
5
+ * on ~/Workspace/alef's packages/core/foundry/src/scheduler.ts
6
+ * (defer/repeat/cancel/list), generalized so the fired action is a
7
+ * declarative Vehicle operation invocation or event emission -- never a
8
+ * bespoke callback closure, so it can be persisted and re-armed after a
9
+ * restart the way a closure never could.
10
+ *
11
+ * Pure pieces only: trigger/action shapes and the fire-time arithmetic.
12
+ * Real timers, persistence, and registry wiring live in vehicle-server's
13
+ * VehicleScheduler, the same core/server split vehicle-jobs.ts uses.
14
+ */
15
+ import type { JsonValue } from "./vehicle-contract.js";
16
+
17
+ export type VehicleScheduleTrigger = { readonly kind: "at"; readonly at: number } | { readonly kind: "every"; readonly intervalMs: number };
18
+
19
+ export type VehicleScheduleAction =
20
+ | {
21
+ readonly kind: "operation";
22
+ readonly name: string;
23
+ readonly version: number;
24
+ readonly input: JsonValue;
25
+ readonly permissions?: readonly string[];
26
+ }
27
+ | { readonly kind: "event"; readonly name: string; readonly version: number; readonly payload: JsonValue };
28
+
29
+ export interface VehicleScheduledEntry {
30
+ readonly scheduleId: string;
31
+ readonly owner: string;
32
+ readonly trigger: VehicleScheduleTrigger;
33
+ readonly action: VehicleScheduleAction;
34
+ readonly createdAt: number;
35
+ /** For "at": consumed once it fires. For "every": advanced to the next tick after each fire. */
36
+ readonly nextFireAt: number;
37
+ }
38
+
39
+ /** Matches WatchRegistry's own historical default (Lector's MAX_WATCHES_PER_WORKSPACE). */
40
+ export const DEFAULT_MAX_SCHEDULES_PER_OWNER = 32;
41
+
42
+ /** Raised when an owner already has its configured maximum of schedules -- fails closed, the same bounded-resource discipline WatchLimitExceeded already applies to Vehicle Watchers. */
43
+ export class VehicleScheduleLimitExceeded extends Error {
44
+ constructor(
45
+ readonly owner: string,
46
+ readonly max: number,
47
+ ) {
48
+ super(`owner "${owner}" already has ${max} active schedules -- cancel one before adding another`);
49
+ this.name = "VehicleScheduleLimitExceeded";
50
+ }
51
+ }
52
+
53
+ /** The first fire time for a freshly created schedule. */
54
+ export function initialFireAt(trigger: VehicleScheduleTrigger, now: number): number {
55
+ return trigger.kind === "at" ? trigger.at : now + trigger.intervalMs;
56
+ }
57
+
58
+ /** The next fire time after a successful fire, or undefined if the entry (a one-shot "at") should be removed instead of re-armed. */
59
+ export function nextFireAtAfterFire(trigger: VehicleScheduleTrigger, now: number): number | undefined {
60
+ return trigger.kind === "every" ? now + trigger.intervalMs : undefined;
61
+ }
62
+
63
+ /**
64
+ * Where a restored entry should be re-armed to. A one-shot "at" entry keeps
65
+ * its original persisted time (fires as soon as possible if overdue -- the
66
+ * one thing it was supposed to do must not be silently lost). A recurring
67
+ * "every" entry resumes its normal cadence from now if it fell behind while
68
+ * the daemon was down, rather than firing once per missed tick.
69
+ */
70
+ export function nextFireAtAfterRestore(trigger: VehicleScheduleTrigger, persistedNextFireAt: number, now: number): number {
71
+ if (trigger.kind === "at") return persistedNextFireAt;
72
+ return persistedNextFireAt > now ? persistedNextFireAt : now + trigger.intervalMs;
73
+ }