oneentry 1.0.139 → 1.0.141

package/dist/products/productsApi.d.ts

@@ -1,19 +1,19 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { IFilterParams, IProductApi, IProductBlock, IProductsCount, IProductsEntity, IProductsInfo, IProductsQuery, IProductsResponse } from './productsInterfaces';
+import type { IFilterParams, IProductBlock, IProductsApi, IProductsCount, IProductsEntity, IProductsInfo, IProductsQuery, IProductsResponse } from './productsInterfaces';
 /**
  * Controllers for working with product pages
  * @handle /api/content/products
  * @description Controllers for working with product pages
  */
-export default class ProductApi extends AsyncModules implements IProductApi {
+export default class ProductsApi extends AsyncModules implements IProductsApi {
     protected state: StateModule;
     protected _url: string;
     /**
      * Constructor
      * @param {StateModule} state - StateModule instance
-     * @description Constructor initializes the ProductApi with a given state.
+     * @description Constructor initializes the ProductsApi with a given state.
      */
     constructor(state: StateModule);
     /**
@@ -269,11 +269,12 @@ export default class ProductApi extends AsyncModules implements IProductApi {
      * @handleName getProductById
      * @param {number} id - Product id. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {boolean} [isNormalized] - If true, the product object will be normalized.
      * @returns {Promise<IProductsEntity | IError>} ProductEntity object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Retrieve one product object.
      */
-    getProductById(id: number, langCode?: string): Promise<IProductsEntity | IError>;
+    getProductById(id: number, langCode?: string, isNormalized?: boolean): Promise<IProductsEntity | IError>;
     /**
      * Getting a product block object by product id.
      * @handleName getProductBlockById

package/dist/products/productsApi.js

@@ -11,11 +11,11 @@ const productsSchemas_1 = require("./productsSchemas");
  * @handle /api/content/products
  * @description Controllers for working with product pages
  */
-class ProductApi extends asyncModules_1.default {
+class ProductsApi extends asyncModules_1.default {
     /**
      * Constructor
      * @param {StateModule} state - StateModule instance
-     * @description Constructor initializes the ProductApi with a given state.
+     * @description Constructor initializes the ProductsApi with a given state.
      */
     constructor(state) {
         super(state);
@@ -323,12 +323,16 @@ class ProductApi extends asyncModules_1.default {
      * @handleName getProductById
      * @param {number} id - Product id. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {boolean} [isNormalized] - If true, the product object will be normalized.
      * @returns {Promise<IProductsEntity | IError>} ProductEntity object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Retrieve one product object.
      */
-    async getProductById(id, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/${id}?langCode=${langCode}`);
+    async getProductById(id, langCode = this.state.lang, isNormalized) {
+        const query = { langCode };
+        if (isNormalized !== undefined)
+            query.isNormalized = isNormalized;
+        const result = await this._fetchGet(`/${id}?` + this._queryParamsToString(query));
         // Validate response if validation is enabled
         const validated = this._validateResponse(result, productsSchemas_1.ProductEntitySchema);
         return this._dataPostProcess(validated, langCode);
@@ -452,4 +456,4 @@ class ProductApi extends asyncModules_1.default {
         return result;
     }
 }
-exports.default = ProductApi;
+exports.default = ProductsApi;

package/dist/products/productsInterfaces.d.ts

@@ -1,7 +1,7 @@
 import type { AttributeType, IError, ILocalizeInfo, LangType, Types } from '../base/utils';
 import type { IFormConfig } from '../forms/formsInterfaces';
 /**
- * @interface IProductApi
+ * @interface IProductsApi
  * @property {Function} getProducts - Search for all product page objects with pagination and filtering.
  * @property {Function} getProductsEmptyPage - Search for all product page objects with pagination that do not have a category.
  * @property {Function} getProductsByPageId - Search for all products with pagination for the selected category.
@@ -17,7 +17,7 @@ import type { IFormConfig } from '../forms/formsInterfaces';
  * @property {Function} getProductsCountByPageUrl - Retrieves the number of products on a specific catalog page identified by its URL.
  * @description This interface defines methods for retrieving and managing products in the system.
  */
-interface IProductApi {
+interface IProductsApi {
     /**
      * Search for all products with pagination and filter.
      * @handleName getProducts
@@ -208,11 +208,12 @@ interface IProductApi {
      * @handleName getProductById
      * @param {number} id - Product id. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {boolean} [isNormalized] - If true, the product object will be normalized.
      * @returns {IProductsEntity} ProductEntity object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method retrieves one product object.
      */
-    getProductById(id: number, langCode?: string): Promise<IProductsEntity | IError>;
+    getProductById(id: number, langCode?: string, isNormalized?: boolean): Promise<IProductsEntity | IError>;
     /**
      * Getting a product block object by product id.
      * @handleName getProductBlockById
@@ -364,6 +365,7 @@ interface IProductsQuery {
  * @property {string | null} [conditionMarker] - Id of the filter condition by which the values are filtered. Default: null. Example: "equals".
  * @property {number | null} conditionValue - The value that is being searched for, default null. Example: "new".
  * @property {string | null} [pageUrl] - Url of the category page object. Example: ["23-laminat-floorwood-maxima"].
+ * @property {string[] | null} [pageUrls] - Url of the category page object. Example: ["23-laminat-floorwood-maxima"].
  * @property {string | null} [statusMarker] - Text identifier of the product page status (default not set). Example: "in_stock".
  * @property {string | null} [title] - Product name. Example: "Laminatboden Maxima".
  * @property {boolean} [isNested] - Flag for nested attributes, default false. Example: true.
@@ -374,6 +376,7 @@ interface IFilterParams {
     conditionMarker?: 'in' /** 'in' - Contains */ | 'nin' /** 'nin' - Does not contain */ | 'eq' /** 'eq' - Equal */ | 'neq' /** 'neq' - Not equal */ | 'mth' /** 'mth' - Greater than */ | 'lth' /** 'lth' - Less than */ | 'exs' /** 'exs' - Exists */ | 'nexs' /** 'nexs' - Does not exist */ | null;
     conditionValue: number | string | null;
     pageUrl?: string | null;
+    pageUrls?: string[] | null;
     statusMarker?: string;
     title?: string;
     isNested?: boolean;
@@ -394,7 +397,7 @@ interface IFilterParams {
       "de": "Auf Lager"
     }
  * @property {string | null} sku - Product SKU (Stock Keeping Unit), may be null. Example: "SKU_12345".
- * @property {number | boolean} isSync - Indication of page indexing. Example: true.
+ * @property {boolean} isSync - Indication of page indexing. Example: true.
  * @property {AttributeType} attributeValues - Array of attribute values from the index, represented.
  * @example
     [
@@ -446,7 +449,7 @@ interface IProductsEntity {
         };
     };
     sku: string | null;
-    isSync: number | boolean;
+    isSync: boolean;
     attributeValues: AttributeType;
     categories: string[];
     isVisible: boolean;
@@ -526,7 +529,7 @@ interface IProductInfo {
 /**
  * @interface IProductBlock
  * @property {number} id - Unique identifier of the product block. Example: 3289.
- * @property {number | null} attributeSetIdentifier - Identifier of the attribute set used in the product block, or null if not applicable. Example: 67890.
+ * @property {string | null} attributeSetIdentifier - Identifier of the attribute set used in the product block, or null if not applicable. Example: "product_block".
  * @property {ILocalizeInfo} localizeInfos - Localization information for the product block.
  * @example
     {
@@ -552,7 +555,7 @@ interface IProductInfo {
  */
 interface IProductBlock {
     id: number;
-    attributeSetIdentifier: number | null;
+    attributeSetIdentifier: string | null;
     localizeInfos: ILocalizeInfo;
     version: number;
     position: number;
@@ -580,4 +583,4 @@ interface IProductBlock {
     isSync: boolean;
     attributeValues: AttributeType;
 }
-export type { IFilterParams, IProductApi, IProductBlock, IProductInfo, IProductsCount, IProductsEntity, IProductsInfo, IProductsQuery, IProductsResponse, };
+export type { IFilterParams, IProductBlock, IProductInfo, IProductsApi, IProductsCount, IProductsEntity, IProductsInfo, IProductsQuery, IProductsResponse, };

package/dist/products/productsSchemas.d.ts

@@ -134,46 +134,26 @@ export declare const SingleProductSchema: z.ZodObject<{
  * Products count schema
  */
 export declare const ProductsCountSchema: z.ZodObject<{
-    total: z.ZodNumber;
+    totalAll: z.ZodNumber;
+    totalInCategory: z.ZodNumber;
+    totalInCategoryWithNested: z.ZodNumber;
 }, z.core.$strip>;
 /**
  * Product block schema
  */
 export declare const ProductBlockSchema: z.ZodObject<{
     id: z.ZodNumber;
-    marker: z.ZodString;
-    products: z.ZodArray<z.ZodObject<{
-        id: z.ZodNumber;
-        identifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        attributeSetIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        localizeInfos: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-        statusLocalizeInfos: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-        isVisible: z.ZodOptional<z.ZodBoolean>;
-        statusIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        position: z.ZodOptional<z.ZodNumber>;
-        isPositionLocked: z.ZodOptional<z.ZodBoolean>;
-        templateIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        shortDescTemplateIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        price: z.ZodNullable<z.ZodNumber>;
-        additional: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-        sku: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        isSync: z.ZodOptional<z.ZodBoolean>;
-        categories: z.ZodOptional<z.ZodArray<z.ZodString>>;
-        attributeValues: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-        productPages: z.ZodOptional<z.ZodArray<z.ZodAny>>;
-        blocks: z.ZodOptional<z.ZodArray<z.ZodString>>;
-        moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
-        currency: z.ZodOptional<z.ZodString>;
-        images: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            id: z.ZodNumber;
-            filename: z.ZodString;
-            url: z.ZodString;
-            size: z.ZodOptional<z.ZodNumber>;
-            type: z.ZodOptional<z.ZodString>;
-        }, z.core.$strip>>>;
-        relatedProducts: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
-        pageId: z.ZodOptional<z.ZodNumber>;
-    }, z.core.$strip>>;
+    attributeSetIdentifier: z.ZodNullable<z.ZodString>;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    version: z.ZodNumber;
+    position: z.ZodNumber;
+    identifier: z.ZodString;
+    type: z.ZodString;
+    customSettings: z.ZodRecord<z.ZodString, z.ZodAny>;
+    templateIdentifier: z.ZodNullable<z.ZodString>;
+    isVisible: z.ZodBoolean;
+    isSync: z.ZodBoolean;
+    attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
 }, z.core.$strip>;
 /**
  * Related products schema

package/dist/products/productsSchemas.js

@@ -69,15 +69,26 @@ exports.SingleProductSchema = exports.ProductEntitySchema;
  * Products count schema
  */
 exports.ProductsCountSchema = zod_1.z.object({
-    total: zod_1.z.number(),
+    totalAll: zod_1.z.number(),
+    totalInCategory: zod_1.z.number(),
+    totalInCategoryWithNested: zod_1.z.number(),
 });
 /**
  * Product block schema
  */
 exports.ProductBlockSchema = zod_1.z.object({
     id: zod_1.z.number(),
-    marker: zod_1.z.string(),
-    products: zod_1.z.array(exports.ProductEntitySchema),
+    attributeSetIdentifier: zod_1.z.string().nullable(),
+    localizeInfos: zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
+    version: zod_1.z.number(),
+    position: zod_1.z.number(),
+    identifier: zod_1.z.string(),
+    type: zod_1.z.string(),
+    customSettings: zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
+    templateIdentifier: zod_1.z.string().nullable(),
+    isVisible: zod_1.z.boolean(),
+    isSync: zod_1.z.boolean(),
+    attributeValues: zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
 });
 /**
  * Related products schema

package/dist/sitemap/sitemapApi.d.ts

@@ -0,0 +1,35 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { ISitemapApi, ISitemapEntity, ISitemapQuery } from './sitemapInterfaces';
+/**
+ * Controllers for working with sitemaps.
+ * @handle /api/content/sitemap
+ * @class SitemapApi
+ * @augments AsyncModules
+ * @implements {ISitemapApi}
+ */
+export default class SitemapApi extends AsyncModules implements ISitemapApi {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor for SitemapApi class.
+     * @param {StateModule} state - The state module.
+     */
+    constructor(state: StateModule);
+    /**
+     * Retrieves the set of sitemaps.
+     * @handleName getSitemap
+     * @returns {Promise<string[] | IError>} Returns an array of sitemap URLs.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    getSitemap(): Promise<ISitemapEntity[] | IError>;
+    /**
+     * Generates a new set of sitemaps.
+     * @handleName updateSitemap
+     * @param {ISitemapQuery} body - Sitemap body params.
+     * @returns {Promise<string[] | IError>} Returns an array of sitemap URLs.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    updateSitemap(body: ISitemapQuery): Promise<ISitemapEntity[] | IError>;
+}

package/dist/sitemap/sitemapApi.js

@@ -0,0 +1,45 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const asyncModules_1 = __importDefault(require("../base/asyncModules"));
+/**
+ * Controllers for working with sitemaps.
+ * @handle /api/content/sitemap
+ * @class SitemapApi
+ * @augments AsyncModules
+ * @implements {ISitemapApi}
+ */
+class SitemapApi extends asyncModules_1.default {
+    /**
+     * Constructor for SitemapApi class.
+     * @param {StateModule} state - The state module.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/sitemap';
+    }
+    /**
+     * Retrieves the set of sitemaps.
+     * @handleName getSitemap
+     * @returns {Promise<string[] | IError>} Returns an array of sitemap URLs.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    async getSitemap() {
+        const data = await this._fetchGet(`/`);
+        return this._normalizeData(data);
+    }
+    /**
+     * Generates a new set of sitemaps.
+     * @handleName updateSitemap
+     * @param {ISitemapQuery} body - Sitemap body params.
+     * @returns {Promise<string[] | IError>} Returns an array of sitemap URLs.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    async updateSitemap(body) {
+        const data = await this._fetchPost(`/`, body);
+        return this._normalizeData(data);
+    }
+}
+exports.default = SitemapApi;

package/dist/sitemap/sitemapInterfaces.d.ts

@@ -0,0 +1,40 @@
+import type { IError } from '../base/utils';
+/**
+ * Query parameters for sitemap requests.
+ * @interface ISitemapQuery
+ */
+interface ISitemapQuery {
+    [key: string]: unknown;
+}
+/**
+ * Entity interface for sitemap.
+ * @property {string} url - URL of the sitemap.
+ * @property {string} lastmod - Last modification date of the sitemap.
+ * @property {string} changefreq - Frequency of changes for the sitemap.
+ * @property {string} priority - Priority of the sitemap.
+ * @interface ISitemapEntity
+ */
+interface ISitemapEntity {
+    url: string;
+    lastmod: string;
+    changefreq: string;
+    priority: string;
+}
+/**
+ * Interface for the Sitemap API module.
+ * @interface ISitemapApi
+ */
+interface ISitemapApi {
+    /**
+     * Retrieves the set of sitemaps.
+     * @returns {Promise<ISitemapEntity[] | IError>}
+     */
+    getSitemap(): Promise<ISitemapEntity[] | IError>;
+    /**
+     * Generates a new set of sitemaps.
+     * @param {ISitemapQuery} body - Sitemap body params.
+     * @returns {Promise<ISitemapEntity[] | IError>}
+     */
+    updateSitemap(body: ISitemapQuery): Promise<ISitemapEntity[] | IError>;
+}
+export type { ISitemapApi, ISitemapEntity, ISitemapQuery };

package/dist/sitemap/sitemapInterfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/system/systemApi.d.ts

@@ -1,13 +1,13 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { ISystem } from './systemInterfaces';
+import type { ISystemApi } from './systemInterfaces';
 /**
  * Controllers for working with system - system
  * @handle /api/content/system
  * @description Controllers for working with system - system
  */
-export default class SystemApi extends AsyncModules implements ISystem {
+export default class SystemApi extends AsyncModules implements ISystemApi {
     protected state: StateModule;
     protected _url: string;
     /**
@@ -32,28 +32,6 @@ export default class SystemApi extends AsyncModules implements ISystem {
      * @description This method is used to test the 500 error handling by sending a GET request to a specific endpoint.
      */
     test500(): Promise<any | IError>;
-    /**
-     * Validates a CAPTCHA token by sending it to the server for verification.
-     * @handleName validateCaptcha
-     * @param {object} event - The event object containing CAPTCHA data.
-     * @example
-        {
-          "token": "03AGdBq24...",
-          "expectedAction": "login",
-          "siteKey": "6Lc_aCMTAAAAAB..."
-        }
-     * @param {string} event.token - The CAPTCHA token to be validated. Example: "03AGdBq24...".
-     * @param {string} event.expectedAction - The expected action associated with the CAPTCHA. Example: "login".
-     * @param {string} event.siteKey - The site key used for the CAPTCHA. Example: "6Lc_aCMTAAAAAB...".
-     * @returns {Promise<any | IError>} The response from the server after validating the CAPTCHA, or an error object if validation fails.
-     * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description This method sends the CAPTCHA token and related information to the server endpoint '/captcha/validate' to verify its validity.
-     */
-    validateCaptcha(event: {
-        token: string;
-        expectedAction: string;
-        siteKey: string;
-    }): Promise<any | IError>;
     /**
      * Getting the number of requests to API.
      * @handleName getApiStat
@@ -61,5 +39,5 @@ export default class SystemApi extends AsyncModules implements ISystem {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Getting the number of requests to API.
      */
-    getApiStat(): Promise<any | IError>;
+    getApiStat(): Promise<any>;
 }

package/dist/system/systemApi.js

@@ -43,30 +43,6 @@ class SystemApi extends asyncModules_1.default {
         const result = await this._fetchGet('/test500');
         return result;
     }
-    /**
-     * Validates a CAPTCHA token by sending it to the server for verification.
-     * @handleName validateCaptcha
-     * @param {object} event - The event object containing CAPTCHA data.
-     * @example
-        {
-          "token": "03AGdBq24...",
-          "expectedAction": "login",
-          "siteKey": "6Lc_aCMTAAAAAB..."
-        }
-     * @param {string} event.token - The CAPTCHA token to be validated. Example: "03AGdBq24...".
-     * @param {string} event.expectedAction - The expected action associated with the CAPTCHA. Example: "login".
-     * @param {string} event.siteKey - The site key used for the CAPTCHA. Example: "6Lc_aCMTAAAAAB...".
-     * @returns {Promise<any | IError>} The response from the server after validating the CAPTCHA, or an error object if validation fails.
-     * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description This method sends the CAPTCHA token and related information to the server endpoint '/captcha/validate' to verify its validity.
-     */
-    async validateCaptcha(event) {
-        const data = {
-            event,
-        };
-        const result = await this._fetchPost('/captcha/validate', data);
-        return result;
-    }
     /**
      * Getting the number of requests to API.
      * @handleName getApiStat

package/dist/system/systemInterfaces.d.ts

@@ -1,23 +1,31 @@
+import type { IError } from 'base/utils';
 /**
- * @interface ISystem
+ * @interface ISystemApi
  * @property {Function} test404 - Test 404 error.
  * @property {Function} test500 - Test 500 error.
  * @description Represents a interface object of System Api.
  */
-interface ISystem {
+interface ISystemApi {
     /**
      * Test 404 error.
      * @handleName test404
      * @returns {any} Returns a Promise that resolves with any data.
      * @description This method tests 404 error.
      */
-    test404(): Promise<any>;
+    test404(): Promise<any | IError>;
     /**
      * Test 500 error.
      * @handleName test500
      * @returns {any} Returns a Promise that resolves with any data.
      * @description This method tests 500 error.
      */
-    test500(): Promise<any>;
+    test500(): Promise<any | IError>;
+    /**
+     * getApiStat
+     * @handleName getApiStat
+     * @returns {any} Returns a Promise that resolves with any data.
+     * @description This method getApiStat.
+     */
+    getApiStat(): Promise<any>;
 }
-export type { ISystem };
+export type { ISystemApi };

package/dist/system/systemInterfaces.js

@@ -1,2 +1,5 @@
 "use strict";
+/* eslint-disable jsdoc/reject-function-type */
+/* eslint-disable jsdoc/reject-any-type */
+/* eslint-disable @typescript-eslint/no-explicit-any */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/templates-preview/templatesPreviewApi.d.ts

@@ -1,13 +1,13 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { ITemplatesPreview, ITemplatesPreviewEntity } from './templatesPreviewInterfaces';
+import type { ITemplatesPreviewApi, ITemplatesPreviewEntity } from './templatesPreviewInterfaces';
 /**
  * Controllers for working with template objects for preview.
  * @handle /api/content/template-previews
  * @description This module provides a set of controllers for managing and retrieving template objects designed for preview purposes.
  */
-export default class TemplatePreviewsApi extends AsyncModules implements ITemplatesPreview {
+export default class TemplatePreviewsApi extends AsyncModules implements ITemplatesPreviewApi {
     protected state: StateModule;
     protected _url: string;
     /**

package/dist/templates-preview/templatesPreviewInterfaces.d.ts

@@ -1,11 +1,11 @@
 import type { AttributeType, IError } from '../base/utils';
 /**
- * @interface ITemplatesPreview
+ * @interface ITemplatesPreviewApi
  * @property {Function} getTemplatePreviews - Get all template preview objects.
  * @property {Function} getTemplatePreviewByMarker - Get one template preview object by marker.
  * @description This interface defines methods for retrieving template previews in the system, including fetching all previews, specific previews by marker.
  */
-interface ITemplatesPreview {
+interface ITemplatesPreviewApi {
     /**
      * Retrieves all template preview objects.
      * @param {string} langCode - Language code for localization. Default: "en_US".
@@ -118,4 +118,4 @@ interface ISquare {
     side: number | string;
     alignmentType: string;
 }
-export type { IProportion, ISquare, ITemplatesPreview, ITemplatesPreviewEntity, };
+export type { IProportion, ISquare, ITemplatesPreviewApi, ITemplatesPreviewEntity, };

package/dist/users/usersApi.d.ts

@@ -1,13 +1,13 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { IUserBody, IUserEntity, IUsers } from './usersInterfaces';
+import type { IUserBody, IUserEntity, IUsersApi } from './usersInterfaces';
 /**
  * Controllers for working with users
  * @handle /api/content/users
  * @description This module provides various methods to manage users, including creating, retrieving, updating, and deleting user data. It requires proper authorization to access these endpoints.
  */
-export default class UsersApi extends AsyncModules implements IUsers {
+export default class UsersApi extends AsyncModules implements IUsersApi {
     protected state: StateModule;
     protected _url: string;
     /**

package/dist/users/usersApi.js

@@ -116,7 +116,6 @@ class UsersApi extends asyncModules_1.default {
         const result = await this._fetchPut('/me', Object.prototype.hasOwnProperty.call(body, 'formData')
             ? this._normalizePostBody(body, langCode)
             : body);
-        // Validate response if validation is enabled
         const validated = this._validateResponse(result, usersSchemas_1.UpdateUserResponseSchema);
         return validated;
     }

package/dist/users/usersInterfaces.d.ts

@@ -4,7 +4,7 @@ import type { IFormConfig } from '../forms/formsInterfaces';
 import type { FormDataType } from '../forms-data/formsDataInterfaces';
 /**
  * Interface representing user-related operations.
- * @interface IUsers
+ * @interface IUsersApi
  * @property {Function} getUser - Retrieves the data of an authorized user, optionally based on a language code.
  * @property {Function} updateUser - Updates the user's data with the provided information.
  * @property {Function} archiveUser - Archiving one user object (marked for deletion).
@@ -13,7 +13,7 @@ import type { FormDataType } from '../forms-data/formsDataInterfaces';
  * @property {Function} deleteFCMToken - Deletes an existing FCM token.
  * @description This interface defines methods for managing user data and handling Firebase Cloud Messaging tokens.
  */
-interface IUsers {
+interface IUsersApi {
     /**
      * Retrieves the data of an authorized user.
      * @handleName getUser
@@ -232,4 +232,4 @@ interface IUserBody {
     };
     state?: Record<string, any>;
 }
-export type { IUserBody, IUserEntity, IUsers };
+export type { IUserBody, IUserEntity, IUsersApi };

package/dist/users/usersSchemas.d.ts

@@ -26,7 +26,7 @@ export declare const UserResponseSchema: z.ZodObject<{
     updatedAt: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 /**
- * Update user response schema (returns boolean)
+ * Update user response schema (returns true on success)
  */
 export declare const UpdateUserResponseSchema: z.ZodBoolean;
 /**

package/dist/users/usersSchemas.js

@@ -16,7 +16,7 @@ exports.UserResponseSchema = validation_1.UserEntitySchema.extend({
     updatedAt: zod_1.z.string().optional(),
 });
 /**
- * Update user response schema (returns boolean)
+ * Update user response schema (returns true on success)
  */
 exports.UpdateUserResponseSchema = zod_1.z.boolean();
 /**