@othree.io/stethoscope 1.0.0

package/.gitlab-ci.yml

@@ -0,0 +1,29 @@
+image: node:14-alpine
+
+cache:
+  key: ${CI_PIPELINE_ID}
+  paths:
+    - node_modules/
+    - lib/
+
+build:
+  stage: build
+  script:
+    - npm install && npm run build
+
+test:
+  stage: test
+  script:
+    - npm test
+
+deploy:
+  image: node:20
+  stage: deploy
+  variables:
+    NPM_CONFIG_USERCONFIG: '$CI_PROJECT_DIR/.npmrc'
+  script:
+    - cat $NPM > .npmrc
+    - npx semantic-release
+  only:
+    refs:
+      - main

package/README.md

@@ -0,0 +1 @@
+# stethoscope

package/lib/aws.d.ts

@@ -0,0 +1,107 @@
+/** @module sqs */
+import { SQSBatchResponse, SQSEvent, SQSRecord } from 'aws-lambda';
+import { Optional } from '@othree.io/optional';
+import { GetProcessResults, ProcessResultAction, ProcessResults } from './results-processor';
+import { ChangeMessageVisibilityTimeoutRequest, GetQueueUrlInput, QueueUrlOutput } from '@othree.io/awsome/lib/sqs';
+/**
+ * A unique symbol representing no group.
+ */
+export declare const NoGroupSymbol: unique symbol;
+/**
+ * Type definition for a function that processes input and returns a promise of an optional output.
+ * @template Input, Output
+ * @typedef {Function}
+ * @param {Input} input - The input to process.
+ * @returns {Promise<Optional<Output>>}
+ */
+export type RunProcess<Input, Output> = (input: Input) => Promise<Optional<Output>>;
+/**
+ * Type definition for a key, which can be a string or a symbol.
+ * @typedef {string | symbol} Key
+ */
+export type Key = string | symbol;
+/**
+ * Interface representing the result of a message processing.
+ * @template Input, Output
+ * @interface
+ */
+export interface MessageResult<Input, Output> {
+    readonly message: SQSRecord;
+    readonly result: ProcessResults<Input, Output>;
+}
+/**
+ * Type definition for the results of processing messages, grouped by action.
+ * @template Input, Output
+ * @typedef {Object.<ProcessResultAction, Array<MessageResult<Input, Output>>>} Results
+ */
+export type Results<Input, Output> = {
+    readonly [key in ProcessResultAction]: Array<MessageResult<Input, Output>>;
+};
+/**
+ * Interface representing the grouped results of processing messages.
+ * @template Input, Output
+ * @interface
+ */
+export interface GroupResults<Input, Output> {
+    readonly group: Key;
+    readonly results: Results<Input, Output>;
+}
+/**
+ * Type definition for grouped records.
+ * @typedef {Record<Key, Array<SQSRecord>>} GroupedRecords
+ */
+export type GroupedRecords = Record<Key, Array<SQSRecord>>;
+/**
+ * Groups SQS records by their MessageGroupId attribute.
+ * @param {Array<SQSRecord>} records - The SQS records to group.
+ * @returns {GroupedRecords} The grouped records.
+ */
+export declare const groupRecords: (records: Array<SQSRecord>) => GroupedRecords;
+/**
+ * Processes an SQS event.
+ * @template Input, Output
+ * @param {RunProcess<Input, Output>} process - The process function.
+ * @returns A function that takes groupRecords, getProcessInput, getProcessResults and returns a function that processes an SQS event.
+ */
+export declare const processSQSEvent: <Input, Output>(process: RunProcess<Input, Output>) => (groupRecords: (records: Array<SQSRecord>) => GroupedRecords) => (getProcessInput: RunProcess<SQSRecord, Input>) => (getProcessResults: GetProcessResults<Input, Output>) => (event: SQSEvent) => Promise<Array<GroupResults<Input, Output>>>;
+/**
+ * Handles exponential backoff for message visibility timeout changes.
+ * @param {Function} changeMessageVisibility - Function to change message visibility timeout.
+ * @returns {Function} A function that takes timeouts and returns a function to handle exponential backoff.
+ */
+export declare const handleExponentialBackoff: (changeMessageVisibility: (request: ChangeMessageVisibilityTimeoutRequest) => Promise<Optional<true>>) => (getQueueUrl: (input: GetQueueUrlInput) => QueueUrlOutput) => (timeouts: Array<number>) => <Input, Output>(groupResults: Array<GroupResults<Input, Output>>) => Promise<Array<GroupResults<Input, Output>>>;
+/**
+ * Represents an error message.
+ * @interface
+ * @template Input - The input type for the process.
+ */
+export interface ErrorMessage<Input> {
+    readonly request: Input;
+    readonly error: {
+        readonly name: string;
+        readonly message: string;
+        readonly stack?: string;
+    };
+}
+/**
+ * Handles errors by notifying with the provided notifyError function.
+ * @template Input, Output
+ * @param {Function} notifyError - Function to notify about the error.
+ * @returns {Function} A function to handle errors.
+ */
+export declare const handleErrors: <Input, Output>(notifyError: (payload: ErrorMessage<SQSRecord>) => Promise<Optional<boolean>>) => (groupResults: Array<GroupResults<Input, Output>>) => Promise<Array<GroupResults<Input, Output>>>;
+/**
+ * Converts group results to an SQS batch response.
+ * @template Input, Output
+ * @param {Array<GroupResults<Input, Output>>} groupResults - The group results.
+ * @returns {Promise<SQSBatchResponse>} The SQS batch response.
+ */
+export declare const toSQSBatchResponse: <Input, Output>(groupResults: Array<GroupResults<Input, Output>>) => Promise<SQSBatchResponse>;
+/**
+ * Processes an SQS event and handles results including exponential backoff and errors.
+ * @template Input, Output
+ * @param {Function} processSQSEvent - Function to process the SQS event.
+ * @returns {Function} A function that takes handlers and returns a function to process the SQS event and handle results.
+ */
+export declare const processSQSEventAndHandleResults: <Input, Output>(processSQSEvent: (event: SQSEvent) => Promise<Array<GroupResults<Input, Output>>>) => (handleExponentialBackoff: (groupResults: Array<GroupResults<Input, Output>>) => Promise<Array<GroupResults<Input, Output>>>) => (handleErrors: (groupResults: Array<GroupResults<Input, Output>>) => Promise<Array<GroupResults<Input, Output>>>) => (toSQSBatchResponse: (groupResults: Array<GroupResults<Input, Output>>) => Promise<SQSBatchResponse>) => (event: SQSEvent) => Promise<SQSBatchResponse>;
+//# sourceMappingURL=aws.d.ts.map

