oneentry 1.0.126 → 1.0.127

package/dist/base/syncModules.js

@@ -1,14 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 // Abstract class representing synchronization modules
+/**
+ *
+ */
 class SyncModules {
     // Constructor to initialize state and URL
     constructor(state) {
         /**
          * Sorts attributes by their positions.
-         *
-         * @param data - The data containing attributes.
-         * @return Sorted attributes.
+         * @param   {any} data - The data containing attributes.
+         * @returns {any}      Sorted attributes.
          */
         this._sortAttributes = (data) => Object.fromEntries(Object.entries(data).sort(([, a], [, b]) => a.position - b.position));
         this.state = state;
@@ -16,18 +18,16 @@ class SyncModules {
     }
     /**
      * Constructs the full URL path by appending the given path to the base URL.
-     *
-     * @param path - The path to append to the base URL.
-     * @return The full URL as a string.
+     * @param   {string} path - The path to append to the base URL.
+     * @returns {string}      The full URL as a string.
      */
     _getFullPath(path) {
         return this._url + path;
     }
     /**
      * Converts query parameters into a query string.
-     *
-     * @param query - The query object containing key-value pairs.
-     * @return A string representation of the query parameters.
+     * @param   {IProductsQuery | IUploadingQuery | any} query - The query object containing key-value pairs.
+     * @returns {string}                                       A string representation of the query parameters.
      */
     _queryParamsToString(query) {
         let result = '';
@@ -40,10 +40,9 @@ class SyncModules {
     }
     /**
      * Normalizes data based on language code.
-     *
-     * @param data - The data to normalize.
-     * @param langCode - The language code for normalization.
-     * @return Normalized data.
+     * @param   {any}    data     - The data to normalize.
+     * @param   {string} langCode - The language code for normalization.
+     * @returns {any}             Normalized data.
      */
     _normalizeData(data, langCode = this.state.lang) {
         if (Array.isArray(data)) {
@@ -73,10 +72,9 @@ class SyncModules {
     }
     /**
      * Normalizes the body of a POST request.
-     *
-     * @param body - The body to normalize.
-     * @param langCode - The language code for normalization.
-     * @return Normalized body.
+     * @param   {any}    body     - The body to normalize.
+     * @param   {string} langCode - The language code for normalization.
+     * @returns {any}             Normalized body.
      */
     _normalizePostBody(body, langCode = this.state.lang) {
         const formData = {};
@@ -88,9 +86,8 @@ class SyncModules {
     }
     /**
      * Clears arrays within the data structure.
-     *
-     * @param data - The data to clear.
-     * @return Cleared data.
+     * @param   {Record<string, any>} data - The data to clear.
+     * @returns {any}                      Cleared data.
      */
     _clearArray(data) {
         if (Array.isArray(data)) {
@@ -127,10 +124,9 @@ class SyncModules {
     }
     /**
      * Adds a specified number of days to a date.
-     *
-     * @param date - The initial date.
-     * @param days - The number of days to add.
-     * @return The new date with added days.
+     * @param   {Date}   date - The initial date.
+     * @param   {number} days - The number of days to add.
+     * @returns {any}         The new date with added days.
      */
     _addDays(date, days) {
         const result = new Date(date);
@@ -139,10 +135,12 @@ class SyncModules {
     }
     /**
      * Generates intervals for a specific date based on a schedule.
-     *
-     * @param date - The date for which to generate intervals.
-     * @param schedule - The schedule defining the intervals.
-     * @param utcIntervals - A set to store unique intervals.
+     * @param {Date}               date                  - The date for which to generate intervals.
+     * @param {object}             schedule              - The schedule defining the intervals.
+     * @param {boolean}            schedule.inEveryWeek  - The number of weeks between intervals.
+     * @param {any[]}              schedule.times        - The times for each interval.
+     * @param {boolean}            schedule.inEveryMonth - The month intervals for each interval.
+     * @param {Set<Array<string>>} utcIntervals          - A set to store unique intervals.
      */
     _generateIntervalsForDate(date, schedule, utcIntervals) {
         // Handle weekly schedules
@@ -227,9 +225,8 @@ class SyncModules {
     }
     /**
      * Adds time intervals to schedules.
-     *
-     * @param schedules - The schedules to process.
-     * @return Schedules with added time intervals.
+     * @param   {any[]} schedules - The schedules to process.
+     * @returns {any}             Schedules with added time intervals.
      */
     _addTimeIntervalsToSchedules(schedules) {
         schedules.forEach((scheduleGroup) => {
@@ -253,9 +250,8 @@ class SyncModules {
     }
     /**
      * Normalizes attributes within the data.
-     *
-     * @param data - The data to normalize.
-     * @return Normalized attributes.
+     * @param   {any} data - The data to normalize.
+     * @returns {any}      Normalized attributes.
      */
     _normalizeAttr(data) {
         // For regular attributes
@@ -305,10 +301,9 @@ class SyncModules {
     }
     /**
      * Processes data after fetching or receiving it.
-     *
-     * @param data - The data to process.
-     * @param langCode - The language code for processing.
-     * @return Processed data.
+     * @param   {any} data     - The data to process.
+     * @param   {any} langCode - The language code for processing.
+     * @returns {any}          Processed data.
      */
     _dataPostProcess(data, langCode = this.state.lang) {
         const normalize = this._normalizeData(data, langCode);
@@ -317,9 +312,8 @@ class SyncModules {
     }
     /**
      * Sets the access token in the state.
-     *
-     * @param accessToken - The access token to set.
-     * @return The instance of SyncModules for chaining.
+     * @param   {string} accessToken - The access token to set.
+     * @returns {any}                The instance of SyncModules for chaining.
      */
     setAccessToken(accessToken) {
         this.state.accessToken = accessToken;
@@ -327,9 +321,8 @@ class SyncModules {
     }
     /**
      * Sets the refresh token in the state.
-     *
-     * @param refreshToken - The refresh token to set.
-     * @return The instance of SyncModules for chaining.
+     * @param   {any} refreshToken - The refresh token to set.
+     * @returns {any}              The instance of SyncModules for chaining.
      */
     setRefreshToken(refreshToken) {
         this.state.refreshToken = refreshToken;
@@ -337,13 +330,21 @@ class SyncModules {
     }
     /**
      * Get deviceMetadata
+     * @returns {string} - Returns an object containing device metadata.
      */
     _getDeviceMetadata() {
-        const platform = navigator.platform;
-        const userAgent = navigator.userAgent;
-        const language = navigator.language;
+        // Check if we're in a browser environment
+        if (typeof globalThis === 'undefined') {
+            return '';
+        }
+        // Access navigator through globalThis.window object to avoid direct reference
+        const win = globalThis.window;
+        const nav = (win === null || win === void 0 ? void 0 : win.navigator) || {};
+        const platform = nav.platform || 'Win32';
+        const userAgent = nav.userAgent || 'Node.js/22';
+        const language = nav.language || 'en-US';
         const deviceMetadata = {
-            fingerprint: 'abc123-fp',
+            fingerprint: `UQ_${platform}_${userAgent}_${language}`,
             deviceInfo: {
                 os: platform,
                 browser: userAgent,

package/dist/base/utils.d.ts

@@ -1,13 +1,12 @@
 type Types = 'product' | 'error_page' | 'catalog_page' | 'product_preview' | 'similar_products_block' | 'product_block' | 'form' | 'common_page' | 'common_block' | 'order' | 'service' | 'none';
 /**
- * @param {string} [token] - If your project is protected by a token, specify this token in this parameter.
- * @param {string} [langCode] - specify the default language to avoid specifying it in every request.
- * @param {boolean} [traficLimit] - Some methods use multiple queries to make it easier to work with the API. Set this parameter to "false" to save traffic and decide for yourself what data you need.
- * @param {boolean} [auth] - An object with authorization settings
- * @param {boolean} [auth.customAuth] - Set this flag to true if you want to configure the authorization process yourself. Set the flag to false, or do not pass it at all to have automatic authorization and token renewal
+ * @param {string}  [token]             - If your project is protected by a token, specify this token in this parameter.
+ * @param {string}  [langCode]          - specify the default language to avoid specifying it in every request.
+ * @param {boolean} [traficLimit]       - Some methods use multiple queries to make it easier to work with the API. Set this parameter to "false" to save traffic and decide for yourself what data you need.
+ * @param {boolean} [auth]              - An object with authorization settings
+ * @param {boolean} [auth.customAuth]   - Set this flag to true if you want to configure the authorization process yourself. Set the flag to false, or do not pass it at all to have automatic authorization and token renewal
  * @param {boolean} [auth.refreshToken] - Transfer the refresh token here, for example from the local storage, to resume the user's session. Otherwise, the user will need to log in every time a new session is created
  * @param {boolean} [auth.saveFunction] - If you want to store the token between sessions, for example in local storage, create a custom function that takes refreshToken as a parameter and executes the necessary instructions. This function will be called every time the tokens are updated
- *
  * @example
  * const saveToken = (token) => {
  *     localStorage.setItem('refresh', token)
@@ -30,7 +29,6 @@ type Types = 'product' | 'error_page' | 'catalog_page' | 'product_preview' | 'si
  *         }
  *     }
  * }
- *
  */
 interface IConfig {
     token?: string;
@@ -52,6 +50,19 @@ interface IConfig {
         };
     };
 }
+/**
+ * @interface IAttributes
+ * @property {Array<object>}       listTitles       - List of titles.
+ * @property {ILocalizeInfo}       localizeInfos    - Localization information.
+ * @property {string}              marker           - Attribute marker.
+ * @property {number}              position         - Attribute position.
+ * @property {boolean}             isVisible        - Indicates whether the attribute is visible.
+ * @property {string}              type             - Attribute type.
+ * @property {Record<string, any>} settings         - Additional settings for the attribute.
+ * @property {Record<string, any>} validators       - Validators for the attribute.
+ * @property {Record<string, any>} additionalFields - Additional fields for the attribute.
+ * @description Interface for attributes.
+ */
 interface IAttributes {
     listTitles: Array<{
         title: string;
@@ -72,15 +83,35 @@ interface IAttributes {
     additionalFields?: any;
     [key: string]: any;
 }
+/**
+ * @interface ILocalizeInfos
+ * @property {Record<string, ILocalizeInfo>} Localization information.
+ * @description Interface for localization information.
+ */
 interface ILocalizeInfos {
     [key: string]: ILocalizeInfo;
 }
+/**
+ * Interface for localization information.
+ * @property {Record<string, any>} Localization information.
+ * @description Interface for localization information.
+ */
 interface ILocalizeInfo {
     [key: string]: any;
 }
+/**
+ * @interface IAttributeValues
+ * @property {Record<string, IAttributeValue>} Attribute values.
+ * @description Interface for attribute values.
+ */
 interface IAttributeValues {
     [key: string]: IAttributeValue;
 }
+/**
+ * @interface IAttributeValue
+ * @property {Record<string, any>} Attribute value.
+ * @description Interface for attribute value.
+ */
 interface IAttributeValue {
     [key: string]: any;
 }

package/dist/blocks/blocksApi.d.ts

@@ -4,82 +4,73 @@ import type { IError } from '../base/utils';
 import type { BlockType, IBlockEntity, IBlocks, IBlocksResponse, ISearchBlock } from './blocksInterfaces';
 /**
  * Controllers for working with blocks.
- *
  * @handle /api/content/blocks
  * @class BlocksApi
- * @extends AsyncModules
+ * @augments AsyncModules
  * @implements {IBlocks}
- *
  * @description This class provides methods to interact with blocks.
  */
 export default class BlocksApi extends AsyncModules implements IBlocks {
     protected state: StateModule;
     protected _url: string;
+    /**
+     *
+     */
     constructor(state: StateModule);
     /**
      * Get blocks by parameters.
-     *
      * @handleName getBlocks
-     *
-     * @param {BlockType} type - Available values: "product" | "error_page" | "catalog_page" | "product_preview" | "similar_products_block" | "product_block" | "form" | "common_page" | "common_block" | "order" | "service" | "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.
+     * @param   {BlockType}       type       - Available values: "product" | "error_page" | "catalog_page" | "product_preview" | "similar_products_block" | "product_block" | "form" | "common_page" | "common_block" | "order" | "service" | "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.
+     * @returns {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.
-     *
      * @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.
-     * @return {IBlockEntity} - Returns a BlockEntity object.
+     * @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 {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.
-     *
      * @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.
-     * @return {IProductsResponse} - Returns the total count and an array of product items in object by specified block marker.
+     * @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 {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.
-     *
      * @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.
+     * @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.
+     * @returns {IProductsEntity[]}            Return array of 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.
      */
     private getProductsByBlockMarker;
     /**
      * 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".
-     * @return {ISearchBlock[]} Returns an array of ISearchBlock objects.
+     * @param   {string}         name       - Search string. Example: "product_block".
+     * @param   {string}         [langCode] - Language code. Default: "en_US".
+     * @returns {ISearchBlock[]}            Returns an array of ISearchBlock objects.
      * @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.
      */

package/dist/blocks/blocksApi.js

@@ -6,29 +6,28 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with blocks.
- *
  * @handle /api/content/blocks
  * @class BlocksApi
- * @extends AsyncModules
+ * @augments AsyncModules
  * @implements {IBlocks}
- *
  * @description This class provides methods to interact with blocks.
  */
 class BlocksApi extends asyncModules_1.default {
+    /**
+     *
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/blocks';
     }
     /**
      * Get blocks by parameters.
-     *
      * @handleName getBlocks
-     *
-     * @param {BlockType} type - Available values: "product" | "error_page" | "catalog_page" | "product_preview" | "similar_products_block" | "product_block" | "form" | "common_page" | "common_block" | "order" | "service" | "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.
+     * @param   {BlockType}       type       - Available values: "product" | "error_page" | "catalog_page" | "product_preview" | "similar_products_block" | "product_block" | "form" | "common_page" | "common_block" | "order" | "service" | "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.
+     * @returns {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.
      */
@@ -79,14 +78,12 @@ class BlocksApi extends asyncModules_1.default {
     }
     /**
      * Get block by marker.
-     *
      * @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.
-     * @return {IBlockEntity} - Returns a BlockEntity object.
+     * @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 {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.
      */
@@ -131,14 +128,12 @@ class BlocksApi extends asyncModules_1.default {
     }
     /**
      * Get similar products by block marker.
-     *
      * @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.
-     * @return {IProductsResponse} - Returns the total count and an array of product items in object by specified block marker.
+     * @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 {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.
      */
@@ -153,14 +148,12 @@ class BlocksApi extends asyncModules_1.default {
     }
     /**
      * Get products by block marker.
-     *
      * @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.
+     * @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.
+     * @returns {IProductsEntity[]}            Return array of 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.
      */
@@ -175,12 +168,10 @@ class BlocksApi extends asyncModules_1.default {
     }
     /**
      * 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".
-     * @return {ISearchBlock[]} Returns an array of ISearchBlock objects.
+     * @param   {string}         name       - Search string. Example: "product_block".
+     * @param   {string}         [langCode] - Language code. Default: "en_US".
+     * @returns {ISearchBlock[]}            Returns an array of ISearchBlock objects.
      * @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.
      */