@nestjs-pipeline/job-context 0.2.0

package/dist/helpers/principal-reference.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"principal-reference.d.ts","sourceRoot":"","sources":["../../src/helpers/principal-reference.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6CAA6C,CAAC;AAEtF;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,kBAAkB,GAAG,kBAAkB,CAG7E"}

package/dist/helpers/principal-reference.js

@@ -0,0 +1,18 @@
+"use strict";
+/* Copyright (C) 2026-present Aristotelis — see repository license. */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toReference = toReference;
+/**
+ * Copies only the identity fields of `principal`, so grants or session data an
+ * application object also holds never reach a payload or a restore call.
+ *
+ * @example
+ * ```ts
+ * toReference({ id: 'u-1', type: 'user', sid: 's-1', grants: [] }); // { id: 'u-1', type: 'user' }
+ * ```
+ */
+function toReference(principal) {
+    const { id, type, sessionId } = principal;
+    return sessionId === undefined ? { id, type } : { id, type, sessionId };
+}
+//# sourceMappingURL=principal-reference.js.map

package/dist/helpers/principal-reference.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"principal-reference.js","sourceRoot":"","sources":["../../src/helpers/principal-reference.ts"],"names":[],"mappings":";AAAA,sEAAsE;;AAatE,kCAGC;AAZD;;;;;;;;GAQG;AACH,SAAgB,WAAW,CAAC,SAA6B;IACvD,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;IAC1C,OAAO,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;AAC1E,CAAC"}

package/dist/helpers/registration.d.ts

@@ -0,0 +1,39 @@
+import type { JobContextSources } from '../interfaces/context-source.interface';
+import type { IJobPrincipal } from '../interfaces/job-principal.interface';
+/** What `JobContextModule` registers for the decorators, which run outside DI. */
+export interface Registration {
+    readonly principal: IJobPrincipal;
+    readonly tenants: readonly string[];
+    readonly sources: JobContextSources;
+}
+/**
+ * Makes `registration` the one the decorators and `withJobContext` use.
+ *
+ * @example
+ * ```ts
+ * register({ principal, tenants: ['tenant_a'], sources });
+ * ```
+ */
+export declare function register(registration: Registration): void;
+/**
+ * Removes `registration` if it is still the active one, so closing one
+ * application does not remove another's.
+ *
+ * @example
+ * ```ts
+ * unregister(registration);
+ * ```
+ */
+export declare function unregister(registration: Registration): void;
+/**
+ * The active registration.
+ *
+ * @throws {MissingJobContextError} When no `JobContextModule` is running.
+ *
+ * @example
+ * ```ts
+ * const { principal, tenants, sources } = activeRegistration();
+ * ```
+ */
+export declare function activeRegistration(): Registration;
+//# sourceMappingURL=registration.d.ts.map

package/dist/helpers/registration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registration.d.ts","sourceRoot":"","sources":["../../src/helpers/registration.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wCAAwC,CAAC;AAChF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AAE3E,kFAAkF;AAClF,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;IAClC,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC;CACrC;AAID;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAEzD;AAED;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAE3D;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,IAAI,YAAY,CAKjD"}

package/dist/helpers/registration.js

@@ -0,0 +1,49 @@
+"use strict";
+/* Copyright (C) 2026-present Aristotelis — see repository license. */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.register = register;
+exports.unregister = unregister;
+exports.activeRegistration = activeRegistration;
+const missing_job_context_error_1 = require("../errors/missing-job-context.error");
+let active;
+/**
+ * Makes `registration` the one the decorators and `withJobContext` use.
+ *
+ * @example
+ * ```ts
+ * register({ principal, tenants: ['tenant_a'], sources });
+ * ```
+ */
+function register(registration) {
+    active = registration;
+}
+/**
+ * Removes `registration` if it is still the active one, so closing one
+ * application does not remove another's.
+ *
+ * @example
+ * ```ts
+ * unregister(registration);
+ * ```
+ */
+function unregister(registration) {
+    if (active === registration)
+        active = undefined;
+}
+/**
+ * The active registration.
+ *
+ * @throws {MissingJobContextError} When no `JobContextModule` is running.
+ *
+ * @example
+ * ```ts
+ * const { principal, tenants, sources } = activeRegistration();
+ * ```
+ */
+function activeRegistration() {
+    if (active === undefined) {
+        throw new missing_job_context_error_1.MissingJobContextError('a running JobContextModule');
+    }
+    return active;
+}
+//# sourceMappingURL=registration.js.map