package/lib/aws.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"aws.d.ts","sourceRoot":"","sources":["../src/aws.ts"],"names":[],"mappings":"AAAA,kBAAkB;AAClB,OAAO,EAAC,gBAAgB,EAAE,QAAQ,EAAE,SAAS,EAAC,MAAM,YAAY,CAAA;AAChE,OAAO,EAAC,QAAQ,EAAC,MAAM,qBAAqB,CAAA;AAE5C,OAAO,EACH,iBAAiB,EAEjB,mBAAmB,EACnB,cAAc,EACjB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EACH,qCAAqC,EAErC,gBAAgB,EAChB,cAAc,EACjB,MAAM,2BAA2B,CAAA;AAElC;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,OAAO,MAAgC,CAAA;AAQnE;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAA;AAEnF;;;GAGG;AACH,MAAM,MAAM,GAAG,GAAG,MAAM,GAAG,MAAM,CAAA;AAEjC;;;;GAIG;AACH,MAAM,WAAW,aAAa,CAAC,KAAK,EAAE,MAAM;IACxC,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAA;IAC3B,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;CACjD;AAED;;;;GAIG;AACH,MAAM,MAAM,OAAO,CAAC,KAAK,EAAE,MAAM,IAAI;IACjC,QAAQ,EAAE,GAAG,IAAI,mBAAmB,GAAG,KAAK,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;CAC7E,CAAA;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY,CAAC,KAAK,EAAE,MAAM;IACvC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAA;IACnB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;CAC3C;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAA;AAQ1D;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,SAAS,KAAK,CAAC,SAAS,CAAC,KAAG,cAaxD,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAAI,KAAK,EAAE,MAAM,EAAE,SAAS,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,MAC5E,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,cAAc,MACvD,iBAAiB,UAAU,CAAC,SAAS,EAAE,KAAK,CAAC,MACzC,mBAAmB,iBAAiB,CAAC,KAAK,EAAE,MAAM,CAAC,MACzC,OAAO,QAAQ,KAAG,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAwFlE,CAAA;AAEjB;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,GAAI,yBAAyB,CAAC,OAAO,EAAE,qCAAqC,KAAK,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,MACxI,aAAa,CAAC,KAAK,EAAE,gBAAgB,KAAK,cAAc,MACpD,UAAU,KAAK,CAAC,MAAM,CAAC,MACb,KAAK,EAAE,MAAM,EAAE,cAAc,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,KAAG,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAmBlH,CAAA;AAEb;;;;GAIG;AACH,MAAM,WAAW,YAAY,CAAC,KAAK;IAC/B,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAA;IACvB,QAAQ,CAAC,KAAK,EAAE;QACZ,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;QACrB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;QACxB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAC1B,CAAA;CACJ;AAED;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,KAAK,EAAE,MAAM,EAAE,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,KAAK,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,MAC9G,cAAc,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,KAAG,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAenG,CAAA;AAEL;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAAU,KAAK,EAAE,MAAM,EAAE,cAAc,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,KAAG,OAAO,CAAC,gBAAgB,CAYlI,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,+BAA+B,GAAI,KAAK,EAAE,MAAM,EAAE,iBAAiB,CAAC,KAAK,EAAE,QAAQ,KAAK,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,MAC3I,0BAA0B,CAAC,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,KAAK,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,MACvH,cAAc,CAAC,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,KAAK,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,MAC3G,oBAAoB,CAAC,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,KAAK,OAAO,CAAC,gBAAgB,CAAC,MACzF,OAAO,QAAQ,KAAG,OAAO,CAAC,gBAAgB,CAKhD,CAAA"}

package/lib/aws.js

