oneentry 1.0.29 → 1.0.30

package/README.md

@@ -59,14 +59,10 @@ const api = defineOneEntry('your-url', 'your-token')
 const { Admins } = defineOneEntry('your-url')
 ```
 
-### Admins.getAdminsInfo()
+### Admins.getAdminsInfo(langCode, offset, limit)
 
 ```
-const langCode = 'en_US'
-const offset = 0
-const limit = 30
-
-const value = await Admins.getAdminsInfo(langCode, offset, limit)
+const value = await Admins.getAdminsInfo('en_US', 0, 30)
 ```
 
 
@@ -75,28 +71,30 @@ const value = await Admins.getAdminsInfo(langCode, offset, limit)
 Example return:
 
 ```
-{
-  "id": 1764,
-  "identifier": "admin1",
-  "attributeSetId": 7,
-  "isSync": false,
-  "attributeValues": {
-    "en_US": {
-      "marker": {
-        "value": "",
-        "type": "string"
+[
+  {
+    "id": 1764,
+    "identifier": "admin1",
+    "attributeSetId": 7,
+    "isSync": false,
+    "attributeValues": {
+      "en_US": {
+        "marker": {
+          "value": "",
+          "type": "string"
+        }
       }
-    }
-  },
-  "position": 192
-}
+    },
+    "position": 192
+  }
+]
 ```
 
 ## FileUploading
 
 const { FileUploading } = defineOneEntry('your-url');
 
-### FileUploading.upload()
+### FileUploading.upload(data, fileQuery)
 
 ```
 const query = {
@@ -117,14 +115,16 @@ const value = await FileUploading.upload(data, query)
 Example return:
 
 ```
-{
-  "filename": "string",
-  "downloadLink": "string",
-  "size": 0
-}
+[
+  {
+    "filename": "string",
+    "downloadLink": "string",
+    "size": 0
+  }
+]
 ```
 
-### FileUploading.delete()
+### FileUploading.delete(filename, fileQuery)
 
 ```
 const query = {
@@ -139,15 +139,9 @@ const value = await FileUploading.delete("file.png", query)
 
 > This void method delete a file from the cloud file storage. 
 
-### FileUploading.getFile()
+### FileUploading.getFile(id, type, entity, filename)
 ```
-const id = 123
-const type = 'page'
-const entity = 'editor'
-const filename = 'file.png'
-
-
-const value = await FileUploading.getFile(id, type, entity, filename)
+const value = await FileUploading.getFile(123, 'page', 'editor', 'file.png')
 ```
 
 > This method return file object by parameters.
@@ -164,14 +158,10 @@ Example return:
 
 const { Forms } = defineOneEntry('your-url');
 
-### Forms.getAllForms()
+### Forms.getAllForms(langCode, offset, limit)
 
 ```
-const langCode = 'en_US'
-const offset = 0
-const limit = 30
-
-const value = await Forms.getAllForms(langCode, offset, limit)
+const value = await Forms.getAllForms('en_US', 0, 30)
 ```
 
 > This method retrieves all form objects from the API. It returns a Promise that resolves to an array of FormEntity objects.
@@ -186,7 +176,7 @@ Example return:
     "processingType": "email",
     "localizeInfos": {
       "en_US": {
-        "title": "My form",
+        "title": "My Form",
         "titleForSite": "",
         "successMessage": "",
         "unsuccessMessage": "",
@@ -196,28 +186,44 @@ Example return:
       }
     },
     "processingData": "Unknown Type: ProcessingData",
-    "attributeValues": {
-      "en_US": {
-        "marker": {
-          "value": "",
-          "type": "string"
-        }
-      }
-    },
     "version": 10,
     "identifier": "catalog",
-    "position": 192
+    "position": 192,
+    "attributes": [
+      {
+        "type": "list",
+        "marker": "l1",
+        "position": 2,
+        "listTitles": [
+          {
+            "title": "red",
+            "value": 1,
+            "position": 1,
+            "extendedValue": null,
+            "extendedValueType": null
+          },
+          {
+            "title": "yellow",
+            "value": 2,
+            "position": 2,
+            "extendedValue": null,
+            "extendedValueType": null
+          }
+        ],
+        "validators": {},
+        "localizeInfos": {
+          "title": "l1"
+        }
+      }
+    ]
   }
 ]
 ```
 
-### Forms.getFormByMarker()
+### Forms.getFormByMarker(marker, langCode)
 
 ```
-const marker = 'My form'
-const langCode = 'en_US'
-
-const value = await Forms.getFormByMarker(marker, langCode)
+const value = await Forms.getFormByMarker('My form', 'en_US')
 ```
 
 > This method retrieves a single form object based on its textual identifier (marker) from the API. It returns a Promise that resolves to a FormEntity object.
@@ -231,7 +237,7 @@ Example return:
   "processingType": "email",
   "localizeInfos": {
     "en_US": {
-      "title": "My form",
+      "title": "My Form",
       "titleForSite": "",
       "successMessage": "",
       "unsuccessMessage": "",
@@ -241,17 +247,36 @@ Example return:
     }
   },
   "processingData": "Unknown Type: ProcessingData",
-  "attributeValues": {
-    "en_US": {
-      "marker": {
-        "value": "",
-        "type": "string"
-      }
-    }
-  },
   "version": 10,
   "identifier": "catalog",
-  "position": 192
+  "position": 192,
+  "attributes": [
+    {
+      "type": "list",
+      "marker": "l1",
+      "position": 2,
+      "listTitles": [
+        {
+          "title": "red",
+          "value": 1,
+          "position": 1,
+          "extendedValue": null,
+          "extendedValueType": null
+        },
+        {
+          "title": "yellow",
+          "value": 2,
+          "position": 2,
+          "extendedValue": null,
+          "extendedValueType": null
+        }
+      ],
+      "validators": {},
+      "localizeInfos": {
+        "title": "l1"
+      }
+    }
+  ]
 }
 ```
 
@@ -259,7 +284,7 @@ Example return:
 
 const { FormData } = defineOneEntry('your-url');
 
-### FormData.postFormsData()
+### FormData.postFormsData(data)
 
 ```
 const value = await FormData.postFormsData(data)
@@ -285,14 +310,10 @@ Example return:
 }
 ```
 
-### FormData.getFormsData()
+### FormData.getFormsData(langCode, offset, limit)
 
 ```
