@ikonintegration/ikapi 4.0.0-alpha8 → 5.0.0-alpha1

package/dist/src/API/Response.js

@@ -0,0 +1,270 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import Globals from '../Globals.js';
+/**
+ * CustomError class that extends the built-in Error class.
+ * @class
+ * @extends Error
+ * @param {any} body - The body of the error, which can be an object or a string.
+ * @constructor
+ * @property {string} name - The name of the error.
+ */
+class CustomError extends Error {
+    constructor(body) {
+        super(body.message || 'Unknown error!');
+        this.name = body.error || 'UnknownError';
+    }
+}
+/**
+ * Represents a response object with various methods for building and manipulating the response.
+ * @template BodyType - The type of the response body.
+ */
+export default class Response {
+    /**
+     * Constructs a new Response object with the given status code, body, and optional behavior.
+     * @param {number} statusCode - The HTTP status code of the response.
+     * @param {BodyType} body - The body of the response.
+     * @param {Object} [optBehaviour] - Optional behavior configuration for the response.
+     * @param {boolean} [optBehaviour.shouldStream] - Indicates whether the response should be streamed.
+     * @param {boolean} [optBehaviour.rawBody] - Indicates whether the response body should be treated as raw data.
+     * @param {boolean} [optBehaviour.throwOnErrors] - Indicates whether errors should be thrown for non-successful status codes.
+     * @param {boolean} [optBehaviour
+     */
+    constructor(statusCode, body, optBehaviour) {
+        // response
+        this.statusCode = statusCode;
+        this.body = body;
+        this.headers = {
+            'Access-Control-Allow-Origin': '*',
+            'Access-Control-Allow-Credentials': true,
+            'Content-Type': 'application/json',
+        };
+        // behaviour
+        this.isPipingOut = false; //internal -- flag to indicate streaming out has started and avoid double stream call
+        // options
+        this.shouldStream = !!(optBehaviour === null || optBehaviour === void 0 ? void 0 : optBehaviour.shouldStream); //
+        this.rawBody = !!(optBehaviour === null || optBehaviour === void 0 ? void 0 : optBehaviour.rawBody);
+        this.throwOnErrors = !!(optBehaviour === null || optBehaviour === void 0 ? void 0 : optBehaviour.throwOnErrors);
+        this.disableTransactionID = !!(optBehaviour === null || optBehaviour === void 0 ? void 0 : optBehaviour.disableTransactionID);
+    }
+    /**
+     * Get the status code of the response.
+     * @returns {number} The status code.
+     */
+    getCode() {
+        return this.statusCode;
+    }
+    /**
+     * Get the body of the object.
+     * @returns {BodyType} The body of the object.
+     */
+    getBody() {
+        return this.body;
+    }
+    /**
+     * Appends a key-value pair into the body object.
+     * @param {string} key - The key to append.
+     * @param {any} value - The value to append.
+     * @returns None
+     */
+    appendIntoBody(key, value) {
+        this.body[key] = value;
+    }
+    /**
+     * Appends a header to the existing headers object.
+     * @param {string} key - The key of the header.
+     * @param {any} value - The value of the header.
+     * @returns None
+     */
+    appendHeader(key, value) {
+        this.headers[key] = value;
+    }
+    /**
+     * Builds the response for the given context and transaction.
+     * @param {Context} context - The context object.
+     * @param {Transaction<any, any, any>} transaction - The transaction object.
+     * @param {boolean} optDoNotCallContext - Optional flag to indicate whether to call the context or not.
+     * @returns {Promise<void>} - A promise that resolves when the response is built.
+     */
+    build(context, transaction, optDoNotCallContext) {
+        return __awaiter(this, void 0, void 0, function* () {
+            //Stream support
+            if (this.isPipingOut)
+                return;
+            if (this.shouldStream)
+                return this.pipe(context);
+            //append default fields
+            if (transaction.request.getRequestID() && this.body && !this.disableTransactionID)
+                this.appendIntoBody('transactionID', transaction.request.getRequestID()); //append transaction ID
+            //Raw response support
+            if (this.rawBody)
+                return this.rawContext(context, transaction);
+            //build response
+            const b = Object.assign({ statusCode: this.statusCode, headers: this.headers }, (this.body ? { body: JSON.stringify(this.body) } : {}));
+            //log response and respond to context
+            transaction.logger.debug(b);
+            //Check for transaction response proxy
+            if (transaction.responseProxy)
+                yield transaction.responseProxy(this);
+            //Batch does not succeed directly just on upper transaction (which will should be a batch)
+            if (!optDoNotCallContext)
+                context.succeed(b);
+        });
+    }
+    /**
+     * Private method that pipes the response to the given context.
+     * @param {Context} context - The context object provided by AWS Lambda.
+     * @returns None
+     */
+    pipe(context) {
+        //Check if not streaming
+        this.isPipingOut = true;
+        //build response
+        const b = {
+            statusCode: this.statusCode,
+            body: this.body,
+            headers: this.headers,
+        };
+        //log response and respond to context
+        context.succeed(b);
+    }
+    /**
+     * Private method that handles the raw context of a transaction.
+     * @param {Context} context - The context object.
+     * @param {Transaction<null, BodyType>} transaction - The transaction object.
+     * @returns None
+     */
+    rawContext(context, transaction) {
+        //log response and respond to context
+        transaction.logger.debug(this.body);
+        if (this.getCode() <= 200 && this.getCode() <= 299)
+            context.succeed(this.body);
+        else {
+            if (!this.throwOnErrors)
+                context.fail(new CustomError(this.body));
+            else
+                throw new CustomError(this.body);
+        }
+    }
+    /**
+     * Generates a response object for a missing path parameter error.
+     * @param {string} paramName - The name of the missing path parameter.
+     * @returns {Response<ResponseErrorType>} - The response object with error details.
+     */
+    static MissingParamResponse(paramName) {
+        console.warn(`Invalid request - Path parameter ${paramName} is missing.`);
+        return new Response(400, {
+            err: `Invalid request. Path parameter ${paramName} is missing.`,
+            errCode: Globals.ErrorCode_MissingParam,
+        });
+    }
+    /**
+     * Creates a response object for a missing query parameter error.
+     * @param {string} paramName - The name of the missing query parameter.
+     * @returns {Response<ResponseErrorType>} - The response object with error details.
+     */
+    static MissingQueryResponse(paramName) {
+        console.warn(`Invalid request - Query parameter ${paramName} is missing.`);
+        return new Response(400, {
+            err: `Invalid request. Query parameter ${paramName} is missing.`,
+            errCode: Globals.ErrorCode_MissingParam,
+        });
+    }
+    /**
+     * Creates a BadRequestResponse object with the given parameters.
+     * @param {string} [msg] - The error message.
+     * @param {string} [errCode] - The error code.
+     * @param {any} [optBody] - Optional additional body data.
+     * @returns {Response<ResponseErrorType>} - The BadRequestResponse object.
+     */
+    static BadRequestResponse(msg, errCode, optBody) {
+        console.warn(`Bad request - ${msg}`);
+        return new Response(400, Object.assign(Object.assign({ err: msg }, (errCode ? { errCode: errCode } : {})), (optBody || {})));
+    }
+    /**
+     * Creates a BadRequestResponse object with rollback option.
+     * @param {string} msg - The error message.
+     * @param {string} [errCode] - The error code.
+     * @param {any} [optBody] - Optional body to include in the response.
+     * @returns {Response<ResponseErrorType>} - The BadRequestResponse object.
+     */
+    static BadRequestResponseWithRollback(msg, errCode, optBody) {
+        console.warn(`Bad request - ${msg}`);
+        return new Response(400, Object.assign(Object.assign({ err: msg, rollback: true }, (errCode ? { errCode: errCode } : {})), (optBody || {})));
+    }
+    /**
+     * Creates an unauthorized response with the given error message and error code.
+     * @param {string} msg - The error message.
+     * @param {string} [errCode] - The error code (optional).
+     * @returns {Response<ResponseErrorType>} - The unauthorized response.
+     */
+    static UnauthorizedResponse(msg, errCode) {
+        console.warn(`Denying request - ${msg}`);
+        return new Response(401, Object.assign({ err: msg }, (errCode ? { errCode: errCode } : {})));
+    }
+    /**
+     * Creates a success response object with the given body.
+     * @param {BodyType} body - The body of the response.
+     * @returns {Response<BodyType>} - The success response object.
+     */
+    static SuccessResponse(body) {
+        return new Response(200, (body ? body : {}));
+    }
+    /**
+     * Creates a redirect response with the specified URL.
+     * @param {string} url - The URL to redirect to.
+     * @returns {Response<null>} - The redirect response.
+     */
+    static RedirectResponse(url) {
+        const resp = new Response(302, null);
+        resp.appendHeader('Location', url);
+        return resp;
+    }
+    /**
+     * Creates a success response with no content.
+     * @returns {Response<null>} A response object with a status code of 204 and no content.
+     */
+    static SuccessNoContentResponse() {
+        return new Response(204, null);
+    }
+    /**
+     * Creates a success response object with a streaming body and specified content type.
+     * @param {any} stream - The stream object to be used as the response body.
+     * @param {string} contentType - The content type of the response.
+     * @returns {Response} - The success response object.
+     */
+    static SuccessStreamResponse(stream, contentType) {
+        const resp = new Response(200, stream, {
+            shouldStream: true,
+        });
+        resp.appendHeader('Connection', 'keep-alive');
+        if (contentType)
+            resp.appendHeader('Content-Type', contentType);
+        return resp;
+    }
+    /**
+     * Creates a simple HTTP response with the given body and optional status code.
+     * @param {BodyType} body - The body of the response.
+     * @param {number} [optionalCode] - The optional status code of the response. Defaults to 200.
+     * @returns {Response<BodyType>} - The created response object.
+     */
+    static SimpleResponse(body, optionalCode) {
+        const resp = new Response(optionalCode || 200, body);
+        return resp;
+    }
+    static StepFunctionResponse(body, optionalCode) {
+        const resp = new Response(optionalCode || 200, body, {
+            rawBody: true,
+            throwOnErrors: true,
+        });
+        return resp;
+    }
+}
+//# sourceMappingURL=Response.js.map

