oneentry 1.0.51 → 1.0.53

package/README.md

@@ -334,6 +334,126 @@ example: List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extende
 const { Blocks } = defineOneEntry('your-url');
 ```
 
+### Blocks.getBlocks(langCode, offset, limit)
+
+```js
+const value = await Blocks.getBlocks('en_US', 0, 30)
+```
+
+> This method return array of all blocks object.
+
+Example return:
+
+```json
+[
+  {
+    "id": 4,
+    "attributeSetId": 14,
+    "localizeInfos": {
+      "title": "Name"
+    },
+    "version": 0,
+    "position": 3,
+    "identifier": "product",
+    "type": "forProductBlock",
+    "productPageUrls": [],
+    "templateIdentifier": null,
+    "isVisible": true,
+    "attributeValues": {
+      "attr": {
+        "type": "string",
+        "value": "",
+        "position": 0,
+        "isProductPreview": false
+      }
+    },
+    "countElementsPerRow": 3,
+    "products": [
+      {
+        "id": 446,
+        "localizeInfos": {
+          "title": "new product 3"
+        },
+        "relatedIds": [1, 2],
+        "statusId": null,
+        "attributeSetId": 11,
+        "position": 3,
+        "templateIdentifier": null,
+        "shortDescTemplateIdentifier": null,
+        "price": 543,
+        "sku": "ggg",
+        "isSync": true,
+        "attributeValues": {
+          "sku": {
+            "type": "string",
+            "value": "ggg",
+            "position": 0,
+            "isProductPreview": false
+          },
+          "images": {
+            "type": "groupOfImages",
+            "value": {},
+            "position": 3,
+            "isProductPreview": false
+          }
+        },
+        "isVisible": true
+      }
+    ]
+  }
+]
+```
+
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier*
+example: 1764 <br>
+
+**attributeSetId:** number <br>
+*identifier for the used attribute set* <br>
+example: 7 <br>
+
+**localizeInfos:**	CommonLocalizeInfos <br>
+*block name with localization* <br>
+example: OrderedMap { "en_US": OrderedMap { "title": "My block" } } <br>
+
+**customSettings:**	BlockCustomSettings <br>
+*custom settings for different block types* <br>
+example: OrderedMap { "sliderDelay": 0, "sliderDelayType": "", "productQuantity": 4, "productSortType": "By_ID", "productSortOrder": "Descending", "productCountElementsPerRow": 10, "similarProductRules": List [ OrderedMap { "property": "Descending", "includes": "", "keywords": "", "strict": "" } ] } <br>
+
+**version:** number <br>
+*object version number* <br>
+example: 10 <br>
+
+**identifier:**	string <br>
+*textual identifier for the field record* <br>
+example: catalog <br>
+default: marker <br>
+
+**position:** number <br>
+*position number (for sorting)* <br>
+example: 192 <br>
+
+**attributeValues:**	Record<string, string> <br>
+*array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
+example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } } <br>
+
+**type:** string <br>
+*block type* <br>
+example: forNewsPage <br>
+
+**templateIdentifier:**	string <br>
+*template marker used by the block (can be null)* <br>
+Enum:
+[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ] <br>
+example: null <br>
+
+</details>
+---
+
+
 ### Blocks.getBlockByMarker(marker, langCode)
 
 ```js
@@ -346,38 +466,52 @@ Example return:
 
 ```json
 {
-  "id": 1764,
-  "attributeSetId": 7,
+  "id": 3,
+  "attributeSetId": null,
   "localizeInfos": {
-    "title": "My block"
+    "title": "test"
   },
-  "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": {
-    "marker": {
-      "value": "",
-      "type": "string"
+  "version": 0,
+  "position": 4,
+  "identifier": "test",
+  "type": "forSimilarProductBlock",
+  "productPageUrls": [],
+  "templateIdentifier": null,
+  "isVisible": true,
+  "attributeValues": {},
+  "countElementsPerRow": 4,
+  "similarProducts": [
+    {
+      "id": 446,
+      "localizeInfos": {
+        "title": "new product 3"
+      },
+      "relatedIds": [1, 2],
+      "statusId": null,
+      "attributeSetId": 11,
+      "position": 3,
+      "templateIdentifier": null,
+      "shortDescTemplateIdentifier": null,
+      "price": 543,
+      "sku": "ggg",
+      "isSync": true,
+      "attributeValues": {
+        "sku": {
+          "type": "string",
+          "value": "ggg",
+          "position": 0,
+          "isProductPreview": false
+        },
+        "images": {
+          "type": "groupOfImages",
+          "value": {},
+          "position": 3,
+          "isProductPreview": false
+        }
+      },
+      "isVisible": true
     }
-  },
-  "type": "forNewsPage",
-  "templateIdentifier": null
+  ]
 }
 ```
 
