oneentry 1.0.16 → 1.0.18

package/README.md

@@ -50,7 +50,7 @@ const api = defineOneEntry('your-url')
 
 The OneEntry Headless CMS SDK contains two classes: ProductApi and PageApi.
 
-## AdminsApi
+## Admins
 
 ```
 const { Admins } = defineOneEntry('your-url')
@@ -70,35 +70,25 @@ Example return:
 [
   {
     "id": 1764,
-    "updatedDate": "2023-09-23T12:06:18.345Z",
-    "version": 10,
-    "identifier": "catalog",
-    "attributesSets": {
-      "string_id19": "",
-      "string_id18": ""
-    },
-    "attributeSetId": 0,
+    "identifier": "admin1",
+    "attributeSetId": 7,
+    "isSync": false,
     "login": "meteor",
-    "email": "meteor@mydomen.ru",
-    "restorePasswordCode": "",
-    "position": {
-      "id": 12,
-      "objectId": 1,
-      "objectType": "module",
-      "position": "0|hzzzzz:"
-    },
-    "positionId": "0|hzzzzz:",
-    "permissions": {
-      "menu.create": true
+    "email": "meteor@mydomen.com",
+    "attributeValues": {
+      "en_US": {
+        "marker": {
+          "value": "",
+          "type": "string"
+        }
+      }
     },
-    "selectedLanguage": "en_US",
-    "selectedContentLanguage": "en_US",
-    "selectedUITheme": "DARK"
+    "position": 192
   }
 ]
 ```
 
-## FormApi
+## Forms
 
 const { Forms } = defineOneEntry('your-url');
 
@@ -112,94 +102,36 @@ const value = await Forms.getAllForms()
 
 Example return: 
 ```
-{
-  "id": 1764,
-  "updatedDate": "2023-09-27T20:07:14.793Z",
-  "version": 10,
-  "identifier": "catalog",
-  "attributesSets": {
-    "string_id19": "",
-    "string_id18": ""
-  },
-  "attributeSetId": 0,
-  "processingType": "email",
-  "localizeInfos": {
-    "en_US": {
-      "title": "My form",
-      "titleForSite": "",
-      "successMessage": "",
-      "unsuccessMessage": "",
-      "urlAddress": "",
-      "database": "0",
-      "script": "0"
-    }
-  },
-  "processingData": {},
-  "formPages": [
-    {
-      "id": 1764,
-      "pageId": 1764,
-      "formId": 164,
-      "positionId": null,
-      "position": {
-        "id": 12,
-        "objectId": 1,
-        "objectType": "page",
-        "position": "0|hzzzzz:"
+[
+  {
+    "id": 1764,
+    "attributeSetId": 0,
+    "processingType": "email",
+    "localizeInfos": {
+      "ru_RU": {
+        "title": "My form",
+        "titleForSite": "",
+        "successMessage": "",
+        "unsuccessMessage": "",
+        "urlAddress": "",
+        "database": "0",
+        "script": "0"
       }
-    }
-  ]
-}
-```
-
-### getFormById
-
-```
-const value = await Forms.getFormById(1)
-```
-
-> This method retrieves a single form object based on its identifier (id) from the API. It returns a Promise that resolves to a FormEntity object.
-
-Example return:
-```
-{
-  "id": 1764,
-  "updatedDate": "2023-09-27T20:10:37.321Z",
-  "version": 10,
-  "identifier": "catalog",
-  "attributesSets": {
-    "string_id19": "",
-    "string_id18": ""
-  },
-  "attributeSetId": 0,
-  "processingType": "email",
-  "localizeInfos": {
-    "en_US": {
-      "title": "My form",
-      "titleForSite": "",
-      "successMessage": "",
-      "unsuccessMessage": "",
-      "urlAddress": "",
-      "database": "0",
-      "script": "0"
-    }
-  },
-  "processingData": {},
-  "formPages": [
-    {
-      "id": 1764,
-      "pageId": 1764,
-      "formId": 164,
-      "positionId": null,
-      "position": {
-        "id": 12,
-        "objectId": 1,
-        "objectType": "page",
-        "position": "0|hzzzzz:"
+    },
+    "processingData": "Unknown Type: ProcessingData",
+    "attributeValues": {
+      "en_US": {
+        "marker": {
+          "value": "",
+          "type": "string"
+        }
       }
-    }
-  ]
-}
+    },
+    "version": 10,
+    "identifier": "catalog",
+    "position": 192
+  }
+]
 ```
 
 ### getFormByMarker