-const langCode = 'en_US'
-const offset = 0
-const limit = 30
-
-const value = await FormData.getFormsData(langCode, offset, limit)
+const value = await FormData.getFormsData('en_US', 0, 30)
 ```
 
 > This method creates form data objects by sending a request to the API. It accepts an array of objects of type IFormsPost as the request body to provide the necessary form data. It returns a Promise that resolves to the created CreateFormDataDto objects.
@@ -300,32 +321,26 @@ const value = await FormData.getFormsData(langCode, offset, limit)
 Example return:
 
 ```
-[
-    {
-      "id": 1764,
-      "formIdentifier": "my-form",
-      "time": "2023-02-12 10:56",
-      "formData": {
-        "en_US": [
-          {
-            "marker": "naimenovanie_1",
-            "value": "Name"
-          }
-        ]
+{
+  "id": 1764,
+  "formIdentifier": "my-form",
+  "time": "2023-02-12 10:56",
+  "formData": {
+    "en_US": [
+      {
+        "marker": "name_1",
+        "value": "Name"
       }
-    }
-]
+    ]
+  },
+  "attributeSetIdentifier": "test-form"
+}
 ```
 
-### FormData.getFormsDataByMarker()
+### FormData.getFormsDataByMarker(marker, langCode, offset, limit)
 
 ```
-const marker = 'my-marker'
-const langCode = 'en_US'
-const offset = 0
-const limit = 30
-
-const value = await FormData.getFormsDataByMarker(marker, langCode, offset, limit)
+const value = await FormData.getFormsDataByMarker('my-marker', 'en_US', 0, 30)
 ```
 
 > This method retrieves a specific form data object by its marker from the API. It accepts a marker parameter as the marker of the form data. It returns a Promise that resolves to an array of objects of type FormDataEntity.
@@ -344,7 +359,8 @@ Example return:
         "value": "Name"
       }
     ]
-  }
+  },
+  "attributeSetIdentifier": "test-form"
 }
 ```
 
@@ -408,10 +424,10 @@ Example return:
 const { Menus } = defineOneEntry('your-url')
 ```
 
-### Menus.getMenusByMarker()
+### Menus.getMenusByMarker(marker)
 
 ```
-const value = await Menus.getMenusByMarker('marker')
+const value = await Menus.getMenusByMarker('my-marker')
 ```
 
 > This method retrieves a single menu object based on its marker (marker) from the API. It returns a Promise that resolves to a single menu object as a ContentMenuDto object with included pages.
@@ -508,7 +524,7 @@ const value = await Pages.getRootPages([ 'en_US', 'it_IT' ])
  }
 ```
 
-### Pages.getRootPages()
+### Pages.getRootPages(langCode)
 
 ```
 const value = await Pages.getRootPages('en_US')
@@ -556,10 +572,10 @@ Example return:
 ]
 ```
 
-### Pages.getCatalogPages()
+### Pages.getCatalogPages(langCode, limit, offset)
 
 ```
-const value = await Pages.getCatalogPages(langCode = 'en_US', limit = 20, offset = 5)
+const value = await Pages.getCatalogPages('en_US', 0, 30)
 ```
 
 > This method retrieves all page objects with product information as an array from the API. It accepts two optional parameters limit and offset for pagination and language code parameter. It returns a Promise that resolves to an array of ContentIndexedPageDto objects or an empty array [] if there is no data.
@@ -604,7 +620,7 @@ Example return:
 ]
 ```
 
-### Pages.getPages()
+### Pages.getPages(langCode)
 
 ```
 const value = await Pages.getPages('en_US')
