@seidor-cloud-produtos/orbit-backend-lib 2.0.138 → 2.1.0

package/dist/clean-arch/infra/scaledjob/sqs/types.d.ts

@@ -1,6 +1,24 @@
 import { ScaledJobOptions } from '../types';
+/**
+ * Opções para execução de ScaledJobs com AWS SQS.
+ */
 export interface SQSScaledJobOptions extends ScaledJobOptions {
+    /**
+     * Região AWS onde a fila SQS está localizada.
+     *
+     * Ex.: `us-east-1`.
+     */
     sqsRegion: string;
+    /**
+     * Tempo máximo (em segundos) que o job pode executar antes de encerrar.
+     *
+     * Quando definido, o runner disputa o processamento com um timeout global.
+     */
     processTimeoutSeconds?: number;
+    /**
+     * Tempo de long polling (em segundos) usado no ReceiveMessage.
+     *
+     * Valores maiores reduzem custo e aumentam eficiência de consumo.
+     */
     waitMessagesTimeSeconds?: number;
 }

package/dist/clean-arch/infra/scaledjob/types/index.d.ts

@@ -1,2 +1,7 @@
+/**
+ * Marcador para opções compartilhadas entre runners de ScaledJob.
+ *
+ * Hoje está vazio, mas serve como ponto de extensão comum.
+ */
 export interface ScaledJobOptions {
 }

package/dist/clean-arch/infra/tracing/start-tracing.d.ts

@@ -0,0 +1,10 @@
+type TracingResourceAttribute = string | number | boolean | undefined;
+interface IStartTracingOptions {
+    serviceName?: string;
+    serviceVersion?: string;
+    disabledInstrumentations?: string[];
+    extraResourceAttributes?: Record<string, TracingResourceAttribute>;
+}
+export declare function shutdownTracing(): Promise<void>;
+export declare function startTracing(options?: IStartTracingOptions): void;
+export {};

package/dist/clean-arch/infra/tracing/start-tracing.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startTracing = exports.shutdownTracing = void 0;
+const auto_instrumentations_node_1 = require("@opentelemetry/auto-instrumentations-node");
+const resources_1 = require("@opentelemetry/resources");
+const sdk_node_1 = require("@opentelemetry/sdk-node");
+const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
+const DEFAULT_DISABLED_INSTRUMENTATIONS = ['@opentelemetry/instrumentation-fs'];
+let sdk = null;
+let isShutdownHookRegistered = false;
+let shutdownPromise = null;
+function makeDisabledInstrumentationMap(disabledInstrumentations) {
+    return disabledInstrumentations.reduce((accumulator, instrumentationName) => {
+        accumulator[instrumentationName] = { enabled: false };
+        return accumulator;
+    }, {});
+}
+function shutdownTracing() {
+    if (sdk === null) {
+        return Promise.resolve();
+    }
+    if (shutdownPromise !== null) {
+        return shutdownPromise;
+    }
+    const currentShutdownPromise = sdk
+        .shutdown()
+        .then(() => {
+        console.log('Tracing terminated');
+        sdk = null;
+    })
+        .catch((error) => {
+        console.log('Error terminating tracing', error);
+        throw error;
+    })
+        .finally(() => {
+        shutdownPromise = null;
+    });
+    shutdownPromise = currentShutdownPromise;
+    return currentShutdownPromise;
+}
+exports.shutdownTracing = shutdownTracing;
+function registerShutdownHook() {
+    if (isShutdownHookRegistered) {
+        return;
+    }
+    process.on('SIGTERM', () => {
+        void shutdownTracing();
+    });
+    isShutdownHookRegistered = true;
+}
+function startTracing(options = {}) {
+    if (sdk !== null) {
+        return;
+    }
+    const serviceName = options.serviceName;
+    const serviceVersion = options.serviceVersion;
+    const disabledInstrumentations = [
+        ...new Set([
+            ...DEFAULT_DISABLED_INSTRUMENTATIONS,
+            ...(options.disabledInstrumentations ?? []),
+        ]),
+    ];
+    const resourceAttributes = {
+        [semantic_conventions_1.ATTR_SERVICE_NAME]: serviceName,
+        [semantic_conventions_1.ATTR_SERVICE_VERSION]: serviceVersion,
+        ...(options.extraResourceAttributes ?? {}),
+    };
+    sdk = new sdk_node_1.NodeSDK({
+        resource: (0, resources_1.resourceFromAttributes)(resourceAttributes),
+        instrumentations: [
+            (0, auto_instrumentations_node_1.getNodeAutoInstrumentations)(makeDisabledInstrumentationMap(disabledInstrumentations)),
+        ],
+    });
+    sdk.start();
+    console.log('OpenTelemetry tracing started');
+    registerShutdownHook();
+}
+exports.startTracing = startTracing;

