shori-sdk-ts 1.1.3 → 1.1.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shori-sdk-ts",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "description": "SDK TypeScript para integrar aplicaciones JS/TS con la plataforma Shori BPM de NTT DATA",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",

package/.env

@@ -1,7 +0,0 @@
-# Copia este archivo a .env y rellena con tus credenciales reales
-# .env está en .gitignore — nunca se commitea
-
-VITE_SHORI_PORTAL_ID=0306444E-38B1-403D-8753-EC9C2BC43215
-VITE_SHORI_TENANT_ID=80ff134a-cae2-4a4a-92b9-a109bdee1183
-VITE_SHORI_API_KEY=B5577FB9-75DF-440C-831D-E42958AD1A79
-VITE_SHORI_ENVIRONMENT=UAT

package/src/auth/AuthService.ts

@@ -1,61 +0,0 @@
-import type { ShoriConfig } from "../config/ShoriConfig.js";
-
-/** Respuesta del endpoint de autenticación. */
-interface AuthResponse {
-  token: string;
-}
-
-/**
- * Servicio de autenticación con Shori.
- * Obtiene el Bearer token usando la X-ApiKey.
- * Equivalente a AuthService.java
- */
-export class AuthService {
-  private readonly config: ShoriConfig;
-
-  constructor(config: ShoriConfig) {
-    this.config = config;
-  }
-
-  /**
-   * Obtiene el token Bearer desde el endpoint de autenticación.
-   * Usa X-ApiKey — nunca Bearer token.
-   */
-  async authenticate(): Promise<string> {
-    const url = `${this.config.identifyUrl}/v3/authentication`;
-
-    const controller = new AbortController();
-    const timerId = setTimeout(() => controller.abort(), this.config.timeoutMs);
-
-    try {
-      const headers = new Headers();
-      headers.append("X-ApiKey", String(this.config.apiKey));
-      headers.append("X-TenantID", String(this.config.tenantId));
-      headers.append("Portal", String(this.config.portalId));
-      const response = await fetch(url, {
-        method: "GET",
-        headers: headers,
-        signal: controller.signal,
-      });
-      if (!response.ok) {
-        const body = await response.text().catch(() => "");
-        throw new Error(
-          `Error de autenticación HTTP ${response.status}: ${body}`,
-        );
-      }
-
-      const data = (await response.json()) as AuthResponse;
-      return data.token;
-    } catch (err) {
-      console.error(err);
-      if (err instanceof Error && err.name === "AbortError") {
-        throw new Error(
-          `Timeout de autenticación (${this.config.timeoutMs}ms)`,
-        );
-      }
-      throw err;
-    } finally {
-      clearTimeout(timerId);
-    }
-  }
-}

package/src/auth/TokenProvider.ts

@@ -1,62 +0,0 @@
-import type { AuthService } from "./AuthService.js";
-
-/**
- * Proveedor de tokens Bearer con lazy-loading y renovación automática.
- *
- * Equivalente a TokenProvider.java.
- * En JS no hay threads, pero sí hay concurrencia async — si múltiples
- * requests se ejecutan en paralelo y el token expira, solo uno refresca
- * y los demás reutilizan el resultado gracias al Promise compartido.
- */
-export class TokenProvider {
-  private token: string | null = null;
-  /** Promise en vuelo para evitar múltiples refreshes simultáneos */
-  private refreshPromise: Promise<string> | null = null;
-  private readonly authService: AuthService;
-
-  constructor(authService: AuthService) {
-    this.authService = authService;
-  }
-
-  /**
-   * Obtiene el token Bearer vigente.
-   * Si no hay token, autentica de forma lazy.
-   * Si hay una autenticación en curso, espera a la misma (no lanza una segunda).
-   */
-  async getToken(): Promise<string> {
-    if (this.token) return this.token;
-    return this.refresh();
-  }
-
-  /**
-   * Invalida el token actual y fuerza una nueva autenticación.
-   * Si ya hay un refresh en curso, espera ese mismo (no duplica la llamada).
-   */
-  async invalidateAndRefresh(): Promise<string> {
-    this.token = null;
-    return this.refresh();
-  }
-
-  private async refresh(): Promise<string> {
-    // Si ya hay un refresh en curso, compartir el mismo Promise
-    if (this.refreshPromise) return this.refreshPromise;
-
-    this.refreshPromise = this.authService
-      .authenticate()
-      .then((newToken) => {
-        this.token = newToken;
-        return newToken;
-      })
-      .finally(() => {
-        this.refreshPromise = null;
-      });
-
-    return this.refreshPromise;
-  }
-
-  /** Limpia el token cacheado (útil en tests o al cerrar el cliente) */
-  clear(): void {
-    this.token = null;
-    this.refreshPromise = null;
-  }
-}

