oneentry 1.0.39 → 1.0.40

package/README.md

@@ -50,6 +50,11 @@ Or
 const api = defineOneEntry('your-url')
 ```
 
+The second parameter of the function takes a configuration object with the keys "token" and "langCode".
+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"
+
 >If you chose token protection to ensure connection security, just pass your token to the function as an optional parameter.
 
 You can get a token as follows
@@ -65,12 +70,28 @@ Also, you can connect a tls certificate to secure your project. In this case, do
 
 
 ```js
-const api = defineOneEntry('your-url', 'your-token')
+const api = defineOneEntry('your-url', {token: 'my-token', langCode:'my-langCode'})
 ```
+Now you can use the following links to jump to specific entries:
+- [Admins](#admins)
+- [AttributesSets](#attributessets)
+- [Blocks](#blocks)
+- [Forms](#forms)
+- [FormData](#formdata)
+- [FileUploading](#fileuploading)
+- [GeneralTypes](#generaltypes)
+- [Locales](#locales)
+- [Markers](#markers)
+- [Menus](#menus)
+- [Pages](#pages)
+- [Products](#products)
+- [ProductStatuses](#productstatuses)
+- [System](#system)
+- [Templates](#templates)
+- [TemplatePreviews](#templatepreviews)
 
 
-
-## Admins
+<h2 id="admins"> Admins </h2>
 
 
 ```js
@@ -141,7 +162,7 @@ example: 192
 
 
 
-## AttributesSets
+<h2 id="attributessets"> AttributesSets </h2>
 
 ```js
 const { AttributesSets } = defineOneEntry('your-url');
@@ -307,8 +328,7 @@ example: List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extende
 ---
 
 
-
-## Blocks
+<h2 id="blocks"> Blocks </h2>
 
 ```js
 const { Blocks } = defineOneEntry('your-url');
@@ -412,8 +432,7 @@ example: null
 
 
 
-
-## FileUploading
+<h2 id="fileuploading"> FileUploading </h2>
 
 const { FileUploading } = defineOneEntry('your-url');
 
@@ -496,8 +515,8 @@ Example return:
 
 
 
+<h2 id="forms"> Forms </h2>
 
-## Forms
 
 const { Forms } = defineOneEntry('your-url');
 