@@ -215,18 +147,11 @@ Example return:
 ```
 {
   "id": 1764,
-  "updatedDate": "2023-09-27T20:14:05.333Z",
-  "version": 10,
-  "identifier": "catalog",
-  "attributesSets": {
-    "string_id19": "",
-    "string_id18": ""
-  },
   "attributeSetId": 0,
   "processingType": "email",
   "localizeInfos": {
-    "en_US": {
-      "title": "My form",
+    "ru_RU": {
+      "title": "Моя форма",
       "titleForSite": "",
       "successMessage": "",
       "unsuccessMessage": "",
@@ -235,25 +160,22 @@ Example return:
       "script": "0"
     }
   },
-  "processingData": {},
-  "formPages": [
-    {
-      "id": 1764,
-      "pageId": 1764,
-      "formId": 164,
-      "positionId": null,
-      "position": {
-        "id": 12,
-        "objectId": 1,
-        "objectType": "page",
-        "position": "0|hzzzzz:"
+  "processingData": "Unknown Type: ProcessingData",
+  "attributeValues": {
+    "en_US": {
+      "marker": {
+        "value": "",
+        "type": "string"
       }
     }
-  ]
+  },
+  "version": 10,
+  "identifier": "catalog",
+  "position": 192
 }
 ```
 
-## FormsDataApi
+## FormsData
 
 const { FormsData } = defineOneEntry('your-url');
 
@@ -272,13 +194,14 @@ Example return:
   "id": 1764,
   "formIdentifier": "my-form",
   "time": "2023-02-12 10:56",
-  "formData": [
-    {
-      "marker": "name_1",
-      "value": "Name",
-      "langCode": "en_US"
-    }
-  ]
+  "formData": {
+    "en_US": [
+      {
+        "marker": "naimenovanie_1",
+        "value": "Name"
+      }
+    ]
+  }
 }
 ```
 
@@ -298,13 +221,14 @@ Example return:
     "id": 1764,
     "formIdentifier": "my-form",
     "time": "2023-02-12 10:56",
-    "formData": [
-      {
-        "marker": "name_1",
-        "value": "Name",
-        "langCode": "en_US"
-      }
-    ]
+    "formData": {
+      "en_US": [
+        {
+          "marker": "naimenovanie_1",
+          "value": "Name"
+        }
+      ]
+    }
   }
 ]
 ```
@@ -320,23 +244,22 @@ const value = await FormsData.getFormsDataByMarker('my-marker')
 Example return:
 
 ```
-[
-  {
-    "id": 1764,
-    "formIdentifier": "my-form",
-    "time": "2023-02-12 10:56",
-    "formData": [
+{
+  "id": 1764,
+  "formIdentifier": "my-form",
+  "time": "2023-02-12 10:56",
+  "formData": {
+    "en_US": [
       {
-        "marker": "name_1",
-        "value": "Name",
-        "langCode": "en_US"
+        "marker": "naimenovanie_1",
+        "value": "Name"
       }
     ]
   }
-]
+}
 ```
 
-## GeneralTypesApi
+## GeneralTypes
 
 const { GeneralTypes } = defineOneEntry('your-url');
 
@@ -357,7 +280,7 @@ Example return:
   }
 ]
 ```
-## LocalesApi
+## Locales
 
 ```
 const { Locales } = defineOneEntry('your-url')
@@ -366,7 +289,7 @@ const { Locales } = defineOneEntry('your-url')
 ### getLocales
 
 ```
-const value = Locales.await getLocales()
+const value = await Locales.getLocales()
 ```
 
 > This method retrieves all active language localization objects from the API. It returns a Promise that resolves to an array of LocaleEntity objects.
@@ -382,12 +305,12 @@ Example return:
     "nativeName": "বাংলা",
     "isActive": false,
     "image": "🇦🇨",
-    "position": "0|hzzzzz:"
+    "position": 1
   }
 ]
 ```
 
-## MenusApi
+## Menus
 
 ```
 const { Menus } = defineOneEntry('your-url')
@@ -430,7 +353,7 @@ Example return:
 }
 ```
 
-## PagesApi
+## Pages
 
 ```
 const { Pages } = defineOneEntry('your-url')
@@ -742,7 +665,7 @@ Example return:
 ]
 ```
 
-## ProductsApi
+## Products
 
 ```
 const { Products } = defineOneEntry('your-url')
