@pakento/cms-sdk 4.3.2 → 4.3.4

package/dist/index.d.mts

@@ -7,7 +7,7 @@ declare class CacheService {
     constructor(apiKey: string);
     private generateParamsHash;
     buildCacheKey(functionName: string, params?: Record<string, unknown>): string;
-    cacheWrap<T>(key: string, fetcher: () => Promise<T>): Promise<T>;
+    cacheWrap<T>(key: string, fetcher: () => Promise<T>, filters?: Record<string, unknown>): Promise<T>;
 }
 
 declare class ApiClient {
@@ -25,7 +25,7 @@ declare class ApiClient {
 }
 
 interface ApiResponse<T> {
-    data: T[] | null;
+    data: T | null;
     totalDocs?: number;
     totalPages?: number;
     prevPage?: number | null;
@@ -116,7 +116,7 @@ interface ItemsRawResponse {
 }
 
 declare class ItemsApi extends ApiClient {
-    getItems(params?: GetItemsParams): Promise<ApiResponse<Item>>;
+    getItems(params?: GetItemsParams): Promise<ApiResponse<Item[]>>;
     private fetchItemsFromAPI;
 }
 declare const itemsApi: ItemsApi;
@@ -126,6 +126,11 @@ interface Category {
     name: string;
     image_url: string;
 }
+interface CategoryEcommerceRaw {
+    id: number;
+    name: string;
+    image_url: string;
+}
 interface CategoriesWhere {
     item_super_category_id?: WhereClause;
     brand_id?: WhereClause;
@@ -135,19 +140,14 @@ interface GetCategoriesParams {
     limit?: number;
     page?: number;
     sort?: string;
+    [key: string]: unknown;
 }
 interface CategoriesRawResponse {
-    docs: Category[];
-}
-interface CategoriesApiResponse {
-    data: Category[] | null;
-    categories: Category[];
-    error: boolean;
-    errorMessage: string | null;
+    docs: CategoryEcommerceRaw[];
 }
 
 declare class CategoriesApi extends ApiClient {
-    getCategories(params?: GetCategoriesParams): Promise<CategoriesApiResponse>;
+    getCategories(params?: GetCategoriesParams): Promise<ApiResponse<Category[]>>;
     private fetchCategoriesFromAPI;
 }
 declare const categoriesApi: CategoriesApi;
@@ -159,15 +159,23 @@ interface Brand {
     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;
 }
 interface GetBrandsParams {
     limit?: number;
     page?: number;
     sort?: string;
+    [key: string]: unknown;
 }
 interface BrandsRawResponse {
-    docs: Brand[];
+    docs: BrandEcommerceRaw[];
     hasNextPage: boolean;
     hasPrevPage: boolean;
     limit: number;
@@ -179,25 +187,9 @@ interface BrandsRawResponse {
     totalDocs: number;
     totalPages: number;
 }
-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;
-}
 
 declare class BrandsApi extends ApiClient {
-    getBrands(params?: GetBrandsParams): Promise<BrandsApiResponse>;
+    getBrands(params?: GetBrandsParams): Promise<ApiResponse<Brand[]>>;
     private fetchBrandsFromAPI;
 }
 declare const brandsApi: BrandsApi;
@@ -229,7 +221,39 @@ interface Entity {
     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 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_thumbnail_url: string;
     featured_image_sizes_thumbnail_filename: string;
     featured_image_filename: string;
@@ -240,17 +264,11 @@ interface GetEntityParams {
     [key: string]: unknown;
 }
 interface EntityRawResponse {
-    GetEntity: Entity;
-}
-interface EntityApiResponse {
-    data: Entity | null;
-    entity: Entity | null;
-    error: boolean;
-    errorMessage: string | null;
+    GetEntity: EntityEcommerceRaw;
 }
 
 declare class EntityApi extends ApiClient {
-    getEntity(params?: GetEntityParams): Promise<EntityApiResponse>;
+    getEntity(params?: GetEntityParams): Promise<ApiResponse<Entity>>;
     private fetchEntityFromAPI;
 }
 declare const entityApi: EntityApi;
@@ -288,6 +306,7 @@ interface SendContactUsEmailParams {
     phone?: string;
     notes?: string;
     subject?: string;
+    [key: string]: unknown;
 }
 interface SendContactUsEmailResponse {
     message: string;
@@ -316,4 +335,4 @@ declare class CustomApi extends ApiClient {
 }
 declare const customApi: CustomApi;
 
-export { ApiClient, type ApiResponse, type Brand, type BrandsApiResponse, type BrandsRawResponse, type CategoriesApiResponse, type CategoriesRawResponse, type CategoriesWhere, type Category, type CreateEcommerceOrderItem, 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 ItemEcommerceRaw, type ItemImage, type ItemsRawResponse, type ItemsWhere, type SendContactUsEmailParams, type SendContactUsEmailResponse, type WhereClause, brandsApi, categoriesApi, contactApi, customApi, entityApi, itemsApi, ordersApi };
+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 };

package/dist/index.d.ts

@@ -7,7 +7,7 @@ declare class CacheService {
     constructor(apiKey: string);
     private generateParamsHash;
     buildCacheKey(functionName: string, params?: Record<string, unknown>): string;
-    cacheWrap<T>(key: string, fetcher: () => Promise<T>): Promise<T>;
+    cacheWrap<T>(key: string, fetcher: () => Promise<T>, filters?: Record<string, unknown>): Promise<T>;
 }
 
 declare class ApiClient {
@@ -25,7 +25,7 @@ declare class ApiClient {
 }
 
 interface ApiResponse<T> {
-    data: T[] | null;
+    data: T | null;
     totalDocs?: number;
     totalPages?: number;
     prevPage?: number | null;
@@ -116,7 +116,7 @@ interface ItemsRawResponse {
 }
 
 declare class ItemsApi extends ApiClient {
-    getItems(params?: GetItemsParams): Promise<ApiResponse<Item>>;
+    getItems(params?: GetItemsParams): Promise<ApiResponse<Item[]>>;
     private fetchItemsFromAPI;
 }
 declare const itemsApi: ItemsApi;
@@ -126,6 +126,11 @@ interface Category {
     name: string;
     image_url: string;
 }
+interface CategoryEcommerceRaw {
+    id: number;
+    name: string;
+    image_url: string;
+}
 interface CategoriesWhere {
     item_super_category_id?: WhereClause;
     brand_id?: WhereClause;
@@ -135,19 +140,14 @@ interface GetCategoriesParams {
     limit?: number;
     page?: number;
     sort?: string;
+    [key: string]: unknown;
 }
 interface CategoriesRawResponse {
-    docs: Category[];
-}
-interface CategoriesApiResponse {
-    data: Category[] | null;
-    categories: Category[];
-    error: boolean;
-    errorMessage: string | null;
+    docs: CategoryEcommerceRaw[];
 }
 
 declare class CategoriesApi extends ApiClient {
-    getCategories(params?: GetCategoriesParams): Promise<CategoriesApiResponse>;
+    getCategories(params?: GetCategoriesParams): Promise<ApiResponse<Category[]>>;
     private fetchCategoriesFromAPI;
 }
 declare const categoriesApi: CategoriesApi;
@@ -159,15 +159,23 @@ interface Brand {
     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;
 }
 interface GetBrandsParams {
     limit?: number;
     page?: number;
     sort?: string;
+    [key: string]: unknown;
 }
 interface BrandsRawResponse {
-    docs: Brand[];
+    docs: BrandEcommerceRaw[];
     hasNextPage: boolean;
     hasPrevPage: boolean;
     limit: number;
@@ -179,25 +187,9 @@ interface BrandsRawResponse {
     totalDocs: number;
     totalPages: number;
 }
-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;
-}
 
 declare class BrandsApi extends ApiClient {
-    getBrands(params?: GetBrandsParams): Promise<BrandsApiResponse>;
+    getBrands(params?: GetBrandsParams): Promise<ApiResponse<Brand[]>>;
     private fetchBrandsFromAPI;
 }
 declare const brandsApi: BrandsApi;
@@ -229,7 +221,39 @@ interface Entity {
     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 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_thumbnail_url: string;
     featured_image_sizes_thumbnail_filename: string;
     featured_image_filename: string;
@@ -240,17 +264,11 @@ interface GetEntityParams {
     [key: string]: unknown;
 }
 interface EntityRawResponse {
-    GetEntity: Entity;
-}
-interface EntityApiResponse {
-    data: Entity | null;
-    entity: Entity | null;
-    error: boolean;
-    errorMessage: string | null;
+    GetEntity: EntityEcommerceRaw;
 }
 
 declare class EntityApi extends ApiClient {
-    getEntity(params?: GetEntityParams): Promise<EntityApiResponse>;
+    getEntity(params?: GetEntityParams): Promise<ApiResponse<Entity>>;
     private fetchEntityFromAPI;
 }
 declare const entityApi: EntityApi;
@@ -288,6 +306,7 @@ interface SendContactUsEmailParams {
     phone?: string;
     notes?: string;
     subject?: string;
+    [key: string]: unknown;
 }
 interface SendContactUsEmailResponse {
     message: string;
@@ -316,4 +335,4 @@ declare class CustomApi extends ApiClient {
 }
 declare const customApi: CustomApi;
 
-export { ApiClient, type ApiResponse, type Brand, type BrandsApiResponse, type BrandsRawResponse, type CategoriesApiResponse, type CategoriesRawResponse, type CategoriesWhere, type Category, type CreateEcommerceOrderItem, 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 ItemEcommerceRaw, type ItemImage, type ItemsRawResponse, type ItemsWhere, type SendContactUsEmailParams, type SendContactUsEmailResponse, type WhereClause, brandsApi, categoriesApi, contactApi, customApi, entityApi, itemsApi, ordersApi };
+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 };