package/dist/src/API/Response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Response.js","sourceRoot":"","sources":["../../../src/API/Response.ts"],"names":[],"mappings":";;;;;;;;;AAGA,OAAO,OAAO,MAAM,eAAe,CAAA;AAEnC;;;;;;;GAOG;AACH,MAAM,WAAY,SAAQ,KAAK;IAC7B,YAAY,IAAS;QACnB,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,gBAAgB,CAAC,CAAA;QACvC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,IAAI,cAAc,CAAA;IAC1C,CAAC;CACF;AAaD;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IA4C3B;;;;;;;;;OASG;IACH,YACE,UAAkB,EAClB,IAAc,EACd,YAOa;QAEb,WAAW;QACX,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,OAAO,GAAG;YACb,6BAA6B,EAAE,GAAG;YAClC,kCAAkC,EAAE,IAAI;YACxC,cAAc,EAAE,kBAAkB;SACnC,CAAA;QACD,YAAY;QACZ,IAAI,CAAC,WAAW,GAAG,KAAK,CAAA,CAAC,qFAAqF;QAC9G,UAAU;QACV,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,YAAY,CAAA,CAAA,CAAC,EAAE;QACnD,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,OAAO,CAAA,CAAA;QACtC,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,aAAa,CAAA,CAAA;QAClD,IAAI,CAAC,oBAAoB,GAAG,CAAC,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,oBAAoB,CAAA,CAAA;IAClE,CAAC;IAED;;;OAGG;IACI,OAAO;QACZ,OAAO,IAAI,CAAC,UAAU,CAAA;IACxB,CAAC;IAED;;;OAGG;IACI,OAAO;QACZ,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,GAAW,EAAE,KAAU;QAC3C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;IACxB,CAAC;IAED;;;;;OAKG;IACI,YAAY,CAAC,GAAW,EAAE,KAAU;QACzC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;IAC3B,CAAC;IAED;;;;;;OAMG;IACU,KAAK,CAChB,OAAgB,EAChB,WAAiD,EACjD,mBAA4B;;YAE5B,gBAAgB;YAChB,IAAI,IAAI,CAAC,WAAW;gBAAE,OAAM;YAC5B,IAAI,IAAI,CAAC,YAAY;gBAAE,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAEhD,uBAAuB;YACvB,IAAI,WAAW,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,oBAAoB;gBAC/E,IAAI,CAAC,cAAc,CAAC,eAAe,EAAE,WAAW,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA,CAAC,uBAAuB;YAClG,sBAAsB;YACtB,IAAI,IAAI,CAAC,OAAO;gBAAE,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;YAE9D,gBAAgB;YAChB,MAAM,CAAC,mBACL,UAAU,EAAE,IAAI,CAAC,UAAU,EAC3B,OAAO,EAAE,IAAI,CAAC,OAAO,IAClB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAC1D,CAAA;YACD,qCAAqC;YACrC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YAC3B,sCAAsC;YACtC,IAAI,WAAW,CAAC,aAAa;gBAAE,MAAM,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;YACpE,0FAA0F;YAC1F,IAAI,CAAC,mBAAmB;gBAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;QAC9C,CAAC;KAAA;IAED;;;;OAIG;IACK,IAAI,CAAC,OAAgB;QAC3B,wBAAwB;QACxB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAA;QACvB,gBAAgB;QAChB,MAAM,CAAC,GAAG;YACR,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAA;QACD,qCAAqC;QACrC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;IAED;;;;;OAKG;IACK,UAAU,CAAC,OAAgB,EAAE,WAA6C;QAChF,qCAAqC;QACrC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACnC,IAAI,IAAI,CAAC,OAAO,EAAE,IAAI,GAAG,IAAI,IAAI,CAAC,OAAO,EAAE,IAAI,GAAG;YAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;aACzE,CAAC;YACJ,IAAI,CAAC,IAAI,CAAC,aAAa;gBAAE,OAAO,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;;gBAC5D,MAAM,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACvC,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,oBAAoB,CAAC,SAAiB;QAClD,OAAO,CAAC,IAAI,CAAC,oCAAoC,SAAS,cAAc,CAAC,CAAA;QACzE,OAAO,IAAI,QAAQ,CAAoB,GAAG,EAAE;YAC1C,GAAG,EAAE,mCAAmC,SAAS,cAAc;YAC/D,OAAO,EAAE,OAAO,CAAC,sBAAsB;SACxC,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,oBAAoB,CAAC,SAAiB;QAClD,OAAO,CAAC,IAAI,CAAC,qCAAqC,SAAS,cAAc,CAAC,CAAA;QAC1E,OAAO,IAAI,QAAQ,CAAoB,GAAG,EAAE;YAC1C,GAAG,EAAE,oCAAoC,SAAS,cAAc;YAChE,OAAO,EAAE,OAAO,CAAC,sBAAsB;SACxC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,kBAAkB,CAC9B,GAAY,EACZ,OAAgB,EAChB,OAAa;QAEb,OAAO,CAAC,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAC,CAAA;QACpC,OAAO,IAAI,QAAQ,CAAoB,GAAG,gCACxC,GAAG,EAAE,GAAG,IACL,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GACrC,CAAC,OAAO,IAAI,EAAE,CAAC,EAClB,CAAA;IACJ,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,8BAA8B,CAC1C,GAAW,EACX,OAAgB,EAChB,OAAa;QAEb,OAAO,CAAC,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAC,CAAA;QACpC,OAAO,IAAI,QAAQ,CAAoB,GAAG,gCACxC,GAAG,EAAE,GAAG,EACR,QAAQ,EAAE,IAAI,IACX,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GACrC,CAAC,OAAO,IAAI,EAAE,CAAC,EAClB,CAAA;IACJ,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,oBAAoB,CAAC,GAAW,EAAE,OAAgB;QAC9D,OAAO,CAAC,IAAI,CAAC,qBAAqB,GAAG,EAAE,CAAC,CAAA;QACxC,OAAO,IAAI,QAAQ,CAAoB,GAAG,kBACxC,GAAG,EAAE,GAAG,IACL,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EACxC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,eAAe,CAAW,IAAc;QACpD,OAAO,IAAI,QAAQ,CAAW,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAa,CAAC,CAAA;IACpE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,GAAW;QACxC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAO,GAAG,EAAE,IAAI,CAAC,CAAA;QAC1C,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,CAAC,CAAA;QAClC,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,wBAAwB;QACpC,OAAO,IAAI,QAAQ,CAAO,GAAG,EAAE,IAAI,CAAC,CAAA;IACtC,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,qBAAqB,CAAC,MAAW,EAAE,WAAmB;QAClE,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE;YACrC,YAAY,EAAE,IAAI;SACnB,CAAC,CAAA;QACF,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,YAAY,CAAC,CAAA;QAC7C,IAAI,WAAW;YAAE,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,WAAW,CAAC,CAAA;QAC/D,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAC1B,IAAc,EACd,YAAqB;QAErB,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAW,YAAY,IAAI,GAAG,EAAE,IAAI,CAAC,CAAA;QAC9D,OAAO,IAAI,CAAA;IACb,CAAC;IAEM,MAAM,CAAC,oBAAoB,CAAW,IAAc,EAAE,YAAqB;QAChF,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAW,YAAY,IAAI,GAAG,EAAE,IAAI,EAAE;YAC7D,OAAO,EAAE,IAAI;YACb,aAAa,EAAE,IAAI;SACpB,CAAC,CAAA;QACF,OAAO,IAAI,CAAA;IACb,CAAC;CACF"}

