oneentry 1.0.122 → 1.0.124

package/dist/base/syncModules.d.ts

@@ -6,65 +6,65 @@ export default abstract class SyncModules {
     protected _url: string;
     protected constructor(state: StateModule);
     /**
-     * getFullPath
+     * Constructs the full URL path by appending the given path to the base URL.
      *
-     * @param path
-     * @returns
+     * @param path - The path to append to the base URL.
+     * @return The full URL as a string.
      */
     protected _getFullPath(path: string): string;
     /**
-     * queryParamsToString
+     * Converts query parameters into a query string.
      *
-     * @param query
-     * @returns
+     * @param query - The query object containing key-value pairs.
+     * @return A string representation of the query parameters.
      */
     protected _queryParamsToString(query: IProductsQuery | IUploadingQuery | any): string;
     /**
-     * normalizeData
+     * Normalizes data based on language code.
      *
-     * @param data
-     * @param langCode
-     * @returns normalized data
+     * @param data - The data to normalize.
+     * @param langCode - The language code for normalization.
+     * @return Normalized data.
      */
     protected _normalizeData(data: any, langCode?: string): any;
     /**
-     * normalizePostBody
+     * Normalizes the body of a POST request.
      *
-     * @param body
-     * @param langCode
-     * @returns
+     * @param body - The body to normalize.
+     * @param langCode - The language code for normalization.
+     * @return Normalized body.
      */
     protected _normalizePostBody(body: any, langCode?: string): any;
     /**
-     * clearArray
+     * Clears arrays within the data structure.
      *
-     * @param data
-     * @returns
+     * @param data - The data to clear.
+     * @return Cleared data.
      */
     protected _clearArray(data: Record<string, any>): any;
     /**
-     * Sort attributes by its positions
+     * Sorts attributes by their positions.
      *
-     * @param data
-     * @returns
+     * @param data - The data containing attributes.
+     * @return Sorted attributes.
      */
     protected _sortAttributes: (data: any) => {
         [k: string]: unknown;
     };
     /**
-     * Function to add days to a date
+     * Adds a specified number of days to a date.
      *
-     * @param date
-     * @param days
-     * @returns
+     * @param date - The initial date.
+     * @param days - The number of days to add.
+     * @return The new date with added days.
      */
     protected _addDays(date: Date, days: number): Date;
     /**
-     * Function to generate intervals for a specific date
+     * Generates intervals for a specific date based on a schedule.
      *
-     * @param date
-     * @param schedule
-     * @param utcIntervals
+     * @param date - The date for which to generate intervals.
+     * @param schedule - The schedule defining the intervals.
+     * @param utcIntervals - A set to store unique intervals.
      */
     protected _generateIntervalsForDate(date: Date, schedule: {
         inEveryWeek: boolean;
@@ -72,39 +72,39 @@ export default abstract class SyncModules {
         inEveryMonth: boolean;
     }, utcIntervals: Set<Array<string>>): void;
     /**
-     * Add TimeIntervals to schedules
+     * Adds time intervals to schedules.
      *
-     * @param schedules
-     * @returns schedules with timeIntervals
+     * @param schedules - The schedules to process.
+     * @return Schedules with added time intervals.
      */
     _addTimeIntervalsToSchedules(schedules: any[]): any[];
     /**
-     * normalizeAttr
+     * Normalizes attributes within the data.
      *
-     * @param data
-     * @returns normalized Attrs
+     * @param data - The data to normalize.
+     * @return Normalized attributes.
      */
     protected _normalizeAttr(data: any): any;
     /**
-     * dataPostProcess
+     * Processes data after fetching or receiving it.
      *
-     * @param data
-     * @param langCode
-     * @returns
+     * @param data - The data to process.
+     * @param langCode - The language code for processing.
+     * @return Processed data.
      */
     protected _dataPostProcess(data: any, langCode?: string): any;
     /**
-     * setAccessToken
+     * Sets the access token in the state.
      *
-     * @param accessToken
-     * @returns
+     * @param accessToken - The access token to set.
+     * @return The instance of SyncModules for chaining.
      */
     setAccessToken(accessToken: string): this;
     /**
-     * setRefreshToken
+     * Sets the refresh token in the state.
      *
-     * @param refreshToken
-     * @returns
+     * @param refreshToken - The refresh token to set.
+     * @return The instance of SyncModules for chaining.
      */
     setRefreshToken(refreshToken: string): this;
 }

package/dist/base/syncModules.js

@@ -1,31 +1,33 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+// Abstract class representing synchronization modules
 class SyncModules {
+    // Constructor to initialize state and URL
     constructor(state) {
         /**
-         * Sort attributes by its positions
+         * Sorts attributes by their positions.
          *
-         * @param data
-         * @returns
+         * @param data - The data containing attributes.
+         * @return Sorted attributes.
          */
         this._sortAttributes = (data) => Object.fromEntries(Object.entries(data).sort(([, a], [, b]) => a.position - b.position));
         this.state = state;
         this._url = state.url;
     }
     /**
-     * getFullPath
+     * Constructs the full URL path by appending the given path to the base URL.
      *
-     * @param path
-     * @returns
+     * @param path - The path to append to the base URL.
+     * @return The full URL as a string.
      */
     _getFullPath(path) {
         return this._url + path;
     }
     /**
-     * queryParamsToString
+     * Converts query parameters into a query string.
      *
-     * @param query
-     * @returns
+     * @param query - The query object containing key-value pairs.
+     * @return A string representation of the query parameters.
      */
     _queryParamsToString(query) {
         let result = '';
@@ -37,11 +39,11 @@ class SyncModules {
         return result.slice(0, result.length - 1);
     }
     /**
-     * normalizeData
+     * Normalizes data based on language code.
      *
-     * @param data
-     * @param langCode
-     * @returns normalized data
+     * @param data - The data to normalize.
+     * @param langCode - The language code for normalization.
+     * @return Normalized data.
      */
     _normalizeData(data, langCode = this.state.lang) {
         if (Array.isArray(data)) {
@@ -70,11 +72,11 @@ class SyncModules {
         }
     }
     /**
-     * normalizePostBody
+     * Normalizes the body of a POST request.
      *
-     * @param body
-     * @param langCode
-     * @returns
+     * @param body - The body to normalize.
+     * @param langCode - The language code for normalization.
+     * @return Normalized body.
      */
     _normalizePostBody(body, langCode = this.state.lang) {
         const formData = {};
@@ -85,10 +87,10 @@ class SyncModules {
         return body;
     }
     /**
-     * clearArray
+     * Clears arrays within the data structure.
      *
-     * @param data
-     * @returns
+     * @param data - The data to clear.
+     * @return Cleared data.
      */
     _clearArray(data) {
         if (Array.isArray(data)) {
@@ -124,11 +126,11 @@ class SyncModules {
         }
     }
     /**
-     * Function to add days to a date
+     * Adds a specified number of days to a date.
      *
-     * @param date
-     * @param days
-     * @returns
+     * @param date - The initial date.
+     * @param days - The number of days to add.
+     * @return The new date with added days.
      */
     _addDays(date, days) {
         const result = new Date(date);
@@ -136,17 +138,17 @@ class SyncModules {
         return result;
     }
     /**
-     * Function to generate intervals for a specific date
+     * Generates intervals for a specific date based on a schedule.
      *
-     * @param date
-     * @param schedule
-     * @param utcIntervals
+     * @param date - The date for which to generate intervals.
+     * @param schedule - The schedule defining the intervals.
+     * @param utcIntervals - A set to store unique intervals.
      */
     _generateIntervalsForDate(date, schedule, utcIntervals) {
-        // inEveryWeek
+        // Handle weekly schedules
         if (schedule.inEveryWeek && !schedule.inEveryMonth) {
             let currentDate = new Date(date);
-            // Вычисляем последний день текущего месяца
+            // Calculate the last day of the current month
             const endOfMonth = new Date(currentDate.getFullYear(), currentDate.getMonth() + 1, 0);
             while (currentDate <= endOfMonth) {
                 schedule.times.forEach((timeRange) => {
@@ -155,16 +157,16 @@ class SyncModules {
                     intervalStart.setUTCHours(startTime.hours, startTime.minutes, 0, 0);
                     const intervalEnd = new Date(currentDate);
                     intervalEnd.setUTCHours(endTime.hours, endTime.minutes, 0, 0);
-                    // Добавляем строку JSON в Set для уникальности
+                    // Add JSON string to Set for uniqueness
                     utcIntervals.add([
                         intervalStart.toISOString(),
                         intervalEnd.toISOString(),
                     ]);
                 });
-                currentDate = this._addDays(currentDate, 7); // Переходим к следующей неделе
+                currentDate = this._addDays(currentDate, 7); // Move to the next week
             }
         }
-        // inEveryMonth
+        // Handle monthly schedules
         if (schedule.inEveryMonth && !schedule.inEveryWeek) {
             const startDate = new Date(date); // Начальная дата
             const targetDayOfMonth = startDate.getUTCDate(); // Определяем день месяца начальной даты
@@ -172,11 +174,11 @@ class SyncModules {
             for (let i = 0; i < numberOfMonths; i++) {
                 const currentDate = new Date(startDate);
                 currentDate.setUTCMonth(currentDate.getUTCMonth() + i);
-                // Попробуем установить текущую дату на целевой день месяца
+                // Try setting the current date to the target day of the month
                 currentDate.setUTCDate(targetDayOfMonth);
-                // Проверяем, не вышли ли мы за пределы месяца
+                // Check if we have exceeded the month
                 if (currentDate.getUTCMonth() !== (startDate.getUTCMonth() + i) % 12) {
-                    continue; // Если вышли, пропускаем этот месяц
+                    continue; // Skip this month if exceeded
                 }
                 schedule.times.forEach((timeRange) => {
                     const [startTime, endTime] = timeRange;
@@ -191,19 +193,19 @@ class SyncModules {
                 });
             }
         }
-        // inEveryMonth && inEveryWeek
+        // Handle both weekly and monthly schedules
         if (schedule.inEveryMonth && schedule.inEveryWeek) {
-            const startDate = new Date(date); // Начальная дата
-            const targetDayOfWeek = startDate.getUTCDay(); // Определяем день недели начальной даты
-            const numberOfMonths = 12; // Количество месяцев, на которые нужно повторить
+            const startDate = new Date(date); // Initial date
+            const targetDayOfWeek = startDate.getUTCDay(); // Determine the day of the week
+            const numberOfMonths = 12; // Number of months to repeat
             for (let i = 0; i < numberOfMonths; i++) {
                 const currentDate = new Date(startDate);
                 currentDate.setUTCMonth(currentDate.getUTCMonth() + i);
-                currentDate.setUTCDate(1); // Устанавливаем на первый день месяца
-                // Находим первый целевой день недели в текущем месяце
+                currentDate.setUTCDate(1); // Set to the first day of the month
+                // Find the first target day of the week in the current month
                 const daysUntilTargetDay = (targetDayOfWeek - currentDate.getUTCDay() + 7) % 7;
                 currentDate.setUTCDate(currentDate.getUTCDate() + daysUntilTargetDay);
-                // Проходим по всем целевым дням недели в текущем месяце
+                // Iterate over all target days of the week in the current month
                 while (currentDate.getUTCMonth() ===
                     (startDate.getUTCMonth() + i) % 12) {
                     schedule.times.forEach((timeRange) => {
@@ -217,17 +219,17 @@ class SyncModules {
                             intervalEnd.toISOString(),
                         ]);
                     });
-                    // Переходим к следующей неделе (следующему такому же дню недели)
+                    // Move to the next week (same day of the week)
                     currentDate.setUTCDate(currentDate.getUTCDate() + 7);
                 }
             }
         }
     }
     /**
-     * Add TimeIntervals to schedules
+     * Adds time intervals to schedules.
      *
-     * @param schedules
-     * @returns schedules with timeIntervals
+     * @param schedules - The schedules to process.
+     * @return Schedules with added time intervals.
      */
     _addTimeIntervalsToSchedules(schedules) {
         schedules.forEach((scheduleGroup) => {
@@ -250,13 +252,13 @@ class SyncModules {
         return schedules;
     }
     /**
-     * normalizeAttr
+     * Normalizes attributes within the data.
      *
-     * @param data
-     * @returns normalized Attrs
+     * @param data - The data to normalize.
+     * @return Normalized attributes.
      */
     _normalizeAttr(data) {
-        // for regular attributes
+        // For regular attributes
         if ('attributeValues' in data) {
             for (const attr in data.attributeValues) {
                 const d = data.attributeValues[attr];
@@ -283,11 +285,11 @@ class SyncModules {
         if ('attributes' in data) {
             const d = data.attributes;
             for (const attr in d) {
-                // normalize numbers
+                // Normalize numbers
                 if (d[attr].type === 'integer' || d[attr].type === 'float') {
                     d[attr].value = Number(d[attr].value);
                 }
-                // add timeIntervals
+                // Add time intervals
                 if (d[attr].type === 'timeInterval') {
                     // const schedules = d[attr].localizeInfos.intervals;
                     // if (Array.isArray(schedules) && schedules.length > 0) {
@@ -301,11 +303,11 @@ class SyncModules {
         return data;
     }
     /**
-     * dataPostProcess
+     * Processes data after fetching or receiving it.
      *
-     * @param data
-     * @param langCode
-     * @returns
+     * @param data - The data to process.
+     * @param langCode - The language code for processing.
+     * @return Processed data.
      */
     _dataPostProcess(data, langCode = this.state.lang) {
         const normalize = this._normalizeData(data, langCode);
@@ -313,20 +315,20 @@ class SyncModules {
         return result;
     }
     /**
-     * setAccessToken
+     * Sets the access token in the state.
      *
-     * @param accessToken
-     * @returns
+     * @param accessToken - The access token to set.
+     * @return The instance of SyncModules for chaining.
      */
     setAccessToken(accessToken) {
         this.state.accessToken = accessToken;
         return this;
     }
     /**
-     * setRefreshToken
+     * Sets the refresh token in the state.
      *
-     * @param refreshToken
-     * @returns
+     * @param refreshToken - The refresh token to set.
+     * @return The instance of SyncModules for chaining.
      */
     setRefreshToken(refreshToken) {
         this.state.refreshToken = refreshToken;

package/dist/blocks/blocksApi.d.ts

@@ -3,8 +3,14 @@ import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
 import type { BlockType, IBlockEntity, IBlocks, IBlocksResponse, ISearchBlock } from './blocksInterfaces';
 /**
- * Controllers for working with blocks
+ * Controllers for working with blocks.
+ *
  * @handle /api/content/blocks
+ * @class BlocksApi
+ * @extends AsyncModules
+ * @implements {IBlocks}
+ *
+ * @description This class provides methods to interact with blocks.
  */
 export default class BlocksApi extends AsyncModules implements IBlocks {
     protected state: StateModule;
@@ -13,54 +19,79 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
     /**
      * Get blocks by parameters.
      *
-     * @param {BlockType} [type] - Available values : product | error_page | catalog_page | product_preview | similar_products_block | product_block | form | common_page | common_block | order | none
-     * @param {string} [langCode] - Language code. Default "en_US"
-     * @param {number} [offset] - Parameter for pagination. Default 0
-     * @param {number} [limit] - Parameter for pagination. Default 30
+     * @handleName getBlocks
      *
-     * @returns Return array of BlocksEntity object.
+     * @param {BlockType} type - Available values : product | error_page | catalog_page | product_preview | similar_products_block | product_block | form | common_page | common_block | order | none. Example: 'product'.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     *
+     * @return {IBlocksResponse} Returns BlocksEntity object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     getBlocks(type: BlockType, langCode?: string, offset?: number, limit?: number): Promise<IBlocksResponse | IError>;
     /**
      * Get block by marker.
      *
-     * @param {string} [marker] - Marker of Block.
-     * @param {string} [langCode] - Language code. Default "en_US"
-     * @param {number} [offset] - Parameter for pagination. Default 0
-     * @param {number} [limit] - Parameter for pagination. Default 30
+     * @handleName getBlockByMarker
+     *
+     * @param {string} marker - Marker of Block. Example: 'product_block'.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
      *
-     * @returns Return BlocksEntity object.
+     * @return {IBlockEntity} - Returns a BlockEntity object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This method retrieves a block by its marker and includes additional information such as similar products or products associated with the block.
      */
     getBlockByMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<IBlockEntity | IError>;
     /**
      * Get similar products by block marker.
      *
-     * @param {string} [marker] - Block identifier
-     * @param {string} [langCode] - Language code. Default "en_US"
-     * @param {number} [offset] - Parameter for pagination. Default 0
-     * @param {number} [limit] - Parameter for pagination. Default 30
+     * @handleName getSimilarProducts
+     *
+     * @param {string} marker - Block identifier. Example: 'similar_products_block'.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
      *
-     * @returns Return IProductsResponse with total and items array of BlocksEntity object.
+     * @return {IProductsResponse} - Returns the total count and an array of product items in object by specified block marker.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     private getSimilarProducts;
     /**
      * Get products by block marker.
      *
-     * @param {string} [marker] - Block identifier
-     * @param {string} [langCode] - Language code. Default "en_US"
-     * @param {number} [offset] - Parameter for pagination. Default 0
-     * @param {number} [limit] - Parameter for pagination. Default 30
+     * @handleName getProductsByBlockMarker
+     *
+     * @param {string} marker - Block identifier. Example: 'product_block'.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     *
+     * @return {IProductsEntity[]} Return array of BlocksEntity object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Return array of BlocksEntity object.
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     private getProductsByBlockMarker;
     /**
-     * Quick search for block objects with limited output
+     * Quick search for block objects with limited output.
+     *
+     * @handleName searchBlock
+     *
+     * @param {string} name - Search string. Example: 'product_block'.
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @param {string} [name] - Search string
-     * @param {string} [langCode] - Language code. Default "en_US"
+     * @return {ISearchBlock[]} Returns an array of ISearchBlock objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Return array of BlocksEntity object.
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     searchBlock(name: string, langCode?: string): Promise<Array<ISearchBlock> | IError>;
 }