@@ -0,0 +1,195 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processSQSEventAndHandleResults = exports.toSQSBatchResponse = exports.handleErrors = exports.handleExponentialBackoff = exports.processSQSEvent = exports.groupRecords = exports.NoGroupSymbol = void 0;
+const optional_1 = require("@othree.io/optional");
+const async_1 = require("async");
+const results_processor_1 = require("./results-processor");
+/**
+ * A unique symbol representing no group.
+ */
+exports.NoGroupSymbol = Symbol('NoGroupSymbol');
+/**
+ * A constant representing the limit for parallel processing.
+ * @const {number}
+ */
+const LIMIT = 10;
+/**
+ * The initial value for grouped records.
+ * @const {Record<Key, Array<SQSRecord>>}
+ */
+const InitialValue = Object.freeze({});
+/**
+ * Groups SQS records by their MessageGroupId attribute.
+ * @param {Array<SQSRecord>} records - The SQS records to group.
+ * @returns {GroupedRecords} The grouped records.
+ */
+const groupRecords = (records) => {
+    const groupedRecords = records.reduce(((acum, current) => {
+        const key = (0, optional_1.Optional)(current.attributes.MessageGroupId).orElse(exports.NoGroupSymbol);
+        return {
+            ...acum,
+            [key]: (0, optional_1.Optional)(acum[key])
+                .map(_ => [..._, current])
+                .orElse([current]),
+        };
+    }), InitialValue);
+    return groupedRecords;
+};
+exports.groupRecords = groupRecords;
+/**
+ * Processes an SQS event.
+ * @template Input, Output
+ * @param {RunProcess<Input, Output>} process - The process function.
+ * @returns A function that takes groupRecords, getProcessInput, getProcessResults and returns a function that processes an SQS event.
+ */
+const processSQSEvent = (process) => (groupRecords) => (getProcessInput) => (getProcessResults) => async (event) => {
+    const groupedRecords = groupRecords(event.Records);
+    const groupedResults = await (0, async_1.mapLimit)(Reflect.ownKeys(groupedRecords), LIMIT, async (key) => {
+        const values = groupedRecords[key];
+        const initialResults = {
+            [results_processor_1.ProcessResultAction.none]: [],
+            [results_processor_1.ProcessResultAction.failure]: [],
+            [results_processor_1.ProcessResultAction.success]: [],
+            [results_processor_1.ProcessResultAction.retry]: []
+        };
+        const processResults = await (0, async_1.reduce)(values, initialResults, async (acum, current) => {
+            const maybeInput = await getProcessInput(current);
+            if (maybeInput.isEmpty) {
+                const processResult = {
+                    request: undefined,
+                    action: results_processor_1.ProcessResultAction.failure,
+                    result: undefined,
+                    error: new Error('Failed to get input'),
+                };
+                const messageResult = {
+                    message: current,
+                    result: processResult,
+                };
+                const results = {
+                    ...acum,
+                    [processResult.action]: [...acum[processResult.action], messageResult],
+                };
+                return results;
+            }
+            const input = maybeInput.get();
+            /*
+                if it is an actual grouped message it means it's a fifo queue and
+                if there's already a message for retry (retry action) on a previous message
+                then next messages need to be retried.
+                Return retry so that the message is placed back into the queue
+             */
+            if (key !== exports.NoGroupSymbol && acum.retry.length > 0) {
+                const messageResult = {
+                    message: current,
+                    result: {
+                        request: maybeInput.orElse(undefined),
+                        action: results_processor_1.ProcessResultAction.retry,
+                        result: undefined,
+                        error: undefined,
+                    },
+                };
+                const results = {
+                    ...acum,
+                    [messageResult.result.action]: [...acum[messageResult.result.action], messageResult],
+                };
+                return results;
+            }
+            const processResult = await process(input)
+                .then(maybeResult => getProcessResults(input, maybeResult));
+            const messageResult = {
+                message: current,
+                result: processResult,
+            };
+            const results = {
+                ...acum,
+                [processResult.action]: [...acum[processResult.action], messageResult],
+            };
+            return results;
+        });
+        const groupResults = {
+            group: key,
+            results: processResults,
+        };
+        return groupResults;
+    });
+    return groupedResults;
+};
+exports.processSQSEvent = processSQSEvent;
+/**
+ * Handles exponential backoff for message visibility timeout changes.
+ * @param {Function} changeMessageVisibility - Function to change message visibility timeout.
+ * @returns {Function} A function that takes timeouts and returns a function to handle exponential backoff.
+ */
+const handleExponentialBackoff = (changeMessageVisibility) => (getQueueUrl) => (timeouts) => async (groupResults) => {
+    await Promise.allSettled(groupResults.map(async (results) => {
+        await (0, async_1.forEachSeries)(results.results.retry, async (messageResult) => {
+            const receiveCount = Number(messageResult.message.attributes.ApproximateReceiveCount);
+            const timeoutIndex = receiveCount - 1 >= timeouts.length ? timeouts.length - 1 : receiveCount - 1;
+            const visibilityTimeout = timeouts[timeoutIndex];
+            await changeMessageVisibility({
+                receiptHandle: messageResult.message.receiptHandle,
+                queue: getQueueUrl({
+                    queueArn: messageResult.message.eventSourceARN
+                }).queueUrl,
+                timeout: visibilityTimeout,
+            });
+        });
+    }));
+    return groupResults;
+};
+exports.handleExponentialBackoff = handleExponentialBackoff;
+/**
+ * Handles errors by notifying with the provided notifyError function.
+ * @template Input, Output
+ * @param {Function} notifyError - Function to notify about the error.
+ * @returns {Function} A function to handle errors.
+ */
+const handleErrors = (notifyError) => async (groupResults) => {
+    await Promise.allSettled(groupResults.map(async (results) => {
+        await (0, async_1.forEachSeries)(results.results.failure, async (messageResult) => {
+            await notifyError({
+                request: messageResult.message,
+                error: {
+                    message: messageResult.result.error.message,
+                    name: messageResult.result.error.name,
+                    stack: messageResult.result.error.stack,
+                },
+            });
+        });
+    }));
+    return groupResults;
+};
+exports.handleErrors = handleErrors;
+/**
+ * Converts group results to an SQS batch response.
+ * @template Input, Output
+ * @param {Array<GroupResults<Input, Output>>} groupResults - The group results.
+ * @returns {Promise<SQSBatchResponse>} The SQS batch response.
+ */
+const toSQSBatchResponse = async (groupResults) => {
+    const response = {
+        batchItemFailures: groupResults.map(_ => _.results.retry)
+            .flat()
+            .map(_ => {
+            return {
+                itemIdentifier: _.message.receiptHandle,
+            };
+        }),
+    };
+    return response;
+};
+exports.toSQSBatchResponse = toSQSBatchResponse;
+/**
+ * Processes an SQS event and handles results including exponential backoff and errors.
+ * @template Input, Output
+ * @param {Function} processSQSEvent - Function to process the SQS event.
+ * @returns {Function} A function that takes handlers and returns a function to process the SQS event and handle results.
+ */
+const processSQSEventAndHandleResults = (processSQSEvent) => (handleExponentialBackoff) => (handleErrors) => (toSQSBatchResponse) => async (event) => {
+    return processSQSEvent(event)
+        .then(handleErrors)
+        .then(handleExponentialBackoff)
+        .then(toSQSBatchResponse);
+};
+exports.processSQSEventAndHandleResults = processSQSEventAndHandleResults;
+//# sourceMappingURL=aws.js.map

