shori-sdk-ts 1.0.1

package/src/modules/caso/dto/request/getAttachmentFilesRequest.ts

@@ -0,0 +1,250 @@
+import { z } from "zod";
+import { SortDirection } from "../../filter/sortDirection.js";
+import { FilterOperator } from "../../filter/filterOperator.js";
+import { PaginationRequest } from "./paginationRequest.js";
+
+// ── Schema de validación Zod ──────────────────────────────────────────────────
+
+/**
+ * Schema Zod que valida los datos del Builder antes de construir la instancia.
+ *
+ * Se puede usar también para validar datos externos (formularios, API, etc.)
+ * sin necesidad de instanciar el Builder.
+ *
+ * @example
+ * ```ts
+ * // Validar datos externos
+ * const result = GetAttachmentFilesRequestSchema.safeParse({
+ *   casoId: "uuid",
+ *   pageSize: 50,
+ * });
+ * if (!result.success) {
+ *   console.error(result.error.issues);
+ * }
+ * ```
+ */
+export const GetAttachmentFilesRequestSchema = z.object({
+  /** UUID del caso. Requerido — no puede estar vacío. */
+  casoId: z
+    .string({ error: "casoId es requerido" })
+    .min(1, "casoId no puede estar vacío"),
+
+  /** Número de página (0-indexado). Debe ser ≥ 0. Por defecto: 0. */
+  pageNumber: z
+    .number({ error: "pageNumber debe ser un número" })
+    .int("pageNumber debe ser un entero")
+    .min(0, "pageNumber debe ser ≥ 0")
+    .default(0),
+
+  /** Tamaño de página. Debe ser entre 1 y 150. Por defecto: 20. */
+  pageSize: z
+    .number({ error: "pageSize debe ser un número" })
+    .int("pageSize debe ser un entero")
+    .min(1, "pageSize debe ser ≥ 1")
+    .max(150, "pageSize no puede superar 150")
+    .default(20),
+
+  /** Campo por el que se ordenan los resultados. Por defecto: "createdAt". */
+  orderBy: z
+    .string()
+    .min(1, "orderBy no puede estar vacío")
+    .default("createdAt"),
+
+  /** Dirección del ordenamiento. Por defecto: DESC. */
+  sortDirection: z.nativeEnum(SortDirection).default(SortDirection.DESC),
+});
+
+/** Tipo inferido del schema — equivalente a los campos del Builder */
+export type GetAttachmentFilesRequestData = z.infer<
+  typeof GetAttachmentFilesRequestSchema
+>;
+
+// ── Clase principal ───────────────────────────────────────────────────────────
+
+/**
+ * Request para obtener los archivos adjuntos de un caso en Shori.
+ *
+ * Usa el patrón Builder con validación Zod en `build()`.
+ * La paginación se gestiona con `PaginationRequest`
+ * (por defecto: `pageNumber: 0`, `pageSize: 20`, `orderBy: "createdAt"`, `sortDirection: DESC`).
+ *
+ * @example
+ * ```ts
+ * // Uso básico (paginación por defecto)
+ * const request = GetAttachmentFilesRequest.builder()
+ *   .casoId("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
+ *   .build();
+ *
+ * const archivos = await client.caso().files().getAttachments(request);
+ *
+ * // Con paginación personalizada
+ * const request = GetAttachmentFilesRequest.builder()
+ *   .casoId("caso-uuid")
+ *   .pageNumber(1)
+ *   .pageSize(50)
+ *   .orderBy("createdAt")
+ *   .sortDirection(SortDirection.ASC)
+ *   .build();
+ * ```
+ */
+export class GetAttachmentFilesRequest {
+  /** UUID del caso cuyos archivos se quieren obtener */
+  readonly casoId: string;
+  /** Paginación con los valores validados */
+  readonly pagination: PaginationRequest;
+
+  /** @internal — usar {@link GetAttachmentFilesRequest.builder()} */
+  private constructor(data: GetAttachmentFilesRequestData) {
+    this.casoId = data.casoId;
+    this.pagination = PaginationRequest.builder()
+      .pageSize(data.pageSize)
+      .pageNumber(data.pageNumber)
+      .orderBy(data.orderBy)
+      .sortDirection(data.sortDirection)
+      .build();
+  }
+
+  /**
+   * Crea un nuevo Builder para construir una instancia de `GetAttachmentFilesRequest`.
+   *
+   * @example
+   * ```ts
+   * const request = GetAttachmentFilesRequest.builder()
+   *   .casoId("caso-uuid")
+   *   .build();
+   * ```
+   */
+  static builder(): _GetAttachmentFilesRequestBuilder {
+    return new _GetAttachmentFilesRequestBuilder();
+  }
+
+  /** @internal */
+  static _create(
+    data: GetAttachmentFilesRequestData,
+  ): GetAttachmentFilesRequest {
+    return new GetAttachmentFilesRequest(data);
+  }
+}
+
+// ── Builder ───────────────────────────────────────────────────────────────────
+
+/**
+ * Builder fluido para `GetAttachmentFilesRequest`.
+ *
+ * La validación ocurre en `build()` usando Zod — lanza `ZodError` con
+ * mensajes detallados si algún campo es inválido.
+ *
+ * Obtén una instancia con `GetAttachmentFilesRequest.builder()`.
+ */
+export class _GetAttachmentFilesRequestBuilder {
+  private _casoId?: string;
+  private _pageNumber?: number;
+  private _pageSize?: number;
+  private _orderBy?: string;
+  private _sortDirection?: SortDirection;
+
+  /**
+   * Filtra por el UUID del caso con un operador específico.
+   * Debe ser un UUID válido.
+   *
+   * @param operator - El operador de filtrado a aplicar.
+   * @param values - Uno o más UUIDs del caso. **Requerido.**
+   * @returns La instancia actual para encadenamiento de métodos.
+   */
+  casoId(operator: FilterOperator, ...values: string[]): this;
+
+  /**
+   * Filtra por el UUID del caso usando el operador IN por defecto.
+   * Debe ser un UUID válido.
+   *
+   * @param values - Uno o más UUIDs del caso. **Requerido.**
+   * @returns La instancia actual para encadenamiento de métodos.
+   */
+  casoId(...values: string[]): this;
+
+  casoId(firstParam: FilterOperator | string, ...values: string[]): this {
+    if (firstParam instanceof FilterOperator) {
+      this._casoId = firstParam.apply(...values);
+    } else {
+      const allValues = [firstParam, ...values];
+      this._casoId = FilterOperator.IN.apply(...allValues);
+    }
+    return this;
+  }
+  /**
+   * Número de página (0-indexado). Por defecto: `0`.
+   * Debe ser un entero ≥ 0.
+   *
+   * @param value - Número de página
+   */
+  pageNumber(value: number): this {
+    this._pageNumber = value;
+    return this;
+  }
+
+  /**
+   * Cantidad de archivos por página. Por defecto: `20`.
+   * Debe ser entre 1 y 150.
+   *
+   * @param value - Tamaño de página
+   */
+  pageSize(value: number): this {
+    this._pageSize = value;
+    return this;
+  }
+
+  /**
+   * Campo por el que se ordenan los resultados. Por defecto: `"createdAt"`.
+   *
+   * @param value - Nombre del campo de ordenamiento
+   */
+  orderBy(value: string): this {
+    this._orderBy = value;
+    return this;
+  }
+
+  /**
+   * Dirección del ordenamiento. Por defecto: `SortDirection.DESC`.
+   *
+   * @param value - `SortDirection.ASC` o `SortDirection.DESC`
+   */
+  sortDirection(value: SortDirection): this {
+    this._sortDirection = value;
+    return this;
+  }
+
+  /**
+   * Valida todos los campos con Zod y construye la instancia.
+   *
+   * Lanza `ZodError` con mensajes detallados si algún campo es inválido:
+   * - `casoId` vacío o no es UUID → `"casoId debe ser un UUID válido"`
+   * - `pageSize` fuera de rango → `"pageSize no puede superar 200"`
+   * - etc.
+   *
+   * @throws {z.ZodError} si algún campo no pasa la validación
+   * @returns Instancia inmutable de `GetAttachmentFilesRequest`
+   *
+   * @example
+   * ```ts
+   * try {
+   *   const request = GetAttachmentFilesRequest.builder()
+   *     .casoId("no-es-uuid")
+   *     .build();
+   * } catch (err) {
+   *   if (err instanceof z.ZodError) {
+   *     err.issues.forEach(i => console.error(i.path, i.message));
+   *   }
+   * }
+   * ```
+   */
+  build(): GetAttachmentFilesRequest {
+    const data = GetAttachmentFilesRequestSchema.parse({
+      casoId: this._casoId,
+      pageNumber: this._pageNumber,
+      pageSize: this._pageSize,
+      orderBy: this._orderBy,
+      sortDirection: this._sortDirection,
+    });
+    return GetAttachmentFilesRequest._create(data);
+  }
+}

