@dynamatix/gb-schemas 2.17.12 → 2.17.13

package/dist/shared/workflow.middleware.js

@@ -0,0 +1,246 @@
+import WorkflowTriggerModel from './workflow-trigger.model.js';
+import { WorkflowService } from './workflow.service.js';
+// @ts-ignore - No type declarations available for @dynamatix/cat-shared/services
+import { getContext as getSharedContext } from '@dynamatix/cat-shared/services';
+import { workflowLog, workflowWarn, workflowError } from './workflow.logger.js';
+export class WorkflowMiddleware {
+    constructor(options) {
+        // Read configuration from environment variables with fallbacks
+        this.options = {
+            workflowApiUrl: process.env.WORKFLOW_API_URL || 'https://your-workflow-api.com/api/v1/workflows/execute',
+            timeout: parseInt(process.env.WORKFLOW_TIMEOUT || '30000'),
+            retryAttempts: parseInt(process.env.WORKFLOW_RETRY_ATTEMPTS || '3'),
+            retryDelay: parseInt(process.env.WORKFLOW_RETRY_DELAY || '1000'),
+            ...options // Allow override of specific options
+        };
+        this.workflowService = new WorkflowService(this.options);
+    }
+    /**
+     * Safely gets the WorkflowTrigger model, handling potential registration issues
+     */
+    getWorkflowTriggerModel() {
+        try {
+            return WorkflowTriggerModel;
+        }
+        catch (error) {
+            workflowError('Error accessing WorkflowTrigger model:', error);
+            throw new Error('WorkflowTrigger model is not properly registered');
+        }
+    }
+    /**
+     * Gets the current request context including application_id and token
+     * @returns The current context object or null if not available
+     */
+    getContext() {
+        const context = getSharedContext();
+        if (context) {
+            return {
+                contextId: context.contextId,
+                token: context.token
+            };
+        }
+        return null;
+    }
+    /**
+     * Creates a Mongoose middleware function for a specific model
+     * @param recordType - The type of record (e.g., 'applications', 'products', 'tasks')
+     * @returns Mongoose middleware function
+     */
+    createMiddleware(recordType) {
+        return {
+            // Post-save middleware for create and update operations
+            postSave: async function (doc, next) {
+                try {
+                    workflowLog('Post-save middleware for create and update operations');
+                    const middleware = new WorkflowMiddleware(this.options || {});
+                    await middleware.handleEvent({
+                        recordType,
+                        action: doc.isNew ? 'created' : 'updated',
+                        triggerKey: `${recordType}.${doc.isNew ? 'created' : 'updated'}`
+                    }, doc);
+                }
+                catch (error) {
+                    workflowError('Workflow middleware error:', error);
+                    // Don't throw error to avoid breaking the main operation
+                }
+                next();
+            }.bind(this),
+            // Post-remove middleware for delete operations
+            postRemove: async function (doc, next) {
+                try {
+                    workflowLog('Post-remove middleware for delete operations');
+                    const middleware = new WorkflowMiddleware(this.options || {});
+                    await middleware.handleEvent({
+                        recordType,
+                        action: 'deleted',
+                        triggerKey: `${recordType}.deleted`
+                    }, doc);
+                }
+                catch (error) {
+                    workflowError('Workflow middleware error:', error);
+                    // Don't throw error to avoid breaking the main operation
+                }
+                next();
+            }.bind(this)
+        };
+    }
+    /**
+     * Handles a workflow trigger event
+     * @param event - The workflow trigger event
+     * @param document - The document that triggered the event
+     */
+    async handleEvent(event, document) {
+        try {
+            // Find active triggers for this event
+            workflowLog('Finding active triggers for this event');
+            const WorkflowTrigger = this.getWorkflowTriggerModel();
+            const triggers = await WorkflowTrigger.find({
+                triggerKey: event.triggerKey,
+                isActive: true
+            });
+            if (triggers.length === 0) {
+                workflowLog(`No active triggers found for ${event.triggerKey}`);
+                return;
+            }
+            // Process each trigger
+            workflowLog('Processing each trigger');
+            for (const trigger of triggers) {
+                await this.processTrigger(trigger, document, event);
+            }
+        }
+        catch (error) {
+            workflowError(`Error handling workflow event ${event.triggerKey}:`, error);
+        }
+    }
+    /**
+     * Processes a single workflow trigger
+     * @param trigger - The workflow trigger configuration
+     * @param document - The document that triggered the event
+     * @param event - The workflow trigger event
+     */
+    async processTrigger(trigger, document, event) {
+        try {
+            workflowLog('Processing trigger');
+            // Check if condition is met (if specified)
+            if (trigger.condition && !this.evaluateCondition(trigger.condition, document)) {
+                workflowLog(`Condition not met for trigger ${trigger.triggerKey}`);
+                return;
+            }
+            // Extract variables from document
+            workflowLog('Extracting variables from document');
+            workflowLog(`   Required variables: ${JSON.stringify(trigger.requiredVariables)}`);
+            workflowLog(`   Optional variables: ${JSON.stringify(trigger.optionalVariables || [])}`);
+            const variables = this.workflowService.extractVariables(trigger.requiredVariables, trigger.optionalVariables || [], document);
+            workflowLog(`   Extracted variables: ${JSON.stringify(variables, null, 2)}`);
+            // Validate required variables
+            if (!this.workflowService.validateRequiredVariables(trigger.requiredVariables, variables)) {
+                workflowWarn(`❌ Required variables missing for trigger ${trigger.triggerKey}`);
+                workflowWarn(`   Required: ${JSON.stringify(trigger.requiredVariables)}`);
+                workflowWarn(`   Got: ${JSON.stringify(variables)}`);
+                return;
+            }
+            // Add metadata
+            const metadata = this.extractMetadata(document, event, trigger.parentKey);
+            workflowLog(`   Metadata: ${JSON.stringify(metadata, null, 2)}`);
+            const enrichedVariables = {
+                ...variables,
+                ...metadata
+            };
+            // Create workflow payload
+            const payload = {
+                workflowKey: trigger.workflowKey,
+                version: 1, // Default version, could be made configurable
+                variables: enrichedVariables
+            };
+            workflowLog('📦 Workflow payload:', JSON.stringify(payload, null, 2));
+            // Get token from context
+            const context = this.getContext();
+            const token = context?.token;
+            // Trigger workflow in background
+            await this.workflowService.triggerWorkflow(payload, token);
+            workflowLog(`Workflow ${trigger.workflowKey} triggered for ${event.triggerKey}`);
+        }
+        catch (error) {
+            workflowError(`Error processing trigger ${trigger.triggerKey}:`, error);
+        }
+    }
+    /**
+     * Evaluates a condition against a document
+     * @param condition - The condition string to evaluate
+     * @param document - The document to evaluate against
+     * @returns true if condition is met
+     */
+    evaluateCondition(condition, document) {
+        try {
+            // Simple condition evaluation - could be enhanced with a proper expression parser
+            // For now, supporting basic field checks like "status === 'active'"
+            if (condition.includes('===')) {
+                const [field, value] = condition.split('===').map(s => s.trim());
+                const fieldValue = this.workflowService['getNestedValue'](document, field);
+                return fieldValue === value.replace(/['"]/g, '');
+            }
+            // Default to true if condition format is not recognized
+            return true;
+        }
+        catch (error) {
+            workflowError('Error evaluating condition:', error);
+            return false;
+        }
+    }
+    /**
+     * Extracts metadata from document and event
+     * @param document - The document
+     * @param event - The event
+     * @returns Metadata object
+     */
+    extractMetadata(document, event, parentKey) {
+        const context = this.getContext();
+        return {
+            source: event.recordType,
+            action: event.action,
+            triggerKey: event.triggerKey,
+            sourceId: document._id?.toString(),
+            parentSourceId: parentKey ? document[parentKey] : null,
+            timestamp: new Date().toISOString(),
+            contextId: context?.contextId,
+        };
+    }
+    /**
+     * Manually trigger a workflow for a specific document
+     * @param triggerKey - The trigger key to use
+     * @param document - The document to process
+     * @param recordType - The record type
+     */
+    async manualTrigger(triggerKey, document, recordType) {
+        const event = {
+            recordType,
+            action: 'manual',
+            triggerKey
+        };
+        await this.handleEvent(event, document);
+    }
+}
+/**
+ * Factory function to create workflow middleware for a model
+ * @param recordType - The type of record (e.g., 'applications', 'products', 'tasks')
+ * @param options - Optional workflow middleware options (overrides env vars)
+ * @returns Mongoose middleware functions
+ */
+export function createWorkflowMiddleware(recordType, options) {
+    const middleware = new WorkflowMiddleware(options);
+    return middleware.createMiddleware(recordType);
+}
+/**
+ * Utility function to apply workflow middleware to a Mongoose schema
+ * @param schema - The Mongoose schema
+ * @param recordType - The type of record
+ * @param options - Optional workflow middleware options (overrides env vars)
+ */
+export function applyWorkflowMiddleware(schema, recordType, options) {
+    const middleware = createWorkflowMiddleware(recordType, options);
+    // Apply post-save middleware
+    schema.post('save', middleware.postSave);
+    // Apply post-remove middleware
+    schema.post(/^delete/, middleware.postRemove);
+    schema.post('findOneAndDelete', middleware.postRemove);
+}

package/dist/shared/workflow.plugin.d.ts

@@ -0,0 +1,46 @@
+/// <reference path="../value-objects/pound.d.ts" />
+/// <reference path="../value-objects/account-number.d.ts" />
+/// <reference path="../value-objects/sort-code.d.ts" />
+/// <reference types="mongoose/types/aggregate.js" />
+/// <reference types="mongoose/types/callback.js" />
+/// <reference types="mongoose/types/collection.js" />
+/// <reference types="mongoose/types/connection.js" />
+/// <reference types="mongoose/types/cursor.js" />
+/// <reference types="mongoose/types/document.js" />
+/// <reference types="mongoose/types/error.js" />
+/// <reference types="mongoose/types/expressions.js" />
+/// <reference types="mongoose/types/helpers.js" />
+/// <reference types="mongoose/types/middlewares.js" />
+/// <reference types="mongoose/types/indexes.js" />
+/// <reference types="mongoose/types/models.js" />
+/// <reference types="mongoose/types/mongooseoptions.js" />
+/// <reference types="mongoose/types/pipelinestage.js" />
+/// <reference types="mongoose/types/populate.js" />
+/// <reference types="mongoose/types/query.js" />
+/// <reference types="mongoose/types/schemaoptions.js" />
+/// <reference types="mongoose/types/session.js" />
+/// <reference types="mongoose/types/types.js" />
+/// <reference types="mongoose/types/utility.js" />
+/// <reference types="mongoose/types/validation.js" />
+/// <reference types="mongoose/types/virtuals.js" />
+/// <reference types="mongoose/types/schematypes.js" />
+/// <reference types="mongoose/types/inferschematype.js" />
+/// <reference types="mongoose/types/inferrawdoctype.js" />
+import mongoose from 'mongoose';
+/**
+ * Workflow plugin that automatically applies workflow middleware to schemas
+ * This plugin reads the record type from schema options and applies the appropriate middleware
+ */
+export declare function workflowPlugin(schema: mongoose.Schema, options: any): void;
+/**
+ * Utility function to register the workflow plugin globally
+ * This will apply workflow middleware to all schemas automatically
+ */
+export declare function registerWorkflowPlugin(): void;
+/**
+ * Utility function to apply workflow plugin to a specific schema with custom record type
+ * @param schema - The Mongoose schema
+ * @param recordType - The record type (e.g., 'applications', 'applicants')
+ */
+export declare function applyWorkflowPlugin(schema: mongoose.Schema, recordType: string): void;
+//# sourceMappingURL=workflow.plugin.d.ts.map

package/dist/shared/workflow.plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow.plugin.d.ts","sourceRoot":"","sources":["../../shared/workflow.plugin.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAIhC;;;GAGG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,QAyInE;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,SAGrC;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,QAE9E"}

package/dist/shared/workflow.plugin.js

@@ -0,0 +1,151 @@
+import mongoose from 'mongoose';
+import { WorkflowMiddleware } from './workflow.middleware.js';
+import { workflowLog, workflowError } from './workflow.logger.js';
+/**
+ * Workflow plugin that automatically applies workflow middleware to schemas
+ * This plugin reads the record type from schema options and applies the appropriate middleware
+ */
+export function workflowPlugin(schema, options) {
+    // For global plugins, we'll determine the record type when the middleware is triggered
+    // by looking at the document's constructor name
+    workflowLog(`🔌 Workflow plugin applied to schema`);
+    // Create workflow middleware instance
+    const middleware = new WorkflowMiddleware();
+    // Apply post-save middleware
+    schema.post('save', async function (doc, next) {
+        // Determine record type from document constructor name
+        const recordType = doc.constructor.modelName?.toLowerCase() || 'unknown';
+        workflowLog(`💾 Post-save middleware triggered for ${recordType}`);
+        workflowLog(`   Document ID: ${doc._id}`);
+        workflowLog(`   Is new: ${doc.isNew}`);
+        workflowLog(`   Trigger key: ${recordType}.${doc.isNew ? 'created' : 'updated'}`);
+        try {
+            await middleware.handleEvent({
+                recordType,
+                action: doc.isNew ? 'created' : 'updated',
+                triggerKey: `${recordType}.${doc.isNew ? 'created' : 'updated'}`
+            }, doc);
+        }
+        catch (error) {
+            workflowError('Workflow middleware error:', error);
+            // Don't throw error to avoid breaking the main operation
+        }
+        next();
+    });
+    // Apply post-findOneAndUpdate middleware
+    schema.post('findOneAndUpdate', async function (doc, next) {
+        const recordType = doc.constructor.modelName?.toLowerCase() || 'unknown';
+        workflowLog(`🔄 Post-findOneAndUpdate middleware triggered for ${recordType}`);
+        workflowLog(`   Document ID: ${doc._id}`);
+        workflowLog(`   Trigger key: ${recordType}.updated`);
+        try {
+            await middleware.handleEvent({
+                recordType,
+                action: 'updated',
+                triggerKey: `${recordType}.updated`
+            }, doc);
+        }
+        catch (error) {
+            workflowError('Workflow middleware error:', error);
+            // Don't throw error to avoid breaking the main operation
+        }
+        next();
+    });
+    // Apply post-remove middleware
+    schema.post(/^delete/, async function (result, next) {
+        // Try multiple methods to get model name since context differs in delete hooks
+        // For query hooks (model.deleteOne or doc.deleteOne), 'this' is the query
+        let recordType = 'unknown';
+        // Try from query context first (most reliable for deleteOne hooks)
+        // When doc.deleteOne() is called, 'this' refers to the query object
+        if (this?.model?.modelName) {
+            recordType = this.model.modelName.toLowerCase();
+        }
+        // Try from schema modelName
+        else if (schema?.modelName) {
+            recordType = schema.modelName.toLowerCase();
+        }
+        // Try from collection name as fallback
+        else if (this?.model?.collection?.name) {
+            recordType = this.model.collection.name.toLowerCase();
+        }
+        // Try from result if it's a document
+        else if (result?.constructor?.modelName) {
+            recordType = result.constructor.modelName.toLowerCase();
+        }
+        workflowLog(`🗑️  Post-delete middleware triggered for ${recordType}`);
+        try {
+            await middleware.handleEvent({
+                recordType,
+                action: 'deleted',
+                triggerKey: `${recordType}.deleted`
+            }, result);
+        }
+        catch (error) {
+            workflowError('Workflow middleware error:', error);
+            // Don't throw error to avoid breaking the main operation
+        }
+        next();
+    });
+    schema.post('findOneAndDelete', async function (doc, next) {
+        const recordType = doc.constructor.modelName?.toLowerCase() || 'unknown';
+        workflowLog(`🗑️  Post-findOneAndDelete middleware triggered for ${recordType}`);
+        try {
+            await middleware.handleEvent({
+                recordType,
+                action: 'deleted',
+                triggerKey: `${recordType}.deleted`
+            }, doc);
+        }
+        catch (error) {
+            workflowError('Workflow middleware error:', error);
+            // Don't throw error to avoid breaking the main operation
+        }
+        next();
+    });
+    // Apply post-find middleware (for findAll queries)
+    schema.post('find', async function (docs, next) {
+        const recordType = docs && docs.length > 0
+            ? docs[0]?.constructor?.modelName?.toLowerCase() || 'unknown'
+            : 'unknown';
+        // Only process for applicantcreditreport model
+        if (recordType === 'applicantcreditreport') {
+            workflowLog(`📚 Post-find (findAll) middleware triggered for ${recordType}`);
+            workflowLog(`   Documents found: ${docs?.length || 0}`);
+            workflowLog(`   Trigger key: ${recordType}.get`);
+            // Process each document in the results
+            if (docs && docs.length > 0) {
+                for (const doc of docs) {
+                    try {
+                        await middleware.handleEvent({
+                            recordType,
+                            action: 'get',
+                            triggerKey: `${recordType}.get`
+                        }, doc);
+                    }
+                    catch (error) {
+                        workflowError('Workflow middleware error:', error);
+                        // Don't throw error to avoid breaking the main operation
+                    }
+                }
+            }
+        }
+        next();
+    });
+}
+/**
+ * Utility function to register the workflow plugin globally
+ * This will apply workflow middleware to all schemas automatically
+ */
+export function registerWorkflowPlugin() {
+    // Register the plugin globally
+    mongoose.plugin(workflowPlugin);
+}
+/**
+ * Utility function to apply workflow plugin to a specific schema with custom record type
+ * @param schema - The Mongoose schema
+ * @param recordType - The record type (e.g., 'applications', 'applicants')
+ */
+export function applyWorkflowPlugin(schema, recordType) {
+    schema.plugin(workflowPlugin, { recordType });
+}

package/dist/shared/workflow.service.d.ts

@@ -0,0 +1,42 @@
+import { WorkflowApiPayload, WorkflowMiddlewareOptions } from './workflow-trigger.type';
+export declare class WorkflowService {
+    private options;
+    private token?;
+    constructor(options: WorkflowMiddlewareOptions, token?: string);
+    /**
+     * Triggers a workflow execution in the background
+     * @param payload - The workflow payload to send
+     * @param token - Optional token to use for this specific call (overrides instance token)
+     * @returns Promise that resolves when the request is initiated (not when it completes)
+     */
+    triggerWorkflow(payload: WorkflowApiPayload, token?: string): Promise<void>;
+    /**
+     * Executes the actual workflow API call with retry logic
+     * @param payload - The workflow payload to send
+     * @param token - Optional token from context (takes priority over env var)
+     */
+    private executeWorkflowCall;
+    /**
+     * Validates that required variables are present in the data
+     * @param requiredVariables - Array of required variable names
+     * @param data - The data object to validate
+     * @returns true if all required variables are present
+     */
+    validateRequiredVariables(requiredVariables: string[], data: Record<string, any>): boolean;
+    /**
+     * Extracts variables from document data based on required and optional variables
+     * @param requiredVariables - Array of required variable names
+     * @param optionalVariables - Array of optional variable names
+     * @param document - The document to extract variables from
+     * @returns Object containing extracted variables
+     */
+    extractVariables(requiredVariables: string[], optionalVariables: string[], document: any): Record<string, any>;
+    /**
+     * Gets a nested value from an object using dot notation
+     * @param obj - The object to extract from
+     * @param path - The dot notation path (e.g., 'user.id')
+     * @returns The value at the path or undefined
+     */
+    private getNestedValue;
+}
+//# sourceMappingURL=workflow.service.d.ts.map

package/dist/shared/workflow.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow.service.d.ts","sourceRoot":"","sources":["../../shared/workflow.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAC;AAGxF,qBAAa,eAAe;IACxB,OAAO,CAAC,OAAO,CAA4B;IAC3C,OAAO,CAAC,KAAK,CAAC,CAAS;gBAEX,OAAO,EAAE,yBAAyB,EAAE,KAAK,CAAC,EAAE,MAAM;IAU9D;;;;;OAKG;IACG,eAAe,CAAC,OAAO,EAAE,kBAAkB,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAajF;;;;OAIG;YACW,mBAAmB;IA6DjC;;;;;OAKG;IACH,yBAAyB,CAAC,iBAAiB,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO;IAO1F;;;;;;OAMG;IACH,gBAAgB,CACZ,iBAAiB,EAAE,MAAM,EAAE,EAC3B,iBAAiB,EAAE,MAAM,EAAE,EAC3B,QAAQ,EAAE,GAAG,GACd,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAmBtB;;;;;OAKG;IACH,OAAO,CAAC,cAAc;CAKzB"}

package/dist/shared/workflow.service.js

@@ -0,0 +1,134 @@
+import { workflowLog, workflowWarn, workflowError } from './workflow.logger.js';
+export class WorkflowService {
+    constructor(options, token) {
+        this.options = {
+            timeout: 30000,
+            retryAttempts: 3,
+            retryDelay: 1000,
+            ...options
+        };
+        this.token = token;
+    }
+    /**
+     * Triggers a workflow execution in the background
+     * @param payload - The workflow payload to send
+     * @param token - Optional token to use for this specific call (overrides instance token)
+     * @returns Promise that resolves when the request is initiated (not when it completes)
+     */
+    async triggerWorkflow(payload, token) {
+        // Execute in background without waiting for completion
+        const tokenToUse = token || this.token;
+        setTimeout(async () => {
+            try {
+                await this.executeWorkflowCall(payload, tokenToUse);
+            }
+            catch (error) {
+                workflowError('Workflow execution failed:', error);
+                // Could implement retry logic or error reporting here
+            }
+        }, 1000);
+    }
+    /**
+     * Executes the actual workflow API call with retry logic
+     * @param payload - The workflow payload to send
+     * @param token - Optional token from context (takes priority over env var)
+     */
+    async executeWorkflowCall(payload, token) {
+        const headers = {
+            'Content-Type': 'application/json',
+            'X-Solution-Key': process.env.SOLUTION_KEY || 'default'
+        };
+        // Priority: Context token > Environment variable
+        const workflowApiKey = token || process.env.WORKFLOW_API_KEY;
+        if (workflowApiKey) {
+            headers['Authorization'] = `Bearer ${workflowApiKey}`;
+        }
+        const requestOptions = {
+            method: 'POST',
+            headers,
+            body: JSON.stringify(payload),
+            signal: AbortSignal.timeout(this.options.timeout)
+        };
+        let lastError = null;
+        for (let attempt = 1; attempt <= this.options.retryAttempts; attempt++) {
+            try {
+                workflowLog(`🚀 Workflow API call attempt ${attempt}:`);
+                workflowLog(`   URL: ${this.options.workflowApiUrl}`);
+                workflowLog(`   Payload: ${JSON.stringify(payload, null, 2)}`);
+                const response = await fetch(this.options.workflowApiUrl, requestOptions);
+                if (!response.ok) {
+                    // Try to get error details from response body
+                    let errorDetails = response.statusText;
+                    try {
+                        const errorBody = await response.text();
+                        if (errorBody) {
+                            errorDetails = errorBody;
+                        }
+                    }
+                    catch (e) {
+                        // Ignore if we can't read the body
+                    }
+                    throw new Error(`HTTP ${response.status}: ${errorDetails}`);
+                }
+                const result = await response.json();
+                workflowLog(`✅ Workflow ${payload.workflowKey} triggered successfully: ${JSON.stringify(result, null, 2)}`);
+                return;
+            }
+            catch (error) {
+                lastError = error;
+                workflowWarn(`Workflow API call attempt ${attempt} failed:`, error);
+                if (attempt < this.options.retryAttempts) {
+                    // Wait before retrying
+                    await new Promise(resolve => setTimeout(resolve, this.options.retryDelay * attempt));
+                }
+            }
+        }
+        // All retry attempts failed
+        throw new Error(`Workflow API call failed after ${this.options.retryAttempts} attempts: ${lastError?.message}`);
+    }
+    /**
+     * Validates that required variables are present in the data
+     * @param requiredVariables - Array of required variable names
+     * @param data - The data object to validate
+     * @returns true if all required variables are present
+     */
+    validateRequiredVariables(requiredVariables, data) {
+        return requiredVariables.every(variable => {
+            const value = data[variable];
+            return value !== undefined && value !== null && value !== '';
+        });
+    }
+    /**
+     * Extracts variables from document data based on required and optional variables
+     * @param requiredVariables - Array of required variable names
+     * @param optionalVariables - Array of optional variable names
+     * @param document - The document to extract variables from
+     * @returns Object containing extracted variables
+     */
+    extractVariables(requiredVariables, optionalVariables, document) {
+        const variables = {};
+        // Extract required variables
+        requiredVariables.forEach(variable => {
+            variables[variable] = this.getNestedValue(document, variable);
+        });
+        // Extract optional variables
+        optionalVariables?.forEach(variable => {
+            const value = this.getNestedValue(document, variable);
+            if (value !== undefined && value !== null) {
+                variables[variable] = value;
+            }
+        });
+        return variables;
+    }
+    /**
+     * Gets a nested value from an object using dot notation
+     * @param obj - The object to extract from
+     * @param path - The dot notation path (e.g., 'user.id')
+     * @returns The value at the path or undefined
+     */
+    getNestedValue(obj, path) {
+        return path.split('.').reduce((current, key) => {
+            return current && current[key] !== undefined ? current[key] : undefined;
+        }, obj);
+    }
+}

package/dist/types/base.types.d.ts

@@ -0,0 +1,35 @@
+/// <reference path="../value-objects/pound.d.ts" />
+/// <reference path="../value-objects/account-number.d.ts" />
+/// <reference path="../value-objects/sort-code.d.ts" />
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/inferschematype" />
+/// <reference types="mongoose/types/inferrawdoctype" />
+import { Types } from "mongoose";
+export interface IBaseType {
+    _id: Types.ObjectId;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+//# sourceMappingURL=base.types.d.ts.map

package/dist/types/base.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.types.d.ts","sourceRoot":"","sources":["../../types/base.types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEjC,MAAM,WAAW,SAAS;IACtB,GAAG,EAAE,KAAK,CAAC,QAAQ,CAAC;IACpB,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,SAAS,CAAC,EAAE,IAAI,CAAC;CACpB"}

package/dist/types/base.types.js

@@ -0,0 +1 @@
+export {};