package/dist/helpers/registration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registration.js","sourceRoot":"","sources":["../../src/helpers/registration.ts"],"names":[],"mappings":";AAAA,sEAAsE;;AAuBtE,4BAEC;AAWD,gCAEC;AAYD,gDAKC;AArDD,mFAA6E;AAW7E,IAAI,MAAgC,CAAC;AAErC;;;;;;;GAOG;AACH,SAAgB,QAAQ,CAAC,YAA0B;IACjD,MAAM,GAAG,YAAY,CAAC;AACxB,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,UAAU,CAAC,YAA0B;IACnD,IAAI,MAAM,KAAK,YAAY;QAAE,MAAM,GAAG,SAAS,CAAC;AAClD,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,kBAAkB;IAChC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,IAAI,kDAAsB,CAAC,4BAA4B,CAAC,CAAC;IACjE,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/helpers/with-job-context.d.ts

@@ -0,0 +1,21 @@
+import type { WithJobContext } from '../interfaces/job-context.interface';
+/**
+ * Stamps the current execution context onto a job payload: the tenant and
+ * correlation id of the registered sources (a new one from the correlation
+ * source's `create()` when none is active), and the principal the registered `IJobPrincipal`
+ * captures, reduced to its identity. The processor restores it with
+ * `@InJobContext`.
+ *
+ * @param data - The payload. Must be a plain object; a shallow copy is returned.
+ * @returns A copy of `data` with `jobContext` added.
+ * @throws {TypeError} When `data` is not a plain object.
+ * @throws {MissingJobContextError} Without a running `JobContextModule`, a
+ *   current tenant, or a current principal.
+ *
+ * @example
+ * ```ts
+ * await queue.add('send', withJobContext({ userId, email }));
+ * ```
+ */
+export declare function withJobContext<T extends Record<string, unknown>>(data: T): WithJobContext<T>;
+//# sourceMappingURL=with-job-context.d.ts.map

package/dist/helpers/with-job-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"with-job-context.d.ts","sourceRoot":"","sources":["../../src/helpers/with-job-context.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAC;AAI1E;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9D,IAAI,EAAE,CAAC,GACN,cAAc,CAAC,CAAC,CAAC,CAwBnB"}

package/dist/helpers/with-job-context.js

@@ -0,0 +1,49 @@
+"use strict";
+/* Copyright (C) 2026-present Aristotelis — see repository license. */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withJobContext = withJobContext;
+const missing_job_context_error_1 = require("../errors/missing-job-context.error");
+const principal_reference_1 = require("./principal-reference");
+const registration_1 = require("./registration");
+/**
+ * Stamps the current execution context onto a job payload: the tenant and
+ * correlation id of the registered sources (a new one from the correlation
+ * source's `create()` when none is active), and the principal the registered `IJobPrincipal`
+ * captures, reduced to its identity. The processor restores it with
+ * `@InJobContext`.
+ *
+ * @param data - The payload. Must be a plain object; a shallow copy is returned.
+ * @returns A copy of `data` with `jobContext` added.
+ * @throws {TypeError} When `data` is not a plain object.
+ * @throws {MissingJobContextError} Without a running `JobContextModule`, a
+ *   current tenant, or a current principal.
+ *
+ * @example
+ * ```ts
+ * await queue.add('send', withJobContext({ userId, email }));
+ * ```
+ */
+function withJobContext(data) {
+    const prototype = data !== null && typeof data === 'object'
+        ? Object.getPrototypeOf(data)
+        : undefined;
+    if (prototype !== Object.prototype && prototype !== null) {
+        throw new TypeError('withJobContext(data) requires a plain object payload. Wrap arrays and class instances in a plain object first.');
+    }
+    const { principal, sources } = (0, registration_1.activeRegistration)();
+    const tenantId = sources.tenantId.current();
+    if (tenantId === undefined)
+        throw new missing_job_context_error_1.MissingJobContextError('tenant');
+    const captured = principal.capture();
+    if (captured === undefined)
+        throw new missing_job_context_error_1.MissingJobContextError('principal');
+    return {
+        ...data,
+        jobContext: {
+            tenantId,
+            correlationId: sources.correlationId.current() ?? sources.correlationId.create(),
+            principal: (0, principal_reference_1.toReference)(captured),
+        },
+    };
+}
+//# sourceMappingURL=with-job-context.js.map