@@ -430,6 +564,98 @@ example: null <br>
 </details>
 ---
 
+## Blocks.getSimilarProducts(marker, langCode, offset, limit)
+
+
+```js
+const value = await Blocks.getSimilarProducts('my-marker', 'en_US')
+```
+
+> This method return array of similar products from block by block marker.
+
+Example return:
+
+```json
+[
+  {
+    "id": 446,
+    "localizeInfos": {
+      "title": "new product 3"
+    },
+    "relatedIds": [1, 2],
+    "statusId": null,
+    "attributeSetId": 11,
+    "position": 3,
+    "templateIdentifier": null,
+    "shortDescTemplateIdentifier": null,
+    "price": 543,
+    "sku": "ggg",
+    "isSync": true,
+    "attributeValues": {
+      "sku": {
+        "type": "string",
+        "value": "ggg",
+        "position": 0,
+        "isProductPreview": false
+      },
+      "images": {
+        "type": "groupOfImages",
+        "value": {},
+        "position": 3,
+        "isProductPreview": false
+      }
+    },
+    "isVisible": true
+  }
+]
+```
+
+
+
+## Blocks.getSimilarProducts(marker, langCode, offset, limit)
+
+```js
+const value = await Blocks.getProductsByBlockMarker('my-marker', 'en_US')
+```
+
+> This method return array of products from block by block marker.
+
+Example return:
+
+```json
+[
+  {
+    "id": 446,
+    "localizeInfos": {
+      "title": "new product 3"
+    },
+    "relatedIds": [1, 2],
+    "statusId": null,
+    "attributeSetId": 11,
+    "position": 3,
+    "templateIdentifier": null,
+    "shortDescTemplateIdentifier": null,
+    "price": 543,
+    "sku": "ggg",
+    "isSync": true,
+    "attributeValues": {
+      "sku": {
+        "type": "string",
+        "value": "ggg",
+        "position": 0,
+        "isProductPreview": false
+      },
+      "images": {
+        "type": "groupOfImages",
+        "value": {},
+        "position": 3,
+        "isProductPreview": false
+      }
+    },
+    "isVisible": true
+  }
+]
+```
 
 
 ## <h2 id="fileuploading"> FileUploading </h2>

package/dist/base/oneEntry.js

@@ -26,7 +26,6 @@ class OneEntry {
         };
         if (!this._NO_FETCH) {
             const response = await fetch(this._getFullPath(path), options);
-            // const result = await response.json()
             return await response.json();
         }
         else {
@@ -37,7 +36,6 @@ class OneEntry {
                         data += chunk;
                     });
                     res.on('end', () => {
-                        // const result = new Result(JSON.parse(data))
                         resolve(JSON.parse(data));
                     });
                 });

package/dist/blocks/blocksApi.d.ts

