oneentry 1.0.41 → 1.0.44

package/README.md

@@ -37,7 +37,7 @@ const {
         Menus,
         Pages,
         Products,
-        ProductStatuses,
+        ProductstatusesSpec,
         System,
         Templates,
         TemplatePreviews
@@ -85,13 +85,13 @@ Now you can use the following links to jump to specific entries:
 - [Menus](#menus)
 - [Pages](#pages)
 - [Products](#products)
-- [ProductStatuses](#productstatuses)
+- [ProductstatusesSpec](#productstatuses)
 - [System](#system)
 - [Templates](#templates)
 - [TemplatePreviews](#templatepreviews)
 
 
-<h2 id="admins"> Admins </h2>
+## <h2 id="admins"> Admins </h2>
 
 
 ```js
@@ -162,7 +162,7 @@ example: 192
 
 
 
-<h2 id="attributessets"> AttributesSets </h2>
+## <h2 id="attributessets"> AttributesSets </h2>
 
 ```js
 const { AttributesSets } = defineOneEntry('your-url');
@@ -328,7 +328,7 @@ example: List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extende
 ---
 
 
-<h2 id="blocks"> Blocks </h2>
+## <h2 id="blocks"> Blocks </h2>
 
 ```js
 const { Blocks } = defineOneEntry('your-url');
@@ -432,7 +432,7 @@ example: null
 
 
 
-<h2 id="fileuploading"> FileUploading </h2>
+## <h2 id="fileuploading"> FileUploading </h2>
 
 const { FileUploading } = defineOneEntry('your-url');
 
@@ -515,7 +515,7 @@ Example return:
 
 
 
-<h2 id="forms"> Forms </h2>
+## <h2 id="forms"> Forms </h2>
 
 
 const { Forms } = defineOneEntry('your-url');
@@ -724,7 +724,7 @@ example: List [ OrderedMap { "type": "list", "marker": "l1", "position": 2, "lis
 ---
 
 
-<h2 id="formdata"> FormData </h2>
+## <h2 id="formdata"> FormData </h2>
 
 const { FormData } = defineOneEntry('your-url');
 
@@ -870,7 +870,7 @@ example: test-form
 ---
 
 
-<h2 id="generaltypes"> GeneralTypes </h2>
+## <h2 id="generaltypes"> GeneralTypes </h2>
 
 const { GeneralTypes } = defineOneEntry('your-url');
 
@@ -909,7 +909,7 @@ Enum:
 ---
 
 
-<h2 id="locales"> Locales </h2>
+## <h2 id="locales"> Locales </h2>
 
 ```js
 const { Locales } = defineOneEntry('your-url')
@@ -979,7 +979,7 @@ description:position number
 
 
 
-<h2 id="markers"> Markers </h2>
+## <h2 id="markers"> Markers </h2>
 
 
 ```js
@@ -1150,9 +1150,8 @@ example: OrderedMap { "en_US": OrderedMap { "title": "My marker" } }
 
 ---
 
-<h2 id="menus"> Menus </h2>
+## <h2 id="menus"> Menus </h2>
 
-## Menus
 
 ```js
 const { Menus } = defineOneEntry('your-url')
@@ -1215,7 +1214,7 @@ example: List [ OrderedMap { "id": 11, "pageUrl": "122", "localizeInfos": Ordere
 
 ---
 
-<h2 id="pages"> Pages </h2>
+## <h2 id="pages"> Pages </h2>
 
 ```js
 const { Pages } = defineOneEntry('your-url')
@@ -2176,7 +2175,7 @@ Example return:
 ---
 
 
-<h2 id="products"> Products </h2>
+## <h2 id="products"> Products </h2>
 
 
 ```js
@@ -3040,17 +3039,17 @@ example: my-template-short
 ---
 
 
-<h2 id="productstatuses"> ProductStatuses </h2>
+## <h2 id="productstatuses"> ProductstatusesSpec </h2>
 
 
 ```js
-const { ProductStatuses } = defineOneEntry('your-url');
+const { ProductstatusesSpec } = defineOneEntry('your-url');
 ```
 
-### ProductStatuses.getProductStatuses()
+### ProductstatusesSpec.getProductStatuses()
 
 ```js
-const value = await ProductStatuses.getProductStatuses()
+const value = await ProductstatusesSpec.getProductStatuses()
 ```
 
 > This method searches for all product status objects from the API. It returns a Promise that resolves to an array of product status objects.
@@ -3094,10 +3093,10 @@ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent":
 
 </details>
 
-### ProductStatuses.getProductStatusesById(id)
+### ProductstatusesSpec.getProductStatusesById(id)
 
 ```js
-const value = await ProductStatuses.getProductStatusesById(1)
+const value = await ProductstatusesSpec.getProductStatusesById(1)
 ```
 
 > This method searches for a product status object based on its identifier (id) from the API. It returns a Promise that resolves to a product status object.
@@ -3139,10 +3138,10 @@ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent":
 
 </details>
 
-### ProductStatuses.getProductsByStatusMarker(marker)
+### ProductstatusesSpec.getProductsByStatusMarker(marker)
 
 ```js
-const value = await ProductStatuses.getProductsByStatusMarker('my-marker')
+const value = await ProductstatusesSpec.getProductsByStatusMarker('my-marker')
 ```
 
 > This method searches for a product status object based on its textual identifier (marker) from the API. It returns a Promise that resolves to a product status object.
@@ -3184,10 +3183,10 @@ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent":
 
 </details>
 
-### ProductStatuses.validateMarker(marker)
+### ProductstatusesSpec.validateMarker(marker)
 
 ```js
-const value = await ProductStatuses.validateMarker('marker')
+const value = await ProductstatusesSpec.validateMarker('marker')
 ```
 
 > This method checks the existence of a textual identifier (marker). It takes a marker parameter as input, representing the product marker to validate. It returns a Promise that resolves to true if the textual identifier (marker) exists or false if it doesn't.
@@ -3201,9 +3200,8 @@ true
 ---
 
 
-<h2 id="system"> System </h2>
+## <h2 id="system"> System </h2>
 
-## System
 
 ```js
 const { System } = defineOneEntry('your-url')
@@ -3226,9 +3224,8 @@ const value = await System.test500()
 > This method allows you to redirect to the error page.
 
 
-<h2 id="templates"> Templates </h2>
+## <h2 id="templates"> Templates </h2>
 
-## Templates
 
 ```js
 const { Templates } = defineOneEntry('your-url')
@@ -3389,9 +3386,8 @@ general type name
 ---
 
 
-<h2 id="templatepreviews"> TemplatePreviews </h2>
+## <h2 id="templatepreviews"> TemplatePreviews </h2>
 
-## TemplatePreviews
 
 ```js
 const { TemplatePreviews } = defineOneEntry('your-url')

package/dist/admins/adminsInterfaces.d.ts

@@ -1,4 +1,4 @@
-import { IAttributeValues } from "../base/utils";
+import { AttributeType } from "../base/utils";
 /**
  * Represents a interface object of Admins Api.
  *
@@ -39,7 +39,7 @@ interface IPosition {
  */
 interface IAdminEntity {
     attributeSetId: number | null;
-    attributeValues: IAttributeValues;
+    attributeValues: AttributeType;
     id: number;
     identifier: string;
     isSync: boolean;

package/dist/blocks/blocksInterfaces.d.ts

@@ -1,4 +1,4 @@
-import { IAttributeValues, ILocalizeInfos } from "../base/utils";
+import { IAttributeValues, LocalizeType } from "../base/utils";
 /**
  * Represents a interface object of Blocks Api.
  *
@@ -10,11 +10,12 @@ interface IBlocks {
 }
 interface IBlocksEntity {
     id: number;
-    attributeSetId: number;
-    localizeInfos: ILocalizeInfos;
-    customSettings: ICustomSetting;
+    attributeSetId: number | null;
+    localizeInfos: LocalizeType;
+    customSettings: ICustomSetting | null;
     version: number;
     identifier: string;
+    isVisible: boolean;
     position: number;
     attributeValues: IAttributeValues;
     type: string;

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

@@ -1,5 +1,5 @@
 import OneEntry from '../base/oneEntry';
-import { IUploadingQuery, IUploadingReturns, IFileUploading, IFileEntity } from "./fileUploadingInterfaces";
+import { IUploadingQuery, IUploadingReturns, IFileUploading } from "./fileUploadingInterfaces";
 import { IConfig } from "../base/utils";
 /**
  * Controllers for working with file uploading
@@ -47,5 +47,5 @@ export default class FileUploadingApi extends OneEntry implements IFileUploading
      *
      * @returns Return file as File object
      */
-    getFile(id: number, type: string, entity: string, filename?: string): Promise<IFileEntity>;
+    getFile(id: number, type: string, entity: string, filename?: string): Promise<Blob>;
 }

package/dist/file-uploding/fileUploadingApi.js

@@ -37,7 +37,7 @@ class FileUploadingApi extends oneEntry_1.default {
         const body = new FormData();
         body.append('files', data);
         const result = await this._fetchPost('?' + this._queryParamsToString(query), body);
-        return result;
+        return result.json();
     }
     /**
      * Deletes a file from the cloud file storage.
@@ -54,7 +54,7 @@ class FileUploadingApi extends oneEntry_1.default {
     async delete(filename, fileQuery) {
         const query = { ...this._defaultQuery, ...fileQuery };
         const result = await this._fetchDelete(`?filename=${filename}&` + this._queryParamsToString(query));
-        return result;
+        return result.json();
     }
     /**
      * Get file by parameters.
@@ -68,8 +68,15 @@ class FileUploadingApi extends oneEntry_1.default {
      * @returns Return file as File object
      */
     async getFile(id, type, entity, filename) {
-        const result = await this._fetchGet(`?id=${id}&type=${type}&entity=${entity}${filename ? `&filename=${filename}` : ''}`);
-        return result;
+        const options = {
+            method: 'GET',
+            headers: {
+                'Content-Type': 'application/json',
+                'x-app-token': this._token,
+            }
+        };
+        const response = await fetch(this._getFullPath(`?id=${id}&type=${type}&entity=${entity}${filename ? `&filename=${filename}` : ''}`), options);
+        return response.blob();
     }
 }
 exports.default = FileUploadingApi;

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

@@ -8,7 +8,7 @@
 interface IFileUploading {
     upload(data: File, fileQuery?: IUploadingQuery): Promise<IUploadingReturns>;
     delete(filename: string, fileQuery?: IUploadingQuery): Promise<any>;
-    getFile(id: number, type: string, entity: string, filename?: string): Promise<IFileEntity>;
+    getFile(id: number, type: string, entity: string, filename?: string): Promise<Blob>;
 }
 interface IFileEntity {
     file: File | string | null;

package/dist/forms/formsInterfaces.d.ts

@@ -1,4 +1,4 @@
-import { IAttributes, ILocalizeInfos } from "../base/utils";
+import { IAttributes, LocalizeType } from "../base/utils";
 /**
  * Represents an interface object of Forms Api.
  *
@@ -25,11 +25,11 @@ interface IForms {
  * @property {number} position - The position of the object.
  */
 interface IFormsEntity {
-    attributeSetId: number;
-    attributes: Array<IAttributes>;
+    attributeSetId: number | null;
+    attributes: Array<IAttributes> | Object;
     id: number;
     identifier: string;
-    localizeInfos: ILocalizeInfos;
+    localizeInfos: LocalizeType;
     position: number;
     processingData: object | string;
     processingType: string;

package/dist/formsData/formsDataApi.js

@@ -55,7 +55,7 @@ class FormsDataApi extends oneEntry_1.default {
      * @returns Returns array of object FormDataEntity
      */
     async getFormsDataByMarker(marker, langCode = this._defaultLangCode, offset = 0, limit = 30) {
-        const result = await this._fetchGet(`/${marker}?langCode=${langCode}&offset=${offset}&limit=${limit}`);
+        const result = await this._fetchGet(`marker/${marker}?langCode=${langCode}&offset=${offset}&limit=${limit}`);
         return this._normalizeData(result);
     }
 }

package/dist/formsData/formsDataInterfaces.d.ts

@@ -27,7 +27,6 @@ interface IFormsDataEntity {
     formIdentifier: string;
     time: Date | string;
     formData: IFormData;
-    attributeSetIdentifier: string;
 }
 /**
  * @property {string} [formIdentifier] - Text identifier of the form object (marker)
@@ -58,9 +57,9 @@ interface IFormData {
  * @property {IFormData} formData - The identifier of the page.
  */
 interface IFormsPost {
-    id: number;
+    id?: number;
     formIdentifier: string;
-    time: Date | string;
+    time?: Date | string;
     formData: IFormData;
 }
 export { IFormsPost, IFormsData, IFormsDataEntity };

package/dist/locales/localesInterfaces.d.ts

@@ -26,7 +26,7 @@ interface ILocalEntity {
     name: string;
     nativeName: string;
     isActive: boolean;
-    image: string;
+    image: string | null;
     position: number;
 }
 export { ILocales, ILocalEntity };

package/dist/pages/pagesApi.d.ts

@@ -33,7 +33,7 @@ export default class PageApi extends OneEntry implements IPageApi {
      *
      * @returns Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
      */
-    getPages(langCode: string): Promise<Array<IPagesEntity>>;
+    getPages(langCode?: string): Promise<Array<IPagesEntity>>;
     /**
      * Get page object with information about forms, blocks, menus, linked to the page.
      *

package/dist/pages/pagesApi.js

@@ -42,9 +42,9 @@ class PageApi extends oneEntry_1.default {
      *
      * @returns Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
      */
-    async getPages(langCode) {
+    async getPages(langCode = this._defaultLangCode) {
         const result = await this._fetchGet(`?langCode=${langCode}`);
-        return this._normalizeData(result.items);
+        return this._normalizeData(result);
     }
     /**
      * Get page object with information about forms, blocks, menus, linked to the page.
@@ -96,7 +96,7 @@ class PageApi extends oneEntry_1.default {
      */
     async getFormsByPageUrl(url, langCode = this._defaultLangCode) {
         const result = await this._fetchGet(`/${url}/forms?langCode=${langCode}`);
-        return this._normalizeData(result.items);
+        return this._normalizeData(result);
     }
     /**
      * Get all blocks by page url.
@@ -109,7 +109,7 @@ class PageApi extends oneEntry_1.default {
      */
     async getBlocksByPageUrl(url, langCode = this._defaultLangCode) {
         const result = await this._fetchGet(`/${url}/blocks?langCode=${langCode}`);
-        return this._normalizeData(result.items);
+        return this._normalizeData(result);
     }
     /**
      * Get settings for the page.
@@ -133,7 +133,7 @@ class PageApi extends oneEntry_1.default {
      */
     async searchPage(name, langCode = this._defaultLangCode) {
         const result = await this._fetchGet(`/quick/search?lang=${langCode}&name=${name}`);
-        return this._normalizeData(result.items);
+        return this._normalizeData(result);
     }
 }
 exports.default = PageApi;

package/dist/pages/pagesInterfaces.d.ts

@@ -140,17 +140,19 @@ interface IPagesEntity {
      * @property {langCode.<object>}
      */
     attributeValues: AttributeType;
-    childrenCount: number;
-    config: Record<string, number>;
+    childrenCount?: number;
+    config?: Record<string, number>;
     depth: number;
     id: number;
     isSync: boolean;
     isVisible: boolean;
+    forms?: Record<string, any>;
+    blocks?: Record<string, any>;
     localizeInfos: LocalizeType;
     pageUrl: string;
     parentId: number | null;
-    position: number;
-    products: number;
+    position?: number;
+    products?: number;
     templateIdentifier: string;
     type: Types;
 }

package/dist/product-statuses/productStatusesApi.js

@@ -16,7 +16,7 @@ class ProductStatusesApi extends oneEntry_1.default {
      */
     async getProductStatuses() {
         const result = await this._fetchGet('');
-        return result;
+        return this._normalizeData(result);
     }
     /**
      * Search for a product status object by identifier.
@@ -27,7 +27,7 @@ class ProductStatusesApi extends oneEntry_1.default {
      */
     async getProductStatusesById(id) {
         const result = await this._fetchGet(`/${id}`);
-        return result;
+        return this._normalizeData(result);
     }
     /**
      * Search for a product status object by its textual identifier (marker).
@@ -38,7 +38,7 @@ class ProductStatusesApi extends oneEntry_1.default {
      */
     async getProductsByStatusMarker(marker) {
         const result = await this._fetchGet(`/marker/${marker}`);
-        return result;
+        return this._normalizeData(result);
     }
     /**
      * Check the existence of a textual identifier.

package/dist/product-statuses/productStatusesInterfaces.d.ts

@@ -1,4 +1,4 @@
-import { ILocalizeInfos } from "../base/utils";
+import { LocalizeType } from "../base/utils";
 /**
  * Represents an interface object of Product Statuses Api.
  *
@@ -32,6 +32,6 @@ interface IProductStatusEntity {
     updatedDate: string | Date;
     version: number;
     identifier: string;
-    localizeInfos: ILocalizeInfos;
+    localizeInfos: LocalizeType;
 }
 export { IProductStatuses, IProductStatusEntity };

package/dist/products/productsInterfaces.d.ts

@@ -120,7 +120,7 @@ interface IProductsEntity {
     attributeSetId: number;
     isSync: number | boolean;
     price: number;
-    templateIdentifier: string;
+    templateIdentifier: string | null;
     shortDescTemplateIdentifier: string;
     /**
      * Language-specific attribute values.
@@ -130,5 +130,6 @@ interface IProductsEntity {
      */
     attributeValues: AttributeType;
     position: number;
+    productPages: Array<Object>;
 }
 export { IFilterParams, IProductsQuery, IProductApi, IProductsEntity };

package/dist/templates/templatesApi.js

@@ -16,7 +16,7 @@ class TemplatesPreviewApi extends oneEntry_1.default {
      */
     async getAllTemplates() {
         const result = await this._fetchGet('/all');
-        return result;
+        return this._normalizeData(result);
     }
     /**
      * Get template objects by type.
@@ -27,7 +27,7 @@ class TemplatesPreviewApi extends oneEntry_1.default {
      */
     async getTemplateByType(type) {
         const result = await this._fetchGet(`?type=${type}`);
-        return result;
+        return this._normalizeData(result);
     }
 }
 exports.default = TemplatesPreviewApi;

package/dist/templates/templatesInterfaces.d.ts

@@ -29,14 +29,14 @@ interface ITemplatesApi {
  */
 interface ITemplateEntity {
     id: number;
-    updateDate: string | Date;
+    updateDate?: string | Date;
     version: number;
     identifier: string;
-    generalType: IGeneralTypesEntity;
+    generalType?: IGeneralTypesEntity;
     generalTypeId: number;
     localizeInfos: ILocalizeInfos;
     position: number;
-    positionId: number;
+    positionId?: number;
     generalTypeName: Types;
 }
 export { ITemplatesApi, ITemplateEntity };

package/dist/templates-preview/templatesPreviewApi.js

@@ -16,7 +16,7 @@ class TemplatePreviewsApi extends oneEntry_1.default {
      */
     async getTemplatePreviews() {
         const result = await this._fetchGet('');
-        return result;
+        return this._normalizeData(result);
     }
     /**
      * Get one template object by id.
@@ -27,7 +27,7 @@ class TemplatePreviewsApi extends oneEntry_1.default {
      */
     async getTemplatePreviewById(id) {
         const result = await this._fetchGet(`/${id}`);
-        return result;
+        return this._normalizeData(result);
     }
     /**
      * Get one template object by marker.
@@ -38,7 +38,7 @@ class TemplatePreviewsApi extends oneEntry_1.default {
      */
     async getTemplatePreviewByMarker(marker) {
         const result = await this._fetchGet(`/marker/${marker}`);
-        return result;
+        return this._normalizeData(result);
     }
 }
 exports.default = TemplatePreviewsApi;

package/package.json

@@ -1,19 +1,25 @@
 {
   "name": "oneentry",
-  "version": "1.0.41",
+  "version": "1.0.44",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "/dist"
   ],
+  "scripts": {
+    "test": "jest"
+  },
   "author": "ONEENTRY PORTAL CO.",
   "license": "ISC",
   "dependencies": {
-    "jsdoc": "^4.0.2",
-    "typescript": "^5.2.2"
+    "jsdoc": "^4.0.2"
   },
   "devDependencies": {
-    "@types/node": "^20.10.4"
+    "@types/jest": "^29.5.11",
+    "@types/node": "^20.10.5",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.3.3"
   }
 }