@@ -652,7 +668,7 @@ Example return:
 ]
 ```
 
-### Pages.getPageById()
+### Pages.getPageById(id, langCode)
 
 ```
 const value = await Pages.getPageById(1, 'en_US')
@@ -692,7 +708,7 @@ Example return:
 }
 ```
 
-### Pages.getPageByUrl()
+### Pages.getPageByUrl(url, langCode)
 
 ```
 const value = await Pages.getPageByUrl('shop', 'en_US')
@@ -732,7 +748,7 @@ Example return:
 }
 ```
 
-### Pages.getChildPagesByParentUrl()
+### Pages.getChildPagesByParentUrl(url, langCode)
 
 ```
 const value = await Pages.getChildPagesByParentUrl('shop', 'en_US')
@@ -774,7 +790,7 @@ Example return:
 ]
 ```
 
-### Pages.getFormsByPageUrl()
+### Pages.getFormsByPageUrl(url, langCode)
 
 ```
 const value = await Pages.getFormsByPageUrl('shop', 'en_US')
@@ -785,38 +801,58 @@ const value = await Pages.getFormsByPageUrl('shop', 'en_US')
 Example return:
 
 ```
-{
-  "id": 1764,
-  "version": 10,
-  "identifier": "catalog",
-  "attributeSetId": 0,
-  "processingType": "email",
-  "localizeInfos": {
-    "en_US": {
-      "title": "My form",
-      "titleForSite": "",
-      "successMessage": "",
-      "unsuccessMessage": "",
-      "urlAddress": "",
-      "database": "0",
-      "script": "0"
-    }
-  },
-  "processingData": {},
-  "position": 0,
-  "isSync": false,
-  "attributeValues": {
-    "en_US": {
-      "marker": {
-        "value": "",
-        "type": "string"
+[
+  {
+    "id": 1764,
+    "version": 10,
+    "identifier": "catalog",
+    "attributeSetId": 0,
+    "processingType": "email",
+    "localizeInfos": {
+      "en_US": {
+        "title": "My form",
+        "titleForSite": "",
+        "successMessage": "",
+        "unsuccessMessage": "",
+        "urlAddress": "",
+        "database": "0",
+        "script": "0"
       }
-    }
+    },
+    "processingData": {},
+    "position": 0,
+    "attributes": [
+      {
+        "type": "list",
+        "marker": "l1",
+        "position": 2,
+        "listTitles": [
+          {
+            "title": "red",
+            "value": 1,
+            "position": 1,
+            "extendedValue": null,
+            "extendedValueType": null
+          },
+          {
+            "title": "yellow",
+            "value": 2,
+            "position": 2,
+            "extendedValue": null,
+            "extendedValueType": null
+          }
+        ],
+        "validators": {},
+        "localizeInfos": {
+          "title": "l1"
+        }
+      }
+    ]
   }
-}
+]
 ```
 
-### Pages.getConfigPageByUrl()
+### Pages.getConfigPageByUrl(url)
 
 ```
 const value = await Pages.getConfigPageByUrl('shop')
@@ -833,7 +869,7 @@ Example return:
 }
 ```
 
-### Pages.searchPage()
+### Pages.searchPage(name, langCode)
 
 ```
 const value = await Pages.searchPage('cup', 'en_US')
@@ -886,7 +922,7 @@ const { Products } = defineOneEntry('your-url')
 Parameters:
 
 ```
-{
+const userQuery = {
     offset: 0,
     limit: 30,
     statusMarker: null,
@@ -972,10 +1008,10 @@ const value = await Products.getProducts([ 'en_US', 'it_IT' ])
  }
 ```
 
-### Products.getProducts()
+### Products.getProducts(langCode, userQuery)
 
 ```
-const value = await Products.getProducts('en_US')
+const value = await Products.getProducts('en_US', userQuery)
 ```
 
 > This method searches for product page objects with pagination and filtering based on the provided query parameters (userQuery). It returns a Promise that resolves to a list of products (IProduct[]).
@@ -1016,10 +1052,10 @@ Example return:
 ]
 ```
 
-### Products.getProductsEmptyPage()
+### Products.getProductsEmptyPage(langCode, userQuery)
 
 ```
-const value = await Products.getProductsEmptyPage('en_US')
+const value = await Products.getProductsEmptyPage('en_US', userQuery)
 ```
 
 > This method searches for product page objects with pagination that do not have a category, based on the provided query parameters (userQuery). It returns a Promise that resolves to an array of items, where each item is a ContentIndexedProductDto object.
@@ -1060,10 +1096,10 @@ Example return:
 ]
 ```
 
-### Products.getProductsPageById()
+### Products.getProductsPageById(id, langCode, userQuery)
 
 ```
-const value = await Products.getProductsPageById(1, 'en_US')
+const value = await Products.getProductsPageById(1, 'en_US', userQuery)
 ```
 
 > This method searches for all product page objects with pagination for the selected category based on the page identifier (id). It accepts an optional userQuery parameter to set query parameters for the search. The query parameters include limit, offset, statusMarker, conditionValue, conditionMarker, attributeMarker, sortOrder, and sortKey. It returns a Promise that resolves to an array of ContentIndexedProductDto objects.
@@ -1110,10 +1146,10 @@ Example return:
 }
 ```
 
