oneentry 1.0.102 → 1.0.105

package/configure.js

@@ -6,44 +6,35 @@ const path = require('path');
 const readline = require('readline');
 
 const rl = readline.createInterface({
-    input: process.stdin,
-    output: process.stdout
+  input: process.stdin,
+  output: process.stdout
 });
 
 rl.question('Enter project name witht https://... : ', (name) => {
-    rl.question('Enter token: ', (token) => {
-        rl.close()
-        createInterface(name, token)
-    })
+  rl.question('Enter token: ', (token) => {
+    rl.close()
+    createInterface(name, token)
+  })
 })
 
 
 function createInterface(name, token) {
-    const filePath = 'example.ts'
-    fs.writeFile(filePath,
-
-        `
-type BuildInterface<T extends string[]> = {
-    [K in T[number]]: string | undefined;
-}
-
-interface IAttributesList extends BuildInterface<['${name}', '${token}', 'value3']> {}
-
-export {
-    IAttributesList
+  const filePath = 'example.ts'
+  fs.writeFile(filePath,
+    `
+      type BuildInterface<T extends string[]> = {
+          [K in T[number]]: string | undefined;
+      }
+      interface IAttributesList extends BuildInterface<['${name}', '${token}', 'value3']> {}
+      export {
+          IAttributesList
+      }
+    `,
+  (err) => {
+    if (err) {
+      console.error(err);
+      return;
+    }
+    console.log(`Successfully created ${filePath}`);
+  })
 }
-`
-
-
-        , (err) => {
-            if (err) {
-                console.error(err);
-                return;
-            }
-
-            console.log(`Successfully created ${filePath}`);
-        })
-}
-
-
-

package/dist/admins/adminsApi.d.ts

@@ -1,22 +1,26 @@
-import AsyncModules from "../base/asyncModules";
-import { IAdminEntity, IAdmins } from "./adminsInterfaces";
-import StateModule from "../base/stateModule";
-import { IError } from "../base/utils";
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { AttributeType, IError } from '../base/utils';
+import type { IAdminEntity, IAdmins } from './adminsInterfaces';
 /**
  * Controllers for working with users - admins
  */
 export default class AdminsApi extends AsyncModules implements IAdmins {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * '/api/content/admins'
+     */
     constructor(state: StateModule);
     /**
      * Get all user objects - admins.
      *
+     * @param {Array<any>} [body] - array of objects AttributeType
      * @param {string} [langCode] - Language code. Default "en_US"
-     * @param {number} [offset] - Parameter for pagination. Default 0
-     * @param {number} [limit] - Parameter for pagination. Default 30
+     * @param {number} [offset] - Optional parameter for pagination, default is 0
+     * @param {number} [limit] - Optional parameter for pagination, default is 30
      *
      * @returns Returns all AdminEntity user objects
      */
-    getAdminsInfo(langCode?: string, offset?: number, limit?: number): Promise<Array<IAdminEntity> | IError>;
+    getAdminsInfo(body?: Array<AttributeType>, langCode?: string, offset?: number, limit?: number): Promise<Array<IAdminEntity> | IError>;
 }

package/dist/admins/adminsApi.js

