@djust-b2b/djust-front-sdk 2.1.0 → 2.1.1

package/lib/services/product/index.d.ts

@@ -1,4 +1,4 @@
-import { CreateProductReviewParameters, CreateProductReviewResponse, GetProductOffersParameters, GetProductOffersResponse, GetProductParameters, GetProductReviewsParameters, GetProductReviewsResponse, GetProductStatReviewsParameters, GetProductStatReviewsResponse, GetProductVariantAttributesParameters, GetProductVariantAttributesResponse, GetProductVariantOffersParameters, GetProductVariantOffersResponse, GetProductVariantSuppliersParameters, GetProductVariantSuppliersResponse, GetProductVariantsListParameters, GetProductVariantsListResponse, GetProductsListParameters, GetProductsListResponse, GetRelatedProductsParameters, AutoCompleteSearchProductsParameters, SearchProductsResponse, UpdateProductReviewParameters, UpdateProductReviewResponse, GetProductPaginatedOffersParameters, GetProductPaginatedOffersResponse, GetRelatedProductsResponse } from "./definitions";
+import { CreateProductReviewParameters, CreateProductReviewResponse, GetProductOffersParameters, GetProductOffersResponse, GetProductParameters, GetProductReviewsParameters, GetProductReviewsResponse, GetProductStatReviewsParameters, GetProductStatReviewsResponse, GetProductVariantAttributesParameters, GetProductVariantAttributesResponse, GetProductVariantOffersParameters, GetProductVariantOffersResponse, GetProductVariantSuppliersParameters, GetProductVariantSuppliersResponse, GetProductsListParameters, GetProductsListResponse, GetRelatedProductsParameters, AutoCompleteSearchProductsParameters, SearchProductsResponse, UpdateProductReviewParameters, UpdateProductReviewResponse, GetProductPaginatedOffersParameters, GetProductPaginatedOffersResponse, GetRelatedProductsResponse } from "./definitions";
 /**
  * 📄 Search products with a text expression for search and autocomplete.
  *
@@ -57,32 +57,6 @@ export declare function autoCompleteSearchProducts({ input, locale, currency, pa
  * ```
  */
 export declare function getProductsList({ locale, filters, pageable, }: GetProductsListParameters): Promise<GetProductsListResponse>;
-/**
- * 📄 Fetches product variants by product SKU.
- *
- * 🛠 **Endpoint**: `GET /v1/shop/product-variants`
- *
- * | Parameter       | Type         | Required | Description                                |
- * |-----------------|--------------|----------|--------------------------------------------|
- * | `productSku`    | `string`     | ✅       | The SKU of the product.                   |
- * | `locale`        | `string`     | ❌       | The locale for product variants.          |
- * | `pageable.page` | `number`     | ❌       | The page number to fetch (0-based index). |
- * | `pageable.size` | `number`     | ❌       | The number of items per page.             |
- *
- * 📤 **Returns**:
- * A `Promise` resolving to a `GetProductVariantsListResponse` containing the product variants.
- *
- * 🛠 **Example usage**:
- * ```typescript
- * const variants = await getProductVariantsList({
- *   productSku: 'sku123',
- *   locale: 'en-US',
- *   pageable: { page: 0, size: 10 },
- * });
- * console.log(variants);
- * ```
- */
-export declare function getProductVariantsList({ productSku, locale, pageable, }: GetProductVariantsListParameters): Promise<GetProductVariantsListResponse>;
 /**
  * 📄 Fetches offers for a specific product variant.
  *
@@ -132,7 +106,7 @@ export declare function getProductVariantsList({ productSku, locale, pageable, }
  * }
  * ```
  */
-export declare function getProductVariantOffers({ productIdentifier, productIdType, currency, }: GetProductVariantOffersParameters): Promise<GetProductVariantOffersResponse>;
+export declare function getProductVariantOffers({ productIdentifier, productIdType, currency, withoutPrice, }: GetProductVariantOffersParameters): Promise<GetProductVariantOffersResponse>;
 /**
  * 📄 Fetches suppliers associated with a product variant.
  *
@@ -186,6 +160,8 @@ export declare function getProductVariantSuppliers({ productVariantId, }: GetPro
  */
 export declare function getProduct({ productIdentifier, productIdType, locale, }: GetProductParameters): Promise<GetProductsListResponse>;
 /**
+ * @deprecated
+ *
  * 📄 Fetches product offers by SKU, ID, or external ID.
  *
  * 🛠 **Endpoint**: `GET /v1/shop/products/{productIdentifier}/offers`
@@ -208,8 +184,9 @@ export declare function getProduct({ productIdentifier, productIdType, locale, }
  * });
  * console.log(offers);
  * ```
+ * SWAGGER [PRODUCT-502]
  */