package/lib/aws.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aws.js","sourceRoot":"","sources":["../src/aws.ts"],"names":[],"mappings":";;;AAEA,kDAA4C;AAC5C,iCAAqD;AACrD,2DAK4B;AAQ5B;;GAEG;AACU,QAAA,aAAa,GAAkB,MAAM,CAAC,eAAe,CAAC,CAAA;AAEnE;;;GAGG;AACH,MAAM,KAAK,GAAG,EAAE,CAAA;AAoDhB;;;GAGG;AACH,MAAM,YAAY,GAAkC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;AAErE;;;;GAIG;AACI,MAAM,YAAY,GAAG,CAAC,OAAyB,EAAkB,EAAE;IACtE,MAAM,cAAc,GAAmB,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;QACrE,MAAM,GAAG,GAAG,IAAA,mBAAQ,EAAM,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,qBAAa,CAAC,CAAA;QAElF,OAAO;YACH,GAAG,IAAI;YACP,CAAC,GAAG,CAAC,EAAE,IAAA,mBAAQ,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;iBACrB,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;iBACzB,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC;SACzB,CAAA;IACL,CAAC,CAAC,EAAE,YAAY,CAAC,CAAA;IAEjB,OAAO,cAAc,CAAA;AACzB,CAAC,CAAA;AAbY,QAAA,YAAY,gBAaxB;AAED;;;;;GAKG;AACI,MAAM,eAAe,GAAG,CAAgB,OAAkC,EAAE,EAAE,CACjF,CAAC,YAA2D,EAAE,EAAE,CAC5D,CAAC,eAA6C,EAAE,EAAE,CAC9C,CAAC,iBAAmD,EAAE,EAAE,CACpD,KAAK,EAAE,KAAe,EAA+C,EAAE;IAEnE,MAAM,cAAc,GAAG,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IAElD,MAAM,cAAc,GAAG,MAAM,IAAA,gBAAQ,EAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,GAAQ,EAAE,EAAE;QAC7F,MAAM,MAAM,GAAG,cAAc,CAAC,GAAG,CAAC,CAAA;QAElC,MAAM,cAAc,GAA2B;YAC3C,CAAC,uCAAmB,CAAC,IAAI,CAAC,EAAE,EAAE;YAC9B,CAAC,uCAAmB,CAAC,OAAO,CAAC,EAAE,EAAE;YACjC,CAAC,uCAAmB,CAAC,OAAO,CAAC,EAAE,EAAE;YACjC,CAAC,uCAAmB,CAAC,KAAK,CAAC,EAAE,EAAE;SAClC,CAAA;QACD,MAAM,cAAc,GAAG,MAAM,IAAA,cAAM,EAAC,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,IAA4B,EAAE,OAAkB,EAAE,EAAE;YACnH,MAAM,UAAU,GAAG,MAAM,eAAe,CAAC,OAAO,CAAC,CAAA;YAEjD,IAAI,UAAU,CAAC,OAAO,EAAE,CAAC;gBACrB,MAAM,aAAa,GAA8D;oBAC7E,OAAO,EAAE,SAAU;oBACnB,MAAM,EAAE,uCAAmB,CAAC,OAAO;oBACnC,MAAM,EAAE,SAAS;oBACjB,KAAK,EAAE,IAAI,KAAK,CAAC,qBAAqB,CAAC;iBAC1C,CAAA;gBAED,MAAM,aAAa,GAAiC;oBAChD,OAAO,EAAE,OAAO;oBAChB,MAAM,EAAE,aAAa;iBACxB,CAAA;gBAED,MAAM,OAAO,GAA2B;oBACpC,GAAG,IAAI;oBACP,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC;iBACzE,CAAA;gBAED,OAAO,OAAO,CAAA;YAClB,CAAC;YAED,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAA;YAE9B;;;;;eAKG;YACH,IAAI,GAAG,KAAK,qBAAa,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACjD,MAAM,aAAa,GAAiC;oBAChD,OAAO,EAAE,OAAO;oBAChB,MAAM,EAAE;wBACJ,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,SAAU,CAAC;wBACtC,MAAM,EAAE,uCAAmB,CAAC,KAAK;wBACjC,MAAM,EAAE,SAAS;wBACjB,KAAK,EAAE,SAAS;qBACnB;iBACJ,CAAA;gBAED,MAAM,OAAO,GAA2B;oBACpC,GAAG,IAAI;oBACP,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC;iBACvF,CAAA;gBAED,OAAO,OAAO,CAAA;YAClB,CAAC;YAED,MAAM,aAAa,GAAkC,MAAM,OAAO,CAAC,KAAK,CAAC;iBACpE,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,iBAAiB,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAA;YAE/D,MAAM,aAAa,GAAiC;gBAChD,OAAO,EAAE,OAAO;gBAChB,MAAM,EAAE,aAAa;aACxB,CAAA;YAED,MAAM,OAAO,GAA2B;gBACpC,GAAG,IAAI;gBACP,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC;aACzE,CAAA;YAED,OAAO,OAAO,CAAA;QAClB,CAAC,CAAC,CAAA;QAEF,MAAM,YAAY,GAAgC;YAC9C,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,cAAc;SAC1B,CAAA;QACD,OAAO,YAAY,CAAA;IACvB,CAAC,CAAC,CAAA;IAEF,OAAO,cAAc,CAAA;AACzB,CAAC,CAAA;AA5FJ,QAAA,eAAe,mBA4FX;AAEjB;;;;GAIG;AACI,MAAM,wBAAwB,GAAG,CAAC,uBAAoG,EAAE,EAAE,CAC7I,CAAC,WAAwD,EAAE,EAAE,CACzD,CAAC,QAAuB,EAAE,EAAE,CACxB,KAAK,EAAiB,YAAgD,EAA+C,EAAE;IACnH,MAAM,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAC,OAAO,EAAC,EAAE;QACtD,MAAM,IAAA,qBAAa,EAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,EAAC,aAAa,EAAC,EAAE;YAC7D,MAAM,YAAY,GAAG,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,UAAU,CAAC,uBAAuB,CAAC,CAAA;YACrF,MAAM,YAAY,GAAG,YAAY,GAAG,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,GAAG,CAAC,CAAA;YAEjG,MAAM,iBAAiB,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAA;YAEhD,MAAM,uBAAuB,CAAC;gBAC1B,aAAa,EAAE,aAAa,CAAC,OAAO,CAAC,aAAa;gBAClD,KAAK,EAAE,WAAW,CAAC;oBACf,QAAQ,EAAE,aAAa,CAAC,OAAO,CAAC,cAAc;iBACjD,CAAC,CAAC,QAAQ;gBACX,OAAO,EAAE,iBAAiB;aAC7B,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;IACN,CAAC,CAAC,CAAC,CAAA;IAEH,OAAO,YAAY,CAAA;AACvB,CAAC,CAAA;AAtBA,QAAA,wBAAwB,4BAsBxB;AAgBb;;;;;GAKG;AACI,MAAM,YAAY,GAAG,CAAgB,WAA6E,EAAE,EAAE,CACzH,KAAK,EAAE,YAAgD,EAA+C,EAAE;IACpG,MAAM,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAC,OAAO,EAAC,EAAE;QACtD,MAAM,IAAA,qBAAa,EAAC,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,EAAC,aAAa,EAAC,EAAE;YAC/D,MAAM,WAAW,CAAC;gBACd,OAAO,EAAE,aAAa,CAAC,OAAO;gBAC9B,KAAK,EAAE;oBACH,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,KAAM,CAAC,OAAO;oBAC5C,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,KAAM,CAAC,IAAI;oBACtC,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,KAAM,CAAC,KAAK;iBAC3C;aACJ,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;IACN,CAAC,CAAC,CAAC,CAAA;IAEH,OAAO,YAAY,CAAA;AACvB,CAAC,CAAA;AAhBQ,QAAA,YAAY,gBAgBpB;AAEL;;;;;GAKG;AACI,MAAM,kBAAkB,GAAG,KAAK,EAAiB,YAAgD,EAA6B,EAAE;IACnI,MAAM,QAAQ,GAAqB;QAC/B,iBAAiB,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;aACpD,IAAI,EAAE;aACN,GAAG,CAAC,CAAC,CAAC,EAAE;YACL,OAAO;gBACH,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa;aAC1C,CAAA;QACL,CAAC,CAAC;KACT,CAAA;IAED,OAAO,QAAQ,CAAA;AACnB,CAAC,CAAA;AAZY,QAAA,kBAAkB,sBAY9B;AAED;;;;;GAKG;AACI,MAAM,+BAA+B,GAAG,CAAgB,eAAiF,EAAE,EAAE,CAChJ,CAAC,wBAA2H,EAAE,EAAE,CAC5H,CAAC,YAA+G,EAAE,EAAE,CAChH,CAAC,kBAAmG,EAAE,EAAE,CACpG,KAAK,EAAE,KAAe,EAA6B,EAAE;IACjD,OAAO,eAAe,CAAC,KAAK,CAAC;SACxB,IAAI,CAAC,YAAY,CAAC;SAClB,IAAI,CAAC,wBAAwB,CAAC;SAC9B,IAAI,CAAC,kBAAkB,CAAC,CAAA;AACjC,CAAC,CAAA;AATJ,QAAA,+BAA+B,mCAS3B"}