@@ -1,10 +1,16 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const asyncModules_1 = require("../base/asyncModules");
+const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with users - admins
  */
 class AdminsApi extends asyncModules_1.default {
+    /**
+     * '/api/content/admins'
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/admins';
@@ -12,14 +18,20 @@ class AdminsApi extends asyncModules_1.default {
     /**
      * Get all user objects - admins.
      *
+     * @param {Array<any>} [body] - array of objects AttributeType
      * @param {string} [langCode] - Language code. Default "en_US"
-     * @param {number} [offset] - Parameter for pagination. Default 0
-     * @param {number} [limit] - Parameter for pagination. Default 30
+     * @param {number} [offset] - Optional parameter for pagination, default is 0
+     * @param {number} [limit] - Optional parameter for pagination, default is 30
      *
      * @returns Returns all AdminEntity user objects
      */
-    async getAdminsInfo(langCode = this.state.lang, offset = 0, limit = 30) {
-        const response = await this._fetchGet(`?langCode=${langCode}&offset=${offset}&limit=${limit}`);
+    async getAdminsInfo(body = [], langCode = this.state.lang, offset = 0, limit = 30) {
+        const query = {
+            langCode,
+            offset,
+            limit,
+        };
+        const response = await this._fetchPost(`/?` + this._queryParamsToString(query), body);
         return this._normalizeData(response, langCode);
     }
 }

package/dist/admins/adminsInterfaces.d.ts

@@ -1,22 +1,22 @@
-import { AttributeType, IError } from "../base/utils";
+import type { AttributeType, IError } from '../base/utils';
 /**
  * Represents a interface object of Admins Api.
  *
- * @property {function} getAdminsInfo - Get all user objects - admins.
+ * @property {function} [getAdminsInfo] - Get all user objects - admins.
  */
 interface IAdmins {
-    getAdminsInfo(langCode: string, offset?: number, limit?: number): Promise<Array<IAdminEntity> | IError>;
+    getAdminsInfo(body: Array<AttributeType>, langCode: string, offset: number, limit: number): Promise<Array<IAdminEntity> | IError>;
 }
 /**
  * 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.
+ * @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;
@@ -30,19 +30,33 @@ interface IPosition {
  * Represents an object with various properties.
  *
  * @interface
- * @property {number} id - The identifier of the object.
- * @property {string} identifier - The textual identifier for the record field.
- * @property {Record<string, any>} attributeValues - The attributes with values used by the object.
- * @property {number} attributeSetId - The identifier of the attribute set being used.
- * @property {boolean} isSync - Indication of page indexing.
- * @property {number} position - The position of the object.
+ * @property {number} [id] - The identifier of the object.
+ * @property {string} [identifier] - The textual identifier for the record field.
+ * @property {number} [attributeSetId] - The identifier of the attribute set being used.
+ * @property {boolean} [isSync] - Indication of page indexing.
+ * @property {Record<string, any>} [attributesSets] - The attributes with values used by the object.
+ * @property {number} [position] - The position of the object.
  */
 interface IAdminEntity {
-    attributeSetId: number | null;
-    attributeValues: AttributeType;
     id: number;
     identifier: string;
+    attributeSetId: number | null;
     isSync: boolean;
-    position: number;
+    attributesSets: Record<string, any>;
+    position: number | null;
+    [key: string]: any;
+}
+/**
+ * Represents IAdmin query parameters object.
+ *
+ * @interface
+ * @property {number} [langCode] - Language code. Default "en_US"
+ * @property {number} [offset] - Parameter for pagination, default 0.
+ * @property {number} [limit] - Parameter for pagination, default 30.
+ */
+interface IAdminQuery {
+    langCode: string;
+    offset: number;
+    limit: number;
 }
-export { IAdmins, IAdminEntity, IPosition };
+export type { IAdminEntity, IAdminQuery, IAdmins, IPosition };

package/dist/attribute-sets/attributeSetsApi.d.ts

@@ -1,31 +1,56 @@
-import AsyncModules from "../base/asyncModules";
-import { IAttributesSets, IAttributesSetsEntity } from "./attributeSetsInterfaces";
-import { IError } from "../base/utils";
-import StateModule from "../base/stateModule";
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { IAttributeSetsEntity, IAttributesSets, IAttributesSetsEntity, IAttributesSetsResponce } from './attributeSetsInterfaces';
 /**
- * Controllers for working with attributes.
+ * Controllers for working with attributes - AttributesSetsApi.
+ * @class
  */
 export default class AttributesSetsApi extends AsyncModules implements IAttributesSets {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * '/api/content/attributes-sets'
+     */
     constructor(state: StateModule);
     /**
-     * Get all attributes with data from the attribute sets.
+     * Getting all attribute sets objects
+     *
+     * @param {number} [langCode] - Language code.
+     * @param {number} [limit] - parameter limiting the selection of records, default - 30. Example : 30
+     * @param {number} [offset] - parameter offset of record selection, default - 0.Example : 0
+     * @param {number} [typeId] - identifier of the attribute set type. Example : null
+     * @param {string} [sortBy] - identifier of the attribute set type. Example : null
+     *
+     * @returns Returns an array of AttributeInSet objects.
+     */
+    getAttributes(langCode?: string, limit?: number, offset?: number, typeId?: any, sortBy?: string): Promise<IAttributesSetsResponce | IError>;
+    /**
+     * Getting all attributes with data from the attribute set
      *
-     * @param {string} marker - Attribute marker.
+     * @param {string} [marker] - Attribute marker.
      * @param {string} [langCode] - Language code.
      *
      * @returns Returns an array of AttributeInSet objects.
      */
     getAttributesByMarker(marker: string, langCode?: string): Promise<Array<IAttributesSetsEntity> | IError>;
+    /**
+     * Getting a single object from a set of attributes by marker
+     *
+     * @param {string} [marker] - marker of the attribute set object
+     * @param {string} [langCode] - Language code.
+     *
+     * @returns Returns one object ContentPositionAttributesSetDto of the attribute set
+     */
+    getAttributeSetByMarker(marker: string, langCode?: string): Promise<IAttributeSetsEntity | IError>;
     /**
      * Get a single attribute with data from the attribute sets.
      *
-     * @param {string} attributeMarker  - Text identifier (marker) of the attribute in the set.
-     * @param {string} setMarker  - Text identifier (marker) of the attribute set.
+     * @param {string} [setMarker]  - Text identifier (marker) of the attribute set.
+     * @param {string} [attributeMarker]  - Text identifier (marker) of the attribute in the set.
      * @param {string} [langCode] - Language code.
      *
      * @returns Returns a AttributeInSet object.
      */
-    getSingleAttributeByMarkerSet(attributeMarker: string, setMarker: string, langCode?: string): Promise<IAttributesSetsEntity | IError>;
+    getSingleAttributeByMarkerSet(setMarker: string, attributeMarker: string, langCode?: string): Promise<IAttributesSetsEntity | IError>;
 }

package/dist/attribute-sets/attributeSetsApi.js

@@ -1,18 +1,48 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const asyncModules_1 = require("../base/asyncModules");
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
- * Controllers for working with attributes.
+ * Controllers for working with attributes - AttributesSetsApi.
+ * @class
  */
 class AttributesSetsApi extends asyncModules_1.default {
+    /**
+     * '/api/content/attributes-sets'
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/attributes-sets';
     }
     /**
-     * Get all attributes with data from the attribute sets.
+     * Getting all attribute sets objects
+     *
+     * @param {number} [langCode] - Language code.
+     * @param {number} [limit] - parameter limiting the selection of records, default - 30. Example : 30
+     * @param {number} [offset] - parameter offset of record selection, default - 0.Example : 0
+     * @param {number} [typeId] - identifier of the attribute set type. Example : null
+     * @param {string} [sortBy] - identifier of the attribute set type. Example : null
+     *
+     * @returns Returns an array of AttributeInSet objects.
+     */
+    async getAttributes(langCode = this.state.lang, limit = 30, offset = 0, typeId = null, sortBy = 'id') {
+        const query = {
+            langCode,
+            limit,
+            offset,
+            typeId,
+            sortBy,
+        };
+        const result = await this._fetchGet(`/?` + this._queryParamsToString(query));
+        return this._dataPostProcess(result, langCode);
+    }
+    /**
+     * Getting all attributes with data from the attribute set
      *
-     * @param {string} marker - Attribute marker.
+     * @param {string} [marker] - Attribute marker.
      * @param {string} [langCode] - Language code.
      *
      * @returns Returns an array of AttributeInSet objects.
@@ -21,16 +51,28 @@ class AttributesSetsApi extends asyncModules_1.default {
         const result = await this._fetchGet(`/${marker}/attributes?langCode=${langCode}`);
         return this._dataPostProcess(result, langCode);
     }
+    /**
+     * Getting a single object from a set of attributes by marker
+     *
+     * @param {string} [marker] - marker of the attribute set object
+     * @param {string} [langCode] - Language code.
+     *
+     * @returns Returns one object ContentPositionAttributesSetDto of the attribute set
+     */
+    async getAttributeSetByMarker(marker, langCode = this.state.lang) {
+        const result = await this._fetchGet(`/marker/${marker}/?langCode=${langCode}`);
+        return this._dataPostProcess(result, langCode);
+    }
     /**
      * Get a single attribute with data from the attribute sets.
      *
-     * @param {string} attributeMarker  - Text identifier (marker) of the attribute in the set.
-     * @param {string} setMarker  - Text identifier (marker) of the attribute set.
+     * @param {string} [setMarker]  - Text identifier (marker) of the attribute set.
+     * @param {string} [attributeMarker]  - Text identifier (marker) of the attribute in the set.
      * @param {string} [langCode] - Language code.
      *
      * @returns Returns a AttributeInSet object.
      */
-    async getSingleAttributeByMarkerSet(attributeMarker, setMarker, langCode = this.state.lang) {
+    async getSingleAttributeByMarkerSet(setMarker, attributeMarker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/${setMarker}/attributes/${attributeMarker}?langCode=${langCode}`);
         return result;
     }

package/dist/attribute-sets/attributeSetsInterfaces.d.ts

@@ -1,15 +1,22 @@
-import { IError } from "../base/utils";
+import type { IError } from '../base/utils';
 /**
  * Represents an interface object of AttributesSets Api.
  *
  * @property {function} getAttributesByMarker - Get all attributes with data from the attribute sets.
- *
  * @property {function} getSingleAttributeByMarkerSet - Get a single attribute with data from the attribute sets.
  */
 interface IAttributesSets {
     getAttributesByMarker(marker: string, langCode: string): Promise<Array<IAttributesSetsEntity> | IError>;
     getSingleAttributeByMarkerSet(attributeMarker: string, setMarker: string, langCode: string): Promise<IAttributesSetsEntity | IError>;
 }
+/**
+ * Represents an interface object of IListTitle.
+ *
+ * @property {string} title
+ * @property {number | string} value
+ * @property {string | number | null} position
+ * @property {object} extended
+ */
 interface IListTitle {
     title: string;
     value: number | string;
@@ -37,16 +44,40 @@ interface IAttributesSetsEntity {
     type: AttributeType;
     marker: string;
     position: number;
-    validators: {
-        requiredValidator: {
-            strict: boolean;
-        };
-        defaultValueValidator: {
-            fieldDefaultValue: number;
-        };
-    };
+    validators: object;
     localizeInfos: Record<string, any>;
     listTitles: Array<IListTitle> | Record<string, any>;
+    additionalFields?: Record<string, any>;
     settings?: Record<string, any>;
 }
-export { IAttributesSets, IAttributesSetsEntity, IListTitle, AttributeType };
+/**
+ * Represents an interface object of IAttributeSetsEntity.
+ *
+ * @property {number} id
+ * @property {string} identifier
+ * @property {boolean} isVisible
+ * @property {number} position
+ */
+interface IAttributeSetsEntity {
+    id: number;
+    identifier: string;
+    isVisible: boolean;
+    position: number;
+    schema: any;
+    title: string;
+    type: any;
+    typeId: number;
+    updatedDate: string;
+    version: number;
+}
+/**
+ * Represents an interface object of IAttributesSetsResponce.
+ *
+ * @property {IAttributeSetsEntity[]} items - IAttributeSetsEntity
+ * @property {number} total - total items
+ */
+interface IAttributesSetsResponce {
+    items: IAttributeSetsEntity[];
+    total: number;
+}
+export type { AttributeType, IAttributeSetsEntity, IAttributesSets, IAttributesSetsEntity, IAttributesSetsResponce, IListTitle, };

package/dist/auth-provider/authProviderApi.d.ts

@@ -1,16 +1,20 @@
-import AsyncModules from "../base/asyncModules";
-import { IAuthProvider, ISignUpData, ISignUpEntity, IAuthEntity, IAuthProvidersEntity, IAuthPostBody } from "./authProvidersInterfaces";
-import StateModule from "../base/stateModule";
-import { IError } from "../base/utils";
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { IAuthEntity, IAuthPostBody, IAuthProvider, IAuthProvidersEntity, ISignUpData, ISignUpEntity } from './authProvidersInterfaces';
 /**
  * Controllers for working with auth services.
  */
 export default class AuthProviderApi extends AsyncModules implements IAuthProvider {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * '/api/content/users-auth-providers'
+     */
     constructor(state: StateModule);
     /**
      * User registration
+     *
      * @param {string} marker - The text identifier of the authorization provider. Example - email
      * @param data - Request body
      * @param {string} langCode - Optional language field
@@ -45,6 +49,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
     signUp(marker: string, data: ISignUpData, langCode?: string): Promise<ISignUpEntity | IError>;
     /**
      * Getting a user activation code. The code is returned via the appropriate user notification method
+     *
      * @param {string} marker - The text identifier of the authorization provider. Example - email
      * @param {string} userIdentifier - The text identifier of the user's object (user login)
      * @param {string} eventIdentifier - Text identifier of the event object for which the code is generated
@@ -52,6 +57,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
     generateCode(marker: string, userIdentifier: string, eventIdentifier: string): Promise<void | IError>;
     /**
      * User activation code verification. Returns true (if the code is correct) or false (if it is incorrect).
+     *
      * @param {string} marker - The text identifier of the authorization provider. Example - email
      * @param {string} userIdentifier - The text identifier of the user's object (user login)
      * @param {string} code - Service code
@@ -59,6 +65,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
     checkCode(marker: string, userIdentifier: string, code: string): Promise<boolean | IError>;
     /**
      * User activate.
+     *
      * @param {string} marker - The text identifier of the authorization provider. Example - email
      * @param {string} userIdentifier - The text identifier of the user's object (user login)
      * @param {string} code - Service code
@@ -66,6 +73,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
     activateUser(marker: string, userIdentifier: string, code: string): Promise<boolean | IError>;
     /**
      * User authorization
+     *
      * @param {string} marker - The text identifier of the authorization provider. Example - email
      * @param {IAuthPostBody} data - Array of objects contains auth information
      *
@@ -87,14 +95,15 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
     auth(marker: string, data: IAuthPostBody): Promise<IAuthEntity | IError>;
     /**
      * Refresh token
+     *
      * @param {string} marker - The text identifier of the authorization provider. Example - email
      * @param {string} token - Refresh token
      *
      */
     refresh(marker: string, token: string): Promise<IAuthEntity | IError>;
     /**
-     *
      * User logout.
+     *
      * @param {string} marker - The text identifier of the authorization provider. Example - email
      * @param {string} token - Refresh token
      *
@@ -103,6 +112,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
     logout(marker: string, token: string): Promise<boolean | IError>;
     /**
      * Change password
+     *
      * @param {string} marker - The text identifier of the authorization provider. Example - email
      * @param {string} userIdentifier - The text identifier of the user's object (user login)
      * @param {string} code - Service code
@@ -113,6 +123,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
     changePassword(marker: string, userIdentifier: string, type: number, code: string, newPassword: string, repeatPassword?: string): Promise<boolean | IError>;
     /**
      * Get all auth providers objects
+     *
      * @param {string} [langCode] - Language code. Default "en_US"
      * @param {number} [offset] - Parameter for pagination. Default 0
      * @param {number} [limit] - Parameter for pagination. Default 30
@@ -120,6 +131,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
     getAuthProviders(langCode?: string, offset?: number, limit?: number): Promise<Array<IAuthProvidersEntity> | IError>;
     /**
      * Get one auth provider object by marker
+     *
      * @param {string} marker - The text identifier of the authorization provider. Example - email
      * @param {string} [langCode] - Optional parameter language code. Default "en_US"
      */