package/dist/helpers/with-job-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"with-job-context.js","sourceRoot":"","sources":["../../src/helpers/with-job-context.ts"],"names":[],"mappings":";AAAA,sEAAsE;;AAyBtE,wCA0BC;AAjDD,mFAA6E;AAE7E,+DAAoD;AACpD,iDAAoD;AAEpD;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,cAAc,CAC5B,IAAO;IAEP,MAAM,SAAS,GACb,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;QACvC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC;QAC7B,CAAC,CAAC,SAAS,CAAC;IAChB,IAAI,SAAS,KAAK,MAAM,CAAC,SAAS,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;QACzD,MAAM,IAAI,SAAS,CACjB,gHAAgH,CACjH,CAAC;IACJ,CAAC;IACD,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAA,iCAAkB,GAAE,CAAC;IACpD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC5C,IAAI,QAAQ,KAAK,SAAS;QAAE,MAAM,IAAI,kDAAsB,CAAC,QAAQ,CAAC,CAAC;IACvE,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC;IACrC,IAAI,QAAQ,KAAK,SAAS;QAAE,MAAM,IAAI,kDAAsB,CAAC,WAAW,CAAC,CAAC;IAC1E,OAAO;QACL,GAAG,IAAI;QACP,UAAU,EAAE;YACV,QAAQ;YACR,aAAa,EACX,OAAO,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,EAAE;YACnE,SAAS,EAAE,IAAA,iCAAW,EAAC,QAAQ,CAAC;SACjC;KACF,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+export { AsSystem, type AsSystemOptions, } from './decorators/as-system.decorator';
+export { InJobContext, type InJobContextOptions, } from './decorators/in-job-context.decorator';
+export { InvalidJobContextError } from './errors/invalid-job-context.error';
+export { MissingJobContextError } from './errors/missing-job-context.error';
+export { withJobContext } from './helpers/with-job-context';
+export type { ContextSource, CorrelationSource, JobContextSources, } from './interfaces/context-source.interface';
+export type { JobContext, WithJobContext, } from './interfaces/job-context.interface';
+export type { JobContextOptions } from './interfaces/job-context-options.interface';
+export type { IJobPrincipal } from './interfaces/job-principal.interface';
+export type { PrincipalReference } from './interfaces/principal-reference.interface';
+export { JobContextModule } from './job-context.module';
+//# 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":"AAEA,OAAO,EACL,QAAQ,EACR,KAAK,eAAe,GACrB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,YAAY,EACZ,KAAK,mBAAmB,GACzB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,YAAY,EACV,aAAa,EACb,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,uCAAuC,CAAC;AAC/C,YAAY,EACV,UAAU,EACV,cAAc,GACf,MAAM,oCAAoC,CAAC;AAC5C,YAAY,EAAE,iBAAiB,EAAE,MAAM,4CAA4C,CAAC;AACpF,YAAY,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AAC1E,YAAY,EAAE,kBAAkB,EAAE,MAAM,4CAA4C,CAAC;AACrF,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+/* Copyright (C) 2026-present Aristotelis — see repository license. */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobContextModule = exports.withJobContext = exports.MissingJobContextError = exports.InvalidJobContextError = exports.InJobContext = exports.AsSystem = void 0;
+var as_system_decorator_1 = require("./decorators/as-system.decorator");
+Object.defineProperty(exports, "AsSystem", { enumerable: true, get: function () { return as_system_decorator_1.AsSystem; } });
+var in_job_context_decorator_1 = require("./decorators/in-job-context.decorator");
+Object.defineProperty(exports, "InJobContext", { enumerable: true, get: function () { return in_job_context_decorator_1.InJobContext; } });
+var invalid_job_context_error_1 = require("./errors/invalid-job-context.error");
+Object.defineProperty(exports, "InvalidJobContextError", { enumerable: true, get: function () { return invalid_job_context_error_1.InvalidJobContextError; } });
+var missing_job_context_error_1 = require("./errors/missing-job-context.error");
+Object.defineProperty(exports, "MissingJobContextError", { enumerable: true, get: function () { return missing_job_context_error_1.MissingJobContextError; } });
+var with_job_context_1 = require("./helpers/with-job-context");
+Object.defineProperty(exports, "withJobContext", { enumerable: true, get: function () { return with_job_context_1.withJobContext; } });
+var job_context_module_1 = require("./job-context.module");
+Object.defineProperty(exports, "JobContextModule", { enumerable: true, get: function () { return job_context_module_1.JobContextModule; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,sEAAsE;;;AAEtE,wEAG0C;AAFxC,+GAAA,QAAQ,OAAA;AAGV,kFAG+C;AAF7C,wHAAA,YAAY,OAAA;AAGd,gFAA4E;AAAnE,mIAAA,sBAAsB,OAAA;AAC/B,gFAA4E;AAAnE,mIAAA,sBAAsB,OAAA;AAC/B,+DAA4D;AAAnD,kHAAA,cAAc,OAAA;AAavB,2DAAwD;AAA/C,sHAAA,gBAAgB,OAAA"}

package/dist/interfaces/context-source.interface.d.ts

@@ -0,0 +1,23 @@
+/**
+ * A value kept for the current execution by the package that owns it, such as
+ * `tenantSource` of `@nestjs-pipeline/tenant`.
+ */
+export interface ContextSource {
+    /** The value of the current execution, or `undefined` for none. */
+    current(): string | undefined;
+    /** Runs `fn` with `value` as the current value for everything it calls. */
+    run<T>(value: string | undefined, fn: () => T): T;
+}
+/** A correlation id source that also makes new ids and judges ids received from outside. */
+export interface CorrelationSource extends ContextSource {
+    /** A new correlation id. */
+    create(): string;
+    /** Whether `id`, read from a job payload, is a well-formed correlation id. */
+    accepts(id: string): boolean;
+}
+/** The tenant and correlation id a job carries and restores. */
+export interface JobContextSources {
+    readonly tenantId: ContextSource;
+    readonly correlationId: CorrelationSource;
+}
+//# sourceMappingURL=context-source.interface.d.ts.map

package/dist/interfaces/context-source.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context-source.interface.d.ts","sourceRoot":"","sources":["../../src/interfaces/context-source.interface.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,mEAAmE;IACnE,OAAO,IAAI,MAAM,GAAG,SAAS,CAAC;IAC9B,2EAA2E;IAC3E,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;CACnD;AAED,4FAA4F;AAC5F,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACtD,4BAA4B;IAC5B,MAAM,IAAI,MAAM,CAAC;IACjB,8EAA8E;IAC9E,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC;CAC9B;AAED,gEAAgE;AAChE,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IACjC,QAAQ,CAAC,aAAa,EAAE,iBAAiB,CAAC;CAC3C"}

package/dist/interfaces/context-source.interface.js

@@ -0,0 +1,4 @@
+"use strict";
+/* Copyright (C) 2026-present Aristotelis — see repository license. */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=context-source.interface.js.map

package/dist/interfaces/context-source.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context-source.interface.js","sourceRoot":"","sources":["../../src/interfaces/context-source.interface.ts"],"names":[],"mappings":";AAAA,sEAAsE"}

package/dist/interfaces/job-context-options.interface.d.ts

@@ -0,0 +1,22 @@
+import type { ModuleMetadata, Type } from '@nestjs/common';
+import type { JobContextSources } from './context-source.interface';
+import type { IJobPrincipal } from './job-principal.interface';
+/** Options of `JobContextModule.forRoot`. */
+export interface JobContextOptions {
+    /** The application's principal port, instantiated through dependency injection. */
+    principal: Type<IJobPrincipal>;
+    /**
+     * Tenants a job may run in. A payload naming another tenant is refused, and
+     * `@AsSystem` work runs once per tenant, in this order. Must not be empty.
+     */
+    tenants: readonly string[];
+    /**
+     * Where the tenant and correlation id are read when a job is enqueued and
+     * restored when it runs, such as `tenantSource` of `@nestjs-pipeline/tenant`
+     * and `correlationSource` of `@nestjs-pipeline/correlation`.
+     */
+    sources: JobContextSources;
+    /** Modules that export the dependencies of `principal`. */
+    imports?: ModuleMetadata['imports'];
+}
+//# sourceMappingURL=job-context-options.interface.d.ts.map

package/dist/interfaces/job-context-options.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"job-context-options.interface.d.ts","sourceRoot":"","sources":["../../src/interfaces/job-context-options.interface.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE/D,6CAA6C;AAC7C,MAAM,WAAW,iBAAiB;IAChC,mFAAmF;IACnF,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IAC/B;;;OAGG;IACH,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B;;;;OAIG;IACH,OAAO,EAAE,iBAAiB,CAAC;IAC3B,2DAA2D;IAC3D,OAAO,CAAC,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC;CACrC"}

package/dist/interfaces/job-context-options.interface.js

@@ -0,0 +1,4 @@
+"use strict";
+/* Copyright (C) 2026-present Aristotelis — see repository license. */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=job-context-options.interface.js.map

package/dist/interfaces/job-context-options.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"job-context-options.interface.js","sourceRoot":"","sources":["../../src/interfaces/job-context-options.interface.ts"],"names":[],"mappings":";AAAA,sEAAsE"}

package/dist/interfaces/job-context.interface.d.ts

@@ -0,0 +1,12 @@
+import type { PrincipalReference } from './principal-reference.interface';
+/** Execution context a job payload carries from the request that enqueued it. */
+export interface JobContext {
+    readonly tenantId: string;
+    readonly correlationId: string;
+    readonly principal: PrincipalReference;
+}
+/** A job payload stamped by `withJobContext`. */
+export type WithJobContext<T extends Record<string, unknown>> = T & {
+    jobContext: JobContext;
+};
+//# sourceMappingURL=job-context.interface.d.ts.map

package/dist/interfaces/job-context.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"job-context.interface.d.ts","sourceRoot":"","sources":["../../src/interfaces/job-context.interface.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAE1E,iFAAiF;AACjF,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC;CACxC;AAED,iDAAiD;AACjD,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG;IAClE,UAAU,EAAE,UAAU,CAAC;CACxB,CAAC"}

package/dist/interfaces/job-context.interface.js

@@ -0,0 +1,4 @@
+"use strict";
+/* Copyright (C) 2026-present Aristotelis — see repository license. */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=job-context.interface.js.map

package/dist/interfaces/job-context.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"job-context.interface.js","sourceRoot":"","sources":["../../src/interfaces/job-context.interface.ts"],"names":[],"mappings":";AAAA,sEAAsE"}

package/dist/interfaces/job-principal.interface.d.ts

@@ -0,0 +1,28 @@
+import type { PrincipalReference } from './principal-reference.interface';
+/**
+ * Application port that reads the current principal when a job is enqueued and
+ * binds it again when the job runs. The application implements it over its own
+ * authentication state; register the implementation with
+ * `JobContextModule.forRoot`.
+ *
+ * @typeParam TGrant - The application's grant type, as declared in `@AsSystem`.
+ */
+export interface IJobPrincipal<TGrant = unknown> {
+    /**
+     * The principal of the current execution, or `undefined` when there is none.
+     * Only `id`, `type` and `sessionId` of the result are kept.
+     */
+    capture(): PrincipalReference | undefined;
+    /**
+     * Re-checks `principal` against current state and runs `work` with it as the
+     * current principal. It runs inside the job's tenant and correlation id.
+     * Throw to refuse the job, for example for a revoked session or a deleted
+     * principal; the job then fails without running.
+     *
+     * @param grants - Set only for `@AsSystem` work: the complete grants its code
+     *   declares. For a job payload it is `undefined`, and the principal's
+     *   authorization must be resolved from current state.
+     */
+    restore<T>(principal: PrincipalReference, work: () => Promise<T>, grants?: readonly TGrant[]): Promise<T>;
+}
+//# sourceMappingURL=job-principal.interface.d.ts.map

package/dist/interfaces/job-principal.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"job-principal.interface.d.ts","sourceRoot":"","sources":["../../src/interfaces/job-principal.interface.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAE1E;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa,CAAC,MAAM,GAAG,OAAO;IAC7C;;;OAGG;IACH,OAAO,IAAI,kBAAkB,GAAG,SAAS,CAAC;IAE1C;;;;;;;;;OASG;IACH,OAAO,CAAC,CAAC,EACP,SAAS,EAAE,kBAAkB,EAC7B,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACtB,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,GACzB,OAAO,CAAC,CAAC,CAAC,CAAC;CACf"}

package/dist/interfaces/job-principal.interface.js

@@ -0,0 +1,4 @@
+"use strict";
+/* Copyright (C) 2026-present Aristotelis — see repository license. */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=job-principal.interface.js.map

package/dist/interfaces/job-principal.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"job-principal.interface.js","sourceRoot":"","sources":["../../src/interfaces/job-principal.interface.ts"],"names":[],"mappings":";AAAA,sEAAsE"}

