oneentry 1.0.137 → 1.0.138

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/dist/admins/adminsApi.d.ts +2 -2
  2. package/dist/admins/adminsApi.js +2 -2
  3. package/dist/admins/adminsInterfaces.d.ts +1 -1
  4. package/dist/attribute-sets/attributeSetsApi.d.ts +8 -8
  5. package/dist/attribute-sets/attributeSetsApi.js +8 -8
  6. package/dist/attribute-sets/attributeSetsInterfaces.d.ts +3 -3
  7. package/dist/auth-provider/authProviderApi.d.ts +33 -33
  8. package/dist/auth-provider/authProviderApi.js +33 -33
  9. package/dist/auth-provider/authProvidersInterfaces.d.ts +12 -62
  10. package/dist/base/asyncModules.js +4 -50
  11. package/dist/base/stateModule.d.ts +1 -0
  12. package/dist/base/stateModule.js +16 -15
  13. package/dist/base/syncModules.d.ts +6 -0
  14. package/dist/base/syncModules.js +48 -5
  15. package/dist/base/utils.d.ts +15 -8
  16. package/dist/blocks/blocksApi.d.ts +10 -10
  17. package/dist/blocks/blocksApi.js +10 -10
  18. package/dist/blocks/blocksInterfaces.d.ts +1 -0
  19. package/dist/events/eventsApi.d.ts +5 -5
  20. package/dist/events/eventsApi.js +5 -5
  21. package/dist/events/eventsInterfaces.d.ts +25 -15
  22. package/dist/file-uploading/fileUploadingApi.d.ts +6 -6
  23. package/dist/file-uploading/fileUploadingApi.js +6 -6
  24. package/dist/forms/formsApi.d.ts +4 -4
  25. package/dist/forms/formsApi.js +4 -4
  26. package/dist/forms/formsInterfaces.d.ts +1 -0
  27. package/dist/forms-data/formsDataApi.d.ts +10 -10
  28. package/dist/forms-data/formsDataApi.js +10 -10
  29. package/dist/forms-data/formsDataInterfaces.d.ts +24 -24
  30. package/dist/forms-data/formsDataSchemas.d.ts +36 -28
  31. package/dist/forms-data/formsDataSchemas.js +16 -13
  32. package/dist/general-types/generalTypesApi.d.ts +2 -2
  33. package/dist/general-types/generalTypesApi.js +2 -2
  34. package/dist/index.d.ts +23 -1
  35. package/dist/integration-collections/integrationCollectionsApi.d.ts +17 -17
  36. package/dist/integration-collections/integrationCollectionsApi.js +17 -17
  37. package/dist/locales/localesApi.d.ts +2 -2
  38. package/dist/locales/localesApi.js +2 -2
  39. package/dist/menus/menusApi.d.ts +2 -2
  40. package/dist/menus/menusApi.js +2 -2
  41. package/dist/menus/menusInterfaces.d.ts +2 -2
  42. package/dist/orders/ordersApi.d.ts +12 -12
  43. package/dist/orders/ordersApi.js +12 -12
  44. package/dist/orders/ordersInterfaces.d.ts +2 -1
  45. package/dist/pages/pagesApi.d.ts +20 -20
  46. package/dist/pages/pagesApi.js +20 -20
  47. package/dist/pages/pagesInterfaces.d.ts +10 -7
  48. package/dist/payments/paymentsApi.d.ts +13 -13
  49. package/dist/payments/paymentsApi.js +12 -12
  50. package/dist/payments/paymentsInterfaces.d.ts +8 -2
  51. package/dist/payments/paymentsSchemas.d.ts +22 -6
  52. package/dist/payments/paymentsSchemas.js +6 -3
  53. package/dist/product-statuses/productStatusesApi.d.ts +6 -6
  54. package/dist/product-statuses/productStatusesApi.js +6 -6
  55. package/dist/products/productsApi.d.ts +29 -28
  56. package/dist/products/productsApi.js +31 -30
  57. package/dist/products/productsInterfaces.d.ts +26 -21
  58. package/dist/system/systemApi.d.ts +10 -10
  59. package/dist/system/systemApi.js +10 -10
  60. package/dist/templates/templatesApi.d.ts +6 -6
  61. package/dist/templates/templatesApi.js +6 -6
  62. package/dist/templates-preview/templatesPreviewApi.d.ts +3 -3
  63. package/dist/templates-preview/templatesPreviewApi.js +3 -3
  64. package/dist/templates-preview/templatesPreviewInterfaces.d.ts +1 -0
  65. package/dist/users/usersApi.d.ts +18 -18
  66. package/dist/users/usersApi.js +18 -18
  67. package/dist/users/usersInterfaces.d.ts +8 -10
  68. package/package.json +34 -11
  69. package/dist/config.d.ts +0 -21
  70. package/dist/config.js +0 -48
