@cleverbrush/scheduler 1.1.11 → 2.0.0

package/package.json

@@ -5,7 +5,10 @@
         "email": "andrew_zol@cleverbrush.com"
     },
     "dependencies": {
-        "@cleverbrush/schema": "1.1.11"
+        "@cleverbrush/schema": "^2.0.0"
+    },
+    "devDependencies": {
+        "@types/node": "^25.4.0"
     },
     "description": "Job Scheduler for NodeJS",
     "files": [
@@ -20,6 +23,13 @@
     ],
     "license": "BSD 3-Clause",
     "main": "./dist/index.js",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js"
+        }
+    },
+    "sideEffects": false,
     "name": "@cleverbrush/scheduler",
     "readme": "https://github.com/cleverbrush/framework/tree/master/libs/scheduler#readme",
     "repository": {
@@ -27,10 +37,11 @@
         "url": "github:cleverbrush/framework"
     },
     "scripts": {
-        "watch": "tsc --watch",
-        "build": "tsc"
+        "watch": "tsc --build --watch",
+        "build": "tsup && tsc --project tsconfig.build.json --emitDeclarationOnly",
+        "clean": "rm -rf dist tsconfig.tsbuildinfo"
     },
     "type": "module",
     "types": "./dist/index.d.ts",
-    "version": "1.1.11"
+    "version": "2.0.0"
 }

package/dist/ScheduleCalculator.js

