npm - @pakento/cms-sdk - Versions diffs - 4.0.3 → 4.0.5 - Mend

@pakento/cms-sdk 4.0.3 → 4.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/README.md CHANGED Viewed

@@ -1,99 +1,15 @@
 # @pakento/cms-sdk
-SDK para conectar tiendas en línea con Pakento CMS
+SDK para conectar tiendas en línea con Pakento CMS de forma rápida y sencilla.
 ## Instalación
 ```bash
 npm install @pakento/cms-sdk
 # o
-yarn add @pakento/cms-sdk
-# o
 bun add @pakento/cms-sdk
 ```
-**Nota importante**: Este paquete requiere las siguientes peer dependencies:
-- `react >= 16.8.0`
-- `react-dom >= 16.8.0`
-- `axios >= 1.6.0`
-- `@upstash/redis >= 1.35.3` (opcional, solo si usas cache con Redis)
-## Uso del Cart Context en Next.js
-### 1. Configurar el Provider en tu app
-En tu `app/layout.tsx` o `pages/_app.tsx`:
-```tsx
-import { CartProvider } from "@pakento/cms-sdk";
-export default function RootLayout({
-  children,
-}: {
-  children: React.ReactNode;
-}) {
-  return (
-    <html lang="es">
-      <body>
-        <CartProvider>{children}</CartProvider>
-      </body>
-    </html>
-  );
-}
-```
-### 2. Usar el hook useCart en tus componentes
-```tsx
-"use client";
-import { useCart } from "@pakento/cms-sdk";
-export default function CartComponent() {
-  const { state, dispatch } = useCart();
-  const addToCart = (item) => {
-    dispatch({ type: "ADD_TO_CART", payload: item });
-  };
-  const removeFromCart = (itemId) => {
-    dispatch({ type: "REMOVE_FROM_CART", payload: itemId });
-  };
-  return (
-    <div>
-      <p>Items en carrito: {state.cart.itemCount}</p>
-      <p>Total: ${state.cart.total}</p>
-      {/* Tu UI del carrito aquí */}
-    </div>
-  );
-}
-```
-### 3. API Usage
-````tsx
-import { pakentoCMSAPI } from '@pakento/cms-sdk';
-// Configurar variables de entorno
-// PAKENTO_API_URL=tu_url_de_api
-// PAKENTO_API_KEY=tu_api_key
-const items = await pakentoCMSAPI.getItems({
-  limit: 10,
-  page: 1
-});
-``` de forma rápida y sencilla.
-## Instalación
-```bash
-npm install @pakento/cms-sdk
-# o
-bun add @pakento/cms-sdk
-````
 ## Configuración
 Agrega las siguientes variables de entorno a tu proyecto:
@@ -277,4 +193,4 @@ El SDK incluye manejo de errores para:
 MIT
-.build
+.build

package/dist/index.d.mts CHANGED Viewed

