oneentry 1.0.10 → 1.0.13

package/README.md

@@ -83,111 +83,13 @@ Example return:
     "permissions": {
       "menu.create": true
     },
-    "selectedLanguage": "ru_RU",
-    "selectedContentLanguage": "ru_RU",
+    "selectedLanguage": "en_US",
+    "selectedContentLanguage": "en_US",
     "selectedUITheme": "DARK"
   }
 ]
 ```
 
-## AttributeSetApi
-
-```
-const { AttributeSet } = defineOneEntry('your-url')
-```
-
-### getAttributeSetById
-
-```
-const value = await AttributeSet.getAttributeSetById(1)
-```
-
-> This method retrieves a single attribute set object based on its identifier (id) from the API. It returns a Promise that resolves to the attribute set object.
-
-Example return:
-```
-{
-  "id": 1764,
-  "updatedDate": "2023-09-23T12:19:44.803Z",
-  "version": 10,
-  "identifier": "catalog",
-  "typeId": 1,
-  "localizeInfos": {
-    "ru_RU": {
-      "title": "Набор для страниц"
-    }
-  },
-  "schema": {
-    "attribute1": {
-      "id": 1,
-      "type": "string",
-      "isPrice": false,
-      "original": true,
-      "identifier": "stroka",
-      "localizeInfos": {
-        "ru_RU": {
-          "title": "Строка"
-        }
-      }
-    }
-  },
-  "position": {
-    "id": 12,
-    "objectId": 1,
-    "objectType": "attribute-set",
-    "position": "0|hzzzzz:"
-  },
-  "positionId": "0|hzzzzz:",
-  "isVisible": true
-}
-```
-
-### getAttributeSetByMarker
-
-```
-const value = await AttributeSet.getAttributeSetByMarker('marker')
-```
-
-> This method retrieves a single attribute set object based on its marker (marker) from the API. It returns a Promise that resolves to the attribute set object.
-
-Example return:
-```
-{
-  "id": 1764,
-  "updatedDate": "2023-09-23T12:21:39.906Z",
-  "version": 10,
-  "identifier": "catalog",
-  "typeId": 1,
-  "localizeInfos": {
-    "ru_RU": {
-      "title": "Набор для страниц"
-    }
-  },
-  "schema": {
-    "attribute1": {
-      "id": 1,
-      "type": "string",
-      "isPrice": false,
-      "original": true,
-      "identifier": "stroka",
-      "localizeInfos": {
-        "ru_RU": {
-          "title": "Строка"
-        }
-      }
-    }
-  },
-  "position": {
-    "id": 12,
-    "objectId": 1,
-    "objectType": "attribute-set",
-    "position": "0|hzzzzz:"
-  },
-  "positionId": "0|hzzzzz:",
-  "isVisible": true
-}
-```
-
 ## FormApi
 
 const { Forms } = defineOneEntry('your-url');
@@ -214,8 +116,8 @@ Example return:
   "attributeSetId": 0,
   "processingType": "email",
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Моя форма",
+    "en_US": {
+      "title": "My form",
       "titleForSite": "",
       "successMessage": "",
       "unsuccessMessage": "",
@@ -264,8 +166,8 @@ Example return:
   "attributeSetId": 0,
   "processingType": "email",
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Моя форма",
+    "en_US": {
+      "title": "My form",
       "titleForSite": "",
       "successMessage": "",
       "unsuccessMessage": "",
@@ -315,8 +217,8 @@ Example return:
   "attributeSetId": 0,
   "processingType": "email",
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Моя форма",
+    "en_US": {
+      "title": "My form",
       "titleForSite": "",
       "successMessage": "",
       "unsuccessMessage": "",
@@ -364,9 +266,9 @@ Example return:
   "time": "2023-02-12 10:56",
   "formData": [
     {
-      "marker": "naimenovanie_1",
-      "value": "Наименование",
-      "langCode": "ru_RU"
+      "marker": "name_1",
+      "value": "Name",
+      "langCode": "en_US"
     }
   ]
 }
@@ -390,9 +292,9 @@ Example return:
     "time": "2023-02-12 10:56",
     "formData": [
       {
-        "marker": "naimenovanie_1",
-        "value": "Наименование",
-        "langCode": "ru_RU"
+        "marker": "name_1",
+        "value": "Name",
+        "langCode": "en_US"
       }
     ]
   }
@@ -417,9 +319,9 @@ Example return:
     "time": "2023-02-12 10:56",
     "formData": [
       {
-        "marker": "naimenovanie_1",
-        "value": "Наименование",
-        "langCode": "ru_RU"
+        "marker": "name_1",
+        "value": "Name",
+        "langCode": "en_US"
       }
     ]
   }
@@ -466,8 +368,8 @@ Example return:
 [
   {
     "id": 1764,
-    "shortCode": "ru",
-    "code": "ru_RU",
+    "shortCode": "en",
+    "code": "en_US",
     "name": "Bengali",
     "nativeName": "বাংলা",
     "isActive": false,
@@ -498,8 +400,8 @@ Example return:
   "id": 1764,
   "identifier": "catalog",
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Главное меню"
+    "en_US": {
+      "title": "Main menu"
     }
   },
   "pages": [
@@ -519,49 +421,7 @@ Example return:
   ]
 }
 ```