@@ -752,15 +675,15 @@ This module accepts a set of user parameters called userQuery. If the parameters
 
 ```
 {
-offset: 0,
-limit: 30,
-statusMarker: null,
-conditionValue: null,
-conditionMarker: null,
-attributeMarker: null,
-langCode: 'en_US',
-sortOrder: 'DESC',
-sortKey: 'id'
+    offset: 0,
+    limit: 30,
+    statusMarker: null,
+    conditionValue: null,
+    conditionMarker: null,
+    attributeMarker: null,
+    langCode: 'en_US',
+    sortOrder: 'DESC',
+    sortKey: 'id'
 }
 ```
 "conditionMarker" by which values are filtered (not set by default), possible values:
@@ -1188,26 +1111,8 @@ Example return:
 }
 ]
 ```
-### getAttributesByProductId
-
-```
-const value = await Products.getAttributesByProductId(1)
-```
 
-> This method retrieves all attributes of a product based on its identifier (id) from the API. It returns a Promise that resolves to an array of set attributes for the product.
-
-Example return:
-```
-{
-  "en_US": {
-    "marker": {
-      "value": "",
-      "type": "string"
-    }
-  }
-}
-```
-## ProductStatusApi
+## ProductStatus
 
 ```
 const { ProductStatus } = defineOneEntry('your-url');
@@ -1293,7 +1198,7 @@ Example return:
 ```
 true
 ```
-## TemplatesApi
+## Templates
 
 ```
 const { Templates } = defineOneEntry('your-url')
@@ -1309,88 +1214,68 @@ const value = await Templates.getAllTemplates()
 
 Example return:
 ```
-string
+[
+  {
+    "id": 1764,
+    "identifier": "admin1",
+    "attributeSetId": 7,
+    "generalTypeId": 2,
+    "generalTypeName": "forProductPreview",
+    "localizeInfos": {
+      "ru_RU": {
+        "title": "Product"
+      }
+    },
+    "isSync": false,
+    "attributeValues": {
+      "en_US": {
+        "marker": {
+          "value": "",
+          "type": "string"
+        }
+      }
+    },
+    "position": 192
+  }
+]
 ```
-### getTemplateById
+### getTemplateByType
 
 ```
-const value = await Templates.getTemplateById(1)
+const value = await Templates.getTemplateById('forCatalogProducts')
 ```
 
 > This method retrieves a single template object based on its identifier (id) from the API. It returns a Promise that resolves to a template object.
 
 Example return:
 ```
-{
-  "id": 1764,
-  "updatedDate": "2023-09-25T13:49:05.070Z",
-  "version": 10,
-  "identifier": "catalog",
-  "attributesSets": {
-    "string_id19": "",
-    "string_id18": ""
-  },
-  "attributeSetId": 0,
-  "generalType": {
-    "id": 4,
-    "type": "forCatalogPages"
-  },
-  "generalTypeId": 4,
-  "localizeInfos": {
-    "en_US": {
-      "title": "Page template"
-    }
-  },
-  "position": {
-    "id": 12,
-    "objectId": 1,
-    "objectType": "module",
-    "position": "0|hzzzzz:"
-  },
-  "positionId": "0|hzzzzz:"
-}
-```
-### getTemplateByMarker
-
-```
-const value = await Templates.getTemplateByMarker(1)
+[
+  {
+    "id": 1764,
+    "identifier": "admin1",
+    "attributeSetId": 7,
+    "generalTypeId": 2,
+    "generalTypeName": "forCatalogProducts",
+    "localizeInfos": {
+      "ru_RU": {
+        "title": "Product"
+      }
+    },
+    "isSync": false,
+    "attributeValues": {
+      "en_US": {
+        "marker": {
+          "value": "",
+          "type": "string"
+        }
+      }
+    },
+    "position": 192
+  }
+]
 ```
 
-> This method retrieves a single template object based on its textual identifier (marker) from the API. It returns a Promise that resolves to a template object.
-
-Example return:
-
-```
-{
-  "id": 1764,
-  "updatedDate": "2023-09-25T13:49:43.355Z",
-  "version": 10,
-  "identifier": "catalog",
-  "attributesSets": {
-    "string_id19": "",
-    "string_id18": ""
-  },
-  "attributeSetId": 0,
-  "generalType": {
-    "id": 4,
-    "type": "forCatalogPages"
-  },
-  "generalTypeId": 4,
-  "localizeInfos": {
-    "en_US": {
-      "title": "Page template"
-    }
-  },
-  "position": {
-    "id": 12,
-    "objectId": 1,
-    "objectType": "module",
-    "position": "0|hzzzzz:"
-  },
-  "positionId": "0|hzzzzz:"
-}
-```
-## TemplatesPreviewApi
+## TemplatesPreview
 
 ```
 const { TemplatesPreview } = defineOneEntry('your-url')