package/dist/src/BaseEvent/DynamoTransaction.d.ts

@@ -0,0 +1,20 @@
+import type { Context, DynamoDBBatchResponse, DynamoDBRecord, DynamoDBStreamEvent } from 'aws-lambda';
+import Transaction, { TransactionConfig } from './Transaction.js';
+import Response, { ResponseErrorType } from '../API/Response.js';
+export interface DynamoDBMarshalledRecord extends DynamoDBRecord {
+    marshalled: {
+        Keys?: object;
+        OldImage?: object;
+        NewImage?: object;
+    };
+}
+export type DynamoTransactionExecution<ResponseInnerType> = (transaction: Transaction<null, ResponseInnerType | ResponseErrorType, DynamoDBBatchResponse | null>, recordContent: DynamoDBMarshalledRecord) => Promise<Response<ResponseInnerType | ResponseErrorType> | DynamoDBBatchResponse | null>;
+export default class DynamoTransaction<ResponseInnerType> {
+    private readonly allowFailure;
+    private readonly config;
+    private readonly context;
+    private readonly event;
+    constructor(event: DynamoDBStreamEvent, context: Context, config?: TransactionConfig, allowFailure?: boolean);
+    processEvent(execution: DynamoTransactionExecution<ResponseInnerType>): Promise<Response<ResponseErrorType | null> | null | DynamoDBBatchResponse>;
+    private processRawEvent;
+}

