@vendure/core 3.2.4 → 3.3.0

package/dist/scheduler/scheduled-task.d.ts

@@ -0,0 +1,142 @@
+import CronTime from 'cron-time-generator';
+import { RequestContext } from '../api';
+import { Injector } from '../common/index';
+/**
+ * @description
+ * The arguments passed to the execute method of a scheduled task.
+ *
+ * @since 3.3.0
+ * @docsCategory scheduled-tasks
+ * @docsPage ScheduledTask
+ */
+export interface ScheduledTaskExecutionArgs<C extends Record<string, any> = Record<string, any>> {
+    /**
+     * @description
+     * The injector instance.
+     */
+    injector: Injector;
+    /**
+     * @description
+     * A RequestContext instance that is configured for the scheduled task.
+     */
+    scheduledContext: RequestContext;
+    /**
+     * @description
+     * The parameters for the scheduled task.
+     */
+    params: C;
+}
+/**
+ * @description
+ * The configuration for a scheduled task.
+ *
+ * @since 3.3.0
+ * @docsCategory scheduled-tasks
+ * @docsPage ScheduledTask
+ */
+export interface ScheduledTaskConfig<C extends Record<string, any> = Record<string, any>> {
+    /**
+     * @description
+     * The unique identifier for the scheduled task.
+     */
+    id: string;
+    /**
+     * @description
+     * The description for the scheduled task.
+     */
+    description?: string;
+    /**
+     * @description
+     * Optional parameters that will be passed to the `execute` function.
+     */
+    params?: C;
+    /**
+     * @description
+     * The cron schedule for the scheduled task. This can be a standard cron expression or
+     * a function that returns a [cron-time-generator](https://www.npmjs.com/package/cron-time-generator)
+     * expression.
+     *
+     * @example
+     * ```ts
+     * // Standard cron expression
+     * { schedule: '0 0-23/5 * * *', } // every 5 hours
+     * { schedule: '0 22 * * *', } // every day at 10:00 PM
+     *
+     * // Cron-time-generator expression
+     * { schedule: cronTime => cronTime.every(2).minutes(), }
+     * { schedule: cronTime => cronTime.every(5).hours(), }
+     * ```
+     */
+    schedule: string | ((cronTime: typeof CronTime) => string);
+    /**
+     * @description
+     * The timeout for the scheduled task. If the task takes longer than the timeout, the task
+     * will be considered to have failed with a timeout error.
+     *
+     * @default 60_000ms
+     */
+    timeout?: number | string;
+    /**
+     * @description
+     * Whether the scheduled task should be prevented from running if it is already running.
+     *
+     * @default true
+     */
+    preventOverlap?: boolean;
+    /**
+     * @description
+     * The function that will be executed when the scheduled task is run.
+     */
+    execute(args: ScheduledTaskExecutionArgs<C>): Promise<any>;
+}
+/**
+ * @description
+ * Use this class to define a scheduled task that will be executed at a given cron schedule.
+ *
+ * @example
+ * ```ts
+ * import { ScheduledTask } from '\@vendure/core';
+ *
+ * const task = new ScheduledTask({
+ *     id: 'test-job',
+ *     schedule: cron => cron.every(2).minutes(),
+ *     execute: async ({ injector, scheduledContext, params }) => {
+ *         // some logic here
+ *     },
+ * });
+ * ```
+ *
+ * @since 3.3.0
+ * @docsCategory scheduled-tasks
+ * @docsPage ScheduledTask
+ * @docsWeight 0
+ */
+export declare class ScheduledTask<C extends Record<string, any> = Record<string, any>> {
+    private readonly config;
+    constructor(config: ScheduledTaskConfig<C>);
+    get id(): string;
+    get options(): ScheduledTaskConfig<C>;
+    execute(injector: Injector): Promise<any>;
+    /**
+     * @description
+     * This method allows you to further configure existing scheduled tasks. For example, you may
+     * wish to change the schedule or timeout of a task, without having to define a new task.
+     *
+     * @example
+     * ```ts
+     * import { ScheduledTask } from '\@vendure/core';
+     *
+     * const task = new ScheduledTask({
+     *     id: 'test-job',
+     *     schedule: cron => cron.every(2).minutes(),
+     *     execute: async ({ injector, scheduledContext, params }) => {
+     *         // some logic here
+     *     },
+     * });
+     *
+     * // later, you can configure the task
+     * task.configure({ schedule: cron => cron.every(5).minutes() });
+     * ```
+     */
+    configure(additionalConfig: Partial<Pick<ScheduledTaskConfig<C>, 'schedule' | 'timeout' | 'params'>>): this;
+}