-## ModulesApi
-
-```
-const { Modules } = defineOneEntry('your-url')
-```
 
-### getAllModules
-
-```
-const value = await Modules.getAllModules()
-```
-
-> This method retrieves all modules from the API. It returns a Promise that resolves to an array of BaseModuleDto objects or an empty array [] if there is no data.
-
-Example return:
-```
-[
-  {
-    "identifier": "catalog",
-    "isVisible": true,
-    "type": null,
-    "localizeInfos": {
-      "ru_RU": {
-        "title": "Каталог"
-      }
-    },
-    "icon": "mdi mdi-account-key",
-    "generalTypes": [
-      {
-        "id": 1,
-        "type": "service"
-      },
-      {
-        "id": 2,
-        "type": "forCatalogPages"
-      }
-    ],
-    "attributeSetTypes": [],
-    "position": "0|hzzzzz:",
-    "positionId": 12
-  }
-]
-```
 ## PagesApi
 
 ```
@@ -589,10 +449,10 @@ Example return:
     "pageUrl": "string",
     "depth": 3,
     "localizeInfos": {
-      "ru_RU": {
-        "title": "Каталог",
-        "content": "Контент для каталога",
-        "menuTitle": "Каталог"
+      "en_US": {
+        "title": "Catalog",
+        "content": "Content from catalog",
+        "menuTitle": "Catalog"
       }
     },
     "isVisible": true,
@@ -641,10 +501,10 @@ Example return:
     "pageUrl": "string",
     "depth": 3,
     "localizeInfos": {
-      "ru_RU": {
-        "title": "Каталог",
-        "content": "Контент для каталога",
-        "menuTitle": "Каталог"
+      "en_US": {
+        "title": "Catalog",
+        "content": "Content from catalog",
+        "menuTitle": "Catalog"
       }
     },
     "isVisible": true,
@@ -692,10 +552,10 @@ Example return:
     "pageUrl": "string",
     "depth": 3,
     "localizeInfos": {
-      "ru_RU": {
-        "title": "Каталог",
-        "content": "Контент для каталога",
-        "menuTitle": "Каталог"
+      "en_US": {
+        "title": "Catalog",
+        "content": "Content for catalog",
+        "menuTitle": "Catalog"
       }
     },
     "isVisible": true,
@@ -737,10 +597,10 @@ const value = await Pages.getPageById(1, 'en_US')
   "pageUrl": "string",
   "depth": 3,
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Каталог",
-      "content": "Контент для каталога",
-      "menuTitle": "Каталог"
+    "en_US": {
+      "title": "Catalog",
+      "content": "Content from catalog",
+      "menuTitle": "Catalog"
     }
   },
   "isVisible": true,
@@ -780,10 +640,10 @@ Example return:
   "pageUrl": "string",
   "depth": 3,
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Каталог",
-      "content": "Контент для каталога",
-      "menuTitle": "Каталог"
+    "en_US": {
+      "title": "Catalog",
+      "content": "Content from catalog",
+      "menuTitle": "Catalog"
     }
   },
   "isVisible": true,
@@ -837,8 +697,8 @@ Example return:
   {
   "id": 1764,
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Товар"
+    "en_US": {
+      "title": "Product"
     }
   },
   "isVisible": true,
@@ -895,6 +755,22 @@ sortOrder: 'DESC',
 sortKey: 'id'
 }
 ```