package/dist/src/BaseEvent/DynamoTransaction.js

@@ -0,0 +1,81 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import Transaction from './Transaction.js';
+import Response from '../API/Response.js';
+import Globals from '../Globals.js';
+import Utils from '../Util/Utils.js';
+export default class DynamoTransaction {
+    constructor(event, context, config, allowFailure) {
+        this.event = event;
+        this.context = context;
+        this.config = config || {};
+        this.allowFailure = !!allowFailure;
+    }
+    processEvent(execution) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.processRawEvent(execution);
+            if (!this.allowFailure &&
+                resp &&
+                resp instanceof Response &&
+                !(resp.getCode() >= 200 && resp.getCode() < 300))
+                throw new Error(JSON.stringify(resp.getBody() || {}));
+            else if (resp)
+                return resp;
+            return null;
+        });
+    }
+    processRawEvent(execution) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            // safe check for empty events?
+            if (this.event.Records && this.event.Records.length > 0) {
+                // Regular cleanup of tmp disk to avoid tmp overflow on reused lambdas
+                if (!((_a = this.config) === null || _a === void 0 ? void 0 : _a.skipCleanTmp))
+                    yield Utils.cleanTemporaryFolder();
+                // init transaction for all records
+                return yield new Transaction(this.event, this.context, Object.assign(Object.assign({}, this.config), { syncReturn: true })).execute((transaction) => __awaiter(this, void 0, void 0, function* () {
+                    var _a, _b, _c, _d, _e, _f;
+                    // for each available event
+                    const failureIDs = [];
+                    for (const eventRecordIdx in this.event.Records) {
+                        const eventRecord = this.event.Records[eventRecordIdx];
+                        const record = Object.assign(Object.assign({}, eventRecord), { marshalled: Object.assign(Object.assign(Object.assign({}, (((_a = eventRecord.dynamodb) === null || _a === void 0 ? void 0 : _a.Keys)
+                                ? { Keys: Utils.ddbUnmarshall((_b = eventRecord.dynamodb) === null || _b === void 0 ? void 0 : _b.Keys) }
+                                : {})), (((_c = eventRecord.dynamodb) === null || _c === void 0 ? void 0 : _c.OldImage)
+                                ? { OldImage: Utils.ddbUnmarshall((_d = eventRecord.dynamodb) === null || _d === void 0 ? void 0 : _d.OldImage) }
+                                : {})), (((_e = eventRecord.dynamodb) === null || _e === void 0 ? void 0 : _e.NewImage)
+                                ? { NewImage: Utils.ddbUnmarshall((_f = eventRecord.dynamodb) === null || _f === void 0 ? void 0 : _f.NewImage) }
+                                : {})) });
+                        // Call execution with marshalled item
+                        const resp = yield execution(transaction, record);
+                        // check for failure
+                        if (!resp ||
+                            (resp instanceof Response && !((resp === null || resp === void 0 ? void 0 : resp.getCode()) >= 200 && (resp === null || resp === void 0 ? void 0 : resp.getCode()) < 300))) {
+                            // response with failures or fail hard at first
+                            if (this.allowFailure)
+                                failureIDs.push(eventRecord.eventID);
+                            else
+                                return resp;
+                        }
+                    }
+                    // not errored and loop ended - succeeded (might have failures)
+                    if (this.allowFailure)
+                        return {
+                            batchItemFailures: failureIDs.map(id => ({ itemIdentifier: id })),
+                        };
+                    return Response.SuccessResponse(null);
+                }));
+            }
+            else
+                return Response.BadRequestResponse(Globals.ErrorResponseNoRecords, Globals.ErrorCode_NoRecords);
+        });
+    }
+}
+//# sourceMappingURL=DynamoTransaction.js.map

