griddo-sdk 2.0.12 → 2.0.14

package/CHANGELOG.md

@@ -0,0 +1,149 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+#### Logging System
+- **Sistema de logging flexible basado en el patrón Adapter** para permitir múltiples implementaciones de logger
+  - **PinoLogger**: Nueva implementación por defecto usando Pino (logger JSON de alto rendimiento, ~5x más rápido que console)
+  - **LoggerFactory**: Factory para crear instancias de Logger según configuración
+  - **Tipos LoggerConfig y LoggerType**: Configuración avanzada del sistema de logging
+  - **Inyección de loggers personalizados**: Posibilidad de inyectar cualquier logger que cumpla la interfaz `Logger`
+  - **Tipos exportados**: `Logger`, `LoggerConfig`, `LoggerType` disponibles para consumidores del SDK
+  - Niveles de soporte: `info`, `error`, `debug` con opción `verbose` para activar logs detallados
+  - Pretty print automático en desarrollo usando `pino-pretty`
+  - **Test Coverage**: 100% coverage para PinoLogger y LoggerFactory (19 tests nuevos)
+  - **Test Coverage**: 144 tests pasan exitosamente (sin breaking changes)
+
+#### Site Management
+- **`getSocials` method** in `SiteService` and `SiteFacade` for retrieving social network URLs
+  - New TypeScript types added to `src/sdk.ts`:
+    - `SocialName` type: Union type for supported social networks (instagram, linkedIn, facebook, twitter, youTube, flickr, tiktok, snapchat, newsletter)
+    - `SocialsResponse` type: Record mapping each social network name to its corresponding URL
+  - API endpoint: `GET /site/{id}/socials`
+  - Implemented in `SiteService.getSocials(id: string | number)`
+  - Facade available via `SiteFacade.getSocials(id: string | number)`
+  - Spanish log messages for success and error cases
+  - **Test Coverage:** 100% coverage for both SiteService and SiteFacade
+  - **Example:** `examples/site/get_socials.ts` demonstrates usage
+  - **Types exported:** `SocialName` and `SocialsResponse` available for consumer use
+
+- **`getSitemap` method** in `SiteService` and `SiteFacade` for retrieving sitemaps
+  - New TypeScript types added to `src/sdk.ts`:
+    - `SitemapUrl` interface: Contains `path`, `domain`, and `home` properties
+    - `SitemapItem` interface: Contains `loc`, `lastmod`, and `priority` properties
+    - `SitemapItems` type: Record mapping URLs to sitemap items
+    - `SitemapResponse` interface: Complete sitemap response structure with URLs and items
+  - API endpoint: `GET /site/{id}/sitemap`
+  - Implemented in `SiteService.getSitemap(id: string | number)`
+  - Facade available via `SiteFacade.getSitemap(id: string | number)`
+  - Spanish log messages for success and error cases
+  - **Test Coverage:**
+    - SiteService: 100% coverage (5 tests passing)
+    - SiteFacade: 82.05% coverage (7 tests passing)
+    - Tests include success scenarios and error handling
+  - **Example:** `examples/site/get_sitemap.ts` demonstrates usage
+
+#### Build Management
+- **`buildStart` method** in `SiteService` and `SiteFacade` for initiating build processes
+  - API endpoint for build initialization
+  - Test coverage and mock updates included
+
+- **`buildEnd` method** in `SiteService` and `SiteFacade` for finalizing builds
+  - Complete build lifecycle management
+  - Comprehensive test suite and examples
+  - Mock updates for testing scenarios
+
+#### Error Handling
+- **`SiteException` class** for site-specific error handling
+  - Custom error types extending `BaseException`
+  - Structured error codes with severity levels
+  - Integration with `ErrorHandlingService`
+
+#### Architecture
+- **SiteService integration** into SDK architecture
+  - `SiteFacade` added to main SDK entry point
+  - Lazy-loading pattern for site management functionality
+  - ServiceFactory integration for SiteService instances
+  - Dependency injection pattern throughout
+
+### Changed
+
+#### Logging
+- **StdoutLogger marcado como @deprecated** en favor de PinoLogger
+  - Se mantiene por backwards compatibility pero se recomienda usar PinoLogger
+  - Aviso en JSDoc sobre preferir PinoLogger o inyectar logger personalizado
+
+#### Configuration
+- **Client header defaults** refactor in PageFacade
+  - Enhanced page update methods with improved header management
+  - Better separation of concerns between services
+
+#### Documentation
+- **Enhanced documentation** para sistema de logging en docs_dev y Docusaurus
+  - **Updated Configuración.md** con sección de Sistema de Logging integrada
+  - **Sistema de Logging.md** creado en docs_dev con ejemplos de uso
+- **Enhanced documentation** for image management methods
+- **Improved documentation** for page processing methods across services and facades
+- Updated JSDoc comments for better API clarity
+
+### Technical Details
+
+#### Files Modified for getSocials Feature:
+1. **src/sdk.ts** - Type definitions (SocialName, SocialsResponse)
+2. **src/index.ts** - Exported new types
+3. **src/interfaces/SiteManager.ts** - Method signature: `getSocials(id: string | number): Promise<SocialsResponse>`
+4. **src/services/SiteService.ts** - GET endpoint implementation: `/site/{id}/socials`
+5. **src/facades/SiteFacade.ts** - Facade with Spanish logging
+6. **__tests__/services/SiteService.test.ts** - Test suite
+7. **__tests__/facades/SiteFacade.test.ts** - Success and error tests
+8. **__tests__/mocks/site.ts** - Socials response mock data
+9. **examples/site/get_socials.ts** - Usage example
+
+#### Files Modified for getSitemap Feature:
+1. **src/sdk.ts** - Type definitions (SitemapUrl, SitemapItem, SitemapItems, SitemapResponse)
+2. **src/index.ts** - Exported new types
+3. **src/interfaces/SiteManager.ts** - Method signature: `getSitemap(id: string | number): Promise<SitemapResponse>`
+4. **src/services/SiteService.ts** - GET endpoint implementation: `/site/{id}/sitemap`
+5. **src/facades/SiteFacade.ts** - Facade with Spanish logging
+6. **__tests__/services/SiteService.test.ts** - Test suite
+7. **__tests__/facades/SiteFacade.test.ts** - Success and error tests
+8. **__tests__/mocks/site.ts** - Sitemap response mock data
+9. **examples/site/get_sitemap.ts** - Usage example
+
+## [2.0.8] - 2025-01-XX
+
+### Changed
+- Made `clientName` and `clientVersion` optional in SDK configuration
+
+## [2.0.7] - 2025-01-XX
+
+### Changed
+- Made `clientName` and `clientVersion` optional in SDK configuration
+
+## [2.0.6] - 2025-01-XX
+
+### Changed
+- Made `clientName` and `clientVersion` optional in SDK configuration
+
+## [2.0.4] - 2025-01-XX
+
+### Changed
+- Initial release candidate version
+
+---
+
+## Version Classification
+
+- **Added**: New features
+- **Changed**: Changes in existing functionality
+- **Deprecated**: Soon-to-be removed features
+- **Removed**: Removed features
+- **Fixed**: Bug fixes
+- **Security**: Security vulnerability fixes

