oneentry 1.0.105 → 1.0.107

package/README.md

@@ -204,7 +204,7 @@ Now you can use the following links to jump to specific entries:
 const { Admins } = defineOneEntry('your-url');
 ```
 
-> Method accept the body as a parameter for filtering. If you don't want to set up sorting, pass an empty array or don't pass anything.
+> Method accept the body as a parameter for filtering. If you don't want to set up filtering/sorting, pass an empty array or don't pass anything.
 
 Parameters:
 
@@ -2662,9 +2662,9 @@ const body = {
   "formData": {
     "en_US": [
       {
-        "marker": "naimenovanie_1",
+        "marker": "name_1",
         "type": "string",
-        "value": "Наименование"
+        "value": "Value"
       }
     ]
   }
@@ -2678,13 +2678,13 @@ Example return:
 
 ```json
 {
-  "formIdentifier": "collection_form",
+  "formIdentifier": "collection-form",
   "formData": {
     "en_US": [
       {
-        "marker": "naimenovanie_1",
+        "marker": "name_1",
         "type": "string",
-        "value": "Name"
+        "value": "Value"
       }
     ]
   }
@@ -2754,7 +2754,7 @@ Example return:
 >
 ></details>
 
-### IntegrationCollections.deleteCollectionRowByMarker(id, marker)
+### IntegrationCollections.deleteICollectionRowByMarker(id, marker)
 
 ```js
 const result = await IntegrationCollections.deleteCollectionRowByMarker(1, 'test_collection');

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

@@ -1,7 +1,7 @@
 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';
+import type { IAttributeSetsEntity, IAttributesSets, IAttributesSetsEntity, IAttributesSetsResponse } from './attributeSetsInterfaces';
 /**
  * Controllers for working with attributes - AttributesSetsApi.
  * @class
@@ -24,7 +24,7 @@ export default class AttributesSetsApi extends AsyncModules implements IAttribut
      *
      * @returns Returns an array of AttributeInSet objects.
      */
-    getAttributes(langCode?: string, limit?: number, offset?: number, typeId?: any, sortBy?: string): Promise<IAttributesSetsResponce | IError>;
+    getAttributes(langCode?: string, offset?: number, limit?: number, typeId?: any, sortBy?: string): Promise<IAttributesSetsResponse | IError>;
     /**
      * Getting all attributes with data from the attribute set
      *

package/dist/attribute-sets/attributeSetsApi.js

@@ -28,11 +28,11 @@ class AttributesSetsApi extends asyncModules_1.default {
      *
      * @returns Returns an array of AttributeInSet objects.
      */
-    async getAttributes(langCode = this.state.lang, limit = 30, offset = 0, typeId = null, sortBy = 'id') {
+    async getAttributes(langCode = this.state.lang, offset = 0, limit = 30, typeId = null, sortBy = 'id') {
         const query = {
             langCode,
-            limit,
             offset,
+            limit,
             typeId,
             sortBy,
         };

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

@@ -76,8 +76,8 @@ interface IAttributeSetsEntity {
  * @property {IAttributeSetsEntity[]} items - IAttributeSetsEntity
  * @property {number} total - total items
  */
-interface IAttributesSetsResponce {
+interface IAttributesSetsResponse {
     items: IAttributeSetsEntity[];
     total: number;
 }
-export type { AttributeType, IAttributeSetsEntity, IAttributesSets, IAttributesSetsEntity, IAttributesSetsResponce, IListTitle, };
+export type { AttributeType, IAttributeSetsEntity, IAttributesSets, IAttributesSetsEntity, IAttributesSetsResponse, IListTitle, };

package/dist/integration-collections/integrationCollectionsApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { ICollection, ICollectionFormObject, ICollectionResponce, ICollectionsApi } from './integrationCollectionsInterfaces';
+import type { ICollection, ICollectionFormObject, ICollectionResponce, ICollectionRow, ICollectionsApi } from './integrationCollectionsInterfaces';
 /**
  * Controllers for working with attributes.
  */
@@ -24,7 +24,6 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
     getICollections(langCode?: string, userQuery?: any): Promise<Array<ICollection> | IError>;
     /**
      * Get a single collection object by id.
-     * GET/api/content/integration-collections/{id}
      *
      * @param {number} [id] - Collection id.
      * @param {string} [langCode] - Language code.
@@ -34,7 +33,6 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
     getICollectionById(id: number, langCode?: string): Promise<ICollection | IError>;
     /**
      * Get all records belonging to the collection by collection id.
-     * GET/api/content/integration-collections/{id}/rows
      *
      * @param {number} [id] - Collection id.
      * @param {string} [langCode] - Language code.
@@ -48,16 +46,16 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
     getICollectionRowsById(id: number, langCode?: string, userQuery?: any): Promise<ICollectionResponce | IError>;
     /**
      * Check for the existence of a text identifier (marker)
-     * GET/api/content/integration-collections/marker-validation/{marker}
      *
      * @param {string} [marker] - Collection id.
      *
      * @returns Returns object MarkerValidDto with value true if text identifier (marker) exists or false if not
      */
-    validateICollectionMarker(marker: string): Promise<any | IError>;
+    validateICollectionMarker(marker: string): Promise<{
+        valid: boolean;
+    } | IError>;
     /**
      * Getting one record from the collection.
-     * GET/api/content/integration-collections/marker/{marker}/rows/{id}
      *
      * @param {string} [marker] - Collection text identifier
      * @param {number} [id] - Collection record identifier
@@ -68,11 +66,10 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
     getICollectionRowByMarkerAndId(marker: string, id: number, langCode?: string): Promise<any | IError>;
     /**
      * Create a record in the collection
-     * POST/api/content/integration-collections/marker/{marker}/rows
      *
      * @param {string} [marker] - Collection text identifier. Example : collection1
-     * @param {ICollectionFormObject} [data] - Object for creating a record
-     * const data: ICollectionFormObject = {
+     * @param {ICollectionFormObject} [body] - Object for creating a record
+     * const body: ICollectionFormObject = {
         "formIdentifier": "collection-form",
         "formData": {
           "en_US": [
@@ -88,13 +85,14 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      *
      * @description Create a record in the collection
      */
-    createICollectionRow(marker: string, data: ICollectionFormObject, langCode?: string): Promise<Array<any> | IError>;
+    createICollectionRow(marker: string, body: ICollectionFormObject, langCode?: string): Promise<any | IError>;
     /**
      * Edit a record in the collection
-     * PUT/api/content/integration-collections/marker/{marker}/rows/{id}
      *
-     * @param {string} marker - text identifier of the collection
-     * @param {any} body - Object UpdateCollectionRowDto for updating a record in the collection
+     * @param {string} [marker] - text identifier of the collection
+     * @param {number} [id] -
+     * @param {any} [body] - Object UpdateCollectionRowDto for updating a record in the collection
+     *
      * const body = {
         "formIdentifier": "collection-form",
         "formData": {
@@ -107,22 +105,22 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
           ]
         }
       }
-     * @param {string} langCode - language code
+     *
+     * @param {string} [langCode] - language code
      *
      * @returns Returns object UpdateCollectionRowDto
      */
     updateICollectionRow(marker: string, id: number, body: {
         formIdentifier: string;
         formData: any;
-    }, langCode?: string): Promise<any | IError>;
+    }, langCode?: string): Promise<ICollectionRow | IError>;
     /**
      * Deletion of collection record object
-     * DELETE/api/content/integration-collections/marker/{marker}/rows/{id} Удаление объекта записи коллекции
      *
-     * @param id - record identifier in the collection Example : 12
-     * @param marker - text identifier of the collection Example : collection1
+     * @param {string} [marker] - text identifier of the collection Example : collection1
+     * @param {number} [id] - record identifier in the collection Example : 12
      *
      * @returns Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
      */
-    deleteCollectionRowByMarker(marker: number, id: number): Promise<any | IError>;
+    deleteICollectionRowByMarkerAndId(marker: string, id: number): Promise<boolean | IError>;
 }

package/dist/integration-collections/integrationCollectionsApi.js

@@ -36,7 +36,6 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * Get a single collection object by id.
-     * GET/api/content/integration-collections/{id}
      *
      * @param {number} [id] - Collection id.
      * @param {string} [langCode] - Language code.
@@ -50,7 +49,6 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * Get all records belonging to the collection by collection id.
-     * GET/api/content/integration-collections/{id}/rows
      *
      * @param {number} [id] - Collection id.
      * @param {string} [langCode] - Language code.
@@ -68,7 +66,6 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * Check for the existence of a text identifier (marker)
-     * GET/api/content/integration-collections/marker-validation/{marker}
      *
      * @param {string} [marker] - Collection id.
      *
@@ -80,7 +77,6 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * Getting one record from the collection.
-     * GET/api/content/integration-collections/marker/{marker}/rows/{id}
      *
      * @param {string} [marker] - Collection text identifier
      * @param {number} [id] - Collection record identifier
@@ -94,11 +90,10 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * Create a record in the collection
-     * POST/api/content/integration-collections/marker/{marker}/rows
      *
      * @param {string} [marker] - Collection text identifier. Example : collection1
-     * @param {ICollectionFormObject} [data] - Object for creating a record
-     * const data: ICollectionFormObject = {
+     * @param {ICollectionFormObject} [body] - Object for creating a record
+     * const body: ICollectionFormObject = {
         "formIdentifier": "collection-form",
         "formData": {
           "en_US": [
@@ -114,16 +109,17 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      *
      * @description Create a record in the collection
      */
-    async createICollectionRow(marker, data, langCode = this.state.lang) {
-        const response = await this._fetchPost(`/marker/${marker}/rows/?` + `langCode=${langCode}`, data);
+    async createICollectionRow(marker, body, langCode = this.state.lang) {
+        const response = await this._fetchPost(`/marker/${marker}/rows/?` + `langCode=${langCode}`, body);
         return this._normalizeData(response, langCode);
     }
     /**
      * Edit a record in the collection
-     * PUT/api/content/integration-collections/marker/{marker}/rows/{id}
      *
-     * @param {string} marker - text identifier of the collection
-     * @param {any} body - Object UpdateCollectionRowDto for updating a record in the collection
+     * @param {string} [marker] - text identifier of the collection
+     * @param {number} [id] -
+     * @param {any} [body] - Object UpdateCollectionRowDto for updating a record in the collection
+     *
      * const body = {
         "formIdentifier": "collection-form",
         "formData": {
@@ -136,7 +132,8 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
           ]
         }
       }
-     * @param {string} langCode - language code
+     *
+     * @param {string} [langCode] - language code
      *
      * @returns Returns object UpdateCollectionRowDto
      */
@@ -146,16 +143,15 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * Deletion of collection record object
-     * DELETE/api/content/integration-collections/marker/{marker}/rows/{id} Удаление объекта записи коллекции
      *
-     * @param id - record identifier in the collection Example : 12
-     * @param marker - text identifier of the collection Example : collection1
+     * @param {string} [marker] - text identifier of the collection Example : collection1
+     * @param {number} [id] - record identifier in the collection Example : 12
      *
      * @returns Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
      */
-    async deleteCollectionRowByMarker(marker, id) {
+    async deleteICollectionRowByMarkerAndId(marker, id) {
         const result = await this._fetchDelete(`/marker/${marker}/rows/${id}`);
-        return result.json();
+        return result;
     }
 }
 exports.default = IntegrationCollectionsApi;

package/dist/integration-collections/integrationCollectionsInterfaces.d.ts

@@ -2,13 +2,14 @@ import type { IError } from '../base/utils';
 /**
  * Represents an interface object of ICollections Api.
  *
- * @property {function} getICollections - Get all collections
- * @property {function} getICollectionById - Get a single collection object
- * @property {function} getICollectionRowsById -
- * @property {function} validateICollectionMarker -
- * @property {function} getICollectionRowByMarkerAndId -
- * @property {function} createICollectionRow -
- * @property {function} updateICollectionRow -
+ * @property {function} [getICollections] - Get all collections
+ * @property {function} [getICollectionById] - Get a single collection object
+ * @property {function} [getICollectionRowsById] - Get all records belonging to the collection by collection id.
+ * @property {function} [validateICollectionMarker] - Check for the existence of a text identifier (marker)
+ * @property {function} [getICollectionRowByMarkerAndId] - Getting one record (row) from the collection.
+ * @property {function} [createICollectionRow] - Create a record (row) in the collection
+ * @property {function} [updateICollectionRow] - Edit a record (row) in the collection
+ * @property {function} [deleteICollectionRowByMarkerAndId] - Deletion of collection record object (row)
  */
 interface ICollectionsApi {
     getICollections(marker: string, langCode: string, userQuery?: any): Promise<Array<any> | IError>;
@@ -18,9 +19,17 @@ interface ICollectionsApi {
     getICollectionRowByMarkerAndId(marker: string, id: number, langCode: string): Promise<any | IError>;
     createICollectionRow(marker: string, body: any, langCode: string): Promise<Array<any> | IError>;
     updateICollectionRow(marker: string, id: number, body: any, langCode: string): Promise<any | IError>;
+    deleteICollectionRowByMarkerAndId(marker: string, id: number): Promise<any | IError>;
 }
 /**
  * ICollection
+ *
+ * @property {number} [id] - Object identifier
+ * @property {object} [localizeInfos] - Name considering localization
+ * @property {string | null} [identifier] - Text identifier for record field
+ * @property {number | null} [formId] - Identifier for the form used by the order storage
+ * @property {string | null} [attributeSetId] - Identifier of the set of attributes used by the form attached to the collection
+ * @property {string | null} [selectedAttributeMarkers] - Text identifiers of form object attributes for display in the data table
  */
 interface ICollection {
     id: number;
@@ -32,6 +41,9 @@ interface ICollection {
 }
 /**
  * ICollectionResponce
+ *
+ * @property {ICollection[]} items -
+ * @property {number} total -
  */
 interface ICollectionResponce {
     items: ICollection[];
@@ -39,6 +51,10 @@ interface ICollectionResponce {
 }
 /**
  * ICollectionFormData
+ *
+ * @property {string} marker -
+ * @property {string} type -
+ * @property {string} value -
  */
 interface ICollectionFormData {
     marker: string;
@@ -47,6 +63,9 @@ interface ICollectionFormData {
 }
 /**
  * ICollectionFormObject
+ *
+ * @property {string} formIdentifier -
+ * @property {object} formData -
  */
 interface ICollectionFormObject {
     formIdentifier: string;
@@ -54,4 +73,22 @@ interface ICollectionFormObject {
         [key: string]: ICollectionFormData[];
     };
 }
-export type { ICollection, ICollectionFormObject, ICollectionResponce, ICollectionsApi, };
+/**
+ * ICollectionRow
+ */
+interface ICollectionRow {
+    id: number;
+    createdDate: string;
+    updatedDate: string;
+    formData: ICollectionFormData[];
+    attributeSetIdentifier: string | null;
+    total?: string;
+}
+/**
+ * ICollectionRows
+ */
+interface ICollectionRowsResponce {
+    items: ICollectionRow[];
+    total: number;
+}
+export type { ICollection, ICollectionFormObject, ICollectionResponce, ICollectionRow, ICollectionRowsResponce, ICollectionsApi, };

package/dist/orders/ordersInterfaces.d.ts

@@ -13,11 +13,11 @@ import type { IError } from '../base/utils';
  */
 interface IOrdersApi {
     createOrder(marker: string, data: IOrderData): Promise<IBaseOrdersEntity | IError>;
-    getAllOrdersByMarker(marker: string, langCode?: string, limit?: number, offset?: number): Promise<IOrdersByMarkerEntity | IError>;
+    getAllOrdersByMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<IOrdersByMarkerEntity | IError>;
     getOrderByMarker(marker: string, langCode?: string): Promise<IOrdersEntity | IError>;
     updateOrderByMarkerAndId(marker: string, id: number, data: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | IError>;
     getOrderByMarkerAndId(marker: string, id: number, langCode?: string): Promise<IOrderByMarkerEntity | IError>;
-    getAllOrdersStorage(langCode?: string, limit?: number, offset?: number): Promise<Array<IOrdersEntity> | IError>;
+    getAllOrdersStorage(langCode?: string, offset?: number, limit?: number): Promise<Array<IOrdersEntity> | IError>;
 }
 /**
  * Represents a form data.

package/dist/products/productsInterfaces.d.ts

@@ -77,7 +77,7 @@ interface IFilterParams {
  * @property {object} additional - Additional value from the index.
  * @property {Record<string, any>} localizeInfos - The name of the products, taking into account localization.
  * @property {boolean} isVisible - A sign of page visibility.
- * @property {boolean} [isPositionLocked] - Sorting position lock indicator (optional).
+ * @property {boolean} isPositionLocked - Sorting position lock indicator (optional).
  * @property {number | null} statusIdentifier - Product page status identifiers (may be null).
  * @property {Array<number>} relatedIds - Ids of related product pages.
  * @property {string} attributeSetIdentifier - Set of attributes id.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.105",
+  "version": "1.0.107",
   "description": "OneEntry NPM package",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",