package/dist/interfaces/principal-reference.interface.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Identity of the principal a job acts for. It carries no grants: what the
+ * principal may do is resolved again when the job runs.
+ */
+export interface PrincipalReference {
+    readonly id: string;
+    /** Application-defined classification, such as `'user'` or `'service'`. */
+    readonly type: string;
+    /** Login session the principal authenticated with; absent when it has none. */
+    readonly sessionId?: string;
+}
+//# sourceMappingURL=principal-reference.interface.d.ts.map

package/dist/interfaces/principal-reference.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"principal-reference.interface.d.ts","sourceRoot":"","sources":["../../src/interfaces/principal-reference.interface.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,2EAA2E;IAC3E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,+EAA+E;IAC/E,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B"}

package/dist/interfaces/principal-reference.interface.js

@@ -0,0 +1,4 @@
+"use strict";
+/* Copyright (C) 2026-present Aristotelis — see repository license. */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=principal-reference.interface.js.map

package/dist/interfaces/principal-reference.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"principal-reference.interface.js","sourceRoot":"","sources":["../../src/interfaces/principal-reference.interface.ts"],"names":[],"mappings":";AAAA,sEAAsE"}

package/dist/job-context.module.d.ts

@@ -0,0 +1,42 @@
+import { type DynamicModule } from '@nestjs/common';
+import type { JobContextOptions } from './interfaces/job-context-options.interface';
+/**
+ * Connects `withJobContext`, `@InJobContext` and `@AsSystem` to the
+ * application's principal port, tenant list, and tenant and correlation id
+ * sources. The decorators wrap methods
+ * outside dependency injection, so they read the registration of the running
+ * module; with none they fail closed. One application registers it once.
+ *
+ * @example
+ * ```ts
+ * @Module({
+ *   imports: [
+ *     JobContextModule.forRoot({
+ *       principal: SessionJobPrincipal,
+ *       tenants: ['tenant_a', 'tenant_b'],
+ *       sources: { tenantId: tenantSource, correlationId: correlationSource },
+ *       imports: [AuthsModule],
+ *     }),
+ *   ],
+ * })
+ * export class JobsModule {}
+ * ```
+ */
+export declare class JobContextModule {
+    /**
+     * Builds the module for `options`.
+     *
+     * @throws {TypeError} When `options.tenants` is empty.
+     *
+     * @example
+     * ```ts
+     * JobContextModule.forRoot({
+     *   principal: SessionJobPrincipal,
+     *   tenants: ['tenant_a'],
+     *   sources: { tenantId: tenantSource, correlationId: correlationSource },
+     * });
+     * ```
+     */
+    static forRoot(options: JobContextOptions): DynamicModule;
+}
+//# sourceMappingURL=job-context.module.d.ts.map