package/CLAUDE.md

@@ -0,0 +1,153 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+Griddo SDK is a TypeScript library for integrating with the Griddo API. It provides a modular architecture using facades, services, and factories to interact with pages, alerts, languages, images, structured data, and site management.
+
+## Common Commands
+
+### Build
+```bash
+npm run build              # Full build (esbuild + types + aliases)
+npm run build:tsc          # Build with esbuild and TypeScript declarations
+npm run build:doc          # Generate TypeDoc documentation
+npm run build:doc:md       # Generate documentation as markdown
+```
+
+### Testing
+```bash
+npm test                  # Run all tests with vitest
+npm run test:ui           # Run tests with UI
+npm run test:coverage     # Run tests with coverage report
+npm run test:sync         # Run tests synchronously (no file parallelism)
+```
+
+### Development
+```bash
+npm run lint              # Lint source files
+npm run lint:fix          # Fix linting issues automatically
+npm run prettier          # Format code with Prettier
+npm run dev:connection    # Compile example connection file
+```
+
+### Running Examples
+```bash
+npm run run:example site/build_end    # Run a specific example (use tsx under the hood)
+# Usage: npm run run:example <filename> [testName]
+```
+
+### Release
+```bash
+npm run release           # Create a new release using release-it
+```
+
+## Architecture
+
+### Layer Structure
+
+The SDK follows a layered architecture with clear separation of concerns:
+
+```
+SDK (entry point)
+  ↓
+Facades (simplified user interface)
+  ↓
+Services (business logic)
+  ↓
+ApiService (HTTP communication)
+  ↓
+HttpClient (fetch/node-fetch/undici)
+```
+
+### Key Patterns
+
+1. **Factory Pattern** (`ServiceFactory`, `HttpClientFactory`): Centralizes instance creation with singleton services
+2. **Facade Pattern** (`PageFacade`, `AlertFacade`, etc.): Simplifies service interfaces
+3. **Dependency Injection**: All services receive dependencies via constructor
+4. **Decorator Pattern**: HttpClient decorators add timeout, retry, logging, error handling
+
+### Core Components
+
+- **SDK** (`src/index.ts`): Main entry point, lazy-loads facades on first access
+- **ServiceFactory** (`src/factories/ServiceFactory.ts`): Creates and manages service instances
+- **HttpClientFactory** (`src/factories/HttpClientFactory.ts`): Creates HTTP clients with decorators
+- **Services** (`src/services/`): Business logic layer (ApiService, PageService, etc.)
+- **Facades** (`src/facades/`): User-facing interfaces for services
+- **Exceptions** (`src/exception/`): Custom error classes extending `BaseException`
+
+### Path Aliases
+
+The project uses path aliases defined in `tsconfig.json`:
+- `@griddo-sdk` → `src/sdk`
+- `@clients/*` → `src/clients/*`
+- `@config/*` → `src/config/*`
+- `@exceptions/*` → `src/exception/*`
+- `@facades/*` → `src/facades/*`
+- `@factories/*` → `src/factories/*`
+- `@interfaces/*` → `src/interfaces/*`
+- `@services/*` → `src/services/*`
+- `@utils/*` → `src/utils/*`
+- `@adapters/*` → `src/adapters/*`
+
+## TypeScript Configuration
+
+- Target: ES2020
+- Module: ESNext
+- Strict mode enabled
+- Path aliases used for imports (see above)
+
+## Error Handling
+
+All custom exceptions extend `BaseException`. When adding new exceptions:
+
+1. Create in `src/exception/`
+2. Extend `BaseException`
+3. Define error codes with severity levels
+4. Use `ErrorHandlingService` for logging
+
+See `docs_dev/errors.md` for the complete error reference.
+
+## Testing
+
+- Tests located in `__tests__/`
+- Uses vitest with node environment
+- Coverage excludes: interfaces, types, test files, examples
+- Run specific test file: `vitest path/to/test.test.ts`
+
+## Concurrency
+
+The SDK uses `ConcurrencyLimiter` interface (implemented by `PLimitConcurrencyLimiter`) for controlling concurrent API requests. Default concurrency is 10, configurable via `ApiEnvironment.concurrency`.
+
+## HTTP Client Configuration
+
+Three HTTP clients available via `HttpClients` enum:
+- `FETCH` (default): Native fetch
+- `NODE_FETCH`: node-fetch package
+- `UNDICI`: Undici package
+
+Clients can be decorated with:
+- Timeout (`timeoutMs`)
+- Retry (`retries`, `retryDelay`)
+- HTTP logging (`httpLog`)
+- Error handling
+
+## Documentation Files
+
+- `docs_dev/README.md`: Main development documentation
+- `docs_dev/design_patterns.md`: Applied design patterns
+- `docs_dev/errors.md`: Error handling reference
+- `docs_dev/guia_estilo_typescript.md`: TypeScript style guide
+- `docs_dev/maintenance_doc.md`: Maintenance guide
+- `RELEASE_MANAGEMENT.md`: Release process using release-it
+
+## When Working on This Codebase
+
+1. **Use path aliases** instead of relative imports
+2. **Follow the facade pattern**: Users interact with facades, not services directly
+3. **Add exceptions** to `src/exception/` for new error scenarios
+4. **Create tests** in `__tests__/` mirroring the `src/` structure
+5. **Run linting** before committing: `npm run lint:fix && npm run prettier`
+6. **Build** before committing to ensure types are correct
+- @CLAUDE.md