@@ -1,6 +1,3 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import * as React from 'react';
 interface ItemImage {
     alt: string;
     url: string;
@@ -223,15 +220,6 @@ interface CustomGraphQLResponse<T> {
     errorMessage: string | null;
     errors?: T[];
 }
-interface CartItem {
-    item: Item;
-    quantity: number;
-}
-interface Cart {
-    cartItems: CartItem[];
-    total: number;
-    itemCount: number;
-}
 declare class PakentoCMSAPI {
     private client;
@@ -242,17 +230,23 @@ declare class PakentoCMSAPI {
     constructor(config?: {
         cacheTTL?: number;
     });
+    /**
+     * Genera un hash único para los parámetros de búsqueda
+     */
+    private generateParamsHash;
+    /**
+     * Genera una key única y calculable para el cache basada en:
+     * - API Token (para namespacing entre proyectos)
+     * - Nombre de la función
+     * - Hash de los parámetros de búsqueda
+     */
+    private buildCacheKey;
     /**
      * Obtiene datos desde cache si existen; de lo contrario llama a fetcher() y guarda.
      */
     private safeJsonParse;
     private serializeForCache;
     private getCachedOrFetch;
-    /**
-     * Construye una llave única para el cache a partir del nombre de la
-     * consulta y los parámetros.
-     */
-    private buildCacheKey;
     getItems(params?: GetItemsParams): Promise<ItemsApiResponse>;
     private fetchItemsFromAPI;
     getCategories(params?: GetCategoriesParams): Promise<CategoriesApiResponse>;
@@ -264,40 +258,31 @@ declare class PakentoCMSAPI {
     createEcommerceOrder(params: CreateEcommerceOrderParams): Promise<CreateEcommerceOrderResponse>;
     executeCustomQuery<T>(params: CustomGraphQLParams<T>): 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;
+    }>;
 }
 declare const pakentoCMSAPI: PakentoCMSAPI;
-interface CartState {
-    cart: Cart;
-    isCartOpen: boolean;
-}
-type CartAction = {
-    type: "ADD_TO_CART";
-    payload: Item;
-} | {
-    type: "REMOVE_FROM_CART";
-    payload: string;
-} | {
-    type: "UPDATE_QUANTITY";
-    payload: {
-        itemId: string;
-        quantity: number;
-    };
-} | {
-    type: "CLEAR_CART";
-} | {
-    type: "TOGGLE_CART";
-} | {
-    type: "OPEN_CART";
-} | {
-    type: "CLOSE_CART";
-};
-declare function CartProvider({ children }: {
-    children: React.ReactNode;
-}): react_jsx_runtime.JSX.Element;
-declare function useCart(): {
-    state: CartState;
-    dispatch: React.Dispatch<CartAction>;
-};
-export { type Brand, type BrandsApiResponse, type BrandsRawResponse, CartProvider, 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, useCart };
+export { type Brand, type BrandsApiResponse, type BrandsRawResponse, 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 };

package/dist/index.d.ts CHANGED Viewed

@@ -1,6 +1,3 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import * as React from 'react';
 interface ItemImage {
     alt: string;
     url: string;
@@ -223,15 +220,6 @@ interface CustomGraphQLResponse<T> {
     errorMessage: string | null;
     errors?: T[];
 }
-interface CartItem {
-    item: Item;
-    quantity: number;
-}
-interface Cart {
-    cartItems: CartItem[];
-    total: number;
-    itemCount: number;
-}
 declare class PakentoCMSAPI {
     private client;
@@ -242,17 +230,23 @@ declare class PakentoCMSAPI {
     constructor(config?: {
         cacheTTL?: number;
     });
+    /**
+     * Genera un hash único para los parámetros de búsqueda
+     */
+    private generateParamsHash;
+    /**
+     * Genera una key única y calculable para el cache basada en:
+     * - API Token (para namespacing entre proyectos)
+     * - Nombre de la función
+     * - Hash de los parámetros de búsqueda
+     */
+    private buildCacheKey;
     /**
      * Obtiene datos desde cache si existen; de lo contrario llama a fetcher() y guarda.
      */
     private safeJsonParse;
     private serializeForCache;
     private getCachedOrFetch;
-    /**
-     * Construye una llave única para el cache a partir del nombre de la
-     * consulta y los parámetros.
-     */
-    private buildCacheKey;
     getItems(params?: GetItemsParams): Promise<ItemsApiResponse>;
     private fetchItemsFromAPI;
     getCategories(params?: GetCategoriesParams): Promise<CategoriesApiResponse>;
@@ -264,40 +258,31 @@ declare class PakentoCMSAPI {
     createEcommerceOrder(params: CreateEcommerceOrderParams): Promise<CreateEcommerceOrderResponse>;
     executeCustomQuery<T>(params: CustomGraphQLParams<T>): 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;
+    }>;
 }
 declare const pakentoCMSAPI: PakentoCMSAPI;
-interface CartState {
-    cart: Cart;
-    isCartOpen: boolean;
-}
-type CartAction = {
-    type: "ADD_TO_CART";
-    payload: Item;
-} | {
-    type: "REMOVE_FROM_CART";
-    payload: string;
-} | {
-    type: "UPDATE_QUANTITY";
-    payload: {
-        itemId: string;
-        quantity: number;
-    };
-} | {
-    type: "CLEAR_CART";
-} | {
-    type: "TOGGLE_CART";
-} | {
-    type: "OPEN_CART";
-} | {
-    type: "CLOSE_CART";
-};
-declare function CartProvider({ children }: {
-    children: React.ReactNode;
-}): react_jsx_runtime.JSX.Element;
-declare function useCart(): {
-    state: CartState;
-    dispatch: React.Dispatch<CartAction>;
-};
-export { type Brand, type BrandsApiResponse, type BrandsRawResponse, CartProvider, 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, useCart };
+export { type Brand, type BrandsApiResponse, type BrandsRawResponse, 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 };

package/dist/index.js CHANGED Viewed

@@ -30,15 +30,14 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  CartProvider: () => CartProvider,
-  pakentoCMSAPI: () => pakentoCMSAPI,
-  useCart: () => useCart
+  pakentoCMSAPI: () => pakentoCMSAPI
 });
 module.exports = __toCommonJS(index_exports);
 // src/services/api.ts
 var import_axios = __toESM(require("axios"));
 var import_redis = require("@upstash/redis");
+var import_crypto = require("crypto");
 var PakentoCMSAPI = class {
   constructor(config) {
     this.defaultTTL = 86400;
@@ -76,6 +75,28 @@ var PakentoCMSAPI = class {
       }
     );
   }
+  /**
+   * Genera un hash único para los parámetros de búsqueda
+   */
+  generateParamsHash(params) {
+    const sortedParams = Object.keys(params).sort().reduce((acc, key) => {
+      acc[key] = params[key];
+      return acc;
+    }, {});
+    const paramsString = JSON.stringify(sortedParams);
+    return (0, import_crypto.createHash)("sha256").update(paramsString).digest("hex").substring(0, 16);
+  }
+  /**
+   * Genera una key única y calculable para el cache basada en:
+   * - API Token (para namespacing entre proyectos)
+   * - Nombre de la función
+   * - Hash de los parámetros de búsqueda
+   */
+  buildCacheKey(functionName, params = {}) {
+    const paramsHash = this.generateParamsHash(params);
+    const apiKeyHash = (0, import_crypto.createHash)("sha256").update(this.apiKey).digest("hex").substring(0, 8);
+    return `pakento:${apiKeyHash}:${functionName}:${paramsHash}`;
+  }
   /**
    * Obtiene datos desde cache si existen; de lo contrario llama a fetcher() y guarda.
    */
@@ -91,37 +112,38 @@ var PakentoCMSAPI = class {
   }
   async getCachedOrFetch(key, fetcher, ttl, skipCache = false) {
     if (!this.redis || skipCache) {
+      console.log(`[PakentoSDK] ${!this.redis ? "Redis no configurado" : "Saltando cache"} - llamando a API`);
       return fetcher();
     }
     try {
+      console.log(`[PakentoSDK] Buscando en cache: ${key}`);
       const cached = await this.redis.get(key);
       if (cached) {
+        console.log(`[PakentoSDK] \u2705 Cache hit para: ${key}`);
         const parsed = this.safeJsonParse(cached);
         if (parsed !== null) {
           return parsed;
+        } else {
+          console.warn(`[PakentoSDK] Error parseando cache para: ${key}`);
         }
+      } else {
+        console.log(`[PakentoSDK] \u274C Cache miss para: ${key}`);
       }
     } catch (err) {
       console.warn("[PakentoSDK] Error leyendo cache Redis", err);
     }
+    console.log(`[PakentoSDK] Llamando a API para: ${key}`);
     const result = await fetcher();
     try {
       await this.redis.set(key, this.serializeForCache(result), {
         ex: ttl ?? this.defaultTTL
       });
+      console.log(`[PakentoSDK] \u2705 Guardado en cache: ${key} (TTL: ${ttl ?? this.defaultTTL}s)`);
     } catch (err) {
       console.warn("[PakentoSDK] Error escribiendo cache Redis", err);
     }
     return result;
   }
-  /**
-   * Construye una llave única para el cache a partir del nombre de la
-   * consulta y los parámetros.
-   */
-  buildCacheKey(queryName, variables) {
-    const vars = typeof variables === "string" ? variables : JSON.stringify(variables ?? {});
-    return `${this.apiKey}-${queryName}:${vars}`;
-  }
   async getItems(params = {}) {
     const { skipCache = false, cacheTTL, ...rest } = params;
     const cacheKey = this.buildCacheKey("GetEcommerceItems", rest);
@@ -823,125 +845,97 @@ var PakentoCMSAPI = class {
       };
     }
   }
-};
-var pakentoCMSAPI = new PakentoCMSAPI();
-// src/context/CartContext.tsx
-var React = __toESM(require("react"));
-var import_jsx_runtime = require("react/jsx-runtime");
-var { createContext, useContext, useReducer } = React;
-var initialState = {
-  cart: {
-    cartItems: [],
-    total: 0,
-    itemCount: 0
-  },
-  isCartOpen: false
-};
-function cartReducer(state, action) {
-  switch (action.type) {
-    case "ADD_TO_CART": {
-      const existingItem = state.cart.cartItems.find(
-        (cartItem) => cartItem.item.id === action.payload.id
-      );
-      let newItems;
-      if (existingItem) {
-        newItems = state.cart.cartItems.map(
-          (cartItem) => cartItem.item.id === action.payload.id ? { ...cartItem, quantity: cartItem.quantity + 1 } : cartItem
-        );
-      } else {
-        newItems = [
-          ...state.cart.cartItems,
-          { item: action.payload, quantity: 1 }
-        ];
-      }
-      const total = newItems.reduce(
-        (sum, cartItem) => sum + cartItem.item.price * cartItem.quantity,
-        0
-      );
-      const itemCount = newItems.reduce(
-        (sum, cartItem) => sum + cartItem.quantity,
-        0
-      );
-      return {
-        ...state,
-        cart: { cartItems: newItems, total, itemCount }
-      };
+  /**
+   * Verifica si existe cache para una función y parámetros específicos
+   */
+  async hasCache(functionName, params = {}) {
+    if (!this.redis) {
+      return false;
     }
-    case "REMOVE_FROM_CART": {
-      const newItems = state.cart.cartItems.filter(
-        (cartItem) => cartItem.item.id !== action.payload
-      );
-      const total = newItems.reduce(
-        (sum, cartItem) => sum + cartItem.item.price * cartItem.quantity,
-        0
-      );
-      const itemCount = newItems.reduce(
-        (sum, cartItem) => sum + cartItem.quantity,
-        0
-      );
-      return {
-        ...state,
-        cart: { cartItems: newItems, total, itemCount }
-      };
+    try {
+      const key = this.buildCacheKey(functionName, params);
+      const cached = await this.redis.get(key);
+      return cached !== null;
+    } catch (err) {
+      console.warn("[PakentoSDK] Error verificando cache", err);
+      return false;
     }
-    case "UPDATE_QUANTITY": {
-      const newItems = state.cart.cartItems.map(
-        (cartItem) => cartItem.item.id === action.payload.itemId ? { ...cartItem, quantity: Math.max(0, action.payload.quantity) } : cartItem
-      ).filter((item) => item.quantity > 0);
-      const total = newItems.reduce(
-        (sum, cartItem) => sum + cartItem.item.price * cartItem.quantity,
-        0
-      );
-      const itemCount = newItems.reduce(
-        (sum, cartItem) => sum + cartItem.quantity,
-        0
-      );
-      return {
-        ...state,
-        cart: { cartItems: newItems, total, itemCount }
-      };
+  }
+  /**
+   * Obtiene la key de cache para una función y parámetros específicos
+   */
+  getCacheKey(functionName, params = {}) {
+    return this.buildCacheKey(functionName, params);
+  }
+  /**
+   * Limpia el cache para una función y parámetros específicos
+   */
+  async clearCache(functionName, params = {}) {
+    if (!this.redis) {
+      return false;
     }
-    case "CLEAR_CART":
-      return {
-        ...state,
-        cart: { cartItems: [], total: 0, itemCount: 0 }
-      };
-    case "TOGGLE_CART":
+    try {
+      const key = this.buildCacheKey(functionName, params);
+      await this.redis.del(key);
+      console.log(`[PakentoSDK] \u2705 Cache limpiado para: ${key}`);
+      return true;
+    } catch (err) {
+      console.warn("[PakentoSDK] Error limpiando cache", err);
+      return false;
+    }
+  }
+  /**
+   * Limpia todo el cache relacionado con este API Key
+   */
+  async clearAllCache() {
+    if (!this.redis) {
+      return false;
+    }
+    try {
+      const apiKeyHash = (0, import_crypto.createHash)("sha256").update(this.apiKey).digest("hex").substring(0, 8);
+      const pattern = `pakento:${apiKeyHash}:*`;
+      const keys = await this.redis.keys(pattern);
+      if (keys.length > 0) {
+        await this.redis.del(...keys);
+        console.log(`[PakentoSDK] \u2705 Cache limpiado para ${keys.length} keys`);
+      }
+      return true;
+    } catch (err) {
+      console.warn("[PakentoSDK] Error limpiando todo el cache", err);
+      return false;
+    }
+  }
+  /**
+   * Obtiene información del cache (útil para debugging)
+   */
+  async getCacheInfo(functionName, params = {}) {
+    if (!this.redis) {
       return {
-        ...state,
-        isCartOpen: !state.isCartOpen
+        exists: false,
+        key: this.buildCacheKey(functionName, params)
       };
-    case "OPEN_CART":
+    }
+    try {
+      const key = this.buildCacheKey(functionName, params);
+      const exists = await this.redis.exists(key);
+      const ttl = exists ? await this.redis.ttl(key) : void 0;
       return {
-        ...state,
-        isCartOpen: true
+        exists: exists === 1,
+        key,
+        ttl: ttl === -1 ? void 0 : ttl
       };
-    case "CLOSE_CART":
+    } catch (err) {
+      console.warn("[PakentoSDK] Error obteniendo info del cache", err);
       return {
-        ...state,
-        isCartOpen: false
+        exists: false,
+        key: this.buildCacheKey(functionName, params)
       };
-    default:
-      return state;
-  }
-}
-var CartContext = createContext(null);
-function CartProvider({ children }) {
-  const [state, dispatch] = useReducer(cartReducer, initialState);
-  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(CartContext.Provider, { value: { state, dispatch }, children });
-}
-function useCart() {
-  const context = useContext(CartContext);
-  if (!context) {
-    throw new Error("useCart must be used within a CartProvider");
+    }
   }
-  return context;
-}
+};
+var pakentoCMSAPI = new PakentoCMSAPI();
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  CartProvider,
-  pakentoCMSAPI,
-  useCart
+  pakentoCMSAPI
 });
 //# sourceMappingURL=index.js.map