package/lib/index.d.ts

@@ -0,0 +1,21 @@
+import { RunProcess } from './aws';
+import { SQSRecord } from 'aws-lambda';
+import { LoggingProps } from '@othree.io/journal';
+export * from './results-processor';
+export * as aws from './aws';
+/**
+ * Interface representing the configuration for an SQS Process.
+ * @interface
+ */
+export interface SQSProcessConfiguration {
+    readonly dlqUrl: string;
+    readonly exponentialTimeouts: Array<number>;
+}
+type Log = <Input, Output>(fn: (...args: Input[]) => Promise<Output>) => (context: string, loggingProps?: LoggingProps) => (...args: Input[]) => Promise<Output>;
+/**
+ * Processes SQS messages with the given configuration and handlers.
+ * @param {SQSProcessConfiguration} configuration - The SQS configuration.
+ * @returns {Function} A function that takes a didItFail function and returns a function to process SQS events.
+ */
+export declare const processSqs: (log?: Log) => (configuration: SQSProcessConfiguration) => (didItFail: (error: Error) => boolean) => <Input, Output>(runProcess: RunProcess<Input, Output>) => (getProcessInput: RunProcess<SQSRecord, Input>) => (...args: import("aws-lambda").SQSEvent[]) => Promise<import("aws-lambda").SQSBatchResponse>;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAMH,UAAU,EACb,MAAM,OAAO,CAAA;AACd,OAAO,EAAC,SAAS,EAAC,MAAM,YAAY,CAAA;AAKpC,OAAO,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAA;AAG/C,cAAc,qBAAqB,CAAA;AACnC,OAAO,KAAK,GAAG,MAAM,OAAO,CAAA;AAE5B;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACpC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,mBAAmB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;CAC9C;AAED,KAAK,GAAG,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY,KAAK,CAAC,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;AAChK;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,MAAM,GAAG,MAC/B,eAAe,uBAAuB,MAClC,WAAW,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,MAChC,KAAK,EAAE,MAAM,EAAE,YAAY,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,MAChD,iBAAiB,UAAU,CAAC,SAAS,EAAE,KAAK,CAAC,iGA2B7C,CAAA"}