package/src/modules/caso/dto/request/nextStateRequest.ts

@@ -0,0 +1,17 @@
+/**
+ * Datos para cambiar el estado de un caso.
+ *
+ * @example
+ * ```ts
+ * await client.caso().state().next({
+ *   casoId: "caso-uuid",
+ *   stateId: "siguiente-estado-uuid",
+ * });
+ * ```
+ */
+export interface NextStateRequest {
+  /** UUID del caso */
+  casoId: string;
+  /** UUID del estado destino */
+  stateId: string;
+}

package/src/modules/caso/dto/request/paginationRequest.ts

@@ -0,0 +1,206 @@
+import { z } from "zod";
+import { SortDirection } from "../../filter/sortDirection.js";
+
+// ── Schema de validación Zod ──────────────────────────────────────────────────
+
+/**
+ * Schema Zod para `PaginationRequest`.
+ *
+ * Valida los parámetros de paginación antes de construir la instancia.
+ *
+ * @example
+ * ```ts
+ * const result = PaginationRequestSchema.safeParse({
+ *   pageSize: 50,
+ *   pageNumber: 0,
+ * });
+ * if (!result.success) {
+ *   console.error(result.error.issues);
+ * }
+ * ```
+ */
+export const PaginationRequestSchema = z.object({
+  /** Tamaño de página. Debe ser entre 1 y 150. Por defecto: 20. */
+  pageSize: z
+    .number({ error: "pageSize debe ser un número" })
+    .int("pageSize debe ser un entero")
+    .min(1, "pageSize debe ser ≥ 1")
+    .max(150, "pageSize no puede superar 150")
+    .default(20),
+
+  /** Número de página (0-indexado). Debe ser ≥ 0. Por defecto: 0. */
+  pageNumber: z
+    .number({ error: "pageNumber debe ser un número" })
+    .int("pageNumber debe ser un entero")
+    .min(0, "pageNumber debe ser ≥ 0")
+    .default(0),
+
+  /** Campo por el que se ordenan los resultados. Por defecto: "createdAt". */
+  orderBy: z
+    .string()
+    .min(1, "orderBy no puede estar vacío")
+    .default("createdAt"),
+
+  /** Dirección del ordenamiento. Por defecto: DESC. */
+  sortDirection: z.nativeEnum(SortDirection).default(SortDirection.DESC),
+});
+
+/** Tipo inferido del schema */
+export type PaginationRequestData = z.infer<typeof PaginationRequestSchema>;
+
+// ── Clase principal ───────────────────────────────────────────────────────────
+
+/**
+ * Configuración de paginación y ordenamiento para requests de Shori.
+ *
+ * Equivalente a `PaginationRequest.java`. Usa el patrón Builder con
+ * validación Zod en `build()`.
+ *
+ * @example
+ * ```ts
+ * // Valores por defecto (pageSize=20, pageNumber=0, orderBy="createdAt", DESC)
+ * const pagination = PaginationRequest.builder().build();
+ *
+ * // Personalizado
+ * const pagination = PaginationRequest.builder()
+ *   .pageSize(50)
+ *   .pageNumber(1)
+ *   .orderBy("createdAt")
+ *   .sortDirection(SortDirection.ASC)
+ *   .build();
+ * ```
+ */
+export class PaginationRequest {
+  /** Tamaño de página */
+  readonly pageSize: number;
+  /** Número de página (0-indexado) */
+  readonly pageNumber: number;
+  /** Campo de ordenamiento */
+  readonly orderBy: string;
+  /** Dirección del ordenamiento */
+  readonly sortDirection: SortDirection;
+
+  /** @internal — usar {@link PaginationRequest.builder()} */
+  private constructor(data: PaginationRequestData) {
+    this.pageSize = data.pageSize;
+    this.pageNumber = data.pageNumber;
+    this.orderBy = data.orderBy;
+    this.sortDirection = data.sortDirection;
+  }
+
+  /**
+   * Crea un nuevo Builder para construir una instancia de `PaginationRequest`.
+   *
+   * @example
+   * ```ts
+   * const pagination = PaginationRequest.builder().pageSize(50).build();
+   * ```
+   */
+  static builder(): _PaginationRequestBuilder {
+    return new _PaginationRequestBuilder();
+  }
+
+  /** @internal */
+  static _create(data: PaginationRequestData): PaginationRequest {
+    return new PaginationRequest(data);
+  }
+
+  /** Serialización para JSON.stringify */
+  toJSON(): Record<string, unknown> {
+    return {
+      pageSize: this.pageSize,
+      pageNumber: this.pageNumber,
+      orderBy: this.orderBy,
+      sortDirection: this.sortDirection,
+    };
+  }
+}
+
+// ── Builder ───────────────────────────────────────────────────────────────────
+
+/**
+ * Builder fluido para `PaginationRequest`.
+ *
+ * La validación ocurre en `build()` usando Zod.
+ * Todos los campos tienen valores por defecto — `build()` sin configuración
+ * crea una paginación con `pageSize=20`, `pageNumber=0`, `orderBy="createdAt"`, `sortDirection=DESC`.
+ *
+ * Obtén una instancia con `PaginationRequest.builder()`.
+ */
+export class _PaginationRequestBuilder {
+  private _pageSize?: number;
+  private _pageNumber?: number;
+  private _orderBy?: string;
+  private _sortDirection?: SortDirection;
+
+  /**
+   * Tamaño de página. Debe ser entre 1 y 200. Por defecto: `20`.
+   *
+   * @param value - Cantidad de registros por página
+   */
+  pageSize(value: number): this {
+    this._pageSize = value;
+    return this;
+  }
+
+  /**
+   * Número de página (0-indexado). Debe ser ≥ 0. Por defecto: `0`.
+   *
+   * @param value - Número de página
+   */
+  pageNumber(value: number): this {
+    this._pageNumber = value;
+    return this;
+  }
+
+  /**
+   * Campo por el que se ordenan los resultados. Por defecto: `"createdAt"`.
+   *
+   * @param value - Nombre del campo de ordenamiento
+   */
+  orderBy(value: string): this {
+    this._orderBy = value;
+    return this;
+  }
+
+  /**
+   * Dirección del ordenamiento. Por defecto: `SortDirection.DESC`.
+   *
+   * @param value - `SortDirection.ASC` o `SortDirection.DESC`
+   */
+  sortDirection(value: SortDirection): this {
+    this._sortDirection = value;
+    return this;
+  }
+
+  /**
+   * Valida los campos con Zod y construye la instancia.
+   *
+   * No lanza error si no se configura nada — todos los campos tienen defaults.
+   * Lanza `ZodError` si se pasa un valor inválido (ej: `pageSize(-1)`).
+   *
+   * @throws {z.ZodError} si algún campo no pasa la validación
+   * @returns Instancia inmutable de `PaginationRequest`
+   *
+   * @example
+   * ```ts
+   * try {
+   *   PaginationRequest.builder().pageSize(-1).build();
+   * } catch (err) {
+   *   if (err instanceof z.ZodError) {
+   *     err.issues.forEach(i => console.error(i.path[0], i.message));
+   *     // pageSize "pageSize debe ser ≥ 1"
+   *   }
+   * }
+   * ```
+   */
+  build(): PaginationRequest {
+    const data = PaginationRequestSchema.parse({
+      pageSize: this._pageSize,
+      pageNumber: this._pageNumber,
+      orderBy: this._orderBy,
+      sortDirection: this._sortDirection,
+    });
+    return PaginationRequest._create(data);
+  }
+}

