oneentry 1.0.9 → 1.0.12

package/dist/_types/admins/adminsApi.d.ts

@@ -0,0 +1,14 @@
+import OneEntry from "../base/oneEntry";
+import { IAdminEntity, IAdmins } from "./adminsInterfaces";
+/**
+ * Controllers for working with users - admins
+ */
+export default class AdminsApi extends OneEntry implements IAdmins {
+    constructor(url: string);
+    /**
+     * Get all user objects - admins.
+     *
+     * @returns Returns all AdminEntity user objects
+     */
+    getAdminsInfo(): Promise<IAdminEntity>;
+}

package/dist/_types/admins/adminsInterfaces.d.ts

@@ -0,0 +1,32 @@
+interface IAdmins {
+    getAdminsInfo(): Promise<IAdminEntity>;
+}
+interface IPosition {
+    id: number;
+    position: string;
+    objectId: number;
+    objectType: string;
+    isLocked: boolean;
+    objectCategoryId: number;
+}
+interface IAttributesSets {
+    [key: string]: string;
+}
+interface IAdminEntity {
+    id: number;
+    updatedDate: string;
+    version: number;
+    identifier: string;
+    attributesSets: IAttributesSets;
+    attributeSetId: number;
+    login: string;
+    email?: string;
+    restorePasswordCode: number;
+    position: IPosition;
+    positionId: number;
+    permissions: Record<string, boolean>;
+    selectedLanguage: string;
+    selectedContentLanguage: string;
+    selectedUITheme: string;
+}
+export { IAdmins, IAdminEntity };

package/dist/_types/attribute-set/attributeSetApi.d.ts

@@ -0,0 +1,24 @@
+import OneEntry from "../base/oneEntry";
+import { IAttributeSet, IAttributeSetEntity } from "./attributeSetInterfaces";
+/**
+ * Controllers for working with attribute sets
+ */
+export default class AttributeSetApi extends OneEntry implements IAttributeSet {
+    constructor(url: string);
+    /**
+     * Get one attributes set object.
+     *
+     * @param {number} [id] - Identifier of the attributes set object
+     *
+     * @returns Returns one attributes set object
+     */
+    getAttributeSetById(id: number): Promise<IAttributeSetEntity>;
+    /**
+     * Get one attributes set object by marker.
+     *
+     * @param {string} [marker] - Marker of the attributes set object
+     *
+     * @returns Returns one attributes set object
+     */
+    getAttributeSetByMarker(marker: string): Promise<IAttributeSetEntity>;
+}

package/dist/_types/attribute-set/attributeSetInterfaces.d.ts

@@ -0,0 +1,23 @@
+import { ILocalizeInfos } from "../base/utils";
+interface IAttributeSet {
+    getAttributeSetById(id: number): Promise<IAttributeSetEntity>;
+    getAttributeSetByMarker(url: string): Promise<IAttributeSetEntity>;
+}
+interface IAttributeSetEntity {
+    id: number;
+    updatedDate: string;
+    version: number;
+    identifier: string;
+    typeId: number;
+    localizeInfos: ILocalizeInfos;
+    schema: object;
+    position: {
+        id: number;
+        objectId: number;
+        objectType: string;
+        position: number | string;
+    };
+    positionId: number | string;
+    isVisible: boolean;
+}
+export { IAttributeSet, IAttributeSetEntity };

package/dist/_types/base/oneEntry.d.ts

@@ -0,0 +1,9 @@
+import { IProductsQuery } from '../products/productsInterfaces';
+export default abstract class OneEntry {
+    protected _url: string;
+    constructor(url: string);
+    protected _getFullPath(path: string): string;
+    protected _fetchGet(path: string): Promise<any>;
+    protected _fetchPost(path: string, data: object): Promise<any>;
+    protected _queryParamsToString(query: IProductsQuery): string;
+}

package/dist/_types/base/utils.d.ts