package/dist/job-context.module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"job-context.module.d.ts","sourceRoot":"","sources":["../src/job-context.module.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,aAAa,EAKnB,MAAM,gBAAgB,CAAC;AAYxB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4CAA4C,CAAC;AAyBpF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBACa,gBAAgB;IAC3B;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,iBAAiB,GAAG,aAAa;CAe1D"}

package/dist/job-context.module.js

@@ -0,0 +1,99 @@
+"use strict";
+/* Copyright (C) 2026-present Aristotelis — see repository license. */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var JobContextModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobContextModule = void 0;
+const common_1 = require("@nestjs/common");
+const job_context_constants_1 = require("./constants/job-context.constants");
+const registration_1 = require("./helpers/registration");
+/**
+ * Registers the principal port, tenants and sources when it is constructed, before any
+ * lifecycle hook can start a worker, and removes them at shutdown.
+ */
+let JobContextRegistration = class JobContextRegistration {
+    registration;
+    constructor(principal, tenants, sources) {
+        this.registration = { principal, tenants, sources };
+        (0, registration_1.register)(this.registration);
+    }
+    onApplicationShutdown() {
+        (0, registration_1.unregister)(this.registration);
+    }
+};
+JobContextRegistration = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, common_1.Inject)(job_context_constants_1.JOB_PRINCIPAL)),
+    __param(1, (0, common_1.Inject)(job_context_constants_1.JOB_TENANTS)),
+    __param(2, (0, common_1.Inject)(job_context_constants_1.JOB_SOURCES)),
+    __metadata("design:paramtypes", [Object, Array, Object])
+], JobContextRegistration);
+/**
+ * Connects `withJobContext`, `@InJobContext` and `@AsSystem` to the
+ * application's principal port, tenant list, and tenant and correlation id
+ * sources. The decorators wrap methods
+ * outside dependency injection, so they read the registration of the running
+ * module; with none they fail closed. One application registers it once.
+ *
+ * @example
+ * ```ts
+ * @Module({
+ *   imports: [
+ *     JobContextModule.forRoot({
+ *       principal: SessionJobPrincipal,
+ *       tenants: ['tenant_a', 'tenant_b'],
+ *       sources: { tenantId: tenantSource, correlationId: correlationSource },
+ *       imports: [AuthsModule],
+ *     }),
+ *   ],
+ * })
+ * export class JobsModule {}
+ * ```
+ */
+let JobContextModule = JobContextModule_1 = class JobContextModule {
+    /**
+     * Builds the module for `options`.
+     *
+     * @throws {TypeError} When `options.tenants` is empty.
+     *
+     * @example
+     * ```ts
+     * JobContextModule.forRoot({
+     *   principal: SessionJobPrincipal,
+     *   tenants: ['tenant_a'],
+     *   sources: { tenantId: tenantSource, correlationId: correlationSource },
+     * });
+     * ```
+     */
+    static forRoot(options) {
+        if (options.tenants.length === 0) {
+            throw new TypeError('JobContextModule needs at least one tenant.');
+        }
+        return {
+            module: JobContextModule_1,
+            imports: options.imports ?? [],
+            providers: [
+                { provide: job_context_constants_1.JOB_PRINCIPAL, useClass: options.principal },
+                { provide: job_context_constants_1.JOB_TENANTS, useValue: [...options.tenants] },
+                { provide: job_context_constants_1.JOB_SOURCES, useValue: options.sources },
+                JobContextRegistration,
+            ],
+        };
+    }
+};
+exports.JobContextModule = JobContextModule;
+exports.JobContextModule = JobContextModule = JobContextModule_1 = __decorate([
+    (0, common_1.Module)({})
+], JobContextModule);
+//# sourceMappingURL=job-context.module.js.map

