oneentry 1.0.62 → 1.0.63

package/dist/auth-provider/authProviderApi.d.ts

@@ -0,0 +1,104 @@
+import OneEntry from "../base/oneEntry";
+import { IConfig } from "../base/utils";
+import { IAuthProvider, ISignUpData, ISignUpEntity, ICodeEntity, IAuthEntity, IAuthProvidersEntity } from "./authProvidersInterfaces";
+/**
+ * Controllers for working with auth services.
+ */
+export default class AuthProviderApi extends OneEntry implements IAuthProvider {
+    constructor(url: string, config: IConfig);
+    /**
+     * User registration
+     * @param {string} marker - The text identifier of the authorization provider. Example - email
+     * @param data - Request body
+     * @param {string} langCode - Optional language field
+     *
+     * @example
+     * const data = {
+     *   "formIdentifier": "reg",
+     *   "authData": [
+     *     {
+     *       "marker": "login",
+     *       "value": "test"
+     *     },
+     *     {
+     *       "marker": "password",
+     *       "value": "12345"
+     *     }
+     *   ],
+     *   "formData": [
+     *       {
+     *         "marker": "last_name",
+     *         "type": "string",
+     *         "value": "Name"
+     *       }
+     *   ],
+     *   "notificationData": {
+     *     "email": "test@test.com",
+     *     "phonePush": "",
+     *     "phoneSMS": "+79991234567"
+     *   }
+     * }
+     */
+    signUp(marker: string, data: ISignUpData, langCode?: string): Promise<ISignUpEntity>;
+    /**
+     * Getting a user activation code
+     * @param {string} marker - The text identifier of the authorization provider. Example - email
+     * @param {string} userIdentifier - The text identifier of the user's object (user login)
+     *
+     * @example
+     * const data = {
+     *   "userIdentifier": "test@test.com"
+     * }
+     */
+    generateCode(marker: string, userIdentifier: string): Promise<ICodeEntity>;
+    /**
+     * User activate.
+     * @param {string} marker - The text identifier of the authorization provider. Example - email
+     * @param {string} userIdentifier - The text identifier of the user's object (user login)
+     * @param {string} code - Service code
+     */
+    activateUser(marker: string, userIdentifier: string, code: string): Promise<boolean>;
+    /**
+     * User authorization
+     * @param {string} marker - The text identifier of the authorization provider. Example - email
+     * @param {string} login - User login
+     * @param {string} password - User password
+     *
+     */
+    auth(marker: string, login: string, password: string): Promise<IAuthEntity>;
+    /**
+     * Refresh token
+     * @param {string} marker - The text identifier of the authorization provider. Example - email
+     * @param {string} token - Refresh token
+     *
+     */
+    refresh(marker: string, token: string): Promise<IAuthEntity>;
+    /**
+     * User logout
+     * @param {string} marker - The text identifier of the authorization provider. Example - email
+     * @param {string} token - Refresh token
+     */
+    logout(marker: string, token: string): Promise<boolean>;
+    /**
+     * Change password
+     * @param {string} marker - The text identifier of the authorization provider. Example - email
+     * @param {string} userIdentifier - The text identifier of the user's object (user login)
+     * @param {string} code - Service code
+     * @param {string} newPassword - New password
+     * @param {string} [repeatPassword] - Optional variable contains repeat new password for validation
+     */
+    changePassword(marker: string, userIdentifier: string, code: string, newPassword: string, repeatPassword?: string): Promise<boolean>;
+    /**
+     * Get all auth providers objects
+     * @param {string} [langCode] - Language code. Default "en_US"
+     * @param {number} [offset] - Parameter for pagination. Default 0
+     * @param {number} [limit] - Parameter for pagination. Default 30
+     */
+    getAuthProviders(langCode: string, offset: number, limit: number): Promise<Array<IAuthProvidersEntity>>;
+    /**
+     * Get one auth provider object by marker
+     * @param {string} marker - The text identifier of the authorization provider. Example - email
+     * @param {string} [langCode] - Optional parameter language code. Default "en_US"
+     */
+    getMarker(marker: string, langCode?: string): Promise<IAuthProvidersEntity>;
+}

package/dist/auth-provider/authProviderApi.js