@@ -0,0 +1,32 @@
+declare enum LanguageCode {
+    ru_RU = "ru_RU",
+    en_US = "en_US",
+    fr_FR = "fr_FR"
+}
+declare enum Types {
+    forCatalogProducts = "forCatalogProducts",
+    forBasketPage = "forBasketPage",
+    forErrorPage = "forErrorPage",
+    forCatalogPages = "forCatalogPages",
+    forProductPreview = "forProductPreview",
+    forProductPage = "forProductPage",
+    forSimilarProductBlock = "forSimilarProductBlock",
+    forStatisticProductBlock = "forStatisticProductBlock",
+    forProductBlock = "forProductBlock",
+    forForm = "forForm",
+    forFormField = "forFormField",
+    forNewsPage = "forNewsPage",
+    forNewsBlock = "forNewsBlock",
+    forNewsPreview = "forNewsPreview",
+    forOneNewsPage = "forOneNewsPage",
+    forUsualPage = "forUsualPage",
+    forTextBlock = "forTextBlock",
+    forSlider = "forSlider",
+    service = "service"
+}
+interface ILocalizeInfos {
+    [key: string]: {
+        [key: string]: string;
+    };
+}
+export { LanguageCode, ILocalizeInfos, Types, };

package/dist/_types/forms/formsApi.d.ts

@@ -0,0 +1,26 @@
+import OneEntry from "../base/oneEntry";
+import { IForms, IFormsEntity } from "./formsInterfaces";
+/**
+ * Controllers for forms objects
+ */
+export default class FormsApi extends OneEntry implements IForms {
+    constructor(url: string);
+    /**
+     * Get all forms.
+     *
+     * @returns Returns array for all objects of type FormEntity
+     */
+    getAllForms(): Promise<IFormsEntity[]>;
+    /**
+     * Get one form by form id.
+     *
+     * @returns Returns object of type FormEntity
+     */
+    getFormById(id: number): Promise<IFormsEntity>;
+    /**
+     * Get one form by form marker.
+     *
+     * @returns Returns object of type FormEntity
+     */
+    getFormByMarker(marker: string): Promise<IFormsEntity>;
+}

package/dist/_types/forms/formsInterfaces.d.ts

@@ -0,0 +1,28 @@
+import { ILocalizeInfos } from "../base/utils";
+interface IForms {
+    getAllForms(): Promise<IFormsEntity[]>;
+    getFormById(id: number): Promise<IFormsEntity>;
+    getFormByMarker(marker: string): Promise<IFormsEntity>;
+}
+interface IFromPages {
+    id: number;
+    pageId: number;
+    formId: number;
+    positionId: number;
+    position: object;
+}
+interface IFormsEntity {
+    id: number;
+    updatedDate: string;
+    version: number;
+    identifier: string;
+    attributesSets: {
+        [key: string]: string;
+    };
+    attributeSetId: number;
+    processingType: string;
+    localizeInfos: ILocalizeInfos;
+    processingData: object;
+    formPages: Array<IFromPages>;
+}
+export { IForms, IFormsEntity };

package/dist/_types/formsData/formsDataApi.d.ts

@@ -0,0 +1,41 @@
+import OneEntry from '../base/oneEntry';
+import { IFormsPost, IFormsData, IFormsDataPost, IFormsDataEntity } from './formsDataInterfaces';
+/**
+ * Controllers for working with form data
+ */
+export default class FormsDataApi extends OneEntry implements IFormsData {
+    constructor(url: string);
+    /**
+     * Get all forms data.
+     *
+     * @returns Returns array for all objects of type CreateFormDataDto
+     */
+    getFormsData(): Promise<Array<IFormsDataEntity>>;
+    /**
+     * Find all product page objects with pagination and multiple filtering.
+     *
+     * @param {object} [data] - Request body.
+     * Example Value:
+     * {
+     *   "formIdentifier": "my-form",
+     *   "formData": [
+     *     {
+     *       "marker": "naimenovanie_1",
+     *       "value": "Наименование",
+     *       "langCode": "ru_RU"
+     *     }
+     *   ]
+     * }
+     *
+     * @returns - Returns created CreateFormDataDto objects.
+     */
+    postFormsData(data: Array<IFormsPost>): Promise<IFormsDataPost>;
+    /**
+     * Get one object of form data by marker.
+     *
+     * @param {string} [marker] - Marker of the form data
+     *
+     * @returns Returns array of object FormDataEntity
+     */
+    getFormsDataByMarker(marker: string): Promise<Array<IFormsDataEntity>>;
+}