package/src/modules/caso/dto/response/actionResponse.ts

@@ -0,0 +1,9 @@
+export interface ActionResponse {
+  id: string;
+  name: string;
+  description?: string;
+  eventType: string;
+  eventTypeName: string;
+  externalType: string;
+  params: string;
+}

package/src/modules/caso/dto/response/addCommentResponse.ts

@@ -0,0 +1,4 @@
+/** Respuesta al agregar un comentario */
+export interface AddCommentResponse {
+  id?: string;
+}

package/src/modules/caso/dto/response/caseDataFieldResponse.ts

@@ -0,0 +1,38 @@
+export interface CaseDataFieldResponse {
+  /** Identificador único del campo de datos. */
+  id: string;
+  /** Nombre técnico o interno del campo. */
+  name: string;
+  /** Etiqueta visual (UI) que se muestra al usuario final. */
+  label: string;
+  /** Indica si el valor del campo está encriptado por motivos de seguridad. */
+  encrypted: boolean;
+  /** Identificador único del tipo de datos del campo (ej. Texto, Número, Fecha). */
+  fieldTypeId: string;
+  /** Nombre descriptivo del tipo de datos del campo. */
+  fieldTypeName: string;
+  /** Indica si el campo se despliega como una columna en las vistas de tablas. */
+  isColumn: boolean;
+  /** Indica si el campo admite múltiples valores (lista o arreglo). */
+  isMultiValue: boolean;
+  /** Indica si el campo hace referencia a una entidad externa del sistema. */
+  isEntity: boolean;
+  /** Define si el campo se encuentra activo y disponible para su uso. */
+  active: boolean;
+  /** Indica si el campo maneja múltiples valores específicos dentro de una tarea. */
+  isMultivalueTask: boolean;
+  /** Identificador del campo padre, en caso de existir una relación jerárquica. */
+  parentField: string;
+  /** Nombre del campo expuesto a través de la API pública. */
+  apiName: string;
+  /** Nombre del campo a nivel de sistema o base de datos. */
+  systemName: string;
+  /** Identificador del tipo de caso (CasoType) al que pertenece este campo. */
+  casoTypeId: string;
+  /** Identificador del nivel primario o categoría principal de la estructura del caso. */
+  primaryLevelId: string;
+  /** Lista de identificadores de los campos hijos que dependen de este campo. */
+  children: string[];
+  /** Indica si el campo actúa como el asunto principal o título del caso. */
+  isSubject: boolean;
+}