@@ -6,6 +6,16 @@ import { IConfig } from "../base/utils";
  */
 export default class BlocksApi extends OneEntry implements IBlocks {
     constructor(url: string, config: IConfig);
+    /**
+     * Get blocks by parameters.
+     *
+     * @param {string} [langCode] - Language code. Default "en_US"
+     * @param {number} [offset] - Parameter for pagination. Default 0
+     * @param {number} [limit] - Parameter for pagination. Default 30
+     *
+     * @returns Return array of BlocksEntity object.
+     */
+    getBlocks(langCode?: string, offset?: number, limit?: number): Promise<Array<IBlocksEntity>>;
     /**
      * Get block by marker.
      *
@@ -15,4 +25,26 @@ export default class BlocksApi extends OneEntry implements IBlocks {
      * @returns Return BlocksEntity object.
      */
     getBlockByMarker(marker: string, langCode?: string): Promise<IBlocksEntity>;
+    /**
+     * Get similar products by block marker.
+     *
+     * @param {string} marker - Block identifier
+     * @param {string} [langCode] - Language code. Default "en_US"
+     * @param {number} [offset] - Parameter for pagination. Default 0
+     * @param {number} [limit] - Parameter for pagination. Default 30
+     *
+     * @returns Return array of BlocksEntity object.
+     */
+    getSimilarProducts(marker: string, langCode?: string, offset?: number, limit?: number): Promise<any>;
+    /**
+     * Get products by block marker.
+     *
+     * @param {string} marker - Block identifier
+     * @param {string} [langCode] - Language code. Default "en_US"
+     * @param {number} [offset] - Parameter for pagination. Default 0
+     * @param {number} [limit] - Parameter for pagination. Default 30
+     *
+     * @returns Return array of BlocksEntity object.
+     */
+    getProductsByBlockMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<any>;
 }

package/dist/blocks/blocksApi.js

@@ -9,19 +9,37 @@ class BlocksApi extends oneEntry_1.default {
         super(url, config);
         this._url += '/api/content/blocks';
     }
-    // /**
-    //  * Get blocks by parameters.
-    //  *
-    //  * @param {string} [langCode] - Language code. Default "en_US"
-    //  * @param {number} [offset] - Parameter for pagination. Default 0
-    //  * @param {number} [limit] - Parameter for pagination. Default 30
-    //  *
-    //  * @returns Return array of BlocksEntity object.
-    //  */
-    // public async getBlocks(langCode:string = 'en_US', offset:number = 0, limit:number = 30):Promise<Array<IBlocksEntity>>{
-    //     const result = await this._fetchGet(`&langCode=${langCode}&offset=${offset}&limit=${limit}`)
-    //     return result
-    // }
+    /**
+     * Get blocks by parameters.
+     *
+     * @param {string} [langCode] - Language code. Default "en_US"
+     * @param {number} [offset] - Parameter for pagination. Default 0
+     * @param {number} [limit] - Parameter for pagination. Default 30
+     *
+     * @returns Return array of BlocksEntity object.
+     */
+    async getBlocks(langCode = 'en_US', offset = 0, limit = 30) {
+        const response = await this._fetchGet(`?langCode=${langCode}&offset=${offset}&limit=${limit}`);
+        const normalizeResponse = this._normalizeData(response);
+        await Promise.all(normalizeResponse.map(async (block) => {
+            const customSettings = block.customSettings;
+            if (customSettings.hasOwnProperty('productConfig')) {
+                block.countElementsPerRow = Number(customSettings.productConfig.countElementsPerRow);
+            }
+            delete block.customSettings;
+            if (block.type === 'forSimilarProductBlock') {
+                await this.getSimilarProducts(block.identifier, langCode, offset, limit).then((result) => {
+                    block.similarProducts = result;
+                });
+            }
+            else if (block.type === 'forProductBlock') {
+                await this.getProductsByBlockMarker(block.identifier, langCode, offset, limit).then((result) => {
+                    block.products = result;
+                });
+            }
+        }));
+        return normalizeResponse;
+    }
     /**
      * Get block by marker.
      *
@@ -31,8 +49,52 @@ class BlocksApi extends oneEntry_1.default {
      * @returns Return BlocksEntity object.
      */
     async getBlockByMarker(marker, langCode = this._defaultLangCode) {
-        const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
-        return this._dataPostProcess(result, langCode);
+        const response = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
+        const normalizeResponse = this._normalizeData(response);
+        const customSettings = normalizeResponse.customSettings;
+        if (customSettings.hasOwnProperty('productConfig')) {
+            normalizeResponse.countElementsPerRow = Number(customSettings.productConfig.countElementsPerRow);
+        }
+        delete normalizeResponse.customSettings;
+        if (normalizeResponse.type === 'forSimilarProductBlock') {
+            await this.getSimilarProducts(normalizeResponse.identifier, langCode).then((result) => {
+                normalizeResponse.similarProducts = result;
+            });
+        }
+        else if (normalizeResponse.type === 'forProductBlock') {
+            await this.getProductsByBlockMarker(normalizeResponse.identifier, langCode).then((result) => {
+                normalizeResponse.products = result;
+            });
+        }
+        return normalizeResponse;
+    }
+    /**
+     * Get similar products by block marker.
+     *
+     * @param {string} marker - Block identifier
+     * @param {string} [langCode] - Language code. Default "en_US"
+     * @param {number} [offset] - Parameter for pagination. Default 0
+     * @param {number} [limit] - Parameter for pagination. Default 30
+     *
+     * @returns Return array of BlocksEntity object.
+     */
+    async getSimilarProducts(marker, langCode = 'en_US', offset = 0, limit = 30) {
+        const result = await this._fetchGet(`/${marker}/similar-products?langCode=${langCode}&offset=${offset}&limit=${limit}`);
+        return this._normalizeData(result.items);
+    }
+    /**
+     * Get products by block marker.
+     *
+     * @param {string} marker - Block identifier
+     * @param {string} [langCode] - Language code. Default "en_US"
+     * @param {number} [offset] - Parameter for pagination. Default 0
+     * @param {number} [limit] - Parameter for pagination. Default 30
+     *
+     * @returns Return array of BlocksEntity object.
+     */
+    async getProductsByBlockMarker(marker, langCode = 'en_US', offset = 0, limit = 30) {
+        const result = await this._fetchGet(`/${marker}/products?langCode=${langCode}&offset=${offset}&limit=${limit}`);
+        return this._normalizeData(result.items);
     }
 }
 exports.default = BlocksApi;

