@pakento/cms-sdk 4.3.1 → 4.3.3

package/README.md

@@ -193,4 +193,8 @@ El SDK incluye manejo de errores para:
 
 MIT
 
-.build
+.build
+
+## EJECUCION DE PREUBAS:
+
+npx ts-node -P tsconfig.examples.json examples/testItems.

package/dist/index.d.mts

@@ -1,3 +1,42 @@
+import { AxiosInstance } from 'axios';
+
+declare class CacheService {
+    private redis?;
+    private apiKeyHash;
+    private defaultTTL;
+    constructor(apiKey: string);
+    private generateParamsHash;
+    buildCacheKey(functionName: string, params?: Record<string, unknown>): string;
+    cacheWrap<T>(key: string, fetcher: () => Promise<T>): Promise<T>;
+}
+
+declare class ApiClient {
+    protected client: AxiosInstance;
+    protected cache: CacheService;
+    protected baseURL: string;
+    protected apiKey: string;
+    constructor();
+    protected handleApiError(error: unknown, context: string): string;
+    protected fetchGraphQL<T>(query: string, variables: any, extractData: (responseData: any) => T): Promise<{
+        data: T | null;
+        error: boolean;
+        errorMessage: string | null;
+    }>;
+}
+
+interface ApiResponse<T> {
+    data: T | null;
+    totalDocs?: number;
+    totalPages?: number;
+    prevPage?: number | null;
+    nextPage?: number | null;
+    error?: boolean;
+    errorMessage?: string | null;
+}
+interface WhereClause {
+    equals?: string;
+}
+
 interface ItemImage {
     url: string;
     thumbnail_url: string;
@@ -21,79 +60,13 @@ interface Item {
     url_safe_name: string;
     images: ItemImage[];
 }
-interface Category {
-    id: number;
-    name: string;
-    image_url: string;
-}
-interface Brand {
-    id: string;
-    name: string;
-    description: string;
-    items_count: number;
-    image_url: string;
-    image_thumbnail_url: string;
-    image_alt: string;
-}
-interface Entity {
-    id: string;
-    tin: string;
-    name: string;
-    web: string;
-    address: string;
-    country: string;
-    city: string;
-    currency_id: string;
-    currency_name: string;
-    currency_prefix: string;
-    currency_suffix: string;
-    logo_url: string;
-    logo_alt: string;
-    logo_thumbnail_url: string;
-    logo_sizes_thumbnail_filename: string;
-    logo_filename: string;
-    logo_width: string;
-    logo_height: string;
-    logo_2_url: string;
-    logo_2_alt: string;
-    logo_2_thumbnail_url: string;
-    logo_2_sizes_thumbnail_filename: string;
-    logo_2_filename: string;
-    logo_2_width: string;
-    logo_2_height: string;
-    featured_image_url: string;
-    featured_image_alt: string;
-    featured_image_thumbnail_url: string;
-    featured_image_sizes_thumbnail_filename: string;
-    featured_image_filename: string;
-    featured_image_width: string;
-    featured_image_height: string;
-}
-interface ApiResponse<T> {
-    data: T[] | null;
-    totalDocs?: number;
-    totalPages?: number;
-    prevPage?: number | null;
-    nextPage?: number | null;
-    error?: boolean;
-    errorMessage?: string | null;
-}
-interface WhereEquals {
-    equals?: string;
-}
 interface ItemsWhere {
-    item_category_id?: WhereEquals;
-    item_super_category_id?: WhereEquals;
-    brand_id?: WhereEquals;
-    id?: WhereEquals;
-}
-interface CategoriesWhere {
-    item_super_category_id?: WhereEquals;
-    brand_id?: WhereEquals;
+    item_category_id?: WhereClause;
+    item_super_category_id?: WhereClause;
+    brand_id?: WhereClause;
+    id?: WhereClause;
 }
 interface GetItemsParams {
-    skipCache?: boolean;
-    cacheTTL?: number;
     where?: ItemsWhere;
     onlyOffers?: boolean;
     limit?: number;
@@ -103,47 +76,6 @@ interface GetItemsParams {
     minPrice?: number;
     maxPrice?: number;
 }
-interface GetCategoriesParams {
-    skipCache?: boolean;
-    cacheTTL?: number;
-    where?: CategoriesWhere;
-    limit?: number;
-    page?: number;
-    sort?: string;
-}
-interface GetBrandsParams {
-    skipCache?: boolean;
-    cacheTTL?: number;
-    limit?: number;
-    page?: number;
-    sort?: string;
-}
-interface GetEntityParams {
-    skipCache?: boolean;
-    cacheTTL?: number;
-}
-interface CreateEcommerceOrderItem {
-    id: number;
-    quantity: number;
-}
-interface CreateEcommerceOrderParams {
-    name: string;
-    email: string;
-    phone?: string;
-    notes?: string;
-    tin?: string;
-    items: CreateEcommerceOrderItem[];
-    delivery_address?: string;
-    delivery_instructions?: string;
-    payment_method?: "cash" | "transfer";
-}
-interface SendContactUsEmailParams {
-    name: string;
-    email: string;
-    phone?: string;
-    notes?: string;
-    subject?: string;
-}
 interface ItemEcommerceRaw {
     id: string;
     name: string;
@@ -182,11 +114,70 @@ interface ItemsRawResponse {
     nextPage: number | null;
     docs: ItemEcommerceRaw[];
 }
+
+declare class ItemsApi extends ApiClient {
+    getItems(params?: GetItemsParams): Promise<ApiResponse<Item[]>>;
+    private fetchItemsFromAPI;
+}
+declare const itemsApi: ItemsApi;
+
+interface Category {
+    id: number;
+    name: string;
+    image_url: string;
+}
+interface CategoryEcommerceRaw {
+    id: number;
+    name: string;
+    image_url: string;
+}
+interface CategoriesWhere {
+    item_super_category_id?: WhereClause;
+    brand_id?: WhereClause;
+}
+interface GetCategoriesParams {
+    where?: CategoriesWhere;
+    limit?: number;
+    page?: number;
+    sort?: string;
+    [key: string]: unknown;
+}
 interface CategoriesRawResponse {
-    docs: Category[];
+    docs: CategoryEcommerceRaw[];
+}
+
+declare class CategoriesApi extends ApiClient {
+    getCategories(params?: GetCategoriesParams): Promise<ApiResponse<Category[]>>;
+    private fetchCategoriesFromAPI;
+}
+declare const categoriesApi: CategoriesApi;
+
+interface Brand {
+    id: string;
+    name: string;
+    description: string;
+    items_count: number;
+    image_url: string;
+    image_thumbnail_url: string;
+    image_alt: string;
+}
+interface BrandEcommerceRaw {
+    id: string;
+    name: string;
+    description: string;
+    items_count: number;
+    image_url: string;
+    image_thumbnail_url: string;
+    image_alt: string;
+}
+interface GetBrandsParams {
+    limit?: number;
+    page?: number;
+    sort?: string;
+    [key: string]: unknown;
 }
 interface BrandsRawResponse {
-    docs: Brand[];
+    docs: BrandEcommerceRaw[];
     hasNextPage: boolean;
     hasPrevPage: boolean;
     limit: number;
@@ -198,45 +189,108 @@ interface BrandsRawResponse {
     totalDocs: number;
     totalPages: number;
 }
-interface EntityRawResponse {
-    entity: Entity;
+
+declare class BrandsApi extends ApiClient {
+    getBrands(params?: GetBrandsParams): Promise<ApiResponse<Brand[]>>;
+    private fetchBrandsFromAPI;
 }
-interface ItemsApiResponse {
-    data: ItemsRawResponse | null;
-    totalDocs: number;
-    totalPages: number;
-    prevPage: number | null;
-    nextPage: number | null;
-    error: boolean;
-    errorMessage: string | null;
+declare const brandsApi: BrandsApi;
+
+interface Entity {
+    id: string;
+    tin: string;
+    name: string;
+    web: string;
+    address: string;
+    country: string;
+    city: string;
+    currency_id: string;
+    currency_name: string;
+    currency_prefix: string;
+    currency_suffix: string;
+    logo_url: string;
+    logo_alt: string;
+    logo_thumbnail_url: string;
+    logo_sizes_thumbnail_filename: string;
+    logo_filename: string;
+    logo_width: string;
+    logo_height: string;
+    logo_2_url: string;
+    logo_2_alt: string;
+    logo_2_thumbnail_url: string;
+    logo_2_sizes_thumbnail_filename: string;
+    logo_2_filename: string;
+    logo_2_width: string;
+    logo_2_height: string;
+    featured_image_url: string;
+    featured_image_alt: string;
+    featured_image_thumbnail_url: string;
+    featured_image_sizes_thumbnail_filename: string;
+    featured_image_filename: string;
+    featured_image_width: string;
+    featured_image_height: string;
 }
-interface CategoriesApiResponse {
-    data: Category[] | null;
-    categories: Category[];
-    error: boolean;
-    errorMessage: string | null;
+interface EntityEcommerceRaw {
+    id: string;
+    tin: string;
+    name: string;
+    web: string;
+    address: string;
+    country: string;
+    city: string;
+    currency_id: string;
+    currency_name: string;
+    currency_prefix: string;
+    currency_suffix: string;
+    logo_url: string;
+    logo_alt: string;
+    logo_thumbnail_url: string;
+    logo_sizes_thumbnail_filename: string;
+    logo_filename: string;
+    logo_width: string;
+    logo_height: string;
+    logo_2_url: string;
+    logo_2_alt: string;
+    logo_2_thumbnail_url: string;
+    logo_2_sizes_thumbnail_filename: string;
+    logo_2_filename: string;
+    logo_2_width: string;
+    logo_2_height: string;
+    featured_image_url: string;
+    featured_image_alt: string;
+    featured_image_thumbnail_url: string;
+    featured_image_sizes_thumbnail_filename: string;
+    featured_image_filename: string;
+    featured_image_width: string;
+    featured_image_height: string;
 }
-interface BrandsApiResponse {
-    data: BrandsRawResponse | null;
-    brands: Brand[];
-    hasNextPage: boolean;
-    hasPrevPage: boolean;
-    limit: number;
-    nextPage: number;
-    offset: number;
-    page: number;
-    pagingCounter: number;
-    prevPage: number;
-    totalDocs: number;
-    totalPages: number;
-    error: boolean;
-    errorMessage: string | null;
+interface GetEntityParams {
+    [key: string]: unknown;
 }
-interface EntityApiResponse {
-    data: Entity | null;
-    entity: Entity | null;
-    error: boolean;
-    errorMessage: string | null;
+interface EntityRawResponse {
+    GetEntity: EntityEcommerceRaw;
+}
+
+declare class EntityApi extends ApiClient {
+    getEntity(params?: GetEntityParams): Promise<ApiResponse<Entity>>;
+    private fetchEntityFromAPI;
+}
+declare const entityApi: EntityApi;
+
+interface CreateEcommerceOrderItem {
+    id: number;
+    quantity: number;
+}
+interface CreateEcommerceOrderParams {
+    name: string;
+    email: string;
+    phone?: string;
+    notes?: string;
+    tin?: string;
+    items: CreateEcommerceOrderItem[];
+    delivery_address?: string;
+    delivery_instructions?: string;
+    payment_method?: "cash" | "transfer";
 }
 interface CreateEcommerceOrderResponse {
     message: string;
@@ -244,11 +298,31 @@ interface CreateEcommerceOrderResponse {
     error: boolean;
     errorMessage: string | null;
 }
+
+declare class OrdersApi extends ApiClient {
+    createEcommerceOrder(params: CreateEcommerceOrderParams): Promise<CreateEcommerceOrderResponse>;
+}
+declare const ordersApi: OrdersApi;
+
+interface SendContactUsEmailParams {
+    name: string;
+    email: string;
+    phone?: string;
+    notes?: string;
+    subject?: string;
+    [key: string]: unknown;
+}
 interface SendContactUsEmailResponse {
     message: string;
     error: boolean;
     errorMessage: string | null;
 }
+
+declare class ContactApi extends ApiClient {
+    sendContactUsEmail(params: SendContactUsEmailParams): Promise<SendContactUsEmailResponse>;
+}
+declare const contactApi: ContactApi;
+
 interface CustomGraphQLParams {
     query: string;
     variables?: Record<string, unknown>;
@@ -257,99 +331,12 @@ interface CustomGraphQLResponse<T> {
     data: T;
     error: boolean;
     errorMessage: string | null;
-    errors?: T[];
+    errors?: any[];
 }
 
-declare class PakentoCMSAPI {
-    private client;
-    private cache;
-    private defaultTTL;
-    private baseURL;
-    private apiKey;
-    constructor(config?: {
-        cacheTTL?: number;
-    });
-    private handleApiError;
-    private fetchGraphQL;
-    getItems(params?: GetItemsParams): Promise<ApiResponse<Item>>;
-    private fetchItemsFromAPI;
-    getCategories(params?: GetCategoriesParams): Promise<CategoriesApiResponse>;
-    private fetchCategoriesFromAPI;
-    getBrands(params?: GetBrandsParams): Promise<BrandsApiResponse>;
-    private fetchBrandsFromAPI;
-    getEntity(params?: GetEntityParams): Promise<EntityApiResponse>;
-    private fetchEntityFromAPI;
-    createEcommerceOrder(params: CreateEcommerceOrderParams): Promise<CreateEcommerceOrderResponse>;
+declare class CustomApi extends ApiClient {
     executeCustomQuery<T>(params: CustomGraphQLParams): Promise<CustomGraphQLResponse<T>>;
-    sendContactUsEmail(params: SendContactUsEmailParams): Promise<SendContactUsEmailResponse>;
-    /**
-     * Verifica si existe cache para una función y parámetros específicos
-     */
-    hasCache(functionName: string, params?: Record<string, unknown>): Promise<boolean>;
-    /**
-     * Obtiene la key de cache para una función y parámetros específicos
-     */
-    getCacheKey(functionName: string, params?: Record<string, unknown>): string;
-    /**
-     * Limpia el cache para una función y parámetros específicos
-     */
-    clearCache(functionName: string, params?: Record<string, unknown>): Promise<boolean>;
-    /**
-     * Limpia todo el cache relacionado con este API Key
-     */
-    clearAllCache(): Promise<boolean>;
-    /**
-     * Obtiene información del cache (útil para debugging)
-     */
-    getCacheInfo(functionName: string, params?: Record<string, unknown>): Promise<{
-        exists: boolean;
-        key: string;
-        ttl?: number;
-    }>;
-    /**
-     * Limpia un cache específico que pueda estar corrupto
-     */
-    clearCorruptedCache(functionName: string, params?: Record<string, unknown>): Promise<boolean>;
 }
-declare const pakentoCMSAPI: PakentoCMSAPI;
-
-declare class CacheService {
-    private redis?;
-    private defaultTTL;
-    private apiKeyHash;
-    private isCacheEnvelope;
-    constructor(defaultTTL: number, apiKey: string);
-    private generateParamsHash;
-    buildCacheKey(functionName: string, params?: Record<string, unknown>): string;
-    private safeJsonParse;
-    private serializeForCache;
-    getCachedOrFetch<T>(key: string, fetcher: () => Promise<T>, ttl?: number, skipCache?: boolean): Promise<T>;
-    hasCache(functionName: string, params?: Record<string, unknown>): Promise<boolean>;
-    /**
-     * Limpia un cache específico si está corrupto
-     */
-    clearCorruptedCache(key: string): Promise<boolean>;
-    getCacheKey(functionName: string, params?: Record<string, unknown>): string;
-    clearCache(functionName: string, params?: Record<string, unknown>): Promise<boolean>;
-    clearAllCache(): Promise<boolean>;
-    getCacheInfo(functionName: string, params?: Record<string, unknown>): Promise<{
-        exists: boolean;
-        key: string;
-        ttl?: number;
-    }>;
-}
-
-/**
- * Parses a raw GraphQL response item to the normalized Item type
- * @param rawItem - The raw item from GraphQL response
- * @returns Normalized Item object
- */
-declare function parseRawItemToItem(rawItem: ItemEcommerceRaw): Item;
-/**
- * Parses an array of raw GraphQL response items to normalized Item types
- * @param rawItems - Array of raw items from GraphQL response
- * @returns Array of normalized Item objects
- */
-declare function parseRawItemsToItems(rawItems: ItemEcommerceRaw[]): Item[];
+declare const customApi: CustomApi;
 
-export { type Brand, type BrandsApiResponse, type BrandsRawResponse, CacheService, type CategoriesApiResponse, type CategoriesRawResponse, type CategoriesWhere, type Category, type CreateEcommerceOrderParams, type CreateEcommerceOrderResponse, type CustomGraphQLParams, type CustomGraphQLResponse, type Entity, type EntityApiResponse, type EntityRawResponse, type GetBrandsParams, type GetCategoriesParams, type GetEntityParams, type GetItemsParams, type Item, type ItemImage, type ItemsApiResponse, type ItemsRawResponse, type ItemsWhere, type SendContactUsEmailParams, type SendContactUsEmailResponse, type WhereEquals, pakentoCMSAPI, parseRawItemToItem, parseRawItemsToItems };
+export { ApiClient, type ApiResponse, type Brand, type BrandEcommerceRaw, type BrandsRawResponse, type CategoriesRawResponse, type CategoriesWhere, type Category, type CategoryEcommerceRaw, type CreateEcommerceOrderItem, type CreateEcommerceOrderParams, type CreateEcommerceOrderResponse, type CustomGraphQLParams, type CustomGraphQLResponse, type Entity, type EntityEcommerceRaw, type EntityRawResponse, type GetBrandsParams, type GetCategoriesParams, type GetEntityParams, type GetItemsParams, type Item, type ItemEcommerceRaw, type ItemImage, type ItemsRawResponse, type ItemsWhere, type SendContactUsEmailParams, type SendContactUsEmailResponse, type WhereClause, brandsApi, categoriesApi, contactApi, customApi, entityApi, itemsApi, ordersApi };