package/lib/index.js

@@ -0,0 +1,54 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processSqs = exports.aws = void 0;
+const aws_1 = require("./aws");
+const results_processor_1 = require("./results-processor");
+const client_sqs_1 = require("@aws-sdk/client-sqs");
+const awsome_1 = require("@othree.io/awsome");
+const optional_1 = require("@othree.io/optional");
+const sqs_1 = require("@othree.io/awsome/lib/sqs");
+__exportStar(require("./results-processor"), exports);
+exports.aws = require("./aws");
+/**
+ * Processes SQS messages with the given configuration and handlers.
+ * @param {SQSProcessConfiguration} configuration - The SQS configuration.
+ * @returns {Function} A function that takes a didItFail function and returns a function to process SQS events.
+ */
+const processSqs = (log) => (configuration) => (didItFail) => (runProcess) => (getProcessInput) => {
+    const maybeLog = (0, optional_1.Optional)(log);
+    const processSQSEventFn = maybeLog
+        .map(_ => _((0, aws_1.processSQSEvent)(runProcess)(aws_1.groupRecords)(getProcessInput)((0, results_processor_1.getProcessResults)(didItFail)))('processSQSEvent'))
+        .orElse((0, aws_1.processSQSEvent)(runProcess)(aws_1.groupRecords)(getProcessInput)((0, results_processor_1.getProcessResults)(didItFail)));
+    const sqsClient = new client_sqs_1.SQSClient({});
+    const changeMessageVisibilityTimeout = maybeLog
+        .map(_ => _(awsome_1.sqs.changeMessageVisibilityTimeout(sqsClient))('changeMessageVisibilityTimeout'))
+        .orElse(awsome_1.sqs.changeMessageVisibilityTimeout(sqsClient));
+    const handleExponentialBackoffFn = maybeLog
+        .map(_ => _((0, aws_1.handleExponentialBackoff)(changeMessageVisibilityTimeout)(sqs_1.getQueueUrl)(configuration.exponentialTimeouts))('handleExponentialBackoff'))
+        .orElse((0, aws_1.handleExponentialBackoff)(changeMessageVisibilityTimeout)(sqs_1.getQueueUrl)(configuration.exponentialTimeouts));
+    const sendDLQMessage = awsome_1.sqs.send(sqsClient, {
+        QueueUrl: configuration.dlqUrl,
+    })()()()();
+    const handleErrorsFn = maybeLog
+        .map(_ => _((0, aws_1.handleErrors)(sendDLQMessage))('handleErrors'))
+        .orElse((0, aws_1.handleErrors)(sendDLQMessage));
+    return maybeLog
+        .map(_ => _((0, aws_1.processSQSEventAndHandleResults)(processSQSEventFn)(handleExponentialBackoffFn)(handleErrorsFn)(aws_1.toSQSBatchResponse))('processSQSEventAndHandleResults'))
+        .orElse((0, aws_1.processSQSEventAndHandleResults)(processSQSEventFn)(handleExponentialBackoffFn)(handleErrorsFn)(aws_1.toSQSBatchResponse));
+};
+exports.processSqs = processSqs;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,+BAOc;AAEd,2DAAqD;AACrD,oDAA6C;AAC7C,8CAAqC;AACrC,kDAA4C;AAE5C,mDAAqD;AAErD,sDAAmC;AACnC,+BAA4B;AAY5B;;;;GAIG;AACI,MAAM,UAAU,GAAG,CAAC,GAAS,EAAE,EAAE,CACpC,CAAC,aAAsC,EAAE,EAAE,CACvC,CAAC,SAAoC,EAAE,EAAE,CACrC,CAAgB,UAAqC,EAAE,EAAE,CACrD,CAAC,eAA6C,EAAE,EAAE;IAC9C,MAAM,QAAQ,GAAG,IAAA,mBAAQ,EAAC,GAAG,CAAC,CAAA;IAC9B,MAAM,iBAAiB,GAAG,QAAQ;SAC7B,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAA,qBAAe,EAAgB,UAAU,CAAC,CAAC,kBAAY,CAAC,CAAC,eAAe,CAAC,CAAC,IAAA,qCAAiB,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC;SACvI,MAAM,CAAC,IAAA,qBAAe,EAAgB,UAAU,CAAC,CAAC,kBAAY,CAAC,CAAC,eAAe,CAAC,CAAC,IAAA,qCAAiB,EAAC,SAAS,CAAC,CAAC,CAAC,CAAA;IAEpH,MAAM,SAAS,GAAG,IAAI,sBAAS,CAAC,EAAE,CAAC,CAAA;IAEnC,MAAM,8BAA8B,GAAG,QAAQ;SAC1C,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAG,CAAC,8BAA8B,CAAC,SAAS,CAAC,CAAC,CAAC,gCAAgC,CAAC,CAAC;SAC5F,MAAM,CAAC,YAAG,CAAC,8BAA8B,CAAC,SAAS,CAAC,CAAC,CAAA;IAE1D,MAAM,0BAA0B,GAAG,QAAQ;SACtC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAA,8BAAwB,EAAC,8BAA8B,CAAC,CAAC,iBAAW,CAAC,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC;SACjJ,MAAM,CAAC,IAAA,8BAAwB,EAAC,8BAA8B,CAAC,CAAC,iBAAW,CAAC,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC,CAAA;IAErH,MAAM,cAAc,GAAG,YAAG,CAAC,IAAI,CAAC,SAAS,EAAE;QACvC,QAAQ,EAAE,aAAa,CAAC,MAAM;KACjC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAA;IAEV,MAAM,cAAc,GAAG,QAAQ;SAC1B,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAA,kBAAY,EAAgB,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;SACxE,MAAM,CAAC,IAAA,kBAAY,EAAgB,cAAc,CAAC,CAAC,CAAA;IAExD,OAAO,QAAQ;SACV,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAA,qCAA+B,EAAgB,iBAAiB,CAAC,CAAC,0BAAiC,CAAC,CAAC,cAAc,CAAC,CAAC,wBAAkB,CAAC,CAAC,CAAC,iCAAiC,CAAC,CAAC;SACxL,MAAM,CAAC,IAAA,qCAA+B,EAAgB,iBAAiB,CAAC,CAAC,0BAAiC,CAAC,CAAC,cAAc,CAAC,CAAC,wBAAkB,CAAC,CAAC,CAAA;AACzJ,CAAC,CAAA;AA/BJ,QAAA,UAAU,cA+BN"}

