@fiado/type-kit 3.18.0 → 3.20.0

package/src/legal-documents-business/index.ts

@@ -1,6 +1,6 @@
-export * from './dtos/DirectoryAcceptanceRequest';
-export * from './dtos/LegalDocumentResponse';
-export * from './dtos/LegalDocumentCreateRequest';
-export * from './dtos/UpdateLegalDocumentRequest';
-
-
+export * from './dtos/DirectoryAcceptanceRequest';
+export * from './dtos/LegalDocumentResponse';
+export * from './dtos/LegalDocumentCreateRequest';
+export * from './dtos/UpdateLegalDocumentRequest';
+
+

package/src/mdm/README.md

@@ -0,0 +1,78 @@
+# Dominio MDM — DTOs prototipo
+
+> ⚠️ **TEMPORAL.** Estos archivos están aquí como prototipo. **Antes de usarlos en producción** deben moverse a `fiado-type-kit/src/mdm/` para no violar el anti-pattern `DTO_LOCAL` (los DTOs son contrato entre microservicios y no deben vivir locales al lambda).
+
+## Qué es esto
+
+DTOs y enums para el servicio MDM (Mobile Device Management) de SureKeep. Son agnósticos al proveedor — la misma forma sirve para Trustonic, Datacultr o cualquier otro proveedor que se integre en el futuro.
+
+## Convenciones
+
+Sigue el estándar `@fiado/type-kit`:
+
+- **Idioma:** inglés (CamelCase para clases, camelCase para propiedades, UPPER_SNAKE_CASE para enums).
+- **Forma:** clases, no `type` ni `interface`.
+- **Request DTOs:** decoradores `@Expose()` de `class-transformer` + decoradores de `class-validator` (`@IsString`, `@IsEnum`, `@IsOptional`, etc.).
+- **Response DTOs:** sin decoradores (los genera el backend).
+- **Enums:** valores en `UPPER_SNAKE_CASE`.
+
+## Estructura
+
+```
+mdm/
+├── dtos/
+│   ├── DeviceLockRequest.ts         ← Request DTO con validación
+│   ├── DeviceLockResponse.ts        ← Response DTO sin validación
+│   ├── DeviceLockScreenMessage.ts   ← DTO compartido (nested)
+│   ├── MdmError.ts                  ← Error tipado compartido
+│   └── ...
+├── enums/
+│   ├── DeviceLockModeEnum.ts
+│   ├── MdmDeviceStatusEnum.ts
+│   └── ...
+└── index.ts                         ← barrel export
+```
+
+## Uso temporal
+
+```typescript
+import { DeviceLockRequest } from "./mdm";
+```
+
+## Uso definitivo (cuando esté en el type-kit)
+
+```typescript
+import { DeviceLockRequest } from "@fiado/type-kit/bin/mdm";
+// o como namespace:
+import { Mdm } from "@fiado/type-kit";
+```
+
+## Acciones soportadas
+
+| Acción | Trustonic | Datacultr |
+|---|---|---|
+| DeviceNotify | HEADSUP / FULLSCREEN | Notification (con `notification_code`) |
+| DeviceRestrictApps | ⚠️ Por confirmar configuración | Nudge (App Block) |
+| DeviceLock (FIRM) | Lock LOCK | Bulk Lock |
+| DeviceLock (TEMPORARY) | Lock DIMISSABLE | ❌ Error: no soporta |
+| DeviceUnlock | Unlock | Unlock |
+| DevicePinUnlock | PIN Unlock | get_device_passcode |
+| DeviceStatus | Device Info | Device Status by IMEI |
+| DeviceEnroll | Upload + Activate (síncrono) | Registra y espera webhook |
+| DeviceRelease | Release | Release |
+| DeviceServiceDeactivate | Deactivate Service | ❌ Error: no soporta |
+| DeviceArchive | Archive | ❌ Error: no soporta |
+| DeviceAutoLockSchedule | ❌ Error: no soporta postpaid | Adhoc Auto Lock |
+| DeviceLastSeen | (incluido en Device Info) | Device Last Seen |
+| DeviceLog | ❌ Error: no expone | Device Log |
+
+## Eventos entrantes (solo Datacultr)
+
+- `DeviceEnrollmentCompletedEvent` — Enrollment Webhook
+- `DeviceReleaseCompletedEvent` — Release Webhook
+
+Trustonic no emite webhooks (según el PDF oficial v2.0.1). Para Trustonic se debe pollear `Upload Status` y `Device Info`.
+
+---
+
+*Mantenido en este repo solo como prototipo. Subir al `fiado-type-kit` antes de producción.*