package/dist/src/BaseEvent/DynamoTransaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DynamoTransaction.js","sourceRoot":"","sources":["../../../src/BaseEvent/DynamoTransaction.ts"],"names":[],"mappings":";;;;;;;;;AAOA,OAAO,WAAkC,MAAM,kBAAkB,CAAA;AACjE,OAAO,QAA+B,MAAM,oBAAoB,CAAA;AAChE,OAAO,OAAO,MAAM,eAAe,CAAA;AACnC,OAAO,KAAK,MAAM,kBAAkB,CAAA;AAmBpC,MAAM,CAAC,OAAO,OAAO,iBAAiB;IASpC,YACE,KAA0B,EAC1B,OAAgB,EAChB,MAA0B,EAC1B,YAAsB;QAEtB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,EAAE,CAAA;QAC1B,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,YAAY,CAAA;IACpC,CAAC;IAEY,YAAY,CACvB,SAAwD;;YAExD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAA;YAClD,IACE,CAAC,IAAI,CAAC,YAAY;gBAClB,IAAI;gBACJ,IAAI,YAAY,QAAQ;gBACxB,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,GAAG,IAAI,IAAI,CAAC,OAAO,EAAE,GAAG,GAAG,CAAC;gBAEhD,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;iBAClD,IAAI,IAAI;gBAAE,OAAO,IAAI,CAAA;YAC1B,OAAO,IAAI,CAAA;QACb,CAAC;KAAA;IAEa,eAAe,CAC3B,SAAwD;;;YAExD,+BAA+B;YAC/B,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxD,sEAAsE;gBACtE,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,YAAY,CAAA;oBAAE,MAAM,KAAK,CAAC,oBAAoB,EAAE,CAAA;gBAClE,mCAAmC;gBACnC,OAAO,MAAM,IAAI,WAAW,CAC1B,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,OAAO,kCAEP,IAAI,CAAC,MAAM,KACd,UAAU,EAAE,IAAI,IAEnB,CAAC,OAAO,CAAC,CAAM,WAAW,EAAC,EAAE;;oBAC5B,2BAA2B;oBAC3B,MAAM,UAAU,GAAkB,EAAE,CAAA;oBACpC,KAAK,MAAM,cAAc,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;wBAChD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;wBACtD,MAAM,MAAM,mCACP,WAAW,KACd,UAAU,gDACL,CAAC,CAAA,MAAA,WAAW,CAAC,QAAQ,0CAAE,IAAI;gCAC5B,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,aAAa,CAAC,MAAA,WAAW,CAAC,QAAQ,0CAAE,IAAI,CAAC,EAAE;gCAC3D,CAAC,CAAC,EAAE,CAAC,GACJ,CAAC,CAAA,MAAA,WAAW,CAAC,QAAQ,0CAAE,QAAQ;gCAChC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,aAAa,CAAC,MAAA,WAAW,CAAC,QAAQ,0CAAE,QAAQ,CAAC,EAAE;gCACnE,CAAC,CAAC,EAAE,CAAC,GACJ,CAAC,CAAA,MAAA,WAAW,CAAC,QAAQ,0CAAE,QAAQ;gCAChC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,aAAa,CAAC,MAAA,WAAW,CAAC,QAAQ,0CAAE,QAAQ,CAAC,EAAE;gCACnE,CAAC,CAAC,EAAE,CAAC,IAEV,CAAA;wBACD,sCAAsC;wBACtC,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC,CAAA;wBACjD,oBAAoB;wBACpB,IACE,CAAC,IAAI;4BACL,CAAC,IAAI,YAAY,QAAQ,IAAI,CAAC,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAI,GAAG,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,IAAG,GAAG,CAAC,CAAC,EAChF,CAAC;4BACD,+CAA+C;4BAC/C,IAAI,IAAI,CAAC,YAAY;gCAAE,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,OAAQ,CAAC,CAAA;;gCACvD,OAAO,IAAI,CAAA;wBAClB,CAAC;oBACH,CAAC;oBACD,+DAA+D;oBAC/D,IAAI,IAAI,CAAC,YAAY;wBACnB,OAAO;4BACL,iBAAiB,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC,CAAC;yBAClE,CAAA;oBACH,OAAO,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,CAAA;gBACvC,CAAC,CAAA,CAAC,CAAA;YACJ,CAAC;;gBACC,OAAO,QAAQ,CAAC,kBAAkB,CAChC,OAAO,CAAC,sBAAsB,EAC9B,OAAO,CAAC,mBAAmB,CAC5B,CAAA;QACL,CAAC;KAAA;CACF"}