package/dist/scheduler/scheduled-task.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScheduledTask = void 0;
+const request_context_service_1 = require("../service/helpers/request-context/request-context.service");
+const channel_service_1 = require("../service/services/channel.service");
+/**
+ * @description
+ * Use this class to define a scheduled task that will be executed at a given cron schedule.
+ *
+ * @example
+ * ```ts
+ * import { ScheduledTask } from '\@vendure/core';
+ *
+ * const task = new ScheduledTask({
+ *     id: 'test-job',
+ *     schedule: cron => cron.every(2).minutes(),
+ *     execute: async ({ injector, scheduledContext, params }) => {
+ *         // some logic here
+ *     },
+ * });
+ * ```
+ *
+ * @since 3.3.0
+ * @docsCategory scheduled-tasks
+ * @docsPage ScheduledTask
+ * @docsWeight 0
+ */
+class ScheduledTask {
+    constructor(config) {
+        this.config = config;
+    }
+    get id() {
+        return this.config.id;
+    }
+    get options() {
+        return this.config;
+    }
+    async execute(injector) {
+        var _a;
+        const requestContextService = injector.get(request_context_service_1.RequestContextService);
+        const channelService = injector.get(channel_service_1.ChannelService);
+        const defaultChannel = await channelService.getDefaultChannel();
+        const scheduledContext = await requestContextService.create({
+            apiType: 'admin',
+            channelOrToken: defaultChannel,
+        });
+        return this.config.execute({
+            injector,
+            scheduledContext,
+            params: (_a = this.config.params) !== null && _a !== void 0 ? _a : {},
+        });
+    }
+    /**
+     * @description
+     * This method allows you to further configure existing scheduled tasks. For example, you may
+     * wish to change the schedule or timeout of a task, without having to define a new task.
+     *
+     * @example
+     * ```ts
+     * import { ScheduledTask } from '\@vendure/core';
+     *
+     * const task = new ScheduledTask({
+     *     id: 'test-job',
+     *     schedule: cron => cron.every(2).minutes(),
+     *     execute: async ({ injector, scheduledContext, params }) => {
+     *         // some logic here
+     *     },
+     * });
+     *
+     * // later, you can configure the task
+     * task.configure({ schedule: cron => cron.every(5).minutes() });
+     * ```
+     */
+    configure(additionalConfig) {
+        if (additionalConfig.schedule) {
+            this.config.schedule = additionalConfig.schedule;
+        }
+        if (additionalConfig.timeout) {
+            this.config.timeout = additionalConfig.timeout;
+        }
+        if (additionalConfig.params) {
+            this.config.params = additionalConfig.params;
+        }
+        return this;
+    }
+}
+exports.ScheduledTask = ScheduledTask;
+//# sourceMappingURL=scheduled-task.js.map

