pg-boss 12.4.0 → 12.5.0

package/dist/attorney.d.ts

@@ -0,0 +1,19 @@
+import type * as types from './types.ts';
+declare const POLICY: {
+    MAX_EXPIRATION_HOURS: number;
+    MIN_POLLING_INTERVAL_MS: number;
+    MAX_RETENTION_DAYS: number;
+};
+declare function validateQueueArgs(config?: any): void;
+declare function checkSendArgs(args: any): types.Request;
+declare function checkWorkArgs(name: string, args: any[]): {
+    options: types.ResolvedWorkOptions;
+    callback: types.WorkHandler<any>;
+};
+declare function checkFetchArgs(name: string, options: any): void;
+declare function getConfig(value: string | types.ConstructorOptions): types.ResolvedConstructorOptions;
+declare function assertPostgresObjectName(name: string): void;
+declare function assertQueueName(name: string): void;
+declare function assertKey(key: string): void;
+export { assertKey, assertPostgresObjectName, assertQueueName, checkFetchArgs, checkSendArgs, checkWorkArgs, getConfig, POLICY, validateQueueArgs };
+//# sourceMappingURL=attorney.d.ts.map

package/dist/attorney.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"attorney.d.ts","sourceRoot":"","sources":["../src/attorney.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AAExC,QAAA,MAAM,MAAM;;;;CAIX,CAAA;AAMD,iBAAS,iBAAiB,CAAE,MAAM,GAAE,GAAQ,QAW3C;AAED,iBAAS,aAAa,CAAE,IAAI,EAAE,GAAG,GAAG,KAAK,CAAC,OAAO,CA8ChD;AAED,iBAAS,aAAa,CAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG;IAClD,OAAO,EAAE,KAAK,CAAC,mBAAmB,CAAA;IAClC,QAAQ,EAAE,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;CACjC,CAyBA;AAED,iBAAS,cAAc,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,QAOlD;AAED,iBAAS,SAAS,CAAE,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,kBAAkB,GAAG,KAAK,CAAC,0BAA0B,CAmB9F;AAkBD,iBAAS,wBAAwB,CAAE,IAAI,EAAE,MAAM,QAK9C;AAED,iBAAS,eAAe,CAAE,IAAI,EAAE,MAAM,QAIrC;AAED,iBAAS,SAAS,CAAE,GAAG,EAAE,MAAM,QAI9B;AAuFD,OAAO,EACL,SAAS,EACT,wBAAwB,EACxB,eAAe,EACf,cAAc,EACd,aAAa,EACb,aAAa,EACb,SAAS,EACT,MAAM,EACN,iBAAiB,EAClB,CAAA"}

package/dist/attorney.js