package/src/client/ShoriClient.ts

@@ -1,104 +0,0 @@
-import type { ShoriConfig } from "../config/ShoriConfig.js";
-import type { HttpExecutor } from "../http/HttpExecutor.js";
-import type { RepoModule } from "../modules/repo/repoModule.js";
-import type { CaseModule } from "../modules/caso/caseModule.js";
-
-/**
- * Punto de entrada principal del SDK de Shori para TypeScript/JavaScript.
- *
- * Compatible con Node.js 18+, React, Next.js, NestJS, Express y cualquier
- * entorno que soporte fetch nativo.
- *
- * @example
- * ```ts
- * import { ShoriClientBuilder, ShoriEnvironment } from "@nttdata/shori-api-client";
- *
- * const client = new ShoriClientBuilder()
- *   .environment(ShoriEnvironment.PROD)
- *   .portalId("mi-portal-id")
- *   .tenantId("mi-tenant-id")
- *   .apiKey("mi-api-key")
- *   .build();
- * ```
- */
-export class ShoriClient {
-  /** Configuración activa del cliente */
-  readonly config: ShoriConfig;
-
-  /** @internal — usado por los módulos de negocio */
-  readonly _httpExecutor: HttpExecutor;
-
-  private readonly _repoModule: RepoModule;
-  private readonly _caseModule: CaseModule;
-
-  /** @internal — usar ShoriClientBuilder para crear instancias */
-  constructor(
-    config: ShoriConfig,
-    httpExecutor: HttpExecutor,
-    repoModule: RepoModule,
-    caseModule: CaseModule,
-  ) {
-    this.config = config;
-    this._httpExecutor = httpExecutor;
-    this._repoModule = repoModule;
-    this._caseModule = caseModule;
-  }
-
-  /**
-   * Accede al módulo de Repositorio de Documentos.
-   *
-   * Permite subir, descargar y eliminar documentos del repositorio de Shori.
-   *
-   * @example
-   * ```ts
-   * // Subir
-   * const docId = await client.repo().document().upload({ file, casoId, casoTypeId });
-   *
-   * // Descargar
-   * const blob = await client.repo().download().byDocument({ documentId: docId });
-   *
-   * // Exportar como PDF
-   * const pdf = await client.repo().download().exportDocument({ documentId: docId });
-   * ```
-   */
-  repo(): RepoModule {
-    return this._repoModule;
-  }
-
-  /**
-   * Accede al módulo de Casos.
-   *
-   * Permite crear, buscar, actualizar casos y acceder a sub-módulos
-   * especializados para estados, comentarios y tipos de caso.
-   *
-   * @example
-   * ```ts
-   * // Crear un caso.
-   * const result = await client.caso().create({ casoTypeId, formId, priority });
-   *
-   * // Buscar con auto-paginación
-   * const todos = await client.caso().searchAll(
-   *   new CaseFilter().casoTypeId(FilterOperator.EQ, "tipo-uuid")
-   *     .workingSubStateId(FilterOperator.IN, ...openStateIds)
-   * );
-   *
-   * // Sub-módulos
-   * client.caso().state()    // avanzar estado
-   * client.caso().comment()  // comentarios
-   * client.caso().casoType() // tipos de caso
-   * ```
-   */
-  caso(): CaseModule {
-    return this._caseModule;
-  }
-
-  /**
-   * Libera los recursos asociados al cliente.
-   *
-   * En JS/TS no hay pool que cerrar — este método existe por
-   * paridad de API con el SDK Java y para compatibilidad futura.
-   */
-  close(): void {
-    // No-op en TS: fetch nativo no mantiene conexiones persistentes
-  }
-}

package/src/client/ShoriClientBuilder.ts