-### Products.getProductsPageByUrl()
+### Products.getProductsPageByUrl(url, langCode, userQuery)
 
 ```
-const value = await Products.getProductsPageByUrl('cup', 'en_US')
+const value = await Products.getProductsPageByUrl('cup', 'en_US', userQuery)
 ```
 
 > This method searches for all product page objects with pagination for the selected category based on the page URL (url). It accepts an optional userQuery parameter to set query parameters for the search. The query parameters include limit, offset, statusMarker, conditionValue, conditionMarker, attributeMarker, sortOrder, and sortKey. It returns a Promise that resolves to an array of ContentIndexedProductDto objects.
@@ -1160,10 +1196,10 @@ Example return:
 }
 ```
 
-### Products.getRelatedProductsById()
+### Products.getRelatedProductsById(id, langCode, userQuery)
 
 ```
-const value = await Products.getRelatedProductsById(1, ''en_US'', {limit:20, offset:1})
+const value = await Products.getRelatedProductsById(1, 'en_US', {limit:20, offset:1})
 ```
 
 > This method retrieves all related product page objects for a specific product based on its identifier (id) from the API. It accepts an optional userQuery parameter for additional query parameters such as limit, offset, sortOrder, and sortKey. It returns a Promise that resolves to an array of ContentIndexedProductDto objects.
@@ -1202,7 +1238,7 @@ Example return:
 }
 ```
 
-### Products.getProductById()
+### Products.getProductById(id, langCode)
 
 ```
 const value = await Products.getProductById(1, 'en_US')
@@ -1245,10 +1281,16 @@ Example return:
 
 ```
 
-### Products.filterProduct()
+### Products.filterProduct(data, langCode, userQuery)
 
 ```
-const value = await Products.filterProduct({conditionValue:1})
+  const data = {
+        attributeMarker: "price",
+        conditionMarker: "lth",
+        conditionValue: "200",
+    }
+
+const value = await Products.filterProduct(data, 'en_US', userQuery)
 ```
 
 Example body:
@@ -1314,7 +1356,7 @@ Example return:
 }
 ```
 
-### Products.searchProduct()
+### Products.searchProduct(name, langCode)
 
 ```
 const value = await Products.searchProduct('cup', 'en_US')
@@ -1398,7 +1440,7 @@ Example return:
 ]
 ```
 
-### ProductStatuses.getProductStatusesById()
+### ProductStatuses.getProductStatusesById(id)
 
 ```
 const value = await ProductStatuses.getProductStatusesById(1)
@@ -1422,10 +1464,10 @@ Example return:
 }
 ```
 
-### ProductStatuses.getProductsByStatusMarker()
+### ProductStatuses.getProductsByStatusMarker(marker)
 
 ```
-const value = await ProductStatuses.getProductsByStatusMarker('marker')
+const value = await ProductStatuses.getProductsByStatusMarker('my-marker')
 ```
 
 > This method searches for a product status object based on its textual identifier (marker) from the API. It returns a Promise that resolves to a product status object.
@@ -1446,7 +1488,7 @@ Example return:
 }
 ```
 
