@benup/bensdk 1.2.3 → 1.3.0

package/bin/lib/lib/consumer/datapoint/index.d.ts

@@ -0,0 +1,18 @@
+import { SendMessageCommandOutput } from '@aws-sdk/client-sqs';
+export interface DataPointContext {
+    executionID: string;
+    accountID: string;
+    companyID: string;
+    correlationIDs: Record<string, string>;
+    ingestion: Record<string, unknown>;
+    SQSMessageID: string;
+    sendMessage: (ingestionRawData: unknown, origin: string, final: boolean) => Promise<SendMessageCommandOutput>;
+}
+export interface DataPoint {
+    executionID: string;
+    accountID: string;
+    companyID: string;
+    correlationIDs: Record<string, string>;
+    ingestion: Record<string, unknown>;
+    SQSMessageID: string;
+}

package/bin/lib/lib/consumer/index.d.ts

@@ -0,0 +1,97 @@
+import { Message, MessageAttributeValue, SendMessageCommandOutput, SQSClient } from '@aws-sdk/client-sqs';
+import pino from 'pino';
+import { Consumer } from 'sqs-consumer';
+import { z } from 'zod';
+import { DataPoint, DataPointContext } from './datapoint/index.js';
+export interface ConsumerHandlerCtx {
+    /**
+     * The raw message object received from sqs
+     */
+    rawMessage: Message;
+    /**
+     * Instace of pino.Logger with the execution context
+     */
+    logger: pino.Logger;
+    /**
+     * Correlation IDs captured in message attributes
+     */
+    correlationIDs: Record<string, string>;
+    /**
+     * send message to a queue
+     */
+    sendMessage: (queueUrl: string, message: object, executionID?: string) => Promise<SendMessageCommandOutput>;
+    /**
+     * Create a DataPointContext object with the provided mapping
+     */
+    createDataPointContext: (dataPoint: DataPoint, meta?: Record<string, string>) => DataPointContext;
+}
+export type HandlerMessageResponse = 'ACK' | 'UNACK' | 'DLQ';
+export interface HandlerResponse {
+    response: HandlerMessageResponse;
+    options?: {
+        maxRetries?: number;
+        delayBetweenRetries?: number;
+        delayMode?: 'fixed' | 'exponential';
+    };
+}
+export type ConsumerHandler<T> = (message: T, ctx: ConsumerHandlerCtx) => Promise<HandlerResponse>;
+/**
+ * Options for create a consumer
+ */
+export interface ConsumerOptions<T> {
+    /**
+     * Zod Schema of the message body. If message body isnt valid,
+     * the consumer will return an error, and the message will be sent to dlq.
+     */
+    messageSchema: z.AnyZodObject;
+    /**
+     * The service name to be showed in log.
+     */
+    serviceName: string;
+    /**
+     * SQS queues urls
+     * main - the url of the queue that consumer will be listen
+     * dlq - the url of the queue to be used as DLQ
+     */
+    queuesUrl: {
+        main: string;
+        dlq: string;
+        dataPointMain?: string;
+    };
+    /**
+     * set this attribute to use localstack
+     */
+    sqsEndpoint?: string;
+    /**
+     * Instace of pino.Logger to be used
+     */
+    logger: pino.Logger;
+    /**
+     * Handler for the received messages
+     * @param message - the message as object
+     * @param ctx -
+     * @returns
+     */
+    handler: ConsumerHandler<T>;
+}
+/**
+ * helper for send message to a sqs queue
+ */
+export declare function send(sqs: SQSClient, queueUrl: string, message: object | string, attributes: Record<string, MessageAttributeValue>): Promise<SendMessageCommandOutput>;
+/**
+ * Create a new consumerHandler
+ */
+export declare const createConsumerHandler: <T>(options: ConsumerOptions<T>, sqs: SQSClient) => (rawMessage: Message) => Promise<Message | void>;
+/**
+ * Create a new SQS Consumer
+ * @param {ConsumerOptions} options - consumer options
+ * @returns {Consumer} - sqs-consumer instance
+ */
+export declare const createConsumer: <T>(options: ConsumerOptions<T>) => Consumer;
+/**
+ * Helper for mapping the ingestion data
+ * @param mapping - The mapping to be used
+ * @param ingestionRawData - The ingestion data to be mapped
+ * @returns The mapped data
+ */
+export declare const ingestionMapping: (mapping: Record<string, unknown>, ingestionRawData: Record<string, unknown>) => Record<string, unknown>;

package/bin/lib/schemas/action-consumer/message.schema.d.ts

@@ -0,0 +1,25 @@
+import { z } from 'zod';
+export declare const ActionConsumerMessageSchema: z.ZodObject<{
+    version: z.ZodNumber;
+    data: z.ZodObject<{
+        actionID: z.ZodEffects<z.ZodString, string, string>;
+    }, "strip", z.ZodTypeAny, {
+        actionID?: string;
+    }, {
+        actionID?: string;
+    }>;
+    meta: z.ZodOptional<z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>;
+}, "strict", z.ZodTypeAny, {
+    data?: {
+        actionID?: string;
+    };
+    meta?: {};
+    version?: number;
+}, {
+    data?: {
+        actionID?: string;
+    };
+    meta?: {};
+    version?: number;
+}>;
+export default ActionConsumerMessageSchema;