@@ -1,208 +0,0 @@
-const MS_IN_DAY = 1000 * 60 * 60 * 24;
-const MS_IN_WEEK = MS_IN_DAY * 7;
-const getDayOfWeek = (date) => {
-    const res = date.getUTCDay();
-    if (res === 0)
-        return 7;
-    return res;
-};
-const getNumberOfDaysInMonth = (date) => {
-    return new Date(Date.UTC(date.getUTCFullYear(), date.getUTCMonth() + 1, 0, 0, 0, 0, 0)).getDate();
-};
-export class ScheduleCalculator {
-    #schedule;
-    #currentDate = new Date();
-    #hour = 9;
-    #minute = 0;
-    #maxRepeat = -1;
-    #repeatCount = 0;
-    #hasNext = false;
-    #next;
-    constructor(schedule) {
-        if (!schedule)
-            throw new Error('schedule is required');
-        this.#schedule = { ...schedule };
-        if (typeof schedule.startsOn !== 'undefined') {
-            this.#currentDate = schedule.startsOn;
-        }
-        else {
-            this.#schedule.startsOn = new Date();
-            this.#currentDate = this.#schedule.startsOn;
-        }
-        if (schedule.every !== 'minute') {
-            if (typeof schedule.hour === 'number') {
-                this.#hour = schedule.hour;
-            }
-            if (typeof schedule.minute === 'number') {
-                this.#minute = schedule.minute;
-            }
-            if (schedule.every === 'day' &&
-                new Date(Date.UTC(this.#currentDate.getUTCFullYear(), this.#currentDate.getUTCMonth(), this.#currentDate.getUTCDate(), this.#hour, this.#minute, 0, 0)).getTime() < this.#currentDate.getTime()) {
-                const date = new Date(Date.UTC(this.#currentDate.getUTCFullYear(), this.#currentDate.getUTCMonth(), this.#currentDate.getUTCDate() + 1, this.#hour, this.#minute, 0, 0));
-                this.#currentDate = date;
-            }
-        }
-        if (typeof schedule.maxOccurences === 'number') {
-            this.#maxRepeat = schedule.maxOccurences;
-        }
-        const next = this.#getNext();
-        if (typeof next !== 'undefined') {
-            this.#next = next;
-            this.#hasNext = true;
-        }
-        let leftToSkip = typeof this.#schedule.skipFirst === 'number'
-            ? this.#schedule.skipFirst
-            : 0;
-        while (leftToSkip-- > 0 && this.#hasNext) {
-            this.next();
-        }
-    }
-    #getNext() {
-        let candidate = null;
-        let dayOfWeek;
-        switch (this.#schedule.every) {
-            case 'minute':
-                candidate =
-                    this.#repeatCount === 0
-                        ? this.#schedule.startsOn
-                        : new Date(Date.UTC(this.#currentDate.getUTCFullYear(), this.#currentDate.getUTCMonth(), this.#currentDate.getUTCDate(), this.#currentDate.getUTCHours(), this.#currentDate.getUTCMinutes() +
-                            this.#schedule.interval, this.#currentDate.getUTCSeconds(), this.#currentDate.getUTCMilliseconds()));
-                break;
-            case 'day':
-                {
-                    const date = new Date(this.#currentDate.getTime() +
-                        MS_IN_DAY *
-                            (this.#repeatCount === 0
-                                ? 0
-                                : this.#schedule.interval - 1));
-                    candidate = new Date(Date.UTC(date.getUTCFullYear(), date.getUTCMonth(), date.getUTCDate(), this.#hour, this.#minute, 0, 0));
-                }
-                break;
-            case 'week':
-                {
-                    let date = this.#currentDate;
-                    do {
-                        let found = false;
-                        dayOfWeek = getDayOfWeek(date);
-                        if (Number.isNaN(dayOfWeek))
-                            return;
-                        for (let i = 0; i < 7 - dayOfWeek + 1; i++) {
-                            date = new Date(date.getTime() + (i == 0 ? 0 : MS_IN_DAY));
-                            if (this.#schedule.endsOn &&
-                                date > this.#schedule.endsOn) {
-                                return;
-                            }
-                            if (this.#schedule.dayOfWeek.includes(getDayOfWeek(date))) {
-                                const dateWithTime = new Date(Date.UTC(date.getUTCFullYear(), date.getUTCMonth(), date.getUTCDate(), this.#hour, this.#minute, 0, 0));
-                                if (dateWithTime >
-                                    this.#schedule.startsOn) {
-                                    candidate = dateWithTime;
-                                    found = true;
-                                    break;
-                                }
-                            }
-                        }
-                        if (found)
-                            break;
-                        date = new Date(date.getTime() +
-                            MS_IN_DAY +
-                            (this.#repeatCount == 0
-                                ? 0
-                                : (this.#schedule.interval - 1) *
-                                    MS_IN_WEEK));
-                    } while ((this.#schedule.endsOn &&
-                        date <= this.#schedule.endsOn) ||
-                        !this.#schedule.endsOn);
-                }
-                break;
-            case 'month':
-                {
-                    let dateTime;
-                    const cDate = this.#currentDate;
-                    let iteration = 0;
-                    do {
-                        const date = this.#schedule.day === 'last'
-                            ? getNumberOfDaysInMonth(new Date(Date.UTC(cDate.getUTCFullYear(), cDate.getUTCMonth() +
-                                iteration *
-                                    (this.#repeatCount === 0
-                                        ? 1
-                                        : this.#schedule
-                                            .interval), 1, 0, 0, 0, 0)))
-                            : this.#schedule.day;
-                        dateTime = new Date(Date.UTC(cDate.getUTCFullYear(), cDate.getUTCMonth() +
-                            iteration *
-                                (this.#repeatCount === 0
-                                    ? 1
-                                    : this.#schedule.interval), date, this.#hour, this.#minute, 0, 0));
-                        iteration++;
-                    } while (dateTime < this.#schedule.startsOn ||
-                        dateTime <= this.#currentDate);
-                    candidate = dateTime;
-                }
-                break;
-            case 'year':
-                {
-                    let dateTime;
-                    const cDate = this.#currentDate;
-                    let iteration = 0;
-                    do {
-                        const date = this.#schedule.day === 'last'
-                            ? getNumberOfDaysInMonth(new Date(Date.UTC(cDate.getUTCFullYear() +
-                                iteration *
-                                    (this.#repeatCount === 0
-                                        ? 1
-                                        : this.#schedule
-                                            .interval), this.#schedule.month - 1, 1, 0, 0, 0, 0)))
-                            : this.#schedule.day;
-                        dateTime = new Date(Date.UTC(cDate.getUTCFullYear() +
-                            iteration *
-                                (this.#repeatCount === 0
-                                    ? 1
-                                    : this.#schedule.interval), this.#schedule.month - 1, date, this.#hour, this.#minute, 0, 0));
-                        iteration++;
-                    } while (dateTime < this.#schedule.startsOn ||
-                        dateTime <= this.#currentDate);
-                    candidate = dateTime;
-                }
-                break;
-            default:
-                throw new Error('unknown schedule type');
-        }
-        if (!candidate)
-            return;
-        if (typeof this.#schedule.endsOn !== 'undefined' &&
-            candidate > this.#schedule.endsOn) {
-            return;
-        }
-        return candidate;
-    }
-    hasNext(span) {
-        if (!this.#hasNext) {
-            return false;
-        }
-        if (typeof span !== 'number')
-            return this.#hasNext;
-        if (!this.#next)
-            return false;
-        return this.#next.getTime() - new Date().getTime() <= span;
-    }
-    next() {
-        if (!this.#hasNext)
-            throw new Error('schedule is over');
-        const result = this.#next;
-        this.#currentDate = new Date(result.getTime() +
-            (['day', 'week'].includes(this.#schedule.every) ? MS_IN_DAY : 0));
-        this.#repeatCount++;
-        const next = this.#getNext();
-        this.#next = next;
-        this.#hasNext = typeof next !== 'undefined';
-        if (this.#maxRepeat > 0 && this.#repeatCount >= this.#maxRepeat) {
-            this.#next = undefined;
-            this.#hasNext = false;
-        }
-        return {
-            date: result,
-            index: this.#repeatCount
-        };
-    }
-}

package/dist/jobRepository.js

@@ -1,79 +0,0 @@
-export class InMemoryJobRepository {
-    _jobs = [];
-    _jobInstances = [];
-    _instanceId = 1;
-    async getJobs() {
-        return this._jobs;
-    }
-    async removeJob(jobId) {
-        const job = this.getJobById(jobId);
-        if (!job)
-            throw new Error(`job with id ${jobId} doesn't exist`);
-        this._jobs = this._jobs.filter((j) => j.id !== jobId);
-    }
-    async createJob(item) {
-        const job = {
-            ...item,
-            status: 'active'
-        };
-        this._jobs.push(job);
-        return job;
-    }
-    async getInstances(jobId) {
-        return this._jobInstances.filter((ji) => ji.jobId === jobId);
-    }
-    async addInstance(jobId, instance) {
-        const newInstance = {
-            ...instance,
-            id: this._instanceId++,
-            jobId
-        };
-        this._jobInstances.push(newInstance);
-        return newInstance;
-    }
-    async getJobById(jobId) {
-        return this._jobs.find((j) => j.id === jobId);
-    }
-    async setJobStatus(jobId, status) {
-        const job = await this.getJobById(jobId);
-        if (!job)
-            return null;
-        job.status = status;
-        return job;
-    }
-    async saveJob(job) {
-        const index = this._jobs.findIndex((j) => j.id === job.id);
-        if (index !== -1) {
-            this._jobs[index] = {
-                ...job
-            };
-            return this._jobs[index];
-        }
-        const result = {
-            ...job
-        };
-        this._jobs.push(result);
-        return result;
-    }
-    async getInstancesWithStatus(jobId, status) {
-        return (await this.getInstances(jobId)).filter((i) => i.status === status);
-    }
-    async getInstanceById(id) {
-        return this._jobInstances.find((ji) => ji.id === id);
-    }
-    async saveInstance(instance) {
-        const oldIndex = this._jobInstances.findIndex((ji) => ji.id === instance.id);
-        if (oldIndex !== -1) {
-            this._jobInstances[oldIndex] = {
-                ...instance
-            };
-            return this._jobInstances[oldIndex];
-        }
-        const result = {
-            ...instance,
-            id: this._instanceId++
-        };
-        this._jobInstances.push(result);
-        return result;
-    }
-}

package/dist/types.js

@@ -1,115 +0,0 @@
-import { array, boolean, date, func, number, object, string, union } from '@cleverbrush/schema';
-const ScheduleSchemaBase = object({
-    /** Number of intervals (days, months, minutes or weeks)
-     * between repeats. Interval type depends of `every` value */
-    interval: number().min(1).max(356),
-    /** Hour (0-23) */
-    hour: number().min(0).max(23).optional(),
-    /** Minute (0-59) */
-    minute: number().min(0).max(59).optional(),
-    /** Do not start earlier than this date */
-    startsOn: date().acceptJsonString().optional(),
-    /** Do not repeat after this date */
-    endsOn: date().acceptJsonString().optional(),
-    /** Max number of repeats (min 1) */
-    maxOccurences: number().min(1).optional(),
-    /** Skip this number of repeats. Min value is 1.  */
-    skipFirst: number().min(1).optional()
-}).addValidator((val) => {
-    if ('endsOn' in val &&
-        'maxOccurences' in val &&
-        typeof val.endsOn !== 'undefined') {
-        return {
-            valid: false,
-            errors: [{ message: 'either endsOn or maxOccurences is required' }]
-        };
-    }
-    return { valid: true };
-});
-const ScheduleMinuteSchema = ScheduleSchemaBase.omit('hour')
-    .omit('minute')
-    .addProps({
-    /** Repeat every minute */
-    every: string('minute')
-});
-const ScheduleDaySchema = ScheduleSchemaBase.addProps({
-    /** Repeat every day */
-    every: string('day')
-});
-const ScheduleWeekSchema = ScheduleSchemaBase.addProps({
-    /** Repeat every week */
-    every: string('week'),
-    /** Days of week for schedule */
-    dayOfWeek: array()
-        .of(number().min(1).max(7))
-        .minLength(1)
-        .maxLength(7)
-        .addValidator((val) => {
-        const map = {};
-        for (let i = 0; i < val.length; i++) {
-            if (map[val[i]]) {
-                return {
-                    valid: false,
-                    errors: [{ message: 'no duplicates allowed' }]
-                };
-            }
-            map[val[i]] = true;
-        }
-        return {
-            valid: true
-        };
-    })
-});
-const ScheduleMonthSchema = ScheduleSchemaBase.addProps({
-    /** Repeat every month */
-    every: string('month'),
-    /** Day - 'last' or number from 1 to 28 */
-    day: union(string('last')).or(number().min(1).max(28))
-});
-const ScheduleYearSchema = ScheduleSchemaBase.addProps({
-    /** Repeat every year */
-    every: string('year'),
-    /** Day - 'last' or number from 1 to 28 */
-    day: union(string('last')).or(number().min(1).max(28)),
-    /** Month - number from 1 to 12 */
-    month: number().min(1).max(12)
-});
-const ScheduleSchema = union(ScheduleMinuteSchema)
-    .or(ScheduleDaySchema)
-    .or(ScheduleWeekSchema)
-    .or(ScheduleMonthSchema)
-    .or(ScheduleYearSchema);
-const CreateJobRequestSchema = object({
-    /** Id of job, must be uniq */
-    id: string(),
-    /** Path to js file (relative to root folder) */
-    path: string().minLength(1),
-    /** Job's schedule */
-    schedule: ScheduleSchema,
-    /** Timeout for job (in milliseconds) */
-    timeout: number().min(0).optional(),
-    /** Arbitrary props for job (can be a callback returning props or Promise<props>) */
-    props: union(object().acceptUnknownProps()).or(func()).optional(),
-    /** Job will be considered as disabled when more than that count of runs fails consequently
-     * unlimited if negative
-     */
-    maxConsequentFails: number().optional(),
-    /**
-     * Job will be retried right away this times. Job will be retried on next schedule run if this number is exceeded.
-     */
-    maxRetries: number().optional().min(1),
-    /**
-     * If true, job will not be runned if previous run is not finished yet.
-     */
-    noConcurrentRuns: boolean().optional()
-});
-export const Schemas = {
-    ScheduleSchemaBase,
-    ScheduleSchema,
-    CreateJobRequestSchema,
-    ScheduleMinuteSchema,
-    ScheduleDaySchema,
-    ScheduleWeekSchema,
-    ScheduleMonthSchema,
-    ScheduleYearSchema
-};