package/src/mdm/dtos/DeviceArchiveRequest.ts

@@ -0,0 +1,14 @@
+import { Expose } from "class-transformer";
+import { IsString, IsNotEmpty } from "class-validator";
+
+export class DeviceArchiveRequest {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    imei: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    operationReference: string;
+}

package/src/mdm/dtos/DeviceArchiveResponse.ts

@@ -0,0 +1,10 @@
+import { MdmOperationStatusEnum } from "../enums/MdmOperationStatusEnum";
+import { MdmError } from "./MdmError";
+
+export class DeviceArchiveResponse {
+    imei: string;
+    operationReference: string;
+    status: MdmOperationStatusEnum;
+    archivedAt?: string;
+    error?: MdmError;
+}

package/src/mdm/dtos/DeviceAutoLockScheduleRequest.ts

@@ -0,0 +1,18 @@
+import { Expose } from "class-transformer";
+import { IsString, IsNotEmpty, IsISO8601 } from "class-validator";
+
+export class DeviceAutoLockScheduleRequest {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    imei: string;
+
+    @Expose()
+    @IsISO8601()
+    lockAt: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    operationReference: string;
+}

package/src/mdm/dtos/DeviceAutoLockScheduleResponse.ts

@@ -0,0 +1,10 @@
+import { MdmOperationStatusEnum } from "../enums/MdmOperationStatusEnum";
+import { MdmError } from "./MdmError";
+
+export class DeviceAutoLockScheduleResponse {
+    imei: string;
+    operationReference: string;
+    status: MdmOperationStatusEnum;
+    scheduledFor?: string;
+    error?: MdmError;
+}

package/src/mdm/dtos/DeviceEnrollInitiateResponse.ts

@@ -0,0 +1,9 @@
+import { MdmOperationStatusEnum } from "../enums/MdmOperationStatusEnum";
+import { MdmError } from "./MdmError";
+
+export class DeviceEnrollInitiateResponse {
+    imei: string;
+    operationReference: string;
+    status: MdmOperationStatusEnum;
+    error?: MdmError;
+}

package/src/mdm/dtos/DeviceEnrollRequest.ts

@@ -0,0 +1,38 @@
+import { Expose } from "class-transformer";
+import { IsString, IsNotEmpty, IsOptional, IsNumber, IsPositive, IsUUID } from "class-validator";
+
+export class DeviceEnrollRequest {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    imei: string;
+
+    @Expose()
+    @IsString()
+    @IsOptional()
+    imei2?: string;
+
+    @Expose()
+    @IsString()
+    @IsOptional()
+    brand?: string;
+
+    @Expose()
+    @IsString()
+    @IsOptional()
+    model?: string;
+
+    @Expose()
+    @IsUUID()
+    creditId: string;
+
+    @Expose()
+    @IsNumber()
+    @IsPositive()
+    termMonths: number;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    operationReference: string;
+}

package/src/mdm/dtos/DeviceEnrollStatusRequest.ts

@@ -0,0 +1,14 @@
+import { Expose } from "class-transformer";
+import { IsString, IsNotEmpty } from "class-validator";
+
+export class DeviceEnrollStatusRequest {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    imei: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    operationReference: string;
+}

package/src/mdm/dtos/DeviceEnrollStatusResponse.ts

@@ -0,0 +1,15 @@
+import { MdmOperationStatusEnum } from "../enums/MdmOperationStatusEnum";
+import { DeviceEnrollmentModeEnum } from "../enums/DeviceEnrollmentModeEnum";
+import { MdmError } from "./MdmError";
+
+export class DeviceEnrollStatusResponse {
+    imei: string;
+    operationReference: string;
+    status: MdmOperationStatusEnum;
+    enrolledAt?: string;
+    enrollmentMode?: DeviceEnrollmentModeEnum;
+    enrollmentId?: string;
+    brand?: string;
+    model?: string;
+    error?: MdmError;
+}