package/dist/_types/formsData/formsDataInterfaces.d.ts

@@ -0,0 +1,25 @@
+interface IFormsData {
+    getFormsData(): Promise<Array<IFormsDataEntity>>;
+    postFormsData(data: Array<IFormsPost>): Promise<IFormsDataPost>;
+    getFormsDataByMarker(marker: string): Promise<Array<IFormsDataEntity>>;
+}
+interface IFormsDataEntity {
+    id: number;
+    formIdentifier: string;
+    time: Date | string;
+    formData: Array<IFormData>;
+}
+interface IFormsDataPost {
+    formIdentifier: string;
+    formData: Array<IFormData>;
+}
+interface IFormData {
+    marker?: string;
+    value?: string;
+    langCode?: string;
+}
+interface IFormsPost {
+    formIdentifier: string;
+    formData: IFormData;
+}
+export { IFormsPost, IFormsData, IFormsDataPost, IFormsDataEntity };

package/dist/_types/general-types/generalTypesApi.d.ts

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

package/dist/_types/general-types/generalTypesInterfaces.d.ts

@@ -0,0 +1,9 @@
+import { Types } from "../base/utils";
+interface IGeneralTypes {
+    getAllTypes(): Promise<Array<IGeneralTypesEntity>>;
+}
+interface IGeneralTypesEntity {
+    id: number;
+    type: Types;
+}
+export { IGeneralTypes, IGeneralTypesEntity };

package/dist/_types/index.d.ts

@@ -0,0 +1,35 @@
+import ProductApi from './products/productsApi';
+import PageApi from "./pages/pagesApi";
+import ProductStatusesApi from "./product-statuses/productStatusesApi";
+import TemplatesApi from "./templates/templatesApi";
+import TemplatesPreviewApi from "./templates-preview/templatesPreviewApi";
+import AttributeSetApi from "./attribute-set/attributeSetApi";
+import AdminsApi from "./admins/adminsApi";
+import GeneralTypesApi from "./general-types/generalTypesApi";
+import LocalesApi from "./locales/localesApi";
+import MenusApi from "./menus/menusApi";
+import ModulesApi from "./modules/modulesApi";
+import FormsApi from "./forms/formsApi";
+import FormsDataApi from "./formsData/formsDataApi";
+interface IDefineApi {
+    Admins: AdminsApi;
+    AttributeSet: AttributeSetApi;
+    Forms: FormsApi;
+    FormsData: FormsDataApi;
+    GeneralTypes: GeneralTypesApi;
+    Locales: LocalesApi;
+    Menus: MenusApi;
+    Modules: ModulesApi;
+    Page: PageApi;
+    Product: ProductApi;
+    ProductStatus: ProductStatusesApi;
+    Templates: TemplatesApi;
+    TemplatesPreview: TemplatesPreviewApi;
+}
+/**
+ * Define API.
+ * @param {string} url - URl of your project.
+ * @returns {IDefineApi} - List of methods set.
+ */
+export declare function defineOneEntry(url: string): IDefineApi;
+export {};

package/dist/_types/locales/localesApi.d.ts

@@ -0,0 +1,14 @@
+import OneEntry from "../base/oneEntry";
+import { ILocales, ILocalEntity } from "./localesInterfaces";
+/**
+ * Controllers for working with localizations (content language)
+ */
+export default class LocalesApi extends OneEntry implements ILocales {
+    constructor(url: string);
+    /**
+     * Find all active language localization objects.
+     *
+     * @returns Returns an array of LocaleEntity objects
+     */
+    getLocales(): Promise<Array<ILocalEntity>>;
+}

