@dynamatix/gb-schemas 2.3.237 → 2.3.239

package/dist/shared/{document-type-model.d.ts → webhook-event.model.d.ts}

@@ -26,51 +26,12 @@
 /// <reference types="mongoose/types/schematypes" />
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
-import mongoose from "mongoose";
-declare const DocumentTypeModel: mongoose.Model<{
-    name: string;
-    source: string;
-    parentDocumentTypeId: mongoose.Types.ObjectId;
-    label?: string | null | undefined;
-    matchRules?: any;
-}, {}, {}, {}, mongoose.Document<unknown, {}, {
-    name: string;
-    source: string;
-    parentDocumentTypeId: mongoose.Types.ObjectId;
-    label?: string | null | undefined;
-    matchRules?: any;
-}, {}> & {
-    name: string;
-    source: string;
-    parentDocumentTypeId: mongoose.Types.ObjectId;
-    label?: string | null | undefined;
-    matchRules?: any;
-} & {
-    _id: mongoose.Types.ObjectId;
-} & {
-    __v: number;
-}, mongoose.Schema<any, mongoose.Model<any, any, any, any, any, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, {
-    name: string;
-    source: string;
-    parentDocumentTypeId: mongoose.Types.ObjectId;
-    label?: string | null | undefined;
-    matchRules?: any;
-}, mongoose.Document<unknown, {}, mongoose.FlatRecord<{
-    name: string;
-    source: string;
-    parentDocumentTypeId: mongoose.Types.ObjectId;
-    label?: string | null | undefined;
-    matchRules?: any;
-}>, {}> & mongoose.FlatRecord<{
-    name: string;
-    source: string;
-    parentDocumentTypeId: mongoose.Types.ObjectId;
-    label?: string | null | undefined;
-    matchRules?: any;
-}> & {
+import mongoose from 'mongoose';
+import IWebhookEvent from './webhook-event.type';
+declare const _default: mongoose.Model<IWebhookEvent, {}, {}, {}, mongoose.Document<unknown, {}, IWebhookEvent, {}> & IWebhookEvent & {
     _id: mongoose.Types.ObjectId;
 } & {
     __v: number;
-}>>;
-export default DocumentTypeModel;
-//# sourceMappingURL=document-type-model.d.ts.map
+}, any>;
+export default _default;
+//# sourceMappingURL=webhook-event.model.d.ts.map

package/dist/shared/webhook-event.model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook-event.model.d.ts","sourceRoot":"","sources":["../../shared/webhook-event.model.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,QAAoB,MAAM,UAAU,CAAC;AAC5C,OAAO,aAAa,MAAM,sBAAsB,CAAC;;;;;;AAuDjD,wBAAiF"}

package/dist/shared/webhook-event.model.js

@@ -0,0 +1,53 @@
+import mongoose, { Schema } from 'mongoose';
+const webhookEventSchema = new Schema({
+    eventId: {
+        type: String,
+        required: true,
+        unique: true,
+        index: true
+    },
+    eventType: {
+        type: String,
+        required: true,
+        index: true
+    },
+    source: {
+        type: String,
+        required: true,
+        default: 'apprivo'
+    },
+    applicationId: {
+        type: String,
+        index: true
+    },
+    payload: {
+        type: Schema.Types.Mixed,
+        required: true
+    },
+    status: {
+        type: String,
+        enum: ['pending', 'processing', 'completed', 'failed'],
+        default: 'pending',
+        index: true
+    },
+    retryCount: {
+        type: Number,
+        default: 0
+    },
+    maxRetries: {
+        type: Number,
+        default: 3
+    },
+    processedAt: {
+        type: Date
+    },
+    errorMessage: {
+        type: String
+    }
+}, {
+    timestamps: true
+});
+// Index for efficient querying
+webhookEventSchema.index({ createdAt: -1 });
+webhookEventSchema.index({ status: 1, retryCount: 1 });
+export default mongoose.model('WebhookEvent', webhookEventSchema);

package/dist/shared/webhook-event.type.d.ts