package/src/modules/caso/dto/response/caseFileSearchResult.ts

@@ -0,0 +1,8 @@
+import { CasoFileSearchResponse } from "./casoFileSearchResponse";
+
+export interface CaseFileSearchResult {
+  files: CasoFileSearchResponse[];
+  pag: number;
+  numElements: number;
+  count: number;
+}

package/src/modules/caso/dto/response/caseSearchResult.ts

@@ -0,0 +1,13 @@
+import { CasoSearchResponse } from "./casoSearchResponse";
+
+/** Resultado paginado de una búsqueda de casos */
+export interface CaseSearchResult {
+  /** Lista de casos de la página actual */
+  casoResponse: CasoSearchResponse[];
+  /** Total de casos que cumplen los filtros */
+  count: number;
+  /** Número de elementos */
+  numElements: number;
+  /** Número de página */
+  pag: number;
+}

package/src/modules/caso/dto/response/casoCreateResponse.ts

@@ -0,0 +1,21 @@
+/**
+ * Respuesta conveniente al crear un caso (re-mapeada para claridad).
+ */
+export interface CasoCreateResponse {
+  /** UUID del caso creado */
+  casoId: string;
+  /** Número de caso */
+  casoNumber: number;
+}
+
+/**
+ * Respuesta interna de la API al crear un caso.
+ * El campo "caso" contiene el UUID y "casoId" el número del caso.
+ * @internal
+ */
+export interface CasoCreateResponseAux {
+  /** UUID del caso creado (campo JSON: "caso") */
+  caso: string;
+  /** Número de caso (campo JSON: "casoId") */
+  casoId: number;
+}

