@benup/bensdk 1.2.3 → 1.3.0

package/bin/lib/schemas/common.schema.d.ts

@@ -0,0 +1,144 @@
+/**
+ * zod helper
+ * @module zod
+ */
+import { ObjectId } from 'bson';
+import { z } from 'zod';
+/**
+ * Check if string is a valid ObjectId
+ */
+export declare const zStrId: z.ZodEffects<z.ZodString, string, string>;
+/**
+ * Check if value is a valid ObjectId
+ */
+export declare const zObjectId: z.ZodType<ObjectId, z.ZodTypeDef, ObjectId>;
+/**
+ * Check if string is ISO Date
+ */
+export declare const zDateAt: z.ZodString;
+/**
+ * Check if value is a valid Date
+ */
+export declare const zDate: z.ZodDate;
+/**
+ * Check if string is a valid CPF
+ */
+export declare const zCPF: z.ZodEffects<z.ZodString, string, string>;
+/**
+ * Check if string is a valid birthdate, a.k.a: date < now
+ */
+export declare const zBirthdate: z.ZodEffects<z.ZodString, string, string>;
+/**
+ * Check if object is a valid address object
+ */
+export declare const zAddress: z.ZodObject<{
+    street: z.ZodString;
+    number: z.ZodString;
+    complement: z.ZodOptional<z.ZodString>;
+    neighborhood: z.ZodString;
+    city: z.ZodString;
+    state: z.ZodString;
+    zipCode: z.ZodString;
+    country: z.ZodString;
+}, "strict", z.ZodTypeAny, {
+    number?: string;
+    state?: string;
+    country?: string;
+    street?: string;
+    complement?: string;
+    neighborhood?: string;
+    city?: string;
+    zipCode?: string;
+}, {
+    number?: string;
+    state?: string;
+    country?: string;
+    street?: string;
+    complement?: string;
+    neighborhood?: string;
+    city?: string;
+    zipCode?: string;
+}>;
+/**
+ * Check if string is a valid integer
+ */
+export declare const zStrInt: z.ZodString;
+export declare const zLogsFromResponse: z.ZodObject<{
+    request: z.ZodObject<{
+        url: z.ZodString;
+        path: z.ZodString;
+        method: z.ZodString;
+        headers: z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>;
+        body: z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>;
+    }, "strip", z.ZodTypeAny, {
+        url?: string;
+        body?: {} & {
+            [k: string]: unknown;
+        };
+        path?: string;
+        method?: string;
+        headers?: {} & {
+            [k: string]: unknown;
+        };
+    }, {
+        url?: string;
+        body?: {} & {
+            [k: string]: unknown;
+        };
+        path?: string;
+        method?: string;
+        headers?: {} & {
+            [k: string]: unknown;
+        };
+    }>;
+    response: z.ZodObject<{
+        status: z.ZodNumber;
+        body: z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>;
+    }, "strip", z.ZodTypeAny, {
+        body?: {} & {
+            [k: string]: unknown;
+        };
+        status?: number;
+    }, {
+        body?: {} & {
+            [k: string]: unknown;
+        };
+        status?: number;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    request?: {
+        url?: string;
+        body?: {} & {
+            [k: string]: unknown;
+        };
+        path?: string;
+        method?: string;
+        headers?: {} & {
+            [k: string]: unknown;
+        };
+    };
+    response?: {
+        body?: {} & {
+            [k: string]: unknown;
+        };
+        status?: number;
+    };
+}, {
+    request?: {
+        url?: string;
+        body?: {} & {
+            [k: string]: unknown;
+        };
+        path?: string;
+        method?: string;
+        headers?: {} & {
+            [k: string]: unknown;
+        };
+    };
+    response?: {
+        body?: {} & {
+            [k: string]: unknown;
+        };
+        status?: number;
+    };
+}>;

package/bin/lib/types/action.types.d.ts

@@ -0,0 +1,7 @@
+import z from 'zod';
+import { ActionSchema, DeductionActionSchema, DependentActionSchema, GrantRevokeActionSchema, RechargeActionSchema } from '../schemas/action.schema';
+export type ActionBaseGrantRevoke = z.infer<typeof GrantRevokeActionSchema>;
+export type ActionBaseRecharge = z.infer<typeof RechargeActionSchema>;
+export type ActionBaseDeduction = z.infer<typeof DeductionActionSchema>;
+export type ActionBaseDependent = z.infer<typeof DependentActionSchema>;
+export type ActionBase = z.infer<typeof ActionSchema>;

package/bin/lib/types/benefit-definition.types.d.ts

@@ -0,0 +1,3 @@
+import z from 'zod';
+import { BenefitDefinitionSchema } from '../schemas/benefit-definition.schema';
+export type BenefitDefinition = z.infer<typeof BenefitDefinitionSchema>;

package/bin/lib/types/state-handler.types.d.ts

@@ -0,0 +1,62 @@
+import { Message } from '@aws-sdk/client-sqs';
+import { AxiosInstance } from 'axios';
+import pino from 'pino';
+import z from 'zod';
+import { HandlerResponse } from '../lib/consumer';
+import ActionConsumerMessageSchema from '../schemas/action-consumer/message.schema';
+import { BenefitDefinition } from './benefit-definition.types';
+export type MessageBody = z.infer<typeof ActionConsumerMessageSchema>;
+export interface StateHandlerResponse<TLogs, TCtx> {
+    handlerResponse: HandlerResponse;
+    action?: {
+        state: string;
+        logs: TLogs;
+        ctx?: TCtx;
+    };
+}
+export interface StateHandlerCtx {
+    /**
+     * 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>;
+    /**
+     * benefitsAPI Axios instance
+     */
+    benefitsAPI: AxiosInstance;
+    /**
+     * lgProxy Axios instance
+     */
+    lgProxyAPI: AxiosInstance;
+    /**
+     * apiBenup Axios instance
+     */
+    benupAPI: AxiosInstance;
+    /**
+     * universAPI Axios instance
+     */
+    universAPI: AxiosInstance;
+    /**
+     * benefitDefinition
+     */
+    benefitDefinition: BenefitDefinition;
+}
+/**
+ * State Handler
+ * @param TAction - Action type
+ * @param TLogs - Logs type
+ * @param TCtx - Context type
+ */
+export type StateHandler<TAction, TLogs, TCtx> = (message: MessageBody, action: TAction, ctx: StateHandlerCtx) => Promise<StateHandlerResponse<TLogs, TCtx>>;
+export type StateHandlerConfig = {
+    maxRetries: number;
+    delayBetweenRetries: number;
+    delayMode: 'fixed' | 'exponential';
+};

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@benup/bensdk",
-  "version": "1.2.3",
+  "version": "1.3.0",
   "main": "index.js",
   "type": "module",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "start": "tsx src/cli/app.ts",
-    "build": "tsc && cp -r src/cli/templates bin/src/cli/"
+    "build": "tsc && cp -r src/cli/templates bin/src/cli/ && cp -r src/lib/ bin/lib/"
   },
   "repository": {
     "url": "https://developers.benup.io"