package/src/mdm/dtos/DeviceEnrollmentCompletedEvent.ts

@@ -0,0 +1,8 @@
+export class DeviceEnrollmentCompletedEvent {
+    imei: string;
+    brand?: string;
+    model?: string;
+    enrolledAt: string;
+    successful: boolean;
+    provider: string;
+}

package/src/mdm/dtos/DeviceLastSeenRequest.ts

@@ -0,0 +1,9 @@
+import { Expose } from "class-transformer";
+import { IsString, IsNotEmpty } from "class-validator";
+
+export class DeviceLastSeenRequest {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    imei: string;
+}

package/src/mdm/dtos/DeviceLastSeenResponse.ts

@@ -0,0 +1,9 @@
+import { MdmOperationStatusEnum } from "../enums/MdmOperationStatusEnum";
+import { MdmError } from "./MdmError";
+
+export class DeviceLastSeenResponse {
+    imei: string;
+    status: MdmOperationStatusEnum;
+    lastSeenAt?: string;
+    error?: MdmError;
+}

package/src/mdm/dtos/DeviceLockRequest.ts

@@ -0,0 +1,46 @@
+import { Expose, Type } from "class-transformer";
+import {
+    IsString,
+    IsNotEmpty,
+    IsEnum,
+    IsOptional,
+    IsNumber,
+    IsPositive,
+    ValidateNested,
+    IsUrl
+} from "class-validator";
+import { DeviceLockModeEnum } from "../enums/DeviceLockModeEnum";
+import { DeviceLockScreenMessage } from "./DeviceLockScreenMessage";
+
+export class DeviceLockRequest {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    imei: string;
+
+    @Expose()
+    @IsEnum(DeviceLockModeEnum)
+    mode: DeviceLockModeEnum;
+
+    @Expose()
+    @IsNumber()
+    @IsPositive()
+    @IsOptional()
+    durationSeconds?: number;
+
+    @Expose()
+    @IsOptional()
+    @ValidateNested()
+    @Type(() => DeviceLockScreenMessage)
+    screenMessage?: DeviceLockScreenMessage;
+
+    @Expose()
+    @IsUrl()
+    @IsOptional()
+    paymentLink?: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    operationReference: string;
+}

package/src/mdm/dtos/DeviceLockResponse.ts

@@ -0,0 +1,12 @@
+import { DeviceLockModeEnum } from "../enums/DeviceLockModeEnum";
+import { MdmOperationStatusEnum } from "../enums/MdmOperationStatusEnum";
+import { MdmError } from "./MdmError";
+
+export class DeviceLockResponse {
+    imei: string;
+    operationReference: string;
+    status: MdmOperationStatusEnum;
+    lockedAt?: string;
+    appliedMode?: DeviceLockModeEnum;
+    error?: MdmError;
+}

package/src/mdm/dtos/DeviceLockScreenMessage.ts

@@ -0,0 +1,14 @@
+import { Expose } from "class-transformer";
+import { IsString, IsNotEmpty } from "class-validator";
+
+export class DeviceLockScreenMessage {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    title: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    content: string;
+}

package/src/mdm/dtos/DeviceLogEntry.ts

@@ -0,0 +1,5 @@
+export class DeviceLogEntry {
+    occurredAt: string;
+    action: string;
+    state: string;
+}

package/src/mdm/dtos/DeviceLogRequest.ts

@@ -0,0 +1,19 @@
+import { Expose } from "class-transformer";
+import { IsString, IsNotEmpty, IsISO8601, IsOptional } from "class-validator";
+
+export class DeviceLogRequest {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    imei: string;
+
+    @Expose()
+    @IsISO8601()
+    @IsOptional()
+    from?: string;
+
+    @Expose()
+    @IsISO8601()
+    @IsOptional()
+    to?: string;
+}

package/src/mdm/dtos/DeviceLogResponse.ts

@@ -0,0 +1,10 @@
+import { MdmOperationStatusEnum } from "../enums/MdmOperationStatusEnum";
+import { DeviceLogEntry } from "./DeviceLogEntry";
+import { MdmError } from "./MdmError";
+
+export class DeviceLogResponse {
+    imei: string;
+    status: MdmOperationStatusEnum;
+    entries?: DeviceLogEntry[];
+    error?: MdmError;
+}

