oneentry 1.0.57 → 1.0.58

package/README.md

@@ -14,7 +14,7 @@ To get started with OneEntry, sign up for an account at [https://account.oneentr
 
 To install the OneEntry Headless CMS SDK in your project, run the following command:
 
-```
+```bash
 npm install oneentry
 ```
 
@@ -37,7 +37,7 @@ const {
         Menus,
         Pages,
         Products,
-        ProductstatusesSpec,
+        ProductStatuses,
         System,
         Templates,
         TemplatePreviews
@@ -50,10 +50,11 @@ Or
 const api = defineOneEntry('your-url')
 ```
 
-The second parameter of the function takes a configuration object with the keys "token" and "langCode".
+The second parameter of the function takes a configuration object with the keys "token", "langCode" and "multipleResponse".
 Set the token key if your project secure "Security API Token"
 
 Set the "langCode" to set the default language. By specifying this parameter once, you don't have to pass the langCode to the methods ONEENTRY API. If you have not passed the default language, it will be set "en_US"
+Some methods use more than one request to the CMS so that the data you receive is complete and easy to work with. Pass the value "false" for this parameter to save traffic and decide for yourself what data you need. The default value "true"
 
 >If you chose token protection to ensure connection security, just pass your token to the function as an optional parameter.
 
@@ -85,7 +86,7 @@ Now you can use the following links to jump to specific entries:
 - [Menus](#menus)
 - [Pages](#pages)
 - [Products](#products)
-- [ProductstatusesSpec](#productstatuses)
+- [ProductStatuses](#productstatuses)
 - [System](#system)
 - [Templates](#templates)
 - [TemplatePreviews](#templatepreviews)
@@ -464,50 +465,17 @@ Example return:
 
 ```json
 {
-  "id": 3,
+  "id": 1,
   "localizeInfos": {
-    "title": "test"
+    "title": "Block"
   },
   "version": 0,
-  "position": 4,
-  "identifier": "test",
-  "type": "forSimilarProductBlock",
+  "position": 1,
+  "identifier": "block",
+  "type": "forTextBlock",
   "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
-    }
-  ]
+  "attributeValues": {}
 }
 ```
 
@@ -574,29 +542,30 @@ Example return:
 ```json
 [
   {
-    "id": 446,
+    "id": 2,
     "localizeInfos": {
-      "title": "new product 3"
+      "title": "Box"
     },
-    "relatedIds": [1, 2],
-    "statusId": null,
-    "position": 3,
+    "relatedIds": [],
+    "statusId": 2,
+    "attributeSetId": 5,
+    "position": 1,
     "templateIdentifier": null,
     "shortDescTemplateIdentifier": null,
-    "price": 543,
-    "sku": "ggg",
+    "price": 150,
+    "sku": null,
     "isSync": true,
     "attributeValues": {
-      "sku": {
-        "type": "string",
-        "value": "ggg",
-        "position": 0,
+      "price": {
+        "type": "integer",
+        "value": "150",
+        "position": 1,
         "isProductPreview": false
       },
-      "images": {
-        "type": "groupOfImages",
-        "value": {},
-        "position": 3,
+      "product-name": {
+        "type": "string",
+        "value": "Box text",
+        "position": 0,
         "isProductPreview": false
       }
     },
@@ -607,7 +576,7 @@ Example return:
 
 
 
-### Blocks.getSimilarProducts(marker, langCode, offset, limit)
+### Blocks.getProductsByBlockMarker(marker, langCode, offset, limit)
 
 ```js
 const value = await Blocks.getProductsByBlockMarker('my-marker', 'en_US')

package/dist/base/oneEntry.d.ts

@@ -5,6 +5,7 @@ export default abstract class OneEntry {
     protected _url: string;
     protected _token: string | undefined;
     protected _defaultLangCode: string;
+    protected _multipleResponse: boolean;
     protected _NO_FETCH: boolean;
     protected _https: any;
     constructor(url: string, config?: IConfig);

package/dist/base/oneEntry.js

@@ -2,9 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 class OneEntry {
     constructor(url, config = {}) {
+        var _a;
         this._url = url;
         this._token = config.token;
         this._defaultLangCode = config.langCode ? config.langCode : 'en_US';
+        this._multipleResponse = (_a = config.multipleRequests) !== null && _a !== void 0 ? _a : true;
         this._NO_FETCH = !!(typeof process === 'object' && process.versions);
         try {
             this._https = this._NO_FETCH ? require('https') : null;
@@ -26,6 +28,10 @@ class OneEntry {
         };
         if (!this._NO_FETCH) {
             const response = await fetch(this._getFullPath(path), options);
+            if (!response.ok) {
+                const error = await response.json();
+                throw error;
+            }
             return await response.json();
         }
         else {
@@ -61,6 +67,10 @@ class OneEntry {
                 ...options,
                 body: data
             });
+            if (!response.ok) {
+                const error = await response.json();
+                throw error;
+            }
             return await response.json();
         }
         else {
@@ -92,8 +102,11 @@ class OneEntry {
         };
         if (!this._NO_FETCH) {
             const response = await fetch(this._getFullPath(path), options);
-            const result = await response.json();
-            return result;
+            if (!response.ok) {
+                const error = await response.json();
+                throw error;
+            }
+            return await response.json();
         }
         else {
             return new Promise((resolve, reject) => {

package/dist/base/utils.d.ts

@@ -19,9 +19,15 @@ declare enum Types {
     forSlider = "forSlider",
     service = "service"
 }
+/**
+ * @param {string} [token] - If your project is protected by a token, specify this token in this parameter.
+ * @param {string} [langCode] - specify the default language to avoid specifying it in every request.
+ * @param {boolean} [multipleRequests] - Some methods use multiple queries to make it easier to work with the API. Set this parameter to "false" to save traffic and decide for yourself what data you need.
+ */
 interface IConfig {
     token?: string;
     langCode?: string;
+    multipleRequests?: boolean;
 }
 interface IAttributes {
     listTitles: Array<{
@@ -69,4 +75,11 @@ interface IAttributeSetEntity {
 }
 type LangType = string | Array<string>;
 type LocalizeType = ILocalizeInfos | ILocalizeInfo;
-export { LocalizeType, ILocalizeInfos, ILocalizeInfo, Types, IAttributeSetEntity, LangType, AttributeType, IAttributeValues, IAttributes, IConfig };
+interface IError {
+    message: string;
+    pageData: any;
+    statusCode: number;
+    timestamp: string;
+    [key: string]: any;
+}
+export { LocalizeType, ILocalizeInfos, ILocalizeInfo, Types, IAttributeSetEntity, LangType, AttributeType, IAttributeValues, IAttributes, IConfig, IError };

package/dist/blocks/blocksApi.d.ts

@@ -1,5 +1,6 @@
 import OneEntry from "../base/oneEntry";
-import { IBlocks, IBlockEntity, IBlockProduct } from "./blocksInterfaces";
+import { IBlocks, IBlocksResponse, IBlockEntity } from "./blocksInterfaces";
+import { IProductsEntity } from "../products/productsInterfaces";
 import { IConfig } from "../base/utils";
 /**
  * Controllers for working with blocks
@@ -15,7 +16,7 @@ export default class BlocksApi extends OneEntry implements IBlocks {
      *
      * @returns Return array of BlocksEntity object.
      */
-    getBlocks(langCode?: string, offset?: number, limit?: number): Promise<Array<IBlockEntity>>;
+    getBlocks(langCode?: string, offset?: number, limit?: number): Promise<Array<IBlockEntity | IBlocksResponse>>;
     /**
      * Get block by marker.
      *
@@ -35,7 +36,7 @@ export default class BlocksApi extends OneEntry implements IBlocks {
      *
      * @returns Return array of BlocksEntity object.
      */
-    getSimilarProducts(marker: string, langCode?: string, offset?: number, limit?: number): Promise<Array<IBlockProduct>>;
+    getSimilarProducts(marker: string, langCode?: string, offset?: number, limit?: number): Promise<Array<IProductsEntity>>;
     /**
      * Get products by block marker.
      *
@@ -46,5 +47,5 @@ export default class BlocksApi extends OneEntry implements IBlocks {
      *
      * @returns Return array of BlocksEntity object.
      */
-    getProductsByBlockMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<Array<IBlockProduct>>;
+    getProductsByBlockMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<Array<IProductsEntity>>;
 }

package/dist/blocks/blocksApi.js

@@ -20,40 +20,43 @@ class BlocksApi extends oneEntry_1.default {
      */
     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 && customSettings.hasOwnProperty('productConfig')) {
-                block.countElementsPerRow = customSettings.productConfig.countElementsPerRow ? (+customSettings.productConfig.countElementsPerRow) : 0;
-            }
-            else {
-                block.countElementsPerRow = 0;
-            }
-            delete block.customSettings;
-            delete block.attributeSetId;
-            delete block.productPageUrls;
-            if (block.type === 'forSimilarProductBlock') {
-                try {
-                    await this.getSimilarProducts(block.identifier, langCode, offset, limit).then((result) => {
-                        block.similarProducts = result;
-                    });
+        if (this._multipleResponse) {
+            const normalizeResponse = this._normalizeData(response);
+            await Promise.all(normalizeResponse.map(async (block) => {
+                const customSettings = block.customSettings;
+                if (customSettings && customSettings.hasOwnProperty('productConfig')) {
+                    block.countElementsPerRow = customSettings.productConfig.countElementsPerRow ? (+customSettings.productConfig.countElementsPerRow) : 0;
                 }
-                catch {
-                    block.similarProducts = [];
+                else {
+                    block.countElementsPerRow = 0;
                 }
-            }
-            else if (block.type === 'forProductBlock') {
-                try {
-                    await this.getProductsByBlockMarker(block.identifier, langCode, offset, limit).then((result) => {
-                        block.products = result;
-                    });
+                delete block.customSettings;
+                delete block.attributeSetId;
+                delete block.productPageUrls;
+                if (block.type === 'forSimilarProductBlock') {
+                    try {
+                        await this.getSimilarProducts(block.identifier, langCode, offset, limit).then((result) => {
+                            block.similarProducts = result;
+                        });
+                    }
+                    catch {
+                        block.similarProducts = [];
+                    }
                 }
-                catch {
-                    block.products = [];
+                else if (block.type === 'forProductBlock') {
+                    try {
+                        await this.getProductsByBlockMarker(block.identifier, langCode, offset, limit).then((result) => {
+                            block.products = result;
+                        });
+                    }
+                    catch {
+                        block.products = [];
+                    }
                 }
-            }
-        }));
-        return normalizeResponse;
+            }));
+            return normalizeResponse;
+        }
+        return response;
     }
     /**
      * Get block by marker.
@@ -76,24 +79,26 @@ class BlocksApi extends oneEntry_1.default {
         delete normalizeResponse.customSettings;
         delete normalizeResponse.attributeSetId;
         delete normalizeResponse.productPageUrls;
-        if (normalizeResponse.type === 'forSimilarProductBlock') {
-            try {
-                await this.getSimilarProducts(normalizeResponse.identifier, langCode).then((result) => {
-                    normalizeResponse.similarProducts = result;
-                });
-            }
-            catch {
-                normalizeResponse.similarProducts = [];
-            }
-        }
-        else if (normalizeResponse.type === 'forProductBlock') {
-            try {
-                await this.getProductsByBlockMarker(normalizeResponse.identifier, langCode).then((result) => {
-                    normalizeResponse.products = result;
-                });
+        if (this._multipleResponse) {
+            if (normalizeResponse.type === 'forSimilarProductBlock') {
+                try {
+                    await this.getSimilarProducts(normalizeResponse.identifier, langCode).then((result) => {
+                        normalizeResponse.similarProducts = result;
+                    });
+                }
+                catch {
+                    normalizeResponse.similarProducts = [];
+                }
             }
-            catch {
-                normalizeResponse.products = [];
+            else if (normalizeResponse.type === 'forProductBlock') {
+                try {
+                    await this.getProductsByBlockMarker(normalizeResponse.identifier, langCode).then((result) => {
+                        normalizeResponse.products = result;
+                    });
+                }
+                catch {
+                    normalizeResponse.products = [];
+                }
             }
         }
         return normalizeResponse;

package/dist/blocks/blocksInterfaces.d.ts

@@ -1,3 +1,4 @@
+import { IProductsEntity } from "../products/productsInterfaces";
 /**
  * Represents a interface object of Blocks Api.
  *
@@ -7,25 +8,10 @@
  * @property {function} getProductsByBlockMarker - Get Array of products from product block.
  */
 interface IBlocks {
-    getBlocks(langCode: string, offset?: number, limit?: number): Promise<Array<IBlockEntity>>;
+    getBlocks(langCode: string, offset?: number, limit?: number): Promise<Array<IBlockEntity | IBlocksResponse>>;
     getBlockByMarker(marker: string, langCode: string): Promise<IBlockEntity>;
-    getSimilarProducts(marker: string, langCode?: string, offset?: number, limit?: number): Promise<Array<IBlockProduct>>;
-    getProductsByBlockMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<Array<IBlockProduct>>;
-}
-interface IBlockProduct {
-    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;
+    getSimilarProducts(marker: string, langCode?: string, offset?: number, limit?: number): Promise<Array<IProductsEntity>>;
+    getProductsByBlockMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<Array<IProductsEntity>>;
 }
 interface IBlocksResponse {
     id: number;
@@ -41,8 +27,8 @@ interface IBlocksResponse {
     templateIdentifier: string | null;
     countElementsPerRow?: number;
     productPageUrls: Array<any>;
-    similarProducts?: Array<IBlockProduct>;
-    products?: Array<IBlockProduct>;
+    similarProducts?: Array<IProductsEntity>;
+    products?: Array<IProductsEntity>;
 }
 interface IBlockEntity {
     attributeValues: Record<string, any>;
@@ -54,8 +40,8 @@ interface IBlockEntity {
     templateIdentifier: string | null;
     type: string;
     version: number;
-    similarProducts?: Array<IBlockProduct>;
-    products?: Array<IBlockProduct>;
+    similarProducts?: Array<IProductsEntity>;
+    products?: Array<IProductsEntity>;
     countElementsPerRow: number;
 }
 interface ICustomSetting {
@@ -73,4 +59,4 @@ interface ICustomSetting {
     }> | Record<string, any>;
     [key: string]: any;
 }
-export { IBlocks, IBlockEntity, IBlocksResponse, IBlockProduct, ICustomSetting };
+export { IBlocks, IBlockEntity, IBlocksResponse, ICustomSetting };

package/dist/pages/pagesApi.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const oneEntry_1 = require("../base/oneEntry");
+const blocksApi_1 = require("../blocks/blocksApi");
 /**
  * Controllers for working with page objects, including catalog pages
  */
@@ -18,7 +19,6 @@ class PageApi extends oneEntry_1.default {
      */
     async getRootPages(langCode = this._defaultLangCode) {
         const result = await this._fetchGet(`/root?langCode=${langCode}`);
-        console.log(result);
         return this._normalizeData(result, langCode);
     }
     /**
@@ -109,8 +109,47 @@ class PageApi extends oneEntry_1.default {
      * @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 = this._defaultLangCode) {
-        const result = await this._fetchGet(`/${url}/blocks?langCode=${langCode}`);
-        return this._normalizeData(result, langCode);
+        const response = await this._fetchGet(`/${url}/blocks?langCode=${langCode}`);
+        const normalizeResponse = this._normalizeData(response);
+        normalizeResponse.map((item) => {
+            const customSettings = item.customSettings;
+            if (customSettings && customSettings.hasOwnProperty('productConfig')) {
+                item.countElementsPerRow = customSettings.productConfig.countElementsPerRow ? (+customSettings.productConfig.countElementsPerRow) : 0;
+            }
+            else {
+                item.countElementsPerRow = 0;
+            }
+            delete item.customSettings;
+            delete item.attributeSetId;
+            return item;
+        });
+        if (this._multipleResponse) {
+            const Blocks = new blocksApi_1.default(this._url.split('/api')[0], {
+                langCode: this._defaultLangCode,
+                token: this._token
+            });
+            if (normalizeResponse.type === 'forSimilarProductBlock') {
+                try {
+                    await Blocks.getSimilarProducts(normalizeResponse.identifier, langCode).then((result) => {
+                        normalizeResponse.similarProducts = result;
+                    });
+                }
+                catch {
+                    normalizeResponse.similarProducts = [];
+                }
+            }
+            else if (normalizeResponse.type === 'forProductBlock') {
+                try {
+                    await Blocks.getProductsByBlockMarker(normalizeResponse.identifier, langCode).then((result) => {
+                        normalizeResponse.products = result;
+                    });
+                }
+                catch {
+                    normalizeResponse.products = [];
+                }
+            }
+        }
+        return normalizeResponse;
     }
     /**
      * Get settings for the page.

package/dist/products/productsApi.js

@@ -238,13 +238,16 @@ class ProductApi extends oneEntry_1.default {
      */
     async searchProduct(name, langCode = this._defaultLangCode) {
         const searchProducts = await this._fetchGet(`/quick/search?lang=${langCode}&name=${name}`);
-        const productsList = [];
-        await Promise.all(searchProducts.map(async (product) => {
-            await this.getProductById(product.id, langCode).then((result) => {
-                productsList.push(result);
-            });
-        }));
-        return this._dataPostProcess(productsList, langCode);
+        if (this._multipleResponse) {
+            const productsList = [];
+            await Promise.all(searchProducts.map(async (product) => {
+                await this.getProductById(product.id, langCode).then((result) => {
+                    productsList.push(result);
+                });
+            }));
+            return this._dataPostProcess(productsList, langCode);
+        }
+        return searchProducts;
     }
 }
 exports.default = ProductApi;

package/dist/products/productsInterfaces.d.ts

@@ -119,6 +119,6 @@ interface IProductsEntity {
     attributeValues: Record<string, any>;
     position: number;
     sku: string | null;
-    productPages: Array<Record<string, any>> | Record<string, any>;
+    productPages?: Array<Record<string, any>> | Record<string, any>;
 }
 export { IFilterParams, IProductsQuery, IProductApi, IProductsEntity, };

package/package.json

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