@@ -1426,9 +1311,9 @@ Example return:
       "id": 12,
       "objectId": 1,
       "objectType": "module",
-      "position": "0|hzzzzz:"
+      "position": 1
     },
-    "positionId": "0|hzzzzz:"
+    "positionId": 1
   }
 ]
 ```
@@ -1462,9 +1347,9 @@ Example return:
     "id": 12,
     "objectId": 1,
     "objectType": "module",
-    "position": "0|hzzzzz:"
+    "position": 1
   },
-  "positionId": "0|hzzzzz:"
+  "positionId": 1
 }
 ```
 ### getTemplatesPreviewByMarker
@@ -1497,8 +1382,8 @@ Example return:
     "id": 12,
     "objectId": 1,
     "objectType": "module",
-    "position": "0|hzzzzz:"
+    "position": 1
   },
-  "positionId": "0|hzzzzz:"
+  "positionId": 1
 }
 ```

package/dist/admins/adminsApi.d.ts

@@ -10,5 +10,5 @@ export default class AdminsApi extends OneEntry implements IAdmins {
      *
      * @returns Returns all AdminEntity user objects
      */
-    getAdminsInfo(): Promise<IAdminEntity>;
+    getAdminsInfo(): Promise<Array<IAdminEntity>>;
 }

package/dist/admins/adminsInterfaces.d.ts

@@ -1,32 +1,67 @@
+/**
+ * Represents a interface object of Admins Api.
+ *
+ * @property {function} getAdminsInfo - Get all user objects - admins.
+ */
 interface IAdmins {
-    getAdminsInfo(): Promise<IAdminEntity>;
+    getAdminsInfo(): Promise<Array<IAdminEntity>>;
 }
+/**
+ * Represents a position object.
+ *
+ * @interface
+ * @property {number} id - The unique identifier of the position.
+ * @property {number} position - The position of the object.
+ * @property {number} objectId - The unique identifier of the object.
+ * @property {string} objectType - The type of the object.
+ * @property {boolean} isLocked - Indicates whether the position is locked or not.
+ * @property {number} objectCategoryId - The unique identifier of the object's category.
+ */
 interface IPosition {
     id: number;
-    position: string;
+    position: number;
     objectId: number;
     objectType: string;
-    isLocked: boolean;
-    objectCategoryId: number;
+    isLocked?: boolean;
+    objectCategoryId?: number;
 }
+/**
+ * Represents a position object.
+ *
+ * @interface
+ * @property {string} attr_name - Attributes with values used by the object.
+ */
 interface IAttributesSets {
     [key: string]: string;
 }
+/**
+ * Represents an object with various properties.
+ *
+ * @interface
+ * @property {number} id - The identifier of the object.
+ * @property {string} updatedDate - The date of when the object was 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 {number} attributeSetId - The identifier of the attribute set being used.
+ * @property {string} login - The login username.
+ * @property {string} email - The email address.
+ * @property {number} restorePasswordCode - The code for password restoration.
+ * @property {IPosition} position - The position of the object.
+ * @property {number} positionId - The identifier of the position object.
+ * @property {Record<string, boolean>} permissions - The user's available permissions.
+ * @property {string} selectedLanguage - The selected language for the interface.
+ * @property {string} selectedContentLanguage - The selected language for content.
+ * @property {string} selectedUITheme - The selected theme for the interface.
+ */
 interface IAdminEntity {
     id: number;
-    updatedDate: string;
-    version: number;
     identifier: string;
     attributesSets: IAttributesSets;
-    attributeSetId: number;
-    login: string;
+    isSync: boolean;
+    attributeSetId: number | null;
+    login?: string;
     email?: string;
-    restorePasswordCode: number;
     position: IPosition;
-    positionId: number;
-    permissions: Record<string, boolean>;
-    selectedLanguage: string;
-    selectedContentLanguage: string;
-    selectedUITheme: string;
 }
-export { IAdmins, IAdminEntity };
+export { IAdmins, IAdminEntity, IPosition };