oneentry 1.0.72 → 1.0.73

package/README.md

@@ -95,7 +95,8 @@ const api = defineOneEntry('https://my-project.oneentry.cloud', {
     langCode:'en_US',
     traficLimit: true,
     auth: {
-        customAuth: true
+        customAuth: true,
+        refreshToken: localStorage.getItem('refreshToken')
     }
 })
 ```
@@ -449,8 +450,7 @@ Example return:
   "identifier": "catalog",
   "isActive": false,
   "authProviderId": 1,
-  "formData": {
-    "en_US": [
+  "formData": [
       {
         "marker": "login",
         "value": "test"
@@ -459,8 +459,7 @@ Example return:
         "marker": "f-name",
         "value": "Second name"
       }
-    ]
-  },
+  ],
   "notificationData": {
     "email": "test@test.com",
     "phonePush": "",
@@ -2029,15 +2028,13 @@ Example return:
   "formIdentifier": "bars",
   "paymentAccountIdentifier": "payment1",
   "statusIdentifier": "inprogress",
-  "formData": {
-    "en_US": [
+  "formData": [
       {
         "marker": "naimenovanie_1",
         "type": "string",
         "value": "Name"
       }
-    ]
-  },
+  ],
   "products": [
     {
       "productId": 1,
@@ -2458,123 +2455,6 @@ Enum:
 [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ] <br>
 
 
-**childrenCount:**	number <br>
-*number of nested pages* <br>
-example: 0 <br>
-
-</details>
-
-### Pages.getCatalogPages(langCode, limit, offset)
-
-```js
-const value = await Pages.getCatalogPages('en_US', 0, 30)
-```
-
-> This method retrieves all page objects with product information as an array from the API. It accepts two optional parameters limit and offset for pagination and language code parameter. It returns a Promise that resolves to an array of ContentIndexedPageDto objects or an empty array [] if there is no data.
-
-Example return:
-
-```json
-[
-  {
-    "id": 1,
-    "config": {},
-    "depth": 0,
-    "parentId": null,
-    "pageUrl": "blog",
-    "attributeSetIdentifier": "page",
-    "localizeInfos": {
-      "title": "Blog",
-      "menuTitle": "Blog",
-      "htmlContent": "",
-      "plainContent": ""
-    },
-    "position": 1,
-    "isVisible": true,
-    "products": 0,
-    "childrenCount": 1,
-    "type": "forUsualPage",
-    "templateIdentifier": "template",
-    "isSync": true,
-    "attributeValues": {
-      "text": {
-        "type": "string",
-        "value": "some text",
-        "position": 0
-      }
-    }
-  }
-]
-```
-<details>
-<summary>Schema</summary>
-
-**id:**	number <br>
-*object identifier* <br>
-example: 1764 <br>
-
-**parentId** number <br>
-*parent page identifier, if null, it is a top-level page* <br>
-example: null <br>
-
-**config**	Record<string, number> <br>
-*output settings for catalog pages* <br>
-example: OrderedMap { "rowsPerPage": 1, "productsPerRow": 1 } <br>
-
-**pageUrl**	string <br>
-*unique page URL* <br>
-
-**depth** number <br>
-*page nesting depth relative to parentId* <br>
-example: 3 <br>
-
-**localizeInfos:**	Record<string, any> <br>
-*json description of the main page data object taking into account the language "en_US" (for example)* <br>
-example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
-
-**isVisible:**	boolean <br>
-*Page visibility flag* <br>
-example: true <br>
-
-**products** number <br>
-*Number of products linked to the page* <br>
-example: 0 <br>
-
-**attributeSetId:**	number <br>
-*attribute set identifier* <br>
-example: 7 <br>
-
-**forms**	 <br>
-*Array of FormEntity object identifier values linked to the page (optional)* <br>
-
-
-**blocks**	 <br>
-*Array of BlockEntity object identifier values linked to the page (optional)* <br>
-
-
-**isSync:**	boolean <br>
-*indicator of page indexing (true or false)* <br>
-example: false <br>
-
-**templateIdentifier:**	string <br>
-*Custom identifier of the linked template* <br>
-example: my-template <br>
-
-**attributeValues:**	Record<string, string> <br>
-*Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
-example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } } <br>
-
-**position:**	number <br>
-*position number for sorting (optional)* <br>
-example: 192 <br>
-
-**type:**	string <br>
-*Page type* <br>
-example: forNewsPage <br>
-Enum:
-[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ] <br>
-
-
 **childrenCount:**	number <br>
 *number of nested pages* <br>
 example: 0 <br>

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

@@ -92,9 +92,12 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
      */
     refresh(marker: string, token: string): Promise<IAuthEntity>;
     /**
-     * User logout
+     *
+     * User logout.
      * @param {string} marker - The text identifier of the authorization provider. Example - email
      * @param {string} token - Refresh token
+     *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     logout(marker: string, token: string): Promise<boolean>;
     /**

package/dist/auth-provider/authProviderApi.js

@@ -136,9 +136,12 @@ class AuthProviderApi extends asyncModules_1.default {
         return result;
     }
     /**
-     * User logout
+     *
+     * User logout.
      * @param {string} marker - The text identifier of the authorization provider. Example - email
      * @param {string} token - Refresh token
+     *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     async logout(marker, token) {
         const data = {

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

@@ -50,16 +50,16 @@ interface ISignUpEntity {
     version: number;
     identifier: string;
     isActive: boolean;
-    authProviderId: number;
     formData: Array<{
         marker: string;
         value: string;
     }>;
-    notificationData: IAuthFormData | Array<IAuthFormData>;
-    systemCode: {
-        value: string;
-        expiredDate: string;
+    notificationData: {
+        email: string;
+        phonePush: string;
+        phoneSMS: string;
     };
+    locale: string;
 }
 interface ICodeEntity {
     code: string;

package/dist/base/utils.d.ts

@@ -2,7 +2,7 @@ type Types = 'forCatalogProducts' | 'forBasketPage' | 'forErrorPage' | 'forCatal
 /**
  * @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.
+ * @param {boolean} [traficLimit] - 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.
  * @param {boolean} [auth] - An object with authorization settings
  * @param {boolean} [auth.customAuth] - Set this flag to true if you want to configure the authorization process yourself. Set the flag to false, or do not pass it at all to have automatic authorization and token renewal
  * @param {boolean} [auth.refreshToken] - Transfer the refresh token here, for example from the local storage, to resume the user's session. Otherwise, the user will need to log in every time a new session is created

package/dist/index.d.ts

@@ -47,6 +47,11 @@ interface IDefineApi {
  * @param {IConfig} config - Custom configuration settings
  * @param {string} [config.token] - Optional token parameter
  * @param {string} [config.langCode] - Optional langCode parameter
+ * @param {boolean} [config.traficLimit] - 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.
+ * @param {string} [config.auth] - An object with authorization settings.
+ * @param {boolean} [config.auth.customAuth] - Set this flag to true if you want to configure the authorization process yourself. Set the flag to false, or do not pass it at all to have automatic authorization and token renewal.
+ * @param {string} [config.auth.refreshToken] - Transfer the refresh token here, for example from the local storage, to resume the user's session. Otherwise, the user will need to log in every time a new session is created.
+ * @param {string} [config.auth.saveFunction] - If you want to store the token between sessions, for example in local storage, create a custom function that takes refreshToken as a parameter and executes the necessary instructions. This function will be called every time the tokens are updated.
  * @returns {IDefineApi} - List of methods set.
  */
 export declare function defineOneEntry(url: string, config: IConfig): IDefineApi;

package/dist/index.js

@@ -28,6 +28,11 @@ const stateModule_1 = require("./base/stateModule");
  * @param {IConfig} config - Custom configuration settings
  * @param {string} [config.token] - Optional token parameter
  * @param {string} [config.langCode] - Optional langCode parameter
+ * @param {boolean} [config.traficLimit] - 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.
+ * @param {string} [config.auth] - An object with authorization settings.
+ * @param {boolean} [config.auth.customAuth] - Set this flag to true if you want to configure the authorization process yourself. Set the flag to false, or do not pass it at all to have automatic authorization and token renewal.
+ * @param {string} [config.auth.refreshToken] - Transfer the refresh token here, for example from the local storage, to resume the user's session. Otherwise, the user will need to log in every time a new session is created.
+ * @param {string} [config.auth.saveFunction] - If you want to store the token between sessions, for example in local storage, create a custom function that takes refreshToken as a parameter and executes the necessary instructions. This function will be called every time the tokens are updated.
  * @returns {IDefineApi} - List of methods set.
  */
 function defineOneEntry(url, config) {

package/dist/orders/ordersApi.d.ts

@@ -15,6 +15,8 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      * @param {IOrderData} data - Object for creating an order
      * @param {String} langCode - Optional language field
      *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     *
      * @example
      * const body = {
      *   "formIdentifier": "bar-orders-form",
@@ -37,6 +39,8 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
     createOrder(marker: string, data: IOrderData, langCode?: string): Promise<IBaseOrdersEntity>;
     /**
      * Getting all order storage object by marker
+     *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      * @param {number} marker - Textual identifier of the order storage object
      * @param {string} [langCode] Optional language field
      * @param {number} [limit] Limit parameter. Default 30
@@ -45,6 +49,8 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
     getAllOrdersByMarker(marker: string, langCode?: string, limit?: number, offset?: number): Promise<Array<IOrdersByMarkersEntity>>;
     /**
      * Changing an order in the order store
+     *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      * @param marker - The text identifier of the order storage object
      * @param id - ID of the order object
      * @param data Object for updating an order
@@ -71,6 +77,8 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
     updateOrderByMarkerAndId(marker: string, id: number, data: IOrderData, langCode?: string): Promise<IBaseOrdersEntity>;
     /**
      * Getting all the order storage objects
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     *
      * @param {number} [langCode] Optional language field
      * @param {number} [limit] - Optional parameter for pagination, default is 0
      * @param {number} [offset] - Optional parameter for pagination, default is 30
@@ -79,6 +87,7 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
     /**
      * Retrieve one order storage object by marker.
      *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      * @param {string} marker - Marker of the order object
      * @param {string} [langCode] - Language code
      *

package/dist/orders/ordersApi.js

@@ -16,6 +16,8 @@ class OrdersApi extends asyncModules_1.default {
      * @param {IOrderData} data - Object for creating an order
      * @param {String} langCode - Optional language field
      *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     *
      * @example
      * const body = {
      *   "formIdentifier": "bar-orders-form",
@@ -44,6 +46,8 @@ class OrdersApi extends asyncModules_1.default {
     }
     /**
      * Getting all order storage object by marker
+     *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      * @param {number} marker - Textual identifier of the order storage object
      * @param {string} [langCode] Optional language field
      * @param {number} [limit] Limit parameter. Default 30
@@ -55,6 +59,8 @@ class OrdersApi extends asyncModules_1.default {
     }
     /**
      * Changing an order in the order store
+     *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      * @param marker - The text identifier of the order storage object
      * @param id - ID of the order object
      * @param data Object for updating an order
@@ -87,6 +93,8 @@ class OrdersApi extends asyncModules_1.default {
     }
     /**
      * Getting all the order storage objects
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     *
      * @param {number} [langCode] Optional language field
      * @param {number} [limit] - Optional parameter for pagination, default is 0
      * @param {number} [offset] - Optional parameter for pagination, default is 30
@@ -98,6 +106,7 @@ class OrdersApi extends asyncModules_1.default {
     /**
      * Retrieve one order storage object by marker.
      *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      * @param {string} marker - Marker of the order object
      * @param {string} [langCode] - Language code
      *

package/dist/pages/pagesApi.d.ts

@@ -16,18 +16,6 @@ export default class PageApi extends AsyncModules implements IPageApi {
      * @returns Returns all created pages without parents as an array of PageEntity 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 PageEntity 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.
      *

package/dist/pages/pagesApi.js

@@ -21,21 +21,6 @@ class PageApi extends asyncModules_1.default {
         const result = await this._fetchGet(`/root?langCode=${langCode}`);
         return this._normalizeData(result, langCode);
     }
-    /**
-     * 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 PageEntity objects or an empty array [] (if there is no data)
-     */
-    async getCatalogPages(langCode = this.state.lang, limit = 30, offset = 0) {
-        const result = await this._fetchGet(`/catalog?langCode=${langCode}&limit=${limit}&offset=${offset}`);
-        return this._normalizeData(result, langCode);
-    }
     /**
      * Get all page objects with product information as an array.
      *

package/dist/pages/pagesInterfaces.d.ts

@@ -22,7 +22,6 @@ import { IAttributes, LangType, Types } from "../base/utils";
  */
 interface IPageApi {
     getRootPages(langCode?: LangType): Promise<Array<IPagesEntity>>;
-    getCatalogPages(langCode: LangType, limit: number, offset: number): Promise<Array<IPagesEntity>>;
     getPages(langCode: LangType): Promise<Array<IPagesEntity>>;
     getPageById(id: number, langCode: LangType): Promise<IPagesEntity>;
     getPageByUrl(url: string, langCode: LangType): Promise<IPagesEntity>;
@@ -118,7 +117,7 @@ interface IPositionBlock {
  * @property {number} childrenCount - Children count.
  */
 interface IPagesEntity {
-    attributeSetIdentifier?: string;
+    attributeSetIdentifier: string;
     attributeValues: Record<string, any>;
     childrenCount?: number;
     config?: Record<string, number>;

package/dist/payments/paymentsApi.d.ts

@@ -11,6 +11,7 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
     /**
      * Get list of payment sessions.
      *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      * @param {number} [limit] - Optional parameter for pagination, default is 0
      * @param {number} [offset] - Optional parameter for pagination, default is 30
      *
@@ -19,6 +20,7 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
     getSessions(limit?: number, offset?: number): Promise<Array<ISessionEntity>>;
     /**
      * Get a single payment session object by its identifier.
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
      * @param {number} id - Identifier of the retrieved payment session object
      *
@@ -27,6 +29,7 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
     getSessionById(id: number): Promise<ISessionEntity>;
     /**
      * Creation of payment session.
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
      * @param {number} orderId - Order identifier
      * @param {'session' | 'intent'} type - Session type
@@ -37,18 +40,21 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
     createSession(orderId: number, type: 'session' | 'intent', automaticTaxEnabled?: boolean): Promise<ICreateSessionEntity>;
     /**
      * Get payment settings.
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
      * @returns Returns object PaymentsConnected or null.
      */
     getConnected(): Promise<IConnectedEntity | null>;
     /**
      * Get all payment accounts as an array.
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
      * @returns Returns all created payment accounts as an array of PaymentAccountEntity objects.
      */
     getAccounts(): Promise<Array<IAccountsEntity>>;
     /**
      * Get a single payment account object by its identifier.
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
      * @param {number} id - Identifier of the retrieved payment account object
      *
@@ -57,6 +63,7 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
     getAccountById(id: number): Promise<IAccountsEntity>;
     /**
      * Webhook for Stripe.
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
      * @returns Returns true (in case of successful execution) or false (in case of unsuccessful execution)
      */

package/dist/payments/paymentsApi.js

@@ -12,6 +12,7 @@ class PaymentsApi extends asyncModules_1.default {
     /**
      * Get list of payment sessions.
      *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      * @param {number} [limit] - Optional parameter for pagination, default is 0
      * @param {number} [offset] - Optional parameter for pagination, default is 30
      *
@@ -23,6 +24,7 @@ class PaymentsApi extends asyncModules_1.default {
     }
     /**
      * Get a single payment session object by its identifier.
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
      * @param {number} id - Identifier of the retrieved payment session object
      *
@@ -34,6 +36,7 @@ class PaymentsApi extends asyncModules_1.default {
     }
     /**
      * Creation of payment session.
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
      * @param {number} orderId - Order identifier
      * @param {'session' | 'intent'} type - Session type
@@ -50,6 +53,7 @@ class PaymentsApi extends asyncModules_1.default {
     }
     /**
      * Get payment settings.
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
      * @returns Returns object PaymentsConnected or null.
      */
@@ -59,6 +63,7 @@ class PaymentsApi extends asyncModules_1.default {
     }
     /**
      * Get all payment accounts as an array.
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
      * @returns Returns all created payment accounts as an array of PaymentAccountEntity objects.
      */
@@ -68,6 +73,7 @@ class PaymentsApi extends asyncModules_1.default {
     }
     /**
      * Get a single payment account object by its identifier.
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
      * @param {number} id - Identifier of the retrieved payment account object
      *
@@ -79,6 +85,7 @@ class PaymentsApi extends asyncModules_1.default {
     }
     /**
      * Webhook for Stripe.
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
      * @returns Returns true (in case of successful execution) or false (in case of unsuccessful execution)
      */

package/dist/users/usersApi.d.ts

@@ -10,11 +10,16 @@ export default class UsersApi extends AsyncModules implements IUsers {
     constructor(state: StateModule);
     /**
      * Getting the data of an authorized user.
+     *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     *
      * @param {string} [langCode] Required parameter lang code.
      */
     getUser(langCode?: string): Promise<IUserEntity>;
     /**
      * Updating a single user object.
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     *
      * @param {object} data - Request body.
      * @param {string} langCode - Optional language field
      *

package/dist/users/usersApi.js

@@ -11,6 +11,9 @@ class UsersApi extends asyncModules_1.default {
     }
     /**
      * Getting the data of an authorized user.
+     *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     *
      * @param {string} [langCode] Required parameter lang code.
      */
     async getUser(langCode = this.state.lang) {
@@ -19,6 +22,8 @@ class UsersApi extends asyncModules_1.default {
     }
     /**
      * Updating a single user object.
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     *
      * @param {object} data - Request body.
      * @param {string} langCode - Optional language field
      *

package/package.json

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