package/src/mdm/dtos/DeviceNotifyRequest.ts

@@ -0,0 +1,47 @@
+import { Expose } from "class-transformer";
+import { IsString, IsNotEmpty, IsEnum } from "class-validator";
+import { DeviceNotifyIntensityEnum } from "../enums/DeviceNotifyIntensityEnum";
+
+export class DeviceNotifyRequest {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    imei: string;
+
+    @Expose()
+    @IsEnum(DeviceNotifyIntensityEnum)
+    intensity: DeviceNotifyIntensityEnum;
+
+    /**
+     * Código de notificación del catálogo (usado por Datacultr en su catálogo de mensajes
+     * predefinidos). Trustonic lo ignora porque exige texto crudo en `title + content`.
+     * Ver `trustonic-connector/docs/ARCHITECTURE.md` §7.6.
+     */
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    notificationCode: string;
+
+    /**
+     * Título de la notificación. Usado por Trustonic (`notificationTitle`). Datacultr lo
+     * ignora — el texto del título vive en su catálogo indexado por `notificationCode`.
+     */
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    title: string;
+
+    /**
+     * Cuerpo de la notificación. Usado por Trustonic (`notificationContent`). Datacultr lo
+     * ignora.
+     */
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    content: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    operationReference: string;
+}

package/src/mdm/dtos/DeviceNotifyResponse.ts

@@ -0,0 +1,10 @@
+import { MdmOperationStatusEnum } from "../enums/MdmOperationStatusEnum";
+import { MdmError } from "./MdmError";
+
+export class DeviceNotifyResponse {
+    imei: string;
+    operationReference: string;
+    status: MdmOperationStatusEnum;
+    sentAt?: string;
+    error?: MdmError;
+}

package/src/mdm/dtos/DevicePinUnlockRequest.ts

@@ -0,0 +1,19 @@
+import { Expose } from "class-transformer";
+import { IsString, IsNotEmpty, IsOptional } from "class-validator";
+
+export class DevicePinUnlockRequest {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    imei: string;
+
+    @Expose()
+    @IsString()
+    @IsOptional()
+    devicePasskey?: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    operationReference: string;
+}

package/src/mdm/dtos/DevicePinUnlockResponse.ts

@@ -0,0 +1,12 @@
+import { MdmOperationStatusEnum } from "../enums/MdmOperationStatusEnum";
+import { MdmError } from "./MdmError";
+
+export class DevicePinUnlockResponse {
+    imei: string;
+    operationReference: string;
+    status: MdmOperationStatusEnum;
+    pin?: string;
+    validitySeconds?: number;
+    generatedAt?: string;
+    error?: MdmError;
+}

package/src/mdm/dtos/DeviceReleaseCompletedEvent.ts

@@ -0,0 +1,6 @@
+export class DeviceReleaseCompletedEvent {
+    imei: string;
+    releasedAt: string;
+    successful: boolean;
+    provider: string;
+}

package/src/mdm/dtos/DeviceReleaseInitiateResponse.ts

@@ -0,0 +1,10 @@
+import { MdmOperationStatusEnum } from "../enums/MdmOperationStatusEnum";
+import { MdmError } from "./MdmError";
+
+export class DeviceReleaseInitiateResponse {
+    imei: string;
+    operationReference: string;
+    status: MdmOperationStatusEnum;
+    releasedAt?: string;
+    error?: MdmError;
+}

package/src/mdm/dtos/DeviceReleaseRequest.ts

@@ -0,0 +1,24 @@
+import { Expose } from "class-transformer";
+import { IsString, IsNotEmpty, IsEnum, IsOptional } from "class-validator";
+import { DeviceReleaseReasonEnum } from "../enums/DeviceReleaseReasonEnum";
+
+export class DeviceReleaseRequest {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    imei: string;
+
+    @Expose()
+    @IsEnum(DeviceReleaseReasonEnum)
+    reason: DeviceReleaseReasonEnum;
+
+    @Expose()
+    @IsString()
+    @IsOptional()
+    comment?: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    operationReference: string;
+}

package/src/mdm/dtos/DeviceReleaseStatusRequest.ts