@@ -705,8 +724,7 @@ example: List [ OrderedMap { "type": "list", "marker": "l1", "position": 2, "lis
 ---
 
 
-
-## FormData
+<h2 id="formdata"> FormData </h2>
 
 const { FormData } = defineOneEntry('your-url');
 
@@ -852,8 +870,7 @@ example: test-form
 ---
 
 
-
-## GeneralTypes
+<h2 id="generaltypes"> GeneralTypes </h2>
 
 const { GeneralTypes } = defineOneEntry('your-url');
 
@@ -892,8 +909,7 @@ Enum:
 ---
 
 
-
-## Locales
+<h2 id="locales"> Locales </h2>
 
 ```js
 const { Locales } = defineOneEntry('your-url')
@@ -963,8 +979,8 @@ description:position number
 
 
 
+<h2 id="markers"> Markers </h2>
 
-## Markers
 
 ```js
 const { Markers } = defineOneEntry('your-url')
@@ -1134,6 +1150,7 @@ example: OrderedMap { "en_US": OrderedMap { "title": "My marker" } }
 
 ---
 
+<h2 id="menus"> Menus </h2>
 
 ## Menus
 
@@ -1198,70 +1215,12 @@ example: List [ OrderedMap { "id": 11, "pageUrl": "122", "localizeInfos": Ordere
 
 ---
 
-
-## Pages
+<h2 id="pages"> Pages </h2>
 
 ```js
 const { Pages } = defineOneEntry('your-url')
 ```
 
-> In some methods, the langcode parameter can be either a string or an array of strings. It depends on which set of values will contain "attributeValues" and "localizeInfos" 
-
-Example: 
-
-```
- const value = await Pages.getRootPages('en_US')
- 
- "localizeInfos": {
-      {
-        "title": "Catalog",
-        "content": "Content from catalog",
-        "menuTitle": "Catalog"
-      }
- },
- "attributeValues": {
-      {
-        "marker": {
-          "value": "Value",
-          "type": "string"
-        }
-      }
- }   
- ```
-
- Or
-
-```
-const value = await Pages.getRootPages([ 'en_US', 'it_IT' ])
-
- "localizeInfos": {
-      en_US: {
-        "title": "Catalog",
-        "content": "Content from catalog",
-        "menuTitle": "Catalog"
-      },
-      it_IT: {
-        "title": "Catalogo",
-        "content": "Contenuto dal catalogo",
-        "menuTitle": "Catalogo"
-      }
- },
- "attributeValues": {
-      en_US: {
-        "marker": {
-          "value": "Value",
-          "type": "string"
-        }
-      },
-      it_IT: {
-        "marker": {
-          "value": "Valore",
-          "type": "string"
-        }
-      }
- }
-```
-
 ### Pages.getRootPages(langCode)
 
 ```js
@@ -2217,8 +2176,8 @@ Example return:
 ---
 
 
+<h2 id="products"> Products </h2>
 
-## Products
 
 ```js
 const { Products } = defineOneEntry('your-url')
@@ -2258,62 +2217,6 @@ const userQuery = {
 >
 > 'nexs' - Does not exist
 
-In some methods, the langcode parameter (default 'en_US') can be either a string or an array of strings. It depends on which set of values will contain "attributeValues" and "localizeInfos"
-
-Example
-
-```
- const value = await Products.getProducts('en_US')
- 
- "localizeInfos": {
-      {
-        "title": "Catalog",
-        "content": "Content from catalog",
-        "menuTitle": "Catalog"
-      }
- },
- "attributeValues": {
-      {
-        "marker": {
-          "value": "Value",
-          "type": "string"
-        }
-      }
- }   
- ```
-
-Or
-
-```
-const value = await Products.getProducts([ 'en_US', 'it_IT' ])
-
- "localizeInfos": {
-      en_US: {
-        "title": "Catalog",
-        "content": "Content from catalog",
-        "menuTitle": "Catalog"
-      },
-      it_IT: {
-        "title": "Catalogo",
-        "content": "Contenuto dal catalogo",
-        "menuTitle": "Catalogo"
-      }
- },
- "attributeValues": {
-      en_US: {
-        "marker": {
-          "value": "Value",
-          "type": "string"
-        }
-      },
-      it_IT: {
-        "marker": {
-          "value": "Valore",
-          "type": "string"
-        }
-      }
- }
-```
 
 ### Products.getProducts(langCode, userQuery)
 
@@ -3137,8 +3040,8 @@ example: my-template-short
 ---
 
 
+<h2 id="productstatuses"> ProductStatuses </h2>
 
-## ProductStatuses
 
 ```js
 const { ProductStatuses } = defineOneEntry('your-url');
@@ -3298,6 +3201,7 @@ true
 ---
 
 
+<h2 id="system"> System </h2>
 
 ## System
 
@@ -3322,6 +3226,8 @@ const value = await System.test500()
 > This method allows you to redirect to the error page.
 
 
+<h2 id="templates"> Templates </h2>
+
 ## Templates
 
 ```js
@@ -3482,6 +3388,9 @@ general type name
 
 ---
 
+
+<h2 id="templatepreviews"> TemplatePreviews </h2>
+
 ## TemplatePreviews
 
 ```js

package/dist/admins/adminsApi.d.ts

@@ -1,10 +1,11 @@
 import OneEntry from "../base/oneEntry";
 import { IAdminEntity, IAdmins } from "./adminsInterfaces";
+import { IConfig } from "../base/utils";
 /**
  * Controllers for working with users - admins
  */
 export default class AdminsApi extends OneEntry implements IAdmins {
-    constructor(url: string, token: string);
+    constructor(url: string, config: IConfig);
     /**
      * Get all user objects - admins.
      *

package/dist/admins/adminsApi.js

@@ -5,8 +5,8 @@ const oneEntry_1 = require("../base/oneEntry");
  * Controllers for working with users - admins
  */
 class AdminsApi extends oneEntry_1.default {
-    constructor(url, token) {
-        super(url, token);
+    constructor(url, config) {
+        super(url, config);
         this._url += '/api/content/admins';
     }
     /**
@@ -18,7 +18,7 @@ class AdminsApi extends oneEntry_1.default {
      *
      * @returns Returns all AdminEntity user objects
      */
-    async getAdminsInfo(langCode = 'en_US', offset = 0, limit = 30) {
+    async getAdminsInfo(langCode = this._defaultLangCode, offset = 0, limit = 30) {
         const result = await this._fetchGet(`?langCode=${langCode}&offset=${offset}&limit=${limit}`);
         return this._normalizeData(result);
     }

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

@@ -1,10 +1,11 @@
 import OneEntry from "../base/oneEntry";
 import { IAttributesSets, IAttributesSetsEntity } from "./attributeSetsInterfaces";
+import { IConfig } from "../base/utils";
 /**
  * Controllers for working with attributes.
  */
 export default class AttributesSetsApi extends OneEntry implements IAttributesSets {
-    constructor(url: string, token: string);
+    constructor(url: string, config: IConfig);
     /**
      * Get all attributes with data from the attribute sets.
      *

package/dist/attribute-sets/attributeSetsApi.js

@@ -5,8 +5,8 @@ const oneEntry_1 = require("../base/oneEntry");
  * Controllers for working with attributes.
  */
 class AttributesSetsApi extends oneEntry_1.default {
-    constructor(url, token) {
-        super(url, token);
+    constructor(url, config) {
+        super(url, config);
         this._url += '/api/content/attributes-sets';
     }
     /**
@@ -17,7 +17,7 @@ class AttributesSetsApi extends oneEntry_1.default {
      *
      * @returns Returns an array of AttributeInSet objects.
      */
-    async getAttributesByMarker(marker, langCode = 'en_US') {
+    async getAttributesByMarker(marker, langCode = this._defaultLangCode) {
         const result = await this._fetchGet(`/${marker}/attributes?langCode=${langCode}`);
         return this._normalizeData(result);
     }
@@ -30,7 +30,7 @@ class AttributesSetsApi extends oneEntry_1.default {
      *
      * @returns Returns a AttributeInSet object.
      */
-    async getSingleAttributeByMarkerSet(attributeMarker, setMarker, langCode = 'en_US') {
+    async getSingleAttributeByMarkerSet(attributeMarker, setMarker, langCode = this._defaultLangCode) {
         const result = await this._fetchGet(`/${setMarker}/attributes/${attributeMarker}?langCode=${langCode}`);
         return result;
     }

package/dist/base/oneEntry.d.ts

@@ -1,18 +1,17 @@
 import { IProductsQuery } from '../products/productsInterfaces';
-import { LangType } from "./utils";
+import { IConfig } from "./utils";
 import { IUploadingQuery } from "../file-uploding/fileUploadingInterfaces";
 export default abstract class OneEntry {
     protected _url: string;
-    protected _token: string;
-    protected _LANGCODE_KEY: string;
+    protected _token: string | undefined;
+    protected _defaultLangCode: string;
     protected _NO_FETCH: boolean;
-    constructor(url: string, token?: string);
+    protected _https: any;
+    constructor(url: string, config: IConfig);
     protected _getFullPath(path: string): string;
     protected _fetchGet(path: string): Promise<any>;
     protected _fetchPost(path: string, data: any): Promise<any>;
     protected _fetchDelete(path: string): Promise<any>;
     protected _queryParamsToString(query: IProductsQuery | IUploadingQuery): string;
-    protected _parseLangFromString(str: string, lang: string): string;
-    protected _fetchRequests(url: string, lang: LangType): Promise<any>;
     protected _normalizeData(data: any): any;
 }

package/dist/base/oneEntry.js

@@ -1,16 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 class OneEntry {
-    constructor(url, token) {
-        this._LANGCODE_KEY = '$LANGCODE';
-        this._NO_FETCH = false;
+    constructor(url, config) {
         this._url = url;
-        if (token) {
-            this._token = token;
-        }
-        if (typeof process === 'object' && process.versions && process.versions.node) {
-            this._NO_FETCH = true;
-        }
+        this._token = config.token;
+        this._defaultLangCode = config.langCode ? config.langCode : 'en_US';
+        this._NO_FETCH = !!(typeof process === 'object' && process.versions);
+        this._https = this._NO_FETCH ? require('https') : null;
     }
     _getFullPath(path) {
         return (this._url + path);
@@ -29,9 +25,8 @@ class OneEntry {
             return result;
         }
         else {
-            const https = require('https');
             return new Promise((resolve, reject) => {
-                const req = https.get(this._getFullPath(path), options, (res) => {
+                const req = this._https.get(this._getFullPath(path), options, (res) => {
                     let data = '';
                     res.on('data', (chunk) => {
                         data += chunk;
@@ -65,9 +60,8 @@ class OneEntry {
             return await response.json();
         }
         else {
-            const https = require('https');
             return new Promise((resolve, reject) => {
-                const req = https.request(this._getFullPath(path), options, (res) => {
+                const req = this._https.request(this._getFullPath(path), options, (res) => {
                     let responseData = '';
                     res.on('data', (chunk) => {
                         responseData += chunk;
@@ -98,9 +92,8 @@ class OneEntry {
             return result;
         }
         else {
-            const https = require('https');
             return new Promise((resolve, reject) => {
-                const req = https.get(this._getFullPath(path), options, (res) => {
+                const req = this._https.delete(this._getFullPath(path), options, (res) => {
                     let data = '';
                     res.on('data', (chunk) => {
                         data += chunk;
@@ -124,62 +117,18 @@ class OneEntry {
         }
         return result.slice(0, (result.length - 1));
     }
-    _parseLangFromString(str, lang) {
-        const index = str.indexOf(this._LANGCODE_KEY);
-        if (index === -1) {
-            console.error('The endpoint does not contain a language template $LANGCODE');
-        }
-        else {
-            return str.slice(0, index) + lang + str.slice(index + this._LANGCODE_KEY.length);
-        }
-    }
-    async _fetchRequests(url, lang) {
-        const langCode = (typeof lang === 'string') ? [lang] : lang;
-        if (langCode.length === 1) {
-            const response = await this._fetchGet(this._parseLangFromString(url, langCode[0]));
-            if (response.hasOwnProperty('items') || Array.isArray(response)) {
-                let result = Array.isArray(response) ? response : response.items;
-                result = result.map(item => this._normalizeData(item));
-                return result;
-            }
-            return this._normalizeData(response);
-        }
-        else {
-            const dataList = [];
-            await Promise.all(langCode.map(async (lang) => {
-                await this._fetchGet(this._parseLangFromString(url, lang)).then((result) => {
-                    result.hasOwnProperty('items') ? dataList.push(result.items) : dataList.push(result);
-                });
-            }));
-            const baseData = dataList.splice(0, 1)[0];
-            dataList.map(item => {
-                if (Array.isArray(item)) {
-                    item.map((subitem, index) => {
-                        Object.assign(baseData[index].attributeValues, subitem.attributeValues);
-                        Object.assign(baseData[index].localizeInfos, subitem.localizeInfos);
-                    });
-                }
-                else {
-                    Object.assign(baseData.attributeValues, item.attributeValues);
-                    Object.assign(baseData.localizeInfos, item.localizeInfos);
-                }
-            });
-            return baseData;
-        }
-    }
     _normalizeData(data) {
-        const normalizeData = Object.assign({}, data);
-        if (data.hasOwnProperty('attributeValues')) {
-            const key = Object.keys(data.attributeValues);
-            normalizeData.attributeValues = data.attributeValues[key[0]];
-        }
-        if (data.hasOwnProperty('localizeInfos')) {
-            const key = Object.keys(data.localizeInfos);
-            normalizeData.localizeInfos = data.localizeInfos[key[0]];
-        }
-        if (data.hasOwnProperty('formData')) {
-            const key = Object.keys(data.formData);
-            normalizeData.formData = data.formData[key[0]].flat();
+        const normalizeData = {};
+        for (let key in data) {
+            if (Array.isArray(data[key]) || !data[key] || typeof data[key] !== 'object') {
+                normalizeData[key] = data[key];
+            }
+            else if (data[key][this._defaultLangCode]) {
+                normalizeData[key] = data[key][this._defaultLangCode];
+            }
+            else {
+                normalizeData[key] = this._normalizeData(data[key]);
+            }
         }
         return normalizeData;
     }

package/dist/base/utils.d.ts

@@ -19,6 +19,10 @@ declare enum Types {
     forSlider = "forSlider",
     service = "service"
 }
+interface IConfig {
+    token?: string;
+    langCode?: string;
+}
 interface IAttributes {
     listTitles: Array<{
         title: string;
@@ -65,4 +69,4 @@ interface IAttributeSetEntity {
 }
 type LangType = string | Array<string>;
 type LocalizeType = ILocalizeInfos | ILocalizeInfo;
-export { LocalizeType, ILocalizeInfos, ILocalizeInfo, Types, IAttributeSetEntity, LangType, AttributeType, IAttributeValues, IAttributes };
+export { LocalizeType, ILocalizeInfos, ILocalizeInfo, Types, IAttributeSetEntity, LangType, AttributeType, IAttributeValues, IAttributes, IConfig };

package/dist/blocks/blocksApi.d.ts

@@ -1,10 +1,11 @@
 import OneEntry from "../base/oneEntry";
 import { IBlocks, IBlocksEntity } from "./blocksInterfaces";
+import { IConfig } from "../base/utils";
 /**
  * Controllers for working with blocks
  */
 export default class BlocksApi extends OneEntry implements IBlocks {
-    constructor(url: string, token: string);
+    constructor(url: string, config: IConfig);
     /**
      * Get block by marker.
      *

package/dist/blocks/blocksApi.js

@@ -5,8 +5,8 @@ const oneEntry_1 = require("../base/oneEntry");
  * Controllers for working with blocks
  */
 class BlocksApi extends oneEntry_1.default {
-    constructor(url, token) {
-        super(url, token);
+    constructor(url, config) {
+        super(url, config);
         this._url += '/api/content/blocks';
     }
     // /**
@@ -30,7 +30,7 @@ class BlocksApi extends oneEntry_1.default {
      *
      * @returns Return BlocksEntity object.
      */
-    async getBlockByMarker(marker, langCode = 'en_US') {
+    async getBlockByMarker(marker, langCode = this._defaultLangCode) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
         return this._normalizeData(result);
     }

package/dist/file-uploding/fileUploadingApi.d.ts

@@ -1,10 +1,11 @@
 import OneEntry from '../base/oneEntry';
 import { IUploadingQuery, IUploadingReturns, IFileUploading, IFileEntity } from "./fileUploadingInterfaces";
+import { IConfig } from "../base/utils";
 /**
  * Controllers for working with file uploading
  */
 export default class FileUploadingApi extends OneEntry implements IFileUploading {
-    constructor(url: string, token: string);
+    constructor(url: string, config: IConfig);
     private _defaultQuery;
     /**
      * Upload file function.

package/dist/file-uploding/fileUploadingApi.js

@@ -5,8 +5,8 @@ const oneEntry_1 = require("../base/oneEntry");
  * Controllers for working with file uploading
  */
 class FileUploadingApi extends oneEntry_1.default {
-    constructor(url, token) {
-        super(url, token);
+    constructor(url, config) {
+        super(url, config);
         this._defaultQuery = {
             type: null,
             entity: null,

package/dist/forms/formsApi.d.ts

@@ -1,10 +1,11 @@
 import OneEntry from "../base/oneEntry";
 import { IForms, IFormsEntity } from "./formsInterfaces";
+import { IConfig } from "../base/utils";
 /**
  * Controllers for forms objects
  */
 export default class FormsApi extends OneEntry implements IForms {
-    constructor(url: string, token: string);
+    constructor(url: string, config: IConfig);
     /**
      * Get all forms.
      *

package/dist/forms/formsApi.js

@@ -5,8 +5,8 @@ const oneEntry_1 = require("../base/oneEntry");
  * Controllers for forms objects
  */
 class FormsApi extends oneEntry_1.default {
-    constructor(url, token) {
-        super(url, token);
+    constructor(url, config) {
+        super(url, config);
         this._url += '/api/content/forms';
     }
     /**
@@ -18,7 +18,7 @@ class FormsApi extends oneEntry_1.default {
      *
      * @returns Returns array for all objects of type FormEntity
      */
-    async getAllForms(langCode = 'en_US', offset = 0, limit = 30) {
+    async getAllForms(langCode = this._defaultLangCode, offset = 0, limit = 30) {
         const result = await this._fetchGet(`?langCode=${langCode}&offset=${offset}&limit=${limit}`);
         return this._normalizeData(result);
     }
@@ -30,7 +30,7 @@ class FormsApi extends oneEntry_1.default {
      *
      * @returns Returns object of type FormEntity
      */
-    async getFormByMarker(marker, langCode = 'en_US') {
+    async getFormByMarker(marker, langCode = this._defaultLangCode) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
         return this._normalizeData(result);
     }

package/dist/formsData/formsDataApi.d.ts

@@ -1,10 +1,11 @@
 import OneEntry from '../base/oneEntry';
 import { IFormsPost, IFormsData, IFormsDataEntity } from './formsDataInterfaces';
+import { IConfig } from "../base/utils";
 /**
  * Controllers for working with form data
  */
 export default class FormsDataApi extends OneEntry implements IFormsData {
-    constructor(url: string, token: string);
+    constructor(url: string, config: IConfig);
     /**
      * Get all forms data.
      *