package/DEVELOPER_GUIDE.md

@@ -0,0 +1,85 @@
+# Guía del Desarrollador IA - Griddo SDK
+
+Esta guía explica cómo orquestar los agentes y comandos para trabajar de forma autónoma en el SDK de Griddo. Sigue estos
+flujos para garantizar la calidad y consistencia del proyecto.
+
+## Roles y Agentes
+
+- **`planning-agent`**: Arquitecto. Crea planes en `.claude/plans/`.
+- **`backend-developer`**: Programador. Implementa lógica y tipos.
+- **`testing-agent`**: Especialista en Vitest. Crea tests TDD (AAA).
+- **`code-reviewer`**: Revisor. Valida calidad y seguridad.
+- **`debugger-agent`**: Investigador. Encuentra causas raíz de fallos.
+- **`technical-writer`**: Documentador. JSDoc, README y guías.
+- **`release-agent`**: Gestor de versiones. CHANGELOG y SemVer.
+
+## Flujos de Trabajo Principales
+
+### 1. Implementar una Nueva Funcionalidad (Feature)
+
+Usa este flujo para añadir nuevos endpoints, servicios o fachadas.
+
+1. `plan-manage start {feature-name}`: Inicializa el plan.
+2. **ESPERAR APROBACIÓN**: El usuario debe validar el plan generado antes de continuar.
+3. `new-feature {descripción}`: Sigue el ciclo TDD completo tras la aprobación.
+4. El comando ejecutará automáticamente:
+    - `testing-agent` (Fase Roja).
+    - `backend-developer` (Fase Verde).
+    - `pre-flight` (Gatekeeper).
+    - `release-agent` (CHANGELOG).
+
+### 2. Corregir un Error (Bug Fix)
+
+Usa este flujo cuando algo no funciona como se espera.
+
+1. `bug-fix {descripción}`: Inicia la investigación.
+2. El comando orquestará:
+    - `debugger-agent` (Análisis).
+    - `testing-agent` (Reproducción).
+    - `backend-developer` (Corrección).
+    - `pre-flight` (Validación).
+
+### 3. Refactorizar Código
+
+Usa este flujo para mejorar el código existente sin cambiar su funcionalidad.
+
+1. `refactor {objetivo}`: Analiza el impacto.
+2. Sigue el flujo de validación continua con los tests existentes.
+3. Ejecuta `pre-flight` al finalizar para asegurar la integridad.
+
+## Comandos Especiales
+
+### `pre-flight` (El Gatekeeper)
+
+**OBLIGATORIO** antes de finalizar cualquier tarea.
+
+- Ejecuta el build de producción.
+- Analiza Breaking Changes.
+- Verifica exportaciones globales.
+
+### `plan-manage` (Persistencia)
+
+- `start`: Nueva tarea (crea el plan en la raíz).
+- `resume`: Carga contexto de una sesión previa (mueve el plan a `active/` tras aprobación).
+- `status`: Muestra progreso y bloqueos.
+- `finish`: Finaliza la tarea y mueve los archivos a `completed/`.
+
+## Reglas de Oro para la IA
+
+1. **Auto-Corrección (Self-Healing)**: Si un test falla o el revisor encuentra un problema, corrígelo automáticamente
+   usando el `backend-developer` antes de informar al usuario.
+2. **Path Aliases**: Usa siempre `@services`, `@facades`, etc. Nunca imports relativos.
+3. **TDD**: Nunca escribas código de producción sin un test que valide su comportamiento (o falle antes).
+4. **Git**: Realiza commits granulares y haz `push` a la rama correspondiente. Sugiere siempre un Pull Request.
+5. **CHANGELOG**: El usuario debe saber qué ha cambiado a nivel de negocio. Usa el `release-agent`.
+
+## Estructura de Archivos del Sistema IA
+
+- `.claude/agents/`: Definición de roles.
+- `.claude/commands/`: Guías de ejecución de tareas.
+- `.claude/plans/`: Planes detallados por funcionalidad.
+    - `active/`: Planes aprobados y en desarrollo.
+    - `completed/`: Planes finalizados y archivados.
+- `.claude/sessions/`: Contexto persistente de cada tarea.
+    - `active/`: Sesiones en curso.
+    - `completed/`: Historial de sesiones finalizadas.