package/dist/scheduler/scheduled-task.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduled-task.js","sourceRoot":"","sources":["../../src/scheduler/scheduled-task.ts"],"names":[],"mappings":";;;AAIA,wGAAmG;AACnG,yEAAqE;AA4FrE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,aAAa;IACtB,YAA6B,MAA8B;QAA9B,WAAM,GAAN,MAAM,CAAwB;IAAG,CAAC;IAE/D,IAAI,EAAE;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;IAC1B,CAAC;IAED,IAAI,OAAO;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,QAAkB;;QAC5B,MAAM,qBAAqB,GAAG,QAAQ,CAAC,GAAG,CAAC,+CAAqB,CAAC,CAAC;QAClE,MAAM,cAAc,GAAG,QAAQ,CAAC,GAAG,CAAC,gCAAc,CAAC,CAAC;QACpD,MAAM,cAAc,GAAG,MAAM,cAAc,CAAC,iBAAiB,EAAE,CAAC;QAEhE,MAAM,gBAAgB,GAAG,MAAM,qBAAqB,CAAC,MAAM,CAAC;YACxD,OAAO,EAAE,OAAO;YAChB,cAAc,EAAE,cAAc;SACjC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;YACvB,QAAQ;YACR,gBAAgB;YAChB,MAAM,EAAE,MAAA,IAAI,CAAC,MAAM,CAAC,MAAM,mCAAK,EAAU;SAC5C,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,SAAS,CAAC,gBAA0F;QAChG,IAAI,gBAAgB,CAAC,QAAQ,EAAE,CAAC;YAC5B,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,gBAAgB,CAAC,QAAQ,CAAC;QACrD,CAAC;QACD,IAAI,gBAAgB,CAAC,OAAO,EAAE,CAAC;YAC3B,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG,gBAAgB,CAAC,OAAO,CAAC;QACnD,CAAC;QACD,IAAI,gBAAgB,CAAC,MAAM,EAAE,CAAC;YAC1B,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC;QACjD,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AA7DD,sCA6DC"}

package/dist/scheduler/scheduler-strategy.d.ts

@@ -0,0 +1,91 @@
+import { UpdateScheduledTaskInput } from '@vendure/common/lib/generated-types';
+import { Cron } from 'croner';
+import { InjectableStrategy } from '../common';
+import { ScheduledTask } from './scheduled-task';
+/**
+ * @description
+ * A report on the status of a scheduled task.
+ *
+ * @since 3.3.0
+ * @docsCategory scheduled-tasks
+ * @docsPage SchedulerStrategy
+ */
+export interface TaskReport {
+    id: string;
+    lastExecutedAt: Date | null;
+    isRunning: boolean;
+    lastResult: any;
+    enabled: boolean;
+}
+/**
+ * @description
+ * This strategy is used to define the mechanism by which scheduled tasks are executed
+ * and how they are reported on. The main purpose of this strategy is to ensure
+ * that a given task is executed exactly once at the scheduled time, even if there
+ * are multiple instances of the worker running.
+ *
+ * To do this, the strategy must use some form of shared storage and a method of
+ * locking so that only a single worker is allowed to execute the task.
+ *
+ * By default, the {@link DefaultSchedulerStrategy} will use the database to enable
+ * this functionality.
+ *
+ * @since 3.3.0
+ * @docsCategory scheduled-tasks
+ * @docsPage SchedulerStrategy
+ * @docsWeight 0
+ */
+export interface SchedulerStrategy extends InjectableStrategy {
+    /**
+     * @description
+     * An optional method that may be used by the strategy to register all the configured
+     * tasks ahead of time. This can be useful for keeping an internal reference of
+     * all the tasks to aid in the specific strategy implemetation.
+     */
+    registerTask?(task: ScheduledTask): void;
+    /**
+     * @description
+     * Execute a scheduled task. This method must also take care of
+     * ensuring that the task is executed exactly once at the scheduled time,
+     * even if there are multiple instances of the worker running.
+     *
+     * For instance, in the {@link DefaultSchedulerStrategy} we make use of a
+     * dedicated database table and a locking mechansim. If you implement a custom
+     * SchedulerStrategy, you must use some other form of shared locking mechanism
+     * that could make use of something like Redis etc. to ensure that the task
+     * is executed exactly once at the scheduled time.
+     *
+     * The function returned is then called in order to execture the task. The
+     * `job` argument is an instance of the croner `Cron` class, except when
+     * the task has been manually triggered, in which case it will be undefined.
+     */
+    executeTask(task: ScheduledTask): (job?: Cron) => Promise<any> | any;
+    /**
+     * @description
+     * Get all scheduled tasks.
+     */
+    getTasks(): Promise<TaskReport[]>;
+    /**
+     * @description
+     * Get a single scheduled task by its id.
+     */
+    getTask(id: string): Promise<TaskReport | undefined>;
+    /**
+     * @description
+     * Manually trigger a given task. This method is not used to actually invoke the
+     * task function itself, since that would cause the task to run on the server
+     * instance which we typically do not want. Instead, it should be used
+     * to signal to the strategy that this specific task needs to be invoked
+     * at the soonest opportunity.
+     *
+     * For instance, in the {@link DefaultSchedulerStrategy} this is done by setting
+     * a flag in the database table which is checked periodically and causes those tasks
+     * to get immediately invoked.
+     */
+    triggerTask(task: ScheduledTask): Promise<void>;
+    /**
+     * @description
+     * Update a scheduled task.
+     */
+    updateTask(input: UpdateScheduledTaskInput): Promise<TaskReport>;
+}