package/lib/results-processor.d.ts

@@ -0,0 +1,43 @@
+import { Optional } from '@othree.io/optional';
+/**
+ * Enumeration representing possible process result actions.
+ * @enum {string}
+ */
+export declare enum ProcessResultAction {
+    success = "success",
+    failure = "failure",
+    none = "none",
+    retry = "retry"
+}
+/**
+ * Represents the result of a process with different possible outcomes.
+ * @interface
+ * @template Input - The type of the input for the process.
+ * @template Output - The type of the output of a successful process.
+ * @template Action - The type of action representing the result's status.
+ */
+export interface ProcessResult<Input, Output, Action extends ProcessResultAction> {
+    readonly request: Input;
+    readonly action: Action;
+    readonly result: Action extends ProcessResultAction.success ? Output : void;
+    readonly error: Action extends ProcessResultAction.failure ? Error : void;
+}
+/**
+ * Represents different possible process results.
+ * @typedef {ProcessResult<Input, Output, ProcessResultAction.failure> |
+ *           ProcessResult<Input, Output, ProcessResultAction.success> |
+ *           ProcessResult<Input, Output, ProcessResultAction.none> |
+ *           ProcessResult<Input, Output, ProcessResultAction.retry> |} ProcessResults
+ * @template Input - The type of the input for the process.
+ * @template Output - The type of the output of a successful process.
+ */
+export type ProcessResults<Input, Output> = ProcessResult<Input, Output, ProcessResultAction.failure> | ProcessResult<Input, Output, ProcessResultAction.success> | ProcessResult<Input, Output, ProcessResultAction.none> | ProcessResult<Input, Output, ProcessResultAction.retry>;
+export type GetProcessResults<Input, Output> = (input: Input, maybeResult: Optional<Output>) => Promise<ProcessResults<Input, Output>>;
+/**
+ * Generates process results based on input, possible result, and error handling.
+ *
+ * @param {Function} didItFail - The input data for the process.
+ * @template Function - Generates process results based on input, possible result, and error handling.
+ */
+export declare const getProcessResults: (didItFail: (error: Error) => boolean) => <Input, Output>(input: Input, maybeResult: Optional<Output>) => Promise<ProcessResults<Input, Output>>;
+//# sourceMappingURL=results-processor.d.ts.map

package/lib/results-processor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"results-processor.d.ts","sourceRoot":"","sources":["../src/results-processor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,qBAAqB,CAAA;AAE5C;;;GAGG;AACH,oBAAY,mBAAmB;IAC3B,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,KAAK,UAAU;CAClB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,mBAAmB;IAC5E,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAA;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,SAAS,mBAAmB,CAAC,OAAO,GAAG,MAAM,GAAG,IAAI,CAAA;IAC3E,QAAQ,CAAC,KAAK,EAAE,MAAM,SAAS,mBAAmB,CAAC,OAAO,GAAG,KAAK,GAAG,IAAI,CAAA;CAC5E;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,CAAC,KAAK,EAAE,MAAM,IAAI,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,mBAAmB,CAAC,OAAO,CAAC,GAC/F,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,mBAAmB,CAAC,OAAO,CAAC,GACzD,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,mBAAmB,CAAC,IAAI,CAAC,GACtD,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAA;AAG7D,MAAM,MAAM,iBAAiB,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,CAAC,MAAM,CAAC,KAAK,OAAO,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAA;AAEtI;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,WAAW,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,MAS3D,KAAK,EAAE,MAAM,EAAE,OAAO,KAAK,EAAE,aAAa,QAAQ,CAAC,MAAM,CAAC,KAAG,OAAO,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,CA0CxG,CAAA"}

