Documentação

Iniciando com Ororo Core.

Pré-requisitos

• Instalar [Node.js].

Configurando um Projeto

Instalando as dependências do projeto:

npm install

Executando testes:

Run npm test to execute unit tests via Jest.

### Usage

This library contains shared code used across the Ororo monorepo:

- **Models**: Domain entities and data structures.
- **Helpers**: Utility functions and common logic.
- **Interfaces**: TypeScript interfaces for type safety.

Import these modules in your NestJS services or other packages:

```typescript
import { SomeModel } from '@ororo.dev/ororo-core';
import { DateHelper } from '@ororo.dev/ororo-core';

// Example usage
const formattedDate = DateHelper.format(new Date());

Build

This library uses tsup for bundling.

npm run build

Shared Alert Contract (DOCUMENT)

SendAlertJob is the canonical payload shared by producer and consumer alert services.

For AlertSourceType.DOCUMENT, the optional dispatchContext field standardizes origin metadata across services:

• trigger source (DOCUMENT_CHECK_CRON, DOCUMENT_FORCE_CHECK, DOCUMENT_RESEND)
• routine and execution id (routine, runId)
• requester identity (requestedByType, requestedByUserId)
• request metadata (requestPath, requestMethod, requestId)
• producer metadata (producerService, producerModule, producerHostname, producerPid, createdAt)

This contract is used by:

• api-retaguarda to annotate document alert jobs.
• api-alert-center to log origin and apply resend scope in dedupe keys.