package/dist/scheduler/scheduler-strategy.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=scheduler-strategy.js.map

package/dist/scheduler/scheduler-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduler-strategy.js","sourceRoot":"","sources":["../../src/scheduler/scheduler-strategy.ts"],"names":[],"mappings":""}

package/dist/scheduler/scheduler.module.d.ts

@@ -0,0 +1,2 @@
+export declare class SchedulerModule {
+}

package/dist/scheduler/scheduler.module.js

@@ -0,0 +1,23 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchedulerModule = void 0;
+const common_1 = require("@nestjs/common");
+const index_1 = require("../config/index");
+const scheduler_service_1 = require("./scheduler.service");
+let SchedulerModule = class SchedulerModule {
+};
+exports.SchedulerModule = SchedulerModule;
+exports.SchedulerModule = SchedulerModule = __decorate([
+    (0, common_1.Module)({
+        imports: [index_1.ConfigModule],
+        providers: [scheduler_service_1.SchedulerService],
+        exports: [scheduler_service_1.SchedulerService],
+    })
+], SchedulerModule);
+//# sourceMappingURL=scheduler.module.js.map

package/dist/scheduler/scheduler.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduler.module.js","sourceRoot":"","sources":["../../src/scheduler/scheduler.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAwC;AAExC,2CAA+C;AAE/C,2DAAuD;AAOhD,IAAM,eAAe,GAArB,MAAM,eAAe;CAAG,CAAA;AAAlB,0CAAe;0BAAf,eAAe;IAL3B,IAAA,eAAM,EAAC;QACJ,OAAO,EAAE,CAAC,oBAAY,CAAC;QACvB,SAAS,EAAE,CAAC,oCAAgB,CAAC;QAC7B,OAAO,EAAE,CAAC,oCAAgB,CAAC;KAC9B,CAAC;GACW,eAAe,CAAG"}

package/dist/scheduler/scheduler.service.d.ts

@@ -0,0 +1,40 @@
+import { OnApplicationBootstrap, OnApplicationShutdown } from '@nestjs/common';
+import { Success, UpdateScheduledTaskInput } from '@vendure/common/lib/generated-types';
+import { ConfigService } from '../config/config.service';
+import { ProcessContext } from '../process-context';
+export interface TaskInfo {
+    id: string;
+    description: string;
+    schedule: string;
+    scheduleDescription: string;
+    lastExecutedAt: Date | null;
+    nextExecutionAt: Date | null;
+    isRunning: boolean;
+    lastResult: any;
+    enabled: boolean;
+}
+/**
+ * @description
+ * The service that is responsible for setting up and querying the scheduled tasks.
+ *
+ * @since 3.3.0
+ * @docsCategory scheduled-tasks
+ */
+export declare class SchedulerService implements OnApplicationBootstrap, OnApplicationShutdown {
+    private readonly configService;
+    private readonly processContext;
+    private readonly jobs;
+    private shouldRunTasks;
+    constructor(configService: ConfigService, processContext: ProcessContext);
+    onApplicationBootstrap(): void;
+    onApplicationShutdown(signal?: string): void;
+    /**
+     * @description
+     * Returns a list of all the scheduled tasks and their current status.
+     */
+    getTaskList(): Promise<TaskInfo[]>;
+    updateTask(input: UpdateScheduledTaskInput): Promise<TaskInfo>;
+    runTask(taskId: string): Promise<Success>;
+    private createTaskInfo;
+    private createCronJob;
+}

package/dist/scheduler/scheduler.service.js