package/dist/clean-arch/infra/validations/zod/schemas/common-validation.d.ts

@@ -1,4 +1,8 @@
 import { z } from 'zod';
+/**
+ *
+ * @deprecated Use authorizerHeaders.
+ */
 export declare const headersDefault: z.ZodObject<{
     tenantid: z.ZodString;
     username: z.ZodString;
@@ -12,6 +16,10 @@ export declare const headersDefault: z.ZodObject<{
     tenantid: string;
     useremail: string;
 }>;
+/**
+ *
+ * @deprecated Use authorizerHeaders.
+ */
 export declare const headersDefaultWithUserId: z.ZodObject<{
     tenantid: z.ZodString;
     username: z.ZodString;
@@ -28,6 +36,157 @@ export declare const headersDefaultWithUserId: z.ZodObject<{
     useremail: string;
     userid: string;
 }>;
+export declare const tenantIdSchema: z.ZodObject<{
+    tenantid: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    tenantid: string;
+}, {
+    tenantid: string;
+}>;
+export declare const userSchema: z.ZodObject<{
+    username: z.ZodString;
+    useremail: z.ZodString;
+    userid: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    username: string;
+    useremail: string;
+    userid?: string | undefined;
+}, {
+    username: string;
+    useremail: string;
+    userid?: string | undefined;
+}>;
+export declare const appSchema: z.ZodObject<{
+    "app-name": z.ZodString;
+    "app-id": z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    "app-id": string;
+    "app-name": string;
+}, {
+    "app-id": string;
+    "app-name": string;
+}>;
+export declare const traceSchema: z.ZodObject<{
+    "x-trace-id": z.ZodDefault<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    "x-trace-id": string;
+}, {
+    "x-trace-id"?: string | undefined;
+}>;
+export declare const tenantSchema: z.ZodObject<{
+    tenantname: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    tenantname?: string | undefined;
+}, {
+    tenantname?: string | undefined;
+}>;
+export declare const integrationHeaders: z.ZodObject<z.objectUtil.extendShape<{
+    tenantid: z.ZodString;
+}, {
+    "x-trace-id": z.ZodDefault<z.ZodString>;
+}>, "strip", z.ZodTypeAny, {
+    "x-trace-id": string;
+    tenantid: string;
+}, {
+    tenantid: string;
+    "x-trace-id"?: string | undefined;
+}>;
+export declare const authorizerHeaders: z.ZodUnion<[z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+    username: z.ZodString;
+    useremail: z.ZodString;
+    userid: z.ZodOptional<z.ZodString>;
+}, z.objectUtil.extendShape<{
+    tenantid: z.ZodString;
+}, {
+    "x-trace-id": z.ZodDefault<z.ZodString>;
+}>>, {
+    tenantname: z.ZodOptional<z.ZodString>;
+}>, "strip", z.ZodTypeAny, {
+    "x-trace-id": string;
+    username: string;
+    tenantid: string;
+    useremail: string;
+    userid?: string | undefined;
+    tenantname?: string | undefined;
+}, {
+    username: string;
+    tenantid: string;
+    useremail: string;
+    "x-trace-id"?: string | undefined;
+    userid?: string | undefined;
+    tenantname?: string | undefined;
+}>, z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+    "app-name": z.ZodString;
+    "app-id": z.ZodString;
+}, z.objectUtil.extendShape<{
+    tenantid: z.ZodString;
+}, {
+    "x-trace-id": z.ZodDefault<z.ZodString>;
+}>>, {
+    tenantname: z.ZodOptional<z.ZodString>;
+}>, "strip", z.ZodTypeAny, {
+    "app-id": string;
+    "app-name": string;
+    "x-trace-id": string;
+    tenantid: string;
+    tenantname?: string | undefined;
+}, {
+    "app-id": string;
+    "app-name": string;
+    tenantid: string;
+    "x-trace-id"?: string | undefined;
+    tenantname?: string | undefined;
+}>]>;
+export declare const authorizerHeadersWithFiscalIds: z.ZodUnion<[z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+    username: z.ZodString;
+    useremail: z.ZodString;
+    userid: z.ZodOptional<z.ZodString>;
+}, {
+    fiscalidsfromtenant: z.ZodString;
+}>, z.objectUtil.extendShape<{
+    tenantid: z.ZodString;
+}, {
+    "x-trace-id": z.ZodDefault<z.ZodString>;
+}>>, "strip", z.ZodTypeAny, {
+    "x-trace-id": string;
+    fiscalidsfromtenant: string;
+    username: string;
+    tenantid: string;
+    useremail: string;
+    userid?: string | undefined;
+}, {
+    fiscalidsfromtenant: string;
+    username: string;
+    tenantid: string;
+    useremail: string;
+    "x-trace-id"?: string | undefined;
+    userid?: string | undefined;
+}>, z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+    "app-name": z.ZodString;
+    "app-id": z.ZodString;
+}, {
+    fiscalidsfromtenant: z.ZodString;
+}>, z.objectUtil.extendShape<{
+    tenantid: z.ZodString;
+}, {
+    "x-trace-id": z.ZodDefault<z.ZodString>;
+}>>, "strip", z.ZodTypeAny, {
+    "app-id": string;
+    "app-name": string;
+    "x-trace-id": string;
+    fiscalidsfromtenant: string;
+    tenantid: string;
+}, {
+    "app-id": string;
+    "app-name": string;
+    fiscalidsfromtenant: string;
+    tenantid: string;
+    "x-trace-id"?: string | undefined;
+}>]>;
+/**
+ *
+ * @deprecated Use authorizerHeadersWithFiscalIds.
+ */
 export declare const headersDefaultWithFiscalIds: z.ZodObject<{
     tenantid: z.ZodString;
     username: z.ZodString;

package/dist/clean-arch/infra/validations/zod/schemas/common-validation.js

@@ -1,18 +1,69 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.headersDefaultWithFiscalIds = exports.headersDefaultWithUserId = exports.headersDefault = void 0;
+exports.headersDefaultWithFiscalIds = exports.authorizerHeadersWithFiscalIds = exports.authorizerHeaders = exports.integrationHeaders = exports.tenantSchema = exports.traceSchema = exports.appSchema = exports.userSchema = exports.tenantIdSchema = exports.headersDefaultWithUserId = exports.headersDefault = void 0;
+const tslib_1 = require("tslib");
 const zod_1 = require("zod");
+const crypto_1 = tslib_1.__importDefault(require("crypto"));
+/**
+ *
+ * @deprecated Use authorizerHeaders.
+ */
 exports.headersDefault = zod_1.z.object({
     tenantid: zod_1.z.string().uuid(),
     username: zod_1.z.string(),
     useremail: zod_1.z.string(),
 });
+/**
+ *
+ * @deprecated Use authorizerHeaders.
+ */
 exports.headersDefaultWithUserId = zod_1.z.object({
     tenantid: zod_1.z.string().uuid(),
     username: zod_1.z.string(),
     useremail: zod_1.z.string(),
-    userid: zod_1.z.string().uuid(),
+    userid: zod_1.z.string(),
 });
+exports.tenantIdSchema = zod_1.z.object({
+    tenantid: zod_1.z.string().uuid(),
+});
+exports.userSchema = zod_1.z.object({
+    username: zod_1.z.string(),
+    useremail: zod_1.z.string().email(),
+    userid: zod_1.z.string().optional(),
+});
+exports.appSchema = zod_1.z.object({
+    ['app-name']: zod_1.z.string(),
+    ['app-id']: zod_1.z.string().uuid(),
+});
+exports.traceSchema = zod_1.z.object({
+    ['x-trace-id']: zod_1.z
+        .string()
+        .uuid()
+        .default(() => crypto_1.default.randomUUID()),
+});
+const fiscalIdsSchema = zod_1.z.object({
+    fiscalidsfromtenant: zod_1.z.string(zod_1.z.array(zod_1.z.object({
+        value: zod_1.z.string(),
+        type: zod_1.z.string(),
+        countryCode: zod_1.z.string(),
+    }))),
+});
+exports.tenantSchema = zod_1.z.object({
+    tenantname: zod_1.z.string().optional(),
+});
+exports.integrationHeaders = exports.tenantIdSchema.merge(exports.traceSchema);
+exports.authorizerHeaders = zod_1.z.union([
+    exports.userSchema.merge(exports.integrationHeaders).merge(exports.tenantSchema),
+    exports.appSchema.merge(exports.integrationHeaders).merge(exports.tenantSchema),
+]);
+exports.authorizerHeadersWithFiscalIds = zod_1.z.union([
+    exports.userSchema.merge(fiscalIdsSchema).merge(exports.integrationHeaders),
+    exports.appSchema.merge(fiscalIdsSchema).merge(exports.integrationHeaders),
+]);
+/**
+ *
+ * @deprecated Use authorizerHeadersWithFiscalIds.
+ */
 exports.headersDefaultWithFiscalIds = zod_1.z.object({
     tenantid: zod_1.z.string().uuid(),
     username: zod_1.z.string(),

package/dist/clean-arch/infra/validations/zod/validation-zod.d.ts

@@ -6,7 +6,7 @@ type SchemaDefinition = {
     query: ZodObject<Record<string, any>> | ZodEffects<ZodObject<Record<string, any>>>;
     body: ZodObject<Record<string, any>> | ZodEffects<ZodObject<Record<string, any>>>;
 };
-type ZodSchemaObject = ZodObject<SchemaDefinition>;
+export type ZodSchemaObject = ZodObject<SchemaDefinition>;
 export default class ValidationZod implements ValidationHTTP {
     private zodSchema;
     constructor(zodSchema: ZodSchemaObject);

package/dist/clean-arch/infra/validations/zod/validation-zod.spec.js

@@ -433,4 +433,27 @@ describe('Validation zod', () => {
             }));
         }
     });