-export declare function getProductOffers({ productIdentifier, productIdType, locale, currency, }: GetProductOffersParameters): Promise<GetProductOffersResponse>;
+export declare function getProductOffers({ productIdentifier, productIdType, locale, currency, withoutPrice, }: GetProductOffersParameters): Promise<GetProductOffersResponse>;
 /**
  * 📄 Fetches related products for a specific product.
  *

package/lib/services/product/index.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.autoCompleteSearchProducts = autoCompleteSearchProducts;
 exports.getProductsList = getProductsList;
-exports.getProductVariantsList = getProductVariantsList;
 exports.getProductVariantOffers = getProductVariantOffers;
 exports.getProductVariantSuppliers = getProductVariantSuppliers;
 exports.getProduct = getProduct;
@@ -60,6 +59,7 @@ async function autoCompleteSearchProducts({ input, locale, currency, pageable, a
             productTags,
             page: pageable === null || pageable === void 0 ? void 0 : pageable.page,
             size: pageable === null || pageable === void 0 ? void 0 : pageable.size,
+            sort: pageable === null || pageable === void 0 ? void 0 : pageable.sort,
         },
     });
     return data;
@@ -104,45 +104,6 @@ async function getProductsList({ locale, filters, pageable, }) {
     });
     return data;
 }
-/**
- * 📄 Fetches product variants by product SKU.
- *
- * 🛠 **Endpoint**: `GET /v1/shop/product-variants`
- *
- * | Parameter       | Type         | Required | Description                                |
- * |-----------------|--------------|----------|--------------------------------------------|
- * | `productSku`    | `string`     | ✅       | The SKU of the product.                   |
- * | `locale`        | `string`     | ❌       | The locale for product variants.          |
- * | `pageable.page` | `number`     | ❌       | The page number to fetch (0-based index). |
- * | `pageable.size` | `number`     | ❌       | The number of items per page.             |
- *
- * 📤 **Returns**:
- * A `Promise` resolving to a `GetProductVariantsListResponse` containing the product variants.
- *
- * 🛠 **Example usage**:
- * ```typescript
- * const variants = await getProductVariantsList({
- *   productSku: 'sku123',
- *   locale: 'en-US',
- *   pageable: { page: 0, size: 10 },
- * });
- * console.log(variants);
- * ```
- */
-async function getProductVariantsList({ productSku, locale, pageable, }) {
-    (0, parameters_validation_1.required)({ productSku });
-    const { data } = await (0, fetch_instance_1.enhancedFetch)({
-        method: "GET",
-        path: `/v1/shop/product-variants`,
-        params: {
-            productSku,
-            locale,
-            page: pageable === null || pageable === void 0 ? void 0 : pageable.page,
-            size: pageable === null || pageable === void 0 ? void 0 : pageable.size,
-        },
-    });
-    return data;
-}
 /**
  * 📄 Fetches offers for a specific product variant.
  *
@@ -192,7 +153,7 @@ async function getProductVariantsList({ productSku, locale, pageable, }) {
  * }
  * ```
  */