@@ -0,0 +1,160 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchedulerService = void 0;
+const common_1 = require("@nestjs/common");
+const cron_time_generator_1 = __importDefault(require("cron-time-generator"));
+const croner_1 = require("croner");
+const cronstrue_1 = __importDefault(require("cronstrue"));
+const config_service_1 = require("../config/config.service");
+const vendure_logger_1 = require("../config/logger/vendure-logger");
+const process_context_1 = require("../process-context");
+const noop_scheduler_strategy_1 = require("./noop-scheduler-strategy");
+/**
+ * @description
+ * The service that is responsible for setting up and querying the scheduled tasks.
+ *
+ * @since 3.3.0
+ * @docsCategory scheduled-tasks
+ */
+let SchedulerService = class SchedulerService {
+    constructor(configService, processContext) {
+        this.configService = configService;
+        this.processContext = processContext;
+        this.jobs = new Map();
+        this.shouldRunTasks = false;
+    }
+    onApplicationBootstrap() {
+        var _a, _b;
+        const schedulerStrategy = this.configService.schedulerOptions.schedulerStrategy;
+        if (!schedulerStrategy || schedulerStrategy instanceof noop_scheduler_strategy_1.NoopSchedulerStrategy) {
+            vendure_logger_1.Logger.warn('No scheduler strategy is configured! Scheduled tasks will not be executed.');
+            vendure_logger_1.Logger.warn('Please use the `DefaultSchedulerPlugin` (or alternative) to enable scheduled tasks.');
+            return;
+        }
+        this.shouldRunTasks =
+            this.configService.schedulerOptions.runTasksInWorkerOnly === false ||
+                this.processContext.isWorker;
+        const scheduledTasks = (_a = this.configService.schedulerOptions.tasks) !== null && _a !== void 0 ? _a : [];
+        for (const task of scheduledTasks) {
+            const job = this.createCronJob(task);
+            const pattern = job.getPattern();
+            if (!pattern) {
+                vendure_logger_1.Logger.warn(`Invalid cron pattern for task ${task.id}`);
+            }
+            else {
+                if (this.shouldRunTasks) {
+                    const schedule = cronstrue_1.default.toString(pattern);
+                    vendure_logger_1.Logger.info(`Registered scheduled task: ${task.id} - ${schedule}`);
+                }
+                this.jobs.set(task.id, { task, job });
+            }
+            (_b = schedulerStrategy.registerTask) === null || _b === void 0 ? void 0 : _b.call(schedulerStrategy, task);
+        }
+    }
+    onApplicationShutdown(signal) {
+        for (const job of this.jobs.values()) {
+            job.job.stop();
+        }
+    }
+    /**
+     * @description
+     * Returns a list of all the scheduled tasks and their current status.
+     */
+    getTaskList() {
+        return this.configService.schedulerOptions.schedulerStrategy
+            .getTasks()
+            .then(taskReports => taskReports.map(taskReport => this.createTaskInfo(taskReport)).filter(x => x !== undefined));
+    }
+    updateTask(input) {
+        return this.configService.schedulerOptions.schedulerStrategy.updateTask(input).then(taskReport => {
+            const taskInfo = this.createTaskInfo(taskReport);
+            if (!taskInfo) {
+                throw new Error(`Task ${input.id} not found`);
+            }
+            return taskInfo;
+        });
+    }
+    async runTask(taskId) {
+        const task = this.jobs.get(taskId);
+        if (!task) {
+            return {
+                success: false,
+            };
+        }
+        try {
+            await this.configService.schedulerOptions.schedulerStrategy.triggerTask(task.task);
+            return {
+                success: true,
+            };
+        }
+        catch (e) {
+            vendure_logger_1.Logger.error(`Could not trigger task: ` + e.message);
+            return {
+                success: false,
+            };
+        }
+    }
+    createTaskInfo(taskReport) {
+        var _a, _b, _c;
+        const job = (_a = this.jobs.get(taskReport.id)) === null || _a === void 0 ? void 0 : _a.job;
+        const task = (_b = this.jobs.get(taskReport.id)) === null || _b === void 0 ? void 0 : _b.task;
+        if (!job || !task) {
+            return;
+        }
+        const pattern = job.getPattern();
+        return {
+            id: taskReport.id,
+            description: (_c = task.options.description) !== null && _c !== void 0 ? _c : '',
+            schedule: pattern !== null && pattern !== void 0 ? pattern : 'unknown',
+            scheduleDescription: pattern ? cronstrue_1.default.toString(pattern) : 'unknown',
+            lastExecutedAt: taskReport.lastExecutedAt,
+            nextExecutionAt: job.nextRun(),
+            isRunning: taskReport.isRunning,
+            lastResult: taskReport.lastResult,
+            enabled: taskReport.enabled,
+        };
+    }
+    createCronJob(task) {
+        const schedulerStrategy = this.configService.schedulerOptions.schedulerStrategy;
+        const protectCallback = (_job) => {
+            const currentRun = _job.currentRun();
+            if (currentRun) {
+                vendure_logger_1.Logger.warn(`Task invocation of ${task.id} at ${new Date().toISOString()} was blocked because an existing task is still running at ${currentRun.toISOString()}`);
+            }
+        };
+        const schedule = typeof task.options.schedule === 'function'
+            ? task.options.schedule(cron_time_generator_1.default)
+            : task.options.schedule;
+        const job = new croner_1.Cron(schedule, {
+            name: task.id,
+            protect: task.options.preventOverlap ? protectCallback : undefined,
+        }, () => {
+            if (this.shouldRunTasks) {
+                // Only execute the cron task on the worker process
+                // so that any expensive logic does not affect
+                // the responsiveness of server processes
+                schedulerStrategy.executeTask(task)(job);
+            }
+        });
+        return job;
+    }
+};
+exports.SchedulerService = SchedulerService;
+exports.SchedulerService = SchedulerService = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [config_service_1.ConfigService,
+        process_context_1.ProcessContext])
+], SchedulerService);
+//# sourceMappingURL=scheduler.service.js.map