@@ -1,138 +0,0 @@
-import { ShoriConfig } from "../config/ShoriConfig.js";
-import { ShoriEnvironment } from "../config/ShoriEnvironment.js";
-import { AuthService } from "../auth/AuthService.js";
-import { TokenProvider } from "../auth/TokenProvider.js";
-import { HttpExecutor } from "../http/HttpExecutor.js";
-import { ShoriClient } from "./ShoriClient.js";
-import { ValidationException } from "../exception/ShoriException.js";
-import { RepoModule } from "../modules/repo/repoModule.js";
-import { CaseModule } from "../modules/caso/caseModule.js";
-
-/**
- * Builder fluido para construir instancias de ShoriClient.
- *
- * Equivalente a ShoriClientBuilder.java — misma API, mismo comportamiento.
- *
- * @example
- * ```ts
- * // Uso básico
- * const client = new ShoriClientBuilder()
- *   .environment(ShoriEnvironment.PROD)
- *   .portalId("mi-portal-id")
- *   .tenantId("mi-tenant-id")
- *   .apiKey("mi-api-key")
- *   .build();
- *
- * // Uso en Next.js / NestJS (archivo de configuración)
- * export const shoriClient = new ShoriClientBuilder()
- *   .environment(ShoriEnvironment.PROD)
- *   .portalId(process.env.SHORI_PORTAL_ID!)
- *   .tenantId(process.env.SHORI_TENANT_ID!)
- *   .apiKey(process.env.SHORI_API_KEY!)
- *   .build();
- * ```
- */
-export class ShoriClientBuilder {
-  private _environment?: ShoriEnvironment;
-  private _portalId?: string;
-  private _tenantId?: string;
-  private _apiKey?: string;
-  private _timeoutMs: number = 30_000;
-
-  /**
-   * Establece el ambiente de Shori.
-   * @param environment DEV | UAT | PROD
-   */
-  environment(environment: ShoriEnvironment): this {
-    this._environment = environment;
-    return this;
-  }
-
-  /**
-   * Establece el ID del portal de Shori.
-   * @param portalId UUID del portal (ej: "0306444E-38B1-403D-8753-EC9C2BC43215")
-   */
-  portalId(portalId: string): this {
-    this._portalId = portalId;
-    return this;
-  }
-
-  /**
-   * Establece el ID del tenant de Shori.
-   * @param tenantId UUID del tenant (ej: "80ff134a-cae2-4a4a-92b9-a109bdee1183")
-   */
-  tenantId(tenantId: string): this {
-    this._tenantId = tenantId;
-    return this;
-  }
-
-  /**
-   * Establece la API Key para autenticación.
-   * @param apiKey Clave de API proporcionada por Shori
-   */
-  apiKey(apiKey: string): this {
-    this._apiKey = apiKey;
-    return this;
-  }
-
-  /**
-   * Establece el timeout de los requests en milisegundos.
-   * @param timeoutMs Milisegundos. Por defecto: 30000 (30s)
-   */
-  timeoutMs(timeoutMs: number): this {
-    if (timeoutMs <= 0) {
-      throw new ValidationException("El timeout debe ser mayor a 0 ms");
-    }
-    this._timeoutMs = timeoutMs;
-    return this;
-  }
-
-  /**
-   * Valida la configuración y construye la instancia de ShoriClient.
-   *
-   * @returns ShoriClient completamente inicializado
-   * @throws ValidationException si falta algún parámetro requerido
-   */
-  build(): ShoriClient {
-    this.validate();
-
-    const config = new ShoriConfig({
-      environment: this._environment!,
-      portalId: this._portalId!,
-      tenantId: this._tenantId!,
-      apiKey: this._apiKey!,
-      timeoutMs: this._timeoutMs,
-    });
-
-    const authService = new AuthService(config);
-    const tokenProvider = new TokenProvider(authService);
-    const httpExecutor = new HttpExecutor(config, tokenProvider);
-    const repoModule = new RepoModule(config, httpExecutor);
-    const caseModule = new CaseModule(config, httpExecutor, repoModule);
-
-    return new ShoriClient(config, httpExecutor, repoModule, caseModule);
-  }
-
-  private validate(): void {
-    if (!this._environment) {
-      throw new ValidationException(
-        "El ambiente es requerido. Usa .environment(ShoriEnvironment.DEV | UAT | PROD)",
-      );
-    }
-    if (!this._portalId?.trim()) {
-      throw new ValidationException(
-        'El Portal ID es requerido. Usa .portalId("tu-portal-id")',
-      );
-    }
-    if (!this._tenantId?.trim()) {
-      throw new ValidationException(
-        'El Tenant ID es requerido. Usa .tenantId("tu-tenant-id")',
-      );
-    }
-    if (!this._apiKey?.trim()) {
-      throw new ValidationException(
-        'La API Key es requerida. Usa .apiKey("tu-api-key")',
-      );
-    }
-  }
-}

package/src/config/ShoriConfig.ts

