@navios/schedule 0.8.0 → 0.9.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/lib/index.cjs CHANGED
@@ -117,11 +117,11 @@ function hasScheduleMetadata(target) {
117
117
  //#region src/decorators/schedulable.decorator.mts
118
118
  /**
119
119
  * Decorator that marks a class as schedulable and makes it injectable.
120
- *
120
+ *
121
121
  * Classes decorated with `@Schedulable()` can contain methods decorated with `@Cron()`
122
122
  * that will be automatically scheduled and executed. This decorator also applies
123
123
  * the `@Injectable()` decorator, making the class available for dependency injection.
124
- *
124
+ *
125
125
  * @example
126
126
  * ```typescript
127
127
  * @Schedulable()
@@ -131,19 +131,19 @@ function hasScheduleMetadata(target) {
131
131
  * // This will run daily at midnight
132
132
  * }
133
133
  * }
134
- *
134
+ *
135
135
  * // Register the service
136
136
  * schedulerService.register(TaskService)
137
137
  * ```
138
- *
138
+ *
139
139
  * @throws {Error} If applied to something other than a class
140
- *
140
+ *
141
141
  * @public
142
- */ function Schedulable() {
142
+ */ function Schedulable({ registry } = {}) {
143
143
  return (target, context) => {
144
144
  if (context.kind !== "class") throw new Error(`SchedulableDecorator can only be applied to classes, not ${context.kind}`);
145
145
  if (context.metadata) getScheduleMetadata(target, context);
146
- return (0, _navios_core.Injectable)()(target, context);
146
+ return (0, _navios_core.Injectable)({ registry: registry ?? _navios_core.globalRegistry })(target, context);
147
147
  };
148
148
  }
149
149
 
package/lib/index.cjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.cjs","names":["newMetadata: CronMetadata","getAllCronMetadata","ScheduleMetadataKey","Symbol","getScheduleMetadata","target","context","metadata","jobsMetadata","newMetadata","name","jobs","Error","extractScheduleMetadata","hasScheduleMetadata","getCronMetadata","Cron","cronTime","options","target","context","kind","Error","metadata","disabled","Injectable","getScheduleMetadata","Schedulable","target","context","kind","Error","metadata","Schedule","Container","inject","Injectable","Logger","CronJob","extractScheduleMetadata","hasScheduleMetadata","SchedulerService","logger","context","name","container","jobs","Map","register","service","Error","metadata","debug","registerJobs","getJob","method","jobName","get","job","cronTime","classMethod","self","defaultDisabled","cronJob","from","onTick","instance","error","start","disabled","set","startAll","values","isActive","stopAll","stop"],"sources":["../src/metadata/cron.metadata.mts","../src/metadata/schedule.metadata.mts","../src/decorators/cron.decorator.mts","../src/decorators/schedulable.decorator.mts","../src/cron.constants.mts","../src/scheduler.service.mts"],"sourcesContent":["import type { CronJobParams } from 'cron'\n\nexport const CronMetadataKey = Symbol('CronMetadataKey')\n\nexport interface CronMetadata {\n classMethod: string\n cronTime: CronJobParams['cronTime'] | null\n disabled: boolean\n}\n\nexport function getAllCronMetadata(\n context: ClassMethodDecoratorContext | ClassDecoratorContext,\n): Set<CronMetadata> {\n if (context.metadata) {\n const metadata = context.metadata[CronMetadataKey] as\n | Set<CronMetadata>\n | undefined\n if (metadata) {\n return metadata\n } else {\n context.metadata[CronMetadataKey] = new Set<CronMetadata>()\n return context.metadata[CronMetadataKey] as Set<CronMetadata>\n }\n }\n throw new Error('[Navios-Schedule] Wrong environment.')\n}\n\nexport function getCronMetadata(\n target: Function,\n context: ClassMethodDecoratorContext,\n): CronMetadata {\n if (context.metadata) {\n const metadata = getAllCronMetadata(context)\n if (metadata) {\n const endpointMetadata = Array.from(metadata).find(\n (item) => item.classMethod === target.name,\n )\n if (endpointMetadata) {\n return endpointMetadata\n } else {\n const newMetadata: CronMetadata = {\n classMethod: target.name,\n cronTime: null,\n disabled: false,\n }\n metadata.add(newMetadata)\n return newMetadata\n }\n }\n }\n throw new Error('[Navios-Schedule] Wrong environment.')\n}\n","import type { ClassType } from '@navios/core'\n\nimport type { CronMetadata } from './cron.metadata.mjs'\n\nimport { getAllCronMetadata } from './cron.metadata.mjs'\n\nexport const ScheduleMetadataKey = Symbol('ControllerMetadataKey')\n\nexport interface ScheduleMetadata {\n name: string\n jobs: Set<CronMetadata>\n}\n\nexport function getScheduleMetadata(\n target: ClassType,\n context: ClassDecoratorContext,\n): ScheduleMetadata {\n if (context.metadata) {\n const metadata = context.metadata[ScheduleMetadataKey] as\n | ScheduleMetadata\n | undefined\n if (metadata) {\n return metadata\n } else {\n const jobsMetadata = getAllCronMetadata(context)\n const newMetadata: ScheduleMetadata = {\n name: target.name,\n jobs: jobsMetadata,\n }\n context.metadata[ScheduleMetadataKey] = newMetadata\n // @ts-expect-error We add a custom metadata key to the target\n target[ScheduleMetadataKey] = newMetadata\n return newMetadata\n }\n }\n throw new Error('[Navios-Schedule] Wrong environment.')\n}\n\nexport function extractScheduleMetadata(target: ClassType): ScheduleMetadata {\n // @ts-expect-error We add a custom metadata key to the target\n const metadata = target[ScheduleMetadataKey] as ScheduleMetadata | undefined\n if (!metadata) {\n throw new Error(\n '[Navios-Schedule] Controller metadata not found. Make sure to use @Controller decorator.',\n )\n }\n return metadata\n}\n\nexport function hasScheduleMetadata(target: ClassType): boolean {\n // @ts-expect-error We add a custom metadata key to the target\n const metadata = target[ScheduleMetadataKey] as ScheduleMetadata | undefined\n\n return !!metadata\n}\n","import type { CronJobParams } from 'cron'\n\nimport { getCronMetadata } from '../metadata/index.mjs'\n\n/**\n * Options for configuring a cron job.\n * \n * @public\n */\nexport interface CronOptions {\n /**\n * Whether the job should be disabled by default.\n * Disabled jobs won't start automatically but can be manually started later.\n * \n * @default false\n */\n disabled?: boolean\n}\n\n/**\n * Decorator that marks a method to run on a cron schedule.\n * \n * The method must be in a class decorated with `@Schedulable()`.\n * The method will be automatically executed according to the provided cron expression.\n * \n * @param cronTime - Cron expression (5 or 6 fields) or a pre-defined Schedule constant\n * @param options - Optional configuration for the cron job\n * \n * @example\n * ```typescript\n * @Schedulable()\n * class TaskService {\n * // Run daily at midnight\n * @Cron('0 0 * * *')\n * async dailyTask() {\n * console.log('Running daily task')\n * }\n * \n * // Use pre-defined schedule\n * @Cron(Schedule.EveryFiveMinutes)\n * async frequentTask() {\n * console.log('Running every 5 minutes')\n * }\n * \n * // Disabled job (won't start automatically)\n * @Cron('0 2 * * *', { disabled: true })\n * async maintenanceTask() {\n * console.log('Maintenance task')\n * }\n * }\n * ```\n * \n * @throws {Error} If applied to something other than a method\n * \n * @public\n */\nexport function Cron(\n cronTime: CronJobParams['cronTime'],\n options?: CronOptions,\n) {\n return (\n target: () => Promise<void>,\n context: ClassMethodDecoratorContext,\n ) => {\n if (context.kind !== 'method') {\n throw new Error(\n `Cron can only be applied to methods, not ${context.kind}`,\n )\n }\n if (context.metadata) {\n const metadata = getCronMetadata(target, context)\n metadata.cronTime = cronTime\n metadata.disabled = options?.disabled ?? false\n }\n return target\n }\n}\n","import type { ClassType } from '@navios/core'\n\nimport { Injectable } from '@navios/core'\n\nimport { getScheduleMetadata } from '../metadata/index.mjs'\n\n/**\n * Decorator that marks a class as schedulable and makes it injectable.\n * \n * Classes decorated with `@Schedulable()` can contain methods decorated with `@Cron()`\n * that will be automatically scheduled and executed. This decorator also applies\n * the `@Injectable()` decorator, making the class available for dependency injection.\n * \n * @example\n * ```typescript\n * @Schedulable()\n * class TaskService {\n * @Cron('0 0 * * *')\n * async dailyTask() {\n * // This will run daily at midnight\n * }\n * }\n * \n * // Register the service\n * schedulerService.register(TaskService)\n * ```\n * \n * @throws {Error} If applied to something other than a class\n * \n * @public\n */\nexport function Schedulable() {\n return (target: ClassType, context: ClassDecoratorContext) => {\n if (context.kind !== 'class') {\n throw new Error(\n `SchedulableDecorator can only be applied to classes, not ${context.kind}`,\n )\n }\n if (context.metadata) {\n getScheduleMetadata(target, context)\n }\n return Injectable()(target, context)\n }\n}\n","/**\n * Pre-defined cron schedule constants for common scheduling patterns.\n *\n * These constants provide convenient shortcuts for frequently used cron expressions,\n * making it easier to schedule jobs without manually writing cron expressions.\n *\n * @example\n * ```typescript\n * import { Schedule } from '@navios/schedule'\n *\n * @Schedulable()\n * class TaskService {\n * @Cron(Schedule.EveryMinute)\n * async everyMinute() {}\n *\n * @Cron(Schedule.EveryHour)\n * async hourly() {}\n *\n * @Cron(Schedule.EveryDay)\n * async daily() {}\n * }\n * ```\n *\n * @public\n */\nexport enum Schedule {\n EveryMinute = '*/1 * * * *',\n EveryFiveMinutes = '*/5 * * * *',\n EveryTenMinutes = '*/10 * * * *',\n EveryFifteenMinutes = '*/15 * * * *',\n EveryThirtyMinutes = '*/30 * * * *',\n EveryHour = '0 * * * *',\n EveryTwoHours = '0 */2 * * *',\n EveryThreeHours = '0 */3 * * *',\n EveryFourHours = '0 */4 * * *',\n EverySixHours = '0 */6 * * *',\n EveryTwelveHours = '0 */12 * * *',\n EveryDay = '0 0 * * *',\n EveryWeek = '0 0 * * 0',\n EveryMonth = '0 0 1 * *',\n}\n","import type { ClassType } from '@navios/core'\n\nimport { Container, inject, Injectable, Logger } from '@navios/core'\n\nimport { CronJob } from 'cron'\n\nimport type { ScheduleMetadata } from './metadata/index.mjs'\n\nimport {\n extractScheduleMetadata,\n hasScheduleMetadata,\n} from './metadata/index.mjs'\n\n/**\n * Service responsible for managing and executing scheduled cron jobs.\n * \n * The SchedulerService registers schedulable services decorated with `@Schedulable()`\n * and automatically starts their cron jobs based on the `@Cron()` decorator configuration.\n * \n * @example\n * ```typescript\n * import { inject, Injectable } from '@navios/core'\n * import { SchedulerService } from '@navios/schedule'\n * \n * @Injectable()\n * class AppModule {\n * private readonly scheduler = inject(SchedulerService)\n * \n * async onModuleInit() {\n * this.scheduler.register(MySchedulableService)\n * }\n * }\n * ```\n * \n * @public\n */\n@Injectable()\nexport class SchedulerService {\n private readonly logger = inject(Logger, {\n context: SchedulerService.name,\n })\n private readonly container = inject(Container)\n private readonly jobs: Map<string, CronJob> = new Map()\n\n /**\n * Registers a schedulable service and starts all its cron jobs.\n * \n * The service must be decorated with `@Schedulable()` and contain methods\n * decorated with `@Cron()` to be registered successfully.\n * \n * @param service - The schedulable service class to register\n * @throws {Error} If the service is not decorated with `@Schedulable()`\n * \n * @example\n * ```typescript\n * @Schedulable()\n * class TaskService {\n * @Cron('0 0 * * *')\n * async dailyTask() {\n * // Runs daily at midnight\n * }\n * }\n * \n * schedulerService.register(TaskService)\n * ```\n * \n * @public\n */\n register(service: ClassType) {\n if (!hasScheduleMetadata(service)) {\n throw new Error(\n `[Navios-Schedule] Service ${service.name} is not schedulable. Make sure to use @Schedulable decorator.`,\n )\n }\n const metadata = extractScheduleMetadata(service)\n this.logger.debug('Scheduling service', metadata.name)\n this.registerJobs(service, metadata)\n }\n\n /**\n * Retrieves a specific cron job instance for a method in a schedulable service.\n * \n * @param service - The schedulable service class\n * @param method - The name of the method decorated with `@Cron()`\n * @returns The CronJob instance if found, undefined otherwise\n * \n * @example\n * ```typescript\n * const job = schedulerService.getJob(TaskService, 'dailyTask')\n * if (job) {\n * console.log('Job is active:', job.isActive)\n * job.start() // Manually start the job\n * job.stop() // Manually stop the job\n * }\n * ```\n * \n * @public\n */\n getJob<T extends ClassType>(\n service: T,\n method: keyof InstanceType<T>,\n ): CronJob | undefined {\n const metadata = extractScheduleMetadata(service)\n const jobName = `${metadata.name}.${method as string}()`\n return this.jobs.get(jobName)\n }\n\n private registerJobs(service: ClassType, metadata: ScheduleMetadata) {\n const jobs = metadata.jobs\n for (const job of jobs) {\n if (!job.cronTime) {\n this.logger.debug('Skipping job', job.classMethod)\n continue\n }\n const name = `${metadata.name}.${job.classMethod}()`\n const self = this\n const defaultDisabled = false\n const cronJob = CronJob.from({\n cronTime: job.cronTime,\n name,\n async onTick() {\n try {\n self.logger.debug('Executing job', name)\n const instance = await self.container.get(service)\n await instance[job.classMethod]()\n } catch (error) {\n self.logger.error('Error executing job', name, error)\n }\n },\n start: !(defaultDisabled || job.disabled),\n })\n this.jobs.set(name, cronJob)\n }\n }\n\n /**\n * Starts all registered cron jobs that are currently inactive.\n * \n * Only jobs that are not already active will be started. This method\n * is useful for resuming all jobs after calling `stopAll()`.\n * \n * @example\n * ```typescript\n * // Stop all jobs\n * schedulerService.stopAll()\n * \n * // Later, resume all jobs\n * schedulerService.startAll()\n * ```\n * \n * @public\n */\n startAll() {\n for (const job of this.jobs.values()) {\n if (job.isActive) {\n continue\n }\n job.start()\n }\n }\n\n /**\n * Stops all registered cron jobs that are currently active.\n * \n * Only jobs that are currently active will be stopped. This method\n * is useful for pausing all scheduled tasks, for example during\n * application shutdown or maintenance.\n * \n * @example\n * ```typescript\n * // Pause all scheduled jobs\n * schedulerService.stopAll()\n * \n * // Jobs can be resumed later with startAll()\n * schedulerService.startAll()\n * ```\n * \n * @public\n */\n stopAll() {\n for (const job of this.jobs.values()) {\n if (!job.isActive) {\n continue\n }\n job.stop()\n }\n }\n}\n"],"mappings":";;;;AAEA,MAAa,kBAAkB,OAAO,kBAAkB;AAQxD,SAAgB,mBACd,SACmB;AACnB,KAAI,QAAQ,UAAU;EACpB,MAAM,WAAW,QAAQ,SAAS;AAGlC,MAAI,SACF,QAAO;OACF;AACL,WAAQ,SAAS,mCAAmB,IAAI,KAAmB;AAC3D,UAAO,QAAQ,SAAS;;;AAG5B,OAAM,IAAI,MAAM,uCAAuC;;AAGzD,SAAgB,gBACd,QACA,SACc;AACd,KAAI,QAAQ,UAAU;EACpB,MAAM,WAAW,mBAAmB,QAAQ;AAC5C,MAAI,UAAU;GACZ,MAAM,mBAAmB,MAAM,KAAK,SAAS,CAAC,MAC3C,SAAS,KAAK,gBAAgB,OAAO,KACvC;AACD,OAAI,iBACF,QAAO;QACF;IACL,MAAMA,cAA4B;KAChC,aAAa,OAAO;KACpB,UAAU;KACV,UAAU;KACX;AACD,aAAS,IAAI,YAAY;AACzB,WAAO;;;;AAIb,OAAM,IAAI,MAAM,uCAAuC;;;;;AC5CzD,MAAaE,sBAAsBC,OAAO,wBAAA;AAO1C,SAAgBC,oBACdC,QACAC,SAA8B;AAE9B,KAAIA,QAAQC,UAAU;EACpB,MAAMA,WAAWD,QAAQC,SAASL;AAGlC,MAAIK,SACF,QAAOA;OACF;GACL,MAAMC,eAAeP,mBAAmBK,QAAAA;GACxC,MAAMG,cAAgC;IACpCC,MAAML,OAAOK;IACbC,MAAMH;IACR;AACAF,WAAQC,SAASL,uBAAuBO;AAExCJ,UAAOH,uBAAuBO;AAC9B,UAAOA;;;AAGX,OAAM,IAAIG,MAAM,uCAAA;;AAGlB,SAAgBC,wBAAwBR,QAAiB;CAEvD,MAAME,WAAWF,OAAOH;AACxB,KAAI,CAACK,SACH,OAAM,IAAIK,MACR,2FAAA;AAGJ,QAAOL;;AAGT,SAAgBO,oBAAoBT,QAAiB;AAInD,QAAO,CAAC,CAFSA,OAAOH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GCK1B,SAAgBc,KACdC,UACAC,SAAqB;AAErB,SACEC,QACAC,YAAAA;AAEA,MAAIA,QAAQC,SAAS,SACnB,OAAM,IAAIC,MACR,4CAA4CF,QAAQC,OAAM;AAG9D,MAAID,QAAQG,UAAU;GACpB,MAAMA,WAAWR,gBAAgBI,QAAQC,QAAAA;AACzCG,YAASN,WAAWA;AACpBM,YAASC,WAAWN,SAASM,YAAY;;AAE3C,SAAOL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GC3CX,SAAgBQ,cAAAA;AACd,SAAQC,QAAmBC,YAAAA;AACzB,MAAIA,QAAQC,SAAS,QACnB,OAAM,IAAIC,MACR,4DAA4DF,QAAQC,OAAM;AAG9E,MAAID,QAAQG,SACVN,qBAAoBE,QAAQC,QAAAA;AAE9B,uCAAOJ,CAAaG,QAAQC,QAAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GChBhC,IAAO,WAAKI,yBAAAA,YAAAA;;;;;;;;;;;;;;;QAAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qCCWXG;AACM,IAAMK,mBAAN,MAAMA;;;;CACMC,kCAAgBL,qBAAQ,EACvCM,SAASF,kBAAiBG,MAC5B,CAAA;CACiBC,qCAAmBX,uBAAAA;CACnBY,uBAA6B,IAAIC,KAAAA;;;;;;;;;;;;;;;;;;;;;;;;IA0BlDC,SAASC,SAAoB;AAC3B,MAAI,CAACT,oBAAoBS,QAAAA,CACvB,OAAM,IAAIC,MACR,6BAA6BD,QAAQL,KAAK,+DAA8D;EAG5G,MAAMO,WAAWZ,wBAAwBU,QAAAA;AACzC,OAAKP,OAAOU,MAAM,sBAAsBD,SAASP,KAAI;AACrD,OAAKS,aAAaJ,SAASE,SAAAA;;;;;;;;;;;;;;;;;;;;IAsB7BG,OACEL,SACAM,QACqB;EAErB,MAAMC,UAAU,GADCjB,wBAAwBU,QAAAA,CACbL,KAAK,GAAGW,OAAiB;AACrD,SAAO,KAAKT,KAAKW,IAAID,QAAAA;;CAGfH,aAAaJ,SAAoBE,UAA4B;EACnE,MAAML,OAAOK,SAASL;AACtB,OAAK,MAAMY,OAAOZ,MAAM;AACtB,OAAI,CAACY,IAAIC,UAAU;AACjB,SAAKjB,OAAOU,MAAM,gBAAgBM,IAAIE,YAAW;AACjD;;GAEF,MAAMhB,OAAO,GAAGO,SAASP,KAAK,GAAGc,IAAIE,YAAY;GACjD,MAAMC,OAAO;GAEb,MAAME,UAAUzB,aAAQ0B,KAAK;IAC3BL,UAAUD,IAAIC;IACdf;IACA,MAAMqB,SAAAA;AACJ,SAAI;AACFJ,WAAKnB,OAAOU,MAAM,iBAAiBR,KAAAA;AAEnC,aADiB,MAAMiB,KAAKhB,UAAUY,IAAIR,QAAAA,EAC3BS,IAAIE,cAAY;cACxBO,OAAO;AACdN,WAAKnB,OAAOyB,MAAM,uBAAuBvB,MAAMuB,MAAAA;;;IAGnDC,OAAO,CAAqBV,IAAIW;IAClC,CAAA;AACA,QAAKvB,KAAKwB,IAAI1B,MAAMmB,QAAAA;;;;;;;;;;;;;;;;;;;IAqBxBQ,WAAW;AACT,OAAK,MAAMb,OAAO,KAAKZ,KAAK0B,QAAM,EAAI;AACpC,OAAId,IAAIe,SACN;AAEFf,OAAIU,OAAK;;;;;;;;;;;;;;;;;;;;IAsBbM,UAAU;AACR,OAAK,MAAMhB,OAAO,KAAKZ,KAAK0B,QAAM,EAAI;AACpC,OAAI,CAACd,IAAIe,SACP;AAEFf,OAAIiB,MAAI"}
1
+ {"version":3,"file":"index.cjs","names":["newMetadata: CronMetadata","getAllCronMetadata","ScheduleMetadataKey","Symbol","getScheduleMetadata","target","context","metadata","jobsMetadata","newMetadata","name","jobs","Error","extractScheduleMetadata","hasScheduleMetadata","getCronMetadata","Cron","cronTime","options","target","context","kind","Error","metadata","disabled","globalRegistry","Injectable","getScheduleMetadata","Schedulable","registry","target","context","kind","Error","metadata","Schedule","Container","inject","Injectable","Logger","CronJob","extractScheduleMetadata","hasScheduleMetadata","SchedulerService","logger","context","name","container","jobs","Map","register","service","Error","metadata","debug","registerJobs","getJob","method","jobName","get","job","cronTime","classMethod","self","defaultDisabled","cronJob","from","onTick","instance","error","start","disabled","set","startAll","values","isActive","stopAll","stop"],"sources":["../src/metadata/cron.metadata.mts","../src/metadata/schedule.metadata.mts","../src/decorators/cron.decorator.mts","../src/decorators/schedulable.decorator.mts","../src/cron.constants.mts","../src/scheduler.service.mts"],"sourcesContent":["import type { CronJobParams } from 'cron'\n\nexport const CronMetadataKey = Symbol('CronMetadataKey')\n\nexport interface CronMetadata {\n classMethod: string\n cronTime: CronJobParams['cronTime'] | null\n disabled: boolean\n}\n\nexport function getAllCronMetadata(\n context: ClassMethodDecoratorContext | ClassDecoratorContext,\n): Set<CronMetadata> {\n if (context.metadata) {\n const metadata = context.metadata[CronMetadataKey] as\n | Set<CronMetadata>\n | undefined\n if (metadata) {\n return metadata\n } else {\n context.metadata[CronMetadataKey] = new Set<CronMetadata>()\n return context.metadata[CronMetadataKey] as Set<CronMetadata>\n }\n }\n throw new Error('[Navios-Schedule] Wrong environment.')\n}\n\nexport function getCronMetadata(\n target: Function,\n context: ClassMethodDecoratorContext,\n): CronMetadata {\n if (context.metadata) {\n const metadata = getAllCronMetadata(context)\n if (metadata) {\n const endpointMetadata = Array.from(metadata).find(\n (item) => item.classMethod === target.name,\n )\n if (endpointMetadata) {\n return endpointMetadata\n } else {\n const newMetadata: CronMetadata = {\n classMethod: target.name,\n cronTime: null,\n disabled: false,\n }\n metadata.add(newMetadata)\n return newMetadata\n }\n }\n }\n throw new Error('[Navios-Schedule] Wrong environment.')\n}\n","import type { ClassType } from '@navios/core'\n\nimport type { CronMetadata } from './cron.metadata.mjs'\n\nimport { getAllCronMetadata } from './cron.metadata.mjs'\n\nexport const ScheduleMetadataKey = Symbol('ControllerMetadataKey')\n\nexport interface ScheduleMetadata {\n name: string\n jobs: Set<CronMetadata>\n}\n\nexport function getScheduleMetadata(\n target: ClassType,\n context: ClassDecoratorContext,\n): ScheduleMetadata {\n if (context.metadata) {\n const metadata = context.metadata[ScheduleMetadataKey] as\n | ScheduleMetadata\n | undefined\n if (metadata) {\n return metadata\n } else {\n const jobsMetadata = getAllCronMetadata(context)\n const newMetadata: ScheduleMetadata = {\n name: target.name,\n jobs: jobsMetadata,\n }\n context.metadata[ScheduleMetadataKey] = newMetadata\n // @ts-expect-error We add a custom metadata key to the target\n target[ScheduleMetadataKey] = newMetadata\n return newMetadata\n }\n }\n throw new Error('[Navios-Schedule] Wrong environment.')\n}\n\nexport function extractScheduleMetadata(target: ClassType): ScheduleMetadata {\n // @ts-expect-error We add a custom metadata key to the target\n const metadata = target[ScheduleMetadataKey] as ScheduleMetadata | undefined\n if (!metadata) {\n throw new Error(\n '[Navios-Schedule] Controller metadata not found. Make sure to use @Controller decorator.',\n )\n }\n return metadata\n}\n\nexport function hasScheduleMetadata(target: ClassType): boolean {\n // @ts-expect-error We add a custom metadata key to the target\n const metadata = target[ScheduleMetadataKey] as ScheduleMetadata | undefined\n\n return !!metadata\n}\n","import type { CronJobParams } from 'cron'\n\nimport { getCronMetadata } from '../metadata/index.mjs'\n\n/**\n * Options for configuring a cron job.\n * \n * @public\n */\nexport interface CronOptions {\n /**\n * Whether the job should be disabled by default.\n * Disabled jobs won't start automatically but can be manually started later.\n * \n * @default false\n */\n disabled?: boolean\n}\n\n/**\n * Decorator that marks a method to run on a cron schedule.\n * \n * The method must be in a class decorated with `@Schedulable()`.\n * The method will be automatically executed according to the provided cron expression.\n * \n * @param cronTime - Cron expression (5 or 6 fields) or a pre-defined Schedule constant\n * @param options - Optional configuration for the cron job\n * \n * @example\n * ```typescript\n * @Schedulable()\n * class TaskService {\n * // Run daily at midnight\n * @Cron('0 0 * * *')\n * async dailyTask() {\n * console.log('Running daily task')\n * }\n * \n * // Use pre-defined schedule\n * @Cron(Schedule.EveryFiveMinutes)\n * async frequentTask() {\n * console.log('Running every 5 minutes')\n * }\n * \n * // Disabled job (won't start automatically)\n * @Cron('0 2 * * *', { disabled: true })\n * async maintenanceTask() {\n * console.log('Maintenance task')\n * }\n * }\n * ```\n * \n * @throws {Error} If applied to something other than a method\n * \n * @public\n */\nexport function Cron(\n cronTime: CronJobParams['cronTime'],\n options?: CronOptions,\n) {\n return (\n target: () => Promise<void>,\n context: ClassMethodDecoratorContext,\n ) => {\n if (context.kind !== 'method') {\n throw new Error(\n `Cron can only be applied to methods, not ${context.kind}`,\n )\n }\n if (context.metadata) {\n const metadata = getCronMetadata(target, context)\n metadata.cronTime = cronTime\n metadata.disabled = options?.disabled ?? false\n }\n return target\n }\n}\n","import type { ClassType } from '@navios/core'\n\nimport { globalRegistry, Injectable, Registry } from '@navios/core'\n\nimport { getScheduleMetadata } from '../metadata/index.mjs'\n\n/**\n * Decorator that marks a class as schedulable and makes it injectable.\n *\n * Classes decorated with `@Schedulable()` can contain methods decorated with `@Cron()`\n * that will be automatically scheduled and executed. This decorator also applies\n * the `@Injectable()` decorator, making the class available for dependency injection.\n *\n * @example\n * ```typescript\n * @Schedulable()\n * class TaskService {\n * @Cron('0 0 * * *')\n * async dailyTask() {\n * // This will run daily at midnight\n * }\n * }\n *\n * // Register the service\n * schedulerService.register(TaskService)\n * ```\n *\n * @throws {Error} If applied to something other than a class\n *\n * @public\n */\nexport function Schedulable({ registry }: { registry?: Registry } = {}) {\n return (target: ClassType, context: ClassDecoratorContext) => {\n if (context.kind !== 'class') {\n throw new Error(\n `SchedulableDecorator can only be applied to classes, not ${context.kind}`,\n )\n }\n if (context.metadata) {\n getScheduleMetadata(target, context)\n }\n return Injectable({ registry: registry ?? globalRegistry })(target, context)\n }\n}\n","/**\n * Pre-defined cron schedule constants for common scheduling patterns.\n *\n * These constants provide convenient shortcuts for frequently used cron expressions,\n * making it easier to schedule jobs without manually writing cron expressions.\n *\n * @example\n * ```typescript\n * import { Schedule } from '@navios/schedule'\n *\n * @Schedulable()\n * class TaskService {\n * @Cron(Schedule.EveryMinute)\n * async everyMinute() {}\n *\n * @Cron(Schedule.EveryHour)\n * async hourly() {}\n *\n * @Cron(Schedule.EveryDay)\n * async daily() {}\n * }\n * ```\n *\n * @public\n */\nexport enum Schedule {\n EveryMinute = '*/1 * * * *',\n EveryFiveMinutes = '*/5 * * * *',\n EveryTenMinutes = '*/10 * * * *',\n EveryFifteenMinutes = '*/15 * * * *',\n EveryThirtyMinutes = '*/30 * * * *',\n EveryHour = '0 * * * *',\n EveryTwoHours = '0 */2 * * *',\n EveryThreeHours = '0 */3 * * *',\n EveryFourHours = '0 */4 * * *',\n EverySixHours = '0 */6 * * *',\n EveryTwelveHours = '0 */12 * * *',\n EveryDay = '0 0 * * *',\n EveryWeek = '0 0 * * 0',\n EveryMonth = '0 0 1 * *',\n}\n","import type { ClassType } from '@navios/core'\n\nimport { Container, inject, Injectable, Logger } from '@navios/core'\n\nimport { CronJob } from 'cron'\n\nimport type { ScheduleMetadata } from './metadata/index.mjs'\n\nimport {\n extractScheduleMetadata,\n hasScheduleMetadata,\n} from './metadata/index.mjs'\n\n/**\n * Service responsible for managing and executing scheduled cron jobs.\n * \n * The SchedulerService registers schedulable services decorated with `@Schedulable()`\n * and automatically starts their cron jobs based on the `@Cron()` decorator configuration.\n * \n * @example\n * ```typescript\n * import { inject, Injectable } from '@navios/core'\n * import { SchedulerService } from '@navios/schedule'\n * \n * @Injectable()\n * class AppModule {\n * private readonly scheduler = inject(SchedulerService)\n * \n * async onModuleInit() {\n * this.scheduler.register(MySchedulableService)\n * }\n * }\n * ```\n * \n * @public\n */\n@Injectable()\nexport class SchedulerService {\n private readonly logger = inject(Logger, {\n context: SchedulerService.name,\n })\n private readonly container = inject(Container)\n private readonly jobs: Map<string, CronJob> = new Map()\n\n /**\n * Registers a schedulable service and starts all its cron jobs.\n * \n * The service must be decorated with `@Schedulable()` and contain methods\n * decorated with `@Cron()` to be registered successfully.\n * \n * @param service - The schedulable service class to register\n * @throws {Error} If the service is not decorated with `@Schedulable()`\n * \n * @example\n * ```typescript\n * @Schedulable()\n * class TaskService {\n * @Cron('0 0 * * *')\n * async dailyTask() {\n * // Runs daily at midnight\n * }\n * }\n * \n * schedulerService.register(TaskService)\n * ```\n * \n * @public\n */\n register(service: ClassType) {\n if (!hasScheduleMetadata(service)) {\n throw new Error(\n `[Navios-Schedule] Service ${service.name} is not schedulable. Make sure to use @Schedulable decorator.`,\n )\n }\n const metadata = extractScheduleMetadata(service)\n this.logger.debug('Scheduling service', metadata.name)\n this.registerJobs(service, metadata)\n }\n\n /**\n * Retrieves a specific cron job instance for a method in a schedulable service.\n * \n * @param service - The schedulable service class\n * @param method - The name of the method decorated with `@Cron()`\n * @returns The CronJob instance if found, undefined otherwise\n * \n * @example\n * ```typescript\n * const job = schedulerService.getJob(TaskService, 'dailyTask')\n * if (job) {\n * console.log('Job is active:', job.isActive)\n * job.start() // Manually start the job\n * job.stop() // Manually stop the job\n * }\n * ```\n * \n * @public\n */\n getJob<T extends ClassType>(\n service: T,\n method: keyof InstanceType<T>,\n ): CronJob | undefined {\n const metadata = extractScheduleMetadata(service)\n const jobName = `${metadata.name}.${method as string}()`\n return this.jobs.get(jobName)\n }\n\n private registerJobs(service: ClassType, metadata: ScheduleMetadata) {\n const jobs = metadata.jobs\n for (const job of jobs) {\n if (!job.cronTime) {\n this.logger.debug('Skipping job', job.classMethod)\n continue\n }\n const name = `${metadata.name}.${job.classMethod}()`\n const self = this\n const defaultDisabled = false\n const cronJob = CronJob.from({\n cronTime: job.cronTime,\n name,\n async onTick() {\n try {\n self.logger.debug('Executing job', name)\n const instance = await self.container.get(service)\n await instance[job.classMethod]()\n } catch (error) {\n self.logger.error('Error executing job', name, error)\n }\n },\n start: !(defaultDisabled || job.disabled),\n })\n this.jobs.set(name, cronJob)\n }\n }\n\n /**\n * Starts all registered cron jobs that are currently inactive.\n * \n * Only jobs that are not already active will be started. This method\n * is useful for resuming all jobs after calling `stopAll()`.\n * \n * @example\n * ```typescript\n * // Stop all jobs\n * schedulerService.stopAll()\n * \n * // Later, resume all jobs\n * schedulerService.startAll()\n * ```\n * \n * @public\n */\n startAll() {\n for (const job of this.jobs.values()) {\n if (job.isActive) {\n continue\n }\n job.start()\n }\n }\n\n /**\n * Stops all registered cron jobs that are currently active.\n * \n * Only jobs that are currently active will be stopped. This method\n * is useful for pausing all scheduled tasks, for example during\n * application shutdown or maintenance.\n * \n * @example\n * ```typescript\n * // Pause all scheduled jobs\n * schedulerService.stopAll()\n * \n * // Jobs can be resumed later with startAll()\n * schedulerService.startAll()\n * ```\n * \n * @public\n */\n stopAll() {\n for (const job of this.jobs.values()) {\n if (!job.isActive) {\n continue\n }\n job.stop()\n }\n }\n}\n"],"mappings":";;;;AAEA,MAAa,kBAAkB,OAAO,kBAAkB;AAQxD,SAAgB,mBACd,SACmB;AACnB,KAAI,QAAQ,UAAU;EACpB,MAAM,WAAW,QAAQ,SAAS;AAGlC,MAAI,SACF,QAAO;OACF;AACL,WAAQ,SAAS,mCAAmB,IAAI,KAAmB;AAC3D,UAAO,QAAQ,SAAS;;;AAG5B,OAAM,IAAI,MAAM,uCAAuC;;AAGzD,SAAgB,gBACd,QACA,SACc;AACd,KAAI,QAAQ,UAAU;EACpB,MAAM,WAAW,mBAAmB,QAAQ;AAC5C,MAAI,UAAU;GACZ,MAAM,mBAAmB,MAAM,KAAK,SAAS,CAAC,MAC3C,SAAS,KAAK,gBAAgB,OAAO,KACvC;AACD,OAAI,iBACF,QAAO;QACF;IACL,MAAMA,cAA4B;KAChC,aAAa,OAAO;KACpB,UAAU;KACV,UAAU;KACX;AACD,aAAS,IAAI,YAAY;AACzB,WAAO;;;;AAIb,OAAM,IAAI,MAAM,uCAAuC;;;;;AC5CzD,MAAaE,sBAAsBC,OAAO,wBAAA;AAO1C,SAAgBC,oBACdC,QACAC,SAA8B;AAE9B,KAAIA,QAAQC,UAAU;EACpB,MAAMA,WAAWD,QAAQC,SAASL;AAGlC,MAAIK,SACF,QAAOA;OACF;GACL,MAAMC,eAAeP,mBAAmBK,QAAAA;GACxC,MAAMG,cAAgC;IACpCC,MAAML,OAAOK;IACbC,MAAMH;IACR;AACAF,WAAQC,SAASL,uBAAuBO;AAExCJ,UAAOH,uBAAuBO;AAC9B,UAAOA;;;AAGX,OAAM,IAAIG,MAAM,uCAAA;;AAGlB,SAAgBC,wBAAwBR,QAAiB;CAEvD,MAAME,WAAWF,OAAOH;AACxB,KAAI,CAACK,SACH,OAAM,IAAIK,MACR,2FAAA;AAGJ,QAAOL;;AAGT,SAAgBO,oBAAoBT,QAAiB;AAInD,QAAO,CAAC,CAFSA,OAAOH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GCK1B,SAAgBc,KACdC,UACAC,SAAqB;AAErB,SACEC,QACAC,YAAAA;AAEA,MAAIA,QAAQC,SAAS,SACnB,OAAM,IAAIC,MACR,4CAA4CF,QAAQC,OAAM;AAG9D,MAAID,QAAQG,UAAU;GACpB,MAAMA,WAAWR,gBAAgBI,QAAQC,QAAAA;AACzCG,YAASN,WAAWA;AACpBM,YAASC,WAAWN,SAASM,YAAY;;AAE3C,SAAOL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GC3CX,SAAgBS,YAAY,EAAEC,aAAsC,EAAE,EAAA;AACpE,SAAQC,QAAmBC,YAAAA;AACzB,MAAIA,QAAQC,SAAS,QACnB,OAAM,IAAIC,MACR,4DAA4DF,QAAQC,OAAM;AAG9E,MAAID,QAAQG,SACVP,qBAAoBG,QAAQC,QAAAA;AAE9B,sCAAkB,EAAEF,UAAUA,YAAYJ,6BAAe,CAAA,CAAGK,QAAQC,QAAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GChBxE,IAAO,WAAKI,yBAAAA,YAAAA;;;;;;;;;;;;;;;QAAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qCCWXG;AACM,IAAMK,mBAAN,MAAMA;;;;CACMC,kCAAgBL,qBAAQ,EACvCM,SAASF,kBAAiBG,MAC5B,CAAA;CACiBC,qCAAmBX,uBAAAA;CACnBY,uBAA6B,IAAIC,KAAAA;;;;;;;;;;;;;;;;;;;;;;;;IA0BlDC,SAASC,SAAoB;AAC3B,MAAI,CAACT,oBAAoBS,QAAAA,CACvB,OAAM,IAAIC,MACR,6BAA6BD,QAAQL,KAAK,+DAA8D;EAG5G,MAAMO,WAAWZ,wBAAwBU,QAAAA;AACzC,OAAKP,OAAOU,MAAM,sBAAsBD,SAASP,KAAI;AACrD,OAAKS,aAAaJ,SAASE,SAAAA;;;;;;;;;;;;;;;;;;;;IAsB7BG,OACEL,SACAM,QACqB;EAErB,MAAMC,UAAU,GADCjB,wBAAwBU,QAAAA,CACbL,KAAK,GAAGW,OAAiB;AACrD,SAAO,KAAKT,KAAKW,IAAID,QAAAA;;CAGfH,aAAaJ,SAAoBE,UAA4B;EACnE,MAAML,OAAOK,SAASL;AACtB,OAAK,MAAMY,OAAOZ,MAAM;AACtB,OAAI,CAACY,IAAIC,UAAU;AACjB,SAAKjB,OAAOU,MAAM,gBAAgBM,IAAIE,YAAW;AACjD;;GAEF,MAAMhB,OAAO,GAAGO,SAASP,KAAK,GAAGc,IAAIE,YAAY;GACjD,MAAMC,OAAO;GAEb,MAAME,UAAUzB,aAAQ0B,KAAK;IAC3BL,UAAUD,IAAIC;IACdf;IACA,MAAMqB,SAAAA;AACJ,SAAI;AACFJ,WAAKnB,OAAOU,MAAM,iBAAiBR,KAAAA;AAEnC,aADiB,MAAMiB,KAAKhB,UAAUY,IAAIR,QAAAA,EAC3BS,IAAIE,cAAY;cACxBO,OAAO;AACdN,WAAKnB,OAAOyB,MAAM,uBAAuBvB,MAAMuB,MAAAA;;;IAGnDC,OAAO,CAAqBV,IAAIW;IAClC,CAAA;AACA,QAAKvB,KAAKwB,IAAI1B,MAAMmB,QAAAA;;;;;;;;;;;;;;;;;;;IAqBxBQ,WAAW;AACT,OAAK,MAAMb,OAAO,KAAKZ,KAAK0B,QAAM,EAAI;AACpC,OAAId,IAAIe,SACN;AAEFf,OAAIU,OAAK;;;;;;;;;;;;;;;;;;;;IAsBbM,UAAU;AACR,OAAK,MAAMhB,OAAO,KAAKZ,KAAK0B,QAAM,EAAI;AACpC,OAAI,CAACd,IAAIe,SACP;AAEFf,OAAIiB,MAAI"}
package/lib/index.d.cts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { CronJob, CronJobParams } from "cron";
2
- import { ClassType } from "@navios/core";
2
+ import { ClassType, Registry } from "@navios/core";
3
3
 
4
4
  //#region src/decorators/cron.decorator.d.mts
5
5
 
@@ -82,7 +82,11 @@ declare function Cron(cronTime: CronJobParams['cronTime'], options?: CronOptions
82
82
  *
83
83
  * @public
84
84
  */
85
- declare function Schedulable(): (target: ClassType, context: ClassDecoratorContext) => ClassType;
85
+ declare function Schedulable({
86
+ registry
87
+ }?: {
88
+ registry?: Registry;
89
+ }): (target: ClassType, context: ClassDecoratorContext) => ClassType;
86
90
  //#endregion
87
91
  //#region src/metadata/cron.metadata.d.mts
88
92
  declare const CronMetadataKey: unique symbol;
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.cts","names":[],"sources":["../src/decorators/cron.decorator.mts","../src/decorators/schedulable.decorator.mts","../src/metadata/cron.metadata.mts","../src/metadata/schedule.metadata.mts","../src/cron.constants.mts","../src/scheduler.service.mts"],"sourcesContent":[],"mappings":";;;;;;;;AASA;AA+CA;AACY,UAhDK,WAAA,CAgDL;EACA;;;;;;;;AC3BZ;;;;;;;;AC7BA;AAEA;AAMA;;;;;;AAiBA;;;;;;;;ACrBA;AAEA;AAKA;;;;;AAyBA;AAWA;;;;ACxBA;iBJ+BgB,IAAA,WACJ,qCACA,6BAGM,wBACL,sCADK;;;;;;AApDlB;AA+CA;;;;;;;;;;ACzBA;;;;;;;;AC7BA;AAEA;AAMA;AACW,iBDoBK,WAAA,CAAA,CCpBL,EAAA,CAAA,MAAA,EDqBO,SCrBP,EAAA,OAAA,EDqB2B,qBCrB3B,EAAA,GDqBgD,SCrBhD;;;cATE;UAEI,YAAA;;EFKA,QAAA,EEHL,aFGgB,CAAA,UAAA,CAAA,GAAA,IAAA;EA+CZ,QAAI,EAAA,OAAA;;AAER,iBEhDI,kBAAA,CFgDJ,OAAA,EE/CD,2BF+CC,GE/C6B,qBF+C7B,CAAA,EE9CT,GF8CS,CE9CL,YF8CK,CAAA;AAGM,iBElCF,eAAA,CFkCE,MAAA,EEjCR,QFiCQ,EAAA,OAAA,EEhCP,2BFgCO,CAAA,EE/Bf,YF+Be;;;cGvDL;UAEI,gBAAA;EHCA,IAAA,EAAA,MAAA;EA+CD,IAAA,EG9CR,GH8CY,CG9CR,YH8CQ,CAAA;;AAER,iBG7CI,mBAAA,CH6CJ,MAAA,EG5CF,SH4CE,EAAA,OAAA,EG3CD,qBH2CC,CAAA,EG1CT,gBH0CS;AAGM,iBGvBF,uBAAA,CHuBE,MAAA,EGvB8B,SHuB9B,CAAA,EGvB0C,gBHuB1C;AACL,iBGbG,mBAAA,CHaH,MAAA,EGb+B,SHa/B,CAAA,EAAA,OAAA;;;;;;;AArDb;AA+CA;;;;;;;;;;ACzBA;;;;;;;;AC7BA;AAEA;AAMgB,aEeJ,QAAA;EFdD,WAAA,GAAA,aAAA;EAA8B,gBAAA,GAAA,aAAA;EAClC,eAAA,GAAA,cAAA;EAAJ,mBAAA,GAAA,cAAA;EAAG,kBAAA,GAAA,cAAA;EAeU,SAAA,GAAA,WAAe;EACrB,aAAA,GAAA,aAAA;EACC,eAAA,GAAA,aAAA;EACR,cAAA,GAAA,aAAA;EAAY,aAAA,GAAA,aAAA;;;;ECxBF,UAAA,GAAA,WAAqD;AAElE;;;;;AHCA;AA+CA;;;;;;;;;;ACzBA;;;;;;;;AC7BA;AAEA;AAMgB,cG2BH,gBAAA,CH3BqB;EACvB,iBAAA,MAAA;EAA8B,iBAAA,SAAA;EAClC,iBAAA,IAAA;EAAJ;;AAeH;;;;;;;;ACrBA;AAEA;AAKA;;;;;AAyBA;AAWA;;;;ACxBA;;oBC2CoB;;AAhCpB;;;;;;;;;;;;;;;;;;mBA8DmB,oBACN,iBACK,aAAa,KAC1B"}
1
+ {"version":3,"file":"index.d.cts","names":[],"sources":["../src/decorators/cron.decorator.mts","../src/decorators/schedulable.decorator.mts","../src/metadata/cron.metadata.mts","../src/metadata/schedule.metadata.mts","../src/cron.constants.mts","../src/scheduler.service.mts"],"sourcesContent":[],"mappings":";;;;;;;;AASA;AA+CA;AACY,UAhDK,WAAA,CAgDL;EACA;;;;;;;;AC3BZ;;;;;;;;;;AC7BA;AAEA;AAMA;;;;;;AAiBA;;;;;;;;ACrBA;AAEA;AAKA;;;;;AAyBA;AAWA;;;iBHOgB,IAAA,WACJ,qCACA,6BAGM,wBACL,sCADK;;;;;AApDlB;AA+CA;;;;;;;;;;ACzBA;;;;;;;;;;AC7BA;AAEA;AAMgB,iBDqBA,WAAA,CCrBkB;EAAA;CACO,CADP,EAAA;EACvB,QAAA,CAAA,EDoB4C,QCpB5C;CAA8B,CAAA,EAAA,CAAA,MAAA,EDqBvB,SCrBuB,EAAA,OAAA,EDqBH,qBCrBG,EAAA,GDqBkB,SCrBlB;;;cAT5B;UAEI,YAAA;;EFKA,QAAA,EEHL,aFGgB,CAAA,UAAA,CAAA,GAAA,IAAA;EA+CZ,QAAI,EAAA,OAAA;;AAER,iBEhDI,kBAAA,CFgDJ,OAAA,EE/CD,2BF+CC,GE/C6B,qBF+C7B,CAAA,EE9CT,GF8CS,CE9CL,YF8CK,CAAA;AAGM,iBElCF,eAAA,CFkCE,MAAA,EEjCR,QFiCQ,EAAA,OAAA,EEhCP,2BFgCO,CAAA,EE/Bf,YF+Be;;;cGvDL;UAEI,gBAAA;EHCA,IAAA,EAAA,MAAA;EA+CD,IAAA,EG9CR,GH8CY,CG9CR,YH8CQ,CAAA;;AAER,iBG7CI,mBAAA,CH6CJ,MAAA,EG5CF,SH4CE,EAAA,OAAA,EG3CD,qBH2CC,CAAA,EG1CT,gBH0CS;AAGM,iBGvBF,uBAAA,CHuBE,MAAA,EGvB8B,SHuB9B,CAAA,EGvB0C,gBHuB1C;AACL,iBGbG,mBAAA,CHaH,MAAA,EGb+B,SHa/B,CAAA,EAAA,OAAA;;;;;;;AArDb;AA+CA;;;;;;;;;;ACzBA;;;;;;;;;;AC7Ba,aEuBD,QAAA;EFrBK,WAAA,GAAA,aAEL;EAII,gBAAA,GAAA,aAAkB;EACvB,eAAA,GAAA,cAAA;EAA8B,mBAAA,GAAA,cAAA;EAClC,kBAAA,GAAA,cAAA;EAAJ,SAAA,GAAA,WAAA;EAAG,aAAA,GAAA,aAAA;EAeU,eAAA,GAAe,aAAA;EACrB,cAAA,GAAA,aAAA;EACC,aAAA,GAAA,aAAA;EACR,gBAAA,GAAA,cAAA;EAAY,QAAA,GAAA,WAAA;;;;;;;;AFrBf;AA+CA;;;;;;;;;;ACzBA;;;;;;;;;;AC7Ba,cGmCA,gBAAA,CHnC2C;EAEvC,iBAAY,MAAA;EAMb,iBAAA,SAAkB;EACvB,iBAAA,IAAA;EAA8B;;;;AAgBzC;;;;;;;;ACrBA;AAEA;AAKA;;;;;AAyBA;AAWA;;;;ECxBY,QAAA,CAAA,OAAQ,EC2CA,SD3CA,CAAA,EAAA,IAAA;;;;ACWpB;;;;;;;;;;;;;;;;mBA8DmB,oBACN,iBACK,aAAa,KAC1B"}
package/lib/index.d.mts CHANGED
@@ -1,4 +1,4 @@
1
- import { ClassType } from "@navios/core";
1
+ import { ClassType, Registry } from "@navios/core";
2
2
  import { CronJob, CronJobParams } from "cron";
3
3
 
4
4
  //#region src/decorators/cron.decorator.d.mts
@@ -82,7 +82,11 @@ declare function Cron(cronTime: CronJobParams['cronTime'], options?: CronOptions
82
82
  *
83
83
  * @public
84
84
  */
85
- declare function Schedulable(): (target: ClassType, context: ClassDecoratorContext) => ClassType;
85
+ declare function Schedulable({
86
+ registry
87
+ }?: {
88
+ registry?: Registry;
89
+ }): (target: ClassType, context: ClassDecoratorContext) => ClassType;
86
90
  //#endregion
87
91
  //#region src/metadata/cron.metadata.d.mts
88
92
  declare const CronMetadataKey: unique symbol;
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.mts","names":[],"sources":["../src/decorators/cron.decorator.mts","../src/decorators/schedulable.decorator.mts","../src/metadata/cron.metadata.mts","../src/metadata/schedule.metadata.mts","../src/cron.constants.mts","../src/scheduler.service.mts"],"sourcesContent":[],"mappings":";;;;;;;;AASA;AA+CA;AACY,UAhDK,WAAA,CAgDL;EACA;;;;;;;;AC3BZ;;;;;;;;AC7BA;AAEA;AAMA;;;;;;AAiBA;;;;;;;;ACrBA;AAEA;AAKA;;;;;AAyBA;AAWA;;;;ACxBA;iBJ+BgB,IAAA,WACJ,qCACA,6BAGM,wBACL,sCADK;;;;;;AApDlB;AA+CA;;;;;;;;;;ACzBA;;;;;;;;AC7BA;AAEA;AAMA;AACW,iBDoBK,WAAA,CAAA,CCpBL,EAAA,CAAA,MAAA,EDqBO,SCrBP,EAAA,OAAA,EDqB2B,qBCrB3B,EAAA,GDqBgD,SCrBhD;;;cATE;UAEI,YAAA;;EFKA,QAAA,EEHL,aFGgB,CAAA,UAAA,CAAA,GAAA,IAAA;EA+CZ,QAAI,EAAA,OAAA;;AAER,iBEhDI,kBAAA,CFgDJ,OAAA,EE/CD,2BF+CC,GE/C6B,qBF+C7B,CAAA,EE9CT,GF8CS,CE9CL,YF8CK,CAAA;AAGM,iBElCF,eAAA,CFkCE,MAAA,EEjCR,QFiCQ,EAAA,OAAA,EEhCP,2BFgCO,CAAA,EE/Bf,YF+Be;;;cGvDL;UAEI,gBAAA;EHCA,IAAA,EAAA,MAAA;EA+CD,IAAA,EG9CR,GH8CY,CG9CR,YH8CQ,CAAA;;AAER,iBG7CI,mBAAA,CH6CJ,MAAA,EG5CF,SH4CE,EAAA,OAAA,EG3CD,qBH2CC,CAAA,EG1CT,gBH0CS;AAGM,iBGvBF,uBAAA,CHuBE,MAAA,EGvB8B,SHuB9B,CAAA,EGvB0C,gBHuB1C;AACL,iBGbG,mBAAA,CHaH,MAAA,EGb+B,SHa/B,CAAA,EAAA,OAAA;;;;;;;AArDb;AA+CA;;;;;;;;;;ACzBA;;;;;;;;AC7BA;AAEA;AAMgB,aEeJ,QAAA;EFdD,WAAA,GAAA,aAAA;EAA8B,gBAAA,GAAA,aAAA;EAClC,eAAA,GAAA,cAAA;EAAJ,mBAAA,GAAA,cAAA;EAAG,kBAAA,GAAA,cAAA;EAeU,SAAA,GAAA,WAAe;EACrB,aAAA,GAAA,aAAA;EACC,eAAA,GAAA,aAAA;EACR,cAAA,GAAA,aAAA;EAAY,aAAA,GAAA,aAAA;;;;ECxBF,UAAA,GAAA,WAAqD;AAElE;;;;;AHCA;AA+CA;;;;;;;;;;ACzBA;;;;;;;;AC7BA;AAEA;AAMgB,cG2BH,gBAAA,CH3BqB;EACvB,iBAAA,MAAA;EAA8B,iBAAA,SAAA;EAClC,iBAAA,IAAA;EAAJ;;AAeH;;;;;;;;ACrBA;AAEA;AAKA;;;;;AAyBA;AAWA;;;;ACxBA;;oBC2CoB;;AAhCpB;;;;;;;;;;;;;;;;;;mBA8DmB,oBACN,iBACK,aAAa,KAC1B"}
1
+ {"version":3,"file":"index.d.mts","names":[],"sources":["../src/decorators/cron.decorator.mts","../src/decorators/schedulable.decorator.mts","../src/metadata/cron.metadata.mts","../src/metadata/schedule.metadata.mts","../src/cron.constants.mts","../src/scheduler.service.mts"],"sourcesContent":[],"mappings":";;;;;;;;AASA;AA+CA;AACY,UAhDK,WAAA,CAgDL;EACA;;;;;;;;AC3BZ;;;;;;;;;;AC7BA;AAEA;AAMA;;;;;;AAiBA;;;;;;;;ACrBA;AAEA;AAKA;;;;;AAyBA;AAWA;;;iBHOgB,IAAA,WACJ,qCACA,6BAGM,wBACL,sCADK;;;;;AApDlB;AA+CA;;;;;;;;;;ACzBA;;;;;;;;;;AC7BA;AAEA;AAMgB,iBDqBA,WAAA,CCrBkB;EAAA;CACO,CADP,EAAA;EACvB,QAAA,CAAA,EDoB4C,QCpB5C;CAA8B,CAAA,EAAA,CAAA,MAAA,EDqBvB,SCrBuB,EAAA,OAAA,EDqBH,qBCrBG,EAAA,GDqBkB,SCrBlB;;;cAT5B;UAEI,YAAA;;EFKA,QAAA,EEHL,aFGgB,CAAA,UAAA,CAAA,GAAA,IAAA;EA+CZ,QAAI,EAAA,OAAA;;AAER,iBEhDI,kBAAA,CFgDJ,OAAA,EE/CD,2BF+CC,GE/C6B,qBF+C7B,CAAA,EE9CT,GF8CS,CE9CL,YF8CK,CAAA;AAGM,iBElCF,eAAA,CFkCE,MAAA,EEjCR,QFiCQ,EAAA,OAAA,EEhCP,2BFgCO,CAAA,EE/Bf,YF+Be;;;cGvDL;UAEI,gBAAA;EHCA,IAAA,EAAA,MAAA;EA+CD,IAAA,EG9CR,GH8CY,CG9CR,YH8CQ,CAAA;;AAER,iBG7CI,mBAAA,CH6CJ,MAAA,EG5CF,SH4CE,EAAA,OAAA,EG3CD,qBH2CC,CAAA,EG1CT,gBH0CS;AAGM,iBGvBF,uBAAA,CHuBE,MAAA,EGvB8B,SHuB9B,CAAA,EGvB0C,gBHuB1C;AACL,iBGbG,mBAAA,CHaH,MAAA,EGb+B,SHa/B,CAAA,EAAA,OAAA;;;;;;;AArDb;AA+CA;;;;;;;;;;ACzBA;;;;;;;;;;AC7Ba,aEuBD,QAAA;EFrBK,WAAA,GAAA,aAEL;EAII,gBAAA,GAAA,aAAkB;EACvB,eAAA,GAAA,cAAA;EAA8B,mBAAA,GAAA,cAAA;EAClC,kBAAA,GAAA,cAAA;EAAJ,SAAA,GAAA,WAAA;EAAG,aAAA,GAAA,aAAA;EAeU,eAAA,GAAe,aAAA;EACrB,cAAA,GAAA,aAAA;EACC,aAAA,GAAA,aAAA;EACR,gBAAA,GAAA,cAAA;EAAY,QAAA,GAAA,WAAA;;;;;;;;AFrBf;AA+CA;;;;;;;;;;ACzBA;;;;;;;;;;AC7Ba,cGmCA,gBAAA,CHnC2C;EAEvC,iBAAY,MAAA;EAMb,iBAAA,SAAkB;EACvB,iBAAA,IAAA;EAA8B;;;;AAgBzC;;;;;;;;ACrBA;AAEA;AAKA;;;;;AAyBA;AAWA;;;;ECxBY,QAAA,CAAA,OAAQ,EC2CA,SD3CA,CAAA,EAAA,IAAA;;;;ACWpB;;;;;;;;;;;;;;;;mBA8DmB,oBACN,iBACK,aAAa,KAC1B"}
package/lib/index.mjs CHANGED
@@ -1,4 +1,4 @@
1
- import { Container, Injectable, Logger, inject } from "@navios/core";
1
+ import { Container, Injectable, Logger, globalRegistry, inject } from "@navios/core";
2
2
  import { CronJob } from "cron";
3
3
 
4
4
  //#region src/metadata/cron.metadata.mts
@@ -117,11 +117,11 @@ function hasScheduleMetadata(target) {
117
117
  //#region src/decorators/schedulable.decorator.mts
118
118
  /**
119
119
  * Decorator that marks a class as schedulable and makes it injectable.
120
- *
120
+ *
121
121
  * Classes decorated with `@Schedulable()` can contain methods decorated with `@Cron()`
122
122
  * that will be automatically scheduled and executed. This decorator also applies
123
123
  * the `@Injectable()` decorator, making the class available for dependency injection.
124
- *
124
+ *
125
125
  * @example
126
126
  * ```typescript
127
127
  * @Schedulable()
@@ -131,19 +131,19 @@ function hasScheduleMetadata(target) {
131
131
  * // This will run daily at midnight
132
132
  * }
133
133
  * }
134
- *
134
+ *
135
135
  * // Register the service
136
136
  * schedulerService.register(TaskService)
137
137
  * ```
138
- *
138
+ *
139
139
  * @throws {Error} If applied to something other than a class
140
- *
140
+ *
141
141
  * @public
142
- */ function Schedulable() {
142
+ */ function Schedulable({ registry } = {}) {
143
143
  return (target, context) => {
144
144
  if (context.kind !== "class") throw new Error(`SchedulableDecorator can only be applied to classes, not ${context.kind}`);
145
145
  if (context.metadata) getScheduleMetadata(target, context);
146
- return Injectable()(target, context);
146
+ return Injectable({ registry: registry ?? globalRegistry })(target, context);
147
147
  };
148
148
  }
149
149
 
package/lib/index.mjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.mjs","names":["newMetadata: CronMetadata","getAllCronMetadata","ScheduleMetadataKey","Symbol","getScheduleMetadata","target","context","metadata","jobsMetadata","newMetadata","name","jobs","Error","extractScheduleMetadata","hasScheduleMetadata","getCronMetadata","Cron","cronTime","options","target","context","kind","Error","metadata","disabled","Injectable","getScheduleMetadata","Schedulable","target","context","kind","Error","metadata","Schedule","Container","inject","Injectable","Logger","CronJob","extractScheduleMetadata","hasScheduleMetadata","SchedulerService","logger","context","name","container","jobs","Map","register","service","Error","metadata","debug","registerJobs","getJob","method","jobName","get","job","cronTime","classMethod","self","defaultDisabled","cronJob","from","onTick","instance","error","start","disabled","set","startAll","values","isActive","stopAll","stop"],"sources":["../src/metadata/cron.metadata.mts","../src/metadata/schedule.metadata.mts","../src/decorators/cron.decorator.mts","../src/decorators/schedulable.decorator.mts","../src/cron.constants.mts","../src/scheduler.service.mts"],"sourcesContent":["import type { CronJobParams } from 'cron'\n\nexport const CronMetadataKey = Symbol('CronMetadataKey')\n\nexport interface CronMetadata {\n classMethod: string\n cronTime: CronJobParams['cronTime'] | null\n disabled: boolean\n}\n\nexport function getAllCronMetadata(\n context: ClassMethodDecoratorContext | ClassDecoratorContext,\n): Set<CronMetadata> {\n if (context.metadata) {\n const metadata = context.metadata[CronMetadataKey] as\n | Set<CronMetadata>\n | undefined\n if (metadata) {\n return metadata\n } else {\n context.metadata[CronMetadataKey] = new Set<CronMetadata>()\n return context.metadata[CronMetadataKey] as Set<CronMetadata>\n }\n }\n throw new Error('[Navios-Schedule] Wrong environment.')\n}\n\nexport function getCronMetadata(\n target: Function,\n context: ClassMethodDecoratorContext,\n): CronMetadata {\n if (context.metadata) {\n const metadata = getAllCronMetadata(context)\n if (metadata) {\n const endpointMetadata = Array.from(metadata).find(\n (item) => item.classMethod === target.name,\n )\n if (endpointMetadata) {\n return endpointMetadata\n } else {\n const newMetadata: CronMetadata = {\n classMethod: target.name,\n cronTime: null,\n disabled: false,\n }\n metadata.add(newMetadata)\n return newMetadata\n }\n }\n }\n throw new Error('[Navios-Schedule] Wrong environment.')\n}\n","import type { ClassType } from '@navios/core'\n\nimport type { CronMetadata } from './cron.metadata.mjs'\n\nimport { getAllCronMetadata } from './cron.metadata.mjs'\n\nexport const ScheduleMetadataKey = Symbol('ControllerMetadataKey')\n\nexport interface ScheduleMetadata {\n name: string\n jobs: Set<CronMetadata>\n}\n\nexport function getScheduleMetadata(\n target: ClassType,\n context: ClassDecoratorContext,\n): ScheduleMetadata {\n if (context.metadata) {\n const metadata = context.metadata[ScheduleMetadataKey] as\n | ScheduleMetadata\n | undefined\n if (metadata) {\n return metadata\n } else {\n const jobsMetadata = getAllCronMetadata(context)\n const newMetadata: ScheduleMetadata = {\n name: target.name,\n jobs: jobsMetadata,\n }\n context.metadata[ScheduleMetadataKey] = newMetadata\n // @ts-expect-error We add a custom metadata key to the target\n target[ScheduleMetadataKey] = newMetadata\n return newMetadata\n }\n }\n throw new Error('[Navios-Schedule] Wrong environment.')\n}\n\nexport function extractScheduleMetadata(target: ClassType): ScheduleMetadata {\n // @ts-expect-error We add a custom metadata key to the target\n const metadata = target[ScheduleMetadataKey] as ScheduleMetadata | undefined\n if (!metadata) {\n throw new Error(\n '[Navios-Schedule] Controller metadata not found. Make sure to use @Controller decorator.',\n )\n }\n return metadata\n}\n\nexport function hasScheduleMetadata(target: ClassType): boolean {\n // @ts-expect-error We add a custom metadata key to the target\n const metadata = target[ScheduleMetadataKey] as ScheduleMetadata | undefined\n\n return !!metadata\n}\n","import type { CronJobParams } from 'cron'\n\nimport { getCronMetadata } from '../metadata/index.mjs'\n\n/**\n * Options for configuring a cron job.\n * \n * @public\n */\nexport interface CronOptions {\n /**\n * Whether the job should be disabled by default.\n * Disabled jobs won't start automatically but can be manually started later.\n * \n * @default false\n */\n disabled?: boolean\n}\n\n/**\n * Decorator that marks a method to run on a cron schedule.\n * \n * The method must be in a class decorated with `@Schedulable()`.\n * The method will be automatically executed according to the provided cron expression.\n * \n * @param cronTime - Cron expression (5 or 6 fields) or a pre-defined Schedule constant\n * @param options - Optional configuration for the cron job\n * \n * @example\n * ```typescript\n * @Schedulable()\n * class TaskService {\n * // Run daily at midnight\n * @Cron('0 0 * * *')\n * async dailyTask() {\n * console.log('Running daily task')\n * }\n * \n * // Use pre-defined schedule\n * @Cron(Schedule.EveryFiveMinutes)\n * async frequentTask() {\n * console.log('Running every 5 minutes')\n * }\n * \n * // Disabled job (won't start automatically)\n * @Cron('0 2 * * *', { disabled: true })\n * async maintenanceTask() {\n * console.log('Maintenance task')\n * }\n * }\n * ```\n * \n * @throws {Error} If applied to something other than a method\n * \n * @public\n */\nexport function Cron(\n cronTime: CronJobParams['cronTime'],\n options?: CronOptions,\n) {\n return (\n target: () => Promise<void>,\n context: ClassMethodDecoratorContext,\n ) => {\n if (context.kind !== 'method') {\n throw new Error(\n `Cron can only be applied to methods, not ${context.kind}`,\n )\n }\n if (context.metadata) {\n const metadata = getCronMetadata(target, context)\n metadata.cronTime = cronTime\n metadata.disabled = options?.disabled ?? false\n }\n return target\n }\n}\n","import type { ClassType } from '@navios/core'\n\nimport { Injectable } from '@navios/core'\n\nimport { getScheduleMetadata } from '../metadata/index.mjs'\n\n/**\n * Decorator that marks a class as schedulable and makes it injectable.\n * \n * Classes decorated with `@Schedulable()` can contain methods decorated with `@Cron()`\n * that will be automatically scheduled and executed. This decorator also applies\n * the `@Injectable()` decorator, making the class available for dependency injection.\n * \n * @example\n * ```typescript\n * @Schedulable()\n * class TaskService {\n * @Cron('0 0 * * *')\n * async dailyTask() {\n * // This will run daily at midnight\n * }\n * }\n * \n * // Register the service\n * schedulerService.register(TaskService)\n * ```\n * \n * @throws {Error} If applied to something other than a class\n * \n * @public\n */\nexport function Schedulable() {\n return (target: ClassType, context: ClassDecoratorContext) => {\n if (context.kind !== 'class') {\n throw new Error(\n `SchedulableDecorator can only be applied to classes, not ${context.kind}`,\n )\n }\n if (context.metadata) {\n getScheduleMetadata(target, context)\n }\n return Injectable()(target, context)\n }\n}\n","/**\n * Pre-defined cron schedule constants for common scheduling patterns.\n *\n * These constants provide convenient shortcuts for frequently used cron expressions,\n * making it easier to schedule jobs without manually writing cron expressions.\n *\n * @example\n * ```typescript\n * import { Schedule } from '@navios/schedule'\n *\n * @Schedulable()\n * class TaskService {\n * @Cron(Schedule.EveryMinute)\n * async everyMinute() {}\n *\n * @Cron(Schedule.EveryHour)\n * async hourly() {}\n *\n * @Cron(Schedule.EveryDay)\n * async daily() {}\n * }\n * ```\n *\n * @public\n */\nexport enum Schedule {\n EveryMinute = '*/1 * * * *',\n EveryFiveMinutes = '*/5 * * * *',\n EveryTenMinutes = '*/10 * * * *',\n EveryFifteenMinutes = '*/15 * * * *',\n EveryThirtyMinutes = '*/30 * * * *',\n EveryHour = '0 * * * *',\n EveryTwoHours = '0 */2 * * *',\n EveryThreeHours = '0 */3 * * *',\n EveryFourHours = '0 */4 * * *',\n EverySixHours = '0 */6 * * *',\n EveryTwelveHours = '0 */12 * * *',\n EveryDay = '0 0 * * *',\n EveryWeek = '0 0 * * 0',\n EveryMonth = '0 0 1 * *',\n}\n","import type { ClassType } from '@navios/core'\n\nimport { Container, inject, Injectable, Logger } from '@navios/core'\n\nimport { CronJob } from 'cron'\n\nimport type { ScheduleMetadata } from './metadata/index.mjs'\n\nimport {\n extractScheduleMetadata,\n hasScheduleMetadata,\n} from './metadata/index.mjs'\n\n/**\n * Service responsible for managing and executing scheduled cron jobs.\n * \n * The SchedulerService registers schedulable services decorated with `@Schedulable()`\n * and automatically starts their cron jobs based on the `@Cron()` decorator configuration.\n * \n * @example\n * ```typescript\n * import { inject, Injectable } from '@navios/core'\n * import { SchedulerService } from '@navios/schedule'\n * \n * @Injectable()\n * class AppModule {\n * private readonly scheduler = inject(SchedulerService)\n * \n * async onModuleInit() {\n * this.scheduler.register(MySchedulableService)\n * }\n * }\n * ```\n * \n * @public\n */\n@Injectable()\nexport class SchedulerService {\n private readonly logger = inject(Logger, {\n context: SchedulerService.name,\n })\n private readonly container = inject(Container)\n private readonly jobs: Map<string, CronJob> = new Map()\n\n /**\n * Registers a schedulable service and starts all its cron jobs.\n * \n * The service must be decorated with `@Schedulable()` and contain methods\n * decorated with `@Cron()` to be registered successfully.\n * \n * @param service - The schedulable service class to register\n * @throws {Error} If the service is not decorated with `@Schedulable()`\n * \n * @example\n * ```typescript\n * @Schedulable()\n * class TaskService {\n * @Cron('0 0 * * *')\n * async dailyTask() {\n * // Runs daily at midnight\n * }\n * }\n * \n * schedulerService.register(TaskService)\n * ```\n * \n * @public\n */\n register(service: ClassType) {\n if (!hasScheduleMetadata(service)) {\n throw new Error(\n `[Navios-Schedule] Service ${service.name} is not schedulable. Make sure to use @Schedulable decorator.`,\n )\n }\n const metadata = extractScheduleMetadata(service)\n this.logger.debug('Scheduling service', metadata.name)\n this.registerJobs(service, metadata)\n }\n\n /**\n * Retrieves a specific cron job instance for a method in a schedulable service.\n * \n * @param service - The schedulable service class\n * @param method - The name of the method decorated with `@Cron()`\n * @returns The CronJob instance if found, undefined otherwise\n * \n * @example\n * ```typescript\n * const job = schedulerService.getJob(TaskService, 'dailyTask')\n * if (job) {\n * console.log('Job is active:', job.isActive)\n * job.start() // Manually start the job\n * job.stop() // Manually stop the job\n * }\n * ```\n * \n * @public\n */\n getJob<T extends ClassType>(\n service: T,\n method: keyof InstanceType<T>,\n ): CronJob | undefined {\n const metadata = extractScheduleMetadata(service)\n const jobName = `${metadata.name}.${method as string}()`\n return this.jobs.get(jobName)\n }\n\n private registerJobs(service: ClassType, metadata: ScheduleMetadata) {\n const jobs = metadata.jobs\n for (const job of jobs) {\n if (!job.cronTime) {\n this.logger.debug('Skipping job', job.classMethod)\n continue\n }\n const name = `${metadata.name}.${job.classMethod}()`\n const self = this\n const defaultDisabled = false\n const cronJob = CronJob.from({\n cronTime: job.cronTime,\n name,\n async onTick() {\n try {\n self.logger.debug('Executing job', name)\n const instance = await self.container.get(service)\n await instance[job.classMethod]()\n } catch (error) {\n self.logger.error('Error executing job', name, error)\n }\n },\n start: !(defaultDisabled || job.disabled),\n })\n this.jobs.set(name, cronJob)\n }\n }\n\n /**\n * Starts all registered cron jobs that are currently inactive.\n * \n * Only jobs that are not already active will be started. This method\n * is useful for resuming all jobs after calling `stopAll()`.\n * \n * @example\n * ```typescript\n * // Stop all jobs\n * schedulerService.stopAll()\n * \n * // Later, resume all jobs\n * schedulerService.startAll()\n * ```\n * \n * @public\n */\n startAll() {\n for (const job of this.jobs.values()) {\n if (job.isActive) {\n continue\n }\n job.start()\n }\n }\n\n /**\n * Stops all registered cron jobs that are currently active.\n * \n * Only jobs that are currently active will be stopped. This method\n * is useful for pausing all scheduled tasks, for example during\n * application shutdown or maintenance.\n * \n * @example\n * ```typescript\n * // Pause all scheduled jobs\n * schedulerService.stopAll()\n * \n * // Jobs can be resumed later with startAll()\n * schedulerService.startAll()\n * ```\n * \n * @public\n */\n stopAll() {\n for (const job of this.jobs.values()) {\n if (!job.isActive) {\n continue\n }\n job.stop()\n }\n }\n}\n"],"mappings":";;;;AAEA,MAAa,kBAAkB,OAAO,kBAAkB;AAQxD,SAAgB,mBACd,SACmB;AACnB,KAAI,QAAQ,UAAU;EACpB,MAAM,WAAW,QAAQ,SAAS;AAGlC,MAAI,SACF,QAAO;OACF;AACL,WAAQ,SAAS,mCAAmB,IAAI,KAAmB;AAC3D,UAAO,QAAQ,SAAS;;;AAG5B,OAAM,IAAI,MAAM,uCAAuC;;AAGzD,SAAgB,gBACd,QACA,SACc;AACd,KAAI,QAAQ,UAAU;EACpB,MAAM,WAAW,mBAAmB,QAAQ;AAC5C,MAAI,UAAU;GACZ,MAAM,mBAAmB,MAAM,KAAK,SAAS,CAAC,MAC3C,SAAS,KAAK,gBAAgB,OAAO,KACvC;AACD,OAAI,iBACF,QAAO;QACF;IACL,MAAMA,cAA4B;KAChC,aAAa,OAAO;KACpB,UAAU;KACV,UAAU;KACX;AACD,aAAS,IAAI,YAAY;AACzB,WAAO;;;;AAIb,OAAM,IAAI,MAAM,uCAAuC;;;;;AC5CzD,MAAaE,sBAAsBC,OAAO,wBAAA;AAO1C,SAAgBC,oBACdC,QACAC,SAA8B;AAE9B,KAAIA,QAAQC,UAAU;EACpB,MAAMA,WAAWD,QAAQC,SAASL;AAGlC,MAAIK,SACF,QAAOA;OACF;GACL,MAAMC,eAAeP,mBAAmBK,QAAAA;GACxC,MAAMG,cAAgC;IACpCC,MAAML,OAAOK;IACbC,MAAMH;IACR;AACAF,WAAQC,SAASL,uBAAuBO;AAExCJ,UAAOH,uBAAuBO;AAC9B,UAAOA;;;AAGX,OAAM,IAAIG,MAAM,uCAAA;;AAGlB,SAAgBC,wBAAwBR,QAAiB;CAEvD,MAAME,WAAWF,OAAOH;AACxB,KAAI,CAACK,SACH,OAAM,IAAIK,MACR,2FAAA;AAGJ,QAAOL;;AAGT,SAAgBO,oBAAoBT,QAAiB;AAInD,QAAO,CAAC,CAFSA,OAAOH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GCK1B,SAAgBc,KACdC,UACAC,SAAqB;AAErB,SACEC,QACAC,YAAAA;AAEA,MAAIA,QAAQC,SAAS,SACnB,OAAM,IAAIC,MACR,4CAA4CF,QAAQC,OAAM;AAG9D,MAAID,QAAQG,UAAU;GACpB,MAAMA,WAAWR,gBAAgBI,QAAQC,QAAAA;AACzCG,YAASN,WAAWA;AACpBM,YAASC,WAAWN,SAASM,YAAY;;AAE3C,SAAOL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GC3CX,SAAgBQ,cAAAA;AACd,SAAQC,QAAmBC,YAAAA;AACzB,MAAIA,QAAQC,SAAS,QACnB,OAAM,IAAIC,MACR,4DAA4DF,QAAQC,OAAM;AAG9E,MAAID,QAAQG,SACVN,qBAAoBE,QAAQC,QAAAA;AAE9B,SAAOJ,YAAAA,CAAaG,QAAQC,QAAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GChBhC,IAAO,WAAKI,yBAAAA,YAAAA;;;;;;;;;;;;;;;QAAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OCWXG,YAAAA;AACM,IAAMK,mBAAN,MAAMA;;;;CACMC,SAASP,OAAOE,QAAQ,EACvCM,SAASF,kBAAiBG,MAC5B,CAAA;CACiBC,YAAYV,OAAOD,UAAAA;CACnBY,uBAA6B,IAAIC,KAAAA;;;;;;;;;;;;;;;;;;;;;;;;IA0BlDC,SAASC,SAAoB;AAC3B,MAAI,CAACT,oBAAoBS,QAAAA,CACvB,OAAM,IAAIC,MACR,6BAA6BD,QAAQL,KAAK,+DAA8D;EAG5G,MAAMO,WAAWZ,wBAAwBU,QAAAA;AACzC,OAAKP,OAAOU,MAAM,sBAAsBD,SAASP,KAAI;AACrD,OAAKS,aAAaJ,SAASE,SAAAA;;;;;;;;;;;;;;;;;;;;IAsB7BG,OACEL,SACAM,QACqB;EAErB,MAAMC,UAAU,GADCjB,wBAAwBU,QAAAA,CACbL,KAAK,GAAGW,OAAiB;AACrD,SAAO,KAAKT,KAAKW,IAAID,QAAAA;;CAGfH,aAAaJ,SAAoBE,UAA4B;EACnE,MAAML,OAAOK,SAASL;AACtB,OAAK,MAAMY,OAAOZ,MAAM;AACtB,OAAI,CAACY,IAAIC,UAAU;AACjB,SAAKjB,OAAOU,MAAM,gBAAgBM,IAAIE,YAAW;AACjD;;GAEF,MAAMhB,OAAO,GAAGO,SAASP,KAAK,GAAGc,IAAIE,YAAY;GACjD,MAAMC,OAAO;GAEb,MAAME,UAAUzB,QAAQ0B,KAAK;IAC3BL,UAAUD,IAAIC;IACdf;IACA,MAAMqB,SAAAA;AACJ,SAAI;AACFJ,WAAKnB,OAAOU,MAAM,iBAAiBR,KAAAA;AAEnC,aADiB,MAAMiB,KAAKhB,UAAUY,IAAIR,QAAAA,EAC3BS,IAAIE,cAAY;cACxBO,OAAO;AACdN,WAAKnB,OAAOyB,MAAM,uBAAuBvB,MAAMuB,MAAAA;;;IAGnDC,OAAO,CAAqBV,IAAIW;IAClC,CAAA;AACA,QAAKvB,KAAKwB,IAAI1B,MAAMmB,QAAAA;;;;;;;;;;;;;;;;;;;IAqBxBQ,WAAW;AACT,OAAK,MAAMb,OAAO,KAAKZ,KAAK0B,QAAM,EAAI;AACpC,OAAId,IAAIe,SACN;AAEFf,OAAIU,OAAK;;;;;;;;;;;;;;;;;;;;IAsBbM,UAAU;AACR,OAAK,MAAMhB,OAAO,KAAKZ,KAAK0B,QAAM,EAAI;AACpC,OAAI,CAACd,IAAIe,SACP;AAEFf,OAAIiB,MAAI"}
1
+ {"version":3,"file":"index.mjs","names":["newMetadata: CronMetadata","getAllCronMetadata","ScheduleMetadataKey","Symbol","getScheduleMetadata","target","context","metadata","jobsMetadata","newMetadata","name","jobs","Error","extractScheduleMetadata","hasScheduleMetadata","getCronMetadata","Cron","cronTime","options","target","context","kind","Error","metadata","disabled","globalRegistry","Injectable","getScheduleMetadata","Schedulable","registry","target","context","kind","Error","metadata","Schedule","Container","inject","Injectable","Logger","CronJob","extractScheduleMetadata","hasScheduleMetadata","SchedulerService","logger","context","name","container","jobs","Map","register","service","Error","metadata","debug","registerJobs","getJob","method","jobName","get","job","cronTime","classMethod","self","defaultDisabled","cronJob","from","onTick","instance","error","start","disabled","set","startAll","values","isActive","stopAll","stop"],"sources":["../src/metadata/cron.metadata.mts","../src/metadata/schedule.metadata.mts","../src/decorators/cron.decorator.mts","../src/decorators/schedulable.decorator.mts","../src/cron.constants.mts","../src/scheduler.service.mts"],"sourcesContent":["import type { CronJobParams } from 'cron'\n\nexport const CronMetadataKey = Symbol('CronMetadataKey')\n\nexport interface CronMetadata {\n classMethod: string\n cronTime: CronJobParams['cronTime'] | null\n disabled: boolean\n}\n\nexport function getAllCronMetadata(\n context: ClassMethodDecoratorContext | ClassDecoratorContext,\n): Set<CronMetadata> {\n if (context.metadata) {\n const metadata = context.metadata[CronMetadataKey] as\n | Set<CronMetadata>\n | undefined\n if (metadata) {\n return metadata\n } else {\n context.metadata[CronMetadataKey] = new Set<CronMetadata>()\n return context.metadata[CronMetadataKey] as Set<CronMetadata>\n }\n }\n throw new Error('[Navios-Schedule] Wrong environment.')\n}\n\nexport function getCronMetadata(\n target: Function,\n context: ClassMethodDecoratorContext,\n): CronMetadata {\n if (context.metadata) {\n const metadata = getAllCronMetadata(context)\n if (metadata) {\n const endpointMetadata = Array.from(metadata).find(\n (item) => item.classMethod === target.name,\n )\n if (endpointMetadata) {\n return endpointMetadata\n } else {\n const newMetadata: CronMetadata = {\n classMethod: target.name,\n cronTime: null,\n disabled: false,\n }\n metadata.add(newMetadata)\n return newMetadata\n }\n }\n }\n throw new Error('[Navios-Schedule] Wrong environment.')\n}\n","import type { ClassType } from '@navios/core'\n\nimport type { CronMetadata } from './cron.metadata.mjs'\n\nimport { getAllCronMetadata } from './cron.metadata.mjs'\n\nexport const ScheduleMetadataKey = Symbol('ControllerMetadataKey')\n\nexport interface ScheduleMetadata {\n name: string\n jobs: Set<CronMetadata>\n}\n\nexport function getScheduleMetadata(\n target: ClassType,\n context: ClassDecoratorContext,\n): ScheduleMetadata {\n if (context.metadata) {\n const metadata = context.metadata[ScheduleMetadataKey] as\n | ScheduleMetadata\n | undefined\n if (metadata) {\n return metadata\n } else {\n const jobsMetadata = getAllCronMetadata(context)\n const newMetadata: ScheduleMetadata = {\n name: target.name,\n jobs: jobsMetadata,\n }\n context.metadata[ScheduleMetadataKey] = newMetadata\n // @ts-expect-error We add a custom metadata key to the target\n target[ScheduleMetadataKey] = newMetadata\n return newMetadata\n }\n }\n throw new Error('[Navios-Schedule] Wrong environment.')\n}\n\nexport function extractScheduleMetadata(target: ClassType): ScheduleMetadata {\n // @ts-expect-error We add a custom metadata key to the target\n const metadata = target[ScheduleMetadataKey] as ScheduleMetadata | undefined\n if (!metadata) {\n throw new Error(\n '[Navios-Schedule] Controller metadata not found. Make sure to use @Controller decorator.',\n )\n }\n return metadata\n}\n\nexport function hasScheduleMetadata(target: ClassType): boolean {\n // @ts-expect-error We add a custom metadata key to the target\n const metadata = target[ScheduleMetadataKey] as ScheduleMetadata | undefined\n\n return !!metadata\n}\n","import type { CronJobParams } from 'cron'\n\nimport { getCronMetadata } from '../metadata/index.mjs'\n\n/**\n * Options for configuring a cron job.\n * \n * @public\n */\nexport interface CronOptions {\n /**\n * Whether the job should be disabled by default.\n * Disabled jobs won't start automatically but can be manually started later.\n * \n * @default false\n */\n disabled?: boolean\n}\n\n/**\n * Decorator that marks a method to run on a cron schedule.\n * \n * The method must be in a class decorated with `@Schedulable()`.\n * The method will be automatically executed according to the provided cron expression.\n * \n * @param cronTime - Cron expression (5 or 6 fields) or a pre-defined Schedule constant\n * @param options - Optional configuration for the cron job\n * \n * @example\n * ```typescript\n * @Schedulable()\n * class TaskService {\n * // Run daily at midnight\n * @Cron('0 0 * * *')\n * async dailyTask() {\n * console.log('Running daily task')\n * }\n * \n * // Use pre-defined schedule\n * @Cron(Schedule.EveryFiveMinutes)\n * async frequentTask() {\n * console.log('Running every 5 minutes')\n * }\n * \n * // Disabled job (won't start automatically)\n * @Cron('0 2 * * *', { disabled: true })\n * async maintenanceTask() {\n * console.log('Maintenance task')\n * }\n * }\n * ```\n * \n * @throws {Error} If applied to something other than a method\n * \n * @public\n */\nexport function Cron(\n cronTime: CronJobParams['cronTime'],\n options?: CronOptions,\n) {\n return (\n target: () => Promise<void>,\n context: ClassMethodDecoratorContext,\n ) => {\n if (context.kind !== 'method') {\n throw new Error(\n `Cron can only be applied to methods, not ${context.kind}`,\n )\n }\n if (context.metadata) {\n const metadata = getCronMetadata(target, context)\n metadata.cronTime = cronTime\n metadata.disabled = options?.disabled ?? false\n }\n return target\n }\n}\n","import type { ClassType } from '@navios/core'\n\nimport { globalRegistry, Injectable, Registry } from '@navios/core'\n\nimport { getScheduleMetadata } from '../metadata/index.mjs'\n\n/**\n * Decorator that marks a class as schedulable and makes it injectable.\n *\n * Classes decorated with `@Schedulable()` can contain methods decorated with `@Cron()`\n * that will be automatically scheduled and executed. This decorator also applies\n * the `@Injectable()` decorator, making the class available for dependency injection.\n *\n * @example\n * ```typescript\n * @Schedulable()\n * class TaskService {\n * @Cron('0 0 * * *')\n * async dailyTask() {\n * // This will run daily at midnight\n * }\n * }\n *\n * // Register the service\n * schedulerService.register(TaskService)\n * ```\n *\n * @throws {Error} If applied to something other than a class\n *\n * @public\n */\nexport function Schedulable({ registry }: { registry?: Registry } = {}) {\n return (target: ClassType, context: ClassDecoratorContext) => {\n if (context.kind !== 'class') {\n throw new Error(\n `SchedulableDecorator can only be applied to classes, not ${context.kind}`,\n )\n }\n if (context.metadata) {\n getScheduleMetadata(target, context)\n }\n return Injectable({ registry: registry ?? globalRegistry })(target, context)\n }\n}\n","/**\n * Pre-defined cron schedule constants for common scheduling patterns.\n *\n * These constants provide convenient shortcuts for frequently used cron expressions,\n * making it easier to schedule jobs without manually writing cron expressions.\n *\n * @example\n * ```typescript\n * import { Schedule } from '@navios/schedule'\n *\n * @Schedulable()\n * class TaskService {\n * @Cron(Schedule.EveryMinute)\n * async everyMinute() {}\n *\n * @Cron(Schedule.EveryHour)\n * async hourly() {}\n *\n * @Cron(Schedule.EveryDay)\n * async daily() {}\n * }\n * ```\n *\n * @public\n */\nexport enum Schedule {\n EveryMinute = '*/1 * * * *',\n EveryFiveMinutes = '*/5 * * * *',\n EveryTenMinutes = '*/10 * * * *',\n EveryFifteenMinutes = '*/15 * * * *',\n EveryThirtyMinutes = '*/30 * * * *',\n EveryHour = '0 * * * *',\n EveryTwoHours = '0 */2 * * *',\n EveryThreeHours = '0 */3 * * *',\n EveryFourHours = '0 */4 * * *',\n EverySixHours = '0 */6 * * *',\n EveryTwelveHours = '0 */12 * * *',\n EveryDay = '0 0 * * *',\n EveryWeek = '0 0 * * 0',\n EveryMonth = '0 0 1 * *',\n}\n","import type { ClassType } from '@navios/core'\n\nimport { Container, inject, Injectable, Logger } from '@navios/core'\n\nimport { CronJob } from 'cron'\n\nimport type { ScheduleMetadata } from './metadata/index.mjs'\n\nimport {\n extractScheduleMetadata,\n hasScheduleMetadata,\n} from './metadata/index.mjs'\n\n/**\n * Service responsible for managing and executing scheduled cron jobs.\n * \n * The SchedulerService registers schedulable services decorated with `@Schedulable()`\n * and automatically starts their cron jobs based on the `@Cron()` decorator configuration.\n * \n * @example\n * ```typescript\n * import { inject, Injectable } from '@navios/core'\n * import { SchedulerService } from '@navios/schedule'\n * \n * @Injectable()\n * class AppModule {\n * private readonly scheduler = inject(SchedulerService)\n * \n * async onModuleInit() {\n * this.scheduler.register(MySchedulableService)\n * }\n * }\n * ```\n * \n * @public\n */\n@Injectable()\nexport class SchedulerService {\n private readonly logger = inject(Logger, {\n context: SchedulerService.name,\n })\n private readonly container = inject(Container)\n private readonly jobs: Map<string, CronJob> = new Map()\n\n /**\n * Registers a schedulable service and starts all its cron jobs.\n * \n * The service must be decorated with `@Schedulable()` and contain methods\n * decorated with `@Cron()` to be registered successfully.\n * \n * @param service - The schedulable service class to register\n * @throws {Error} If the service is not decorated with `@Schedulable()`\n * \n * @example\n * ```typescript\n * @Schedulable()\n * class TaskService {\n * @Cron('0 0 * * *')\n * async dailyTask() {\n * // Runs daily at midnight\n * }\n * }\n * \n * schedulerService.register(TaskService)\n * ```\n * \n * @public\n */\n register(service: ClassType) {\n if (!hasScheduleMetadata(service)) {\n throw new Error(\n `[Navios-Schedule] Service ${service.name} is not schedulable. Make sure to use @Schedulable decorator.`,\n )\n }\n const metadata = extractScheduleMetadata(service)\n this.logger.debug('Scheduling service', metadata.name)\n this.registerJobs(service, metadata)\n }\n\n /**\n * Retrieves a specific cron job instance for a method in a schedulable service.\n * \n * @param service - The schedulable service class\n * @param method - The name of the method decorated with `@Cron()`\n * @returns The CronJob instance if found, undefined otherwise\n * \n * @example\n * ```typescript\n * const job = schedulerService.getJob(TaskService, 'dailyTask')\n * if (job) {\n * console.log('Job is active:', job.isActive)\n * job.start() // Manually start the job\n * job.stop() // Manually stop the job\n * }\n * ```\n * \n * @public\n */\n getJob<T extends ClassType>(\n service: T,\n method: keyof InstanceType<T>,\n ): CronJob | undefined {\n const metadata = extractScheduleMetadata(service)\n const jobName = `${metadata.name}.${method as string}()`\n return this.jobs.get(jobName)\n }\n\n private registerJobs(service: ClassType, metadata: ScheduleMetadata) {\n const jobs = metadata.jobs\n for (const job of jobs) {\n if (!job.cronTime) {\n this.logger.debug('Skipping job', job.classMethod)\n continue\n }\n const name = `${metadata.name}.${job.classMethod}()`\n const self = this\n const defaultDisabled = false\n const cronJob = CronJob.from({\n cronTime: job.cronTime,\n name,\n async onTick() {\n try {\n self.logger.debug('Executing job', name)\n const instance = await self.container.get(service)\n await instance[job.classMethod]()\n } catch (error) {\n self.logger.error('Error executing job', name, error)\n }\n },\n start: !(defaultDisabled || job.disabled),\n })\n this.jobs.set(name, cronJob)\n }\n }\n\n /**\n * Starts all registered cron jobs that are currently inactive.\n * \n * Only jobs that are not already active will be started. This method\n * is useful for resuming all jobs after calling `stopAll()`.\n * \n * @example\n * ```typescript\n * // Stop all jobs\n * schedulerService.stopAll()\n * \n * // Later, resume all jobs\n * schedulerService.startAll()\n * ```\n * \n * @public\n */\n startAll() {\n for (const job of this.jobs.values()) {\n if (job.isActive) {\n continue\n }\n job.start()\n }\n }\n\n /**\n * Stops all registered cron jobs that are currently active.\n * \n * Only jobs that are currently active will be stopped. This method\n * is useful for pausing all scheduled tasks, for example during\n * application shutdown or maintenance.\n * \n * @example\n * ```typescript\n * // Pause all scheduled jobs\n * schedulerService.stopAll()\n * \n * // Jobs can be resumed later with startAll()\n * schedulerService.startAll()\n * ```\n * \n * @public\n */\n stopAll() {\n for (const job of this.jobs.values()) {\n if (!job.isActive) {\n continue\n }\n job.stop()\n }\n }\n}\n"],"mappings":";;;;AAEA,MAAa,kBAAkB,OAAO,kBAAkB;AAQxD,SAAgB,mBACd,SACmB;AACnB,KAAI,QAAQ,UAAU;EACpB,MAAM,WAAW,QAAQ,SAAS;AAGlC,MAAI,SACF,QAAO;OACF;AACL,WAAQ,SAAS,mCAAmB,IAAI,KAAmB;AAC3D,UAAO,QAAQ,SAAS;;;AAG5B,OAAM,IAAI,MAAM,uCAAuC;;AAGzD,SAAgB,gBACd,QACA,SACc;AACd,KAAI,QAAQ,UAAU;EACpB,MAAM,WAAW,mBAAmB,QAAQ;AAC5C,MAAI,UAAU;GACZ,MAAM,mBAAmB,MAAM,KAAK,SAAS,CAAC,MAC3C,SAAS,KAAK,gBAAgB,OAAO,KACvC;AACD,OAAI,iBACF,QAAO;QACF;IACL,MAAMA,cAA4B;KAChC,aAAa,OAAO;KACpB,UAAU;KACV,UAAU;KACX;AACD,aAAS,IAAI,YAAY;AACzB,WAAO;;;;AAIb,OAAM,IAAI,MAAM,uCAAuC;;;;;AC5CzD,MAAaE,sBAAsBC,OAAO,wBAAA;AAO1C,SAAgBC,oBACdC,QACAC,SAA8B;AAE9B,KAAIA,QAAQC,UAAU;EACpB,MAAMA,WAAWD,QAAQC,SAASL;AAGlC,MAAIK,SACF,QAAOA;OACF;GACL,MAAMC,eAAeP,mBAAmBK,QAAAA;GACxC,MAAMG,cAAgC;IACpCC,MAAML,OAAOK;IACbC,MAAMH;IACR;AACAF,WAAQC,SAASL,uBAAuBO;AAExCJ,UAAOH,uBAAuBO;AAC9B,UAAOA;;;AAGX,OAAM,IAAIG,MAAM,uCAAA;;AAGlB,SAAgBC,wBAAwBR,QAAiB;CAEvD,MAAME,WAAWF,OAAOH;AACxB,KAAI,CAACK,SACH,OAAM,IAAIK,MACR,2FAAA;AAGJ,QAAOL;;AAGT,SAAgBO,oBAAoBT,QAAiB;AAInD,QAAO,CAAC,CAFSA,OAAOH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GCK1B,SAAgBc,KACdC,UACAC,SAAqB;AAErB,SACEC,QACAC,YAAAA;AAEA,MAAIA,QAAQC,SAAS,SACnB,OAAM,IAAIC,MACR,4CAA4CF,QAAQC,OAAM;AAG9D,MAAID,QAAQG,UAAU;GACpB,MAAMA,WAAWR,gBAAgBI,QAAQC,QAAAA;AACzCG,YAASN,WAAWA;AACpBM,YAASC,WAAWN,SAASM,YAAY;;AAE3C,SAAOL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GC3CX,SAAgBS,YAAY,EAAEC,aAAsC,EAAE,EAAA;AACpE,SAAQC,QAAmBC,YAAAA;AACzB,MAAIA,QAAQC,SAAS,QACnB,OAAM,IAAIC,MACR,4DAA4DF,QAAQC,OAAM;AAG9E,MAAID,QAAQG,SACVP,qBAAoBG,QAAQC,QAAAA;AAE9B,SAAOL,WAAW,EAAEG,UAAUA,YAAYJ,gBAAe,CAAA,CAAGK,QAAQC,QAAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GChBxE,IAAO,WAAKI,yBAAAA,YAAAA;;;;;;;;;;;;;;;QAAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OCWXG,YAAAA;AACM,IAAMK,mBAAN,MAAMA;;;;CACMC,SAASP,OAAOE,QAAQ,EACvCM,SAASF,kBAAiBG,MAC5B,CAAA;CACiBC,YAAYV,OAAOD,UAAAA;CACnBY,uBAA6B,IAAIC,KAAAA;;;;;;;;;;;;;;;;;;;;;;;;IA0BlDC,SAASC,SAAoB;AAC3B,MAAI,CAACT,oBAAoBS,QAAAA,CACvB,OAAM,IAAIC,MACR,6BAA6BD,QAAQL,KAAK,+DAA8D;EAG5G,MAAMO,WAAWZ,wBAAwBU,QAAAA;AACzC,OAAKP,OAAOU,MAAM,sBAAsBD,SAASP,KAAI;AACrD,OAAKS,aAAaJ,SAASE,SAAAA;;;;;;;;;;;;;;;;;;;;IAsB7BG,OACEL,SACAM,QACqB;EAErB,MAAMC,UAAU,GADCjB,wBAAwBU,QAAAA,CACbL,KAAK,GAAGW,OAAiB;AACrD,SAAO,KAAKT,KAAKW,IAAID,QAAAA;;CAGfH,aAAaJ,SAAoBE,UAA4B;EACnE,MAAML,OAAOK,SAASL;AACtB,OAAK,MAAMY,OAAOZ,MAAM;AACtB,OAAI,CAACY,IAAIC,UAAU;AACjB,SAAKjB,OAAOU,MAAM,gBAAgBM,IAAIE,YAAW;AACjD;;GAEF,MAAMhB,OAAO,GAAGO,SAASP,KAAK,GAAGc,IAAIE,YAAY;GACjD,MAAMC,OAAO;GAEb,MAAME,UAAUzB,QAAQ0B,KAAK;IAC3BL,UAAUD,IAAIC;IACdf;IACA,MAAMqB,SAAAA;AACJ,SAAI;AACFJ,WAAKnB,OAAOU,MAAM,iBAAiBR,KAAAA;AAEnC,aADiB,MAAMiB,KAAKhB,UAAUY,IAAIR,QAAAA,EAC3BS,IAAIE,cAAY;cACxBO,OAAO;AACdN,WAAKnB,OAAOyB,MAAM,uBAAuBvB,MAAMuB,MAAAA;;;IAGnDC,OAAO,CAAqBV,IAAIW;IAClC,CAAA;AACA,QAAKvB,KAAKwB,IAAI1B,MAAMmB,QAAAA;;;;;;;;;;;;;;;;;;;IAqBxBQ,WAAW;AACT,OAAK,MAAMb,OAAO,KAAKZ,KAAK0B,QAAM,EAAI;AACpC,OAAId,IAAIe,SACN;AAEFf,OAAIU,OAAK;;;;;;;;;;;;;;;;;;;;IAsBbM,UAAU;AACR,OAAK,MAAMhB,OAAO,KAAKZ,KAAK0B,QAAM,EAAI;AACpC,OAAI,CAACd,IAAIe,SACP;AAEFf,OAAIiB,MAAI"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@navios/schedule",
3
- "version": "0.8.0",
3
+ "version": "0.9.0",
4
4
  "author": {
5
5
  "name": "Oleksandr Hanzha",
6
6
  "email": "alex@granted.name"
@@ -12,7 +12,7 @@
12
12
  },
13
13
  "license": "MIT",
14
14
  "peerDependencies": {
15
- "@navios/core": "^0.8.0",
15
+ "@navios/core": "^0.9.0",
16
16
  "zod": "^3.25.0 || ^4.0.0"
17
17
  },
18
18
  "typings": "./lib/index.d.mts",
@@ -31,7 +31,7 @@
31
31
  }
32
32
  },
33
33
  "devDependencies": {
34
- "@navios/core": "^0.8.0",
34
+ "@navios/core": "^0.9.0",
35
35
  "typescript": "^5.9.3",
36
36
  "zod": "^4.2.1"
37
37
  },
@@ -1,4 +1,4 @@
1
- import { Container, Injectable } from '@navios/core'
1
+ import { Container, globalRegistry, Injectable, Registry } from '@navios/core'
2
2
 
3
3
  import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
4
4
 
@@ -7,11 +7,13 @@ import { SchedulerService } from '../scheduler.service.mjs'
7
7
 
8
8
  describe('Schedule Module', () => {
9
9
  let container: Container
10
+ let registry: Registry
10
11
  let schedulerService: SchedulerService
11
12
 
12
13
  beforeEach(async () => {
13
14
  vi.useFakeTimers()
14
- container = new Container()
15
+ registry = new Registry(globalRegistry)
16
+ container = new Container(registry)
15
17
  schedulerService = await container.get(SchedulerService)
16
18
  })
17
19
 
@@ -22,7 +24,7 @@ describe('Schedule Module', () => {
22
24
  })
23
25
 
24
26
  it('should register a schedulable service', () => {
25
- @Schedulable()
27
+ @Schedulable({ registry })
26
28
  class TestService {
27
29
  @Cron('*/1 * * * * *')
28
30
  async testJob() {}
@@ -35,7 +37,7 @@ describe('Schedule Module', () => {
35
37
  })
36
38
 
37
39
  it('should throw an error when registering a non-schedulable service', () => {
38
- @Injectable()
40
+ @Injectable({ registry })
39
41
  class NonSchedulableService {
40
42
  async testJob() {}
41
43
  }
@@ -46,7 +48,7 @@ describe('Schedule Module', () => {
46
48
  it('should execute a job at the scheduled time', async () => {
47
49
  const mockJob = vi.fn()
48
50
 
49
- @Schedulable()
51
+ @Schedulable({ registry })
50
52
  class TestService {
51
53
  @Cron('*/1 * * * * *')
52
54
  async testJob() {
@@ -69,7 +71,7 @@ describe('Schedule Module', () => {
69
71
  it('should not execute jobs when they are stopped', async () => {
70
72
  const mockJob = vi.fn()
71
73
 
72
- @Schedulable()
74
+ @Schedulable({ registry })
73
75
  class TestService {
74
76
  @Cron('*/1 * * * * *')
75
77
  async testJob() {
@@ -95,7 +97,7 @@ describe('Schedule Module', () => {
95
97
  const mockJob2 = vi.fn()
96
98
  vi.setSystemTime('2021-01-01T00:00:00.000Z')
97
99
 
98
- @Schedulable()
100
+ @Schedulable({ registry })
99
101
  class TestService {
100
102
  @Cron('*/1 * * * * *')
101
103
  async job1() {
@@ -124,7 +126,7 @@ describe('Schedule Module', () => {
124
126
  it('should handle disabled jobs', async () => {
125
127
  const mockJob = vi.fn()
126
128
 
127
- @Schedulable()
129
+ @Schedulable({ registry })
128
130
  class TestService {
129
131
  @Cron('*/1 * * * * *', { disabled: true })
130
132
  async testJob() {
@@ -144,7 +146,7 @@ describe('Schedule Module', () => {
144
146
  it('should handle errors in job execution without crashing', async () => {
145
147
  const errorSpy = vi.spyOn(console, 'error').mockImplementation(() => {})
146
148
 
147
- @Schedulable()
149
+ @Schedulable({ registry })
148
150
  class TestService {
149
151
  @Cron('*/1 * * * * *')
150
152
  async testJob() {
@@ -1,16 +1,16 @@
1
1
  import type { ClassType } from '@navios/core'
2
2
 
3
- import { Injectable } from '@navios/core'
3
+ import { globalRegistry, Injectable, Registry } from '@navios/core'
4
4
 
5
5
  import { getScheduleMetadata } from '../metadata/index.mjs'
6
6
 
7
7
  /**
8
8
  * Decorator that marks a class as schedulable and makes it injectable.
9
- *
9
+ *
10
10
  * Classes decorated with `@Schedulable()` can contain methods decorated with `@Cron()`
11
11
  * that will be automatically scheduled and executed. This decorator also applies
12
12
  * the `@Injectable()` decorator, making the class available for dependency injection.
13
- *
13
+ *
14
14
  * @example
15
15
  * ```typescript
16
16
  * @Schedulable()
@@ -20,16 +20,16 @@ import { getScheduleMetadata } from '../metadata/index.mjs'
20
20
  * // This will run daily at midnight
21
21
  * }
22
22
  * }
23
- *
23
+ *
24
24
  * // Register the service
25
25
  * schedulerService.register(TaskService)
26
26
  * ```
27
- *
27
+ *
28
28
  * @throws {Error} If applied to something other than a class
29
- *
29
+ *
30
30
  * @public
31
31
  */
32
- export function Schedulable() {
32
+ export function Schedulable({ registry }: { registry?: Registry } = {}) {
33
33
  return (target: ClassType, context: ClassDecoratorContext) => {
34
34
  if (context.kind !== 'class') {
35
35
  throw new Error(
@@ -39,6 +39,6 @@ export function Schedulable() {
39
39
  if (context.metadata) {
40
40
  getScheduleMetadata(target, context)
41
41
  }
42
- return Injectable()(target, context)
42
+ return Injectable({ registry: registry ?? globalRegistry })(target, context)
43
43
  }
44
44
  }