oneentry 1.0.171 → 1.0.172

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 (72) hide show
  1. package/changelog.md +28 -0
  2. package/dist/admins/adminsApi.d.ts +3 -3
  3. package/dist/admins/adminsApi.js +1 -1
  4. package/dist/admins/adminsInterfaces.d.ts +3 -3
  5. package/dist/base/asyncModules.d.ts +6 -1
  6. package/dist/base/asyncModules.js +9 -1
  7. package/dist/base/utils.d.ts +11 -1
  8. package/dist/blocks/blocksApi.d.ts +1 -1
  9. package/dist/blocks/blocksApi.js +1 -1
  10. package/dist/blocks/blocksInterfaces.d.ts +4 -2
  11. package/dist/discounts/discountsApi.d.ts +3 -3
  12. package/dist/discounts/discountsApi.js +1 -1
  13. package/dist/discounts/discountsInterfaces.d.ts +3 -3
  14. package/dist/events/eventsApi.d.ts +1 -1
  15. package/dist/events/eventsApi.js +1 -2
  16. package/dist/file-uploading/fileUploadingApi.d.ts +1 -1
  17. package/dist/file-uploading/fileUploadingApi.js +4 -3
  18. package/dist/file-uploading/fileUploadingInterfaces.d.ts +1 -1
  19. package/dist/forms-data/formsDataApi.d.ts +4 -4
  20. package/dist/forms-data/formsDataApi.js +24 -17
  21. package/dist/forms-data/formsDataInterfaces.d.ts +3 -3
  22. package/dist/general-types/generalTypesSchemas.d.ts +0 -2
  23. package/dist/general-types/generalTypesSchemas.js +0 -1
  24. package/dist/orders/ordersApi.d.ts +16 -3
  25. package/dist/orders/ordersApi.js +25 -15
  26. package/dist/orders/ordersInterfaces.d.ts +3 -3
  27. package/dist/pages/pagesApi.d.ts +4 -4
  28. package/dist/pages/pagesApi.js +9 -13
  29. package/dist/pages/pagesInterfaces.d.ts +3 -3
  30. package/dist/products/productsApi.d.ts +7 -6
  31. package/dist/products/productsApi.js +6 -3
  32. package/dist/products/productsInterfaces.d.ts +14 -9
  33. package/dist/user-activity/userActivityApi.js +4 -7
  34. package/dist/users/usersApi.d.ts +3 -3
  35. package/dist/users/usersApi.js +1 -1
  36. package/dist/users/usersInterfaces.d.ts +3 -3
  37. package/esm/admins/adminsApi.d.ts +3 -3
  38. package/esm/admins/adminsApi.js +1 -1
  39. package/esm/admins/adminsInterfaces.d.ts +3 -3
  40. package/esm/base/asyncModules.d.ts +6 -1
  41. package/esm/base/asyncModules.js +9 -1
  42. package/esm/base/utils.d.ts +11 -1
  43. package/esm/blocks/blocksApi.d.ts +1 -1
  44. package/esm/blocks/blocksApi.js +1 -1
  45. package/esm/blocks/blocksInterfaces.d.ts +4 -2
  46. package/esm/discounts/discountsApi.d.ts +3 -3
  47. package/esm/discounts/discountsApi.js +1 -1
  48. package/esm/discounts/discountsInterfaces.d.ts +3 -3
  49. package/esm/events/eventsApi.d.ts +1 -1
  50. package/esm/events/eventsApi.js +1 -2
  51. package/esm/file-uploading/fileUploadingApi.d.ts +1 -1
  52. package/esm/file-uploading/fileUploadingApi.js +4 -3
  53. package/esm/file-uploading/fileUploadingInterfaces.d.ts +1 -1
  54. package/esm/forms-data/formsDataApi.d.ts +4 -4
  55. package/esm/forms-data/formsDataApi.js +24 -17
  56. package/esm/forms-data/formsDataInterfaces.d.ts +3 -3
  57. package/esm/general-types/generalTypesSchemas.d.ts +0 -2
  58. package/esm/general-types/generalTypesSchemas.js +0 -1
  59. package/esm/orders/ordersApi.d.ts +16 -3
  60. package/esm/orders/ordersApi.js +25 -15
  61. package/esm/orders/ordersInterfaces.d.ts +3 -3
  62. package/esm/pages/pagesApi.d.ts +4 -4
  63. package/esm/pages/pagesApi.js +9 -13
  64. package/esm/pages/pagesInterfaces.d.ts +3 -3
  65. package/esm/products/productsApi.d.ts +7 -6
  66. package/esm/products/productsApi.js +6 -3
  67. package/esm/products/productsInterfaces.d.ts +14 -9
  68. package/esm/user-activity/userActivityApi.js +4 -7
  69. package/esm/users/usersApi.d.ts +3 -3
  70. package/esm/users/usersApi.js +1 -1
  71. package/esm/users/usersInterfaces.d.ts +3 -3
  72. package/package.json +2 -2