@@ -43,8 +43,8 @@ export default class AdminsApi extends AsyncModules implements IAdmins {
43
43
  * @param {string} [langCode] - Language code. Default: "en_US".
44
44
  * @param {number} [offset] - Parameter for pagination. Default: 0.
45
45
  * @param {number} [limit] - Parameter for pagination. Default: 30.
46
- * @returns {IAdminEntity[]} Returns an array of admin objects.
47
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
46
+ * @returns {Promise<IAdminEntity[] | IError>} Returns an array of admin objects.
47
+ * @throws {IError} When isShell=false and an error occurs during the fetch
48
48
  */
49
49
  getAdminsInfo(body?: AttributeType[], langCode?: string, offset?: number, limit?: number): Promise<IAdminEntity[] | IError>;
50
50
  }
@@ -47,8 +47,8 @@ class AdminsApi extends asyncModules_1.default {
47
47
  * @param {string} [langCode] - Language code. Default: "en_US".
48
48
  * @param {number} [offset] - Parameter for pagination. Default: 0.
49
49
  * @param {number} [limit] - Parameter for pagination. Default: 30.
50
- * @returns {IAdminEntity[]} Returns an array of admin objects.
51
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
50
+ * @returns {Promise<IAdminEntity[] | IError>} Returns an array of admin objects.
51
+ * @throws {IError} When isShell=false and an error occurs during the fetch
52
52
  */
53
53
  async getAdminsInfo(body = [], langCode = this.state.lang, offset = 0, limit = 30) {
54
54
  const query = {
@@ -55,7 +55,7 @@ interface IPosition {
55
55
  /**
56
56
  * Interface representing an Admin Entity.
57
57
  * @interface IAdminEntity
58
- * @property {number | null} id - The identifier of the object. Example: 1764.
58
+ * @property {number} id - The identifier of the object. Example: 1764.
59
59
  * @property {number | null} attributeSetId - The identifier of the attribute set being used. Example: 120.
60
60
  * @property {string} identifier - The textual identifier for the record field. Example: "admin1".
61
61
  * @property {string | null} attributeSetIdentifier - The identifier of the attribute set. Example: "admins".
@@ -28,8 +28,8 @@ export default class AttributesSetsApi extends AsyncModules implements IAttribut
28
28
  * @param {number} [limit] - parameter limiting the selection of records. Default: 30.
29
29
  * @param {number} [typeId] - identifier of the attribute set type. Default: null.
30
30
  * @param {string} [sortBy] - identifier of the attribute set type. Default: "id".
31
- * @returns {IAttributesSetsResponse} Returns object with array of IAttributeSetsEntity and total items count.
32
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
31
+ * @returns {Promise<IAttributesSetsResponse | IError>} Returns object with array of IAttributeSetsEntity and total items count.
32
+ * @throws {IError} When isShell=false and an error occurs during the fetch
33
33
  */
34
34
  getAttributes(langCode?: string, offset?: number, limit?: number, typeId?: any, sortBy?: string): Promise<IAttributesSetsResponse | IError>;
35
35
  /**
@@ -37,8 +37,8 @@ export default class AttributesSetsApi extends AsyncModules implements IAttribut
37
37
  * @handleName getAttributesByMarker
38
38
  * @param {string} marker - Attribute marker. Example: "productAttributes".
39
39
  * @param {string} [langCode] - Language code. Default: "en_US".
40
- * @returns {IAttributeSetsEntity[]} Returns an array of Attributes objects.
41
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
40
+ * @returns {Promise<IAttributeSetsEntity[] | IError>} Returns an array of Attributes objects.
41
+ * @throws {IError} When isShell=false and an error occurs during the fetch
42
42
  */
43
43
  getAttributesByMarker(marker: string, langCode?: string): Promise<IAttributeSetsEntity[] | IError>;
44
44
  /**
@@ -47,8 +47,8 @@ export default class AttributesSetsApi extends AsyncModules implements IAttribut
47
47
  * @param {string} setMarker - Text identifier (marker) of the attribute set. Example: "productAttributes".
48
48
  * @param {string} attributeMarker - Text identifier (marker) of the attribute in the set. Example: "color".
49
49
  * @param {string} [langCode] - Language code. Default: "en_US".
50
- * @returns {IAttributesSetsEntity} Returns a single attribute object from the attribute set.
51
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
50
+ * @returns {Promise<IAttributesSetsEntity | IError>} Returns a single attribute object from the attribute set.
51
+ * @throws {IError} When isShell=false and an error occurs during the fetch
52
52
  */
53
53
  getSingleAttributeByMarkerSet(setMarker: string, attributeMarker: string, langCode?: string): Promise<IAttributesSetsEntity | IError>;
54
54
  /**
@@ -56,8 +56,8 @@ export default class AttributesSetsApi extends AsyncModules implements IAttribut
56
56
  * @handleName getAttributeSetByMarker
57
57
  * @param {string} marker - marker of the attribute set object. Example: "productAttributes".
58
58
  * @param {string} [langCode] - Language code. Default: "en_US".
59
- * @returns {IAttributeSetsEntity} Returns one object of the attribute set.
60
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
59
+ * @returns {Promise<IAttributeSetsEntity | IError>} Returns one object of the attribute set.
60
+ * @throws {IError} When isShell=false and an error occurs during the fetch
61
61
  */
62
62
  getAttributeSetByMarker(marker: string, langCode?: string): Promise<IAttributeSetsEntity | IError>;
63
63
  }
@@ -32,8 +32,8 @@ class AttributesSetsApi extends asyncModules_1.default {
32
32
  * @param {number} [limit] - parameter limiting the selection of records. Default: 30.
33
33
  * @param {number} [typeId] - identifier of the attribute set type. Default: null.
34
34
  * @param {string} [sortBy] - identifier of the attribute set type. Default: "id".
35
- * @returns {IAttributesSetsResponse} Returns object with array of IAttributeSetsEntity and total items count.
36
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
35
+ * @returns {Promise<IAttributesSetsResponse | IError>} Returns object with array of IAttributeSetsEntity and total items count.
36
+ * @throws {IError} When isShell=false and an error occurs during the fetch
37
37
  */
38
38
  async getAttributes(langCode = this.state.lang, offset = 0, limit = 30,
39
39
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -56,8 +56,8 @@ class AttributesSetsApi extends asyncModules_1.default {
56
56
  * @handleName getAttributesByMarker
57
57
  * @param {string} marker - Attribute marker. Example: "productAttributes".
58
58
  * @param {string} [langCode] - Language code. Default: "en_US".
59
- * @returns {IAttributeSetsEntity[]} Returns an array of Attributes objects.
60
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
59
+ * @returns {Promise<IAttributeSetsEntity[] | IError>} Returns an array of Attributes objects.
60
+ * @throws {IError} When isShell=false and an error occurs during the fetch
61
61
  */
62
62
  async getAttributesByMarker(marker, langCode = this.state.lang) {
63
63
  const result = await this._fetchGet(`/${marker}/attributes?langCode=${langCode}`);
@@ -71,8 +71,8 @@ class AttributesSetsApi extends asyncModules_1.default {
71
71
  * @param {string} setMarker - Text identifier (marker) of the attribute set. Example: "productAttributes".
72
72
  * @param {string} attributeMarker - Text identifier (marker) of the attribute in the set. Example: "color".
73
73
  * @param {string} [langCode] - Language code. Default: "en_US".
74
- * @returns {IAttributesSetsEntity} Returns a single attribute object from the attribute set.
75
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
74
+ * @returns {Promise<IAttributesSetsEntity | IError>} Returns a single attribute object from the attribute set.
75
+ * @throws {IError} When isShell=false and an error occurs during the fetch
76
76
  */
77
77
  async getSingleAttributeByMarkerSet(setMarker, attributeMarker, langCode = this.state.lang) {
78
78
  const result = await this._fetchGet(`/${setMarker}/attributes/${attributeMarker}?langCode=${langCode}`);
@@ -85,8 +85,8 @@ class AttributesSetsApi extends asyncModules_1.default {
85
85
  * @handleName getAttributeSetByMarker
86
86
  * @param {string} marker - marker of the attribute set object. Example: "productAttributes".
87
87
  * @param {string} [langCode] - Language code. Default: "en_US".
88
- * @returns {IAttributeSetsEntity} Returns one object of the attribute set.
89
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
88
+ * @returns {Promise<IAttributeSetsEntity | IError>} Returns one object of the attribute set.
89
+ * @throws {IError} When isShell=false and an error occurs during the fetch
90
90
  */
91
91
  async getAttributeSetByMarker(marker, langCode = this.state.lang) {
92
92
  const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
@@ -60,6 +60,7 @@ type AttributeType = 'string' | 'text' | 'textWithHeader' | 'integer' | 'real' |
60
60
  * @interface IAttributesSetsEntity
61
61
  * @property {AttributeType} type - Attribute type. Example: "string", "text", "integer", "etc".
62
62
  * @property {any} [value] - Value of the attribute, which can be of any type.
63
+ * @property {any} initialValue - Initial value of the attribute.
63
64
  * @property {string} marker - Textual identifier of the attribute (marker). Example: "color", "size", "etc".
64
65
  * @property {number} position - Position number for sorting. Example: 1.
65
66
  * @property {IListTitle[] | Record<string, any>} [listTitles] - Array of values (with extended data) for list and radioButton attributes.
@@ -96,7 +97,6 @@ type AttributeType = 'string' | 'text' | 'textWithHeader' | 'integer' | 'real' |
96
97
  "title": "My attribute"
97
98
  }
98
99
  * @property {Record<string, any>} [additionalFields] - Additional fields for the attribute (optional).
99
- * @property {Record<string, any>} [settings] - Additional attribute settings (optional).
100
100
  * @description This interface defines the structure of an attribute set entity, including its type, marker, position, validators, localization information, list titles, additional fields, and settings.
101
101
  */
102
102
  interface IAttributesSetsEntity {
@@ -109,13 +109,13 @@ interface IAttributesSetsEntity {
109
109
  validators?: Record<string, any>;
110
110
  localizeInfos: ILocalizeInfo;
111
111
  additionalFields?: Record<string, any>;
112
- settings?: Record<string, any>;
113
112
  }
114
113
  /**
115
114
  * Represents an attribute set entity.
116
115
  * @interface IAttributeSetsEntity
117
116
  * @property {number} id - The unique identifier of the attribute set entity. Example: 123.
118
- * @property {string} updatedDate - The date when the attribute set was last updated, represented as a string. Example: "2023-10-01T12:00:00Z".
117
+ * @property {string} createdDate - The date when the attribute set was created. Example: "2023-10-01T12:00:00Z".
118
+ * @property {string} updatedDate - The date when the attribute set was last updated. Example: "2023-10-01T12:00:00Z".
119
119
  * @property {number} version - The version number of the attribute set, used for tracking changes or updates. Example: 1.
120
120
  * @property {string} identifier - A string that uniquely identifies the attribute set. Example: "attributeSet1".
121
121
  * @property {number} typeId - The numerical identifier representing the type of the attribute set. Example: 1.
@@ -27,19 +27,19 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
27
27
  "formIdentifier": "reg",
28
28
  "authData": [
29
29
  {
30
- "marker": "login",
31
- "value": "example@oneentry.cloud"
30
+ "marker": "login",
31
+ "value": "example@oneentry.cloud"
32
32
  },
33
33
  {
34
- "marker": "password",
35
- "value": "12345"
34
+ "marker": "password",
35
+ "value": "12345"
36
36
  }
37
37
  ],
38
38
  "formData": [
39
39
  {
40
- "marker": "last_name",
41
- "type": "string",
42
- "value": "Name"
40
+ "marker": "last_name",
41
+ "type": "string",
42
+ "value": "Name"
43
43
  }
44
44
  ],
45
45
  "notificationData": {
@@ -79,8 +79,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
79
79
  * @param {Array<string>} [body.notificationData.phonePush] - An array of phone numbers for push notifications. Optional.
80
80
  * @param {string} [body.notificationData.phoneSMS] - The phone number for SMS notifications. Optional.
81
81
  * @param {string} [langCode] - Language code. Default: "en_US".
82
- * @returns {ISignUpEntity} Returns a user object.
83
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
82
+ * @returns {Promise<ISignUpEntity | IError>} Returns a user object.
83
+ * @throws {IError} When isShell=false and an error occurs during the fetch
84
84
  * @description User registration (❗️For a provider with user activation, the activation code is sent through the corresponding user notification method).
85
85
  */
86
86
  signUp(marker: string, body: ISignUpData, langCode?: string): Promise<ISignUpEntity | IError>;
@@ -90,8 +90,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
90
90
  * @param {string} marker - The text identifier of the authorization provider. Example: "email".
91
91
  * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
92
92
  * @param {string} eventIdentifier - Text identifier of the event object for which the code is generated. Example: "user_registration".
93
- * @returns {void} Returns void if the code is successfully generated, or an error object if there was an issue.
94
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
93
+ * @returns {Promise<void | IError>} Returns void if the code is successfully generated, or an error object if there was an issue.
94
+ * @throws {IError} When isShell=false and an error occurs during the fetch
95
95
  * @description Obtaining a code to activate the user.
96
96
  */
97
97
  generateCode(marker: string, userIdentifier: string, eventIdentifier: string): Promise<void | IError>;
@@ -102,8 +102,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
102
102
  * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
103
103
  * @param {string} eventIdentifier - Text identifier of the event object for which the code is generated. Example: "user_registration".
104
104
  * @param {string} code - Service code. Example: "123456".
105
- * @returns {boolean} Returns true if the code is correct, or an error object if there was an issue.
106
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
105
+ * @returns {Promise<boolean | IError>} Returns true if the code is correct, or an error object if there was an issue.
106
+ * @throws {IError} When isShell=false and an error occurs during the fetch
107
107
  * @description Checking the user activation code
108
108
  */
109
109
  checkCode(marker: string, userIdentifier: string, eventIdentifier: string, code: string): Promise<boolean | IError>;
@@ -113,8 +113,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
113
113
  * @param {string} marker - The text identifier of the authorization provider. Example: "email".
114
114
  * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
115
115
  * @param {string} code - Service code. Example: "123456".
116
- * @returns {boolean} Returns true if the user was successfully activated, or an error object if there was an issue.
117
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
116
+ * @returns {Promise<boolean | IError>} Returns true if the user was successfully activated, or an error object if there was an issue.
117
+ * @throws {IError} When isShell=false and an error occurs during the fetch
118
118
  * @description User activation.
119
119
  */
120
120
  activateUser(marker: string, userIdentifier: string, code: string): Promise<boolean | IError>;
@@ -146,8 +146,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
146
146
  ]
147
147
  * @param {string} body.authData[index].marker - The marker for the authentication data. Example: "login".
148
148
  * @param {string} body.authData[index].value - The value for the authentication data. Example: "user@example.com".
149
- * @returns {IAuthEntity} Returns an auth entity object.
150
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
149
+ * @returns {Promise<IAuthEntity | IError>} Returns an auth entity object.
150
+ * @throws {IError} When isShell=false and an error occurs during the fetch
151
151
  * @description User authorization.
152
152
  */
153
153
  auth(marker: string, body: IAuthPostBody): Promise<IAuthEntity | IError>;
@@ -156,8 +156,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
156
156
  * @handleName refresh
157
157
  * @param {string} marker - The text identifier of the authorization provider. Example: "email".
158
158
  * @param {string} token - Refresh token. Example: "abcdef123456".
159
- * @returns {IAuthEntity} Returns an auth entity object with the following values: accessToken, refreshToken, user, and other auth-related data.
160
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
159
+ * @returns {Promise<IAuthEntity | IError>} Returns an auth entity object with the following values: accessToken, refreshToken, user, and other auth-related data.
160
+ * @throws {IError} When isShell=false and an error occurs during the fetch
161
161
  * @description User token refresh.
162
162
  */
163
163
  refresh(marker: string, token: string): Promise<IAuthEntity | IError>;
@@ -166,8 +166,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
166
166
  * @handleName logout
167
167
  * @param {string} marker - The text identifier of the authorization provider. Example: "email".
168
168
  * @param {string} token - Refresh token. Example: "abcdef123456".
169
- * @returns {boolean} Returns true if the logout was successful, or an error object if there was an issue.
170
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
169
+ * @returns {Promise<boolean | IError>} Returns true if the logout was successful, or an error object if there was an issue.
170
+ * @throws {IError} When isShell=false and an error occurs during the fetch
171
171
  * @description This method requires user authorization.
172
172
  * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
173
173
  */
@@ -176,8 +176,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
176
176
  * Logout of user account on all devices.
177
177
  * @handleName logoutAll
178
178
  * @param {string} marker - The text identifier of the authorization provider. Example: "email".
179
- * @returns {boolean} Returns true if the logout was successful, or an error object if there was an issue.
180
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
179
+ * @returns {Promise<boolean | IError>} Returns true if the logout was successful, or an error object if there was an issue.
180
+ * @throws {IError} When isShell=false and an error occurs during the fetch
181
181
  * @description This method requires user authorization.
182
182
  * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
183
183
  */
@@ -192,8 +192,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
192
192
  * @param {string} code - Service code. Example: "123456".
193
193
  * @param {string} newPassword - New password. Example: "newPassword123".
194
194
  * @param {string} [repeatPassword] - Optional variable contains repeat new password for validation. Example: "newPassword123".
195
- * @returns {boolean} Returns true if the password was successfully changed, or an error object if there was an issue.
196
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
195
+ * @returns {Promise<boolean | IError>} Returns true if the password was successfully changed, or an error object if there was an issue.
196
+ * @throws {IError} When isShell=false and an error occurs during the fetch
197
197
  * @description User password change (only for tariffs with account activation and the Activation feature enabled).
198
198
  */
199
199
  changePassword(marker: string, userIdentifier: string, eventIdentifier: string, type: number, code: string, newPassword: string, repeatPassword?: string): Promise<boolean | IError>;
@@ -203,8 +203,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
203
203
  * @param {string} [langCode] - Language code. Default: "en_US".
204
204
  * @param {number} [offset] - Parameter for pagination. Default: 0.
205
205
  * @param {number} [limit] - Parameter for pagination. Default: 30.
206
- * @returns {IAuthProvidersEntity[]} Returns an array of auth provider objects.
207
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
206
+ * @returns {Promise<IAuthProvidersEntity[] | IError>} Returns an array of auth provider objects.
207
+ * @throws {IError} When isShell=false and an error occurs during the fetch
208
208
  * @description Getting all objects of authorization providers.
209
209
  */
210
210
  getAuthProviders(langCode?: string, offset?: number, limit?: number): Promise<IAuthProvidersEntity[] | IError>;
@@ -213,8 +213,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
213
213
  * @handleName getAuthProviderByMarker
214
214
  * @param {string} marker - The text identifier of the authorization provider. Example: "email".
215
215
  * @param {string} [langCode] - Language code. Default: "en_US".
216
- * @returns {IAuthProvidersEntity} Returns an auth provider object.
217
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
216
+ * @returns {Promise<IAuthProvidersEntity | IError>} Returns an auth provider object.
217
+ * @throws {IError} When isShell=false and an error occurs during the fetch
218
218
  * @description Getting a single authorization provider object by marker.
219
219
  */
220
220
  getAuthProviderByMarker(marker: string, langCode?: string): Promise<IAuthProvidersEntity | IError>;
@@ -222,8 +222,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
222
222
  * Getting active user sessions data.
223
223
  * @handleName getActiveSessionsByMarker
224
224
  * @param {string} marker - The text identifier of the authorization provider. Example: "email".
225
- * @returns {IActiveSession[]} Returns an auth provider object.
226
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
225
+ * @returns {Promise<IActiveSession[] | IError>} Returns an auth provider object.
226
+ * @throws {IError} When isShell=false and an error occurs during the fetch
227
227
  * @description Getting a single authorization provider object by marker.
228
228
  */
229
229
  getActiveSessionsByMarker(marker: string): Promise<IActiveSession[] | IError>;
@@ -241,8 +241,8 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
241
241
  "redirect_uri": "http://localhost:3000"
242
242
  }
243
243
  * @param {string} [langCode] - Language code. Default: "en_US".
244
- * @returns {ISignUpEntity} Returns a user object.
245
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
244
+ * @returns {Promise<ISignUpEntity | IError>} Returns a user object.
245
+ * @throws {IError} When isShell=false and an error occurs during the fetch
246
246
  * @description User registration (authorization) via OAUTH.
247
247
  */
248
248
  oauth(marker: string, body: IOauthData, langCode?: string): Promise<IAuthEntity | IError>;
@@ -32,19 +32,19 @@ class AuthProviderApi extends asyncModules_1.default {
32
32
  "formIdentifier": "reg",
33
33
  "authData": [
34
34
  {
35
- "marker": "login",
36
- "value": "example@oneentry.cloud"
35
+ "marker": "login",
36
+ "value": "example@oneentry.cloud"
37
37
  },
38
38
  {
39
- "marker": "password",
40
- "value": "12345"
39
+ "marker": "password",
40
+ "value": "12345"
41
41
  }
42
42
  ],
43
43
  "formData": [
44
44
  {
45
- "marker": "last_name",
46
- "type": "string",
47
- "value": "Name"
45
+ "marker": "last_name",
46
+ "type": "string",
47
+ "value": "Name"
48
48
  }
49
49
  ],
50
50
  "notificationData": {
@@ -84,8 +84,8 @@ class AuthProviderApi extends asyncModules_1.default {
84
84
  * @param {Array<string>} [body.notificationData.phonePush] - An array of phone numbers for push notifications. Optional.
85
85
  * @param {string} [body.notificationData.phoneSMS] - The phone number for SMS notifications. Optional.
86
86
  * @param {string} [langCode] - Language code. Default: "en_US".
87
- * @returns {ISignUpEntity} Returns a user object.
88
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
87
+ * @returns {Promise<ISignUpEntity | IError>} Returns a user object.
88
+ * @throws {IError} When isShell=false and an error occurs during the fetch
89
89
  * @description User registration (❗️For a provider with user activation, the activation code is sent through the corresponding user notification method).
90
90
  */
91
91
  async signUp(marker, body, langCode = this.state.lang) {
@@ -101,8 +101,8 @@ class AuthProviderApi extends asyncModules_1.default {
101
101
  * @param {string} marker - The text identifier of the authorization provider. Example: "email".
102
102
  * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
103
103
  * @param {string} eventIdentifier - Text identifier of the event object for which the code is generated. Example: "user_registration".
104
- * @returns {void} Returns void if the code is successfully generated, or an error object if there was an issue.
105
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
104
+ * @returns {Promise<void | IError>} Returns void if the code is successfully generated, or an error object if there was an issue.
105
+ * @throws {IError} When isShell=false and an error occurs during the fetch
106
106
  * @description Obtaining a code to activate the user.
107
107
  */
108
108
  async generateCode(marker, userIdentifier, eventIdentifier) {
@@ -120,8 +120,8 @@ class AuthProviderApi extends asyncModules_1.default {
120
120
  * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
121
121
  * @param {string} eventIdentifier - Text identifier of the event object for which the code is generated. Example: "user_registration".
122
122
  * @param {string} code - Service code. Example: "123456".
123
- * @returns {boolean} Returns true if the code is correct, or an error object if there was an issue.
124
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
123
+ * @returns {Promise<boolean | IError>} Returns true if the code is correct, or an error object if there was an issue.
124
+ * @throws {IError} When isShell=false and an error occurs during the fetch
125
125
  * @description Checking the user activation code
126
126
  */
127
127
  async checkCode(marker, userIdentifier, eventIdentifier, code) {
@@ -139,8 +139,8 @@ class AuthProviderApi extends asyncModules_1.default {
139
139
  * @param {string} marker - The text identifier of the authorization provider. Example: "email".
140
140
  * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
141
141
  * @param {string} code - Service code. Example: "123456".
142
- * @returns {boolean} Returns true if the user was successfully activated, or an error object if there was an issue.
143
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
142
+ * @returns {Promise<boolean | IError>} Returns true if the user was successfully activated, or an error object if there was an issue.
143
+ * @throws {IError} When isShell=false and an error occurs during the fetch
144
144
  * @description User activation.
145
145
  */
146
146
  async activateUser(marker, userIdentifier, code) {
@@ -179,8 +179,8 @@ class AuthProviderApi extends asyncModules_1.default {
179
179
  ]
180
180
  * @param {string} body.authData[index].marker - The marker for the authentication data. Example: "login".
181
181
  * @param {string} body.authData[index].value - The value for the authentication data. Example: "user@example.com".
182
- * @returns {IAuthEntity} Returns an auth entity object.
183
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
182
+ * @returns {Promise<IAuthEntity | IError>} Returns an auth entity object.
183
+ * @throws {IError} When isShell=false and an error occurs during the fetch
184
184
  * @description User authorization.
185
185
  */
186
186
  async auth(marker, body) {
@@ -200,8 +200,8 @@ class AuthProviderApi extends asyncModules_1.default {
200
200
  * @handleName refresh
201
201
  * @param {string} marker - The text identifier of the authorization provider. Example: "email".
202
202
  * @param {string} token - Refresh token. Example: "abcdef123456".
203
- * @returns {IAuthEntity} Returns an auth entity object with the following values: accessToken, refreshToken, user, and other auth-related data.
204
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
203
+ * @returns {Promise<IAuthEntity | IError>} Returns an auth entity object with the following values: accessToken, refreshToken, user, and other auth-related data.
204
+ * @throws {IError} When isShell=false and an error occurs during the fetch
205
205
  * @description User token refresh.
206
206
  */
207
207
  async refresh(marker, token) {
@@ -219,8 +219,8 @@ class AuthProviderApi extends asyncModules_1.default {
219
219
  * @handleName logout
220
220
  * @param {string} marker - The text identifier of the authorization provider. Example: "email".
221
221
  * @param {string} token - Refresh token. Example: "abcdef123456".
222
- * @returns {boolean} Returns true if the logout was successful, or an error object if there was an issue.
223
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
222
+ * @returns {Promise<boolean | IError>} Returns true if the logout was successful, or an error object if there was an issue.
223
+ * @throws {IError} When isShell=false and an error occurs during the fetch
224
224
  * @description This method requires user authorization.
225
225
  * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
226
226
  */
@@ -242,8 +242,8 @@ class AuthProviderApi extends asyncModules_1.default {
242
242
  * Logout of user account on all devices.
243
243
  * @handleName logoutAll
244
244
  * @param {string} marker - The text identifier of the authorization provider. Example: "email".
245
- * @returns {boolean} Returns true if the logout was successful, or an error object if there was an issue.
246
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
245
+ * @returns {Promise<boolean | IError>} Returns true if the logout was successful, or an error object if there was an issue.
246
+ * @throws {IError} When isShell=false and an error occurs during the fetch
247
247
  * @description This method requires user authorization.
248
248
  * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
249
249
  */
@@ -268,8 +268,8 @@ class AuthProviderApi extends asyncModules_1.default {
268
268
  * @param {string} code - Service code. Example: "123456".
269
269
  * @param {string} newPassword - New password. Example: "newPassword123".
270
270
  * @param {string} [repeatPassword] - Optional variable contains repeat new password for validation. Example: "newPassword123".
271
- * @returns {boolean} Returns true if the password was successfully changed, or an error object if there was an issue.
272
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
271
+ * @returns {Promise<boolean | IError>} Returns true if the password was successfully changed, or an error object if there was an issue.
272
+ * @throws {IError} When isShell=false and an error occurs during the fetch
273
273
  * @description User password change (only for tariffs with account activation and the Activation feature enabled).
274
274
  */
275
275
  async changePassword(marker, userIdentifier, eventIdentifier, type, code, newPassword, repeatPassword) {
@@ -290,8 +290,8 @@ class AuthProviderApi extends asyncModules_1.default {
290
290
  * @param {string} [langCode] - Language code. Default: "en_US".
291
291
  * @param {number} [offset] - Parameter for pagination. Default: 0.
292
292
  * @param {number} [limit] - Parameter for pagination. Default: 30.
293
- * @returns {IAuthProvidersEntity[]} Returns an array of auth provider objects.
294
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
293
+ * @returns {Promise<IAuthProvidersEntity[] | IError>} Returns an array of auth provider objects.
294
+ * @throws {IError} When isShell=false and an error occurs during the fetch
295
295
  * @description Getting all objects of authorization providers.
296
296
  */
297
297
  async getAuthProviders(langCode = this.state.lang, offset = 0, limit = 30) {
@@ -305,8 +305,8 @@ class AuthProviderApi extends asyncModules_1.default {
305
305
  * @handleName getAuthProviderByMarker
306
306
  * @param {string} marker - The text identifier of the authorization provider. Example: "email".
307
307
  * @param {string} [langCode] - Language code. Default: "en_US".
308
- * @returns {IAuthProvidersEntity} Returns an auth provider object.
309
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
308
+ * @returns {Promise<IAuthProvidersEntity | IError>} Returns an auth provider object.
309
+ * @throws {IError} When isShell=false and an error occurs during the fetch
310
310
  * @description Getting a single authorization provider object by marker.
311
311
  */
312
312
  async getAuthProviderByMarker(marker, langCode = this.state.lang) {
@@ -317,8 +317,8 @@ class AuthProviderApi extends asyncModules_1.default {
317
317
  * Getting active user sessions data.
318
318
  * @handleName getActiveSessionsByMarker
319
319
  * @param {string} marker - The text identifier of the authorization provider. Example: "email".
320
- * @returns {IActiveSession[]} Returns an auth provider object.
321
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
320
+ * @returns {Promise<IActiveSession[] | IError>} Returns an auth provider object.
321
+ * @throws {IError} When isShell=false and an error occurs during the fetch
322
322
  * @description Getting a single authorization provider object by marker.
323
323
  */
324
324
  async getActiveSessionsByMarker(marker) {
@@ -339,8 +339,8 @@ class AuthProviderApi extends asyncModules_1.default {
339
339
  "redirect_uri": "http://localhost:3000"
340
340
  }
341
341
  * @param {string} [langCode] - Language code. Default: "en_US".
342
- * @returns {ISignUpEntity} Returns a user object.
343
- * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
342
+ * @returns {Promise<ISignUpEntity | IError>} Returns a user object.
343
+ * @throws {IError} When isShell=false and an error occurs during the fetch
344
344
  * @description User registration (authorization) via OAUTH.
345
345
  */
346
346
  async oauth(marker, body, langCode = this.state.lang) {
@@ -208,62 +208,11 @@ interface IAuthFormData {
208
208
  /**
209
209
  * Interface representing the data required for user registration.
210
210
  * @interface ISignUpData
211
- * @property {string} marker - The text identifier of the authorization provider. Example: "email".
212
- * @property {ISignUpData} body - Request body.
213
- * @example
214
- {
215
- "formIdentifier": "reg",
216
- "authData": [
217
- {
218
- "marker": "login",
219
- "value": "example@oneentry.cloud"
220
- },
221
- {
222
- "marker": "password",
223
- "value": "12345"
224
- }
225
- ],
226
- "formData": [
227
- {
228
- "marker": "last_name",
229
- "type": "string",
230
- "value": "Name"
231
- }
232
- ],
233
- "notificationData": {
234
- "email": "example@oneentry.cloud",
235
- "phonePush": ["+99999999999"],
236
- "phoneSMS": "+99999999999"
237
- }
238
- }
239
- * @property {string} body.formIdentifier - The identifier for the registration form. Example: "reg".
240
- * @property {{ marker: string; value: string }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value.
241
- * @example
242
- [
243
- {
244
- "marker": "login",
245
- "value": "example@oneentry.cloud"
246
- },
247
- {
248
- "marker": "password",
249
- "value": "12345"
250
- }
251
- ]
252
- * @property {IAuthFormData | IAuthFormData[]} body.formData - The form data for the registration, which can be a single object or an array of objects.
253
- * @example
254
- {
255
- "marker": "last_name",
256
- "type": "string",
257
- "value": "Name"
258
- }
259
- * @property {object} body.notificationData - An object containing notification data, including email, phonePush, and phoneSMS.
260
- * @example
261
- {
262
- "email": "example@oneentry.cloud",
263
- "phonePush": ["+99999999999"],
264
- "phoneSMS": "+99999999999"
265
- }
211
+ * @property {string} formIdentifier - The identifier for the registration form. Example: "reg".
266
212
  * @property {string} [langCode] - Language code. Default: "en_US".
213
+ * @property {Array} authData - An array of authentication data objects, each containing a marker and its corresponding value.
214
+ * @property {IAuthFormData | IAuthFormData[]} formData - The form data for the registration.
215
+ * @property {object} notificationData - An object containing notification data, including email, phonePush, and phoneSMS.
267
216
  * @description User registration (❗️For a provider with user activation, the activation code is sent through the corresponding user notification method).
268
217
  */
269
218
  interface ISignUpData {
@@ -305,7 +254,7 @@ interface IOauthData {
305
254
  * @property {number} version - The version number of the sign-up entity. Example: 1.
306
255
  * @property {string} identifier - A unique string that identifies the sign-up entity. Example: "signup_12345".
307
256
  * @property {boolean} isActive - Indicates whether the sign-up entity is active. Example: true.
308
- * @property {{ marker: string; value: string }[]} formData - An array of objects representing the form data, each containing a marker and its corresponding value.
257
+ * @property {Array<object>} formData - An array of objects representing the form data, each containing a marker and its corresponding value.
309
258
  * @example
310
259
  [
311
260
  {
@@ -423,10 +372,14 @@ interface IAuthProvidersEntityConfig {
423
372
  systemCodeTlsSec: string;
424
373
  systemCodeLength: string;
425
374
  }
375
+ interface IAuthData {
376
+ marker: string;
377
+ value: string;
378
+ }
426
379
  /**
427
380
  * Interface representing the body used in authentication requests.
428
381
  * @interface IAuthPostBody
429
- * @property {{ marker: string; value: string | number }[]} authData - An array of authentication data objects, each containing a marker and its corresponding value.
382
+ * @property {IAuthData[]} authData - An array of authentication data objects, each containing a marker and its corresponding value.
430
383
  * @example
431
384
  [
432
385
  {
@@ -437,10 +390,7 @@ interface IAuthProvidersEntityConfig {
437
390
  * @description This interface defines the structure of the body used in authentication requests, containing an array of authentication data.
438
391
  */
439
392
  interface IAuthPostBody {
440
- authData: Array<{
441
- marker: string;
442
- value: string | number;
443
- }>;
393
+ authData: IAuthData[];
444
394
  }
445
395
  /**
446
396
  * Interface representing the active session data.
@@ -464,4 +414,4 @@ interface IActiveSession {
464
414
  location: string;
465
415
  };
466
416
  }
467
- export type { IActiveSession, IAuthEntity, IAuthFormData, IAuthPostBody, IAuthProvider, IAuthProvidersEntity, ICodeEntity, IOauthData, ISignUpData, ISignUpEntity, };
417
+ export type { IActiveSession, IAuthData, IAuthEntity, IAuthFormData, IAuthPostBody, IAuthProvider, IAuthProvidersEntity, ICodeEntity, IOauthData, ISignUpData, ISignUpEntity, };