+"conditionMarker" by which values are filtered (not set by default), possible values:
+> 'in' - Contains,
+> 
+> 'nin' - Does not contain,
+> 
+> 'eq' - Equal,
+> 
+> 'neq' - Not equal,
+> 
+> 'mth' - Greater than,
+> 
+> 'lth' - Less than,
+> 
+> 'exs' - Exists,
+> 
+> 'nexs' - Does not exist
 
 ### getProducts
 
@@ -909,8 +785,8 @@ Example return:
 {
   "id": 1764,
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Товар"
+    "en_US": {
+      "title": "Product"
     }
   },
   "isVisible": true,
@@ -958,8 +834,8 @@ Example return:
 {
   "id": 1764,
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Товар"
+    "en_US": {
+      "title": "Product"
     }
   },
   "isVisible": true,
@@ -1007,8 +883,8 @@ Example return:
 {
   "id": 1764,
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Товар"
+    "en_US": {
+      "title": "Product"
     }
   },
   "isVisible": true,
@@ -1056,8 +932,8 @@ Example return:
 {
   "id": 1764,
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Товар"
+    "en_US": {
+      "title": "Product"
     }
   },
   "isVisible": true,
@@ -1105,8 +981,8 @@ Example return:
 {
   "id": 1764,
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Товар"
+    "en_US": {
+      "title": "Product"
     }
   },
   "isVisible": true,
@@ -1153,8 +1029,8 @@ Example return:
 {
   "id": 1764,
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Товар"
+    "en_US": {
+      "title": "Product"
     }
   },
   "isVisible": true,
@@ -1219,8 +1095,8 @@ Example return:
 {
   "id": 1764,
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Товар"
+    "en_US": {
+      "title": "Product"
     }
   },
   "isVisible": true,
@@ -1268,8 +1144,8 @@ Example return:
   {
   "id": 1764,
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Товар"
+    "en_US": {
+      "title": "Product"
     }
   },
   "isVisible": true,
@@ -1346,8 +1222,8 @@ Example return:
     "version": 10,
     "identifier": "catalog",
     "localizeInfos": {
-      "ru_RU": {
-        "title": "Статус 1"
+      "en_US": {
+        "title": "Status 1"
       }
     }
   }
@@ -1369,8 +1245,8 @@ Example return:
   "version": 10,
   "identifier": "catalog",
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Статус 1"
+    "en_US": {
+      "title": "Status 1"
     }
   }
 }
@@ -1391,8 +1267,8 @@ Example return:
   "version": 10,
   "identifier": "catalog",
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Статус 1"
+    "en_US": {
+      "title": "Status 1"
     }
   }
 }