package/dist/_types/locales/localesInterfaces.d.ts

@@ -0,0 +1,15 @@
+import { LanguageCode } from "../base/utils";
+interface ILocales {
+    getLocales(): Promise<Array<ILocalEntity>>;
+}
+interface ILocalEntity {
+    id: number;
+    shortCode: string;
+    code: LanguageCode;
+    name: string;
+    nativeName: string;
+    isActive: boolean;
+    image: string;
+    position: number | string;
+}
+export { ILocales, ILocalEntity };

package/dist/_types/markers/markersApi.d.ts

@@ -0,0 +1,35 @@
+import OneEntry from '../base/oneEntry';
+import { IMarkersApi, IMarkerEntity } from "./markersInterfaces";
+/**
+ * Controllers for working with markers objects
+ */
+export default class TemplatesPreviewApi extends OneEntry implements IMarkersApi {
+    constructor(url: string);
+    /**
+     * Get one marker object by marker.
+     *
+     * @param {string} [marker] - Text identifier (marker) of the marker object
+     *
+     * @returns
+     * Returns one MarkerEntity marker object
+     */
+    getMarker(marker: string): Promise<IMarkerEntity>;
+    /**
+     * Get all marker objects.
+     *
+     * @param {number} [limit] - Parameter for limiting the selection of records, by default - 30
+     *
+     * @param {number} [offset] - Parameter for offset of records selection, default - 0
+     *
+     * @returns Returns an object ItemsWithTotal, where items is an array of MarkerEntity objects, total - the total number of markers found
+     */
+    getMarkers(limit?: number, offset?: number): Promise<Array<IMarkerEntity>>;
+    /**
+     * Get one marker object.
+     *
+     * @param {number} [id] - Identifier of marker object
+     *
+     * @returns Returns one marker object MarkerEntity
+     */
+    getMarkersById(id: number): Promise<IMarkerEntity>;
+}

package/dist/_types/markers/markersInterfaces.d.ts

@@ -0,0 +1,16 @@
+import { ILocalizeInfos } from "../base/utils";
+interface IMarkersApi {
+    getMarker(marker: string): Promise<IMarkerEntity>;
+    getMarkers(limit: number, offset: number): Promise<Array<IMarkerEntity>>;
+    getMarkersById(id: number): Promise<IMarkerEntity>;
+}
+interface IMarkerEntity {
+    id: number;
+    updatedDate: string;
+    version: number;
+    identifier: string;
+    name: string;
+    marker: string;
+    localizeInfos: ILocalizeInfos;
+}
+export { IMarkersApi, IMarkerEntity };

package/dist/_types/menus/menusApi.d.ts

@@ -0,0 +1,16 @@
+import OneEntry from "../base/oneEntry";
+import { IMenus, IMenusEntity } from "./menusInterfaces";
+/**
+ * Controllers for working with menu objects
+ */
+export default class MenusApi extends OneEntry implements IMenus {
+    constructor(url: string);
+    /**
+     * Get pages includes in menu by marker.
+     *
+     * @param {string} [marker] - Menu marker
+     *
+     * @returns Returns a single menu object as a ContentMenuDto object with included pages
+     */
+    getMenusByMarker(marker: string): Promise<IMenusEntity>;
+}

package/dist/_types/menus/menusInterfaces.d.ts

@@ -0,0 +1,18 @@
+import { ILocalizeInfos } from "../base/utils";
+interface IMenus {
+    getMenusByMarker(marker: string): Promise<IMenusEntity>;
+}
+interface IMenusPages {
+    id: number;
+    pageUrl: string;
+    localizeInfos: ILocalizeInfos;
+    position: number;
+    parentId: number | null;
+}
+interface IMenusEntity {
+    id: number;
+    identifier: string;
+    localizeInfos: ILocalizeInfos;
+    pages: Array<IMenusPages>;
+}
+export { IMenus, IMenusEntity };

