@orion-js/dogs 3.11.15 → 3.12.0

package/dist/index.d.ts

@@ -0,0 +1,215 @@
+// Generated by dts-bundle-generator v9.5.1
+
+import { OrionLogger } from '@orion-js/logger';
+import { ModelToDocumentTypeWithoutId } from '@orion-js/mongodb';
+
+export type Blackbox = {
+	[name: string]: any;
+};
+export interface JobToRun {
+	jobId: string;
+	executionId: string;
+	name: string;
+	type: "event" | "recurrent";
+	params: Blackbox;
+	tries: number;
+	lockTime: number;
+	priority: number;
+	uniqueIdentifier?: string;
+}
+export interface ExecutionContext {
+	record: JobToRun;
+	definition: JobDefinition;
+	tries: number;
+	logger: OrionLogger;
+	extendLockTime: (extraTime: number) => Promise<void>;
+	clearStaleTimeout: () => void;
+}
+export interface WorkerInstance {
+	running: boolean;
+	workerIndex: number;
+	stop: () => Promise<void>;
+	respawn: () => Promise<void>;
+	promise?: Promise<any>;
+}
+export interface WorkersInstance {
+	running: boolean;
+	workersCount: number;
+	workers: WorkerInstance[];
+	/**
+	 * Stop all workers and wait for them to finish
+	 */
+	stop: () => Promise<void>;
+}
+export interface JobRetryResultBase {
+	action: "retry" | "dismiss";
+}
+export type JobRetryResultRunIn = JobRetryResultBase & {
+	runIn: number;
+};
+export type JobRetryResultRunAt = JobRetryResultBase & {
+	runAt: Date;
+};
+export type JobRetryResult = JobRetryResultRunIn | JobRetryResultRunAt | JobRetryResultBase;
+export interface BaseJobDefinition {
+	/**
+	 * The function to execute when the job is executed.
+	 */
+	resolve: (params: Blackbox, context: ExecutionContext) => Promise<Blackbox | void>;
+	/**
+	 * Called if the job fails.
+	 */
+	onError?: (error: Error, params: Blackbox, context: ExecutionContext) => Promise<JobRetryResult>;
+	/**
+	 * Called if the job locktime is expired. The job will be executed again.
+	 */
+	onStale?: (params: Blackbox, context: ExecutionContext) => Promise<void>;
+	/**
+	 * Save the executions of the job time in milliseconds. Default is 1 week. Set to 0 to disable.
+	 */
+	saveExecutionsFor?: number;
+}
+export interface RecurrentJobDefinition extends BaseJobDefinition {
+	/**
+	 * Type of the job.
+	 */
+	type: "recurrent";
+	/**
+	 * A function executed after each execution that returns the date of the next run.
+	 */
+	getNextRun?: () => Date;
+	/**
+	 * Run every x milliseconds. This will be ignored if getNextRun is defined.
+	 */
+	runEvery?: number;
+	/**
+	 * The priority of the job. Higher is more priority. Default is 100.
+	 */
+	priority?: number;
+}
+export interface EventJobDefinition extends BaseJobDefinition {
+	/**
+	 * Type of the job.
+	 */
+	type: "event";
+}
+export type JobDefinition = RecurrentJobDefinition | EventJobDefinition;
+export type JobDefinitionWithName = JobDefinition & {
+	name: string;
+};
+export interface JobsDefinition {
+	[jobName: string]: JobDefinition;
+}
+export declare const defineJob: (options: JobDefinition) => JobDefinition;
+export type LogLevels = "debug" | "info" | "warn" | "error" | "none";
+export interface StartWorkersConfig {
+	/**
+	 * Object map of the jobs that this workers will execute
+	 */
+	jobs: JobsDefinition;
+	/**
+	 * Time in milliseconds to wait between each look without results for a job
+	 * to run at the database. Default is 3000.
+	 */
+	pollInterval: number;
+	/**
+	 * Time in milliseconds to wait too look for a job after a job execution. Default is 100.
+	 */
+	cooldownPeriod: number;
+	/**
+	 * Number of workers to start. Default is 1.
+	 */
+	workersCount: number;
+	/**
+	 * Time in milliseconds to lock a job for execution. Default is 30000 (30 seconds).
+	 * If a job is locked for longer than this time, it will be considered as failed.
+	 * This is to prevent a job from being executed multiple times at the same time.
+	 * You can extend this time inside a job by calling extendLockTime from context.
+	 */
+	lockTime: number;
+}
+export interface ScheduleJobOptionsBase {
+	name: string;
+	params?: Blackbox;
+	priority?: number;
+	uniqueIdentifier?: string;
+}
+export type ScheduleJobOptionsRunIn = ScheduleJobOptionsBase & {
+	runIn: number;
+};
+export type ScheduleJobOptionsRunAt = ScheduleJobOptionsBase & {
+	runAt: Date;
+};
+export type ScheduleJobOptions = ScheduleJobOptionsRunIn | ScheduleJobOptionsRunAt | ScheduleJobOptionsBase;
+export interface ScheduleJobRecordOptions {
+	name: string;
+	params: Blackbox;
+	nextRunAt: Date;
+	priority: number;
+	uniqueIdentifier?: string;
+}
+export declare class HistoryRecord {
+	_id: string;
+	jobId: string;
+	executionId: string;
+	jobName: string;
+	type: "recurrent" | "event";
+	priority: number;
+	tries: number;
+	uniqueIdentifier?: string;
+	startedAt: Date;
+	endedAt: Date;
+	duration: number;
+	expiresAt?: Date;
+	status: "success" | "error" | "stale";
+	errorMessage?: string;
+	params?: Blackbox;
+	result?: Blackbox;
+}
+declare class JobsHistoryRepo {
+	history: () => import("@orion-js/mongodb").Collection<HistoryRecord>;
+	saveExecution(record: ModelToDocumentTypeWithoutId<HistoryRecord>): Promise<void>;
+	getExecutions(jobName: string, limit?: number, skip?: number): Promise<HistoryRecord[]>;
+}
+export declare class JobRecord {
+	_id: string;
+	jobName: string;
+	type: "recurrent" | "event";
+	priority: number;
+	uniqueIdentifier?: string;
+	nextRunAt: Date;
+	lastRunAt?: Date;
+	lockedUntil?: Date;
+	tries?: number;
+	params?: any;
+}
+declare class JobsRepo {
+	jobs: () => import("@orion-js/mongodb").Collection<JobRecord>;
+	getJobAndLock(jobNames: string[], lockTime: number): Promise<JobToRun>;
+	setJobRecordPriority(jobId: string, priority: number): Promise<void>;
+	scheduleNextRun(options: {
+		jobId: string;
+		nextRunAt: Date;
+		addTries: boolean;
+		priority: number;
+	}): Promise<void>;
+	deleteEventJob(jobId: string): Promise<void>;
+	extendLockTime(jobId: string, extraTime: number): Promise<void>;
+	ensureJobRecord(job: JobDefinitionWithName): Promise<void>;
+	scheduleJob(options: ScheduleJobRecordOptions): Promise<void>;
+}
+export declare function Jobs(): ClassDecorator;
+export interface JobsPropertyDescriptor extends Omit<PropertyDecorator, "value"> {
+	value?: JobDefinition["resolve"];
+}
+export declare function RecurrentJob(options: Omit<RecurrentJobDefinition, "resolve" | "type">): (target: any, propertyKey: string, descriptor: JobsPropertyDescriptor) => void;
+export declare function EventJob(options?: Omit<EventJobDefinition, "resolve" | "type">): (target: any, propertyKey: string, descriptor: JobsPropertyDescriptor) => void;
+export declare function getServiceJobs(target: any): {
+	[key: string]: JobDefinition;
+};
+export declare const jobsHistoryRepo: JobsHistoryRepo;
+export declare const jobsRepo: JobsRepo;
+export declare const startWorkers: (config: Partial<StartWorkersConfig>) => WorkersInstance;
+export declare const scheduleJob: (options: ScheduleJobOptions) => Promise<void>;
+
+export {};