package/dist/config/Environment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Environment.d.ts","sourceRoot":"","sources":["../../src/config/Environment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAIzE,qBAAa,WAAY,YAAW,kBAAkB;IACrD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;gBAE5B,MAAM,EAAE,cAAc;IAOlC,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,aAAa;IAcrB,SAAS;CAGT"}
+{"version":3,"file":"Environment.d.ts","sourceRoot":"","sources":["../../src/config/Environment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAIzE,qBAAa,WAAY,YAAW,kBAAkB;IACrD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;gBAE5B,MAAM,EAAE,cAAc;IAOlC,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,aAAa;IAMrB,SAAS;CAGT"}

package/dist/config/version.d.ts

@@ -1,2 +1,2 @@
-export declare const version = "v2.0.12";
+export declare const version = "v2.0.14";
 //# sourceMappingURL=version.d.ts.map

package/dist/exception/SiteException.d.ts

@@ -0,0 +1,63 @@
+import { SeverityError } from "../interfaces/ErrorHandling";
+import type { ExceptionErrors } from "../interfaces/ErrorHandling";
+import { BaseException } from "./BaseException";
+export type SiteExceptionsErrors = ExceptionErrors;
+export declare const SiteExceptionsErrors: {
+    REQUIRED_API_SERVICE_PROPERTY: {
+        code: number;
+        message: string;
+        severity: SeverityError.WARNING;
+        description: string;
+    };
+    REQUIRED_SITE_SERVICE_PROPERTY: {
+        code: number;
+        message: string;
+        severity: SeverityError.WARNING;
+        description: string;
+    };
+    REQUIRED_LOGGING_SERVICE_PROPERTY: {
+        code: number;
+        message: string;
+        severity: SeverityError.WARNING;
+        description: string;
+    };
+};
+interface SiteErrorParams {
+    context: string;
+    error: string | object;
+    detail: (typeof SiteExceptionsErrors)[keyof typeof SiteExceptionsErrors];
+}
+/**
+ * Represents a validation error that occurs when input data is invalid.
+ */
+export declare class SiteException extends BaseException {
+    static internalErrors: {
+        REQUIRED_API_SERVICE_PROPERTY: {
+            code: number;
+            message: string;
+            severity: SeverityError.WARNING;
+            description: string;
+        };
+        REQUIRED_SITE_SERVICE_PROPERTY: {
+            code: number;
+            message: string;
+            severity: SeverityError.WARNING;
+            description: string;
+        };
+        REQUIRED_LOGGING_SERVICE_PROPERTY: {
+            code: number;
+            message: string;
+            severity: SeverityError.WARNING;
+            description: string;
+        };
+    };
+    /**
+     * Creates an instance of SiteError.
+     * @param message - The error message.
+     * @param error
+     * @param detail
+     */
+    constructor({ context, error, detail }: SiteErrorParams);
+}
+export {};
+//# sourceMappingURL=SiteException.d.ts.map

package/dist/exception/SiteException.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SiteException.d.ts","sourceRoot":"","sources":["../../src/exception/SiteException.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAEjE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,MAAM,MAAM,oBAAoB,GAAG,eAAe,CAAC;AAEnD,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;CAmBD,CAAC;AAEjC,UAAU,eAAe;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,MAAM,EAAE,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,OAAO,oBAAoB,CAAC,CAAC;CACzE;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,aAAa;IAC/C,MAAM,CAAC,cAAc;;;;;;;;;;;;;;;;;;;MAAwB;IAE7C;;;;;OAKG;gBACS,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,eAAe;CAIvD"}

package/dist/facades/ImageFacade.d.ts

@@ -38,10 +38,10 @@ export declare class ImageFacade implements ImageManager {
      *
      * @param image - The image data as a readable stream.
      * @param imageName - The name of the image.
-     * @param site - The site identifier to which the image belongs.
-     * @param mimetype - The MIME type of the image.
+     * @param site - The site identifier to which the image belongs. Defaults to "global".
+     * @param mimetype - The MIME type of the image (optional).
      * @returns A Promise resolving to the detailed information of the newly added image.
-     * @throws {ImageException} Throws an error if the image or mimetype are invalid.
+     * @throws {ImageException} If the image is invalid.
      */
     add({ image, imageName, site, mimetype, }: {
         image: Readable;

package/dist/facades/PageFacade.d.ts

@@ -1,8 +1,10 @@
+import { SiteSyncActionsResponseDTO } from "@griddo/api-types";
 import { ConcurrencyLimiter } from "../interfaces/ConcurrencyLimiter";
 import type { Pageable } from "../interfaces/Pageable";
 import type { PageUpdateHelpers } from "../interfaces/PageUpdateHelpers";
 import type { LoggingService } from "../services/LoggingService";
 import type { PageService } from "../services/PageService";
+import { SiteService } from "../services/SiteService";
 import { ApiResponse, PagePaginateParams, PagePaginationResponse, PageResponse, UpdateModulesOptions } from "../sdk";
 /**
  * Facade that simplifies page-related operations for the user.
@@ -18,18 +20,62 @@ import { ApiResponse, PagePaginateParams, PagePaginationResponse, PageResponse,
 export declare class PageFacade implements Pageable {
     private readonly pageService;
     private readonly loggingService;
+    private readonly siteService;
     private readonly concurrencyLimiter;
     /**
      * Constructs an instance of PageController.
      *
      * @param pageService - The service responsible for page-related operations.
      * @param loggingService - The service used for logging operations.
+     * @param siteService
+     * @param siteService
+     * @param siteService
      * @param concurrencyLimiter
      */
-    constructor(pageService: PageService, loggingService: LoggingService, concurrencyLimiter: ConcurrencyLimiter);
+    constructor(pageService: PageService, loggingService: LoggingService, siteService: SiteService, concurrencyLimiter: ConcurrencyLimiter);
+    /**
+     * Compares two pages to determine if they are equal using JSON serialization.
+     *
+     * @template TTemplate - The type of the page template.
+     * @param originalPage - The original page to compare.
+     * @param modifiedPage - The modified page to compare.
+     * @returns `true` if the pages are identical, `false` otherwise.
+     */
     private arePagesEqual;
+    /**
+     * Recursively traverses page modules and applies a callback to those
+     * matching the specified component name.
+     *
+     * @template TModule - The type of the target module.
+     * @param modules - The object containing the modules to traverse.
+     * @param moduleName - The component name of the module to find.
+     * @param callback - The async function to apply to each found module.
+     * @returns `true` if at least one module was modified, `false` otherwise.
+     */
     private applyCallbackToModules;
+    /**
+     * Processes multiple pages by applying a callback to each one.
+     *
+     * This method handles concurrency, page cloning, and automatic saving
+     * if changes are detected. It also manages errors on a per-page basis.
+     *
+     * @template TTemplate - The type of the page template.
+     * @param pageIDs - Array of page IDs to process.
+     * @param callback - Async function applied to each page.
+     * @param skipDeletePages - If `true`, skips pages marked as deleted.
+     * @returns A promise that resolves when all pages have been processed.
+     */
     private processPages;
+    /**
+     * Applies a callback to specific modules within a page.
+     *
+     * @template TModule - The type of the target module.
+     * @param callback - Async function to apply to each found module.
+     * @param page - The page containing the modules to process.
+     * @param moduleName - The component name of the module to find.
+     * @returns The page with modified modules.
+     * @throws {PageException} If the page is invalid or module name is missing.
+     */
     private readonly updateModulesFromPages;
     listIDs(template?: string | null): Promise<number[]>;
     paginate<TPage>({ queryParams, site, language, }: PagePaginateParams): Promise<PagePaginationResponse<TPage>>;
@@ -57,7 +103,7 @@ export declare class PageFacade implements Pageable {
      * @returns A promise that resolves when all pages have been processed.
      * @throws Will throw a `ValidationException` if pages cannot be retrieved or the callback is invalid.
      */
-    updatePages<TTemplate = unknown>(callback: (page: PageResponse<TTemplate>, helpers: PageUpdateHelpers) => Promise<PageResponse<TTemplate> | void>, options?: UpdateModulesOptions): Promise<void>;
+    updatePages<TTemplate = unknown>(callback: (page: PageResponse<TTemplate>, helpers: PageUpdateHelpers) => Promise<PageResponse<TTemplate> | void>, options?: UpdateModulesOptions): Promise<SiteSyncActionsResponseDTO>;
     /**
      * Applies a callback to modules with a specific name across multiple pages.
      *
@@ -77,6 +123,6 @@ export declare class PageFacade implements Pageable {
      * @returns A promise that resolves when all matching modules have been processed.
      * @throws Will throw a `PageException` if `moduleName` is not provided.
      */
-    updateModules<TModule, TTemplate = unknown>(callback: (module: TModule) => Promise<TModule>, moduleName: string, options?: UpdateModulesOptions): Promise<void>;
+    updateModules<TModule, TTemplate = unknown>(callback: (module: TModule) => Promise<TModule>, moduleName: string, options?: UpdateModulesOptions): Promise<SiteSyncActionsResponseDTO>;
 }
 //# sourceMappingURL=PageFacade.d.ts.map

package/dist/facades/PageFacade.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PageFacade.d.ts","sourceRoot":"","sources":["../../src/facades/PageFacade.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAGzD,OAAO,EACN,WAAW,EACX,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,EACZ,oBAAoB,EACpB,MAAM,aAAa,CAAC;AAUrB;;;;;;;;;;GAUG;AACH,qBAAa,UAAW,YAAW,QAAQ;IASzC,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IAVpC;;;;;;OAMG;gBAEe,WAAW,EAAE,WAAW,EACxB,cAAc,EAAE,cAAc,EAC9B,kBAAkB,EAAE,kBAAkB;IAWxD,OAAO,CAAC,aAAa;YAWP,sBAAsB;YAqCtB,YAAY;IA8C1B,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CA4CrC;IAEW,OAAO,CAAC,QAAQ,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAI1D,QAAQ,CAAC,KAAK,EAAE,EAC5B,WAAW,EACX,IAAI,EACJ,QAAQ,GACR,EAAE,kBAAkB,GAAG,OAAO,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAQjD,IAAI,CAAC,KAAK,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAsBrD,IAAI,CAAC,KAAK,EACtB,IAAI,EAAE,YAAY,CAAC,KAAK,CAAC,GACvB,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAWlB,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAgBxC,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAoBtD;;;;;;;;;;;;;;;;;;;OAmBG;IACU,WAAW,CAAC,SAAS,GAAG,OAAO,EAC3C,QAAQ,EAAE,CACT,IAAI,EAAE,YAAY,CAAC,SAAS,CAAC,EAC7B,OAAO,EAAE,iBAAiB,KACtB,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,EAC5C,OAAO,CAAC,EAAE,oBAAoB,GAC5B,OAAO,CAAC,IAAI,CAAC;IAiChB;;;;;;;;;;;;;;;;;;OAkBG;IACU,aAAa,CAAC,OAAO,EAAE,SAAS,GAAG,OAAO,EACtD,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,EAC/C,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,oBAAoB,GAC5B,OAAO,CAAC,IAAI,CAAC;CA+BhB"}
+{"version":3,"file":"PageFacade.d.ts","sourceRoot":"","sources":["../../src/facades/PageFacade.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,mBAAmB,CAAC;AAE/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAGpD,OAAO,EACN,WAAW,EACX,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,EACZ,oBAAoB,EACpB,MAAM,aAAa,CAAC;AAUrB;;;;;;;;;;GAUG;AACH,qBAAa,UAAW,YAAW,QAAQ;IAYzC,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IAdpC;;;;;;;;;OASG;gBAEe,WAAW,EAAE,WAAW,EACxB,cAAc,EAAE,cAAc,EAC9B,WAAW,EAAE,WAAW,EACxB,kBAAkB,EAAE,kBAAkB;IAgBxD;;;;;;;OAOG;IACH,OAAO,CAAC,aAAa;IAWrB;;;;;;;;;OASG;YACW,sBAAsB;IAqCpC;;;;;;;;;;;OAWG;YACW,YAAY;IA8C1B;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CA4CrC;IAEW,OAAO,CAAC,QAAQ,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAI1D,QAAQ,CAAC,KAAK,EAAE,EAC5B,WAAW,EACX,IAAI,EACJ,QAAQ,GACR,EAAE,kBAAkB,GAAG,OAAO,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAQjD,IAAI,CAAC,KAAK,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAsBrD,IAAI,CAAC,KAAK,EACtB,IAAI,EAAE,YAAY,CAAC,KAAK,CAAC,GACvB,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAWlB,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAgBxC,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAoBtD;;;;;;;;;;;;;;;;;;;OAmBG;IACU,WAAW,CAAC,SAAS,GAAG,OAAO,EAC3C,QAAQ,EAAE,CACT,IAAI,EAAE,YAAY,CAAC,SAAS,CAAC,EAC7B,OAAO,EAAE,iBAAiB,KACtB,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,EAC5C,OAAO,CAAC,EAAE,oBAAoB,GAC5B,OAAO,CAAC,0BAA0B,CAAC;IAsCtC;;;;;;;;;;;;;;;;;;OAkBG;IACU,aAAa,CAAC,OAAO,EAAE,SAAS,GAAG,OAAO,EACtD,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,EAC/C,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,oBAAoB,GAC5B,OAAO,CAAC,0BAA0B,CAAC;CA+BtC"}

package/dist/facades/SiteFacade.d.ts

@@ -0,0 +1,62 @@
+import { SiteSyncActionsResponseDTO } from "@griddo/api-types";
+import { SiteManager } from "../interfaces/SiteManager";
+import type { LoggingService } from "../services/LoggingService";
+import { SiteService } from "../services/SiteService";
+import { SiteBuildStartResponse, SiteBuildEndParams, SiteBuildEndResponse, SitemapResponse, SocialsResponse, SiteLanguagesResponse, ReferenceFieldBody, ReferenceFieldResponse } from "../sdk";
+/**
+ * Facade that simplifies site-related operations for the user.
+ *
+ * This class provides an easy-to-use interface for site operations
+ * such as syncing content. By using this facade, users can interact
+ * with site functionality without needing to manage the underlying
+ * `SiteService` directly.
+ *
+ * The facade abstracts the complexity, allowing you to perform operations
+ * in a streamlined manner within the SDK.
+ */
+export declare class SiteFacade implements SiteManager {
+    private readonly siteService;
+    private readonly loggingService;
+    /**
+     * Constructs an instance of SiteFacade.
+     *
+     * @param siteService - The service responsible for site-related operations.
+     * @param loggingService - The service used for logging operations.
+     * @throws {SiteException} If siteService or loggingService is not provided.
+     */
+    constructor(siteService: SiteService, loggingService: LoggingService);
+    /**
+     * Synchronizes site content.
+     */
+    syncContent(): Promise<SiteSyncActionsResponseDTO>;
+    /**
+     * Starts the build process for a site.
+     */
+    buildStart(id: string | number): Promise<SiteBuildStartResponse>;
+    /**
+     * Ends the build process for a site.
+     */
+    buildEnd(id: string | number, body: SiteBuildEndParams): Promise<SiteBuildEndResponse>;
+    /**
+     * Gets the sitemap for a site.
+     */
+    getSitemap(id: string | number): Promise<SitemapResponse>;
+    /**
+     * Gets the social networks for a site.
+     */
+    getSocials(id: string | number): Promise<SocialsResponse>;
+    /**
+     * Gets the languages for a site.
+     */
+    getLanguages(id: string | number): Promise<SiteLanguagesResponse>;
+    /**
+     * Gets distributor data for a site.
+     *
+     * @param id - The site ID.
+     * @param body - The request body for distributor configuration.
+     * @param language - Language ID (numeric or string) for the lang header.
+     * @returns A promise that resolves to the distributor response.
+     */
+    distributor(id: string | number, body: ReferenceFieldBody, language: string | number): Promise<ReferenceFieldResponse>;
+}
+//# sourceMappingURL=SiteFacade.d.ts.map

package/dist/facades/SiteFacade.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SiteFacade.d.ts","sourceRoot":"","sources":["../../src/facades/SiteFacade.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,mBAAmB,CAAC;AAG/D,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EACN,sBAAsB,EACtB,kBAAkB,EAClB,oBAAoB,EACpB,eAAe,EACf,eAAe,EACf,qBAAqB,EACrB,kBAAkB,EAClB,sBAAsB,EACtB,MAAM,aAAa,CAAC;AAErB;;;;;;;;;;GAUG;AACH,qBAAa,UAAW,YAAW,WAAW;IAC7C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAc;IAC1C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAiB;IAEhD;;;;;;OAMG;gBACS,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,cAAc;IAqBpE;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC,0BAA0B,CAAC;IAIxD;;OAEG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAmBtE;;OAEG;IACG,QAAQ,CACb,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,IAAI,EAAE,kBAAkB,GACtB,OAAO,CAAC,oBAAoB,CAAC;IAmBhC;;OAEG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAmB/D;;OAEG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAmB/D;;OAEG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAmBvE;;;;;;;OAOG;IACG,WAAW,CAChB,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,IAAI,EAAE,kBAAkB,EACxB,QAAQ,EAAE,MAAM,GAAG,MAAM,GACvB,OAAO,CAAC,sBAAsB,CAAC;CAoBlC"}