@@ -1453,8 +1329,8 @@ Example return:
   },
   "generalTypeId": 4,
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Шаблон страниц"
+    "en_US": {
+      "title": "Page template"
     }
   },
   "position": {
@@ -1493,8 +1369,8 @@ Example return:
   },
   "generalTypeId": 4,
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Шаблон страниц"
+    "en_US": {
+      "title": "Page template"
     }
   },
   "position": {
@@ -1534,8 +1410,8 @@ Example return:
     },
     "attributeSetId": 0,
     "localizeInfos": {
-      "ru_RU": {
-        "title": "Шаблон страниц"
+      "en_US": {
+        "title": "Page tamplate"
       }
     },
     "position": {
@@ -1570,8 +1446,8 @@ Example return:
   },
   "attributeSetId": 0,
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Шаблон страниц"
+    "en_US": {
+      "title": "Page template"
     }
   },
   "position": {
@@ -1605,8 +1481,8 @@ Example return:
   },
   "attributeSetId": 0,
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Шаблон страниц"
+    "en_US": {
+      "title": "Page template"
     }
   },
   "position": {

package/dist/_cjs/admins/adminsApi.d.ts

@@ -0,0 +1,14 @@
+import OneEntry from "../base/oneEntry";
+import { IAdminEntity, IAdmins } from "./adminsInterfaces";
+/**
+ * Controllers for working with users - admins
+ */
+export default class AdminsApi extends OneEntry implements IAdmins {
+    constructor(url: string);
+    /**
+     * Get all user objects - admins.
+     *
+     * @returns Returns all AdminEntity user objects
+     */
+    getAdminsInfo(): Promise<IAdminEntity>;
+}

package/dist/_cjs/admins/adminsApi.js

@@ -0,0 +1,34 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const oneEntry_1 = require("../base/oneEntry");
+/**
+ * Controllers for working with users - admins
+ */
+class AdminsApi extends oneEntry_1.default {
+    constructor(url) {
+        super(url);
+        this._url += '/api/content/admins';
+    }
+    /**
+     * Get all user objects - admins.
+     *
+     * @returns Returns all AdminEntity user objects
+     */
+    getAdminsInfo() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this._fetchGet('');
+            return result;
+        });
+    }
+}
+exports.default = AdminsApi;
+//# sourceMappingURL=adminsApi.js.map

package/dist/_cjs/admins/adminsApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adminsApi.js","sourceRoot":"","sources":["../../../src/admins/adminsApi.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,+CAAwC;AAGxC;;GAEG;AACH,MAAqB,SAAU,SAAQ,kBAAQ;IAC3C,YAAY,GAAW;QACnB,KAAK,CAAC,GAAG,CAAC,CAAA;QACV,IAAI,CAAC,IAAI,IAAI,qBAAqB,CAAA;IACtC,CAAC;IAED;;;;OAIG;IACU,aAAa;;YACtB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;YACvC,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;CACJ;AAfD,4BAeC"}

package/dist/_cjs/admins/adminsInterfaces.d.ts

@@ -0,0 +1,32 @@
+interface IAdmins {
+    getAdminsInfo(): Promise<IAdminEntity>;
+}
+interface IPosition {
+    id: number;
+    position: string;
+    objectId: number;
+    objectType: string;
+    isLocked: boolean;
+    objectCategoryId: number;
+}
+interface IAttributesSets {
+    [key: string]: string;
+}
+interface IAdminEntity {
+    id: number;
+    updatedDate: string;
+    version: number;
+    identifier: string;
+    attributesSets: IAttributesSets;
+    attributeSetId: number;
+    login: string;
+    email?: string;
+    restorePasswordCode: number;
+    position: IPosition;
+    positionId: number;
+    permissions: Record<string, boolean>;
+    selectedLanguage: string;
+    selectedContentLanguage: string;
+    selectedUITheme: string;
+}
+export { IAdmins, IAdminEntity };

package/dist/_cjs/admins/adminsInterfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=adminsInterfaces.js.map

package/dist/_cjs/admins/adminsInterfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adminsInterfaces.js","sourceRoot":"","sources":["../../../src/admins/adminsInterfaces.ts"],"names":[],"mappings":""}

package/dist/_cjs/attribute-set/attributeSetApi.d.ts

@@ -0,0 +1,24 @@
+import OneEntry from "../base/oneEntry";
+import { IAttributeSet, IAttributeSetEntity } from "./attributeSetInterfaces";
+/**
+ * Controllers for working with attribute sets
+ */
+export default class AttributeSetApi extends OneEntry implements IAttributeSet {
+    constructor(url: string);
+    /**
+     * Get one attributes set object.
+     *
+     * @param {number} [id] - Identifier of the attributes set object
+     *
+     * @returns Returns one attributes set object
+     */
+    getAttributeSetById(id: number): Promise<IAttributeSetEntity>;
+    /**
+     * Get one attributes set object by marker.
+     *
+     * @param {string} [marker] - Marker of the attributes set object
+     *
+     * @returns Returns one attributes set object
+     */
+    getAttributeSetByMarker(marker: string): Promise<IAttributeSetEntity>;
+}