@clipboard-health/background-jobs-adapter 0.1.0 → 0.3.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@clipboard-health/background-jobs-adapter",
   "description": "Minimal adapter interface for background jobs operations supporting Mongo and Postgres implementations.",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "bugs": "https://github.com/ClipboardHealth/core-utils/issues",
   "dependencies": {
     "tslib": "2.8.1"

package/src/lib/adapter.d.ts

@@ -1,53 +1,60 @@
-/**
- * Minimal adapter interface for background jobs operations supporting background-jobs-mongo (Mongo)
- * and background-jobs-postgres (Postgres) implementations.
- */
+export type BackgroundJobsImplementation = "mongo" | "postgres";
+export interface Handler<TData> {
+    perform(data: TData, job?: unknown): Promise<string | void>;
+}
 /**
  * Base handler interface that supports each implementation.
  */
-export interface BaseHandler<T> {
+export interface BaseHandler<T> extends Handler<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>;
+    new (...arguments_: never[]): Handler<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 {
+interface WithStartAt {
     /**
      * 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 | {
+}
+export interface MongoEnqueueOptions extends WithStartAt {
+    session?: unknown;
+    unique?: string | {
         enqueuedKey: string | undefined;
         runningKey: string | undefined;
     };
 }
+export interface PostgresEnqueueOptions extends WithStartAt {
+    idempotencyKey?: string;
+    transaction?: unknown;
+}
+export declare const ENQUEUE_FIELD_NAMES: {
+    readonly mongo: {
+        readonly startAt: "startAt";
+        readonly transaction: "session";
+        readonly idempotencyKey: "unique";
+    };
+    readonly postgres: {
+        readonly startAt: "startAt";
+        readonly idempotencyKey: "idempotencyKey";
+        readonly transaction: "transaction";
+    };
+};
+export type EnqueueOptions = MongoEnqueueOptions | PostgresEnqueueOptions;
 /**
- * Minimal adapter interface for background jobs enqueue operations.
+ * Minimal adapter interface for background jobs operations supporting background-jobs-mongo (Mongo)
+ * and background-jobs-postgres (Postgres) implementations.
  */
 export interface BackgroundJobsAdapter {
+    implementation: BackgroundJobsImplementation;
     /**
      * Enqueue a job to be processed.
      *
@@ -56,5 +63,6 @@ export interface BackgroundJobsAdapter {
      * @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>;
+    enqueue<T>(handler: string | HandlerClassOrInstance<T>, data: T, options?: EnqueueOptions): Promise<unknown>;
 }
+export {};

package/src/lib/adapter.js

@@ -1,7 +1,16 @@
 "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 });
+exports.ENQUEUE_FIELD_NAMES = void 0;
+exports.ENQUEUE_FIELD_NAMES = {
+    mongo: {
+        startAt: "startAt",
+        transaction: "session",
+        idempotencyKey: "unique",
+    },
+    postgres: {
+        startAt: "startAt",
+        idempotencyKey: "idempotencyKey",
+        transaction: "transaction",
+    },
+};
 //# sourceMappingURL=adapter.js.map

package/src/lib/adapter.js.map

@@ -1 +1 @@
-{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../../../../../packages/background-jobs-adapter/src/lib/adapter.ts"],"names":[],"mappings":";AAAA;;;GAGG"}
+{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../../../../../packages/background-jobs-adapter/src/lib/adapter.ts"],"names":[],"mappings":";;;AAsDa,QAAA,mBAAmB,GAAG;IACjC,KAAK,EAAE;QACL,OAAO,EAAE,SAAS;QAClB,WAAW,EAAE,SAAS;QACtB,cAAc,EAAE,QAAQ;KAC2C;IACrE,QAAQ,EAAE;QACR,OAAO,EAAE,SAAS;QAClB,cAAc,EAAE,gBAAgB;QAChC,WAAW,EAAE,aAAa;KAC4C;CAChE,CAAC"}