package/dist/blocks/blocksInterfaces.d.ts

@@ -3,9 +3,29 @@
  *
  * @property {function} getBlocks - Get all Blocks objects.
  * @property {function} getBlockByMarker - Get Block object by marker.
+ * @property {function} getSimilarProducts - Get Array of similar products from product-similar block.
+ * @property {function} getProductsByBlockMarker - Get Array of products from product block.
  */
 interface IBlocks {
+    getBlocks(langCode: string, offset?: number, limit?: number): Promise<Array<IBlocksEntity>>;
     getBlockByMarker(marker: string, langCode: string): Promise<IBlocksEntity>;
+    getSimilarProducts(marker: string, langCode?: string, offset?: number, limit?: number): Promise<Array<ISimilarProduct>>;
+    getProductsByBlockMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<Array<ISimilarProduct>>;
+}
+interface ISimilarProduct {
+    attributeSetId: number;
+    attributeValues: Record<string, any>;
+    id: number;
+    isSync: boolean;
+    isVisible: boolean;
+    localizeInfos: Record<string, any>;
+    position: number;
+    price: number;
+    relatedIds: Array<number>;
+    shortDescTemplateIdentifier: string | null;
+    sku: string;
+    statusId: number | null;
+    templateIdentifier: string | null;
 }
 interface IBlocksEntity {
     id: number;
@@ -19,6 +39,9 @@ interface IBlocksEntity {
     attributeValues: Record<string, any>;
     type: string;
     templateIdentifier: string | null;
+    countElementsPerRow?: number;
+    similarProducts?: Array<ISimilarProduct>;
+    products?: Array<ISimilarProduct>;
 }
 interface ICustomSetting {
     sliderDelay: number;
@@ -33,5 +56,6 @@ interface ICustomSetting {
         keywords: string;
         strict: string;
     }> | Record<string, any>;
+    [key: string]: any;
 }
 export { IBlocks, IBlocksEntity };

package/dist/general-types/typesApi.d.ts

@@ -0,0 +1,15 @@
+import OneEntry from "../base/oneEntry";
+import { IGeneralTypes, IGeneralTypesEntity } from "./generalTypesInterfaces";
+import { IConfig } from "../base/utils";
+/**
+ * Controllers for working with types
+ */
+export default class GeneralTypesApi extends OneEntry implements IGeneralTypes {
+    constructor(url: string, config: IConfig);
+    /**
+     * Get all types.
+     *
+     * @returns Returns all objects of type GeneralTypeEntity
+     */
+    getAllTypes(): Promise<Array<IGeneralTypesEntity>>;
+}

package/dist/general-types/typesApi.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const oneEntry_1 = require("../base/oneEntry");
+/**
+ * Controllers for working with types
+ */
+class GeneralTypesApi extends oneEntry_1.default {
+    constructor(url, config) {
+        super(url, config);
+        this._url += '/api/content/general-types';
+    }
+    /**
+     * Get all types.
+     *
+     * @returns Returns all objects of type GeneralTypeEntity
+     */
+    async getAllTypes() {
+        const result = await this._fetchGet('');
+        return result;
+    }
+}
+exports.default = GeneralTypesApi;

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import ProductStatusesApi from "./product-statuses/productStatusesApi";
 import TemplatesApi from "./templates/templatesApi";
 import TemplatePreviewsApi from "./templates-preview/templatesPreviewApi";
 import AdminsApi from "./admins/adminsApi";
-import GeneralTypesApi from "./general-types/GeneralTypesApi";
+import GeneralTypesApi from "./general-types/typesApi";
 import LocalesApi from "./locales/localesApi";
 import MenusApi from "./menus/menusApi";
 import FormsApi from "./forms/formsApi";

package/dist/index.js

@@ -7,7 +7,7 @@ const productStatusesApi_1 = require("./product-statuses/productStatusesApi");
 const templatesApi_1 = require("./templates/templatesApi");
 const templatesPreviewApi_1 = require("./templates-preview/templatesPreviewApi");
 const adminsApi_1 = require("./admins/adminsApi");
-const GeneralTypesApi_1 = require("./general-types/GeneralTypesApi");
+const typesApi_1 = require("./general-types/typesApi");
 const localesApi_1 = require("./locales/localesApi");
 const menusApi_1 = require("./menus/menusApi");
 const formsApi_1 = require("./forms/formsApi");
@@ -32,7 +32,7 @@ function defineOneEntry(url, config) {
     const FileUploading = new fileUploadingApi_1.default(url, config);
     const Forms = new formsApi_1.default(url, config);
     const FormData = new formsDataApi_1.default(url, config);
-    const GeneralTypes = new GeneralTypesApi_1.default(url, config);
+    const GeneralTypes = new typesApi_1.default(url, config);
     const Locales = new localesApi_1.default(url, config);
     const Markers = new markersApi_1.default(url, config);
     const Menus = new menusApi_1.default(url, config);

package/dist/pages/pagesApi.js

@@ -18,7 +18,8 @@ class PageApi extends oneEntry_1.default {
      */
     async getRootPages(langCode = this._defaultLangCode) {
         const result = await this._fetchGet(`/root?langCode=${langCode}`);
-        return this._normalizeData(result.items, langCode);
+        console.log(result);
+        return this._normalizeData(result, langCode);
     }
     /**
      * Get all page objects with product information as an array.
@@ -33,7 +34,7 @@ class PageApi extends oneEntry_1.default {
      */
     async getCatalogPages(langCode = this._defaultLangCode, limit = 30, offset = 0) {
         const result = await this._fetchGet(`/catalog?langCode=${langCode}&limit=${limit}&offset=${offset}`);
-        return this._normalizeData(result.items, langCode);
+        return this._normalizeData(result, langCode);
     }
     /**
      * Get all page objects with product information as an array.
@@ -83,7 +84,7 @@ class PageApi extends oneEntry_1.default {
      */
     async getChildPagesByParentUrl(url, langCode = this._defaultLangCode) {
         const result = await this._fetchGet(`/${url}/children?langCode=${langCode}`);
-        return this._normalizeData(result.items, langCode);
+        return this._normalizeData(result, langCode);
     }
     /**
      * Get all forms by page url.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.51",
+  "version": "1.0.53",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",