package/dist/_types/modules/modulesApi.d.ts

@@ -0,0 +1,14 @@
+import OneEntry from "../base/oneEntry";
+import { IModules, IModulesEntity } from "./modulesInterfaces";
+/**
+ * Controllers for working with application modules
+ */
+export default class ModulesApi extends OneEntry implements IModules {
+    constructor(url: string);
+    /**
+     * Get all modules.
+     *
+     * @returns Returns BaseModuleDto objects or an empty array [] if there is no data
+     */
+    getAllModules(): Promise<Array<IModulesEntity>>;
+}

package/dist/_types/modules/modulesInterfaces.d.ts

@@ -0,0 +1,19 @@
+import { ILocalizeInfos } from "../base/utils";
+interface IModules {
+    getAllModules(): Promise<Array<IModulesEntity>>;
+}
+interface IModulesEntity {
+    identifier: string;
+    isVisible: boolean;
+    type: string | null;
+    localizeInfos: ILocalizeInfos;
+    icon: string;
+    generalTypes: {
+        id: number;
+        type: string;
+    }[];
+    attributeSetTypes: [];
+    position: number | string;
+    positionId: number;
+}
+export { IModules, IModulesEntity };

package/dist/_types/pages/pagesApi.d.ts

@@ -0,0 +1,74 @@
+import OneEntry from "../base/oneEntry";
+import { IPageApi, IPageConfig, IPagesEntity } from "./pagesInterfaces";
+/**
+ * Controllers for working with page objects, including catalog pages
+ */
+export default class PageApi extends OneEntry implements IPageApi {
+    constructor(url: string);
+    /**
+     * Get all top-level page objects.
+     *
+     * @param {string} [langCode] Required parameter lang code
+     *
+     * @returns Returns all created pages without parents as an array of ContentIndexedPageDto objects or an empty array [] (if there is no data)
+     */
+    getRootPages(langCode: string): Promise<Array<IPagesEntity>>;
+    /**
+     * Get all page objects with product information as an array.
+     *
+     * @param {string} [langCode] Required parameter lang code
+     *
+     * @param {number} [limit] - Optional parameter for pagination, default is 30
+     *
+     * @param {number} [offset] - Optional parameter for pagination, default is 0
+     *
+     * @returns Returns all created pages as an array of ContentIndexedPageDto objects or an empty array [] (if there is no data)
+     */
+    getCatalogPages(langCode: string, limit?: number, offset?: number): Promise<Array<IPagesEntity>>;
+    /**
+     * Get all page objects with product information as an array.
+     *
+     * @param {string} [langCode] Required parameter lang code
+     *
+     * @returns Returns all created pages as an array of ContentIndexedPageDto objects or an empty array [] (if there is no data)
+     */
+    getPages(langCode: string): Promise<Array<IPagesEntity>>;
+    /**
+     * Get page object with information about forms, blocks, menus, linked to the page.
+     *
+     * @param {string} [langCode] Required parameter lang code
+     *
+     * @param {number} [id] - Page object identifier
+     *
+     * @returns Returns page object (DTO depends on the type of page being returned)
+     */
+    getPageById(id: number, langCode: string): Promise<IPagesEntity>;
+    /**
+     * Get page object with information about forms, blocks, menus, linked to the page by URL.
+     *
+     * @param {string} [langCode] Required parameter lang code
+     *
+     * @param {string} [url] - Page URL
+     *
+     * @returns Returns page object (DTO depends on the type of page being returned)
+     */
+    getPageByUrl(url: string, langCode: string): Promise<IPagesEntity>;
+    /**
+     * Get settings for the page.
+     *
+     * @param {string} [url] - Page URL
+     *
+     * @returns Returns a ConfigPageDto object with page display settings
+     */
+    getConfigPageByUrl(url: string): Promise<IPageConfig>;
+    /**
+     * Quick search for page objects with limited output.
+     *
+     * @param {string} [name] - Text for searching page objects (search is performed on the title field of the localizeInfos object with the language taken into account)
+     *
+     * @param {string} [langCode] Required parameter lang code
+     *
+     * @returns Returns all created pages as an array of ContentIndexedPageDto objects or an empty array [] (if there is no data)
+     */
+    searchPage(name: string, langCode: string): Promise<IPagesEntity>;
+}

