@stacksjs/scheduler 0.58.51 → 0.58.53

package/src/types/cron.ts

@@ -0,0 +1,98 @@
+import type { SpawnOptions } from 'node:child_process'
+import type { DateTime } from 'luxon'
+import type { CONSTRAINTS, TIME_UNITS_MAP } from '../constants'
+import type { CronJob } from '../job'
+import type { IntRange } from './utils'
+
+interface BaseCronJobParams<
+  OC extends CronOnCompleteCommand | null = null,
+  C = null,
+> {
+  cronTime: string | Date | DateTime
+  onTick: CronCommand<C, WithOnComplete<OC>>
+  onComplete?: OC
+  start?: boolean | null
+  context?: C
+  runOnInit?: boolean | null
+  unrefTimeout?: boolean | null
+}
+
+export type CronJobParams<
+  OC extends CronOnCompleteCommand | null = null,
+  C = null,
+> = BaseCronJobParams<OC, C> &
+(
+  | {
+    timeZone?: string | null
+    utcOffset?: never
+  }
+  | {
+    timeZone?: never
+    utcOffset?: number | null
+  }
+  )
+
+export type CronContext<C> = C extends null ? CronJob : NonNullable<C>
+
+export type CronCallback<C, WithOnCompleteBool extends boolean = false> = (
+  this: CronContext<C>,
+  onComplete: WithOnCompleteBool extends true ? CronOnCompleteCallback : never
+) => void | Promise<void>
+
+export type CronOnCompleteCallback = () => void | Promise<void>
+
+export type CronSystemCommand =
+  | string
+  | {
+    command: string
+    args?: readonly string[] | null
+    options?: SpawnOptions | null
+  }
+
+export type CronCommand<C, WithOnCompleteBool extends boolean = false> =
+  | CronCallback<C, WithOnCompleteBool>
+  | CronSystemCommand
+
+export type CronOnCompleteCommand = CronOnCompleteCallback | CronSystemCommand
+
+export type WithOnComplete<OC> = OC extends null ? false : true
+
+export type TimeUnit = (typeof TIME_UNITS_MAP)[keyof typeof TIME_UNITS_MAP]
+
+export type TimeUnitField<T extends TimeUnit> = Partial<
+  Record<Ranges[T], boolean>
+>
+
+export interface Ranges {
+  second: SecondRange
+  minute: MinuteRange
+  hour: HourRange
+  dayOfMonth: DayOfMonthRange
+  month: MonthRange
+  dayOfWeek: DayOfWeekRange
+}
+
+export type SecondRange = IntRange<
+  (typeof CONSTRAINTS)['second'][0],
+  (typeof CONSTRAINTS)['second'][1]
+>
+export type MinuteRange = IntRange<
+  (typeof CONSTRAINTS)['minute'][0],
+  (typeof CONSTRAINTS)['minute'][1]
+>
+export type HourRange = IntRange<
+  (typeof CONSTRAINTS)['hour'][0],
+  (typeof CONSTRAINTS)['hour'][1]
+>
+export type DayOfMonthRange = IntRange<
+  (typeof CONSTRAINTS)['dayOfMonth'][0],
+  (typeof CONSTRAINTS)['dayOfMonth'][1]
+>
+export type MonthRange = IntRange<
+  (typeof CONSTRAINTS)['month'][0],
+  (typeof CONSTRAINTS)['month'][1]
+>
+export type DayOfWeekRange = IntRange<
+  (typeof CONSTRAINTS)['dayOfWeek'][0],
+  (typeof CONSTRAINTS)['dayOfWeek'][1]
+>

package/src/types/utils.ts

@@ -0,0 +1,14 @@
+export type IntRange<F extends number, T extends number> = Exclude<
+  Enumerate<T>,
+  Enumerate<F, false>
+>
+
+type Enumerate<
+  N extends number,
+  WithTail extends boolean = true,
+  Acc extends number[] = [],
+> = Acc['length'] extends N
+  ? WithTail extends true
+    ? [...Acc, Acc['length']][number]
+    : Acc[number]
+  : Enumerate<N, WithTail, [...Acc, Acc['length']]>

package/src/utils.ts

@@ -0,0 +1,19 @@
+import type { Ranges } from './types/cron'
+import { ExclusiveParametersError } from './errors'
+
+export function getRecordKeys<K extends Ranges[keyof Ranges]>(record: Partial<Record<K, boolean>>) {
+  return Object.keys(record) as unknown as (keyof typeof record)[]
+}
+
+export function getTimeZoneAndOffset(timeZone?: string | null, utcOffset?: number | null) {
+  if (timeZone != null && utcOffset != null)
+    throw new ExclusiveParametersError('timeZone', 'utcOffset')
+
+  if (timeZone != null)
+    return { timeZone, utcOffset: null }
+
+  if (utcOffset != null)
+    return { timeZone: null, utcOffset }
+
+  return { timeZone: null, utcOffset: null }
+}