package/src/modules/caso/dto/response/casoFileSearchResponse.ts

@@ -0,0 +1,20 @@
+/** Metadatos de archivo adjunto de un caso (sin el contenido descargado) */
+export interface CasoFileSearchResponse {
+  id: string;
+  casoId: string;
+  fileName: string;
+  extension: string;
+  documentId: string;
+  isValid: boolean;
+  userName: string;
+  createdAt: string;
+  resolutionGroup: string;
+  name: string;
+  taskId?: string;
+  fileCategoryId?: string;
+  fileCategoryName?: string;
+  fileTypologyId?: string;
+  fileTypologyName?: string;
+
+  file?: File;
+}

package/src/modules/caso/dto/response/casoResponse.ts

@@ -0,0 +1,85 @@
+import { CasoFileSearchResponse } from "./casoFileSearchResponse";
+import { CommentResponse } from "./commentResponse";
+
+/**
+ * Respuesta completa de un caso (de `findById`).
+ *
+ * IMPORTANTE: Los nombres de campo coinciden con los JSON de la API
+ * (`@JsonProperty` en Java). El UUID del caso es el campo `caso` y
+ * el número de caso es `casoId` (un número).
+ */
+export interface CasoResponse {
+  /** UUID del caso (campo JSON: "caso") */
+  caso: string;
+  /** Número de caso (campo JSON: "casoId") */
+  casoId: string;
+  casoNumber?: number;
+  /** Datos del formulario en formato raw JSON string */
+  casoData?: string;
+  /** UUID del tipo de caso (producto) */
+  casoTypeId: string;
+  /** Nombre del producto */
+  casoTypeName: string;
+  /** Nombre interno del producto */
+  casoTypeSystemName: string;
+  /** UUID del nivel secundario */
+  secondaryLevelId: string;
+  /** Nombre del nivel secundario */
+  secondaryLevel: string;
+  /** UUID del nivel primario */
+  primaryLevelId: string;
+  /** Nombre del nivel primario */
+  primaryLevel: string;
+  /** UUID del usuario asignado */
+  assignedUserId?: string;
+  /** Nombre del usuario asignado */
+  assignedUserName?: string;
+  /** UUID del responsable */
+  responsibleId?: string;
+  /** Nombre del responsable */
+  responsibleName?: string;
+  /** UUID del subestado actual */
+  workingSubStateId: string;
+  /** Nombre del subestado actual */
+  workingSubStateName: string;
+  /** Nombre interno del subestado */
+  workingSubStateSystemName: string;
+  /** UUID del estado */
+  stateId: string;
+  /** Estado del caso */
+  state?: string;
+  /** ¿Es urgente? */
+  isUrgent?: boolean;
+  /** UUID de la prioridad */
+  priorityId?: string;
+  /** Nombre de la prioridad */
+  priorityName?: string;
+  /** ID externo */
+  externalId?: string;
+  /** UUID del creador */
+  createdBy: string;
+  /** Nivel de grupo */
+  groupLevel: number;
+  /** Fecha de creación */
+  createdAt: string;
+  /** Fecha de actualización */
+  updatedAt?: string;
+  /** Fecha máxima del SLA */
+  slaMaxDate?: string;
+  /** Fecha de inicio del SLA */
+  slaStartDate?: string;
+  /** ¿Cumple el SLA? */
+  meetSla?: boolean;
+  /** ¿Está finalizado? */
+  finalized?: boolean;
+  /** ¿SLA pausado? */
+  pausedSla?: boolean;
+  /** ¿En proceso? */
+  inProcess?: boolean;
+  /** Asunto del caso */
+  subject?: string;
+  /** Archivos adjuntos */
+  files: CasoFileSearchResponse[];
+  /** Últimos comentarios */
+  lastComments: CommentResponse[];
+}