@@ -0,0 +1,14 @@
+import { Expose } from "class-transformer";
+import { IsString, IsNotEmpty } from "class-validator";
+
+export class DeviceReleaseStatusRequest {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    imei: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    operationReference: string;
+}

package/src/mdm/dtos/DeviceReleaseStatusResponse.ts

@@ -0,0 +1,10 @@
+import { MdmOperationStatusEnum } from "../enums/MdmOperationStatusEnum";
+import { MdmError } from "./MdmError";
+
+export class DeviceReleaseStatusResponse {
+    imei: string;
+    operationReference: string;
+    status: MdmOperationStatusEnum;
+    releasedAt?: string;
+    error?: MdmError;
+}

package/src/mdm/dtos/DeviceRestrictAppsRequest.ts

@@ -0,0 +1,19 @@
+import { Expose } from "class-transformer";
+import { IsString, IsNotEmpty } from "class-validator";
+
+export class DeviceRestrictAppsRequest {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    imei: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    restrictionCode: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    operationReference: string;
+}

package/src/mdm/dtos/DeviceRestrictAppsResponse.ts

@@ -0,0 +1,10 @@
+import { MdmOperationStatusEnum } from "../enums/MdmOperationStatusEnum";
+import { MdmError } from "./MdmError";
+
+export class DeviceRestrictAppsResponse {
+    imei: string;
+    operationReference: string;
+    status: MdmOperationStatusEnum;
+    appliedAt?: string;
+    error?: MdmError;
+}

package/src/mdm/dtos/DeviceServiceDeactivateInitiateResponse.ts

@@ -0,0 +1,9 @@
+import { MdmOperationStatusEnum } from "../enums/MdmOperationStatusEnum";
+import { MdmError } from "./MdmError";
+
+export class DeviceServiceDeactivateInitiateResponse {
+    imei: string;
+    operationReference: string;
+    status: MdmOperationStatusEnum;
+    error?: MdmError;
+}

package/src/mdm/dtos/DeviceServiceDeactivateRequest.ts

@@ -0,0 +1,19 @@
+import { Expose } from "class-transformer";
+import { IsString, IsNotEmpty, IsEnum } from "class-validator";
+import { DeviceServiceDeactivateReasonEnum } from "../enums/DeviceServiceDeactivateReasonEnum";
+
+export class DeviceServiceDeactivateRequest {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    imei: string;
+
+    @Expose()
+    @IsEnum(DeviceServiceDeactivateReasonEnum)
+    reason: DeviceServiceDeactivateReasonEnum;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    operationReference: string;
+}

package/src/mdm/dtos/DeviceServiceDeactivateStatusRequest.ts

@@ -0,0 +1,14 @@
+import { Expose } from "class-transformer";
+import { IsString, IsNotEmpty } from "class-validator";
+
+export class DeviceServiceDeactivateStatusRequest {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    imei: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    operationReference: string;
+}

package/src/mdm/dtos/DeviceServiceDeactivateStatusResponse.ts

@@ -0,0 +1,10 @@
+import { MdmOperationStatusEnum } from "../enums/MdmOperationStatusEnum";
+import { MdmError } from "./MdmError";
+
+export class DeviceServiceDeactivateStatusResponse {
+    imei: string;
+    operationReference: string;
+    status: MdmOperationStatusEnum;
+    deactivatedAt?: string;
+    error?: MdmError;
+}

package/src/mdm/dtos/DeviceStatusRequest.ts

@@ -0,0 +1,9 @@
+import { Expose } from "class-transformer";
+import { IsString, IsNotEmpty } from "class-validator";
+
+export class DeviceStatusRequest {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    imei: string;
+}

package/src/mdm/dtos/DeviceStatusResponse.ts

@@ -0,0 +1,16 @@
+import { MdmDeviceStatusEnum } from "../enums/MdmDeviceStatusEnum";
+import { MdmOperationStatusEnum } from "../enums/MdmOperationStatusEnum";
+import { MdmError } from "./MdmError";
+
+export class DeviceStatusResponse {
+    imei: string;
+    status: MdmOperationStatusEnum;
+    deviceStatus?: MdmDeviceStatusEnum;
+    brand?: string;
+    model?: string;
+    marketName?: string;
+    lastSeenAt?: string;
+    lastTransition?: string;
+    enrolledAt?: string;
+    error?: MdmError;
+}