package/dist/job-context.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"job-context.module.js","sourceRoot":"","sources":["../src/job-context.module.ts"],"names":[],"mappings":";AAAA,sEAAsE;;;;;;;;;;;;;;;;AAEtE,2CAMwB;AACxB,6EAI2C;AAC3C,yDAIgC;AAKhC;;;GAGG;AACH,IACM,sBAAsB,GAD5B,MACM,sBAAsB;IACT,YAAY,CAAe;IAE5C,YACyB,SAAwB,EAC1B,OAA0B,EAC1B,OAA0B;QAE/C,IAAI,CAAC,YAAY,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;QACpD,IAAA,uBAAQ,EAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC9B,CAAC;IAED,qBAAqB;QACnB,IAAA,yBAAU,EAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAChC,CAAC;CACF,CAAA;AAfK,sBAAsB;IAD3B,IAAA,mBAAU,GAAE;IAKR,WAAA,IAAA,eAAM,EAAC,qCAAa,CAAC,CAAA;IACrB,WAAA,IAAA,eAAM,EAAC,mCAAW,CAAC,CAAA;IACnB,WAAA,IAAA,eAAM,EAAC,mCAAW,CAAC,CAAA;;GANlB,sBAAsB,CAe3B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEI,IAAM,gBAAgB,wBAAtB,MAAM,gBAAgB;IAC3B;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,OAAO,CAAC,OAA0B;QACvC,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAC;QACrE,CAAC;QACD,OAAO;YACL,MAAM,EAAE,kBAAgB;YACxB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE;YAC9B,SAAS,EAAE;gBACT,EAAE,OAAO,EAAE,qCAAa,EAAE,QAAQ,EAAE,OAAO,CAAC,SAAS,EAAE;gBACvD,EAAE,OAAO,EAAE,mCAAW,EAAE,QAAQ,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,EAAE;gBACxD,EAAE,OAAO,EAAE,mCAAW,EAAE,QAAQ,EAAE,OAAO,CAAC,OAAO,EAAE;gBACnD,sBAAsB;aACvB;SACF,CAAC;IACJ,CAAC;CACF,CAAA;AA9BY,4CAAgB;2BAAhB,gBAAgB;IAD5B,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,gBAAgB,CA8B5B"}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@nestjs-pipeline/job-context",
+  "version": "0.2.0",
+  "description": "Carries the tenant, correlation id and principal of a request into the queue jobs it enqueues, and gives system-started work an explicit context",
+  "author": "Aristotelis",
+  "license": "SEE LICENSE IN LICENSE",
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aristoteliss/nestjs-pipeline.git",
+    "directory": "packages/pipeline-job-context"
+  },
+  "homepage": "https://github.com/aristoteliss/nestjs-pipeline/tree/master/packages/pipeline-job-context#readme",
+  "bugs": {
+    "url": "https://github.com/aristoteliss/nestjs-pipeline/issues"
+  },
+  "keywords": [
+    "nestjs",
+    "cqrs",
+    "pipeline",
+    "multi-tenancy",
+    "queue",
+    "jobs",
+    "authorization",
+    "correlation-id"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "LICENSE",
+    "COMMERCIAL_LICENSE.txt"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^11.0.0"
+  },
+  "devDependencies": {
+    "@nestjs/common": "^11.2.6",
+    "@vitest/coverage-v8": "^4.1.11",
+    "reflect-metadata": "^0.2.2",
+    "vitest": "^4.1.11"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "build:watch": "tsc -p tsconfig.build.json --watch",
+    "clean": "rm -rf dist tsconfig.tsbuildinfo",
+    "rebuild": "pnpm run clean && pnpm run build",
+    "lint": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}