consolidate to named exports

Author: timgit

examples/load/index.ts

@@ -1,4 +1,4 @@
-import PgBoss from '../../dist/index.mjs'
+import { PgBoss } from '../../dist/index.mjs'
 import * as helper from '../../test/testHelper.js'
 import { delay } from '../../src/tools.ts'
 

examples/readme.cjs

@@ -1,4 +1,4 @@
-const PgBoss = require('../')
+const { PgBoss } = require('../')
 
 async function readme () {
   const boss = new PgBoss('postgres://postgres:postgres@localhost/pgboss')

examples/readme.mjs

@@ -1,4 +1,4 @@
-import PgBoss from '../dist/index.mjs'
+import { PgBoss } from '../dist/index.mjs'
 
 async function readme () {
   const boss = new PgBoss('postgres://postgres:postgres@localhost/pgboss')

examples/schedule.js

@@ -1,4 +1,4 @@
-import PgBoss from '../dist/index.mjs'
+import { PgBoss } from '../dist/index.mjs'
 import * as helper from '../test/testHelper.js'
 
 async function schedule () {

package.json

@@ -1,17 +1,17 @@
 {
   "name": "pg-boss",
-  "version": "12.0.0-beta1",
+  "version": "12.0.0-beta3",
   "description": "Queueing jobs in Postgres from Node.js like a boss",
   "type": "module",
-  "main": "./dist/index.cjs",
+  "main": "./dist/index.mjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.mts",
   "engines": {
     "node": ">=22.12.0"
   },
   "exports": {
-    "import": "./dist/index.mjs",
-    "require": "./dist/index.cjs"
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
   },
   "dependencies": {
     "cron-parser": "^5.4.0",
@@ -36,7 +36,6 @@
   },
   "scripts": {
     "build": "tsdown",
-    "postbuild": "node scripts/cjs-shim.js",
     "prepublishOnly": "npm test && npm run build",
     "test": "eslint . && mocha test/**/*.ts",
     "cover": "nyc npm test",

scripts/cjs-shim.js

@@ -9,12 +9,27 @@ import { delay } from './tools.ts'
 import type * as types from './types.ts'
 import DbDefault from './db.ts'
 
-const events = {
+export const states: types.JobStates = plans.JOB_STATES
+export const policies: types.QueuePolicies = plans.QUEUE_POLICIES
+export const events: types.Events = {
   error: 'error',
+  warning: 'warning',
+  wip: 'wip',
   stopped: 'stopped'
 } as const
 
-class PgBoss extends EventEmitter<types.PgBossEventMap> {
+export function getConstructionPlans (schema?: string) {
+  return Contractor.constructionPlans(schema)
+}
+
+export function getMigrationPlans (schema?: string, version?: number) {
+  return Contractor.migrationPlans(schema, version)
+}
+
+export function getRollbackPlans (schema?: string, version?: number) {
+  return Contractor.rollbackPlans(schema, version)
+}
+export class PgBoss extends EventEmitter<types.PgBossEventMap> {
   #stoppingOn: number | null
   #stopped: boolean
   #starting: boolean | undefined
@@ -25,6 +40,7 @@ class PgBoss extends EventEmitter<types.PgBossEventMap> {
   #contractor: Contractor
   #manager: Manager
   #timekeeper: Timekeeper
+  #events: { readonly error: 'error'; readonly stopped: 'stopped' }
 
   constructor (connectionString: string)
   constructor (options: types.ConstructorOptions)
@@ -60,6 +76,11 @@ class PgBoss extends EventEmitter<types.PgBossEventMap> {
     this.#contractor = contractor
     this.#manager = manager
     this.#timekeeper = timekeeper
+
+    this.#events = {
+      error: 'error',
+      stopped: 'stopped'
+    } as const
   }
 
   #promoteEvents (emitter: types.EventsMixin) {
@@ -68,8 +89,6 @@ class PgBoss extends EventEmitter<types.PgBossEventMap> {
     }
   }
 
-  // Public API
-
   static getConstructionPlans (schema?: string) {
     return Contractor.constructionPlans(schema)
   }
@@ -151,10 +170,10 @@ class PgBoss extends EventEmitter<types.PgBossEventMap> {
           this.#stoppingOn = null
           this.#started = false
 
-          this.emit(events.stopped)
+          this.emit(this.#events.stopped)
           resolve()
         } catch (err: any) {
-          this.emit(events.error, err)
+          this.emit(this.#events.error, err)
           reject(err)
         }
       }
@@ -182,7 +201,7 @@ class PgBoss extends EventEmitter<types.PgBossEventMap> {
           await shutdown()
         } catch (err: any) {
           reject(err)
-          this.emit(events.error, err)
+          this.emit(this.#events.error, err)
         }
       })
     })
@@ -349,11 +368,6 @@ class PgBoss extends EventEmitter<types.PgBossEventMap> {
   }
 }
 
-export default PgBoss
-
-export const states = PgBoss.states
-export const policies = PgBoss.policies
-
 export type {
   ConnectionOptions,
   ConstructorOptions,
@@ -364,6 +378,7 @@ export type {
   JobInsert,
   JobPollingOptions,
   JobStates,
+  Events,
   JobWithMetadata,
   MaintenanceOptions,
   OffWorkOptions,

src/index.ts

@@ -14,6 +14,13 @@ export type QueuePolicies = {
   stately: 'stately'
 }
 
+export type Events = {
+  error: 'error',
+  warning: 'warning',
+  wip: 'wip',
+  stopped: 'stopped'
+}
+
 export interface IDatabase {
   executeSql(text: string, values?: unknown[]): Promise<{ rows: any[] }>;
 }
@@ -86,7 +93,6 @@ export interface ConstructorOptions extends DatabaseOptions, SchedulingOptions,
 
 export interface ResolvedConstructorOptions extends ConstructorOptions {
   schema: string;
-  pollingInterval: number;
   monitorIntervalSeconds: number;
   cronMonitorIntervalSeconds: number;
   maintenanceIntervalSeconds: number;
@@ -215,6 +221,7 @@ export interface JobWithMetadata<T = object> extends Job<T> {
 
 export interface JobInsert<T = object> {
   id?: string;
+  name: string;
   data?: T;
   priority?: number;
   retryLimit?: number;

src/types.ts

@@ -1,5 +1,5 @@
 import assert, { strictEqual } from 'node:assert'
-import PgBoss from '../src/index.ts'
+import { PgBoss } from '../src/index.ts'
 import { delay } from '../src/tools.ts'
 
 describe('background processing error handling', function () {
@@ -62,7 +62,7 @@ describe('background processing error handling', function () {
     await this.boss.start()
 
     assert.rejects(async () => {
-      await this.boss!.stop({ wait: false })
+      await this.boss.stop({ wait: false })
     })
   })
 })

test/backgroundErrorTest.ts

@@ -1,10 +1,11 @@
 import assert from 'node:assert'
 import * as helper from './testHelper.ts'
 import type { TestContext } from './hooks.ts'
+import { type PgBoss } from '../src/index.ts'
 
 describe('cancel', function () {
   it('should reject missing arguments', async function (this: TestContext) {
-    this.boss = await helper.start(this.bossConfig)
+    this.boss = await helper.start(this.bossConfig) as PgBoss
 
     assert.rejects(async () => {
       await this.boss.cancel(null as any, null as any)