@@ -0,0 +1,15 @@
+export default interface IWebhookEvent extends Document {
+    eventId: string;
+    eventType: string;
+    source: string;
+    applicationId?: string;
+    payload: any;
+    status: 'pending' | 'processing' | 'completed' | 'failed';
+    retryCount: number;
+    maxRetries: number;
+    processedAt?: Date;
+    errorMessage?: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+//# sourceMappingURL=webhook-event.type.d.ts.map

package/dist/shared/webhook-event.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook-event.type.d.ts","sourceRoot":"","sources":["../../shared/webhook-event.type.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,WAAW,aAAc,SAAQ,QAAQ;IACnD,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,GAAG,CAAC;IACb,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC1D,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACnB"}

package/dist/shared/webhook-event.type.js

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

package/dist/shared/workflow-trigger.model.d.ts

@@ -0,0 +1,32 @@
+/// <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 mongoose from 'mongoose';
+declare const _default: mongoose.Model<any, {}, {}, {}, any, any>;
+export default _default;
+//# sourceMappingURL=workflow-trigger.model.d.ts.map

package/dist/shared/workflow-trigger.model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-trigger.model.d.ts","sourceRoot":"","sources":["../../shared/workflow-trigger.model.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,QAAoB,MAAM,UAAU,CAAC;;AAmD5C,wBAA6H"}

package/dist/shared/workflow-trigger.model.js

@@ -0,0 +1,45 @@
+import mongoose, { Schema } from 'mongoose';
+const WorkflowTriggerSchema = new Schema({
+    triggerKey: {
+        type: String,
+        required: true,
+        unique: true,
+        index: true
+    },
+    description: {
+        type: String,
+        required: true
+    },
+    isActive: {
+        type: Boolean,
+        default: true,
+        index: true
+    },
+    condition: {
+        type: String,
+        required: true
+    },
+    workflowKey: {
+        type: String,
+        required: true,
+        index: true
+    },
+    requiredVariables: [{
+            type: String,
+            required: true
+        }],
+    optionalVariables: [{
+            type: String
+        }],
+    validationRules: {
+        type: Schema.Types.Mixed
+    },
+    metadata: {
+        type: Schema.Types.Mixed
+    }
+}, { timestamps: true });
+// Index for efficient querying
+WorkflowTriggerSchema.index({ triggerKey: 1, isActive: 1 });
+WorkflowTriggerSchema.index({ workflowKey: 1, isActive: 1 });
+// Conditional model registration to avoid "Cannot overwrite model" errors
+export default mongoose.models.WorkflowTrigger || mongoose.model('WorkflowTrigger', WorkflowTriggerSchema);

package/dist/shared/workflow-trigger.type.d.ts

@@ -0,0 +1,59 @@
+/// <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 { Document } from 'mongoose';
+export default interface IWorkflowTrigger extends Document {
+    triggerKey: string;
+    description: string;
+    isActive: boolean;
+    condition: string;
+    workflowKey: string;
+    requiredVariables: string[];
+    optionalVariables?: string[];
+    validationRules?: any;
+    metadata?: any;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface WorkflowTriggerEvent {
+    recordType: string;
+    action: string;
+    triggerKey: string;
+}
+export interface WorkflowApiPayload {
+    workflowKey: string;
+    version: number;
+    variables: Record<string, any>;
+}
+export interface WorkflowMiddlewareOptions {
+    workflowApiUrl: string;
+    timeout?: number;
+    retryAttempts?: number;
+    retryDelay?: number;
+}
+//# sourceMappingURL=workflow-trigger.type.d.ts.map

package/dist/shared/workflow-trigger.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-trigger.type.d.ts","sourceRoot":"","sources":["../../shared/workflow-trigger.type.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEpC,MAAM,CAAC,OAAO,WAAW,gBAAiB,SAAQ,QAAQ;IACtD,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,yBAAyB;IACtC,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB"}

package/dist/shared/workflow-trigger.type.js

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

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

@@ -0,0 +1,21 @@
+/**
+ * Initialize workflow middleware for all schemas
+ * Call this function once in your application startup to enable workflow middleware globally
+ *
+ * This will automatically apply workflow middleware to all Mongoose schemas
+ * The record type will be inferred from the model name (e.g., 'Application' -> 'applications')
+ */
+export declare function initializeWorkflowMiddleware(): void;
+/**
+ * Check if workflow middleware is properly configured
+ * @returns true if all required environment variables are set
+ */
+export declare function isWorkflowMiddlewareConfigured(): boolean;
+/**
+ * Initialize workflow middleware with configuration check
+ * @param options - Optional configuration options
+ */
+export declare function initializeWorkflowMiddlewareWithCheck(options?: {
+    skipConfigCheck?: boolean;
+}): boolean;
+//# sourceMappingURL=workflow.init.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"workflow.init.d.ts","sourceRoot":"","sources":["../../shared/workflow.init.ts"],"names":[],"mappings":"AAOA;;;;;;GAMG;AACH,wBAAgB,4BAA4B,SAI3C;AAED;;;GAGG;AACH,wBAAgB,8BAA8B,IAAI,OAAO,CAUxD;AAED;;;GAGG;AACH,wBAAgB,qCAAqC,CAAC,OAAO,CAAC,EAAE;IAAE,eAAe,CAAC,EAAE,OAAO,CAAA;CAAE,WAQ5F"}

package/dist/shared/workflow.init.js

@@ -0,0 +1,41 @@
+import dotenv from 'dotenv';
+import { registerWorkflowPlugin } from './workflow.plugin.js';
+// Load environment variables from .env file
+dotenv.config();
+/**
+ * Initialize workflow middleware for all schemas
+ * Call this function once in your application startup to enable workflow middleware globally
+ *
+ * This will automatically apply workflow middleware to all Mongoose schemas
+ * The record type will be inferred from the model name (e.g., 'Application' -> 'applications')
+ */
+export function initializeWorkflowMiddleware() {
+    console.log('Initializing workflow middleware for all schemas...');
+    registerWorkflowPlugin();
+    console.log('Workflow middleware initialized successfully');
+}
+/**
+ * Check if workflow middleware is properly configured
+ * @returns true if all required environment variables are set
+ */
+export function isWorkflowMiddlewareConfigured() {
+    const requiredEnvVars = ['WORKFLOW_API_KEY'];
+    const missingVars = requiredEnvVars.filter(varName => !process.env[varName]);
+    if (missingVars.length > 0) {
+        console.warn(`Missing required environment variables for workflow middleware: ${missingVars.join(', ')}`);
+        return false;
+    }
+    return true;
+}
+/**
+ * Initialize workflow middleware with configuration check
+ * @param options - Optional configuration options
+ */
+export function initializeWorkflowMiddlewareWithCheck(options) {
+    if (!options?.skipConfigCheck && !isWorkflowMiddlewareConfigured()) {
+        console.warn('Workflow middleware configuration incomplete. Middleware will be disabled.');
+        return false;
+    }
+    initializeWorkflowMiddleware();
+    return true;
+}

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

@@ -0,0 +1,107 @@
+/// <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';
+import { WorkflowTriggerEvent, WorkflowMiddlewareOptions } from './workflow-trigger.type.js';
+export declare class WorkflowMiddleware {
+    private workflowService;
+    private options;
+    constructor(options?: Partial<WorkflowMiddlewareOptions>);
+    /**
+     * Safely gets the WorkflowTrigger model, handling potential registration issues
+     */
+    private getWorkflowTriggerModel;
+    /**
+     * Gets the current request context including application_id
+     * @returns The current context object or null if not available
+     */
+    getContext(): {
+        contextId: any;
+    } | 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: string): {
+        postSave: (this: any, doc: any, next: Function) => Promise<void>;
+        postRemove: (this: any, doc: any, next: Function) => Promise<void>;
+    };
+    /**
+     * Handles a workflow trigger event
+     * @param event - The workflow trigger event
+     * @param document - The document that triggered the event
+     */
+    handleEvent(event: WorkflowTriggerEvent, document: any): Promise<void>;
+    /**
+     * 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
+     */
+    private processTrigger;
+    /**
+     * 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
+     */
+    private evaluateCondition;
+    /**
+     * Extracts metadata from document and event
+     * @param document - The document
+     * @param event - The event
+     * @returns Metadata object
+     */
+    private extractMetadata;
+    /**
+     * 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
+     */
+    manualTrigger(triggerKey: string, document: any, recordType: string): Promise<void>;
+}
+/**
+ * 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 declare function createWorkflowMiddleware(recordType: string, options?: Partial<WorkflowMiddlewareOptions>): {
+    postSave: (this: any, doc: any, next: Function) => Promise<void>;
+    postRemove: (this: any, doc: any, next: Function) => Promise<void>;
+};
+/**
+ * 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 declare function applyWorkflowMiddleware(schema: mongoose.Schema, recordType: string, options?: Partial<WorkflowMiddlewareOptions>): void;
+//# sourceMappingURL=workflow.middleware.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"workflow.middleware.d.ts","sourceRoot":"","sources":["../../shared/workflow.middleware.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAGhC,OAAO,EACH,oBAAoB,EAEpB,yBAAyB,EAC5B,MAAM,4BAA4B,CAAC;AAIpC,qBAAa,kBAAkB;IAC3B,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,OAAO,CAA4B;gBAE/B,OAAO,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC;IAYxD;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAS/B;;;OAGG;IACH,UAAU;;;IAMV;;;;OAIG;IACH,gBAAgB,CAAC,UAAU,EAAE,MAAM;yBAGK,GAAG,OAAO,GAAG,QAAQ,QAAQ;2BAiB3B,GAAG,OAAO,GAAG,QAAQ,QAAQ;;IAkBvE;;;;OAIG;IACG,WAAW,CAAC,KAAK,EAAE,oBAAoB,EAAE,QAAQ,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IA0B5E;;;;;OAKG;YACW,cAAc;IA8C5B;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAkBzB;;;;;OAKG;IACH,OAAO,CAAC,eAAe;IAYvB;;;;;OAKG;IACG,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAS5F;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC;;;EAGxG;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC,QAShI"}