fix: change the module export style

BREAKING CHANGE: all modules will be exported from the main entrypoint

README.md

@@ -51,9 +51,8 @@ $ npm install cronyx
 Here's how you can schedule an hourly task with Cronyx and manage the job's lifecycle manually:
 
 ```ts
-import Cronyx from "cronyx";
 // MysqlJobStore, PostgresJobStore and RedisJobStore are also available out of the box
-import { MongodbJobStore } from "cronyx/job-store";
+import Cronyx, { MongodbJobStore } from "cronyx";
 
 const jobStore = await MongodbJobStore.connect("mongodb://mongo:27017/db");
 const cronyx = new Cronyx({ jobStore });

examples/basic/automatic-job-management.ts

@@ -1,6 +1,5 @@
 #!/usr/bin/env bun
-import Cronyx from "../../src";
-import { MongodbJobStore } from "../../src/job-store";
+import Cronyx, { MongodbJobStore } from "../../src";
 
 const jobStore = await MongodbJobStore.connect(Bun.env.MONGO_URI!);
 const cronyx = new Cronyx({ jobStore });

examples/basic/manual-job-management.ts

@@ -1,6 +1,5 @@
 #!/usr/bin/env bun
-import Cronyx from "../../src";
-import { MongodbJobStore } from "../../src/job-store";
+import Cronyx, { MongodbJobStore } from "../../src";
 
 const jobStore = await MongodbJobStore.connect(Bun.env.MONGO_URI!);
 const cronyx = new Cronyx({ jobStore });

examples/job-dependency.ts/child-job.ts → examples/job-dependency/child-job.ts

@@ -1,6 +1,5 @@
 #!/usr/bin/env bun
-import Cronyx from "../../src";
-import { MongodbJobStore } from "../../src/job-store";
+import Cronyx, { MongodbJobStore } from "../../src";
 
 const jobStore = await MongodbJobStore.connect(Bun.env.MONGO_URI!);
 const cronyx = new Cronyx({ jobStore });

examples/job-dependency.ts/parent-job.ts → examples/job-dependency/parent-job.ts

@@ -1,6 +1,5 @@
 #!/usr/bin/env bun
-import Cronyx from "../../src";
-import { MongodbJobStore } from "../../src/job-store";
+import Cronyx, { MongodbJobStore } from "../../src";
 
 const jobStore = await MongodbJobStore.connect(Bun.env.MONGO_URI!);
 const cronyx = new Cronyx({ jobStore });

examples/job-stores/custom-job-store.ts

@@ -1,9 +1,8 @@
 #!/usr/bin/env bun
 import { isEqual } from "date-fns";
 import { v4 } from "uuid";
-import Cronyx from "../../src";
-import { BaseJobLock } from "../../src/job-lock";
-import { BaseJobStore } from "../../src/job-store";
+import Cronyx, { BaseJobLock } from "../../src";
+import type BaseJobStore from "../../src/job-store";
 
 // Create a new cache by extending BaseJobStore interface
 export default class MemoryJobStore implements BaseJobStore<string> {

examples/job-stores/mongodb-job-store.ts

@@ -1,6 +1,5 @@
 #!/usr/bin/env bun
-import Cronyx from "../../src";
-import { MongodbJobStore } from "../../src/job-store";
+import Cronyx, { MongodbJobStore } from "../../src";
 
 const jobStore = await MongodbJobStore.connect(Bun.env.MONGO_URI!);
 const cronyx = new Cronyx({ jobStore });

examples/job-stores/mysql-job-store.ts

@@ -1,6 +1,5 @@
 #!/usr/bin/env bun
-import Cronyx from "../../src";
-import { MysqlJobStore } from "../../src/job-store";
+import Cronyx, { MysqlJobStore } from "../../src";
 
 const jobStore = await MysqlJobStore.connect({ type: "mysql", url: Bun.env.MYSQL_URI });
 const cronyx = new Cronyx({ jobStore });

examples/job-stores/postgres-job-store.ts

@@ -1,6 +1,5 @@
 #!/usr/bin/env bun
-import Cronyx from "../../src";
-import { PostgresJobStore } from "../../src/job-store";
+import Cronyx, { PostgresJobStore } from "../../src";
 
 const jobStore = await PostgresJobStore.connect({ type: "postgres", url: Bun.env.POSTGRES_URI });
 const cronyx = new Cronyx({ jobStore });

examples/job-stores/redis-job-store.ts

@@ -1,6 +1,5 @@
 #!/usr/bin/env bun
-import Cronyx from "../../src";
-import { RedisJobStore } from "../../src/job-store";
+import Cronyx, { RedisJobStore } from "../../src";
 
 const jobStore = await RedisJobStore.connect({ url: Bun.env.REDIS_URI });
 const cronyx = new Cronyx({ jobStore });

package.json

@@ -6,12 +6,6 @@
   "module": "dist/index.ts",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
-  "exports": {
-    ".": "./dist/index.js",
-    "./job-store": "./dist/job-store/index.js",
-    "./job-lock": "./dist/job-lock/index.js",
-    "./*": "./dist/*.js"
-  },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
     "format": "prettier **/*.{md,ts,cts,json} -w",

src/index.ts

@@ -1,7 +1,63 @@
 import type { Duration } from "date-fns";
 import type Job from "./job";
+import type { JobLockId } from "./job-lock";
 import JobRunner from "./job-runner";
-import type BaseJobStore from "./job-store/base";
+import type BaseJobStore from "./job-store";
+
+/**
+ * @public
+ */
+export type { default as BaseJobLock, JobLockId } from "./job-lock";
+
+/**
+ * @public
+ */
+export type { default as MongodbJobLock } from "./job-lock/mongodb";
+
+/**
+ * @public
+ */
+export type { default as RedisJobLock } from "./job-lock/redis";
+
+/**
+ * @public
+ */
+export type { default as TypeormJobLock } from "./job-lock/typeorm";
+
+/**
+ * @public
+ */
+export type { default as BaseJobStore } from "./job-store";
+
+/**
+ * @public
+ */
+export { default as MongodbJobStore } from "./job-store/mongodb";
+
+/**
+ * @public
+ */
+export { default as RedisJobStore } from "./job-store/redis";
+
+/**
+ * @public
+ */
+export { default as MysqlJobStore } from "./job-store/typeorm/mysql";
+
+/**
+ * @public
+ */
+export { default as PostgresJobStore } from "./job-store/typeorm/postgres";
+
+/**
+ * @public
+ */
+export { default as Job } from "./job";
+
+/**
+ * @public
+ */
+export { CronyxError } from "./error";
 
 /**
  * @public
@@ -17,7 +73,7 @@ export enum Source {
  * @public
  */
 export type CronyxOptions<S extends Source> = {
-  jobStore: BaseJobStore<S>;
+  jobStore: BaseJobStore<JobLockId<S>>;
   timezone?: string;
 };
 
@@ -40,7 +96,7 @@ export type RequestJobOptions =
  * @public
  */
 export default class Cronyx<S extends Source> {
-  #jobStore: BaseJobStore<S>;
+  #jobStore: BaseJobStore<JobLockId<S>>;
   #timezone: string | undefined;
 
   constructor(options: CronyxOptions<S>) {

src/job-lock/index.ts

@@ -1,19 +1,28 @@
-/**
- * @public
- */
-export type { default as BaseJobLock, JobLockId } from "./base";
-
-/**
- * @public
- */
-export { default as MongodbJobLock } from "./mongodb";
+import type { Types } from "mongoose";
+import type { Source } from "..";
 
 /**
  * @public
  */
-export { default as RedisJobLock } from "./redis";
+export type JobLockId<S extends Source> = S extends Source.Mongodb
+  ? Types.ObjectId
+  : S extends Source.Redis
+  ? string
+  : S extends Source.Mysql
+  ? string
+  : S extends Source.Postgres
+  ? string
+  : never;
 
 /**
  * @public
  */
-export { default as TypeormJobLock } from "./typeorm";
+export default interface BaseJobLock<T> {
+  _id: T | null;
+  jobName: string;
+  jobInterval: number;
+  jobIntervalEndedAt: Date;
+  isActive: boolean;
+  createdAt: Date;
+  updatedAt: Date;
+}

src/job-lock/mock.ts

@@ -1,6 +1,6 @@
 import { z } from "zod";
+import type BaseJobLock from ".";
 import type { Optional } from "../util";
-import type BaseJobLock from "./base";
 
 type MockJobLockCreationAttributes = Optional<
   BaseJobLock<null>,

src/job-lock/mongodb.ts

@@ -1,6 +1,6 @@
 import { Schema } from "mongoose";
 import type { Types } from "mongoose";
-import type BaseJobLock from "./base";
+import type BaseJobLock from ".";
 
 /**
  * @public

src/job-lock/redis.ts

@@ -1,7 +1,7 @@
 import { v4 } from "uuid";
 import { z } from "zod";
+import type BaseJobLock from ".";
 import type { Optional } from "../util";
-import type BaseJobLock from "./base";
 
 type RedisJobLockCreationAttributes = Optional<
   BaseJobLock<string>,

src/job-lock/typeorm.ts

@@ -1,5 +1,5 @@
 import { Column, CreateDateColumn, Entity, Index, PrimaryGeneratedColumn, UpdateDateColumn } from "typeorm";
-import type BaseJobLock from "./base";
+import type BaseJobLock from ".";
 
 /**
  * @public

src/job-runner.ts

@@ -3,10 +3,10 @@ import { differenceInMilliseconds } from "date-fns";
 import type { Source } from ".";
 import { CronyxError } from "./error";
 import Job from "./job";
-import type BaseJobLock from "./job-lock/base";
-import type { JobLockId } from "./job-lock/base";
+import type BaseJobLock from "./job-lock";
+import type { JobLockId } from "./job-lock";
 import MockJobLock from "./job-lock/mock";
-import type BaseJobStore from "./job-store/base";
+import type BaseJobStore from "./job-store";
 import { addInterval, getLastDeactivatedJobIntervalEndedAt, log, subInterval } from "./util";
 
 type JobRunnerOptions = {
@@ -22,7 +22,7 @@ type JobRunnerOptions = {
  * @internal
  */
 export default class JobRunner<S extends Source> {
-  #jobStore: BaseJobStore<S>;
+  #jobStore: BaseJobStore<JobLockId<S>>;
   #timezone: string;
   #jobName: string;
   #jobInterval: Duration | string | number;
@@ -33,7 +33,7 @@ export default class JobRunner<S extends Source> {
   #jobIntervalStartedAt: Date | undefined;
 
   constructor(
-    jobStore: BaseJobStore<S>,
+    jobStore: BaseJobStore<JobLockId<S>>,
     jobName: string,
     jobInterval: Duration | string | number,
     options?: JobRunnerOptions,

src/job-store/index.ts

@@ -1,24 +1,17 @@
-/**
- * @public
- */
-export type { default as BaseJobStore } from "./base";
-
-/**
- * @public
- */
-export { default as MongodbJobStore } from "./mongodb";
-
-/**
- * @public
- */
-export { default as RedisJobStore } from "./redis";
-
-/**
- * @public
- */
-export { default as MysqlJobStore } from "./typeorm/mysql";
+import type BaseJobLock from "../job-lock";
 
 /**
  * @public
  */
-export { default as PostgresJobStore } from "./typeorm/postgres";
+export default interface BaseJobStore<T> {
+  close(): Promise<void>;
+  fetchLastJobLock(jobName: string): Promise<BaseJobLock<T> | null>;
+  activateJobLock(
+    jobName: string,
+    jobInterval: number,
+    jobIntervalEndedAt: Date,
+    retryIntervalStartedAt: Date,
+  ): Promise<BaseJobLock<T> | null>;
+  deactivateJobLock(jobName: string, jobId: T): Promise<BaseJobLock<T>>;
+  removeJobLock(jobName: string, jobId: T): Promise<void>;
+}

src/job-store/mongodb.ts

@@ -2,15 +2,14 @@ import { MongoError } from "mongodb";
 import type { MongoClientOptions } from "mongodb";
 import { createConnection } from "mongoose";
 import type { Connection, Model, Types } from "mongoose";
-import type { Source } from "..";
+import type BaseJobStore from ".";
 import type MongodbJobLock from "../job-lock/mongodb";
 import { mongodbJobLockSchema } from "../job-lock/mongodb";
-import type BaseJobStore from "./base";
 
 /**
  * @public
  */
-export default class MongodbJobStore implements BaseJobStore<Source.Mongodb> {
+export default class MongodbJobStore implements BaseJobStore<Types.ObjectId> {
   #conn: Connection;
   #model: Model<MongodbJobLock>;