@wavezync/nestjs-pgboss 2.1.0 → 2.2.0

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

package/README.MD

@@ -63,6 +63,10 @@ export class JobSchedulerService {
 
 ```
 
+#### Access `boss` Directly
+
+You can access the `PgBoss` instance directly via `pgBossService.boss`
+
 #### Handle jobs using the `@Job` decorator
 
 ```ts

package/dist/pgboss.service.d.ts

@@ -1,7 +1,8 @@
 import PgBoss, { WorkWithMetadataHandler } from "pg-boss";
 export declare class PgBossService {
-    private readonly boss;
+    private pgBoss;
     constructor(boss: PgBoss);
+    get boss(): PgBoss;
     scheduleJob<TData extends object>(name: string, data: TData, options?: PgBoss.SendOptions): Promise<void>;
     scheduleCronJob<TData extends object>(name: string, cron: string, data?: TData, options?: PgBoss.ScheduleOptions): Promise<void>;
     registerCronJob<TData extends object>(name: string, cron: string, handler: WorkWithMetadataHandler<TData>, data?: TData, options?: PgBoss.ScheduleOptions): Promise<void>;

package/dist/pgboss.service.js

@@ -22,20 +22,23 @@ const common_2 = require("@nestjs/common");
 const consts_1 = require("./utils/consts");
 let PgBossService = class PgBossService {
     constructor(boss) {
-        this.boss = boss;
+        this.pgBoss = boss;
+    }
+    get boss() {
+        return this.pgBoss;
     }
     async scheduleJob(name, data, options) {
-        await this.boss.send(name, data, options);
+        await this.pgBoss.send(name, data, options);
     }
     async scheduleCronJob(name, cron, data, options) {
-        await this.boss.schedule(name, cron, data !== null && data !== void 0 ? data : {}, options !== null && options !== void 0 ? options : {});
+        await this.pgBoss.schedule(name, cron, data !== null && data !== void 0 ? data : {}, options !== null && options !== void 0 ? options : {});
     }
     async registerCronJob(name, cron, handler, data, options) {
-        await this.boss.schedule(name, cron, data !== null && data !== void 0 ? data : {}, options !== null && options !== void 0 ? options : {});
-        await this.boss.work(name, Object.assign(Object.assign({}, options), { includeMetadata: true }), handler);
+        await this.pgBoss.schedule(name, cron, data !== null && data !== void 0 ? data : {}, options !== null && options !== void 0 ? options : {});
+        await this.pgBoss.work(name, Object.assign(Object.assign({}, options), { includeMetadata: true }), handler);
     }
     async registerJob(name, handler, options) {
-        await this.boss.work(name, Object.assign(Object.assign({}, options), { includeMetadata: true }), handler);
+        await this.pgBoss.work(name, Object.assign(Object.assign({}, options), { includeMetadata: true }), handler);
     }
 };
 exports.PgBossService = PgBossService;

package/dist/pgboss.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"pgboss.service.js","sourceRoot":"","sources":["../lib/pgboss.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,2CAA4C;AAC5C,sDAA0D;AAC1D,2CAAwC;AACxC,2CAA8C;AAGvC,IAAM,aAAa,GAAnB,MAAM,aAAa;IACxB,YAAmD,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;IAAG,CAAC;IAEnE,KAAK,CAAC,WAAW,CACf,IAAY,EACZ,IAAW,EACX,OAA4B;QAE5B,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,IAAY,EACZ,OAAgC;QAEhC,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,IAAY,EACZ,IAAY,EACZ,OAAuC,EACvC,IAAY,EACZ,OAAgC;QAEhC,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC,CAAC;QAChE,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAClB,IAAI,kCACC,OAAO,KAAE,eAAe,EAAE,IAAI,KACnC,OAAO,CACR,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,WAAW,CACf,IAAY,EACZ,OAAuC,EACvC,OAAiC;QAEjC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAClB,IAAI,kCACC,OAAO,KAAE,eAAe,EAAE,IAAI,KACnC,OAAO,CACR,CAAC;IACJ,CAAC;CACF,CAAA;AA9CY,sCAAa;wBAAb,aAAa;IADzB,IAAA,mBAAU,GAAE;IAEE,WAAA,IAAA,eAAM,EAAC,qBAAY,CAAC,CAAA;qCAAwB,iBAAM;GADpD,aAAa,CA8CzB"}
+{"version":3,"file":"pgboss.service.js","sourceRoot":"","sources":["../lib/pgboss.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,2CAA4C;AAC5C,sDAA0D;AAC1D,2CAAwC;AACxC,2CAA8C;AAGvC,IAAM,aAAa,GAAnB,MAAM,aAAa;IAGxB,YAAkC,IAAY;QAC5C,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IACrB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,WAAW,CACf,IAAY,EACZ,IAAW,EACX,OAA4B;QAE5B,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,IAAY,EACZ,IAAY,EACZ,IAAY,EACZ,OAAgC;QAEhC,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,IAAY,EACZ,IAAY,EACZ,OAAuC,EACvC,IAAY,EACZ,OAAgC;QAEhC,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC,CAAC;QAClE,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACpB,IAAI,kCACC,OAAO,KAAE,eAAe,EAAE,IAAI,KACnC,OAAO,CACR,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,WAAW,CACf,IAAY,EACZ,OAAuC,EACvC,OAAiC;QAEjC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACpB,IAAI,kCACC,OAAO,KAAE,eAAe,EAAE,IAAI,KACnC,OAAO,CACR,CAAC;IACJ,CAAC;CACF,CAAA;AAtDY,sCAAa;wBAAb,aAAa;IADzB,IAAA,mBAAU,GAAE;IAIE,WAAA,IAAA,eAAM,EAAC,qBAAY,CAAC,CAAA;qCAAO,iBAAM;GAHnC,aAAa,CAsDzB"}

package/lib/pgboss.service.ts

@@ -5,14 +5,22 @@ import { PGBOSS_TOKEN } from "./utils/consts";
 
 @Injectable()
 export class PgBossService {
-  constructor(@Inject(PGBOSS_TOKEN) private readonly boss: PgBoss) {}
+  private pgBoss: PgBoss;
+
+  constructor(@Inject(PGBOSS_TOKEN) boss: PgBoss) {
+    this.pgBoss = boss;
+  }
+
+  get boss(): PgBoss {
+    return this.pgBoss;
+  }
 
   async scheduleJob<TData extends object>(
     name: string,
     data: TData,
     options?: PgBoss.SendOptions,
   ) {
-    await this.boss.send(name, data, options);
+    await this.pgBoss.send(name, data, options);
   }
 
   async scheduleCronJob<TData extends object>(
@@ -21,7 +29,7 @@ export class PgBossService {
     data?: TData,
     options?: PgBoss.ScheduleOptions,
   ) {
-    await this.boss.schedule(name, cron, data ?? {}, options ?? {});
+    await this.pgBoss.schedule(name, cron, data ?? {}, options ?? {});
   }
 
   async registerCronJob<TData extends object>(
@@ -31,8 +39,8 @@ export class PgBossService {
     data?: TData,
     options?: PgBoss.ScheduleOptions,
   ) {
-    await this.boss.schedule(name, cron, data ?? {}, options ?? {});
-    await this.boss.work<TData>(
+    await this.pgBoss.schedule(name, cron, data ?? {}, options ?? {});
+    await this.pgBoss.work<TData>(
       name,
       { ...options, includeMetadata: true },
       handler,
@@ -44,7 +52,7 @@ export class PgBossService {
     handler: WorkWithMetadataHandler<TData>,
     options?: PgBoss.BatchWorkOptions,
   ) {
-    await this.boss.work<TData>(
+    await this.pgBoss.work<TData>(
       name,
       { ...options, includeMetadata: true },
       handler,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wavezync/nestjs-pgboss",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "A NestJS module that integrates pg-boss for job scheduling and handling.",
   "license": "MIT",
   "author": "samaratungajs@wavezync.com",