oneentry 1.0.88 → 1.0.90

package/README.md

@@ -5043,7 +5043,7 @@ const value = await System.test500()
 const { Templates } = defineOneEntry('your-url');
 ```
 
-### Templates.getAllTemplates()
+### Templates.getAllTemplates(langCode)
 
 ```js
 const value = await Templates.getAllTemplates()
@@ -5054,17 +5054,37 @@ const value = await Templates.getAllTemplates()
 Example return:
 
 ```json
-[
-  {
-    "id": 1764,
-    "version": 10,
-    "identifier": "marker",
-    "generalTypeId": 4,
-    "title": "Page template",
-    "position": 0,
-    "generalTypeName": "forProductPreview"
-  }
-]
+{
+  "forTextBlock": [
+    {
+      "id": 1,
+      "version": 0,
+      "identifier": "for-block",
+      "title": "For blocks",
+      "generalTypeName": "forTextBlock",
+      "generalTypeId": 18,
+      "position": 1,
+      "attributeValues": {
+        "en_US": {
+          "marker": {
+            "value": "",
+            "type": "string",
+            "position": 1,
+            "isProductPreview": false,
+            "isIcon": false,
+            "attributeFields": {
+              "marker": {
+                "type": "string",
+                "value": "test"
+              }
+            }
+          }
+        }
+      },
+      "attributeIdentifier": "my-set"
+    }
+  ]
+}
 ```
 <details>
 <summary>Schema</summary>
@@ -5100,7 +5120,7 @@ general type name <br>
 
 </details>
 
-### Templates.getTemplateByType(type)
+### Templates.getTemplateByType(type, langCode)
 
 ```js
 const value = await Templates.getTemplateByType('forCatalogProducts')
@@ -5114,12 +5134,28 @@ Example return:
 [
   {
     "id": 1764,
-    "version": 10,
-    "identifier": "marker",
     "generalTypeId": 4,
+    "generalTypeName": "forCatalogProducts",
     "title": "Page template",
-    "position": 0,
-    "generalTypeName": "forProductPreview"
+    "identifier": "marker",
+    "position": 1,
+    "version": 10,
+    "attributeValues": {
+      "marker": {
+        "value": "",
+        "type": "string",
+        "position": 1,
+        "isProductPreview": false,
+        "isIcon": false,
+        "attributeFields": {
+          "marker": {
+            "type": "string",
+            "value": "test"
+          }
+        }
+      }
+    },
+    "attributeSetIdentifier": "my-set"
   }
 ]
 ```
@@ -5158,7 +5194,7 @@ general type name <br>
 </details>
 
 
-### Templates.getTemplateById(id)
+### Templates.getTemplateById(id, langCode)
 
 ```js
 const value = await Templates.getTemplateById(1)
@@ -5169,16 +5205,102 @@ const value = await Templates.getTemplateById(1)
 Example return:
 
 ```json
-[
-  {
-    "id": 1764,
-    "version": 10,
-    "identifier": "marker",
-    "generalTypeId": 4,
-    "title": "Page template",
-    "generalTypeName": "forProductPreview"
-  }
-]
+{
+  "id": 1764,
+  "generalTypeId": 4,
+  "generalTypeName": "forProductPreview",
+  "title": "Page template",
+  "identifier": "marker",
+  "position": 1,
+  "version": 10,
+  "attributeValues": {
+    "marker": {
+      "value": "",
+      "type": "string",
+      "position": 1,
+      "isProductPreview": false,
+      "isIcon": false,
+      "attributeFields": {
+        "marker": {
+          "type": "string",
+          "value": "test"
+        }
+      }
+    }
+  },
+  "attributeSetIdentifier": "my-set"
+}
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764 <br>
+
+**version**	number <br>
+*object's version number of modification* <br>
+example: 10 <br>
+
+**identifier:**	string <br>
+*textual identifier for a field in the record* <br>
+example: catalog <br>
+
+**generalTypeId:**	number <br>
+*type identifier* <br>
+example: 4 <br>
+
+**title:**	string<br>
+*template name* <br>
+example: page template <br>
+
+**position** object <br>
+*position number* <br>
+example: 0 <br>
+
+
+**generalTypeName**	string <br>
+*example: forProductPreview* <br>
+general type name <br>
+
+</details>
+
+### Templates.getTemplateByMarker(marker, langCode)
+
+```js
+const value = await Templates.getTemplateByMarker('my-marker')
+```
+
+> This method retrieves a single template object based on its identifier (marker) from the API. It returns a Promise that resolves to a template object.
+
+Example return:
+
+```json
+{
+  "id": 1764,
+  "generalTypeId": 4,
+  "generalTypeName": "forProductPreview",
+  "title": "Page template",
+  "identifier": "marker",
+  "position": 1,
+  "version": 10,
+  "attributeValues": {
+      "marker": {
+        "value": "",
+        "type": "string",
+        "position": 1,
+        "isProductPreview": false,
+        "isIcon": false,
+        "attributeFields": {
+          "marker": {
+            "type": "string",
+            "value": "test"
+          }
+        }
+      }
+  },
+  "attributeSetIdentifier": "my-set"
+}
 ```
 <details>
 <summary>Schema</summary>