package/lib/results-processor.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProcessResults = exports.ProcessResultAction = void 0;
+/**
+ * Enumeration representing possible process result actions.
+ * @enum {string}
+ */
+var ProcessResultAction;
+(function (ProcessResultAction) {
+    ProcessResultAction["success"] = "success";
+    ProcessResultAction["failure"] = "failure";
+    ProcessResultAction["none"] = "none";
+    ProcessResultAction["retry"] = "retry";
+})(ProcessResultAction || (exports.ProcessResultAction = ProcessResultAction = {}));
+/**
+ * Generates process results based on input, possible result, and error handling.
+ *
+ * @param {Function} didItFail - The input data for the process.
+ * @template Function - Generates process results based on input, possible result, and error handling.
+ */
+const getProcessResults = (didItFail) => 
+/**
+ * Generates process results based on input, possible result, and error handling.
+ *
+ * @param {Input} input - The input data for the process.
+ * @param {Optional<Output>} maybeResult - The optional result of the process.
+ * @returns {Promise<ProcessResults<Input, Output>>} A promise resolving to process results.
+ * @template Output - The type of the output of a successful process.
+ */
+async (input, maybeResult) => {
+    return maybeResult
+        .map(result => {
+        const successfulResult = {
+            request: input,
+            action: ProcessResultAction.success,
+            result: result,
+            error: undefined,
+        };
+        return successfulResult;
+    })
+        .orMap(() => {
+        const noResult = {
+            request: input,
+            action: ProcessResultAction.none,
+            result: undefined,
+            error: undefined,
+        };
+        return noResult;
+    })
+        .catchAsync(async (error) => {
+        if (didItFail(error)) {
+            const failureResult = {
+                request: input,
+                action: ProcessResultAction.failure,
+                result: undefined,
+                error: error,
+            };
+            return failureResult;
+        }
+        const retryResult = {
+            request: input,
+            action: ProcessResultAction.retry,
+            result: undefined,
+            error: undefined,
+        };
+        return retryResult;
+    })
+        .then(_ => _.get());
+};
+exports.getProcessResults = getProcessResults;
+//# sourceMappingURL=results-processor.js.map

package/lib/results-processor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"results-processor.js","sourceRoot":"","sources":["../src/results-processor.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACH,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC3B,0CAAmB,CAAA;IACnB,0CAAmB,CAAA;IACnB,oCAAa,CAAA;IACb,sCAAe,CAAA;AACnB,CAAC,EALW,mBAAmB,mCAAnB,mBAAmB,QAK9B;AAiCD;;;;;GAKG;AACI,MAAM,iBAAiB,GAAG,CAAC,SAAoC,EAAE,EAAE;AACtE;;;;;;;GAOG;AACH,KAAK,EAAiB,KAAY,EAAE,WAA6B,EAA0C,EAAE;IACzG,OAAO,WAAW;SACb,GAAG,CAAC,MAAM,CAAC,EAAE;QACV,MAAM,gBAAgB,GAAkC;YACpD,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,mBAAmB,CAAC,OAAO;YACnC,MAAM,EAAE,MAAM;YACd,KAAK,EAAE,SAAS;SACnB,CAAA;QAED,OAAO,gBAAgB,CAAA;IAC3B,CAAC,CAAC;SACD,KAAK,CAAC,GAAG,EAAE;QACR,MAAM,QAAQ,GAAkC;YAC5C,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,mBAAmB,CAAC,IAAI;YAChC,MAAM,EAAE,SAAS;YACjB,KAAK,EAAE,SAAS;SACnB,CAAA;QACD,OAAO,QAAQ,CAAA;IACnB,CAAC,CAAC;SACD,UAAU,CAAC,KAAK,EAAC,KAAK,EAAC,EAAE;QACtB,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YACnB,MAAM,aAAa,GAAkC;gBACjD,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,mBAAmB,CAAC,OAAO;gBACnC,MAAM,EAAE,SAAS;gBACjB,KAAK,EAAE,KAAK;aACf,CAAA;YAED,OAAO,aAAa,CAAA;QACxB,CAAC;QAED,MAAM,WAAW,GAAkC;YAC/C,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,mBAAmB,CAAC,KAAK;YACjC,MAAM,EAAE,SAAS;YACjB,KAAK,EAAE,SAAS;SACnB,CAAA;QACD,OAAO,WAAW,CAAA;IACtB,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAA;AAC3B,CAAC,CAAA;AAnDQ,QAAA,iBAAiB,qBAmDzB"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@othree.io/stethoscope",
+  "version": "1.0.0",
+  "description": "Stethoscope",
+  "main": "lib/index.js",
+  "scripts": {
+    "test": "jest",
+    "build": "tsc",
+    "semantic-release": "semantic-release"
+  },
+  "keywords": [
+    "stethoscope"
+  ],
+  "author": "othree",
+  "license": "ISC",
+  "dependencies": {
+    "@othree.io/awsome": "^1.3.0",
+    "@othree.io/journal": "^1.0.0",
+    "@othree.io/optional": "^2.2.0",
+    "async": "^3.2.5"
+  },
+  "devDependencies": {
+    "@types/async": "^3.2.24",
+    "@types/aws-lambda": "^8.10.137",
+    "@types/jest": "^29.5.0",
+    "docdash": "^2.0.1",
+    "jest": "^29.5.0",
+    "jsdoc": "^4.0.2",
+    "semantic-release": "^21.1.1",
+    "ts-jest": "^29.0.5",
+    "typescript": "^5.0.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/release.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+    plugins: ['@semantic-release/commit-analyzer', '@semantic-release/release-notes-generator', '@semantic-release/npm'],
+    branches: ['master', 'main']
+}