@@ -0,0 +1,162 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const oneEntry_1 = require("../base/oneEntry");
+/**
+ * Controllers for working with auth services.
+ */
+class AuthProviderApi extends oneEntry_1.default {
+    constructor(url, config) {
+        super(url, config);
+        this._url += '/api/content/users-auth-providers';
+    }
+    /**
+     * User registration
+     * @param {string} marker - The text identifier of the authorization provider. Example - email
+     * @param data - Request body
+     * @param {string} langCode - Optional language field
+     *
+     * @example
+     * const data = {
+     *   "formIdentifier": "reg",
+     *   "authData": [
+     *     {
+     *       "marker": "login",
+     *       "value": "test"
+     *     },
+     *     {
+     *       "marker": "password",
+     *       "value": "12345"
+     *     }
+     *   ],
+     *   "formData": [
+     *       {
+     *         "marker": "last_name",
+     *         "type": "string",
+     *         "value": "Name"
+     *       }
+     *   ],
+     *   "notificationData": {
+     *     "email": "test@test.com",
+     *     "phonePush": "",
+     *     "phoneSMS": "+79991234567"
+     *   }
+     * }
+     */
+    async signUp(marker, data, langCode = this._defaultLangCode) {
+        const result = await this._fetchPost(`/marker/${marker}/users/sign-up`, this._normalizePostBody(data, langCode));
+        return this._normalizeData(result);
+    }
+    /**
+     * Getting a user activation code
+     * @param {string} marker - The text identifier of the authorization provider. Example - email
+     * @param {string} userIdentifier - The text identifier of the user's object (user login)
+     *
+     * @example
+     * const data = {
+     *   "userIdentifier": "test@test.com"
+     * }
+     */
+    async generateCode(marker, userIdentifier) {
+        const data = {
+            "userIdentifier": userIdentifier
+        };
+        const result = await this._fetchPost(`/marker/${marker}/users/generate-code`, data);
+        return result;
+    }
+    /**
+     * User activate.
+     * @param {string} marker - The text identifier of the authorization provider. Example - email
+     * @param {string} userIdentifier - The text identifier of the user's object (user login)
+     * @param {string} code - Service code
+     */
+    async activateUser(marker, userIdentifier, code) {
+        const data = {
+            "userIdentifier": userIdentifier,
+            "code": code
+        };
+        const result = await this._fetchPost(`/marker/${marker}/users/activate`, data);
+        return result;
+    }
+    /**
+     * User authorization
+     * @param {string} marker - The text identifier of the authorization provider. Example - email
+     * @param {string} login - User login
+     * @param {string} password - User password
+     *
+     */
+    async auth(marker, login, password) {
+        const data = [
+            {
+                "marker": "login",
+                "value": login
+            },
+            {
+                "marker": "password",
+                "value": password
+            }
+        ];
+        const result = await this._fetchPost(`/marker/${marker}/users/activate`, data);
+        return result;
+    }
+    /**
+     * Refresh token
+     * @param {string} marker - The text identifier of the authorization provider. Example - email
+     * @param {string} token - Refresh token
+     *
+     */
+    async refresh(marker, token) {
+        const data = { refreshToken: token };
+        const result = await this._fetchPost(`/marker/${marker}/users/refresh`, data);
+        return result;
+    }
+    /**
+     * User logout
+     * @param {string} marker - The text identifier of the authorization provider. Example - email
+     * @param {string} token - Refresh token
+     */
+    async logout(marker, token) {
+        const data = {
+            "refreshToken": token
+        };
+        const result = await this._fetchPost(`/marker/${marker}/users/logout`, data);
+        return result;
+    }
+    /**
+     * Change password
+     * @param {string} marker - The text identifier of the authorization provider. Example - email
+     * @param {string} userIdentifier - The text identifier of the user's object (user login)
+     * @param {string} code - Service code
+     * @param {string} newPassword - New password
+     * @param {string} [repeatPassword] - Optional variable contains repeat new password for validation
+     */
+    async changePassword(marker, userIdentifier, code, newPassword, repeatPassword) {
+        const data = {
+            "userIdentifier": userIdentifier,
+            "code": code,
+            "password1": newPassword,
+            "password2": repeatPassword !== null && repeatPassword !== void 0 ? repeatPassword : newPassword
+        };
+        const result = await this._fetchPost(`/marker/${marker}/users/change-password`, data);
+        return result;
+    }
+    /**
+     * Get all auth providers objects
+     * @param {string} [langCode] - Language code. Default "en_US"
+     * @param {number} [offset] - Parameter for pagination. Default 0
+     * @param {number} [limit] - Parameter for pagination. Default 30
+     */
+    async getAuthProviders(langCode, offset, limit) {
+        const result = await this._fetchGet(`?langCode=${langCode}&offset=${offset}&limit=${limit}`);
+        return this._normalizeData(result);
+    }
+    /**
+     * Get one auth provider object by marker
+     * @param {string} marker - The text identifier of the authorization provider. Example - email
+     * @param {string} [langCode] - Optional parameter language code. Default "en_US"
+     */
+    async getMarker(marker, langCode) {
+        const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
+        return this._normalizeData(result);
+    }
+}
+exports.default = AuthProviderApi;