@@ -0,0 +1,170 @@
+import assert from 'node:assert';
+import { DEFAULT_SCHEMA } from "./plans.js";
+const POLICY = {
+    MAX_EXPIRATION_HOURS: 24,
+    MIN_POLLING_INTERVAL_MS: 500,
+    MAX_RETENTION_DAYS: 365
+};
+function assertObjectName(value, name = 'Name') {
+    assert(/^[\w.-]+$/.test(value), `${name} can only contain alphanumeric characters, underscores, hyphens, or periods`);
+}
+function validateQueueArgs(config = {}) {
+    assert(!('deadLetter' in config) || config.deadLetter === null || (typeof config.deadLetter === 'string'), 'deadLetter must be a string');
+    if (config.deadLetter) {
+        assertObjectName(config.deadLetter, 'deadLetter');
+    }
+    validateRetryConfig(config);
+    validateExpirationConfig(config);
+    validateRetentionConfig(config);
+    validateDeletionConfig(config);
+}
+function checkSendArgs(args) {
+    let name, data, options;
+    if (typeof args[0] === 'string') {
+        name = args[0];
+        data = args[1];
+        assert(typeof data !== 'function', 'send() cannot accept a function as the payload.  Did you intend to use work()?');
+        options = args[2];
+    }
+    else if (typeof args[0] === 'object') {
+        assert(args.length === 1, 'send object API only accepts 1 argument');
+        const job = args[0];
+        assert(job, 'boss requires all jobs to have a name');
+        name = job.name;
+        data = job.data;
+        options = job.options;
+    }
+    options = options || {};
+    assert(name, 'boss requires all jobs to have a queue name');
+    assert(typeof options === 'object', 'options should be an object');
+    options = { ...options };
+    assert(!('priority' in options) || (Number.isInteger(options.priority)), 'priority must be an integer');
+    options.priority = options.priority || 0;
+    options.startAfter = (options.startAfter instanceof Date && typeof options.startAfter.toISOString === 'function')
+        ? options.startAfter.toISOString()
+        : (+options.startAfter > 0)
+            ? '' + options.startAfter
+            : (typeof options.startAfter === 'string')
+                ? options.startAfter
+                : undefined;
+    validateRetryConfig(options);
+    validateExpirationConfig(options);
+    validateRetentionConfig(options);
+    validateDeletionConfig(options);
+    return { name, data, options };
+}
+function checkWorkArgs(name, args) {
+    let options, callback;
+    assert(name, 'queue name is required');
+    if (args.length === 1) {
+        callback = args[0];
+        options = {};
+    }
+    else if (args.length > 1) {
+        options = args[0] || {};
+        callback = args[1];
+    }
+    assert(typeof callback === 'function', 'expected callback to be a function');
+    assert(typeof options === 'object', 'expected config to be an object');
+    options = { ...options };
+    applyPollingInterval(options);
+    assert(!('batchSize' in options) || (Number.isInteger(options.batchSize) && options.batchSize >= 1), 'batchSize must be an integer > 0');
+    assert(!('includeMetadata' in options) || typeof options.includeMetadata === 'boolean', 'includeMetadata must be a boolean');
+    assert(!('priority' in options) || typeof options.priority === 'boolean', 'priority must be a boolean');
+    return { options, callback };
+}
+function checkFetchArgs(name, options) {
+    assert(name, 'missing queue name');
+    assert(!('batchSize' in options) || (Number.isInteger(options.batchSize) && options.batchSize >= 1), 'batchSize must be an integer > 0');
+    assert(!('includeMetadata' in options) || typeof options.includeMetadata === 'boolean', 'includeMetadata must be a boolean');
+    assert(!('priority' in options) || typeof options.priority === 'boolean', 'priority must be a boolean');
+    assert(!('ignoreStartAfter' in options) || typeof options.ignoreStartAfter === 'boolean', 'ignoreStartAfter must be a boolean');
+}
+function getConfig(value) {
+    assert(value && (typeof value === 'object' || typeof value === 'string'), 'configuration assert: string or config object is required to connect to postgres');
+    const config = (typeof value === 'string')
+        ? { connectionString: value }
+        : { ...value };
+    config.schedule = ('schedule' in config) ? config.schedule : true;
+    config.supervise = ('supervise' in config) ? config.supervise : true;
+    config.migrate = ('migrate' in config) ? config.migrate : true;
+    config.createSchema = ('createSchema' in config) ? config.createSchema : true;
+    applySchemaConfig(config);
+    applyOpsConfig(config);
+    applyScheduleConfig(config);
+    validateWarningConfig(config);
+    return config;
+}
+function applySchemaConfig(config) {
+    if (config.schema) {
+        assertPostgresObjectName(config.schema);
+    }
+    config.schema = config.schema || DEFAULT_SCHEMA;
+}
+function validateWarningConfig(config) {
+    assert(!('warningQueueSize' in config) || config.warningQueueSize >= 1, 'configuration assert: warningQueueSize must be at least 1');
+    assert(!('warningSlowQuerySeconds' in config) || config.warningSlowQuerySeconds >= 1, 'configuration assert: warningSlowQuerySeconds must be at least 1');
+}
+function assertPostgresObjectName(name) {
+    assert(typeof name === 'string', 'Name must be a string');
+    assert(name.length <= 50, 'Name cannot exceed 50 characters');
+    assert(!/\W/.test(name), 'Name can only contain alphanumeric characters or underscores');
+    assert(!/^\d/.test(name), 'Name cannot start with a number');
+}
+function assertQueueName(name) {
+    assert(name, 'Name is required');
+    assert(typeof name === 'string', 'Name must be a string');
+    assertObjectName(name);
+}
+function assertKey(key) {
+    if (!key)
+        return;
+    assert(typeof key === 'string', 'Key must be a string');
+    assertObjectName(key, 'Key');
+}
+function validateRetentionConfig(config) {
+    assert(!('retentionSeconds' in config) || config.retentionSeconds >= 1, 'configuration assert: retentionSeconds must be at least every second');
+}
+function validateExpirationConfig(config) {
+    assert(!('expireInSeconds' in config) || config.expireInSeconds >= 1, 'configuration assert: expireInSeconds must be at least every second');
+    assert(!config.expireInSeconds || config.expireInSeconds / 60 / 60 < POLICY.MAX_EXPIRATION_HOURS, `configuration assert: expiration cannot exceed ${POLICY.MAX_EXPIRATION_HOURS} hours`);
+}
+function validateRetryConfig(config) {
+    assert(!('retryDelay' in config) || (Number.isInteger(config.retryDelay) && config.retryDelay >= 0), 'retryDelay must be an integer >= 0');
+    assert(!('retryLimit' in config) || (Number.isInteger(config.retryLimit) && config.retryLimit >= 0), 'retryLimit must be an integer >= 0');
+    assert(!('retryBackoff' in config) || (config.retryBackoff === true || config.retryBackoff === false), 'retryBackoff must be either true or false');
+    assert(!('retryDelayMax' in config) || config.retryDelayMax === null || config.retryBackoff === true, 'retryDelayMax can only be set if retryBackoff is true');
+    assert(!('retryDelayMax' in config) || config.retryDelayMax === null || (Number.isInteger(config.retryDelayMax) && config.retryDelayMax >= 0), 'retryDelayMax must be an integer >= 0');
+}
+function applyPollingInterval(config) {
+    assert(!('pollingIntervalSeconds' in config) || config.pollingIntervalSeconds >= POLICY.MIN_POLLING_INTERVAL_MS / 1000, `configuration assert: pollingIntervalSeconds must be at least every ${POLICY.MIN_POLLING_INTERVAL_MS}ms`);
+    config.pollingInterval = ('pollingIntervalSeconds' in config)
+        ? config.pollingIntervalSeconds * 1000
+        : 2000;
+}
+function applyOpsConfig(config) {
+    assert(!('superviseIntervalSeconds' in config) || config.superviseIntervalSeconds >= 1, 'configuration assert: superviseIntervalSeconds must be at least every second');
+    config.superviseIntervalSeconds = config.superviseIntervalSeconds || 60;
+    assert(config.superviseIntervalSeconds / 60 / 60 <= POLICY.MAX_EXPIRATION_HOURS, `configuration assert: superviseIntervalSeconds cannot exceed ${POLICY.MAX_EXPIRATION_HOURS} hours`);
+    assert(!('maintenanceIntervalSeconds' in config) || config.maintenanceIntervalSeconds >= 1, 'configuration assert: maintenanceIntervalSeconds must be at least every second');
+    config.maintenanceIntervalSeconds = config.maintenanceIntervalSeconds || POLICY.MAX_EXPIRATION_HOURS * 60 * 60;
+    assert(config.maintenanceIntervalSeconds / 60 / 60 <= POLICY.MAX_EXPIRATION_HOURS, `configuration assert: maintenanceIntervalSeconds cannot exceed ${POLICY.MAX_EXPIRATION_HOURS} hours`);
+    assert(!('monitorIntervalSeconds' in config) || config.monitorIntervalSeconds >= 1, 'configuration assert: monitorIntervalSeconds must be at least every second');
+    config.monitorIntervalSeconds = config.monitorIntervalSeconds || 60;
+    assert(config.monitorIntervalSeconds / 60 / 60 <= POLICY.MAX_EXPIRATION_HOURS, `configuration assert: monitorIntervalSeconds cannot exceed ${POLICY.MAX_EXPIRATION_HOURS} hours`);
+    assert(!('queueCacheIntervalSeconds' in config) || config.queueCacheIntervalSeconds >= 1, 'configuration assert: queueCacheIntervalSeconds must be at least every second');
+    config.queueCacheIntervalSeconds = config.queueCacheIntervalSeconds || 60;
+    assert(config.queueCacheIntervalSeconds / 60 / 60 <= POLICY.MAX_EXPIRATION_HOURS, `configuration assert: queueCacheIntervalSeconds cannot exceed ${POLICY.MAX_EXPIRATION_HOURS} hours`);
+}
+function validateDeletionConfig(config) {
+    assert(!('deleteAfterSeconds' in config) || config.deleteAfterSeconds >= 1, 'configuration assert: deleteAfterSeconds must be at least every second');
+}
+function applyScheduleConfig(config) {
+    assert(!('clockMonitorIntervalSeconds' in config) || (config.clockMonitorIntervalSeconds >= 1 && config.clockMonitorIntervalSeconds <= 600), 'configuration assert: clockMonitorIntervalSeconds must be between 1 second and 10 minutes');
+    config.clockMonitorIntervalSeconds = config.clockMonitorIntervalSeconds || 600;
+    assert(!('cronMonitorIntervalSeconds' in config) || (config.cronMonitorIntervalSeconds >= 1 && config.cronMonitorIntervalSeconds <= 45), 'configuration assert: cronMonitorIntervalSeconds must be between 1 and 45 seconds');
+    config.cronMonitorIntervalSeconds = config.cronMonitorIntervalSeconds || 30;
+    assert(!('cronWorkerIntervalSeconds' in config) || (config.cronWorkerIntervalSeconds >= 1 && config.cronWorkerIntervalSeconds <= 45), 'configuration assert: cronWorkerIntervalSeconds must be between 1 and 45 seconds');
+    config.cronWorkerIntervalSeconds = config.cronWorkerIntervalSeconds || 5;
+}
+export { assertKey, assertPostgresObjectName, assertQueueName, checkFetchArgs, checkSendArgs, checkWorkArgs, getConfig, POLICY, validateQueueArgs };

