@wavezync/nestjs-pgboss 1.0.0-alpha

package/.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = false
+insert_final_newline = false

package/.eslintrc.js

@@ -0,0 +1,33 @@
+/** @type {import('eslint').ESLint.ConfigData} */
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js', 'tools/**'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        "args": "all",
+        "argsIgnorePattern": "^_",
+        "varsIgnorePattern": "^_",
+      }
+    ],
+  },
+};

package/.github/workflows/build.yaml

@@ -0,0 +1,43 @@
+name: Build
+
+on:
+  push:
+    tags-ignore:
+      - "**"
+    branches:
+      - "**"
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - uses: actions/cache@v4
+        name: Setup npm cache
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-npm-${{ hashFiles('package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-npm-
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Build
+        run: npm run build

package/.github/workflows/release.yaml

@@ -0,0 +1,40 @@
+name: Publish to NPM
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          registry-url: "https://registry.npmjs.org/"
+
+      - uses: actions/cache@v4
+        name: Setup npm cache
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-npm-${{ hashFiles('package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-npm-
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Build
+        run: npm run build
+
+      - name: Publish to NPM
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Wavezync
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.MD

@@ -0,0 +1,106 @@
+# `@wavezync/nestjs-pgboss`
+
+<p align="center">
+    Use <a href="https://github.com/timgit/pg-boss" target="_blank">pg-boss</a> in your Nest.js service!
+<p align="center">
+
+<p align="center">
+   <a href="https://github.com/wavezync/nestjs-pgboss/actions/workflows/build.yaml">
+        <img src="https://img.shields.io/github/actions/workflow/status/wavezync/nestjs-pgboss/build.yaml?branch=main" alt="Build Status">
+    </a>
+    <a href="https://github.com/wavezync/nestjs-pgboss/blob/main/LICENSE">
+        <img src="https://img.shields.io/badge/License-MIT-green" alt="License">
+    </a>
+</p>
+
+## Installation
+
+```bash
+npm install @wavezync/nestjs-pgboss
+```
+
+## Usage
+
+### Setup
+
+To begin using `@wavezync/nestjs-pgboss`, initialize the root module:
+
+```ts
+import { PGBossModule } from "@wavezync/nestjs-pgboss";
+
+// app.module.ts
+@Module({
+  imports: [
+    PgBossModule.forRootAsync({
+      imports: [ConfigModule],
+      useFactory: async (configService: ConfigService) => ({
+        connectionString: configService.get<string>('DATABASE_URL'),
+      }),
+      inject: [ConfigService],
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+Schedule a job using `PgBossService`:
+
+```ts
+import { Injectable } from '@nestjs/common';
+import { PgBossService } from '@wavezync/nestjs-pgboss';
+
+@Injectable()
+export class JobSchedulerService {
+  constructor(private readonly pgBossService: PgBossService) {}
+
+  async scheduleJob() {
+    await this.pgBossService.scheduleJob('my-job', { key: 'value' });
+  }
+}
+
+```
+Handle jobs using the `@Job` decorator:
+
+```ts
+import { Injectable, Logger } from '@nestjs/common';
+import { Job } from '@wavezync/nestjs-pgboss';
+
+@Injectable()
+export class MyJobHandler {
+  private readonly logger = new Logger(MyJobHandler.name);
+
+  @Job('my-job')
+  async handleMyJob(job: { data: any }) {
+    this.logger.log('Handling job with data:', job.data);
+  }
+}
+
+```
+Handle cron jobs using the `@CronJob` decorator:
+```ts
+import { Injectable, Logger } from '@nestjs/common';
+import { PgBossService, Cron } from '@wavezync/nestjs-pgboss';
+
+@Injectable()
+export class MyCronJobService {
+  private readonly logger = new Logger(MyCronJobService.name);
+
+  @CronJob('my-cron-job', '0 * * * *', { priority: 1 })
+  async handleCron() {
+    this.logger.log('Executing cron job: my-cron-job');
+  }
+}
+
+```
+
+## Test
+
+```bash
+# unit tests
+$ npm run test
+
+```
+
+## License
+
+`@wavezync/nestjs-pgboss` is [MIT licensed](LICENSE).

package/dist/decorators/job.decorator.d.ts

@@ -0,0 +1,7 @@
+import { JobOptions } from "pg-boss";
+export declare const JOB_NAME = "JOB_NAME";
+export declare const JOB_OPTIONS = "JOB_OPTIONS";
+export declare const CRON_EXPRESSION = "CRON_EXPRESSION";
+export declare const CRON_OPTIONS = "CRON_OPTIONS";
+export declare function Job<_TData extends object = any>(name: string, options?: JobOptions): (target: any, key: string, descriptor: PropertyDescriptor) => void;
+export declare function Cron<_TData extends object = any>(name: string, cron: string, options?: JobOptions): (target: any, key: string, descriptor: PropertyDescriptor) => void;

package/dist/decorators/job.decorator.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CRON_OPTIONS = exports.CRON_EXPRESSION = exports.JOB_OPTIONS = exports.JOB_NAME = void 0;
+exports.Job = Job;
+exports.Cron = Cron;
+const common_1 = require("@nestjs/common");
+exports.JOB_NAME = "JOB_NAME";
+exports.JOB_OPTIONS = "JOB_OPTIONS";
+exports.CRON_EXPRESSION = "CRON_EXPRESSION";
+exports.CRON_OPTIONS = "CRON_OPTIONS";
+function Job(name, options = {}) {
+    return (target, key, descriptor) => {
+        (0, common_1.SetMetadata)(exports.JOB_NAME, name)(target, key, descriptor);
+        (0, common_1.SetMetadata)(exports.JOB_OPTIONS, options)(target, key, descriptor);
+    };
+}
+function Cron(name, cron, options = {}) {
+    return (target, key, descriptor) => {
+        (0, common_1.SetMetadata)(exports.JOB_NAME, name)(target, key, descriptor);
+        (0, common_1.SetMetadata)(exports.CRON_EXPRESSION, cron)(target, key, descriptor);
+        (0, common_1.SetMetadata)(exports.CRON_OPTIONS, options)(target, key, descriptor);
+    };
+}
+//# sourceMappingURL=job.decorator.js.map

package/dist/decorators/job.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"job.decorator.js","sourceRoot":"","sources":["../../lib/decorators/job.decorator.ts"],"names":[],"mappings":";;;AAQA,kBAQC;AAED,oBAUC;AA5BD,2CAA6C;AAGhC,QAAA,QAAQ,GAAG,UAAU,CAAC;AACtB,QAAA,WAAW,GAAG,aAAa,CAAC;AAC5B,QAAA,eAAe,GAAG,iBAAiB,CAAC;AACpC,QAAA,YAAY,GAAG,cAAc,CAAC;AAE3C,SAAgB,GAAG,CACjB,IAAY,EACZ,UAAsB,EAAE;IAExB,OAAO,CAAC,MAAW,EAAE,GAAW,EAAE,UAA8B,EAAE,EAAE;QAClE,IAAA,oBAAW,EAAC,gBAAQ,EAAE,IAAI,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;QACrD,IAAA,oBAAW,EAAC,mBAAW,EAAE,OAAO,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;IAC7D,CAAC,CAAC;AACJ,CAAC;AAED,SAAgB,IAAI,CAClB,IAAY,EACZ,IAAY,EACZ,UAAsB,EAAE;IAExB,OAAO,CAAC,MAAW,EAAE,GAAW,EAAE,UAA8B,EAAE,EAAE;QAClE,IAAA,oBAAW,EAAC,gBAAQ,EAAE,IAAI,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;QACrD,IAAA,oBAAW,EAAC,uBAAe,EAAE,IAAI,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;QAC5D,IAAA,oBAAW,EAAC,oBAAY,EAAE,OAAO,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;IAC9D,CAAC,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./pgboss.module";
+export * from "./pgboss.service";
+export * from "./decorators/job.decorator";
+export * from "./interfaces/pgboss-module-options.interface";

package/dist/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./pgboss.module"), exports);
+__exportStar(require("./pgboss.service"), exports);
+__exportStar(require("./decorators/job.decorator"), exports);
+__exportStar(require("./interfaces/pgboss-module-options.interface"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,mDAAiC;AACjC,6DAA2C;AAC3C,+EAA6D"}

package/dist/interfaces/pgboss-module-options.interface.d.ts

@@ -0,0 +1,12 @@
+import { ModuleMetadata, Type } from "@nestjs/common";
+import { ConstructorOptions } from "pg-boss";
+export type PgBossModuleOptions = ConstructorOptions;
+export interface PgBossOptionsFactory {
+    createPgBossOptions(): Promise<PgBossModuleOptions> | PgBossModuleOptions;
+}
+export interface PgBossModuleAsyncOptions extends Pick<ModuleMetadata, "imports"> {
+    useExisting?: Type<PgBossOptionsFactory>;
+    useClass?: Type<PgBossOptionsFactory>;
+    useFactory?: (...args: any[]) => Promise<PgBossModuleOptions> | PgBossModuleOptions;
+    inject?: any[];
+}

package/dist/interfaces/pgboss-module-options.interface.js

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

package/dist/interfaces/pgboss-module-options.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pgboss-module-options.interface.js","sourceRoot":"","sources":["../../lib/interfaces/pgboss-module-options.interface.ts"],"names":[],"mappings":""}

package/dist/pgboss.module.d.ts

@@ -0,0 +1,7 @@
+import { DynamicModule } from "@nestjs/common";
+import { PgBossModuleAsyncOptions } from "./interfaces/pgboss-module-options.interface";
+export declare class PgBossModule {
+    static forRootAsync(options: PgBossModuleAsyncOptions): DynamicModule;
+    private static createAsyncProviders;
+    private static createAsyncOptionsProvider;
+}

package/dist/pgboss.module.js

@@ -0,0 +1,73 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var PgBossModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PgBossModule = void 0;
+const common_1 = require("@nestjs/common");
+const pg_boss_1 = __importDefault(require("pg-boss"));
+const pgboss_service_1 = require("./pgboss.service");
+const consts_1 = require("./utils/consts");
+let PgBossModule = PgBossModule_1 = class PgBossModule {
+    static forRootAsync(options) {
+        const logger = new common_1.Logger(PgBossModule_1.name);
+        const pgBossProvider = {
+            provide: consts_1.PGBOSS_TOKEN,
+            useFactory: async (pgBossOptions) => {
+                const boss = new pg_boss_1.default(pgBossOptions.connectionString);
+                await boss.start();
+                logger.log("PgBoss started successfully");
+                return boss;
+            },
+            inject: [consts_1.PGBOSS_OPTIONS],
+        };
+        const asyncProviders = this.createAsyncProviders(options);
+        return {
+            module: PgBossModule_1,
+            imports: options.imports || [],
+            providers: [...asyncProviders, pgBossProvider, pgboss_service_1.PgBossService],
+            exports: [pgboss_service_1.PgBossService],
+        };
+    }
+    static createAsyncProviders(options) {
+        if (options.useExisting || options.useFactory) {
+            return [this.createAsyncOptionsProvider(options)];
+        }
+        const useClass = options.useClass;
+        return [
+            this.createAsyncOptionsProvider(options),
+            {
+                provide: useClass,
+                useClass,
+            },
+        ];
+    }
+    static createAsyncOptionsProvider(options) {
+        if (options.useFactory) {
+            return {
+                provide: consts_1.PGBOSS_OPTIONS,
+                useFactory: options.useFactory,
+                inject: options.inject || [],
+            };
+        }
+        const inject = [(options.useClass || options.useExisting)];
+        return {
+            provide: consts_1.PGBOSS_OPTIONS,
+            useFactory: async (optionsFactory) => optionsFactory.createPgBossOptions(),
+            inject,
+        };
+    }
+};
+exports.PgBossModule = PgBossModule;
+exports.PgBossModule = PgBossModule = PgBossModule_1 = __decorate([
+    (0, common_1.Global)(),
+    (0, common_1.Module)({})
+], PgBossModule);
+//# sourceMappingURL=pgboss.module.js.map

package/dist/pgboss.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pgboss.module.js","sourceRoot":"","sources":["../lib/pgboss.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;AACA,2CAMwB;AACxB,sDAA6B;AAC7B,qDAAiD;AACjD,2CAA8D;AAQvD,IAAM,YAAY,oBAAlB,MAAM,YAAY;IACvB,MAAM,CAAC,YAAY,CAAC,OAAiC;QACnD,MAAM,MAAM,GAAG,IAAI,eAAM,CAAC,cAAY,CAAC,IAAI,CAAC,CAAC;QAE7C,MAAM,cAAc,GAAa;YAC/B,OAAO,EAAE,qBAAY;YACrB,UAAU,EAAE,KAAK,EAAE,aAAa,EAAE,EAAE;gBAClC,MAAM,IAAI,GAAG,IAAI,iBAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;gBACxD,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;gBACnB,MAAM,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;gBAC1C,OAAO,IAAI,CAAC;YACd,CAAC;YACD,MAAM,EAAE,CAAC,uBAAc,CAAC;SACzB,CAAC;QAEF,MAAM,cAAc,GAAG,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAE1D,OAAO;YACL,MAAM,EAAE,cAAY;YACpB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE;YAC9B,SAAS,EAAE,CAAC,GAAG,cAAc,EAAE,cAAc,EAAE,8BAAa,CAAC;YAC7D,OAAO,EAAE,CAAC,8BAAa,CAAC;SACzB,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,oBAAoB,CACjC,OAAiC;QAEjC,IAAI,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YAC9C,OAAO,CAAC,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,QAAQ,GAAG,OAAO,CAAC,QAEA,CAAC;QAE1B,OAAO;YACL,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC;YACxC;gBACE,OAAO,EAAE,QAAQ;gBACjB,QAAQ;aACT;SACF,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,0BAA0B,CACvC,OAAiC;QAEjC,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,OAAO;gBACL,OAAO,EAAE,uBAAc;gBACvB,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;aAC7B,CAAC;QACJ,CAAC;QAED,MAAM,MAAM,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,WAAW,CAAQ,CAAC,CAAC;QAElE,OAAO;YACL,OAAO,EAAE,uBAAc;YACvB,UAAU,EAAE,KAAK,EAAE,cAAoC,EAAE,EAAE,CACzD,cAAc,CAAC,mBAAmB,EAAE;YACtC,MAAM;SACP,CAAC;IACJ,CAAC;CACF,CAAA;AAjEY,oCAAY;uBAAZ,YAAY;IAFxB,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,YAAY,CAiExB"}

package/dist/pgboss.service.d.ts

@@ -0,0 +1,8 @@
+import PgBoss, { BatchWorkOptions, JobOptions, WorkHandler } from "pg-boss";
+export declare class PgBossService {
+    private readonly boss;
+    constructor(boss: PgBoss);
+    registerJob<TData extends object>(name: string, handler: WorkHandler<TData>, options?: BatchWorkOptions): Promise<void>;
+    scheduleJob<TData extends object>(name: string, data: TData, options?: JobOptions): Promise<void>;
+    registerCronJob<TData extends object>(name: string, cron: string, handler: WorkHandler<TData>, data?: TData, options?: PgBoss.ScheduleOptions): Promise<void>;
+}

package/dist/pgboss.service.js

@@ -0,0 +1,43 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PgBossService = void 0;
+const common_1 = require("@nestjs/common");
+const pg_boss_1 = __importDefault(require("pg-boss"));
+const consts_1 = require("./utils/consts");
+let PgBossService = class PgBossService {
+    constructor(boss) {
+        this.boss = boss;
+    }
+    async registerJob(name, handler, options) {
+        await this.boss.work(name, options, handler);
+    }
+    async scheduleJob(name, data, options) {
+        await this.boss.send(name, data, options);
+    }
+    async registerCronJob(name, cron, handler, data, options) {
+        await this.boss.schedule(name, cron, data ? data : {}, options ? options : {});
+        await this.boss.work(name, handler);
+    }
+};
+exports.PgBossService = PgBossService;
+exports.PgBossService = PgBossService = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, common_1.Inject)(consts_1.PGBOSS_TOKEN)),
+    __metadata("design:paramtypes", [pg_boss_1.default])
+], PgBossService);
+//# sourceMappingURL=pgboss.service.js.map

package/dist/pgboss.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pgboss.service.js","sourceRoot":"","sources":["../lib/pgboss.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,2CAAoD;AACpD,sDAA4E;AAC5E,2CAA8C;AAGvC,IAAM,aAAa,GAAnB,MAAM,aAAa;IACxB,YAAmD,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;IAAG,CAAC;IAEnE,KAAK,CAAC,WAAW,CACf,IAAY,EACZ,OAA2B,EAC3B,OAA0B;QAE1B,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,WAAW,CACf,IAAY,EACZ,IAAW,EACX,OAAoB;QAEpB,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,IAAY,EACZ,IAAY,EACZ,OAA2B,EAC3B,IAAY,EACZ,OAAgC;QAEhC,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CACtB,IAAI,EACJ,IAAI,EACJ,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAChB,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CACvB,CAAC;QACF,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;CACF,CAAA;AAlCY,sCAAa;wBAAb,aAAa;IADzB,IAAA,mBAAU,GAAE;IAEE,WAAA,IAAA,eAAM,EAAC,qBAAY,CAAC,CAAA;qCAAwB,iBAAM;GADpD,aAAa,CAkCzB"}

package/dist/utils/consts.d.ts

@@ -0,0 +1,2 @@
+export declare const PGBOSS_OPTIONS = "PGBOSS_OPTIONS";
+export declare const PGBOSS_TOKEN = "PGBOSS_TOKEN";

package/dist/utils/consts.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PGBOSS_TOKEN = exports.PGBOSS_OPTIONS = void 0;
+exports.PGBOSS_OPTIONS = "PGBOSS_OPTIONS";
+exports.PGBOSS_TOKEN = "PGBOSS_TOKEN";
+//# sourceMappingURL=consts.js.map

package/dist/utils/consts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.js","sourceRoot":"","sources":["../../lib/utils/consts.ts"],"names":[],"mappings":";;;AAAa,QAAA,cAAc,GAAG,gBAAgB,CAAC;AAClC,QAAA,YAAY,GAAG,cAAc,CAAC"}

package/lib/decorators/job.decorator.ts

@@ -0,0 +1,29 @@
+import { SetMetadata } from "@nestjs/common";
+import { JobOptions } from "pg-boss";
+
+export const JOB_NAME = "JOB_NAME";
+export const JOB_OPTIONS = "JOB_OPTIONS";
+export const CRON_EXPRESSION = "CRON_EXPRESSION";
+export const CRON_OPTIONS = "CRON_OPTIONS";
+
+export function Job<_TData extends object = any>(
+  name: string,
+  options: JobOptions = {},
+) {
+  return (target: any, key: string, descriptor: PropertyDescriptor) => {
+    SetMetadata(JOB_NAME, name)(target, key, descriptor);
+    SetMetadata(JOB_OPTIONS, options)(target, key, descriptor);
+  };
+}
+
+export function CronJob<_TData extends object = any>(
+  name: string,
+  cron: string,
+  options: JobOptions = {},
+) {
+  return (target: any, key: string, descriptor: PropertyDescriptor) => {
+    SetMetadata(JOB_NAME, name)(target, key, descriptor);
+    SetMetadata(CRON_EXPRESSION, cron)(target, key, descriptor);
+    SetMetadata(CRON_OPTIONS, options)(target, key, descriptor);
+  };
+}

package/lib/index.ts

@@ -0,0 +1,4 @@
+export * from "./pgboss.module";
+export * from "./pgboss.service";
+export * from "./decorators/job.decorator";
+export * from "./interfaces/pgboss-module-options.interface";

package/lib/interfaces/pgboss-module-options.interface.ts

@@ -0,0 +1,18 @@
+import { ModuleMetadata, Type } from "@nestjs/common";
+import { ConstructorOptions } from "pg-boss";
+
+export type PgBossModuleOptions = ConstructorOptions;
+
+export interface PgBossOptionsFactory {
+  createPgBossOptions(): Promise<PgBossModuleOptions> | PgBossModuleOptions;
+}
+
+export interface PgBossModuleAsyncOptions
+  extends Pick<ModuleMetadata, "imports"> {
+  useExisting?: Type<PgBossOptionsFactory>;
+  useClass?: Type<PgBossOptionsFactory>;
+  useFactory?: (
+    ...args: any[]
+  ) => Promise<PgBossModuleOptions> | PgBossModuleOptions;
+  inject?: any[];
+}

package/lib/pgboss.module.ts

@@ -0,0 +1,84 @@
+// src/pg-boss.module.ts
+import {
+  Module,
+  DynamicModule,
+  Global,
+  Provider,
+  Logger,
+} from "@nestjs/common";
+import PgBoss from "pg-boss";
+import { PgBossService } from "./pgboss.service";
+import { PGBOSS_OPTIONS, PGBOSS_TOKEN } from "./utils/consts";
+import {
+  PgBossModuleAsyncOptions,
+  PgBossOptionsFactory,
+} from "./interfaces/pgboss-module-options.interface";
+
+@Global()
+@Module({})
+export class PgBossModule {
+  static forRootAsync(options: PgBossModuleAsyncOptions): DynamicModule {
+    const logger = new Logger(PgBossModule.name);
+
+    const pgBossProvider: Provider = {
+      provide: PGBOSS_TOKEN,
+      useFactory: async (pgBossOptions) => {
+        const boss = new PgBoss(pgBossOptions.connectionString);
+        await boss.start();
+        logger.log("PgBoss started successfully");
+        return boss;
+      },
+      inject: [PGBOSS_OPTIONS],
+    };
+
+    const asyncProviders = this.createAsyncProviders(options);
+
+    return {
+      module: PgBossModule,
+      imports: options.imports || [],
+      providers: [...asyncProviders, pgBossProvider, PgBossService],
+      exports: [PgBossService],
+    };
+  }
+
+  private static createAsyncProviders(
+    options: PgBossModuleAsyncOptions,
+  ): Provider[] {
+    if (options.useExisting || options.useFactory) {
+      return [this.createAsyncOptionsProvider(options)];
+    }
+
+    const useClass = options.useClass as new (
+      ...args: any[]
+    ) => PgBossOptionsFactory;
+
+    return [
+      this.createAsyncOptionsProvider(options),
+      {
+        provide: useClass,
+        useClass,
+      },
+    ];
+  }
+
+  private static createAsyncOptionsProvider(
+    options: PgBossModuleAsyncOptions,
+  ): Provider {
+    if (options.useFactory) {
+      return {
+        provide: PGBOSS_OPTIONS,
+        useFactory: options.useFactory,
+        inject: options.inject || [],
+      };
+    }
+
+    const inject = [(options.useClass || options.useExisting) as any];
+
+    return {
+      provide: PGBOSS_OPTIONS,
+      useFactory: async (optionsFactory: PgBossOptionsFactory) =>
+        optionsFactory.createPgBossOptions(),
+      inject,
+    };
+  }
+}

package/lib/pgboss.service.ts

@@ -0,0 +1,40 @@
+import { Inject, Injectable } from "@nestjs/common";
+import PgBoss, { BatchWorkOptions, JobOptions, WorkHandler } from "pg-boss";
+import { PGBOSS_TOKEN } from "./utils/consts";
+
+@Injectable()
+export class PgBossService {
+  constructor(@Inject(PGBOSS_TOKEN) private readonly boss: PgBoss) {}
+
+  async registerJob<TData extends object>(
+    name: string,
+    handler: WorkHandler<TData>,
+    options?: BatchWorkOptions,
+  ) {
+    await this.boss.work(name, options, handler);
+  }
+
+  async scheduleJob<TData extends object>(
+    name: string,
+    data: TData,
+    options?: JobOptions,
+  ) {
+    await this.boss.send(name, data, options);
+  }
+
+  async registerCronJob<TData extends object>(
+    name: string,
+    cron: string,
+    handler: WorkHandler<TData>,
+    data?: TData,
+    options?: PgBoss.ScheduleOptions,
+  ) {
+    await this.boss.schedule(
+      name,
+      cron,
+      data ? data : {},
+      options ? options : {},
+    );
+    await this.boss.work(name, handler);
+  }
+}

package/lib/utils/consts.ts

@@ -0,0 +1,2 @@
+export const PGBOSS_OPTIONS = "PGBOSS_OPTIONS";
+export const PGBOSS_TOKEN = "PGBOSS_TOKEN";

package/nest-cli.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "lib",
+  "compilerOptions": {
+    "deleteOutDir": true
+  }
+}

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@wavezync/nestjs-pgboss",
+  "version": "1.0.0-alpha",
+  "description": "A NestJS module that integrates pg-boss for job scheduling and handling.",
+  "license": "MIT",
+  "author": "samaratungajs@wavezync.com",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "nest build",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "start": "nest start",
+    "start:dev": "nest start --watch",
+    "start:debug": "nest start --debug --watch",
+    "start:prod": "node dist/main",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^9 || ^10",
+    "@nestjs/core": "^9 || ^10",
+    "pg-boss": "^9",
+    "reflect-metadata": "^0.1.13 || ^0.2.0",
+    "rxjs": "^7.2.0"
+  },
+  "devDependencies": {
+    "@nestjs/cli": "^10.0.0",
+    "@nestjs/schematics": "^10.0.0",
+    "@nestjs/testing": "^10.0.0",
+    "@types/express": "^4.17.17",
+    "@types/jest": "^29.5.2",
+    "@types/node": "^20.3.1",
+    "@types/supertest": "^6.0.0",
+    "@typescript-eslint/eslint-plugin": "^7.0.0",
+    "@typescript-eslint/parser": "^7.0.0",
+    "eslint": "^8.42.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "jest": "^29.5.0",
+    "prettier": "^3.0.0",
+    "source-map-support": "^0.5.21",
+    "supertest": "^7.0.0",
+    "ts-jest": "^29.1.0",
+    "ts-loader": "^9.4.3",
+    "ts-node": "^10.9.1",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.1.3"
+  },
+  "jest": {
+    "roots": [
+      "<rootDir>/test"
+    ],
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "testEnvironment": "node",
+    "moduleFileExtensions": [
+      "ts",
+      "js"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wavezync/nestjs-pgboss"
+  }
+}

package/test/jest-e2e.json

@@ -0,0 +1,9 @@
+{
+  "moduleFileExtensions": ["js", "json", "ts"],
+  "rootDir": ".",
+  "testEnvironment": "node",
+  "testRegex": ".e2e-spec.ts$",
+  "transform": {
+    "^.+\\.(t|j)s$": "ts-jest"
+  }
+}

package/test/pgboss.service.spec.ts

@@ -0,0 +1,81 @@
+import { Test, TestingModule } from "@nestjs/testing";
+import PgBoss from "pg-boss";
+import { PgBossService } from "../lib/pgboss.service";
+import { PGBOSS_TOKEN } from "../lib/utils/consts";
+
+describe("PgBossService", () => {
+  let service: PgBossService;
+  let mockPgBoss: jest.Mocked<PgBoss>;
+
+  beforeEach(async () => {
+    mockPgBoss = {
+      start: jest.fn(),
+      work: jest.fn(),
+      send: jest.fn(),
+      schedule: jest.fn(),
+    } as any;
+
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [
+        PgBossService,
+        { provide: PGBOSS_TOKEN, useValue: mockPgBoss },
+      ],
+    }).compile();
+
+    service = module.get<PgBossService>(PgBossService);
+  });
+
+  it("should be defined", () => {
+    expect(service).toBeDefined();
+  });
+
+  describe("registerJob", () => {
+    it("should call PgBoss work with correct parameters", async () => {
+      const handler = jest.fn();
+      const options = { batchSize: 5 };
+
+      await service.registerJob("test-job", handler, options);
+
+      expect(mockPgBoss.work).toHaveBeenCalledWith(
+        "test-job",
+        { batchSize: 5 },
+        handler,
+      );
+    });
+  });
+
+  describe("scheduleJob", () => {
+    it("should call PgBoss send with correct parameters", async () => {
+      const data = { test: "data" };
+
+      await service.scheduleJob("test-job", data, {});
+
+      expect(mockPgBoss.send).toHaveBeenCalledWith("test-job", data, {});
+    });
+  });
+
+  describe("registerCronJob", () => {
+    it("should call PgBoss schedule and work with correct parameters", async () => {
+      const handler = jest.fn();
+      const cron = "* * * * *";
+      const data = { test: "data" };
+      const options = { tz: "UTC" };
+
+      await service.registerCronJob(
+        "test-cron-job",
+        cron,
+        handler,
+        data,
+        options,
+      );
+
+      expect(mockPgBoss.schedule).toHaveBeenCalledWith(
+        "test-cron-job",
+        cron,
+        data,
+        { tz: "UTC" },
+      );
+      expect(mockPgBoss.work).toHaveBeenCalledWith("test-cron-job", handler);
+    });
+  });
+});

package/tsconfig.build.json

@@ -0,0 +1,16 @@
+{
+  "extends": "./tsconfig.json",
+  "include": [
+    "lib/**/*.ts"
+  ],
+  "compilerOptions": {
+    "rootDir": "./lib",
+    "outDir": "./dist"
+  },
+  "exclude": [
+    "node_modules",
+    "test",
+    "dist",
+    "**/*spec.ts"
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,36 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "resolveJsonModule": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "es2017",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "lib",
+    "incremental": false,
+    "skipLibCheck": true,
+    "strictNullChecks": false,
+    "noImplicitAny": false,
+    "strictBindCallApply": false,
+    "forceConsistentCasingInFileNames": false,
+    "noFallthroughCasesInSwitch": false,
+    "types": [
+      "@types/node",
+      "jest"
+    ],
+    "strict": true
+  },
+  "include": [
+    "lib/**/*.ts",
+    "test/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist"
+  ]
+}