package/dist/auth-provider/authProvidersInterfaces.d.ts

@@ -0,0 +1,81 @@
+import { ILocalizeInfo } from "../base/utils";
+/**
+ * Represents a interface object of User Auth Provider Api.
+ *
+ * @property {function} signUp - User registration.
+ * @property {function} generateCode - Getting a user activation code.
+ * @property {function} activateUser - User activate.
+ * @property {function} auth - User authorization.
+ * @property {function} refresh - Refresh token.
+ * @property {function} logout - User logout.
+ * @property {function} changePassword - Change password.
+ * @property {function} getAuthProviders - Get all auth providers objects.
+ * @property {function} getMarker - Get one auth provider object by marker.
+ */
+interface IAuthProvider {
+    signUp(marker: string, data: ISignUpData, langCode?: string): Promise<ISignUpEntity>;
+    generateCode(marker: string, userIdentifier: string): Promise<ICodeEntity>;
+    activateUser(marker: string, userIdentifier: string, code: string): Promise<boolean>;
+    auth(marker: string, login: string, password: string): Promise<IAuthEntity>;
+    refresh(marker: string, token: string): Promise<IAuthEntity>;
+    logout(marker: string, token: string): Promise<boolean>;
+    changePassword(marker: string, userIdentifier: string, code: string, newPassword: string, repeatPassword?: string): Promise<boolean>;
+    getAuthProviders(langCode: string, offset: number, limit: number): Promise<Array<IAuthProvidersEntity>>;
+    getMarker(marker: string, langCode?: string): Promise<IAuthProvidersEntity>;
+}
+interface IAuthFormData {
+    marker: string;
+    type: string;
+    value: string;
+}
+interface ISignUpData {
+    formIdentifier: string;
+    authData: Array<{
+        marker: 'login' | 'password';
+        value: string;
+    }>;
+    formData: IAuthFormData | Array<IAuthFormData>;
+    notificationData: {
+        email: string;
+        phonePush: string;
+        phoneSMS: string;
+    };
+}
+interface ISignUpEntity {
+    id: number;
+    updatedDate: string;
+    version: number;
+    identifier: string;
+    isActive: boolean;
+    authProviderId: number;
+    formData: Array<{
+        marker: 'login' | 'password';
+        value: string;
+    }>;
+    notificationData: IAuthFormData | Array<IAuthFormData>;
+    systemCode: {
+        value: string;
+        expiredDate: string;
+    };
+}
+interface ICodeEntity {
+    code: string;
+    expiredDate: string;
+}
+interface IAuthEntity {
+    userIdentifier: string;
+    authProviderIdentifier: string;
+    accessToken: string;
+    refreshToken: string;
+}
+interface IAuthProvidersEntity {
+    id: number;
+    localizeInfos: ILocalizeInfo;
+    version: number;
+    identifier: string;
+    isActive: boolean;
+    isCheckCode: boolean;
+    type: string;
+    formIdentifier: string | null;
+}
+export { IAuthProvider, IAuthFormData, ISignUpData, ISignUpEntity, ICodeEntity, IAuthEntity, IAuthProvidersEntity };

package/dist/auth-provider/authProvidersInterfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/base/oneEntry.d.ts

@@ -12,9 +12,11 @@ export default abstract class OneEntry {
     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 _fetchPut(path: string, data: any): Promise<any>;
+    protected _fetchDelete(path: string, data?: any): Promise<any>;
     protected _queryParamsToString(query: IProductsQuery | IUploadingQuery): string;
     protected _normalizeData(data: any, langCode?: string): any;
+    protected _normalizePostBody(body: any, langCode?: string): any;
     protected _clearArray(data: Record<string, any>): any;
     protected _dataPostProcess(data: any, langCode?: string): any;
 }

package/dist/base/oneEntry.js

@@ -92,13 +92,55 @@ class OneEntry {
             });
         }
     }