package/dist/boss.d.ts

@@ -0,0 +1,16 @@
+import EventEmitter from 'node:events';
+import type Manager from './manager.js';
+import * as types from './types.js';
+declare class Boss extends EventEmitter implements types.EventsMixin {
+    #private;
+    events: {
+        error: string;
+        warning: string;
+    };
+    constructor(db: types.IDatabase, manager: Manager, config: types.ResolvedConstructorOptions);
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    supervise(value?: string | types.QueueResult): Promise<void>;
+}
+export default Boss;
+//# sourceMappingURL=boss.d.ts.map

package/dist/boss.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"boss.d.ts","sourceRoot":"","sources":["../src/boss.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,aAAa,CAAA;AACtC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAGvC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAYnC,cAAM,IAAK,SAAQ,YAAa,YAAW,KAAK,CAAC,WAAW;;IAQ1D,MAAM;;;MAAS;gBAGb,EAAE,EAAE,KAAK,CAAC,SAAS,EACnB,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,KAAK,CAAC,0BAA0B;IAkBpC,KAAK;IAUL,IAAI;IAiDJ,SAAS,CAAE,KAAK,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,WAAW;CAwEpD;AAED,eAAe,IAAI,CAAA"}

package/dist/boss.js

@@ -0,0 +1,135 @@
+import EventEmitter from 'node:events';
+import * as plans from './plans.js';
+import { unwrapSQLResult } from './tools.js';
+import * as types from './types.js';
+const events = {
+    error: 'error',
+    warning: 'warning'
+};
+const WARNINGS = {
+    SLOW_QUERY: { seconds: 30, message: 'Warning: slow query. Your queues and/or database server should be reviewed' },
+    LARGE_QUEUE: { size: 10_000, message: 'Warning: large queue backlog. Your queue should be reviewed' }
+};
+class Boss extends EventEmitter {
+    #stopped;
+    #maintaining;
+    #superviseInterval;
+    #db;
+    #config;
+    #manager;
+    events = events;
+    constructor(db, manager, config) {
+        super();
+        this.#db = db;
+        this.#config = config;
+        this.#manager = manager;
+        this.#stopped = true;
+        if (config.warningSlowQuerySeconds) {
+            WARNINGS.SLOW_QUERY.seconds = config.warningSlowQuerySeconds;
+        }
+        if (config.warningQueueSize) {
+            WARNINGS.LARGE_QUEUE.size = config.warningQueueSize;
+        }
+    }
+    async start() {
+        if (this.#stopped) {
+            this.#superviseInterval = setInterval(() => this.#onSupervise(), this.#config.superviseIntervalSeconds * 1000);
+            this.#stopped = false;
+        }
+    }
+    async stop() {
+        if (!this.#stopped) {
+            if (this.#superviseInterval)
+                clearInterval(this.#superviseInterval);
+            this.#stopped = true;
+        }
+    }
+    async #executeSql(sql, values) {
+        const started = Date.now();
+        const result = unwrapSQLResult(await this.#db.executeSql(sql, values));
+        const ended = Date.now();
+        const elapsed = (ended - started) / 1000;
+        if (elapsed > WARNINGS.SLOW_QUERY.seconds ||
+            this.#config.__test__warn_slow_query) {
+            this.emit(events.warning, {
+                message: WARNINGS.SLOW_QUERY.message,
+                data: { elapsed, sql, values },
+            });
+        }
+        return result;
+    }
+    async #onSupervise() {
+        try {
+            if (this.#stopped)
+                return;
+            if (this.#maintaining)
+                return;
+            if (this.#config.__test__throw_maint) {
+                throw new Error(this.#config.__test__throw_maint);
+            }
+            this.#maintaining = true;
+            const queues = await this.#manager.getQueues();
+            for (const queue of queues) {
+                !this.#stopped && (await this.supervise(queue));
+            }
+        }
+        catch (err) {
+            this.emit(events.error, err);
+        }
+        finally {
+            this.#maintaining = false;
+        }
+    }
+    async supervise(value) {
+        let queues;
+        if (typeof value === 'object') {
+            queues = [value];
+        }
+        else {
+            queues = await this.#manager.getQueues(value);
+        }
+        const queueGroups = queues.reduce((acc, q) => {
+            const { table } = q;
+            acc[table] = acc[table] || { table, queues: [] };
+            acc[table].queues.push(q);
+            return acc;
+        }, {});
+        for (const queueGroup of Object.values(queueGroups)) {
+            const { table, queues } = queueGroup;
+            const names = queues.map((i) => i.name);
+            while (names.length) {
+                const chunk = names.splice(0, 100);
+                await this.#monitor(table, chunk);
+                await this.#maintain(table, chunk);
+            }
+        }
+    }
+    async #monitor(table, names) {
+        const command = plans.trySetQueueMonitorTime(this.#config.schema, names, this.#config.monitorIntervalSeconds);
+        const { rows } = await this.#executeSql(command);
+        if (rows.length) {
+            const queues = rows.map((q) => q.name);
+            const cacheStatsSql = plans.cacheQueueStats(this.#config.schema, table, queues);
+            const { rows: rowsCacheStats } = await this.#executeSql(cacheStatsSql);
+            const warnings = rowsCacheStats.filter(i => i.queuedCount > (i.warningQueueSize || WARNINGS.LARGE_QUEUE.size));
+            for (const warning of warnings) {
+                this.emit(events.warning, {
+                    message: WARNINGS.LARGE_QUEUE.message,
+                    data: warning,
+                });
+            }
+            const sql = plans.failJobsByTimeout(this.#config.schema, table, queues);
+            await this.#executeSql(sql);
+        }
+    }
+    async #maintain(table, names) {
+        const command = plans.trySetQueueDeletionTime(this.#config.schema, names, this.#config.maintenanceIntervalSeconds);
+        const { rows } = await this.#executeSql(command);
+        if (rows.length) {
+            const queues = rows.map((q) => q.name);
+            const sql = plans.deletion(this.#config.schema, table, queues);
+            await this.#executeSql(sql);
+        }
+    }
+}
+export default Boss;

package/dist/contractor.d.ts

@@ -0,0 +1,22 @@
+import type * as types from './types.ts';
+declare class Contractor {
+    static constructionPlans(schema?: string, options?: {
+        createSchema: boolean;
+    }): string;
+    static migrationPlans(schema?: string, version?: number): string;
+    static rollbackPlans(schema?: string, version?: number): string;
+    private config;
+    private db;
+    private migrations;
+    constructor(db: types.IDatabase, config: types.ResolvedConstructorOptions);
+    schemaVersion(): Promise<number | null>;
+    isInstalled(): Promise<boolean>;
+    start(): Promise<void>;
+    check(): Promise<void>;
+    create(): Promise<void>;
+    migrate(version: number): Promise<void>;
+    next(version: number): Promise<void>;
+    rollback(version: number): Promise<void>;
+}
+export default Contractor;
+//# sourceMappingURL=contractor.d.ts.map

package/dist/contractor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contractor.d.ts","sourceRoot":"","sources":["../src/contractor.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AAIxC,cAAM,UAAU;IACd,MAAM,CAAC,iBAAiB,CAAE,MAAM,SAAuB,EAAE,OAAO;;KAAyB;IAIzF,MAAM,CAAC,cAAc,CAAE,MAAM,SAAuB,EAAE,OAAO,SAAoB;IAIjF,MAAM,CAAC,aAAa,CAAE,MAAM,SAAuB,EAAE,OAAO,SAAgB;IAI5E,OAAO,CAAC,MAAM,CAAkC;IAChD,OAAO,CAAC,EAAE,CAAiB;IAC3B,OAAO,CAAC,UAAU,CAAmB;gBAExB,EAAE,EAAE,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,0BAA0B;IAMpE,aAAa;IAKb,WAAW;IAKX,KAAK;IAcL,KAAK;IAcL,MAAM;IASN,OAAO,CAAE,OAAO,EAAE,MAAM;IASxB,IAAI,CAAE,OAAO,EAAE,MAAM;IAKrB,QAAQ,CAAE,OAAO,EAAE,MAAM;CAIhC;AAED,eAAe,UAAU,CAAA"}

package/dist/contractor.js

@@ -0,0 +1,81 @@
+import assert from 'node:assert';
+import * as plans from "./plans.js";
+import * as migrationStore from "./migrationStore.js";
+import packageJson from '../package.json' with { type: 'json' };
+const schemaVersion = packageJson.pgboss.schema;
+class Contractor {
+    static constructionPlans(schema = plans.DEFAULT_SCHEMA, options = { createSchema: true }) {
+        return plans.create(schema, schemaVersion, options);
+    }
+    static migrationPlans(schema = plans.DEFAULT_SCHEMA, version = schemaVersion - 1) {
+        return migrationStore.migrate(schema, version);
+    }
+    static rollbackPlans(schema = plans.DEFAULT_SCHEMA, version = schemaVersion) {
+        return migrationStore.rollback(schema, version);
+    }
+    config;
+    db;
+    migrations;
+    constructor(db, config) {
+        this.config = config;
+        this.db = db;
+        this.migrations = this.config.migrations || migrationStore.getAll(this.config.schema);
+    }
+    async schemaVersion() {
+        const result = await this.db.executeSql(plans.getVersion(this.config.schema));
+        return result.rows.length ? parseInt(result.rows[0].version) : null;
+    }
+    async isInstalled() {
+        const result = await this.db.executeSql(plans.versionTableExists(this.config.schema));
+        return !!result.rows[0].name;
+    }
+    async start() {
+        const installed = await this.isInstalled();
+        if (installed) {
+            const version = await this.schemaVersion();
+            if (version !== null && schemaVersion > version) {
+                await this.migrate(version);
+            }
+        }
+        else {
+            await this.create();
+        }
+    }
+    async check() {
+        const installed = await this.isInstalled();
+        if (!installed) {
+            throw new Error('pg-boss is not installed');
+        }
+        const version = await this.schemaVersion();
+        if (schemaVersion !== version) {
+            throw new Error('pg-boss database requires migrations');
+        }
+    }
+    async create() {
+        try {
+            const commands = plans.create(this.config.schema, schemaVersion, this.config);
+            await this.db.executeSql(commands);
+        }
+        catch (err) {
+            assert(err.message.includes(plans.CREATE_RACE_MESSAGE), err);
+        }
+    }
+    async migrate(version) {
+        try {
+            const commands = migrationStore.migrate(this.config.schema, version, this.migrations);
+            await this.db.executeSql(commands);
+        }
+        catch (err) {
+            assert(err.message.includes(plans.MIGRATE_RACE_MESSAGE), err);
+        }
+    }
+    async next(version) {
+        const commands = migrationStore.next(this.config.schema, version, this.migrations);
+        await this.db.executeSql(commands);
+    }
+    async rollback(version) {
+        const commands = migrationStore.rollback(this.config.schema, version, this.migrations);
+        await this.db.executeSql(commands);
+    }
+}
+export default Contractor;

package/dist/db.d.ts

@@ -0,0 +1,16 @@
+import EventEmitter from 'node:events';
+import type * as types from './types.ts';
+declare class Db extends EventEmitter implements types.IDatabase, types.EventsMixin {
+    private pool;
+    private config;
+    opened: boolean;
+    constructor(config: types.DatabaseOptions);
+    events: {
+        error: string;
+    };
+    open(): Promise<void>;
+    close(): Promise<void>;
+    executeSql(text: string, values?: unknown[]): Promise<import("pg").QueryResult<any>>;
+}
+export default Db;
+//# sourceMappingURL=db.d.ts.map

package/dist/db.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"db.d.ts","sourceRoot":"","sources":["../src/db.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,aAAa,CAAA;AAGtC,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AAExC,cAAM,EAAG,SAAQ,YAAa,YAAW,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,WAAW;IACzE,OAAO,CAAC,IAAI,CAAU;IACtB,OAAO,CAAC,MAAM,CAAuB;IAGrC,MAAM,EAAE,OAAO,CAAA;gBAEF,MAAM,EAAE,KAAK,CAAC,eAAe;IAY1C,MAAM;;MAEL;IAEK,IAAI;IAMJ,KAAK;IAOL,UAAU,CAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE;CAenD;AAED,eAAe,EAAE,CAAA"}

package/dist/db.js

@@ -0,0 +1,46 @@
+import EventEmitter from 'node:events';
+import pg from 'pg';
+import assert from 'node:assert';
+class Db extends EventEmitter {
+    pool;
+    config;
+    /** @internal */
+    _pgbdb;
+    opened;
+    constructor(config) {
+        super();
+        config.application_name = config.application_name || 'pgboss';
+        config.connectionTimeoutMillis = config.connectionTimeoutMillis || 10000;
+        // config.maxUses = config.maxUses || 1000
+        this.config = config;
+        this._pgbdb = true;
+        this.opened = false;
+    }
+    events = {
+        error: 'error'
+    };
+    async open() {
+        this.pool = new pg.Pool(this.config);
+        this.pool.on('error', error => this.emit('error', error));
+        this.opened = true;
+    }
+    async close() {
+        if (!this.pool.ending) {
+            this.opened = false;
+            await this.pool.end();
+        }
+    }
+    async executeSql(text, values) {
+        assert(this.opened, 'Database not opened. Call open() before executing SQL.');
+        // if (this.config.debug === true) {
+        //   console.log(`${new Date().toISOString()}: DEBUG SQL`)
+        //   console.log(text)
+        //   if (values) {
+        //     console.log(`${new Date().toISOString()}: DEBUG VALUES`)
+        //     console.log(values)
+        //   }
+        // }
+        return await this.pool.query(text, values);
+    }
+}
+export default Db;

package/dist/index.d.ts

@@ -0,0 +1,66 @@
+import EventEmitter from 'node:events';
+import type * as types from './types.ts';
+import type { JobSpyInterface } from './spy.ts';
+export { JOB_STATES as states } from './plans.ts';
+export { QUEUE_POLICIES as policies } from './plans.ts';
+export declare const events: types.Events;
+export declare function getConstructionPlans(schema?: string): string;
+export declare function getMigrationPlans(schema?: string, version?: number): string;
+export declare function getRollbackPlans(schema?: string, version?: number): string;
+export declare class PgBoss extends EventEmitter<types.PgBossEventMap> {
+    #private;
+    constructor(connectionString: string);
+    constructor(options: types.ConstructorOptions);
+    start(): Promise<this>;
+    stop(options?: types.StopOptions): Promise<void>;
+    send(request: types.Request): Promise<string | null>;
+    send(name: string, data?: object | null, options?: types.SendOptions): Promise<string | null>;
+    sendAfter(name: string, data: object | null, options: types.SendOptions | null, date: Date): Promise<string | null>;
+    sendAfter(name: string, data: object | null, options: types.SendOptions | null, dateString: string): Promise<string | null>;
+    sendAfter(name: string, data: object | null, options: types.SendOptions | null, seconds: number): Promise<string | null>;
+    sendThrottled(name: string, data: object | null, options: types.SendOptions | null, seconds: number, key?: string): Promise<string | null>;
+    sendDebounced(name: string, data: object | null, options: types.SendOptions | null, seconds: number, key?: string): Promise<string | null>;
+    insert(name: string, jobs: types.JobInsert[], options?: types.InsertOptions): Promise<string[] | null>;
+    fetch<T>(name: string, options: types.FetchOptions & {
+        includeMetadata: true;
+    }): Promise<types.JobWithMetadata<T>[]>;
+    fetch<T>(name: string, options?: types.FetchOptions): Promise<types.Job<T>[]>;
+    work<ReqData, ResData = any>(name: string, handler: types.WorkHandler<ReqData, ResData>): Promise<string>;
+    work<ReqData, ResData = any>(name: string, options: types.WorkOptions & {
+        includeMetadata: true;
+    }, handler: types.WorkWithMetadataHandler<ReqData, ResData>): Promise<string>;
+    work<ReqData, ResData = any>(name: string, options: types.WorkOptions, handler: types.WorkHandler<ReqData, ResData>): Promise<string>;
+    offWork(name: string, options?: types.OffWorkOptions): Promise<void>;
+    notifyWorker(workerId: string): void;
+    subscribe(event: string, name: string): Promise<void>;
+    unsubscribe(event: string, name: string): Promise<void>;
+    publish(event: string, data?: object, options?: types.SendOptions): Promise<void>;
+    cancel(name: string, id: string | string[], options?: types.ConnectionOptions): Promise<types.CommandResponse>;
+    resume(name: string, id: string | string[], options?: types.ConnectionOptions): Promise<types.CommandResponse>;
+    retry(name: string, id: string | string[], options?: types.ConnectionOptions): Promise<types.CommandResponse>;
+    deleteJob(name: string, id: string | string[], options?: types.ConnectionOptions): Promise<types.CommandResponse>;
+    deleteQueuedJobs(name: string): Promise<void>;
+    deleteStoredJobs(name: string): Promise<void>;
+    deleteAllJobs(name?: string): Promise<void>;
+    complete(name: string, id: string | string[], data?: object | null, options?: types.ConnectionOptions): Promise<types.CommandResponse>;
+    fail(name: string, id: string | string[], data?: object | null, options?: types.ConnectionOptions): Promise<types.CommandResponse>;
+    getJobById<T>(name: string, id: string, options?: types.ConnectionOptions): Promise<types.JobWithMetadata<T> | null>;
+    createQueue(name: string, options?: Omit<types.Queue, 'name'>): Promise<void>;
+    updateQueue(name: string, options?: types.UpdateQueueOptions): Promise<void>;
+    deleteQueue(name: string): Promise<void>;
+    getQueues(names?: string[]): Promise<types.QueueResult[]>;
+    getQueue(name: string): Promise<types.QueueResult | null>;
+    getQueueStats(name: string): Promise<types.QueueResult>;
+    supervise(name?: string): Promise<void>;
+    getSpy<T = object>(name: string): JobSpyInterface<T>;
+    clearSpies(): void;
+    isInstalled(): Promise<boolean>;
+    schemaVersion(): Promise<number | null>;
+    schedule(name: string, cron: string, data?: object | null, options?: types.ScheduleOptions): Promise<void>;
+    unschedule(name: string, key?: string): Promise<void>;
+    getSchedules(name?: string, key?: string): Promise<types.Schedule[]>;
+    getDb(): types.IDatabase;
+}
+export type { ConnectionOptions, ConstructorOptions, FetchOptions, IDatabase as Db, Job, JobFetchOptions, JobInsert, JobPollingOptions, JobStates, Events, JobWithMetadata, MaintenanceOptions, OffWorkOptions, Queue, QueuePolicy, QueueResult, Request, Schedule, ScheduleOptions, SchedulingOptions, SendOptions, StopOptions, WipData, WorkHandler, WorkOptions, WorkWithMetadataHandler, } from './types.ts';
+export type { JobSpyInterface, JobSpyState, JobDataSelector, JobSelector, SpyJob, } from './spy.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,aAAa,CAAA;AAOtC,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AAExC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAE/C,OAAO,EAAE,UAAU,IAAI,MAAM,EAAE,MAAM,YAAY,CAAA;AACjD,OAAO,EAAE,cAAc,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAA;AACvD,eAAO,MAAM,MAAM,EAAE,KAAK,CAAC,MAKzB,CAAA;AAEF,wBAAgB,oBAAoB,CAAE,MAAM,CAAC,EAAE,MAAM,UAEpD;AAED,wBAAgB,iBAAiB,CAAE,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,UAEnE;AAED,wBAAgB,gBAAgB,CAAE,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,UAElE;AAED,qBAAa,MAAO,SAAQ,YAAY,CAAC,KAAK,CAAC,cAAc,CAAC;;gBAY/C,gBAAgB,EAAE,MAAM;gBACxB,OAAO,EAAE,KAAK,CAAC,kBAAkB;IAyCxC,KAAK,IAAK,OAAO,CAAC,IAAI,CAAC;IAkCvB,IAAI,CAAE,OAAO,GAAE,KAAK,CAAC,WAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IA2C3D,IAAI,CAAE,OAAO,EAAE,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IACrD,IAAI,CAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAK9F,SAAS,CAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,WAAW,GAAG,IAAI,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IACpH,SAAS,CAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,WAAW,GAAG,IAAI,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAC5H,SAAS,CAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,WAAW,GAAG,IAAI,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAKzH,aAAa,CAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,WAAW,GAAG,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAI3I,aAAa,CAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,WAAW,GAAG,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAI3I,MAAM,CAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,aAAa,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC;IAIvG,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,YAAY,GAAG;QAAE,eAAe,EAAE,IAAI,CAAA;KAAE,GAAG,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC;IACpH,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAK7E,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IACzG,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,WAAW,GAAG;QAAE,eAAe,EAAE,IAAI,CAAA;KAAE,EAAE,OAAO,EAAE,KAAK,CAAC,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAC7K,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAKrI,OAAO,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrE,YAAY,CAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IAIrC,SAAS,CAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD,WAAW,CAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxD,OAAO,CAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlF,MAAM,CAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC;IAI/G,MAAM,CAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC;IAI/G,KAAK,CAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC;IAI9G,SAAS,CAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC;IAIlH,gBAAgB,CAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9C,gBAAgB,CAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9C,aAAa,CAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI5C,QAAQ,CAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC;IAIvI,IAAI,CAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC;IAInI,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAIpH,WAAW,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9E,WAAW,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7E,WAAW,CAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzC,SAAS,CAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;IAI1D,QAAQ,CAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC;IAI1D,aAAa,CAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC;IAIxD,SAAS,CAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxC,MAAM,CAAC,CAAC,GAAG,MAAM,EAAG,IAAI,EAAE,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC;IAIrD,UAAU,IAAK,IAAI;IAInB,WAAW,IAAK,OAAO,CAAC,OAAO,CAAC;IAIhC,aAAa,IAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAIxC,QAAQ,CAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3G,UAAU,CAAE,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD,YAAY,CAAE,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;IAIrE,KAAK,IAAK,KAAK,CAAC,SAAS;CAW1B;AAED,YAAY,EACV,iBAAiB,EACjB,kBAAkB,EAClB,YAAY,EACZ,SAAS,IAAI,EAAE,EACf,GAAG,EACH,eAAe,EACf,SAAS,EACT,iBAAiB,EACjB,SAAS,EACT,MAAM,EACN,eAAe,EACf,kBAAkB,EAClB,cAAc,EACd,KAAK,EACL,WAAW,EACX,WAAW,EACX,OAAO,EACP,QAAQ,EACR,eAAe,EACf,iBAAiB,EACjB,WAAW,EACX,WAAW,EACX,OAAO,EACP,WAAW,EACX,WAAW,EACX,uBAAuB,GACxB,MAAM,YAAY,CAAA;AAEnB,YAAY,EACV,eAAe,EACf,WAAW,EACX,eAAe,EACf,WAAW,EACX,MAAM,GACP,MAAM,UAAU,CAAA"}