package/dist/scheduler/scheduler.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduler.service.js","sourceRoot":"","sources":["../../src/scheduler/scheduler.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAA2F;AAE3F,8EAA2C;AAC3C,mCAA8B;AAC9B,0DAAkC;AAElC,6DAAyD;AACzD,oEAAyD;AACzD,wDAAoD;AAEpD,uEAAkE;AAgBlE;;;;;;GAMG;AAEI,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;IAGzB,YACqB,aAA4B,EAC5B,cAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAe;QAC5B,mBAAc,GAAd,cAAc,CAAgB;QAJlC,SAAI,GAAoD,IAAI,GAAG,EAAE,CAAC;QAC3E,mBAAc,GAAG,KAAK,CAAC;IAI5B,CAAC;IAEJ,sBAAsB;;QAClB,MAAM,iBAAiB,GAAG,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,iBAAiB,CAAC;QAChF,IAAI,CAAC,iBAAiB,IAAI,iBAAiB,YAAY,+CAAqB,EAAE,CAAC;YAC3E,uBAAM,CAAC,IAAI,CAAC,4EAA4E,CAAC,CAAC;YAC1F,uBAAM,CAAC,IAAI,CACP,qFAAqF,CACxF,CAAC;YACF,OAAO;QACX,CAAC;QACD,IAAI,CAAC,cAAc;YACf,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,oBAAoB,KAAK,KAAK;gBAClE,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;QACjC,MAAM,cAAc,GAAG,MAAA,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,KAAK,mCAAI,EAAE,CAAC;QAEvE,KAAK,MAAM,IAAI,IAAI,cAAc,EAAE,CAAC;YAChC,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YACrC,MAAM,OAAO,GAAG,GAAG,CAAC,UAAU,EAAE,CAAC;YACjC,IAAI,CAAC,OAAO,EAAE,CAAC;gBACX,uBAAM,CAAC,IAAI,CAAC,iCAAiC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;YAC5D,CAAC;iBAAM,CAAC;gBACJ,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;oBACtB,MAAM,QAAQ,GAAG,mBAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;oBAC7C,uBAAM,CAAC,IAAI,CAAC,8BAA8B,IAAI,CAAC,EAAE,MAAM,QAAQ,EAAE,CAAC,CAAC;gBACvE,CAAC;gBACD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;YAC1C,CAAC;YACD,MAAA,iBAAiB,CAAC,YAAY,kEAAG,IAAI,CAAC,CAAC;QAC3C,CAAC;IACL,CAAC;IAED,qBAAqB,CAAC,MAAe;QACjC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;YACnC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QACnB,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,WAAW;QACP,OAAO,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,iBAAiB;aACvD,QAAQ,EAAE;aACV,IAAI,CAAC,WAAW,CAAC,EAAE,CAChB,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAC9F,CAAC;IACV,CAAC;IAED,UAAU,CAAC,KAA+B;QACtC,OAAO,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YAC7F,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;YACjD,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CAAC,QAAQ,KAAK,CAAC,EAAE,YAAY,CAAC,CAAC;YAClD,CAAC;YACD,OAAO,QAAQ,CAAC;QACpB,CAAC,CAAC,CAAC;IACP,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,MAAc;QACxB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACnC,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,OAAO;gBACH,OAAO,EAAE,KAAK;aACjB,CAAC;QACN,CAAC;QACD,IAAI,CAAC;YACD,MAAM,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnF,OAAO;gBACH,OAAO,EAAE,IAAI;aAChB,CAAC;QACN,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YACd,uBAAM,CAAC,KAAK,CAAC,0BAA0B,GAAI,CAAC,CAAC,OAAkB,CAAC,CAAC;YACjE,OAAO;gBACH,OAAO,EAAE,KAAK;aACjB,CAAC;QACN,CAAC;IACL,CAAC;IAEO,cAAc,CAAC,UAAsB;;QACzC,MAAM,GAAG,GAAG,MAAA,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,0CAAE,GAAG,CAAC;QAC9C,MAAM,IAAI,GAAG,MAAA,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,0CAAE,IAAI,CAAC;QAChD,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YAChB,OAAO;QACX,CAAC;QAED,MAAM,OAAO,GAAG,GAAG,CAAC,UAAU,EAAE,CAAC;QACjC,OAAO;YACH,EAAE,EAAE,UAAU,CAAC,EAAE;YACjB,WAAW,EAAE,MAAA,IAAI,CAAC,OAAO,CAAC,WAAW,mCAAI,EAAE;YAC3C,QAAQ,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,SAAS;YAC9B,mBAAmB,EAAE,OAAO,CAAC,CAAC,CAAC,mBAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;YACtE,cAAc,EAAE,UAAU,CAAC,cAAc;YACzC,eAAe,EAAE,GAAG,CAAC,OAAO,EAAE;YAC9B,SAAS,EAAE,UAAU,CAAC,SAAS;YAC/B,UAAU,EAAE,UAAU,CAAC,UAAU;YACjC,OAAO,EAAE,UAAU,CAAC,OAAO;SAC9B,CAAC;IACN,CAAC;IAEO,aAAa,CAAC,IAAmB;QACrC,MAAM,iBAAiB,GAAG,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,iBAAiB,CAAC;QAChF,MAAM,eAAe,GAAG,CAAC,IAAU,EAAE,EAAE;YACnC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;YACrC,IAAI,UAAU,EAAE,CAAC;gBACb,uBAAM,CAAC,IAAI,CACP,sBAAsB,IAAI,CAAC,EAAE,OAAO,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,6DAA6D,UAAU,CAAC,WAAW,EAAE,EAAE,CACtJ,CAAC;YACN,CAAC;QACL,CAAC,CAAC;QAEF,MAAM,QAAQ,GACV,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,UAAU;YACvC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,6BAAQ,CAAC;YACjC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QAEhC,MAAM,GAAG,GAAG,IAAI,aAAI,CAChB,QAAQ,EACR;YACI,IAAI,EAAE,IAAI,CAAC,EAAE;YACb,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS;SACrE,EACD,GAAG,EAAE;YACD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBACtB,mDAAmD;gBACnD,8CAA8C;gBAC9C,yCAAyC;gBACzC,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;YAC7C,CAAC;QACL,CAAC,CACJ,CAAC;QAEF,OAAO,GAAG,CAAC;IACf,CAAC;CACJ,CAAA;AA7IY,4CAAgB;2BAAhB,gBAAgB;IAD5B,IAAA,mBAAU,GAAE;qCAK2B,8BAAa;QACZ,gCAAc;GAL1C,gBAAgB,CA6I5B"}