package/dist/src/BaseEvent/EventProcessor.d.ts

@@ -0,0 +1,58 @@
+import type { Context, SQSBatchResponse, SQSEvent } from 'aws-lambda';
+import Transaction, { TransactionConfig } from './Transaction.js';
+import Response, { ResponseErrorType } from '../API/Response.js';
+/**
+ * Type definition for an event processor execution function.
+ * @param {Transaction<null, ResponseInnerType | ResponseErrorType, SQSBatchResponse>} transaction - The transaction object.
+ * @param {string | object} recordContent - The content of the record being processed.
+ * @returns {Promise<Response<ResponseInnerType | ResponseErrorType> | SQSBatchResponse>} - A promise that resolves to the response or batch response.
+ */
+export type EventProcessorExecution<ResponseInnerType> = (transaction: Transaction<null, ResponseInnerType | ResponseErrorType, SQSBatchResponse | null>, recordContent: string | object) => Promise<Response<ResponseInnerType | ResponseErrorType> | SQSBatchResponse | null>;
+/**
+ * EventProcessor class that processes events from an SQS queue.
+ * @template ResponseInnerType - The type of the inner response object.
+ */
+export default class EventProcessor<ResponseInnerType> {
+    /**
+     * A boolean flag indicating whether failures are allowed or not.
+     * @readonly
+     */
+    private readonly allowFailure;
+    /**
+     * The configuration object for the API transaction.
+     */
+    private readonly config;
+    /**
+     * The private readonly context property of the class.
+     * @type {Context}
+     */
+    private readonly context;
+    /**
+     * The SQS event object that triggered the Lambda function.
+     */
+    private readonly event;
+    /**
+     * Constructs a new instance of the class.
+     * @param {SQSEvent} event - The event object representing the incoming SQS message.
+     * @param {Context} context - The context object representing the AWS Lambda execution context.
+     * @param {TransactionConfig} [config] - Optional configuration object for the transaction.
+     * @param {boolean} [allowFailure] - Optional flag indicating whether to allow failure for the transaction.
+     * @returns None
+     */
+    constructor(event: SQSEvent, context: Context, config?: TransactionConfig, allowFailure?: boolean);
+    /**
+     * Processes an event using the provided execution object and returns a response.
+     * @param {EventProcessorExecution<ResponseInnerType>} execution - The execution object containing the event to process.
+     * @param {boolean} [doNotDecodeMessage] - Optional flag indicating whether to decode the message.
+     * @returns {Promise<Response<ResponseErrorType> | null | SQSBatchResponse>} - A promise that resolves to the response object, or null if no response is available.
+     * @throws {Error} - Throws an error if the response code is not within the range of 200 to 299 and failure is not allowed.
+     */
+    processEvent(execution: EventProcessorExecution<ResponseInnerType>, doNotDecodeMessage?: boolean): Promise<Response<ResponseErrorType | null> | null | SQSBatchResponse>;
+    /**
+     * Processes a raw event by executing the provided execution function and handling any errors or failures.
+     * @param {EventProcessorExecution<ResponseInnerType>} execution - The execution function to process the event.
+     * @param {boolean} doNotDecodeMessage - Flag indicating whether to decode the message or not.
+     * @returns {Promise<Response<ResponseErrorType> | null | SQSBatchResponse>} - A promise that resolves to a response object, null, or a SQS batch response.
+     */
+    private processRawEvent;
+}