@@ -5214,6 +5336,7 @@ general type name <br>
 
 </details>
 
+
 ---
 
 
@@ -5224,7 +5347,7 @@ general type name <br>
 const { TemplatePreviews } = defineOneEntry('your-url');
 ```
 
-### TemplatePreviews.getTemplatePreviews()
+### TemplatePreviews.getTemplatePreviews(langCode)
 
 ```js
 const value = await TemplatePreviews.getTemplatePreviews()
@@ -5240,6 +5363,24 @@ Example return:
     "id": 1,
     "version": 0,
     "identifier": "preview-templates",
+    "attributeValues": {
+      "en_US": {
+        "marker": {
+          "value": "",
+          "type": "string",
+          "position": 1,
+          "isProductPreview": false,
+          "isIcon": false,
+          "attributeFields": {
+            "marker": {
+              "type": "string",
+              "value": "test"
+            }
+          }
+        }
+      }
+    },
+    "attributeSetIdentifier": "my-set",
     "proportion": {
       "vertical": {
         "width": "2",
@@ -5299,7 +5440,7 @@ example: 12 <br>
 </details>
 
 
-### TemplatePreviews.getTemplatesPreviewById(id)
+### TemplatePreviews.getTemplatesPreviewById(id, langCode)
 
 ```js
 const value = await TemplatePreviews.getTemplatePreviewById(1764)
@@ -5314,6 +5455,24 @@ Example return:
   "id": 1,
   "version": 0,
   "identifier": "preview-templates",
+  "attributeValues": {
+    "en_US": {
+      "marker": {
+        "value": "",
+        "type": "string",
+        "position": 1,
+        "isProductPreview": false,
+        "isIcon": false,
+        "attributeFields": {
+          "marker": {
+            "type": "string",
+            "value": "test"
+          }
+        }
+      }
+    }
+  },
+  "attributeSetIdentifier": "my-set",
   "proportion": {
     "vertical": {
       "width": "2",
@@ -5371,7 +5530,7 @@ example: 12 <br>
 
 </details>
 
-### TemplatePreviews.getTemplatesPreviewByMarker(marker)
+### TemplatePreviews.getTemplatesPreviewByMarker(marker, langCode)
 
 ```js
 const value = await TemplatePreviews.getTemplatePreviewByMarker('my-marker')
@@ -5386,6 +5545,24 @@ Example return:
   "id": 1,
   "version": 0,
   "identifier": "preview-templates",
+  "attributeValues": {
+    "en_US": {
+      "marker": {
+        "value": "",
+        "type": "string",
+        "position": 1,
+        "isProductPreview": false,
+        "isIcon": false,
+        "attributeFields": {
+          "marker": {
+            "type": "string",
+            "value": "test"
+          }
+        }
+      }
+    }
+  },
+  "attributeSetIdentifier": "my-set",
   "proportion": {
     "vertical": {
       "width": "2",

package/dist/admins/adminsInterfaces.d.ts

@@ -1,3 +1,4 @@
+import { AttributeType } from "../base/utils";
 /**
  * Represents a interface object of Admins Api.
  *
@@ -38,7 +39,7 @@ interface IPosition {
  */
 interface IAdminEntity {
     attributeSetId: number | null;
-    attributeValues: Record<string, any>;
+    attributeValues: AttributeType;
     id: number;
     identifier: string;
     isSync: boolean;

package/dist/base/asyncModules.js

@@ -163,11 +163,11 @@ class AsyncModules extends syncModules_1.default {
                         return await secondResponse.json();
                     }
                 }
-                throw response;
+                return response;
             }
         }
         catch (e) {
-            console.error(e);
+            return e;
         }
     }
 }