package/dist/scheduler/tasks/clean-sessions-task.d.ts

@@ -0,0 +1,37 @@
+import { ScheduledTask } from '../scheduled-task';
+/**
+ * @description
+ * A {@link ScheduledTask} that cleans expired & inactive sessions from the database.
+ *
+ * @example
+ * ```ts
+ * import { cleanSessionsTask, VendureConfig } from '\@vendure/core';
+ *
+ * export const config: VendureConfig = {
+ *   // ...
+ *   schedulerOptions: {
+ *     tasks: [
+ *       // Use the task as is
+ *       cleanSessionsTask,
+ *       // or configure the task
+ *       cleanSessionsTask.configure({
+ *         // Run the task every day at 3:00am
+ *         // The default schedule is every day at 00:00am
+ *         schedule: cron => cron.everyDayAt(3, 0),
+ *         params: {
+ *           // How many sessions to process in each batch
+ *           // Default: 1000
+ *           batchSize: 5_000,
+ *         },
+ *       }),
+ *     ],
+ *   },
+ * };
+ * ```
+ *
+ * @since 3.3.0
+ * @docsCategory scheduled-tasks
+ */
+export declare const cleanSessionsTask: ScheduledTask<{
+    batchSize: number;
+}>;

package/dist/scheduler/tasks/clean-sessions-task.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cleanSessionsTask = void 0;
+const session_service_1 = require("../../service/services/session.service");
+const scheduled_task_1 = require("../scheduled-task");
+/**
+ * @description
+ * A {@link ScheduledTask} that cleans expired & inactive sessions from the database.
+ *
+ * @example
+ * ```ts
+ * import { cleanSessionsTask, VendureConfig } from '\@vendure/core';
+ *
+ * export const config: VendureConfig = {
+ *   // ...
+ *   schedulerOptions: {
+ *     tasks: [
+ *       // Use the task as is
+ *       cleanSessionsTask,
+ *       // or configure the task
+ *       cleanSessionsTask.configure({
+ *         // Run the task every day at 3:00am
+ *         // The default schedule is every day at 00:00am
+ *         schedule: cron => cron.everyDayAt(3, 0),
+ *         params: {
+ *           // How many sessions to process in each batch
+ *           // Default: 1000
+ *           batchSize: 5_000,
+ *         },
+ *       }),
+ *     ],
+ *   },
+ * };
+ * ```
+ *
+ * @since 3.3.0
+ * @docsCategory scheduled-tasks
+ */
+exports.cleanSessionsTask = new scheduled_task_1.ScheduledTask({
+    id: 'clean-sessions',
+    description: 'Clean expired & inactive sessions from the database',
+    params: {
+        batchSize: 1000,
+    },
+    schedule: cron => cron.everyDayAt(0, 0),
+    async execute({ injector, params }) {
+        const sessionService = injector.get(session_service_1.SessionService);
+        await sessionService.triggerCleanSessionsJob(params.batchSize);
+        return { result: 'Triggered clean sessions job' };
+    },
+});
+//# sourceMappingURL=clean-sessions-task.js.map

package/dist/scheduler/tasks/clean-sessions-task.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clean-sessions-task.js","sourceRoot":"","sources":["../../../src/scheduler/tasks/clean-sessions-task.ts"],"names":[],"mappings":";;;AAAA,4EAAwE;AACxE,sDAAkD;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACU,QAAA,iBAAiB,GAAG,IAAI,8BAAa,CAAC;IAC/C,EAAE,EAAE,gBAAgB;IACpB,WAAW,EAAE,qDAAqD;IAClE,MAAM,EAAE;QACJ,SAAS,EAAE,IAAI;KAClB;IACD,QAAQ,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC;IACvC,KAAK,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE;QAC9B,MAAM,cAAc,GAAG,QAAQ,CAAC,GAAG,CAAC,gCAAc,CAAC,CAAC;QACpD,MAAM,cAAc,CAAC,uBAAuB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC/D,OAAO,EAAE,MAAM,EAAE,8BAA8B,EAAE,CAAC;IACtD,CAAC;CACJ,CAAC,CAAC"}