@djust-b2b/djust-front-sdk 1.11.0 → 1.11.1

package/lib/index.d.ts

@@ -116,7 +116,7 @@ export declare const DjustSDK: {
     updateCustomerAccountOrganisationUser({ organisationId, customerUserId, civility, customFieldValues, firstName, lastName, phone, }: import("./interfaces").UpdateCustomerAccountOrganisationUserParameters): Promise<import("./interfaces").UpdateCustomerAccountOrganisationUserResponse>;
     deleteCarts(): Promise<import("./interfaces").DeleteCartsResponse>;
     getCarts(params: import("./interfaces").GetCartsParameters): Promise<import("./interfaces").GetCartsResponse>;
-    createCart(params: import("./interfaces").CreateCartParameters): Promise<void>;
+    createCart(params: import("./interfaces").CreateCartParameters): Promise<import("./interfaces").GetCartResponse>;
     deleteCart(params: import("./interfaces").DeleteCartParameters): Promise<void>;
     getCart(params: import("./interfaces").GetCartParameters): Promise<import("./interfaces").GetCartResponse>;
     updateCart(params: import("./interfaces").UpdateCartParameters): Promise<void>;

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

@@ -93,7 +93,7 @@ export declare function getCarts(params: GetCartsParameters): Promise<GetCartsRe
  *
  * The name of the cart to create.
  *
- * @returns {Promise<void>} - A promise that resolves when the cart is created.
+ * @returns {Promise<GetCartResponse>} - A promise that resolves when the cart is created.
  *
  * @example
  * #### input
@@ -107,7 +107,7 @@ export declare function getCarts(params: GetCartsParameters): Promise<GetCartsRe
  * }
  * ```
  */
-export declare function createCart(params: CreateCartParameters): Promise<void>;
+export declare function createCart(params: CreateCartParameters): Promise<GetCartResponse>;
 /**
  * APICODE(cART300)
  * Deletes a specific cart.

package/lib/services/cart/index.js

@@ -127,7 +127,7 @@ async function getCarts(params) {
  *
  * The name of the cart to create.
  *
- * @returns {Promise<void>} - A promise that resolves when the cart is created.
+ * @returns {Promise<GetCartResponse>} - A promise that resolves when the cart is created.
  *
  * @example
  * #### input
@@ -143,11 +143,12 @@ async function getCarts(params) {
  */
 async function createCart(params) {
     const { name } = params;
-    (0, fetch_instance_1.enhancedFetch)({
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
         method: "POST",
         path: `/v2/shop/carts`,
         body: JSON.stringify({ name }),
     });
+    return data;
 }
 /**
  * APICODE(cART300)

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

@@ -0,0 +1,145 @@
+import { AttributeObject } from "../../interfaces/models/attribute";
+import { PageableParameters } from "../../interfaces/models/common";
+import { OfferResponse } from "../../interfaces/models/offer";
+import { PageProductVariantResponse, Product, ProductAutocomplete, ProductReviewDto, ProductReviewRatings, ProductReviewsSummary, SearchThumbnailsAndAggregation } from "../../interfaces/models/product";
+import { SearchProduct } from "../../interfaces/models/searchProduct";
+import { SupplierSimpleView } from "../../interfaces/models/supplier";
+import { Order, PageableObject } from "../../interfaces/models/common";
+/**
+ * Requests parameters type definitions
+ */
+export interface CreateProductReviewParameters {
+    message: string;
+    productSku: string;
+    rating: number;
+}
+export interface UpdateProductReviewParameters {
+    productReviewId: string;
+    message: string;
+    rating: number;
+}
+declare enum AggregationType {
+    PRODUCT = "PRODUCT",
+    VARIANT = "VARIANT"
+}
+export interface GetProductsListParameters {
+    locale: string;
+    filters?: {
+        currency: string;
+        categoryIds?: string[];
+        skus?: string[];
+        brand?: string[];
+        query?: string;
+        productTags?: string[];
+        aggregation?: AggregationType;
+        attributes?: string[];
+        suppliers?: string[];
+        customFields?: string[];
+        offerUpdatedTime?: string;
+        productUpdatedTime?: string;
+    };
+    pageable?: PageableParameters;
+}
+export interface GetProductStatReviewsParameters {
+    productIdentifier: string;
+    productIdType: string;
+}
+export interface GetProductReviewsParameters {
+    productIdentifier: string;
+    productIdType: string;
+}
+export interface GetProductParameters {
+    productIdentifier: string;
+    productIdType: string;
+    locale?: string;
+}
+export interface GetProductOffersParameters {
+    productIdentifier: string;
+    productIdType: string;
+    locale?: string;
+    currency?: string;
+}
+export interface GetProductVariantsListParameters {
+    productSku: string;
+    locale?: string;
+    pageable?: PageableParameters;
+}
+export interface GetProductVariantAttributesParameters {
+    productIdentifier: string;
+    productIdType: string;
+    locale?: string;
+}
+export interface AutoCompleteSearchProductsParameters {
+    input: string;
+    locale: string;
+    currency: string;
+    aggregation?: AggregationType;
+    productTags?: string[];
+    pageable?: PageableParameters;
+}
+export interface GetProductVariantSuppliersParameters {
+    productVariantId: string;
+}
+export interface GetProductVariantOffersParameters {
+    productIdentifier: string;
+    productIdType: string;
+    currency?: string;
+}
+export interface GetRelatedProductsParameters {
+    productIdentifier: string;
+    productIdType: string;
+    locale?: string;
+    currency?: string;
+    pageable?: PageableParameters;
+}
+/**
+ * Responses type definitions
+ */
+export interface CreateProductReviewResponse extends ProductReviewsSummary {
+}
+export interface UpdateProductReviewResponse extends ProductReviewDto {
+}
+export interface GetProductsListResponse extends SearchProduct {
+}
+export interface GetProductStatReviewsResponse extends ProductReviewRatings {
+}
+export interface GetProductReviewsResponse extends Array<ProductReviewsSummary> {
+}
+export interface GetProductResponse extends Product {
+}
+export interface GetProductOffersResponse extends Array<OfferResponse> {
+}
+export interface GetProductVariantsListResponse extends PageProductVariantResponse {
+}
+export interface GetProductVariantAttributesResponse extends Array<AttributeObject> {
+}
+export interface SearchProductsResponse extends Array<ProductAutocomplete> {
+}
+export interface GetProductVariantSuppliersResponse extends Array<SupplierSimpleView> {
+}
+export interface GetProductVariantOffersResponse extends Array<OfferResponse> {
+}
+export interface GetRelatedProductsResponse extends SearchThumbnailsAndAggregation {
+}
+export interface GetProductPaginatedOffersParameters {
+    productIdentifier: string;
+    productIdType?: string;
+    locale?: string;
+    currency?: string;
+    withoutPrices?: boolean;
+    pageable?: PageableParameters;
+}
+export interface GetProductPaginatedOffersResponse {
+    content: OfferResponse[];
+    empty: boolean;
+    first: boolean;
+    last: boolean;
+    number: number;
+    numberOfElements: number;
+    pageable: PageableObject;
+    size: number;
+    sort: Order[];
+    totalElements: number;
+    totalPages: number;
+}
+export {};

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

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var AggregationType;
+(function (AggregationType) {
+    AggregationType["PRODUCT"] = "PRODUCT";
+    AggregationType["VARIANT"] = "VARIANT";
+})(AggregationType || (AggregationType = {}));

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

@@ -0,0 +1,200 @@
+import { GetProductVariantAttributesParameters, GetProductVariantAttributesResponse, GetProductVariantSuppliersParameters, GetProductVariantSuppliersResponse, GetProductVariantsListParameters, GetProductVariantsListResponse } from "./definitions";
+/**
+ * APICODE(pVAR300)
+ * Retrieves a paginated list of product variants.
+ *
+ * This function fetches a list of product variants associated with a specific product SKU.
+ *
+ * @param {GetProductVariantsListParameters} params - The parameters to filter the product variants list, including:
+ * #### productSku - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * The SKU of the product to fetch variants for.
+ *
+ * #### locale - `string` | optional
+ * The locale for the product variants.
+ *
+ * #### pageable - `object` | optional
+ * Pagination details, including:
+ * - `page`: The page number.
+ * - `size`: The number of items per page.
+ * - `sort`: Sorting criteria.
+ *
+ * @returns {Promise<GetProductVariantsListResponse>} - A promise that resolves with the paginated list of product variants.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * await getProductVariantsList({
+ *   productSku: 'product123',
+ *   locale: 'en-US',
+ *   pageable: { page: 1, size: 10, sort: 'name,asc' },
+ * });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "content": [
+ *     { "id": "variant1", "name": "Variant 1" },
+ *     { "id": "variant2", "name": "Variant 2" }
+ *   ],
+ *   "pageable": {
+ *     "page": 1,
+ *     "size": 10,
+ *     "totalPages": 5
+ *   }
+ * }
+ * ```
+ */
+export declare function getProductVariantsList({ productSku, locale, pageable, }: GetProductVariantsListParameters): Promise<GetProductVariantsListResponse>;
+/**
+ * APICODE(vSUP300)
+ * Retrieves suppliers of a specific product variant.
+ *
+ * This function fetches a list of suppliers associated with a product variant.
+ *
+ * @param {GetProductVariantSuppliersParameters} params - The parameters to identify the product variant, including:
+ * #### productVariantId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * The ID of the product variant to fetch suppliers for.
+ *
+ * @returns {Promise<GetProductVariantSuppliersResponse>} - A promise that resolves with the suppliers of the product variant.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * await getProductVariantSuppliers({ productVariantId: 'variant123' });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "suppliers": [
+ *     { "id": "supplier1", "name": "Supplier 1" },
+ *     { "id": "supplier2", "name": "Supplier 2" }
+ *   ]
+ * }
+ * ```
+ */
+export declare function getProductVariantSuppliers({ productVariantId, }: GetProductVariantSuppliersParameters): Promise<GetProductVariantSuppliersResponse>;
+/**
+ * ## 🛒 APICODE(vATT300) - Fetch Product Variant Attributes
+ *
+ * Retrieves detailed attributes of a product variant identified by SKU, ID, or external ID.
+ * This metadata includes key details such as **color**, **size**, and **material**, making it easier to describe the variant.
+ *
+ * ---
+ *
+ * ### 📥 Parameters
+ *
+ * | Parameter           | Type     | Required | Description                                                                 |
+ * |---------------------|----------|----------|-----------------------------------------------------------------------------|
+ * | `productIdentifier` | `string` | ✅ Yes    | The unique identifier of the product variant (e.g., SKU, ID, external ID). |
+ * | `productIdType`     | `string` | ✅ Yes    | The type of the identifier: `"sku"`, `"id"`, or `"externalId"`.            |
+ * | `locale`            | `string` | ❌ No     | The locale for localized data (e.g., `"en-US"`, `"fr-FR"`). Defaults to the system locale. |
+ *
+ * ---
+ *
+ * ### 📤 Returns
+ * **Type:** `Promise<GetProductVariantAttributesResponse>`
+ * Resolves with the following structure:
+ *
+ * ```typescript
+ * {
+ *   attributes: Array<{
+ *     id: string;
+ *     name: string;
+ *     value: string | number;
+ *     type: string;
+ *     isRequired: boolean;
+ *     description: string;
+ *   }>;
+ *   locale: string;
+ *   productIdentifier: string;
+ * }
+ * ```
+ *
+ * ---
+ *
+ * ### 🧑‍💻 Example Usage
+ *
+ * **Basic Example:**
+ * ```typescript
+ * const attributes = await getProductVariantAttributes({
+ *   productIdentifier: 'sku123',
+ *   productIdType: 'sku',
+ *   locale: 'en-US',
+ * });
+ * console.log(attributes);
+ * ```
+ *
+ * **Alternative Locale:**
+ * ```typescript
+ * const attributes = await getProductVariantAttributes({
+ *   productIdentifier: 'prod789',
+ *   productIdType: 'externalId',
+ *   locale: 'fr-FR',
+ * });
+ * console.log(attributes);
+ * ```
+ *
+ * ---
+ *
+ * ### 📝 Example Input
+ * ```json
+ * {
+ *   "productIdentifier": "sku123",
+ *   "productIdType": "sku",
+ *   "locale": "en-US"
+ * }
+ * ```
+ *
+ * ---
+ *
+ * ### 📦 Example Output
+ * ```json
+ * {
+ *   "attributes": [
+ *     {
+ *       "id": "attr1",
+ *       "name": "Color",
+ *       "value": "Red",
+ *       "type": "text",
+ *       "isRequired": true,
+ *       "description": "The color of the product variant."
+ *     },
+ *     {
+ *       "id": "attr2",
+ *       "name": "Size",
+ *       "value": "M",
+ *       "type": "text",
+ *       "isRequired": false,
+ *       "description": "The size of the product variant."
+ *     }
+ *   ],
+ *   "locale": "en-US",
+ *   "productIdentifier": "sku123"
+ * }
+ * ```
+ *
+ * ---
+ *
+ * ### 🚨 Error Responses
+ *
+ * | Code  | Message                                  | Description                                          |
+ * |-------|------------------------------------------|------------------------------------------------------|
+ * | `400` | `Bad Request`                            | Missing or invalid `productIdentifier` or `productIdType`. |
+ * | `404` | `Not Found`                              | The specified product variant does not exist.       |
+ * | `500` | `Internal Server Error`                  | Unexpected error on the server.                    |
+ *
+ * ---
+ *
+ * ### 📚 Notes
+ * - Ensure the `productIdType` matches the `productIdentifier` value to avoid mismatched requests.
+ * - Providing a valid `locale` is recommended for fetching localized attribute data when applicable.
+ * - This API version supports strict versioning; ensure compatibility with your application's requirements.
+ *
+ * ---
+ *
+ * ### 🔗 Additional Resources
+ * - [API Authentication Guide](https://docs.example.com/api-authentication)
+ * - [Product Variants Documentation](https://docs.example.com/product-variants)
+ * - [Common Error Codes](https://docs.example.com/error-codes)
+ */
+export declare function getProductVariantAttributes({ productIdentifier, productIdType, locale, }: GetProductVariantAttributesParameters): Promise<GetProductVariantAttributesResponse>;

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