-### ProductStatuses.validateMarker()
+### ProductStatuses.validateMarker(marker)
 
 ```
 const value = await ProductStatuses.validateMarker('marker')
@@ -1501,9 +1543,9 @@ Example return:
 
 ```
 [
-  {
+   {
       "id": 1764,
-      "updatedDate": "2023-11-20T22:16:17.531Z",
+      "updatedDate": "2023-12-05T12:47:02.859Z",
       "version": 10,
       "identifier": "marker",
       "generalType": {
@@ -1523,7 +1565,7 @@ Example return:
 ]
 ```
 
-### Templates.getTemplateByType()
+### Templates.getTemplateByType(type)
 
 ```
 const value = await Templates.getTemplateByType('forCatalogProducts')
@@ -1537,25 +1579,22 @@ Example return:
 [
   {
     "id": 1764,
-    "identifier": "admin1",
-    "attributeSetId": 7,
-    "generalTypeId": 2,
-    "generalTypeName": "forCatalogProducts",
-    "localizeInfos": {
-      "en_US": {
-        "title": "Product"
-      }
+    "updatedDate": "2023-12-05T12:45:13.566Z",
+    "version": 10,
+    "identifier": "marker",
+    "generalType": {
+      "id": 4,
+      "type": "forCatalogPages"
     },
-    "isSync": false,
-    "attributeValues": {
+    "generalTypeId": 4,
+    "localizeInfos": {
       "en_US": {
-        "marker": {
-          "value": "",
-          "type": "string"
-        }
+        "title": "Page template"
       }
     },
-    "position": 192
+    "position": 0,
+    "positionId": 12,
+    "generalTypeName": "forProductPreview"
   }
 ]
 ```
@@ -1579,43 +1618,43 @@ Example return:
 ```
 [
   {
-      "id": 1764,
-      "updatedDate": "2023-11-20T22:18:25.344Z",
-      "version": 10,
-      "identifier": "marker",
-      "proportion": {
-        "horizontal": {
-          "height": 200,
-          "weight": 10,
-          "marker": "horizontal",
-          "title": "Horizontal",
-          "alignmentType": "left"
-        },
-        "vertical": {
-          "height": 10,
-          "weight": 200,
-          "marker": "vertical",
-          "title": "Vertical",
-          "alignmentType": "left"
-        },
-        "square": {
-          "marker": "square",
-          "title": "Square",
-          "slide": 3,
-          "alignmentType": "center"
-        }
+    "id": 1764,
+    "updatedDate": "2023-12-05T12:44:55.663Z",
+    "version": 10,
+    "identifier": "marker",
+    "proportion": {
+      "horizontal": {
+        "height": 200,
+        "weight": 10,
+        "marker": "horizontal",
+        "title": "Horizontal",
+        "alignmentType": "left"
       },
-      "localizeInfos": {
-        "en_US": {
-          "title": "Page Template"
-        }
+      "vertical": {
+        "height": 10,
+        "weight": 200,
+        "marker": "vertical",
+        "title": "Vertical",
+        "alignmentType": "left"
       },
-      "position": 0
+      "square": {
+        "marker": "square",
+        "title": "Square",
+        "slide": 3,
+        "alignmentType": "center"
+      }
+    },
+    "localizeInfos": {
+      "en_US": {
+        "title": "Page Template"
+      }
+    },
+    "position": 0
   }
 ]
 ```
 
-### TemplatePreviews.getTemplatesPreviewById()
+### TemplatePreviews.getTemplatesPreviewById(id)
 
 ```
 const value = await TemplatePreviews.getTemplatesPreviewById(1)
@@ -1626,47 +1665,46 @@ const value = await TemplatePreviews.getTemplatesPreviewById(1)
 Example return:
 
 ```
-  {
-      "id": 1764,
-      "updatedDate": "2023-11-20T22:18:25.344Z",
-      "version": 10,
-      "identifier": "marker",
-      "proportion": {
-        "horizontal": {
-          "height": 200,
-          "weight": 10,
-          "marker": "horizontal",
-          "title": "Horizontal",
-          "alignmentType": "left"
-        },
-        "vertical": {
-          "height": 10,
-          "weight": 200,
-          "marker": "vertical",
-          "title": "Vertical",
-          "alignmentType": "left"
-        },
-        "square": {
-          "marker": "square",
-          "title": "Square",
-          "slide": 3,
-          "alignmentType": "center"
-        }
-      },
-      "localizeInfos": {
-        "en_US": {
-          "title": "Page Template"
-        }
-      },
-      "position": 0
-  }
- 
+{
+  "id": 1764,
+  "updatedDate": "2023-12-05T12:44:37.348Z",
+  "version": 10,
+  "identifier": "marker",
+  "proportion": {
+    "horizontal": {
+      "height": 200,
+      "weight": 10,
+      "marker": "horizontal",
+      "title": "Horizontal",
+      "alignmentType": "left"
+    },
+    "vertical": {
+      "height": 10,
+      "weight": 200,
+      "marker": "vertical",
+      "title": "Vertical",
+      "alignmentType": "left"
+    },
+    "square": {
+      "marker": "square",
+      "title": "Square",
+      "slide": 3,
+      "alignmentType": "center"
+    }
+  },
+  "localizeInfos": {
+    "en_US": {
+      "title": "Page Template"
+    }
+  },
+  "position": 0
+}
 ```
 
-### TemplatePreviews.getTemplatesPreviewByMarker()
+### TemplatePreviews.getTemplatesPreviewByMarker(marker)
 
 ```
-const value = await TemplatePreviews.getTemplatesPreviewByMarker('marker')
+const value = await TemplatePreviews.getTemplatesPreviewByMarker('my-marker')
 ```
 
 > This method retrieves a single template object based on its textual identifier (marker) from the API. It returns a Promise that resolves to a TemplatePreviewsEntity object.
@@ -1676,7 +1714,7 @@ Example return:
 ```
 {
   "id": 1764,
-  "updatedDate": "2023-11-20T22:18:25.344Z",
+  "updatedDate": "2023-12-05T12:44:20.008Z",
   "version": 10,
   "identifier": "marker",
   "proportion": {

package/dist/admins/adminsInterfaces.d.ts

@@ -38,11 +38,11 @@ interface IPosition {
  * @property {number} position - The position of the object.
  */
 interface IAdminEntity {
+    attributeSetId: number | null;
+    attributeValues: IAttributeValues;
     id: number;
     identifier: string;
-    attributeSetId: number | null;
     isSync: boolean;
-    attributeValues: IAttributeValues;
     position: number;
 }
 export { IAdmins, IAdminEntity, IPosition };

package/dist/base/utils.d.ts

@@ -19,6 +19,20 @@ declare enum Types {
     forSlider = "forSlider",
     service = "service"
 }
+interface IAttributes {
+    listTitles: Array<{
+        title: string;
+        value: number | string | null;
+        position: number;
+        extendedValue: number | string | null;
+        extendedValueType: number | string | null;
+    }>;
+    localizeInfos: ILocalizeInfo;
+    marker: string;
+    position: number;
+    type: string;
+    validators: object;
+}
 interface ILocalizeInfos {
     [key: string]: ILocalizeInfo;
 }
@@ -51,4 +65,4 @@ interface IAttributeSetEntity {
 }
 type LangType = string | Array<string>;
 type LocalizeType = ILocalizeInfos | ILocalizeInfo;
-export { LocalizeType, ILocalizeInfos, Types, IAttributeSetEntity, LangType, AttributeType, IAttributeValues };
+export { LocalizeType, ILocalizeInfos, Types, IAttributeSetEntity, LangType, AttributeType, IAttributeValues, IAttributes };

package/dist/file-uploding/fileUploadingApi.d.ts

@@ -11,30 +11,30 @@ export default class FileUploadingApi extends OneEntry implements IFileUploading
      *
      * @param {Event} [data] Array of Express.Multer.File objects
      *
-     * @param {IUploadingQuery} [userQuery] - Optional set query parameters.
-     * @param {string} [userQuery.type] - Type, determines the folder name in the storage. Example : "page"
-     * @param {string} [userQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example : "editor"
-     * @param {number} [userQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example : 3787
-     * @param {number} [userQuery.width] - Width parameter. Example : 0
-     * @param {number} [userQuery.height] - Height parameter. Example : 0
-     * @param {boolean} [userQuery.compress] - Flag of optimization (compression) for images. Example : true
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example : "page"
+     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example : "editor"
+     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example : 3787
+     * @param {number} [fileQuery.width] - Optional width parameter. Example : 0
+     * @param {number} [fileQuery.height] - Optional height parameter. Example : 0
+     * @param {boolean} [fileQuery.compress] - Optional flag of optimization (compression) for images. Example : true
      *
      * @returns Uploads a file to an Amazon S3-compatible cloud file storage
      */
-    upload(data: Event, userQuery?: IUploadingQuery): Promise<IUploadingReturns>;
+    upload(data: Event, fileQuery?: IUploadingQuery): Promise<IUploadingReturns>;
     /**
      * Deletes a file from the cloud file storage.
      *
      * @param {string} [filename] File name. Example "file.png"
      *
-     * @param {IUploadingQuery} [userQuery] - Optional set query parameters.
-     * @param {string} [userQuery.type] - Type, determines the folder name in the storage. Example : "page"
-     * @param {string} [userQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example : "editor"
-     * @param {number} [userQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example : 3787
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example : "page"
+     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example : "editor"
+     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example : 3787
      *
      * @returns Deletes a file from the cloud file storage
      */
-    delete(filename: string, userQuery?: IUploadingQuery): Promise<any>;
+    delete(filename: string, fileQuery?: IUploadingQuery): Promise<any>;
     /**
      * Get file by parameters.
      *

package/dist/file-uploding/fileUploadingApi.js

@@ -22,18 +22,18 @@ class FileUploadingApi extends oneEntry_1.default {
      *
      * @param {Event} [data] Array of Express.Multer.File objects
      *
-     * @param {IUploadingQuery} [userQuery] - Optional set query parameters.
-     * @param {string} [userQuery.type] - Type, determines the folder name in the storage. Example : "page"
-     * @param {string} [userQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example : "editor"
-     * @param {number} [userQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example : 3787
-     * @param {number} [userQuery.width] - Width parameter. Example : 0
-     * @param {number} [userQuery.height] - Height parameter. Example : 0
-     * @param {boolean} [userQuery.compress] - Flag of optimization (compression) for images. Example : true
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example : "page"
+     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example : "editor"
+     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example : 3787
+     * @param {number} [fileQuery.width] - Optional width parameter. Example : 0
+     * @param {number} [fileQuery.height] - Optional height parameter. Example : 0
+     * @param {boolean} [fileQuery.compress] - Optional flag of optimization (compression) for images. Example : true
      *
      * @returns Uploads a file to an Amazon S3-compatible cloud file storage
      */
-    async upload(data, userQuery) {
-        const query = { ...this._defaultQuery, ...userQuery };
+    async upload(data, fileQuery) {
+        const query = { ...this._defaultQuery, ...fileQuery };
         const result = await this._fetchPost('?' + this._queryParamsToString(query), data);
         return result;
     }
@@ -42,15 +42,15 @@ class FileUploadingApi extends oneEntry_1.default {
      *
      * @param {string} [filename] File name. Example "file.png"
      *
-     * @param {IUploadingQuery} [userQuery] - Optional set query parameters.
-     * @param {string} [userQuery.type] - Type, determines the folder name in the storage. Example : "page"
-     * @param {string} [userQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example : "editor"
-     * @param {number} [userQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example : 3787
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example : "page"
+     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example : "editor"
+     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example : 3787
      *
      * @returns Deletes a file from the cloud file storage
      */
-    async delete(filename, userQuery) {
-        const query = { ...this._defaultQuery, ...userQuery };
+    async delete(filename, fileQuery) {
+        const query = { ...this._defaultQuery, ...fileQuery };
         const result = await this._fetchDelete(`?filename=${filename}&` + this._queryParamsToString(query));
         return result;
     }

package/dist/file-uploding/fileUploadingInterfaces.d.ts

@@ -6,13 +6,22 @@
  * @property {function} getFile - Get file by parameters.
  */
 interface IFileUploading {
-    upload(data: Event, userQuery?: IUploadingQuery): Promise<IUploadingReturns>;
-    delete(filename: string, userQuery?: IUploadingQuery): Promise<any>;
+    upload(data: Event, fileQuery?: IUploadingQuery): Promise<IUploadingReturns>;
+    delete(filename: string, fileQuery?: IUploadingQuery): Promise<any>;
     getFile(id: number, type: string, entity: string, filename?: string): Promise<IFileEntity>;
 }
 interface IFileEntity {
     file: File | string | null;
 }
+/**
+ * @interface
+ * @property {string} type - Type, determines the folder name in the storage.
+ * @property {string} entity - Entity name from which the file is uploaded, determines the folder name in the storage.
+ * @property {number} id - Identifier of the object from which the file is uploaded, determines the folder name in the storage.
+ * @property {number} [width] - Width parameter.
+ * @property {number} [height] - Height parameter.
+ * @property {boolean} [compress] - Flag of optimization (compression) for images.
+ */
 interface IUploadingQuery {
     type?: string | null;
     entity?: string | null;
@@ -22,6 +31,12 @@ interface IUploadingQuery {
     compress?: boolean | null;
     [key: string]: string | number | boolean | null;
 }
+/**
+ * @interface
+ * @property {string} filename - Filename with relative path.
+ * @property {string} downloadLink - Link for downloading the file.
+ * @property {number} size - Size of the file in bytes.
+ */
 interface IUploadingReturns {
     filename: string;
     downloadLink: string;

package/dist/forms/formsInterfaces.d.ts

@@ -1,4 +1,4 @@
-import { IAttributeValues, ILocalizeInfos } from "../base/utils";
+import { IAttributes, ILocalizeInfos } from "../base/utils";
 /**
  * Represents an interface object of Forms Api.
  *
@@ -19,20 +19,20 @@ interface IForms {
  * @property {string} processingType - Type of form processing.
  * @property {ILocalizeInfos} localizeInfos - The name of the form, taking into account localization.
  * @property {object} processingData - Form data.
- * @property {IAttributeValues} attributeValues - The attributes with values used by the object.
+ * @property {IAttributes} attribute - Array of attribute values from the used attribute set for displaying the form (taking into account the specified language)
  * @property {number} version - The version number of the object.
  * @property {string} identifier - The textual identifier for the record field.
  * @property {number} position - The position of the object.
  */
 interface IFormsEntity {
-    id: number;
     attributeSetId: number;
-    processingType: string;
+    attributes: IAttributes;
+    id: number;
+    identifier: string;
     localizeInfos: ILocalizeInfos;
+    position: number;
     processingData: object | string;
-    attributes: IAttributeValues;
+    processingType: string;
     version: number;
-    identifier: string;
-    position: number;
 }
 export { IForms, IFormsEntity };

package/dist/formsData/formsDataInterfaces.d.ts

@@ -20,6 +20,7 @@ interface IFormsData {
  * @property {string} formIdentifier - The identifier of the page.
  * @property {Date | string} time - The identifier of the form.
  * @property {IFormData} formData - The identifier of the position.
+ * @property {string} attributeSetIdentifier - Text identifier (marker) of the used attribute set.
  */
 interface IFormsDataEntity {
     id: number;

package/dist/pages/pagesInterfaces.d.ts

@@ -1,6 +1,4 @@
-import { AttributeType, LangType, LocalizeType, Types } from "../base/utils";
-import { IAttributeSetEntity } from "../base/utils";
-import { IFormsEntity } from "../forms/formsInterfaces";
+import { AttributeType, IAttributes, LangType, LocalizeType, Types } from "../base/utils";
 /**
  * Represents an interface object of Pages Api.
  *
@@ -50,29 +48,25 @@ interface IPageConfig {
  *
  * @interface
  * @property {number} id - The identifier of the object.
- * @property {Date | string} updatedDate - The date of last updated.
  * @property {number} version - The version number of the object.
  * @property {string} identifier - The textual identifier for the record field.
- * @property {IAttributesSets} attributesSets - The attributes with values used by the object.
+ * @property {IAttributes} attributes - Array of attribute values from the used attribute set for displaying the form (taking into account the specified language).
  * @property {number} attributeSetId - The identifier of the attribute set being used.
  * @property {string} processingType - Type of form processing.
- * @property {ILocalizeInfos} localizeInfos - The name of the page, taking into account localization.
+ * @property {LocalizeType} localizeInfos - The name of the page, taking into account localization.
  * @property {object} processingData - Form data.
  * @property {number} position - The position of the object.
- * @property {number} positionId - The position id.
  */
 interface IPositionForm {
     id: number;
-    updatedDate: Date | string;
     version: number;
     identifier: string;
-    attributesSets: IAttributeSetEntity;
+    attributes: IAttributes;
     attributeSetId: number;
     processingType: string;
     localizeInfos: LocalizeType;
     processingData: object;
     position: number;
-    positionId: number;
 }
 /**
  * Represents an object with various properties.
@@ -87,29 +81,15 @@ interface IPositionForm {
  * @property {boolean} isVisible - A sign of page visibility.
  * @property {number} products - The number of products linked to the page.
  * @property {number} attributeSetId - Set of attributes id.
- * @property {Array<IFormsEntity>} forms - Array of identifier values of the Form Entity objects to which the page is linked (optional).
- * @property {Array<IFormsEntity>} blocks - array of identifier values of BlockEntity objects to which the page is linked (optional).
  * @property {boolean} isSync - Indication of page indexing.
  * @property {string} templateIdentifier - User id of the linked template.
- * @property {Array<[langCode:string]:object>} 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 {
-    id: number;
-    parentId: number | null;
-    config: Record<string, number>;
-    pageUrl: string;
-    depth: number;
-    localizeInfos: LocalizeType;
-    isVisible: boolean;
-    products: number;
     attributeSetId: number;
-    forms?: Array<IFormsEntity>;
-    blocks?: Array<object>;
-    isSync: boolean;
-    templateIdentifier: string;
     /**
      * Language-specific attribute values.
      * @example attributeValues['en_US']
@@ -117,8 +97,18 @@ interface IPagesEntity {
      * @property {langCode.<object>}
      */
     attributeValues: AttributeType;
+    childrenCount: number;
+    config: Record<string, number>;
+    depth: number;
+    id: number;
+    isSync: boolean;
+    isVisible: boolean;
+    localizeInfos: LocalizeType;
+    pageUrl: string;
+    parentId: number | null;
     position: number;
+    products: number;
+    templateIdentifier: string;
     type: Types;
-    childrenCount: number;
 }
 export { IPageApi, IPageConfig, IPagesEntity, IPositionForm };

package/dist/products/productsInterfaces.d.ts

@@ -97,7 +97,6 @@ interface IFilterParams {
  * @property {boolean} isVisible - A sign of page visibility.
  * @property {number | null} statusId - Product page status identifiers (may be null).
  * @property {Array<number>} relatedIds - Ids of related product pages.
- * @property {object} productPages - ProductPageEntity objects associated with the product page.
  * @property {number} attributeSetId - Set of attributes id.
  * @property {boolean} isSync - Indication of page indexing.
  * @property {number} price - The value of the product page price taken from the index.
@@ -111,11 +110,6 @@ interface IProductsEntity {
     isVisible: boolean;
     statusId: number | null;
     relatedIds: number[];
-    productPages: {
-        id: number;
-        pageId: number;
-        productId: number;
-    }[];
     attributeSetId: number;
     isSync: number | boolean;
     price: number;

package/dist/templates/templatesInterfaces.d.ts

@@ -1,3 +1,4 @@
+import { IGeneralTypesEntity } from "../general-types/generalTypesInterfaces";
 import { ILocalizeInfos, Types } from "../base/utils";
 /**
  * Represents an interface object of Templates Api.
@@ -15,7 +16,7 @@ interface ITemplatesApi {
  *
  * @interface
  * @property {number} id - The unique identifier of the position.
- * @property {Date | string} updatedDate - The date of last updated.
+ * @property {Date | string} updateDate - The date of last updated.
  * @property {number} version - The version number of the object.
  * @property {string} identifier - The textual identifier for the record field.
  * @property {IGeneralTypesEntity} generalType - General type Entity object.
@@ -23,6 +24,7 @@ interface ITemplatesApi {
  * @property {ILocalizeInfos} localizeInfos - The name of the template, taking into account localization.
  * @property {number} position - The position of the object.
  * @property {number | string} positionId - Id of the item object.
+ * @property {Types} generalTypeName - General type name.
  *
  */
 interface ITemplateEntity {
@@ -30,10 +32,11 @@ interface ITemplateEntity {
     updateDate: string | Date;
     version: number;
     identifier: string;
-    isSync: boolean;
+    generalType: IGeneralTypesEntity;
     generalTypeId: number;
     localizeInfos: ILocalizeInfos;
     position: number;
+    positionId: number;
     generalTypeName: Types;
 }
 export { ITemplatesApi, ITemplateEntity };

package/package.json

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