-    async _fetchDelete(path) {
+    async _fetchPut(path, data) {
+        const options = {
+            method: 'PUT',
+            headers: {
+                'x-app-token': this._token,
+                'Content-Type': 'application/json',
+            },
+        };
+        if (data instanceof FormData || data instanceof Blob) {
+            delete options.headers['Content-Type'];
+        }
+        if (!this._NO_FETCH) {
+            const response = await fetch(this._getFullPath(path), {
+                ...options,
+                body: data,
+            });
+            if (!response.ok) {
+                const error = await response.json();
+                throw error;
+            }
+            return await response.json();
+        }
+        else {
+            return new Promise((resolve, reject) => {
+                const req = this._https.request(this._getFullPath(path), options, (res) => {
+                    let responseData = '';
+                    res.on('data', (chunk) => {
+                        responseData += chunk;
+                    });
+                    res.on('end', () => {
+                        resolve(JSON.parse(responseData));
+                    });
+                });
+                req.on('error', (error) => {
+                    reject(error);
+                });
+                req.write(data);
+                req.end();
+            });
+        }
+    }
+    async _fetchDelete(path, data) {
         const options = {
             method: 'DELETE',
             headers: {
                 'Content-Type': 'application/json',
                 'x-app-token': this._token,
-            }
+            },
+            body: data
         };
         if (!this._NO_FETCH) {
             const response = await fetch(this._getFullPath(path), options);
@@ -154,6 +196,12 @@ class OneEntry {
             return normalizeData;
         }
     }
+    _normalizePostBody(body, langCode = this._defaultLangCode) {
+        const formData = {};
+        formData[langCode] = Array.isArray(body.formData) ? body.formData : [body.formData];
+        body.formData = formData;
+        return body;
+    }
     _clearArray(data) {
         if (Array.isArray(data)) {
             return data.map(item => this._clearArray(item));

package/dist/events/eventsApi.d.ts

@@ -0,0 +1,23 @@
+import OneEntry from "../base/oneEntry";
+import { IConfig } from "../base/utils";
+import { IEvents } from "./eventsInterfaces";
+/**
+ * Controllers for working with events
+ */
+export default class EventsApi extends OneEntry implements IEvents {
+    constructor(url: string, config: IConfig);
+    /**
+     * Subscribing to an event on a product.
+     * @param marker - Event marker.
+     * @param userId - User id.
+     * @param productId - Product id.
+     */
+    subscribeByMarker(marker: string, userId: number, productId: number): Promise<any>;
+    /**
+     * Unsubscribing to an event on a product.
+     * @param marker - Event marker.
+     * @param userId - User id.
+     * @param productId - Product id.
+     */
+    unsubscribeByMarker(marker: string, userId: number, productId: number): Promise<any>;
+}

package/dist/events/eventsApi.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const oneEntry_1 = require("../base/oneEntry");
+/**
+ * Controllers for working with events
+ */
+class EventsApi extends oneEntry_1.default {
+    constructor(url, config) {
+        super(url, config);
+        this._url += '/api/content/events';
+    }
+    /**
+     * Subscribing to an event on a product.
+     * @param marker - Event marker.
+     * @param userId - User id.
+     * @param productId - Product id.
+     */
+    async subscribeByMarker(marker, userId, productId) {
+        const result = await this._fetchPost(`/subscribe/marker/${marker}`, {
+            "userId": userId,
+            "productId": productId
+        });
+        return result;
+    }
+    /**
+     * Unsubscribing to an event on a product.
+     * @param marker - Event marker.
+     * @param userId - User id.
+     * @param productId - Product id.
+     */
+    async unsubscribeByMarker(marker, userId, productId) {
+        const result = await this._fetchDelete('', {
+            "userId": userId,
+            "productId": productId
+        });
+        return result;
+    }
+}
+exports.default = EventsApi;

package/dist/events/eventsInterfaces.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Represents a interface object of Events Api.
+ *
+ * @property {function} subscribeByMarker - Subscribing to an event on a product.
+ * @property {function} unsubscribeByMarker - Unsubscribing to an event on a product.
+ */
+interface IEvents {
+    subscribeByMarker(marker: string, userId: number, productId: number): Promise<any>;
+    unsubscribeByMarker(marker: string, userId: number, productId: number): Promise<any>;
+}
+export { IEvents };

package/dist/events/eventsInterfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/formsData/formsDataApi.d.ts

@@ -19,11 +19,11 @@ export default class FormsDataApi extends OneEntry implements IFormsData {
     /**
      * Find all product page objects with pagination and multiple filtering.
      *
-     * @param {object} [data] - Request body.
+     * @param {object} data - Request body.
      * @param {string} langCode - Optional language field
      *
      * @example
-     * const body = {
+     * const data = {
      *    formIdentifier: 'test',
      *    formData: {
      *        marker: 'test',

package/dist/formsData/formsDataApi.js

@@ -25,11 +25,11 @@ class FormsDataApi extends oneEntry_1.default {
     /**
      * Find all product page objects with pagination and multiple filtering.
      *
-     * @param {object} [data] - Request body.
+     * @param {object} data - Request body.
      * @param {string} langCode - Optional language field
      *
      * @example
-     * const body = {
+     * const data = {
      *    formIdentifier: 'test',
      *    formData: {
      *        marker: 'test',

package/dist/formsData/formsDataInterfaces.d.ts

@@ -52,6 +52,122 @@ interface IFormsPost {
     id?: number;
     formIdentifier: string;
     time?: Date | string;
-    formData: IFormData | Array<IFormData>;
+    formData: Array<IBodyTypeStringNumberFloat | IBodyTypeTimeDate | IBodyTypeText | IBodyTypeTextWithHeader | IBodyTypeImageGroupOfImages | IBodyTypeFile | IBodyTypeRadioButtonList>;
 }
-export { IFormsPost, IFormsData, IFormData, IFormsDataEntity };
+/**
+ * @property {string} marker - marker name
+ * @property {'string' | 'number' | 'float'} type - Type value
+ * @property {string} value
+ */
+interface IBodyTypeStringNumberFloat {
+    marker: string;
+    type: 'string' | 'number' | 'float';
+    value: string;
+}
+/**
+ * @property {string} marker - marker name
+ * @property {'date' | 'dateTime' | 'time'} type - Type value
+ * @property {object} value - Date object. Contains fullDate, formattedValue, formatString
+ */
+interface IBodyTypeTimeDate {
+    marker: string;
+    type: 'date' | 'dateTime' | 'time';
+    value: {
+        fullDate: string;
+        formattedValue: string;
+        formatString: string;
+    };
+}
+/**
+ * @property {string} marker - marker name
+ * @property {'text'} type - Type value
+ * @property {object} value - Text Object. Contains html as string and params
+ */
+interface IBodyTypeText {
+    marker: string;
+    type: 'text';
+    value: {
+        htmlValue: string;
+        plainValue: string;
+        params: {
+            isEditorDisabled: boolean;
+            isImageCompressed: boolean;
+        };
+    };
+}
+/**
+ * @property {string} marker - marker name
+ * @property {'textWithHeader'} type - Type value
+ * @property {object} value - Text Object. Contains html as string, header and params
+ */
+interface IBodyTypeTextWithHeader {
+    marker: string;
+    type: 'textWithHeader';
+    value: {
+        header: string;
+        htmlValue: string;
+        plainValue: string;
+        params: {
+            isEditorDisabled: boolean;
+            isImageCompressed: boolean;
+        };
+    };
+}
+/**
+ * @property {string} marker - marker name
+ * @property {'image' | 'groupOfImage'} type - Type value
+ * @property {object} value - Image Object. Contains image information
+ */
+interface IBodyTypeImageGroupOfImages {
+    marker: string;
+    type: 'image' | 'groupOfImage';
+    value: {
+        filename: string;
+        downloadLink: string;
+        size: number;
+        previewLink: string;
+        params: {
+            isImageCompressed: boolean;
+        };
+    } | Array<{
+        filename: string;
+        downloadLink: string;
+        size: number;
+        previewLink: string;
+        params: {
+            isImageCompressed: boolean;
+        };
+    }>;
+}
+/**
+ * @property {string} marker - marker name
+ * @property {'file'} type - Type value
+ * @property {object} value - File Object. Contains file information
+ */
+interface IBodyTypeFile {
+    marker: string;
+    type: 'file';
+    value: {
+        filename: string;
+        downloadLink: string;
+        size: number;
+    };
+}
+/**
+ * @property {string} marker - marker name
+ * @property {'file'} type - Type value
+ * @property {array} value - Array of list or radioButton bojects.
+ */
+interface IBodyTypeRadioButtonList {
+    marker: string;
+    type: 'list' | 'radioButton';
+    value: Array<{
+        title: string;
+        value: string;
+        extended: {
+            value: string;
+            type: string;
+        };
+    }>;
+}
+export { IFormsPost, IFormsData, IFormData, IFormsDataEntity, IBodyTypeStringNumberFloat, IBodyTypeTimeDate, IBodyTypeText, IBodyTypeTextWithHeader, IBodyTypeImageGroupOfImages, IBodyTypeFile, IBodyTypeRadioButtonList };