@clipboard-health/background-jobs-adapter 0.1.0

package/README.md

@@ -0,0 +1,21 @@
+# @clipboard-health/background-jobs-adapter <!-- omit from toc -->
+
+Minimal adapter interface for background jobs operations supporting Mongo and Postgres implementations.
+
+## Table of contents <!-- omit from toc -->
+
+- [Install](#install)
+- [Usage](#usage)
+- [Local development commands](#local-development-commands)
+
+## Install
+
+```bash
+npm install @clipboard-health/background-jobs-adapter
+```
+
+## Usage
+
+## Local development commands
+
+See [`package.json`](./package.json) `scripts` for a list of commands.

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@clipboard-health/background-jobs-adapter",
+  "description": "Minimal adapter interface for background jobs operations supporting Mongo and Postgres implementations.",
+  "version": "0.1.0",
+  "bugs": "https://github.com/ClipboardHealth/core-utils/issues",
+  "dependencies": {
+    "tslib": "2.8.1"
+  },
+  "keywords": [],
+  "license": "MIT",
+  "main": "./src/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "directory": "packages/background-jobs-adapter",
+    "type": "git",
+    "url": "git+https://github.com/ClipboardHealth/core-utils.git"
+  },
+  "type": "commonjs",
+  "typings": "./src/index.d.ts",
+  "types": "./src/index.d.ts"
+}

package/src/index.d.ts

@@ -0,0 +1 @@
+export * from "./lib/adapter";

package/src/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/adapter"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/background-jobs-adapter/src/index.ts"],"names":[],"mappings":";;;AAAA,wDAA8B"}

package/src/lib/adapter.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Minimal adapter interface for background jobs operations supporting background-jobs-mongo (Mongo)
+ * and background-jobs-postgres (Postgres) implementations.
+ */
+/**
+ * Base handler interface that supports each implementation.
+ */
+export interface BaseHandler<T> {
+    name?: string;
+    perform(data: T, job?: unknown): Promise<unknown>;
+}
+/**
+ * Handler class interface that supports each implementation.
+ */
+export interface BaseHandlerClass<T> {
+    queueName?: string;
+    new (...arguments_: never[]): BaseHandler<T>;
+}
+/**
+ * Union type for handler class or instance.
+ */
+export type HandlerClassOrInstance<T> = BaseHandlerClass<T> | BaseHandler<T>;
+/**
+ * Common enqueue options that each implementation supports.
+ */
+export interface CommonEnqueueOptions {
+    /**
+     * When the job should start being processed.
+     */
+    startAt?: Date;
+    /**
+     * Database transaction/session to use for atomic job creation.
+     * - Mongo: called `session`; ClientSession
+     * - Postgres: DatabaseClient (Prisma transaction, pg client, etc.)
+     */
+    transaction?: unknown;
+    /**
+     * Unique key for job deduplication
+     * - Mongo: called `unique`; string or JobUniqueOptions
+     * - Postgres: idempotencyKey
+     */
+    idempotencyKey?: string | {
+        enqueuedKey: string | undefined;
+        runningKey: string | undefined;
+    };
+}
+/**
+ * Minimal adapter interface for background jobs enqueue operations.
+ */
+export interface BackgroundJobsAdapter {
+    /**
+     * Enqueue a job to be processed.
+     *
+     * @param handler - The handler class or instance that will process the job
+     * @param data - The data to be processed by the handler
+     * @param options - Optional configuration for the job
+     * @returns A promise that resolves to the enqueued job or undefined (implementation-specific)
+     */
+    enqueue<T extends Record<string, unknown>>(handler: string | HandlerClassOrInstance<T>, data: T, options?: CommonEnqueueOptions): Promise<unknown>;
+}

package/src/lib/adapter.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Minimal adapter interface for background jobs operations supporting background-jobs-mongo (Mongo)
+ * and background-jobs-postgres (Postgres) implementations.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=adapter.js.map

package/src/lib/adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../../../../../packages/background-jobs-adapter/src/lib/adapter.ts"],"names":[],"mappings":";AAAA;;;GAGG"}