package/dist/_types/pages/pagesInterfaces.d.ts

@@ -0,0 +1,39 @@
+import { ILocalizeInfos, Types } from "../base/utils";
+interface IPageApi {
+    getRootPages(langCode: string): Promise<Array<IPagesEntity>>;
+    getCatalogPages(langCode: string, limit: number, offset: number): Promise<Array<IPagesEntity>>;
+    getPages(langCode: string): Promise<Array<IPagesEntity>>;
+    getPageById(id: number, langCode: string): Promise<IPagesEntity>;
+    getPageByUrl(url: string, langCode: string): Promise<IPagesEntity>;
+    getConfigPageByUrl(url: string): Promise<IPageConfig>;
+    searchPage(name: string, langCode: string): Promise<IPagesEntity>;
+}
+interface IPageConfig {
+    rowsPerPage: number;
+    productsPerRow: number;
+}
+interface IPagesEntity {
+    id: number;
+    parentId: number;
+    config: Record<string, number>;
+    pageUrl: string;
+    depth: number;
+    localizeInfos: ILocalizeInfos;
+    isVisible: boolean;
+    isEditorDisabled: boolean;
+    products: number;
+    attributeSetId: number;
+    templateIdentifier: string;
+    /**
+     * Language-specific attribute values.
+     * @example attributeValues['en_US']
+     *
+     * @property {langCode.<object>}
+     */
+    attributeValues: {
+        [langCode: string]: object;
+    };
+    position: string;
+    type: Types;
+}
+export { IPageApi, IPageConfig, IPagesEntity };

package/dist/_types/product-statuses/productStatusesApi.d.ts

@@ -0,0 +1,38 @@
+import OneEntry from '../base/oneEntry';
+import { IProductStatusEntity, IProductStatuses } from "./productStatusesInterfaces";
+/**
+ * Controllers for working with product statuses
+ */
+export default class ProductStatusesApi extends OneEntry implements IProductStatuses {
+    constructor(url: string);
+    /**
+     * Search for all product status objects.
+     *
+     * @returns Returns an array of product status objects
+     */
+    getProductStatuses(): Promise<Array<IProductStatusEntity>>;
+    /**
+     * Search for a product status object by identifier.
+     *
+     * @param {number} [id] - Status id
+     *
+     * @returns Returns a product status object
+     */
+    getProductStatusesById(id: number): Promise<IProductStatusEntity>;
+    /**
+     * Search for a product status object by its textual identifier (marker).
+     *
+     * @param {string} [marker] - Product marker
+     *
+     * @returns Returns a product status object
+     */
+    getProductsByStatusMarker(marker: string): Promise<IProductStatusEntity>;
+    /**
+     * Check the existence of a textual identifier.
+     *
+     * @param {string} [marker] - Product marker
+     *
+     * @returns Returns true if the textual identifier (marker) exists or false if it doesn't
+     */
+    validateMarker(marker: string): Promise<boolean>;
+}

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

@@ -0,0 +1,15 @@
+import { ILocalizeInfos } from "../base/utils";
+interface IProductStatuses {
+    getProductStatuses(): Promise<Array<IProductStatusEntity>>;
+    getProductStatusesById(id: number): Promise<IProductStatusEntity>;
+    getProductsByStatusMarker(marker: string): Promise<IProductStatusEntity>;
+    validateMarker(marker: string): Promise<boolean>;
+}
+interface IProductStatusEntity {
+    id: number;
+    updatedDate: string;
+    version: number;
+    identifier: string;
+    localizeInfos: ILocalizeInfos;
+}
+export { IProductStatuses, IProductStatusEntity };