oneentry 1.0.31 → 1.0.32

package/README.md

@@ -26,6 +26,7 @@ import { defineOneEntry } from 'oneentry'
 
 const {
         Admins,
+        Blocks
         Forms,
         FormData,
         FileUploading,
@@ -90,6 +91,112 @@ Example return:
 ]
 ```
 
+## Blocks
+
+const { Blocks } = defineOneEntry('your-url');
+
+### Blocks.getBlocks(langCode, offset, limit)
+
+```
+const value = await Blocks.getBlocks('en_US', 0, 30)
+```
+
+> This method return all blocks objects.
+
+Example return:
+```
+[
+  {
+    "id": 1764,
+    "attributeSetId": 7,
+    "localizeInfos": {
+      "en_US": {
+        "title": "My block"
+      }
+    },
+    "customSettings": {
+      "sliderDelay": 0,
+      "sliderDelayType": "",
+      "productQuantity": 4,
+      "productSortType": "By_ID",
+      "productSortOrder": "Descending",
+      "productCountElementsPerRow": 10,
+      "similarProductRules": [
+        {
+          "property": "Descending",
+          "includes": "",
+          "keywords": "",
+          "strict": ""
+        }
+      ]
+    },
+    "version": 10,
+    "identifier": "catalog",
+    "position": 192,
+    "attributeValues": {
+      "en_US": {
+        "marker": {
+          "value": "",
+          "type": "string"
+        }
+      }
+    },
+    "type": "forNewsPage",
+    "templateIdentifier": null
+  }
+]
+```
+
+### Blocks.getBlockByMarker(marker, langCode)
+
+```
+const value = await Blocks.getBlockByMarker('my-marker', 'en_US')
+```
+
+> This method return one blocks object by marker.
+
+Example return:
+```
+{
+  "id": 1764,
+  "attributeSetId": 7,
+  "localizeInfos": {
+    "en_US": {
+      "title": "My block"
+    }
+  },
+  "customSettings": {
+    "sliderDelay": 0,
+    "sliderDelayType": "",
+    "productQuantity": 4,
+    "productSortType": "By_ID",
+    "productSortOrder": "Descending",
+    "productCountElementsPerRow": 10,
+    "similarProductRules": [
+      {
+        "property": "Descending",
+        "includes": "",
+        "keywords": "",
+        "strict": ""
+      }
+    ]
+  },
+  "version": 10,
+  "identifier": "catalog",
+  "position": 192,
+  "attributeValues": {
+    "en_US": {
+      "marker": {
+        "value": "",
+        "type": "string"
+      }
+    }
+  },
+  "type": "forNewsPage",
+  "templateIdentifier": null
+}
+```
+
 ## FileUploading
 
 const { FileUploading } = defineOneEntry('your-url');

package/dist/formsData/formsDataApi.d.ts

@@ -33,7 +33,7 @@ export default class FormsDataApi extends OneEntry implements IFormsData {
      *
      * @returns - Returns created FormData objects.
      */
-    postFormsData(data: Array<IFormsPost>): Promise<IFormsDataEntity>;
+    postFormsData(data: IFormsPost): Promise<IFormsDataEntity>;
     /**
      * Get one object of form data by marker.
      *

package/dist/formsData/formsDataInterfaces.d.ts

@@ -9,7 +9,7 @@
  */
 interface IFormsData {
     getFormsData(langCode: string, offset?: number, limit?: number): Promise<Array<IFormsDataEntity>>;
-    postFormsData(data: Array<IFormsPost>): Promise<IFormsDataEntity>;
+    postFormsData(data: IFormsPost): Promise<IFormsDataEntity>;
     getFormsDataByMarker(marker: string, langCode: string, offset?: number, limit?: number): Promise<Array<IFormsDataEntity>>;
 }
 /**
@@ -30,6 +30,8 @@ interface IFormsDataEntity {
     attributeSetIdentifier: string;
 }
 /**
+ * @property {string} [formIdentifier] - Text identifier of the form object (marker)
+ *
  * Form data get by langcode identifier
  * @example formData['en_US']
  *
@@ -42,19 +44,26 @@ interface IFormsDataEntity {
  * @property {string} value Form data value.
  */
 interface IFormData {
-    [langcode: string]: Array<{
-        marker?: string;
-        value?: string;
-    }>;
+    formIdentifier?: string;
+    formData: {
+        [langcode: string]: Array<{
+            marker?: string;
+            value?: string;
+        }>;
+    };
 }
 /**
  * interface to create an object of information about saving data using the form
  *
+ * @property {number} id
  * @property {string} formIdentifier - The identifier of the page.
+ * @property {Date | string} time - Date and time of form modification
  * @property {IFormData} formData - The identifier of the page.
  */
 interface IFormsPost {
+    id: number;
     formIdentifier: string;
+    time: Date | string;
     formData: IFormData;
 }
 export { IFormsPost, IFormsData, IFormsDataEntity };

package/dist/index.d.ts

@@ -11,8 +11,10 @@ import FormsApi from "./forms/formsApi";
 import FormsDataApi from "./formsData/formsDataApi";
 import FileUploadingApi from "./file-uploding/fileUploadingApi";
 import SystemApi from "./system/systemApi";
+import BlocksApi from "./blocks/blocksApi";
 interface IDefineApi {
     Admins: AdminsApi;
+    Blocks: BlocksApi;
     FileUploading: FileUploadingApi;
     Forms: FormsApi;
     FormData: FormsDataApi;

package/dist/index.js

@@ -14,6 +14,7 @@ const formsApi_1 = require("./forms/formsApi");
 const formsDataApi_1 = require("./formsData/formsDataApi");
 const fileUploadingApi_1 = require("./file-uploding/fileUploadingApi");
 const systemApi_1 = require("./system/systemApi");
+const blocksApi_1 = require("./blocks/blocksApi");
 /**
  * Define API.
  * @param {string} url - URl of your project.
@@ -21,6 +22,7 @@ const systemApi_1 = require("./system/systemApi");
  */
 function defineOneEntry(url, token) {
     const Admins = new adminsApi_1.default(url, token);
+    const Blocks = new blocksApi_1.default(url, token);
     const FileUploading = new fileUploadingApi_1.default(url, token);
     const Forms = new formsApi_1.default(url, token);
     const FormData = new formsDataApi_1.default(url, token);
@@ -35,6 +37,7 @@ function defineOneEntry(url, token) {
     const TemplatePreviews = new templatesPreviewApi_1.default(url, token);
     return {
         Admins,
+        Blocks,
         FileUploading,
         Forms,
         FormData,

package/dist/pages/pagesApi.d.ts

@@ -1,5 +1,5 @@
 import OneEntry from "../base/oneEntry";
-import { IPageApi, IPageConfig, IPagesEntity, IPositionForm } from "./pagesInterfaces";
+import { IPageApi, IPageConfig, IPagesEntity, IPositionForm, IPositionBlock } from "./pagesInterfaces";
 import { LangType } from "../base/utils";
 /**
  * Controllers for working with page objects, including catalog pages
@@ -74,6 +74,16 @@ export default class PageApi extends OneEntry implements IPageApi {
      * @returns Returns all forms as an array of PositionForm objects or an empty array [] (if there is no data) for the selected parent
      */
     getFormsByPageUrl(url: string, langCode: LangType): Promise<Array<IPositionForm>>;
+    /**
+     * Get all blocks by page url.
+     *
+     * @param {string | Array<string>} [langCode] Required parameter lang code
+     *
+     * @param {string} [url] - Page URL
+     *
+     * @returns Returns all blocks as an array of PositionBlock objects or an empty array [] (if there is no data) for the selected parent
+     */
+    getBlocksByPageUrl(url: string, langCode: LangType): Promise<Array<IPositionBlock>>;
     /**
      * Get settings for the page.
      *

package/dist/pages/pagesApi.js

@@ -98,6 +98,19 @@ class PageApi extends oneEntry_1.default {
         const result = await this._fetchRequests(`/${url}/forms?langCode=${this._LANGCODE_KEY}`, langCode);
         return result;
     }
+    /**
+     * Get all blocks by page url.
+     *
+     * @param {string | Array<string>} [langCode] Required parameter lang code
+     *
+     * @param {string} [url] - Page URL
+     *
+     * @returns Returns all blocks as an array of PositionBlock objects or an empty array [] (if there is no data) for the selected parent
+     */
+    async getBlocksByPageUrl(url, langCode) {
+        const result = await this._fetchRequests(`/${url}/blocks?langCode=${this._LANGCODE_KEY}`, langCode);
+        return result;
+    }
     /**
      * Get settings for the page.
      *

package/dist/pages/pagesInterfaces.d.ts

@@ -28,6 +28,7 @@ interface IPageApi {
     getPageByUrl(url: string, langCode: LangType): Promise<IPagesEntity>;
     getChildPagesByParentUrl(url: string, langCode: LangType): Promise<IPagesEntity>;
     getFormsByPageUrl(url: string, langCode: LangType): Promise<Array<IPositionForm>>;
+    getBlocksByPageUrl(url: string, langCode: LangType): Promise<Array<IPositionBlock>>;
     getConfigPageByUrl(url: string): Promise<IPageConfig>;
     searchPage(name: string, langCode: LangType): Promise<Array<IPagesEntity>>;
 }
@@ -68,6 +69,48 @@ interface IPositionForm {
     processingData: object;
     position: number;
 }
+/**
+ * Represents an object with various properties.
+ *
+ * @interface
+ * @property {number} id - The identifier of the object.
+ * @property {number} version - The version number 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 {LocalizeType} localizeInfos - The name of the page, taking into account localization.
+ * @property {object} customSettings - Custom settings for different types of blocks.
+ * @property {number} position - The position of the object.
+ * @property {boolean} isSync - Indication of page indexing.
+ * @property {AttributeType} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value).
+ * @property {Types} type - Page type.
+ * @property {string} templateIdentifier - User id of the linked template.
+ */
+interface IPositionBlock {
+    id: number;
+    version: number;
+    identifier: string;
+    attributeSetId: number;
+    localizeInfos: LocalizeType;
+    customSettings: {
+        sliderDelay: number;
+        sliderDelayType: string;
+        productQuantity: number;
+        productSortType: string;
+        productSortOrder: string;
+        productCountElementsPerRow: number;
+        similarProductRules: Array<{
+            property: string;
+            includes: string;
+            keywords: string;
+            strict: string;
+        }>;
+    };
+    position: number;
+    isSync: boolean;
+    attributeValues: AttributeType;
+    type: string;
+    templateIdentifier: string | null;
+}
 /**
  * Represents an object with various properties.
  *
@@ -111,4 +154,4 @@ interface IPagesEntity {
     templateIdentifier: string;
     type: Types;
 }
-export { IPageApi, IPageConfig, IPagesEntity, IPositionForm };
+export { IPageApi, IPageConfig, IPagesEntity, IPositionForm, IPositionBlock };

package/dist/products/productsInterfaces.d.ts

@@ -28,6 +28,13 @@ interface IProductApi {
     filterProduct(data: Array<IFilterParams>, langCode: LangType, userQuery?: IProductsQuery): Promise<Array<IProductsEntity>>;
     searchProduct(name: string, langCode: string): Promise<Array<IProductsEntity>>;
 }
+declare enum SortKey {
+    id = "id",
+    position = "position",
+    title = "title",
+    date = "date",
+    price = "price"
+}
 /**
  * Represents a product query parameters object.
  *
@@ -40,7 +47,7 @@ interface IProductApi {
  * @property {string | null} attributeMarker - The text identifier of the indexed attribute by which values are filtered, default null.
  * @property {string} sortOrder - Sort order 'DESC' | 'ASC', default 'DESC'.
  * @property {string} langCode - localization language code (used only when searching with a filter, default 'en_US'.
- * @property {string} sortKey - Sorting field, default null.
+ * @property {string} sortKey - Field for sorting (default - null)
  */
 interface IProductsQuery {
     offset?: number;
@@ -60,7 +67,7 @@ interface IProductsQuery {
     conditionMarker?: 'in' | 'nin' | 'eq' | 'neq' | 'mth' | 'lth' | 'exs' | 'nexs' | null;
     attributeMarker?: string | null;
     sortOrder?: 'DESC' | 'ASC' | null;
-    sortKey?: string | null;
+    sortKey?: SortKey | null;
     [key: string]: string | number | null;
 }
 /**

package/dist/products/productsInterfaces.js

@@ -1,2 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+var SortKey;
+(function (SortKey) {
+    SortKey["id"] = "id";
+    SortKey["position"] = "position";
+    SortKey["title"] = "title";
+    SortKey["date"] = "date";
+    SortKey["price"] = "price";
+})(SortKey || (SortKey = {}));

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "oneentry",
-  "version": "1.0.31",
+  "version": "1.0.32",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "/dist"
   ],
-
   "author": "ONEENTRY PORTAL CO.",
   "license": "ISC",
   "dependencies": {