@@ -1,45 +0,0 @@
-import { ShoriEnvironment, getEnvironmentUrls } from "./ShoriEnvironment.js";
-
-/**
- * Configuración inmutable del SDK de Shori.
- * Equivalente a ShoriConfig.java
- */
-export interface ShoriConfigOptions {
-  /** Ambiente de Shori (DEV, UAT, PROD) */
-  environment: ShoriEnvironment;
-  /** ID del portal */
-  portalId: string;
-  /** ID del tenant */
-  tenantId: string;
-  /** API Key para autenticación */
-  apiKey: string;
-  /** Timeout de los requests en milisegundos. Por defecto: 30000 (30s) */
-  timeoutMs?: number;
-}
-
-/**
- * Configuración resuelta con URLs calculadas
- */
-export class ShoriConfig {
-  readonly environment: ShoriEnvironment;
-  readonly portalId: string;
-  readonly tenantId: string;
-  readonly apiKey: string;
-  readonly timeoutMs: number;
-  readonly caseUrl: string;
-  readonly identifyUrl: string;
-  readonly repoUrl: string;
-
-  constructor(options: ShoriConfigOptions) {
-    this.environment = options.environment;
-    this.portalId = options.portalId;
-    this.tenantId = options.tenantId;
-    this.apiKey = options.apiKey;
-    this.timeoutMs = options.timeoutMs ?? 30_000;
-
-    const urls = getEnvironmentUrls(options.environment);
-    this.caseUrl = urls.caseUrl;
-    this.identifyUrl = urls.identifyUrl;
-    this.repoUrl = urls.repoUrl;
-  }
-}

package/src/config/ShoriEnvironment.ts

@@ -1,39 +0,0 @@
-/**
- * Ambientes pre-configurados de Shori con sus URLs correspondientes.
- * Equivalente a ShoriEnvironment.java
- */
-export enum ShoriEnvironment {
-  /** Ambiente de desarrollo */
-  DEV = "DEV",
-  /** Ambiente de UAT (User Acceptance Testing) */
-  UAT = "UAT",
-  /** Ambiente de producción */
-  PROD = "PROD",
-}
-
-/** URLs base por ambiente */
-export const SHORI_ENVIRONMENT_URLS: Record<
-  ShoriEnvironment,
-  { caseUrl: string; identifyUrl: string; repoUrl: string }
-> = {
-  [ShoriEnvironment.DEV]: {
-    caseUrl: "https://shori-caso-uat.clonika.com",
-    identifyUrl: "https://shori-identify-uat.clonika.com",
-    repoUrl: "https://shori-repo-uat.clonika.com",
-  },
-  [ShoriEnvironment.UAT]: {
-    caseUrl: "https://shori-caso-uat.clonika.com",
-    identifyUrl: "https://shori-identify-uat.clonika.com",
-    repoUrl: "https://shori-repo-uat.clonika.com",
-  },
-  [ShoriEnvironment.PROD]: {
-    caseUrl: "https://shori-caso.clonika.com",
-    identifyUrl: "https://shori-identify.clonika.com",
-    repoUrl: "https://shori-repo.clonika.com",
-  },
-};
-
-/** Obtiene las URLs del ambiente dado */
-export function getEnvironmentUrls(env: ShoriEnvironment) {
-  return SHORI_ENVIRONMENT_URLS[env];
-}

package/src/exception/ShoriException.ts

@@ -1,43 +0,0 @@
-/** Excepción base del SDK de Shori */
-export class ShoriException extends Error {
-  readonly cause?: unknown;
-  constructor(message: string, cause?: unknown) {
-    super(message);
-    this.name = "ShoriException";
-    this.cause = cause;
-  }
-}
-
-/** Error HTTP del API (4xx, 5xx) */
-export class ApiException extends ShoriException {
-  readonly statusCode: number;
-  constructor(message: string, statusCode: number, cause?: unknown) {
-    super(message, cause);
-    this.name = "ApiException";
-    this.statusCode = statusCode;
-  }
-}
-
-/** Error de autenticación */
-export class AuthenticationException extends ShoriException {
-  constructor(message: string, cause?: unknown) {
-    super(message, cause);
-    this.name = "AuthenticationException";
-  }
-}
-
-/** Recurso no encontrado (HTTP 404) */
-export class ResourceNotFoundException extends ShoriException {
-  constructor(message: string) {
-    super(message);
-    this.name = "ResourceNotFoundException";
-  }
-}
-
-/** Parámetro inválido en el SDK */
-export class ValidationException extends ShoriException {
-  constructor(message: string) {
-    super(message);
-    this.name = "ValidationException";
-  }
-}