package/dist/src/BaseEvent/EventProcessor.js

@@ -0,0 +1,101 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import Transaction from './Transaction.js';
+import Response from '../API/Response.js';
+import Globals from '../Globals.js';
+import Utils from '../Util/Utils.js';
+/**
+ * EventProcessor class that processes events from an SQS queue.
+ * @template ResponseInnerType - The type of the inner response object.
+ */
+export default class EventProcessor {
+    /**
+     * Constructs a new instance of the class.
+     * @param {SQSEvent} event - The event object representing the incoming SQS message.
+     * @param {Context} context - The context object representing the AWS Lambda execution context.
+     * @param {TransactionConfig} [config] - Optional configuration object for the transaction.
+     * @param {boolean} [allowFailure] - Optional flag indicating whether to allow failure for the transaction.
+     * @returns None
+     */
+    constructor(event, context, config, allowFailure) {
+        this.event = event;
+        this.context = context;
+        this.config = config || {};
+        this.allowFailure = !!allowFailure;
+    }
+    /**
+     * Processes an event using the provided execution object and returns a response.
+     * @param {EventProcessorExecution<ResponseInnerType>} execution - The execution object containing the event to process.
+     * @param {boolean} [doNotDecodeMessage] - Optional flag indicating whether to decode the message.
+     * @returns {Promise<Response<ResponseErrorType> | null | SQSBatchResponse>} - A promise that resolves to the response object, or null if no response is available.
+     * @throws {Error} - Throws an error if the response code is not within the range of 200 to 299 and failure is not allowed.
+     */
+    processEvent(execution, doNotDecodeMessage) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.processRawEvent(execution, !!doNotDecodeMessage);
+            if (!this.allowFailure &&
+                resp &&
+                resp instanceof Response &&
+                !(resp.getCode() >= 200 && resp.getCode() < 300))
+                throw new Error(JSON.stringify(resp.getBody() || {}));
+            else if (resp)
+                return resp;
+            return null;
+        });
+    }
+    /**
+     * Processes a raw event by executing the provided execution function and handling any errors or failures.
+     * @param {EventProcessorExecution<ResponseInnerType>} execution - The execution function to process the event.
+     * @param {boolean} doNotDecodeMessage - Flag indicating whether to decode the message or not.
+     * @returns {Promise<Response<ResponseErrorType> | null | SQSBatchResponse>} - A promise that resolves to a response object, null, or a SQS batch response.
+     */
+    processRawEvent(execution, doNotDecodeMessage) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            // safe check for empty events?
+            if (this.event.Records && this.event.Records.length > 0) {
+                // Regular cleanup of tmp disk to avoid tmp overflow on reused lambdas
+                if (!((_a = this.config) === null || _a === void 0 ? void 0 : _a.skipCleanTmp))
+                    yield Utils.cleanTemporaryFolder();
+                // init transaction for all records
+                return yield new Transaction(this.event, this.context, Object.assign(Object.assign({}, this.config), { syncReturn: true })).execute((transaction) => __awaiter(this, void 0, void 0, function* () {
+                    // Map records with decoded message when required
+                    const decodedRecords = this.event.Records.map(eventRecord => doNotDecodeMessage ? eventRecord.body : JSON.parse(eventRecord.body));
+                    // for each available event
+                    const failureIDs = [];
+                    for (const eventRecordIdx in decodedRecords) {
+                        const eventRecord = decodedRecords[eventRecordIdx];
+                        const message = this.event.Records[eventRecordIdx];
+                        // Call execution
+                        const resp = yield execution(transaction, eventRecord);
+                        // check for failure
+                        if (!resp ||
+                            (resp instanceof Response && !((resp === null || resp === void 0 ? void 0 : resp.getCode()) >= 200 && (resp === null || resp === void 0 ? void 0 : resp.getCode()) < 300))) {
+                            // response with failures or fail hard at first
+                            if (this.allowFailure)
+                                failureIDs.push(message.messageId);
+                            else
+                                return resp;
+                        }
+                    }
+                    // not errored and loop ended - succeeded (might have failures)
+                    if (this.allowFailure)
+                        return {
+                            batchItemFailures: failureIDs.map(id => ({ itemIdentifier: id })),
+                        };
+                    return Response.SuccessResponse(null);
+                }));
+            }
+            else
+                return Response.BadRequestResponse(Globals.ErrorResponseNoRecords, Globals.ErrorCode_NoRecords); // no event to be processed?
+        });
+    }
+}
+//# sourceMappingURL=EventProcessor.js.map