+    test('should return empty sections when the request omits them', async () => {
+        const schema = zod_1.z.object({
+            body: zod_1.z.object({
+                name: zod_1.z.string().optional(),
+            }),
+            headers: zod_1.z.object({
+                tenantid: zod_1.z.string().optional(),
+            }),
+            query: zod_1.z.object({
+                page: zod_1.z.string().optional(),
+            }),
+            params: zod_1.z.object({
+                id: zod_1.z.string().optional(),
+            }),
+        });
+        const validation = new validation_zod_1.default(schema);
+        await expect(validation.validate({})).resolves.toEqual({
+            body: {},
+            headers: {},
+            params: {},
+            query: {},
+        });
+    });
 });

package/dist/clean-arch/shared/pagination/get-take-and-skip.spec.d.ts

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

package/dist/clean-arch/shared/pagination/get-take-and-skip.spec.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const get_take_and_skip_1 = require("./get-take-and-skip");
+(0, vitest_1.describe)('getTakeAndSkip', () => {
+    (0, vitest_1.it)('should parse pagination values and apply defaults', () => {
+        (0, vitest_1.expect)((0, get_take_and_skip_1.getTakeAndSkip)('10', '2')).toEqual({
+            take: 10,
+            skip: 2,
+        });
+        (0, vitest_1.expect)((0, get_take_and_skip_1.getTakeAndSkip)('', '')).toEqual({
+            take: 20,
+            skip: 1,
+        });
+    });
+});