@@ -1,6 +1,6 @@
1
1
  import AsyncModules from '../base/asyncModules.js';
2
2
  import type StateModule from '../base/stateModule.js';
3
- import type { IError } from '../base/utils.js';
3
+ import type { IError, IVectorSearchResponse } from '../base/utils.js';
4
4
  import type { ICartAddItem, ICartResponse, ICartSet, IUserBody, IUserEntity, IUsersApi, IUsersResponse, IUsersVectorSearch, IWishlistAddItem, IWishlistResponse, IWishlistSet } from './usersInterfaces.js';
5
5
  /**
6
6
  * Controllers for working with users
@@ -239,11 +239,11 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
239
239
  * @param {string} [langCode] - Language code. Default: "en_US".
240
240
  * @param {number} [offset] - Parameter for pagination. Default: 0.
241
241
  * @param {number} [limit] - Parameter for pagination. Default: 30.
242
- * @returns {Promise<IUsersResponse | IError>} Returns an object with an array of found users and total count.
242
+ * @returns {Promise<IVectorSearchResponse<IUsersResponse> | IError>} Returns an object with an array of found users and total count.
243
243
  * @throws {IError} When isShell=false and an error occurs during the fetch
244
244
  * @description This method performs a semantic (vector) search for users. It requires user authorization.
245
245
  * @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}.
246
246
  * @see {@link https://js-sdk.oneentry.cloud/docs/users/getUsersByVectorSearch getUsersByVectorSearch} documentation.
247
247
  */
248
- getUsersByVectorSearch(body: IUsersVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IUsersResponse | IError>;
248
+ getUsersByVectorSearch(body: IUsersVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IVectorSearchResponse<IUsersResponse> | IError>;
249
249
  }
@@ -294,7 +294,7 @@ export default class UsersApi extends AsyncModules {
294
294
  * @param {string} [langCode] - Language code. Default: "en_US".
295
295
  * @param {number} [offset] - Parameter for pagination. Default: 0.
296
296
  * @param {number} [limit] - Parameter for pagination. Default: 30.
297
- * @returns {Promise<IUsersResponse | IError>} Returns an object with an array of found users and total count.
297
+ * @returns {Promise<IVectorSearchResponse<IUsersResponse> | IError>} Returns an object with an array of found users and total count.
298
298
  * @throws {IError} When isShell=false and an error occurs during the fetch
299
299
  * @description This method performs a semantic (vector) search for users. It requires user authorization.
300
300
  * @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}.
@@ -1,5 +1,5 @@
1
1
  import type { IAuthData, IAuthFormData, INotificationData } from '../auth-provider/authProvidersInterfaces.js';
2
- import type { IError, IRating } from '../base/utils.js';
2
+ import type { IError, IRating, IVectorSearchResponse } from '../base/utils.js';
3
3
  import type { IFormConfig } from '../forms/formsInterfaces.js';
4
4
  import type { FormDataType } from '../forms-data/formsDataInterfaces.js';
5
5
  /**
@@ -217,12 +217,12 @@ interface IUsersApi {
217
217
  * @param {string} [langCode] - Language code. Default: "en_US".
218
218
  * @param {number} [offset] - Parameter for pagination. Default: 0.
219
219
  * @param {number} [limit] - Parameter for pagination. Default: 30.
220
- * @returns {Promise<IUsersResponse | IError>} A promise resolving to a users response (items + total), or an error.
220
+ * @returns {Promise<IVectorSearchResponse<IUsersResponse> | IError>} A promise resolving to a users response (items + total), or an error.
221
221
  * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
222
222
  * @description This method performs a semantic (vector) search for users. It requires user authorization.
223
223
  * @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}.
224
224
  */
225
- getUsersByVectorSearch(body: IUsersVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IUsersResponse | IError>;
225
+ getUsersByVectorSearch(body: IUsersVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IVectorSearchResponse<IUsersResponse> | IError>;
226
226
  }
227
227
  /**
228
228
  * Body for semantic (vector) user search.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "oneentry",
3
- "version": "1.0.171",
3
+ "version": "1.0.172",
4
4
  "description": "OneEntry NPM package",
5
5
  "main": "dist/index.js",
6
6
  "module": "esm/index.js",
@@ -48,7 +48,7 @@
48
48
  },
49
49
  "scripts": {
50
50
  "prepublishOnly": "node ../scripts/smoke-pack.js --files-only",
51
- "postpublish": "node ../scripts/verify-published.js --named defineOneEntry --expect 1.0.171"
51
+ "postpublish": "node ../scripts/verify-published.js --named defineOneEntry --expect 1.0.172"
52
52
  },
53
53
  "sideEffects": false,
54
54
  "files": [