package/dist/src/BaseEvent/EventProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventProcessor.js","sourceRoot":"","sources":["../../../src/BaseEvent/EventProcessor.ts"],"names":[],"mappings":";;;;;;;;;AAEA,OAAO,WAAkC,MAAM,kBAAkB,CAAA;AACjE,OAAO,QAA+B,MAAM,oBAAoB,CAAA;AAChE,OAAO,OAAO,MAAM,eAAe,CAAA;AACnC,OAAO,KAAK,MAAM,kBAAkB,CAAA;AAapC;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,cAAc;IAoBjC;;;;;;;OAOG;IACH,YACE,KAAe,EACf,OAAgB,EAChB,MAA0B,EAC1B,YAAsB;QAEtB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,EAAE,CAAA;QAC1B,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,YAAY,CAAA;IACpC,CAAC;IAED;;;;;;OAMG;IACU,YAAY,CACvB,SAAqD,EACrD,kBAA4B;;YAE5B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC,CAAC,kBAAkB,CAAC,CAAA;YACxE,IACE,CAAC,IAAI,CAAC,YAAY;gBAClB,IAAI;gBACJ,IAAI,YAAY,QAAQ;gBACxB,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,GAAG,IAAI,IAAI,CAAC,OAAO,EAAE,GAAG,GAAG,CAAC;gBAEhD,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;iBAClD,IAAI,IAAI;gBAAE,OAAO,IAAI,CAAA;YAC1B,OAAO,IAAI,CAAA;QACb,CAAC;KAAA;IAED;;;;;OAKG;IACW,eAAe,CAC3B,SAAqD,EACrD,kBAA2B;;;YAE3B,+BAA+B;YAC/B,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxD,sEAAsE;gBACtE,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,YAAY,CAAA;oBAAE,MAAM,KAAK,CAAC,oBAAoB,EAAE,CAAA;gBAClE,mCAAmC;gBACnC,OAAO,MAAM,IAAI,WAAW,CAAqC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,kCACpF,IAAI,CAAC,MAAM,KACd,UAAU,EAAE,IAAI,IAChB,CAAC,OAAO,CAAC,CAAM,WAAW,EAAC,EAAE;oBAC7B,iDAAiD;oBACjD,MAAM,cAAc,GAAwB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAC/E,kBAAkB,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CACrE,CAAA;oBAED,2BAA2B;oBAC3B,MAAM,UAAU,GAAkB,EAAE,CAAA;oBACpC,KAAK,MAAM,cAAc,IAAI,cAAc,EAAE,CAAC;wBAC5C,MAAM,WAAW,GAAG,cAAc,CAAC,cAAc,CAAC,CAAA;wBAClD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;wBAClD,iBAAiB;wBACjB,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC,CAAA;wBACtD,oBAAoB;wBACpB,IACE,CAAC,IAAI;4BACL,CAAC,IAAI,YAAY,QAAQ,IAAI,CAAC,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,KAAI,GAAG,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,EAAE,IAAG,GAAG,CAAC,CAAC,EAChF,CAAC;4BACD,+CAA+C;4BAC/C,IAAI,IAAI,CAAC,YAAY;gCAAE,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;;gCACpD,OAAO,IAAI,CAAA;wBAClB,CAAC;oBACH,CAAC;oBACD,+DAA+D;oBAC/D,IAAI,IAAI,CAAC,YAAY;wBACnB,OAAO;4BACL,iBAAiB,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC,CAAC;yBAClE,CAAA;oBACH,OAAO,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,CAAA;gBACvC,CAAC,CAAA,CAAC,CAAA;YACJ,CAAC;;gBACC,OAAO,QAAQ,CAAC,kBAAkB,CAChC,OAAO,CAAC,sBAAsB,EAC9B,OAAO,CAAC,mBAAmB,CAC5B,CAAA,CAAC,4BAA4B;QAClC,CAAC;KAAA;CACF"}

package/dist/src/BaseEvent/Process.d.ts

@@ -0,0 +1,50 @@
+import { TransactionConfig } from './Transaction.js';
+import Logger from '../Logger/Logger.js';
+import Publisher from '../Publisher/Publisher.js';
+/**
+ * A type that represents a modified version of the TransactionConfig type, excluding the 'throwOnErrors' and 'syncReturn' properties.
+ */
+export type ProcessConfig = Omit<TransactionConfig, 'throwOnErrors' | 'syncReturn'>;
+/**
+ * Represents a long-running process that executes a given function at a specified interval.
+ */
+export default class Process {
+    /**
+     * Private member variable representing the interval value.
+     * @type {number}
+     * @private
+     */
+    private interval;
+    /**
+     * A logger object used for logging messages, errors, and other information.
+     * @readonly
+     */
+    readonly logger: Logger;
+    /**
+     * The publisher of the content.
+     */
+    readonly publisher: Publisher;
+    /**
+     * A reference to the NodeJS.Timeout object representing the interval timer.
+     */
+    timeout: NodeJS.Timeout;
+    /**
+     * Constructs a new instance of the LongRunningProcess class.
+     * @param {ProcessConfig} config - The configuration object for the process.
+     * @param {number} interval - The interval at which the process should run.
+     * @returns None
+     */
+    constructor(config: ProcessConfig, interval: number);
+    /**
+     * Executes the provided execution function at a specified interval.
+     * @param {Function} executionFunc - The function to execute.
+     * @returns None
+     */
+    execute(executionFunc: any): Promise<void>;
+    /**
+     * Executes the given execution function asynchronously and handles any exceptions that occur.
+     * @param {Function} executionFunc - The function to execute.
+     * @returns {boolean} - Returns true if the execution failed, false otherwise.
+     */
+    private iexecute;
+}