package/dist/clean-arch/shared/timeout.d.ts

@@ -1,2 +1,10 @@
+/**
+ * Rejeita a promise após o tempo informado.
+ *
+ * Útil para competir com tarefas via `Promise.race`.
+ */
 export declare function rejectTimeout(timeoutMs: number): Promise<void>;
+/**
+ * Aguarda de forma assíncrona pelo tempo informado.
+ */
 export declare function sleep(timeoutMs: any): Promise<void>;

package/dist/clean-arch/shared/timeout.js

@@ -1,10 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sleep = exports.rejectTimeout = void 0;
+/**
+ * Rejeita a promise após o tempo informado.
+ *
+ * Útil para competir com tarefas via `Promise.race`.
+ */
 function rejectTimeout(timeoutMs) {
     return new Promise((_, reject) => setTimeout(() => reject(new Error('Timeout')), timeoutMs));
 }
 exports.rejectTimeout = rejectTimeout;
+/**
+ * Aguarda de forma assíncrona pelo tempo informado.
+ */
 async function sleep(timeoutMs) {
     return new Promise(r => setTimeout(r, timeoutMs));
 }

package/dist/frameworks/express/api-gateway/mapping-model.spec.js

@@ -40,6 +40,17 @@ describe('ExpressMappingModel', () => {
         });
     });
     describe('setHeader', () => {
+        it('should ignore empty header keys', () => {
+            const instance = new mapping_model_2.ExpressMappingModel({
+                request: {
+                    headers: { existing: 'existing_value' },
+                },
+            });
+            expect(instance['setHeader']('', 'new_value')).toBe(instance);
+            expect(instance['getHeaders']()).toStrictEqual({
+                existing: 'existing_value',
+            });
+        });
         it('should set a existing header value', () => {
             const result = new mapping_model_2.ExpressMappingModel({
                 request: {
@@ -136,4 +147,51 @@ describe('ExpressMappingModel', () => {
             expect(result).toBe('next func');
         });
     });
+    describe('setBody', () => {
+        it('should replace the body with body-json when present', () => {
+            const instance = new mapping_model_2.ExpressMappingModel({
+                request: {
+                    body: {
+                        ['body-json']: { id: '1' },
+                    },
+                },
+            });
+            instance['setBody']();
+            expect(instance['getBody']()).toStrictEqual({ id: '1' });
+        });
+        it('should keep the original body when body-json is missing', () => {
+            const body = { id: '1' };
+            const instance = new mapping_model_2.ExpressMappingModel({
+                request: {
+                    body,
+                },
+            });
+            instance['setBody']();
+            expect(instance['getBody']()).toBe(body);
+        });
+    });
+    describe('setMethod', () => {
+        it('should override request method from header', () => {
+            const instance = new mapping_model_2.ExpressMappingModel({
+                request: {
+                    method: 'POST',
+                    headers: {
+                        'x-http-method-override': 'PATCH',
+                    },
+                },
+            });
+            instance['setMethod']();
+            expect(instance['controller'].request.method).toBe('PATCH');
+        });
+        it('should keep request method when override header is missing', () => {
+            const instance = new mapping_model_2.ExpressMappingModel({
+                request: {
+                    method: 'POST',
+                    headers: {},
+                },
+            });
+            instance['setMethod']();
+            expect(instance['controller'].request.method).toBe('POST');
+        });
+    });
 });

package/dist/frameworks/express/authorizations/authorization-express.spec.js

@@ -36,6 +36,15 @@ describe('Express', () => {
         const authorizations = await expressInstance['getAuthorizations']();
         expect(authorizations).toEqual(['auth1', 'auth2']);
     });
+    it('should get authorizations from auths header when needed', async () => {
+        request.headers = {
+            auths: '["auth1","auth2"]',
+            ['X-Amzn-Requestid']: 'request-id',
+        };
+        const expressInstance = (await authorization_express_1.default.create(query, controllerMetaData));
+        expect(expressInstance['getAuthsHeader']()).toBe('["auth1","auth2"]');
+        expect(expressInstance.getRequestId()).toBe('request-id');
+    });
     it('should call next function when authorized', async () => {
         const expressInstance = await authorization_express_1.default.create(query, controllerMetaData);
         expressInstance['handleAuthorized']();

package/dist/frameworks/express/middleware-express.spec.d.ts

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

package/dist/frameworks/express/middleware-express.spec.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const vitest_1 = require("vitest");
+vitest_1.vi.mock('compression', () => ({
+    default: vitest_1.vi.fn(options => options),
+}));
+const compression_1 = tslib_1.__importDefault(require("compression"));
+const mapping_model_1 = require("./api-gateway/mapping-model");
+const middleware_express_1 = require("./api-gateway/middleware-express");
+const authorization_express_1 = tslib_1.__importDefault(require("./authorizations/authorization-express"));
+const middleware_express_2 = require("./authorizations/middleware-express");
+const middleware_express_3 = require("./compression/middleware-express");
+describe('Express middlewares', () => {
+    it('should map API Gateway requests through the mapping model', () => {
+        const parseSpy = vitest_1.vi
+            .spyOn(mapping_model_1.ExpressMappingModel.prototype, 'parse')
+            .mockReturnValue('mapped');
+        const request = {};
+        const response = {};
+        const next = vitest_1.vi.fn();
+        expect((0, middleware_express_1.mapRequestMiddleware)(request, response, next)).toBe('mapped');
+        expect(parseSpy).toHaveBeenCalledTimes(1);
+    });
+    it('should build the authorizer middleware and validate the request', async () => {
+        const validate = vitest_1.vi.fn().mockResolvedValue(true);
+        const createSpy = vitest_1.vi
+            .spyOn(authorization_express_1.default, 'create')
+            .mockResolvedValue({ validate });
+        const request = {};
+        const response = {};
+        const next = vitest_1.vi.fn();
+        const query = { $and: ['auth.read'] };
+        const middleware = (0, middleware_express_2.authorizer)(query);
+        await expect(middleware(request, response, next)).resolves.toBe(true);
+        expect(createSpy).toHaveBeenCalledWith(query, {
+            request,
+            response,
+            next,
+        });
+        expect(validate).toHaveBeenCalledTimes(1);
+    });
+    it('should create a compression middleware with the expected filter', () => {
+        expect(compression_1.default).toHaveBeenCalledWith({
+            filter: expect.any(Function),
+        });
+        const filter = middleware_express_3.compressionMiddleware.filter;
+        expect(filter({ headers: { 'accept-encoding': 'identity' } })).toBe(true);
+        expect(filter({ headers: { 'accept-encoding': 'gzip' } })).toBe(false);
+    });
+});

package/dist/frameworks/nest/nest.spec.d.ts

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