hierarchical-approval 4.0.2 → 4.0.3

package/dist/nestjs.d.cts

@@ -1,16 +1,16 @@
 import { OnModuleDestroy, DynamicModule, ModuleMetadata, InjectionToken, OptionalFactoryDependency, Inject } from '@nestjs/common';
-import { a as ApprovalEngine, b as ApprovalEngineOptions } from './ApprovalEngine-XgGBQLC_.cjs';
-import './IStorageAdapter-Cjw5zDwQ.cjs';
-import './instance-uUQh5XW3.cjs';
-import './INotificationAdapter-XbD69gss.cjs';
+import { a as ApprovalEngine, b as ApprovalEngineOptions } from './ApprovalEngine-Djdw-JzA.cjs';
+import './IStorageAdapter-D7cy20uD.cjs';
+import './instance-Dd1jQizG.cjs';
+import './INotificationAdapter-CBsJDk-Y.cjs';
 import 'zod';
-import './Logger-BplhlU7l.cjs';
-import './Clock-3FnOczFJ.cjs';
-import './IOperationMiddleware-BBLk8MIz.cjs';
-import './IAuditAdapter-Dt8qjkQL.cjs';
-import './IMetricsAdapter-DWq8IFaf.cjs';
+import './Logger-hqFbBCtB.cjs';
+import './Clock-D8Qp39q_.cjs';
+import './IOperationMiddleware-D3Yelw9R.cjs';
+import './IAuditAdapter-TT2Xhtu6.cjs';
+import './IMetricsAdapter-WROxYSXd.cjs';
 import './ISchedulerAdapter-DKv_QjVN.cjs';
-import './IAuthorizationPolicy-YJ_08Mof.cjs';
+import './IAuthorizationPolicy-D6tTT3gv.cjs';
 
 /** Options for {@link HierarchicalApprovalModule.forRoot}. */
 interface HierarchicalApprovalModuleOptions extends ApprovalEngineOptions {

package/dist/nestjs.d.ts

@@ -1,16 +1,16 @@
 import { OnModuleDestroy, DynamicModule, ModuleMetadata, InjectionToken, OptionalFactoryDependency, Inject } from '@nestjs/common';
-import { a as ApprovalEngine, b as ApprovalEngineOptions } from './ApprovalEngine-Dqe-rC6K.js';
-import './IStorageAdapter-CdXMggPK.js';
-import './instance-uUQh5XW3.js';
-import './INotificationAdapter-BTO9FSKy.js';
+import { a as ApprovalEngine, b as ApprovalEngineOptions } from './ApprovalEngine-BtgQDr_8.js';
+import './IStorageAdapter-CVvNsnnD.js';
+import './instance-Dd1jQizG.js';
+import './INotificationAdapter-BcUskJ6z.js';
 import 'zod';
-import './Logger-BplhlU7l.js';
-import './Clock-3FnOczFJ.js';
-import './IOperationMiddleware-CX7lo4lp.js';
-import './IAuditAdapter-DkbyFFjb.js';
-import './IMetricsAdapter-DWq8IFaf.js';
+import './Logger-hqFbBCtB.js';
+import './Clock-D8Qp39q_.js';
+import './IOperationMiddleware-C7ciNnJp.js';
+import './IAuditAdapter-C-04ar9A.js';
+import './IMetricsAdapter-WROxYSXd.js';
 import './ISchedulerAdapter-DKv_QjVN.js';
-import './IAuthorizationPolicy-eo6glbpE.js';
+import './IAuthorizationPolicy-wIE1mpTy.js';
 
 /** Options for {@link HierarchicalApprovalModule.forRoot}. */
 interface HierarchicalApprovalModuleOptions extends ApprovalEngineOptions {

package/dist/nestjs.js

@@ -551,6 +551,7 @@ var TemplateRegistry = class {
     delete resolved.removeLevels;
     return resolved;
   }
+  /** Register a new template. Throws if a template with this name already exists for the tenant. */
   async define(config) {
     const existing = await this.adapter.getTemplate(this.tenantId, config.name);
     if (existing) {
@@ -587,11 +588,13 @@ var TemplateRegistry = class {
     await this.adapter.saveTemplate(updated);
     return newId;
   }
+  /** Fetch a template by name. Throws if no template with this name exists for the tenant. */
   async get(name) {
     const template = await this.adapter.getTemplate(this.tenantId, name);
     if (!template) throw new ApprovalTemplateNotFoundError(name);
     return template;
   }
+  /** List every template registered for the tenant. */
   async list() {
     return this.adapter.listTemplates(this.tenantId);
   }
@@ -631,6 +634,32 @@ var LevelResolver = class {
     for (const [name, fn] of this.resolvers) target.register(name, fn);
     for (const [name, fn] of this.approverTypes) target.registerApproverType(name, fn);
   }
+  /**
+   * Resolve a level's `approvers` config down to a deduplicated list of user
+   * ids, applying out-of-office cover last so a substitute never sees a stale
+   * approver id.
+   *
+   * @param approvers - The level's approver configs (`user`, `role`,
+   *   `dynamic`, or a custom type registered via {@link registerApproverType}).
+   * @param submittedBy - Passed through to `dynamic` resolvers and custom
+   *   approver-type functions as routing context.
+   * @param data - The instance's document data, passed through the same way.
+   * @param orgProvider - Required to resolve `role` approvers; omit only when
+   *   the template uses no `role` approvers.
+   * @param outOfOffice - Optional cover lookup, consulted after every other
+   *   approver type has resolved.
+   * @param at - The moment out-of-office cover is resolved for. Defaults to
+   *   now.
+   * @param substitutions - Filled with `original -> stand-in` for each
+   *   approver replaced by out-of-office cover, so the caller can carry
+   *   anything keyed by the original id (such as a weighted level's vote
+   *   weight) across to the substitute.
+   * @returns The resolved, deduplicated approver ids (post-substitution).
+   * @throws {ApprovalValidationError} If no approvers resolve at all, a
+   *   `role` approver is configured without an `orgProvider`, a `dynamic`
+   *   approver names a resolver that was never registered, or a custom
+   *   approver type was never registered.
+   */
   async resolveApprovers(approvers, submittedBy, data, orgProvider, outOfOffice, at, substitutions) {
     const resolved = [];
     for (const approver of approvers) {
@@ -1042,7 +1071,7 @@ function evaluateConditions(conditions, data) {
 function assertStatus(instance, expected) {
   if (instance.status !== expected) {
     throw new ApprovalError(
-      `Expected instance status "${expected}" but got "${instance.status}".`,
+      `Instance "${instance.id}": expected status "${expected}" but got "${instance.status}".`,
       "INVALID_STATUS"
     );
   }
@@ -1050,7 +1079,7 @@ function assertStatus(instance, expected) {
 function assertApproverOnLevel(level, approverId) {
   if (!level.approverIds.includes(approverId)) {
     throw new ApprovalForbiddenError(
-      `User "${approverId}" is not an approver for level ${level.level}.`
+      `User "${approverId}" is not an approver for level ${level.level} ("${level.name}").`
     );
   }
 }