-async function getProductVariantOffers({ productIdentifier, productIdType, currency, }) {
+async function getProductVariantOffers({ productIdentifier, productIdType, currency, withoutPrice, }) {
     (0, parameters_validation_1.required)({ productIdentifier, productIdType });
     const { data } = await (0, fetch_instance_1.enhancedFetch)({
         method: "GET",
@@ -200,6 +161,7 @@ async function getProductVariantOffers({ productIdentifier, productIdType, curre
         params: {
             productIdType,
             currency,
+            withoutPrice,
         },
     });
     return data;
@@ -275,6 +237,8 @@ async function getProduct({ productIdentifier, productIdType, locale, }) {
     return data;
 }
 /**
+ * @deprecated
+ *
  * 📄 Fetches product offers by SKU, ID, or external ID.
  *
  * 🛠 **Endpoint**: `GET /v1/shop/products/{productIdentifier}/offers`
@@ -297,8 +261,9 @@ async function getProduct({ productIdentifier, productIdType, locale, }) {
  * });
  * console.log(offers);
  * ```
+ * SWAGGER [PRODUCT-502]
  */
-async function getProductOffers({ productIdentifier, productIdType, locale, currency, }) {
+async function getProductOffers({ productIdentifier, productIdType, locale, currency, withoutPrice, }) {
     (0, parameters_validation_1.required)({ productIdentifier, productIdType });
     const { data } = await (0, fetch_instance_1.enhancedFetch)({
         method: "GET",
@@ -307,6 +272,7 @@ async function getProductOffers({ productIdentifier, productIdType, locale, curr
             productIdType,
             locale,
             currency,
+            withoutPrice,
         },
     });
     return data;

package/lib/services/product-variant/definitions.d.ts

@@ -141,4 +141,31 @@ export interface GetProductPaginatedOffersResponse {
     totalElements: number;
     totalPages: number;
 }
+export interface GetProductVariantParameters {
+    productVariantId: string;
+    locale?: string;
+}
+export interface ProductVariantPictureUrl {
+    formatType: string;
+    heightInPx: number;
+    sizeType: string;
+    url: string;
+    widthInPx: number;
+}
+export interface ProductVariantPicture {
+    isMain: boolean;
+    urls: ProductVariantPictureUrl[];
+}
+export interface GetProductVariantResponse {
+    description: string;
+    ean: string;
+    externalId: string;
+    id: string;
+    name: string;
+    productExternalId: string;
+    skuProduct: string;
+    skuVariant: string;
+    status: string;
+    variantPictures: ProductVariantPicture[];
+}
 export {};

package/lib/services/product-variant/index.d.ts

@@ -1,4 +1,4 @@
-import { GetProductVariantAttributesParameters, GetProductVariantAttributesResponse, GetProductVariantSuppliersParameters, GetProductVariantSuppliersResponse, GetProductVariantsListParameters, GetProductVariantsListResponse } from "./definitions";
+import { GetProductVariantAttributesParameters, GetProductVariantAttributesResponse, GetProductVariantParameters, GetProductVariantResponse, GetProductVariantSuppliersParameters, GetProductVariantSuppliersResponse, GetProductVariantsListParameters, GetProductVariantsListResponse } from "./definitions";
 /**
  * 📄 Fetches a paginated list of product variants.
  *
@@ -91,3 +91,32 @@ export declare function getProductVariantSuppliers({ productVariantId, }: GetPro
  * @returns {Promise<GetProductVariantAttributesResponse>} A promise resolving to the product variant attributes response.
  */
 export declare function getProductVariantAttributes({ productIdentifier, productIdType, locale, }: GetProductVariantAttributesParameters): Promise<GetProductVariantAttributesResponse>;
+/**
+ * 📄 Fetches details of a specific product variant.
+ *
+ * This function retrieves detailed information about a product variant identified by its ID.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/product-variants/{productVariantId}`
+ *
+ * | Parameter           | Type         | Required | Description                                     |
+ * |---------------------|--------------|----------|-------------------------------------------------|
+ * | `productVariantId`  | `string`     | ✅       | The ID of the product variant to fetch.         |
+ * | `locale`            | `string`     | ❌       | The locale for localized data (e.g., `en-US`).  |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetProductVariantResponse` object, containing the product variant details.
+ *
+ * 🛠 **Example usage**:
+ * ```typescript
+ * const variant = await getProductVariant({
+ *   productVariantId: 'variant123',
+ *   locale: 'fr-FR',
+ * });
+ * console.log(variant);
+ * ```
+ *
+ * @param {GetProductVariantParameters} params - The parameters for fetching the product variant.
+ * @throws {Error} If `productVariantId` is missing.
+ * @returns {Promise<GetProductVariantResponse>} A promise resolving to the product variant response.
+ */
+export declare function getProductVariant({ productVariantId, locale, }: GetProductVariantParameters): Promise<GetProductVariantResponse>;

package/lib/services/product-variant/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getProductVariantsList = getProductVariantsList;
 exports.getProductVariantSuppliers = getProductVariantSuppliers;
 exports.getProductVariantAttributes = getProductVariantAttributes;
+exports.getProductVariant = getProductVariant;
 const parameters_validation_1 = require("../../helpers/parameters-validation");
 const fetch_instance_1 = require("../../settings/fetch-instance");
 /**
@@ -129,3 +130,42 @@ async function getProductVariantAttributes({ productIdentifier, productIdType, l
     });
     return data;
 }
+/**
+ * 📄 Fetches details of a specific product variant.
+ *
+ * This function retrieves detailed information about a product variant identified by its ID.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/product-variants/{productVariantId}`
+ *
+ * | Parameter           | Type         | Required | Description                                     |
+ * |---------------------|--------------|----------|-------------------------------------------------|
+ * | `productVariantId`  | `string`     | ✅       | The ID of the product variant to fetch.         |
+ * | `locale`            | `string`     | ❌       | The locale for localized data (e.g., `en-US`).  |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetProductVariantResponse` object, containing the product variant details.
+ *
+ * 🛠 **Example usage**:
+ * ```typescript
+ * const variant = await getProductVariant({
+ *   productVariantId: 'variant123',
+ *   locale: 'fr-FR',
+ * });
+ * console.log(variant);
+ * ```
+ *
+ * @param {GetProductVariantParameters} params - The parameters for fetching the product variant.
+ * @throws {Error} If `productVariantId` is missing.
+ * @returns {Promise<GetProductVariantResponse>} A promise resolving to the product variant response.
+ */
+async function getProductVariant({ productVariantId, locale, }) {
+    (0, parameters_validation_1.required)({ productVariantId });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "GET",
+        path: `/v1/shop/product-variants/${productVariantId}`,
+        params: {
+            locale,
+        },
+    });
+    return data;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@djust-b2b/djust-front-sdk",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "DJUST Front SDK is a versatile JavaScript Software Development Kit (SDK)",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",