package/dist/base/utils.d.ts

@@ -66,23 +66,6 @@ interface IAttributeValue {
     [key: string]: any;
 }
 type AttributeType = IAttributeValues | IAttributeValue;
-interface IAttributeSetEntity {
-    id: number;
-    updatedDate: string;
-    version: number;
-    identifier: string;
-    typeId: number;
-    localizeInfos: LocalizeType;
-    schema: Record<string, any>;
-    position: {
-        id: number;
-        objectId: number;
-        objectType: string;
-        position: number | string;
-    };
-    positionId: number | string;
-    isVisible: boolean;
-}
 type LangType = string | Array<string>;
 type LocalizeType = ILocalizeInfos | ILocalizeInfo;
 interface IError {
@@ -92,4 +75,4 @@ interface IError {
     timestamp: string;
     [key: string]: any;
 }
-export { LocalizeType, ILocalizeInfos, ILocalizeInfo, Types, IAttributeSetEntity, LangType, AttributeType, IAttributeValues, IAttributes, IConfig, IError };
+export { LocalizeType, ILocalizeInfos, ILocalizeInfo, Types, LangType, AttributeType, IAttributeValues, IAttributes, IConfig, IError };

package/dist/blocks/blocksInterfaces.d.ts

@@ -1,3 +1,4 @@
+import { AttributeType } from "../base/utils";
 import { IProductsEntity } from "../products/productsInterfaces";
 /**
  * Represents a interface object of Blocks Api.
@@ -18,7 +19,7 @@ interface IBlocksResponse {
     items: Array<IBlockEntity>;
 }
 interface IBlockEntity {
-    attributeValues: Record<string, any>;
+    attributeValues: AttributeType;
     id: number;
     identifier: string;
     isVisible: boolean;

package/dist/menus/menusApi.js

@@ -18,23 +18,7 @@ class MenusApi extends asyncModules_1.default {
      * @returns Returns a single menu object as a ContentMenu object with included pages
      */
     async getMenusByMarker(marker, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/marker/${marker}`);
-        let pages = result.pages;
-        pages = pages.map(page => {
-            page = this._normalizeData(page, langCode);
-            for (const key in page.localizeInfos) {
-                if (key !== 'menuTitle') {
-                    delete page.localizeInfos[key];
-                }
-            }
-            const children = pages.filter(child => child.parentId === page.id);
-            if (children.length) {
-                const normalizeChildren = children.map(child => this._normalizeData(child, langCode));
-                page.children = normalizeChildren;
-            }
-            return page;
-        });
-        result.pages = pages;
+        const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
         return this._dataPostProcess(result, langCode);
     }
 }

package/dist/pages/pagesInterfaces.d.ts

@@ -1,4 +1,4 @@
-import { IAttributes, LangType, Types } from "../base/utils";
+import { AttributeType, IAttributes, LangType, Types } from "../base/utils";
 /**
  * Represents an interface object of Pages Api.
  *
@@ -74,23 +74,25 @@ interface IPositionForm {
  * @interface
  * @property {number} id - The identifier of the object.
  * @property {number} version - The version number of the object.
+ * @property {number} quantity - Quantity pages in block.
  * @property {string} identifier - The textual identifier for the record field.
  * @property {Record<string, any>} localizeInfos - The name of the page, taking into account localization.
  * @property {number} position - The position of the object.
  * @property {boolean} isSync - Indication of page indexing.
- * @property {Record<string, any>} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value).
+ * @property {AttributeType} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value).
  * @property {string} attributeSetIdentifier
  * @property {Types} type - Page type.
  */
 interface IPositionBlock {
     id: number;
+    quantity?: number;
     version: number;
     identifier: string;
     localizeInfos: Record<string, any>;
     position: number;
     isSync: boolean;
     isVisible: boolean;
-    attributeValues: Record<string, any>;
+    attributeValues: AttributeType;
     attributeSetIdentifier: string | null;
     type: string;
     templateIdentifier: string | null;
@@ -111,14 +113,14 @@ interface IPositionBlock {
  * @property {string} attributeSetIdentifier - Set of attributes id.
  * @property {boolean} isSync - Indication of page indexing.
  * @property {string} templateIdentifier - User id of the linked template.
- * @property {Record<string, any>} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value).
+ * @property {AttributeType} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value).
  * @property {number} position - Item number (for sorting).
  * @property {Types} type - Page type.
  * @property {number} childrenCount - Children count.
  */
 interface IPagesEntity {
     attributeSetIdentifier: string;
-    attributeValues: Record<string, any>;
+    attributeValues: AttributeType;
     childrenCount?: number;
     config?: Record<string, number>;
     depth: number;

package/dist/products/productsInterfaces.d.ts

@@ -1,4 +1,4 @@
-import { LangType, Types } from "../base/utils";
+import { AttributeType, LangType, Types } from "../base/utils";
 /**
  * Represents an interface object of Products Api.
  *
@@ -66,6 +66,8 @@ interface IProductsQuery {
  * @property {string | null} conditionMarker - Id of the filter condition by which the values are filtered, default null.
  * @property {string | null} attributeMarker - The text identifier of the indexed attribute by which values are filtered, default null.
  * @property {Array<string> | null} pageUrl - Url of the category page object.
+ * @property {string | null} statusMarker - Text identifier of the product page status (default not set).
+ * @property {string | null} title - Product name.
  */
 interface IFilterParams {
     attributeMarker: string;
@@ -82,6 +84,8 @@ interface IFilterParams {
     conditionMarker?: 'in' | 'nin' | 'eq' | 'neq' | 'mth' | 'lth' | 'exs' | 'nexs' | null;
     conditionValue: number | string | null;
     pageUrl?: Array<string> | null;
+    statusMarker?: string;
+    title?: string;
 }
 /**
  * Represents a product entity object.
@@ -120,7 +124,7 @@ interface IProductsEntity {
     templateIdentifier: string | null;
     shortDescTemplateIdentifier: string;
     statusLocalizeInfos: Record<string, any>;
-    attributeValues: Record<string, any>;
+    attributeValues: AttributeType;
     position: number;
     sku: string | null;
 }
@@ -168,6 +172,6 @@ interface IProductBlock {
     templateIdentifier: string | null;
     isVisible: boolean;
     isSync: boolean;
-    attributeValues: Record<string, any>;
+    attributeValues: AttributeType;
 }
 export { IFilterParams, IProductsQuery, IProductApi, IProductsEntity, IProductsInfo, IProductInfo, IProductBlock, IProductEntity, IProductsResponse };

package/dist/templates/templatesApi.d.ts

@@ -24,13 +24,21 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
      *
      * @returns Returns a TemplateEntity object
      */
-    getTemplateByType(type: Types): Promise<Array<ITemplateEntity>>;
+    getTemplateByType(type: Types, langCode?: string): Promise<Array<ITemplateEntity>>;
     /**
      * Get one template object by id.
      *
      * @param {number} id - Template id
+     * @param {string} [langCode] - Optional parameter language code
+     * @returns Returns a TemplateEntity object
+     */
+    getTemplateById(id: number, langCode?: string): Promise<ITemplateEntity>;
+    /**
+     * Get one template object by id.
      *
+     * @param {number} marker - Template marker
+     * @param {string} [langCode] - Optional parameter language code
      * @returns Returns a TemplateEntity object
      */
-    getTemplateById(id: number): Promise<Record<Types, ITemplateEntity>>;
+    getTemplateByMarker(marker: string, langCode?: string): Promise<ITemplateEntity>;
 }

package/dist/templates/templatesApi.js

@@ -16,7 +16,7 @@ class TemplatesPreviewApi extends asyncModules_1.default {
      * @returns Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
      */
     async getAllTemplates(langCode = this.state.lang) {
-        const response = await this._fetchGet('/all');
+        const response = await this._fetchGet(`/all?langCode=${langCode}`);
         const result = {};
         for (let item in response) {
             result[item] = this._normalizeData(response[item], langCode);
@@ -31,20 +31,31 @@ class TemplatesPreviewApi extends asyncModules_1.default {
      *
      * @returns Returns a TemplateEntity object
      */
-    async getTemplateByType(type) {
-        const result = await this._fetchGet(`?type=${type}`);
-        return result;
+    async getTemplateByType(type, langCode = this.state.lang) {
+        const result = await this._fetchGet(`?type=${type}&langCode=${langCode}`);
+        return this._normalizeData(result);
     }
     /**
      * Get one template object by id.
      *
      * @param {number} id - Template id
+     * @param {string} [langCode] - Optional parameter language code
+     * @returns Returns a TemplateEntity object
+     */
+    async getTemplateById(id, langCode = this.state.lang) {
+        const result = await this._fetchGet(`/${id}?langCode=${langCode}`);
+        return this._normalizeData(result);
+    }
+    /**
+     * Get one template object by id.
      *
+     * @param {number} marker - Template marker
+     * @param {string} [langCode] - Optional parameter language code
      * @returns Returns a TemplateEntity object
      */
-    async getTemplateById(id) {
-        const result = await this._fetchGet(`/${id}`);
-        return result;
+    async getTemplateByMarker(marker, langCode = this.state.lang) {
+        const result = await this._fetchGet(`/${marker}?langCode=${langCode}`);
+        return this._normalizeData(result);
     }
 }
 exports.default = TemplatesPreviewApi;

package/dist/templates/templatesInterfaces.d.ts

@@ -1,15 +1,17 @@
-import { Types } from "../base/utils";
+import { AttributeType, Types } from "../base/utils";
 /**
  * Represents an interface object of Templates Api.
  *
  * @property {function} getAllTemplates - Get all template objects grouped by types.
  * @property {function} getTemplateByType - Get template objects by type.
  * @property {function} getTemplateById - Get one template object by id.
+ * @property {function} getTemplateByMarker - Getting a single template object.
  */
 interface ITemplatesApi {
-    getAllTemplates(langCode: string): Promise<Record<Types, ITemplateEntity>>;
+    getAllTemplates(langCode?: string): Promise<Record<Types, ITemplateEntity>>;
     getTemplateByType(type: Types, langCode: string): Promise<Array<ITemplateEntity>>;
-    getTemplateById(id: number): Promise<Record<Types, ITemplateEntity>>;
+    getTemplateById(id: number): Promise<ITemplateEntity>;
+    getTemplateByMarker(marker: string, langCode?: string): Promise<ITemplateEntity>;
 }
 /**
  * Represents a template entity object.
@@ -22,6 +24,8 @@ interface ITemplatesApi {
  * @property {string} title - The name of the template.
  * @property {number} position - The position of the object.
  * @property {Types} generalTypeName - General type name.
+ * @property {string} attributeSetIdentifier - Set of attributes id.
+ * @property {AttributeType} attributeValues - Attribute values from the index (represented as a pair of user attribute id: attribute value).
  *
  */
 interface ITemplateEntity {
@@ -32,5 +36,7 @@ interface ITemplateEntity {
     title: string;
     position: number;
     generalTypeName: Types;
+    attributeValues: AttributeType;
+    attributeSetIdentifier: string | null;
 }
 export { ITemplatesApi, ITemplateEntity, };

package/dist/templates-preview/templatesPreviewApi.js

@@ -16,7 +16,7 @@ class TemplatePreviewsApi extends asyncModules_1.default {
      * @returns Returns all TemplatePreviewsEntity template objects
      */
     async getTemplatePreviews(langCode = this.state.lang) {
-        const result = await this._fetchGet('');
+        const result = await this._fetchGet(`?langCode=${langCode}`);
         return this._normalizeData(result, langCode);
     }
     /**
@@ -28,7 +28,7 @@ class TemplatePreviewsApi extends asyncModules_1.default {
      * @returns Returns a TemplatePreviewsEntity object
      */
     async getTemplatePreviewById(id, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/${id}`);
+        const result = await this._fetchGet(`/${id}?langCode=${langCode}`);
         return this._normalizeData(result, langCode);
     }
     /**
@@ -40,7 +40,7 @@ class TemplatePreviewsApi extends asyncModules_1.default {
      * @returns Returns a TemplatePreviewsEntity object
      */
     async getTemplatePreviewByMarker(marker, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/marker/${marker}`);
+        const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
         return this._normalizeData(result, langCode);
     }
 }

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

@@ -1,3 +1,4 @@
+import { AttributeType } from "../base/utils";
 /**
  * Represents an interface object of Templates Preview Api.
  *
@@ -21,12 +22,17 @@ interface ITemplatesPreview {
  * @property {object} proportion - Object contains info by proportion template preview.
  * @property {Record<string, any>} localizeInfos - The name of the template, taking into account localization.
  * @property {number} position - The position of the object.
+ * @property {AttributeType} attributeValues - Attribute values from index.
+ * @property {string} attributeSetIdentifier - Text identifier used for a set of attributes
+ *
  *
  */
 interface ITemplatesPreviewEntity {
     id: number;
     version: number;
     identifier: string;
+    attributeValues: AttributeType;
+    attributeSetIdentifier: string;
     proportion: {
         horizontal: IProportion | null;
         vertical: IProportion | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.88",
+  "version": "1.0.90",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",