@rvoh/psychic-workers 0.2.9 → 0.3.1

package/dist/types/src/{psychic-application-workers → psychic-app-workers}/index.d.ts

@@ -1,35 +1,35 @@
-import { PsychicApplication } from '@rvoh/psychic';
+import { PsychicApp } from '@rvoh/psychic';
 import { QueueOptions, WorkerOptions } from 'bullmq';
 import { Cluster, Redis } from 'ioredis';
-import { PsychicBackgroundOptions } from '../background/index.js';
-export default class PsychicApplicationWorkers {
-    static init(psychicApp: PsychicApplication, cb: (app: PsychicApplicationWorkers) => void | Promise<void>): Promise<PsychicApplicationWorkers>;
+import { PsychicBackgroundOptions } from '../types/background.js';
+export default class PsychicAppWorkers {
+    static init(psychicApp: PsychicApp, cb: (app: PsychicAppWorkers) => void | Promise<void>): Promise<PsychicAppWorkers>;
     /**
      * Returns the cached psychic application if it has been set.
      * If it has not been set, an exception is raised.
      *
-     * The psychic application can be set by calling PsychicApplication#init
+     * The psychic application can be set by calling PsychicApp#init
      */
-    static getOrFail(): PsychicApplicationWorkers;
-    psychicApp: PsychicApplication;
-    constructor(psychicApp: PsychicApplication);
+    static getOrFail(): PsychicAppWorkers;
+    psychicApp: PsychicApp;
+    constructor(psychicApp: PsychicApp);
     /**
      * Returns the background options provided by the user
      */
     get backgroundOptions(): PsychicBackgroundOptions;
     private _backgroundOptions;
     private _hooks;
-    get hooks(): PsychicWorkersApplicationHooks;
+    get hooks(): PsychicWorkersAppHooks;
     on<T extends PsychicWorkersHookEventType>(hookEventType: T, cb: T extends 'workers:shutdown' ? () => void | Promise<void> : never): void;
-    set<Opt extends PsychicWorkersApplicationOption>(option: Opt, value: unknown): void;
+    set<Opt extends PsychicWorkersAppOption>(option: Opt, value: Opt extends 'background' ? PsychicBackgroundOptions : unknown): void;
 }
 export interface PsychicWorkersTypeSync {
     workstreamNames: string[];
     queueGroupMap: Record<string, string[]>;
 }
-export type PsychicWorkersApplicationOption = 'background';
+export type PsychicWorkersAppOption = 'background';
 export type PsychicWorkersHookEventType = 'workers:shutdown';
-export interface PsychicWorkersApplicationHooks {
+export interface PsychicWorkersAppHooks {
     workerShutdown: (() => void | Promise<void>)[];
 }
 export interface BullMQNativeWorkerOptions extends WorkerOptions {

package/dist/types/src/types/background.d.ts

@@ -0,0 +1,47 @@
+import { IdType } from '@rvoh/dream';
+import BaseBackgroundedService from '../background/BaseBackgroundedService.js';
+import BaseScheduledService from '../background/BaseScheduledService.js';
+import { PsychicBackgroundNativeBullMQOptions, PsychicBackgroundSimpleOptions } from '../psychic-app-workers/index.js';
+import { Either } from './utils.js';
+export interface BackgroundJobData {
+    /**
+     * the id of the background job. This is provided by BullMQ
+     */
+    id?: IdType;
+    /**
+     * the method name of the method on the provided class
+     */
+    method?: string;
+    /**
+     * the arguments that are fed into your background job
+     */
+    args: any;
+    /**
+     * the path to the file containing the class you are backgrounding
+     */
+    filepath?: string;
+    /**
+     * the import key of the class, which will be 'default' if the class is the default
+     * export of the file, and will otherwise be the name of the exported class.
+     */
+    importKey?: string;
+    /**
+     * the globalName value of the service that is being backgrounded.
+     */
+    globalName?: string;
+}
+export type JobTypes = 'BackgroundJobQueueFunctionJob' | 'BackgroundJobQueueStaticJob' | 'BackgroundJobQueueModelInstanceJob';
+export type BackgroundQueuePriority = 'default' | 'urgent' | 'not_urgent' | 'last';
+interface BaseBackgroundJobConfig {
+    priority?: BackgroundQueuePriority;
+}
+export interface WorkstreamBackgroundJobConfig<T extends BaseScheduledService | BaseBackgroundedService> extends BaseBackgroundJobConfig {
+    workstream?: T['psychicTypes']['workstreamNames'][number];
+}
+export interface QueueBackgroundJobConfig<T extends BaseScheduledService | BaseBackgroundedService, PsyTypes extends T['psychicTypes'] = T['psychicTypes'], QueueGroupMap = PsyTypes['queueGroupMap'], Queue extends keyof QueueGroupMap = keyof QueueGroupMap, Groups extends QueueGroupMap[Queue] = QueueGroupMap[Queue], GroupId = Groups[number & keyof Groups]> extends BaseBackgroundJobConfig {
+    groupId?: GroupId;
+    queue?: Queue;
+}
+export type BackgroundJobConfig<T extends BaseScheduledService | BaseBackgroundedService> = Either<WorkstreamBackgroundJobConfig<T>, QueueBackgroundJobConfig<T>>;
+export type PsychicBackgroundOptions = (PsychicBackgroundSimpleOptions & Partial<Record<Exclude<keyof PsychicBackgroundNativeBullMQOptions, keyof PsychicBackgroundSimpleOptions>, never>>) | (PsychicBackgroundNativeBullMQOptions & Partial<Record<Exclude<keyof PsychicBackgroundSimpleOptions, keyof PsychicBackgroundNativeBullMQOptions>, never>>);
+export {};

package/package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "@rvoh/psychic-workers",
   "description": "Background job system for Psychic applications",
-  "version": "0.2.9",
+  "version": "0.3.1",
   "author": "RVO Health",
   "repository": {
     "type": "git",
@@ -23,17 +23,17 @@
     "dist/**/*"
   ],
   "scripts": {
-    "psy": "NODE_ENV=${NODE_ENV:-test} yarn psyts",
-    "psyjs": "node ./dist/test-app/src/cli/index.js",
-    "psyts": "node --experimental-specifier-resolution=node --import ./bin/esm.js ./test-app/src/cli/index.ts",
+    "psy": "NODE_ENV=${NODE_ENV:-test} yarn psy:ts",
+    "psy:js": "node ./dist/test-app/src/cli/index.js",
+    "psy:ts": "tsx ./test-app/src/cli/index.ts",
     "build": "echo \"building cjs...\" && rm -rf dist && npx tsc -p ./tsconfig.cjs.build.json && echo \"building esm...\" && npx tsc -p ./tsconfig.esm.build.json",
     "uspec": "vitest --config ./spec/unit/vite.config.ts",
     "format": "yarn run prettier . --write",
     "lint": "yarn run eslint --no-warn-ignored \"src/**/*.ts\" && yarn run prettier . --check",
     "console": "tsx ./src/conf/repl.ts",
-    "consolejs": "node ./dist/src/conf/repl.js",
+    "console:js": "node ./dist/src/conf/repl.js",
     "prepack": "yarn build",
-    "dev-worker": "NODE_ENV=development WORKER_COUNT=1 ts-node --transpile-only ./test-app/worker.ts"
+    "dev-worker": "NODE_ENV=development WORKER_COUNT=1 tsx ./test-app/worker.ts"
   },
   "peerDependencies": {
     "@rvoh/dream": "*",
@@ -43,10 +43,10 @@
   },
   "devDependencies": {
     "@eslint/js": "=9.0.0",
-    "@rvoh/dream": "^0.33.0",
-    "@rvoh/dream-spec-helpers": "^0.2.0",
-    "@rvoh/psychic": "^0.28.0",
-    "@rvoh/psychic-spec-helpers": "^0.3.0",
+    "@rvoh/dream": "^0.39.0",
+    "@rvoh/dream-spec-helpers": "^0.2.4",
+    "@rvoh/psychic": "^0.31.0",
+    "@rvoh/psychic-spec-helpers": "^0.6.0",
     "@socket.io/redis-adapter": "^8.3.0",
     "@socket.io/redis-emitter": "^5.1.0",
     "@types/express": "^4",
@@ -65,12 +65,12 @@
     "socket.io": "^4.8.1",
     "socket.io-adapter": "^2.5.5",
     "supertest": "^7.0.0",
-    "ts-node": "^10.9.2",
     "tslib": "^2.7.0",
+    "tsx": "^4.19.3",
     "typedoc": "^0.26.6",
     "typescript": "^5.8.2",
     "typescript-eslint": "=7.18.0",
     "vitest": "^3.1.1"
   },
   "packageManager": "yarn@4.7.0"
-}
+}

package/dist/cjs/src/psychic-application-workers/cache.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.cachePsychicWorkersApplication = cachePsychicWorkersApplication;
-exports.getCachedPsychicWorkersApplication = getCachedPsychicWorkersApplication;
-exports.getCachedPsychicWorkersApplicationOrFail = getCachedPsychicWorkersApplicationOrFail;
-let _psychicWorkersApp = undefined;
-function cachePsychicWorkersApplication(psychicWorkersApp) {
-    _psychicWorkersApp = psychicWorkersApp;
-}
-function getCachedPsychicWorkersApplication() {
-    return _psychicWorkersApp;
-}
-function getCachedPsychicWorkersApplicationOrFail() {
-    if (!_psychicWorkersApp)
-        throw new Error('must call `cachePsychicWorkersApplication` before loading cached psychic application workers');
-    return _psychicWorkersApp;
-}

package/dist/esm/src/psychic-application-workers/cache.js

@@ -1,12 +0,0 @@
-let _psychicWorkersApp = undefined;
-export function cachePsychicWorkersApplication(psychicWorkersApp) {
-    _psychicWorkersApp = psychicWorkersApp;
-}
-export function getCachedPsychicWorkersApplication() {
-    return _psychicWorkersApp;
-}
-export function getCachedPsychicWorkersApplicationOrFail() {
-    if (!_psychicWorkersApp)
-        throw new Error('must call `cachePsychicWorkersApplication` before loading cached psychic application workers');
-    return _psychicWorkersApp;
-}

package/dist/types/src/psychic-application-workers/cache.d.ts

@@ -1,4 +0,0 @@
-import PsychicApplicationWorkers from './index.js';
-export declare function cachePsychicWorkersApplication(psychicWorkersApp: PsychicApplicationWorkers): void;
-export declare function getCachedPsychicWorkersApplication(): PsychicApplicationWorkers | undefined;
-export declare function getCachedPsychicWorkersApplicationOrFail(): PsychicApplicationWorkers;