@@ -0,0 +1,238 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProductVariantsList = getProductVariantsList;
+exports.getProductVariantSuppliers = getProductVariantSuppliers;
+exports.getProductVariantAttributes = getProductVariantAttributes;
+const parameters_validation_1 = require("../../helpers/parameters-validation");
+const fetch_instance_1 = require("../../settings/fetch-instance");
+/**
+ * APICODE(pVAR300)
+ * Retrieves a paginated list of product variants.
+ *
+ * This function fetches a list of product variants associated with a specific product SKU.
+ *
+ * @param {GetProductVariantsListParameters} params - The parameters to filter the product variants list, including:
+ * #### productSku - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * The SKU of the product to fetch variants for.
+ *
+ * #### locale - `string` | optional
+ * The locale for the product variants.
+ *
+ * #### pageable - `object` | optional
+ * Pagination details, including:
+ * - `page`: The page number.
+ * - `size`: The number of items per page.
+ * - `sort`: Sorting criteria.
+ *
+ * @returns {Promise<GetProductVariantsListResponse>} - A promise that resolves with the paginated list of product variants.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * await getProductVariantsList({
+ *   productSku: 'product123',
+ *   locale: 'en-US',
+ *   pageable: { page: 1, size: 10, sort: 'name,asc' },
+ * });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "content": [
+ *     { "id": "variant1", "name": "Variant 1" },
+ *     { "id": "variant2", "name": "Variant 2" }
+ *   ],
+ *   "pageable": {
+ *     "page": 1,
+ *     "size": 10,
+ *     "totalPages": 5
+ *   }
+ * }
+ * ```
+ */
+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,
+            sort: pageable === null || pageable === void 0 ? void 0 : pageable.sort,
+        },
+    });
+    return data;
+}
+/**
+ * APICODE(vSUP300)
+ * Retrieves suppliers of a specific product variant.
+ *
+ * This function fetches a list of suppliers associated with a product variant.
+ *
+ * @param {GetProductVariantSuppliersParameters} params - The parameters to identify the product variant, including:
+ * #### productVariantId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * The ID of the product variant to fetch suppliers for.
+ *
+ * @returns {Promise<GetProductVariantSuppliersResponse>} - A promise that resolves with the suppliers of the product variant.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * await getProductVariantSuppliers({ productVariantId: 'variant123' });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "suppliers": [
+ *     { "id": "supplier1", "name": "Supplier 1" },
+ *     { "id": "supplier2", "name": "Supplier 2" }
+ *   ]
+ * }
+ * ```
+ */
+async function getProductVariantSuppliers({ productVariantId, }) {
+    (0, parameters_validation_1.required)({ productVariantId });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "GET",
+        path: `/v1/shop/product-variants/${productVariantId}/suppliers`,
+    });
+    return data;
+}
+/**
+ * ## 🛒 APICODE(vATT300) - Fetch Product Variant Attributes
+ *
+ * Retrieves detailed attributes of a product variant identified by SKU, ID, or external ID.
+ * This metadata includes key details such as **color**, **size**, and **material**, making it easier to describe the variant.
+ *
+ * ---
+ *
+ * ### 📥 Parameters
+ *
+ * | Parameter           | Type     | Required | Description                                                                 |
+ * |---------------------|----------|----------|-----------------------------------------------------------------------------|
+ * | `productIdentifier` | `string` | ✅ Yes    | The unique identifier of the product variant (e.g., SKU, ID, external ID). |
+ * | `productIdType`     | `string` | ✅ Yes    | The type of the identifier: `"sku"`, `"id"`, or `"externalId"`.            |
+ * | `locale`            | `string` | ❌ No     | The locale for localized data (e.g., `"en-US"`, `"fr-FR"`). Defaults to the system locale. |
+ *
+ * ---
+ *
+ * ### 📤 Returns
+ * **Type:** `Promise<GetProductVariantAttributesResponse>`
+ * Resolves with the following structure:
+ *
+ * ```typescript
+ * {
+ *   attributes: Array<{
+ *     id: string;
+ *     name: string;
+ *     value: string | number;
+ *     type: string;
+ *     isRequired: boolean;
+ *     description: string;
+ *   }>;
+ *   locale: string;
+ *   productIdentifier: string;
+ * }
+ * ```
+ *
+ * ---
+ *
+ * ### 🧑‍💻 Example Usage
+ *
+ * **Basic Example:**
+ * ```typescript
+ * const attributes = await getProductVariantAttributes({
+ *   productIdentifier: 'sku123',
+ *   productIdType: 'sku',
+ *   locale: 'en-US',
+ * });
+ * console.log(attributes);
+ * ```
+ *
+ * **Alternative Locale:**
+ * ```typescript
+ * const attributes = await getProductVariantAttributes({
+ *   productIdentifier: 'prod789',
+ *   productIdType: 'externalId',
+ *   locale: 'fr-FR',
+ * });
+ * console.log(attributes);
+ * ```
+ *
+ * ---
+ *
+ * ### 📝 Example Input
+ * ```json
+ * {
+ *   "productIdentifier": "sku123",
+ *   "productIdType": "sku",
+ *   "locale": "en-US"
+ * }
+ * ```
+ *
+ * ---
+ *
+ * ### 📦 Example Output
+ * ```json
+ * {
+ *   "attributes": [
+ *     {
+ *       "id": "attr1",
+ *       "name": "Color",
+ *       "value": "Red",
+ *       "type": "text",
+ *       "isRequired": true,
+ *       "description": "The color of the product variant."
+ *     },
+ *     {
+ *       "id": "attr2",
+ *       "name": "Size",
+ *       "value": "M",
+ *       "type": "text",
+ *       "isRequired": false,
+ *       "description": "The size of the product variant."
+ *     }
+ *   ],
+ *   "locale": "en-US",
+ *   "productIdentifier": "sku123"
+ * }
+ * ```
+ *
+ * ---
+ *
+ * ### 🚨 Error Responses
+ *
+ * | Code  | Message                                  | Description                                          |
+ * |-------|------------------------------------------|------------------------------------------------------|
+ * | `400` | `Bad Request`                            | Missing or invalid `productIdentifier` or `productIdType`. |
+ * | `404` | `Not Found`                              | The specified product variant does not exist.       |
+ * | `500` | `Internal Server Error`                  | Unexpected error on the server.                    |
+ *
+ * ---
+ *
+ * ### 📚 Notes
+ * - Ensure the `productIdType` matches the `productIdentifier` value to avoid mismatched requests.
+ * - Providing a valid `locale` is recommended for fetching localized attribute data when applicable.
+ * - This API version supports strict versioning; ensure compatibility with your application's requirements.
+ *
+ * ---
+ *
+ * ### 🔗 Additional Resources
+ * - [API Authentication Guide](https://docs.example.com/api-authentication)
+ * - [Product Variants Documentation](https://docs.example.com/product-variants)
+ * - [Common Error Codes](https://docs.example.com/error-codes)
+ */
+async function getProductVariantAttributes({ productIdentifier, productIdType, locale, }) {
+    (0, parameters_validation_1.required)({ productIdentifier, productIdType });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "GET",
+        path: `/v1/shop/products/${productIdentifier}/variant-attributes`,
+        params: {
+            productIdType,
+            locale,
+        },
+    });
+    return data;
+}

package/package.json

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