oneentry 1.0.175 → 1.0.177

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 (197) hide show
  1. package/README.md +12 -5
  2. package/changelog.md +140 -0
  3. package/dist/admins/adminsApi.js +2 -9
  4. package/dist/admins/adminsInterfaces.d.ts +5 -5
  5. package/dist/admins/adminsSchemas.d.ts +4 -4
  6. package/dist/admins/adminsSchemas.js +2 -2
  7. package/dist/attribute-sets/attributeSetsApi.d.ts +1 -1
  8. package/dist/attribute-sets/attributeSetsApi.js +4 -4
  9. package/dist/attribute-sets/attributeSetsInterfaces.d.ts +65 -14
  10. package/dist/attribute-sets/attributeSetsSchemas.d.ts +8 -6
  11. package/dist/attribute-sets/attributeSetsSchemas.js +6 -9
  12. package/dist/auth-provider/authProviderApi.d.ts +4 -4
  13. package/dist/auth-provider/authProviderApi.js +96 -29
  14. package/dist/auth-provider/authProviderSchemas.d.ts +1 -0
  15. package/dist/auth-provider/authProviderSchemas.js +1 -0
  16. package/dist/auth-provider/authProvidersInterfaces.d.ts +8 -6
  17. package/dist/base/asyncModules.d.ts +73 -1
  18. package/dist/base/asyncModules.js +233 -37
  19. package/dist/base/stateModule.d.ts +2 -0
  20. package/dist/base/stateModule.js +22 -12
  21. package/dist/base/syncModules.d.ts +18 -10
  22. package/dist/base/syncModules.js +100 -29
  23. package/dist/base/utils.d.ts +26 -21
  24. package/dist/base/validation.d.ts +3 -3
  25. package/dist/base/validation.js +6 -7
  26. package/dist/blocks/blocksApi.d.ts +20 -17
  27. package/dist/blocks/blocksApi.js +101 -74
  28. package/dist/blocks/blocksInterfaces.d.ts +8 -8
  29. package/dist/discounts/discountsApi.d.ts +9 -7
  30. package/dist/discounts/discountsApi.js +18 -14
  31. package/dist/discounts/discountsInterfaces.d.ts +14 -10
  32. package/dist/events/eventsApi.d.ts +3 -3
  33. package/dist/events/eventsApi.js +7 -7
  34. package/dist/events/eventsInterfaces.d.ts +10 -14
  35. package/dist/file-uploading/fileUploadingApi.d.ts +4 -4
  36. package/dist/file-uploading/fileUploadingApi.js +13 -5
  37. package/dist/file-uploading/fileUploadingInterfaces.d.ts +5 -6
  38. package/dist/filters/filtersApi.js +2 -2
  39. package/dist/forms/formsApi.js +2 -2
  40. package/dist/forms/formsInterfaces.d.ts +1 -3
  41. package/dist/forms/formsSchemas.d.ts +3 -6
  42. package/dist/forms/formsSchemas.js +2 -4
  43. package/dist/forms-data/formsDataApi.d.ts +26 -8
  44. package/dist/forms-data/formsDataApi.js +45 -14
  45. package/dist/forms-data/formsDataInterfaces.d.ts +91 -66
  46. package/dist/general-types/generalTypesInterfaces.d.ts +1 -1
  47. package/dist/index.d.ts +7 -6
  48. package/dist/index.js +50 -7
  49. package/dist/integration-collections/integrationCollectionsApi.d.ts +15 -4
  50. package/dist/integration-collections/integrationCollectionsApi.js +42 -14
  51. package/dist/integration-collections/integrationCollectionsInterfaces.d.ts +8 -9
  52. package/dist/integration-collections/integrationCollectionsSchemas.d.ts +0 -2
  53. package/dist/integration-collections/integrationCollectionsSchemas.js +0 -1
  54. package/dist/menus/menusApi.js +1 -1
  55. package/dist/orders/ordersApi.d.ts +1 -13
  56. package/dist/orders/ordersApi.js +24 -44
  57. package/dist/orders/ordersInterfaces.d.ts +21 -14
  58. package/dist/pages/pagesApi.d.ts +6 -5
  59. package/dist/pages/pagesApi.js +44 -31
  60. package/dist/pages/pagesInterfaces.d.ts +18 -15
  61. package/dist/pages/pagesSchemas.d.ts +0 -3
  62. package/dist/pages/pagesSchemas.js +0 -1
  63. package/dist/payments/paymentsApi.d.ts +10 -11
  64. package/dist/payments/paymentsApi.js +22 -18
  65. package/dist/payments/paymentsInterfaces.d.ts +12 -14
  66. package/dist/payments/paymentsSchemas.d.ts +21 -20
  67. package/dist/payments/paymentsSchemas.js +5 -8
  68. package/dist/product-statuses/productStatusesApi.d.ts +1 -1
  69. package/dist/product-statuses/productStatusesApi.js +4 -4
  70. package/dist/product-statuses/productStatusesInterfaces.d.ts +1 -4
  71. package/dist/products/productsApi.d.ts +38 -58
  72. package/dist/products/productsApi.js +59 -72
  73. package/dist/products/productsInterfaces.d.ts +48 -85
  74. package/dist/search/searchApi.d.ts +1 -1
  75. package/dist/search/searchApi.js +4 -3
  76. package/dist/sitemap/sitemapInterfaces.d.ts +10 -6
  77. package/dist/subscriptions/subscriptionsApi.d.ts +1 -1
  78. package/dist/subscriptions/subscriptionsApi.js +1 -1
  79. package/dist/subscriptions/subscriptionsInterfaces.d.ts +1 -1
  80. package/dist/system/systemApi.d.ts +2 -0
  81. package/dist/system/systemApi.js +2 -0
  82. package/dist/system/systemInterfaces.d.ts +2 -0
  83. package/dist/templates/templatesApi.d.ts +2 -2
  84. package/dist/templates/templatesApi.js +12 -11
  85. package/dist/templates/templatesInterfaces.d.ts +2 -2
  86. package/dist/templates-preview/templatesPreviewApi.js +2 -2
  87. package/dist/templates-preview/templatesPreviewInterfaces.d.ts +23 -13
  88. package/dist/templates-preview/templatesPreviewSchemas.d.ts +7 -0
  89. package/dist/templates-preview/templatesPreviewSchemas.js +2 -0
  90. package/dist/user-groups/userGroupsApi.js +5 -5
  91. package/dist/user-groups/userGroupsSchemas.d.ts +4 -4
  92. package/dist/users/usersApi.d.ts +1 -1
  93. package/dist/users/usersApi.js +28 -15
  94. package/dist/users/usersInterfaces.d.ts +2 -9
  95. package/dist/web-socket/lazySocket.d.ts +6 -5
  96. package/dist/web-socket/lazySocket.js +212 -15
  97. package/dist/web-socket/wsApi.d.ts +7 -4
  98. package/dist/web-socket/wsApi.js +49 -12
  99. package/dist/web-socket/wsInterfaces.d.ts +41 -4
  100. package/esm/admins/adminsApi.js +2 -9
  101. package/esm/admins/adminsInterfaces.d.ts +5 -5
  102. package/esm/admins/adminsSchemas.d.ts +4 -4
  103. package/esm/admins/adminsSchemas.js +2 -2
  104. package/esm/attribute-sets/attributeSetsApi.d.ts +1 -1
  105. package/esm/attribute-sets/attributeSetsApi.js +4 -4
  106. package/esm/attribute-sets/attributeSetsInterfaces.d.ts +65 -14
  107. package/esm/attribute-sets/attributeSetsSchemas.d.ts +8 -6
  108. package/esm/attribute-sets/attributeSetsSchemas.js +6 -9
  109. package/esm/auth-provider/authProviderApi.d.ts +4 -4
  110. package/esm/auth-provider/authProviderApi.js +96 -29
  111. package/esm/auth-provider/authProviderSchemas.d.ts +1 -0
  112. package/esm/auth-provider/authProviderSchemas.js +1 -0
  113. package/esm/auth-provider/authProvidersInterfaces.d.ts +8 -6
  114. package/esm/base/asyncModules.d.ts +73 -1
  115. package/esm/base/asyncModules.js +233 -37
  116. package/esm/base/stateModule.d.ts +2 -0
  117. package/esm/base/stateModule.js +22 -12
  118. package/esm/base/syncModules.d.ts +18 -10
  119. package/esm/base/syncModules.js +99 -29
  120. package/esm/base/utils.d.ts +26 -21
  121. package/esm/base/validation.d.ts +3 -3
  122. package/esm/base/validation.js +6 -7
  123. package/esm/blocks/blocksApi.d.ts +20 -17
  124. package/esm/blocks/blocksApi.js +101 -74
  125. package/esm/blocks/blocksInterfaces.d.ts +8 -8
  126. package/esm/discounts/discountsApi.d.ts +9 -7
  127. package/esm/discounts/discountsApi.js +18 -14
  128. package/esm/discounts/discountsInterfaces.d.ts +14 -10
  129. package/esm/events/eventsApi.d.ts +3 -3
  130. package/esm/events/eventsApi.js +7 -7
  131. package/esm/events/eventsInterfaces.d.ts +10 -14
  132. package/esm/file-uploading/fileUploadingApi.d.ts +4 -4
  133. package/esm/file-uploading/fileUploadingApi.js +13 -5
  134. package/esm/file-uploading/fileUploadingInterfaces.d.ts +5 -6
  135. package/esm/filters/filtersApi.js +2 -2
  136. package/esm/forms/formsApi.js +2 -2
  137. package/esm/forms/formsInterfaces.d.ts +1 -3
  138. package/esm/forms/formsSchemas.d.ts +3 -6
  139. package/esm/forms/formsSchemas.js +2 -4
  140. package/esm/forms-data/formsDataApi.d.ts +26 -8
  141. package/esm/forms-data/formsDataApi.js +45 -14
  142. package/esm/forms-data/formsDataInterfaces.d.ts +91 -66
  143. package/esm/general-types/generalTypesInterfaces.d.ts +1 -1
  144. package/esm/index.d.ts +7 -6
  145. package/esm/index.js +50 -7
  146. package/esm/integration-collections/integrationCollectionsApi.d.ts +15 -4
  147. package/esm/integration-collections/integrationCollectionsApi.js +42 -14
  148. package/esm/integration-collections/integrationCollectionsInterfaces.d.ts +8 -9
  149. package/esm/integration-collections/integrationCollectionsSchemas.d.ts +0 -2
  150. package/esm/integration-collections/integrationCollectionsSchemas.js +0 -1
  151. package/esm/menus/menusApi.js +1 -1
  152. package/esm/orders/ordersApi.d.ts +1 -13
  153. package/esm/orders/ordersApi.js +24 -44
  154. package/esm/orders/ordersInterfaces.d.ts +21 -14
  155. package/esm/pages/pagesApi.d.ts +6 -5
  156. package/esm/pages/pagesApi.js +44 -31
  157. package/esm/pages/pagesInterfaces.d.ts +18 -15
  158. package/esm/pages/pagesSchemas.d.ts +0 -3
  159. package/esm/pages/pagesSchemas.js +0 -1
  160. package/esm/payments/paymentsApi.d.ts +10 -11
  161. package/esm/payments/paymentsApi.js +22 -18
  162. package/esm/payments/paymentsInterfaces.d.ts +12 -14
  163. package/esm/payments/paymentsSchemas.d.ts +21 -20
  164. package/esm/payments/paymentsSchemas.js +5 -8
  165. package/esm/product-statuses/productStatusesApi.d.ts +1 -1
  166. package/esm/product-statuses/productStatusesApi.js +4 -4
  167. package/esm/product-statuses/productStatusesInterfaces.d.ts +1 -4
  168. package/esm/products/productsApi.d.ts +38 -58
  169. package/esm/products/productsApi.js +59 -72
  170. package/esm/products/productsInterfaces.d.ts +48 -85
  171. package/esm/search/searchApi.d.ts +1 -1
  172. package/esm/search/searchApi.js +4 -3
  173. package/esm/sitemap/sitemapInterfaces.d.ts +10 -6
  174. package/esm/subscriptions/subscriptionsApi.d.ts +1 -1
  175. package/esm/subscriptions/subscriptionsApi.js +1 -1
  176. package/esm/subscriptions/subscriptionsInterfaces.d.ts +1 -1
  177. package/esm/system/systemApi.d.ts +2 -0
  178. package/esm/system/systemApi.js +2 -0
  179. package/esm/system/systemInterfaces.d.ts +2 -0
  180. package/esm/templates/templatesApi.d.ts +2 -2
  181. package/esm/templates/templatesApi.js +11 -10
  182. package/esm/templates/templatesInterfaces.d.ts +2 -2
  183. package/esm/templates-preview/templatesPreviewApi.js +2 -2
  184. package/esm/templates-preview/templatesPreviewInterfaces.d.ts +23 -13
  185. package/esm/templates-preview/templatesPreviewSchemas.d.ts +7 -0
  186. package/esm/templates-preview/templatesPreviewSchemas.js +2 -0
  187. package/esm/user-groups/userGroupsApi.js +5 -5
  188. package/esm/user-groups/userGroupsSchemas.d.ts +4 -4
  189. package/esm/users/usersApi.d.ts +1 -1
  190. package/esm/users/usersApi.js +28 -15
  191. package/esm/users/usersInterfaces.d.ts +2 -9
  192. package/esm/web-socket/lazySocket.d.ts +6 -5
  193. package/esm/web-socket/lazySocket.js +212 -15
  194. package/esm/web-socket/wsApi.d.ts +7 -4
  195. package/esm/web-socket/wsApi.js +49 -12
  196. package/esm/web-socket/wsInterfaces.d.ts +41 -4
  197. package/package.json +2 -2
@@ -85,9 +85,9 @@ interface IFormsData {
85
85
  /**
86
86
  * Body for semantic (vector) form data search.
87
87
  * @interface IFormsDataVectorSearch
88
- * @property {string} queryText - Natural-language search query. Example: "order confirmation".
89
- * @property {number} [vectorDistanceThreshold] - Override of the cosine distance threshold (0..2). Example: 0.3.
90
- * @property {number} [maxHits] - Number of top candidates fetched before pagination. Default: 100. Maximum: 500. Example: 10.
88
+ * @property {string} queryText - Natural-language search query, 1 to 512 characters: an empty one answers `400 queryText should not be empty`, a longer one `400 queryText must be shorter than or equal to 512 characters`. Example: "order confirmation".
89
+ * @property {number} [vectorDistanceThreshold] - Override of the cosine distance threshold (0..2); a negative value answers `400`. Example: 0.3.
90
+ * @property {number} [maxHits] - Number of top candidates fetched before pagination, from 1. Default: 100. Maximum: 500. Example: 10.
91
91
  * @property {boolean} [debug] - When `true`, each returned item gets a `distance` field. Example: false.
92
92
  * @description Body for the form-data vector/search endpoint.
93
93
  */
@@ -113,14 +113,14 @@ type FormDataStatus = 'sent' | 'moderation' | 'approved' | 'banned' | 'deleted';
113
113
  * @property {number} [parentId] - Identifier of the parent record — the way to fetch replies to one comment. Example: 10.
114
114
  * @property {string} [userIdentifier] - Text identifier of the sender; an empty string means "no filter". Example: "admin".
115
115
  * @property {FormDataStatus[]} [status] - Moderation statuses to keep. Must be an array — a bare string is rejected with `400`. An empty array means "no filter". Example: ["approved"].
116
- * @property {string} [dateFrom] - Lower bound of the submission date, `YYYY-MM-DD`; an empty string means "no bound" — `getFormsDataByMarker` strips it from the body, since the endpoint rejects an empty date with a `400`. A non-empty value the API cannot parse still fails the request. Example: "2025-01-01".
117
- * @property {string} [dateTo] - Upper bound of the submission date, `YYYY-MM-DD`; an empty string means "no bound", handled like `dateFrom`. Example: "2025-12-31".
116
+ * @property {string} [dateFrom] - Lower bound of the submission date, `YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`; an empty string means "no bound" — `getFormsDataByMarker` strips it from the body, since the endpoint rejects an empty date with a `400`. A non-empty value the API cannot parse still fails the request. Example: "2025-01-01".
117
+ * @property {string} [dateTo] - Upper bound of the submission date, `YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`; an empty string means "no bound", handled like `dateFrom`. Example: "2025-12-31".
118
118
  * @description Filter for reading form submissions. Every field is optional and an omitted one is simply not applied.
119
119
  *
120
- * Typed rather than left as `object` on purpose: the API **ignores** a field it
121
- * does not know, so `statuses: ['approved']` (note the "s") is not an error —
122
- * it returns every record, unmoderated ones included. That is premoderation
123
- * leaking onto a public page, from one typo the compiler used to accept.
120
+ * Typed rather than left as `object` on purpose: the API **refuses** a field it
121
+ * does not know, so `statuses: ['approved']` (note the "s") answers
122
+ * `400 property statuses should not exist` — the compiler catches the typo
123
+ * before the request does.
124
124
  */
125
125
  interface IFormsDataFilter {
126
126
  /**
@@ -225,9 +225,14 @@ interface IFormDataEntity {
225
225
  "id": 1,
226
226
  "formIdentifier": "form",
227
227
  "time": "2025-06-06T19:07:45.993Z",
228
- "formData": {},
229
- "attributeSetIdentifier": "form",
230
- "actionMessage": "Action message string"
228
+ "formData": [
229
+ {
230
+ "marker": "name",
231
+ "type": "string",
232
+ "value": "Test"
233
+ }
234
+ ],
235
+ "attributeSetIdentifier": "form"
231
236
  }
232
237
  ]
233
238
  * @property {number} total - Total number of found records. Example: 100.
@@ -241,13 +246,13 @@ interface IFormsDataEntity {
241
246
  * Represents the structure of a form data entity.
242
247
  * @interface IFormByMarkerDataEntity
243
248
  * @property {number} id - ID of the form data record. Example: 12345.
244
- * @property {null | number} parentId - ID of the parent form data record; `null` for a top-level record. Example: 123.
249
+ * @property {null | number} [parentId] - ID of the parent form data record; `null` for a top-level record. Returned only with `isExtended` = 1. Example: 123.
245
250
  * @property {string} formIdentifier - Marker of the form. Example: "contact_form".
246
- * @property {number} depth - Example: 1.
247
- * @property {string | null} ip - IP address the form was submitted from. Example: '127.0.0.1'.
248
- * @property {string | null} fingerprint - Device fingerprint of the sender. Example: 'fingerprint'.
249
- * @property {string | null} status - Moderation status of the record: "sent", "moderation", "approved", "banned" or "deleted"; `null` when the form does not moderate. Example: 'approved'.
250
- * @property {string | null} userIdentifier - Text identifier (marker) of the user. Example: "admin".
251
+ * @property {number} [depth] - Nesting depth of the record. Returned only with `isExtended` = 1. Example: 1.
252
+ * @property {string | null} [ip] - IP address the form was submitted from. Not returned by the by-marker list. Example: '127.0.0.1'.
253
+ * @property {string | null} [fingerprint] - Device fingerprint of the sender. Not returned by the by-marker list. Example: 'fingerprint'.
254
+ * @property {string | null} [status] - Moderation status of the record: "sent", "moderation", "approved", "banned" or "deleted"; `null` when the form does not moderate. Returned only with `isExtended` = 1. Example: 'approved'.
255
+ * @property {string | null} [userIdentifier] - Text identifier (marker) of the user. Returned only with `isExtended` = 1. Example: "admin".
251
256
  * @property {FormDataType[]} formData - Submitted fields, **already unwrapped from the locale**: the API returns `{ "en_US": [ … ] }` and the SDK hands over the array for the requested `langCode`. Read `formData` directly — `formData[langCode]` is `undefined`.
252
257
  * @example
253
258
  [
@@ -260,7 +265,7 @@ interface IFormsDataEntity {
260
265
  * @property {string | null} attributeSetIdentifier - Marker of the attribute set used by the form. Example: "product_attributes".
261
266
  * @property {Date | string} time - Date and time the form data was last changed. Example: "2023-10-01T12:00:00Z".
262
267
  * @property {string} entityIdentifier - Marker of the entity the record belongs to. Example: "test".
263
- * @property {boolean} isUserAdmin - Whether the record was submitted by an admin. Example: true.
268
+ * @property {boolean} [isUserAdmin] - Whether the record was submitted by an admin. Returned only with `isExtended` = 1. Example: true.
264
269
  * @property {number} formModuleConfigId - ID of the form module configuration. Example: 2.
265
270
  * @property {string} [moduleIdentifier] - Marker of the module. Example: "blog".
266
271
  * @property {number} entityId - ID of the entity the record belongs to. Example: 2.
@@ -287,7 +292,7 @@ interface IFormByMarkerDataEntity {
287
292
  /**
288
293
  * Represents a collection of form data entities.
289
294
  * @interface IFormsByMarkerDataEntity
290
- * @property {IFormByMarkerDataEntity[]} items - Form data records.
295
+ * @property {IFormByMarkerDataEntity[]} items - Form data records. The example shows a record with `isExtended` = 1; without it `parentId`, `depth`, `status`, `userIdentifier` and `isUserAdmin` are not returned.
291
296
  * @example
292
297
  [
293
298
  {
@@ -295,7 +300,6 @@ interface IFormByMarkerDataEntity {
295
300
  "parentId": null,
296
301
  "formIdentifier": "test-form",
297
302
  "depth": 0,
298
- "ip": null,
299
303
  "status": null,
300
304
  "userIdentifier": null,
301
305
  "formData": [
@@ -419,7 +423,7 @@ interface IUpdateFormsData {
419
423
  /**
420
424
  * Contains an array of data form objects with the following values
421
425
  */
422
- type FormDataType = IBodyTypeStringNumberFloat | IBodyTypeTimeDate | IBodyTypeText | IBodyTypeTextWithHeader | IBodyTypeImageGroupOfImages | IBodyTypeFile | IBodyTypeRadioButtonList | Record<string, unknown>;
426
+ type FormDataType = IBodyTypeStringNumberFloat | IBodyTypeTimeDate | IBodyTypeText | IBodyTypeTextWithHeader | IBodyTypeImageGroupOfImages | IBodyTypeFile | IBodyTypeRadioButtonList | IBodyTypeEntity | IBodyTypeTimeInterval | Record<string, unknown>;
423
427
  /**
424
428
  * Value shapes accepted by a SUBMISSION (`POST /form-data`).
425
429
  *
@@ -588,13 +592,13 @@ interface IBodyPostFormData {
588
592
  * Represents a form data entity with a simple value.
589
593
  * @interface IBodyTypeStringNumberFloat
590
594
  * @property {string} marker - marker name. Example: "some_marker".
591
- * @property {string} type - Type value. "string" | "number" | "float". Example: "string".
592
- * @property {string | number | null} value - Value of the form data entity. Send it as a string; in responses numeric fields come back normalized to `number`, or `null` when the field is empty. Example: "string".
595
+ * @property {string} type - Type value. "string" | "integer" | "number" | "float". Example: "string".
596
+ * @property {string | number | null} value - Value of the form data entity. A submission may send a number or a string; responses return numeric fields **as strings** — `3` comes back as `"3"`, `2.565` as `"2.565"` — or `null` when the field is empty. Convert with `Number(value)` before arithmetic. Example: "string".
593
597
  * @description Represents a form data entity with a marker, type, and value.
594
598
  */
595
599
  interface IBodyTypeStringNumberFloat {
596
600
  marker: string;
597
- type: 'string' | 'number' | 'float';
601
+ type: 'string' | 'integer' | 'number' | 'float';
598
602
  value: string | number | null;
599
603
  }
600
604
  /**
@@ -633,43 +637,46 @@ interface ITimeDateValue {
633
637
  * @interface IBodyTypeText
634
638
  * @property {string} marker - marker name. Example: "some_marker".
635
639
  * @property {string} type - Type value. Example: "text".
636
- * @property {object} value - Text Object. Contains html as string, plain text and params.
640
+ * @property {ITextValue | ITextValue[]} value - Text value. A read returns a one-element **array**, without `plainValue` and with `params.editorMode`; older records may hold a single object.
637
641
  * @example
638
- {
639
- "htmlValue": "<p>Hello world</p>",
640
- "plainValue": "",
641
- "params": {
642
- "isEditorDisabled": false,
643
- "isImageCompressed": true
642
+ [
643
+ {
644
+ "htmlValue": "<p>Hello world</p>",
645
+ "params": {
646
+ "isImageCompressed": true,
647
+ "editorMode": "html"
648
+ }
644
649
  }
645
- }
646
- * @description Represents a text value with HTML and plain text representations, along with parameters for editor and image compression settings.
650
+ ]
651
+ * @description Represents a text value with HTML and plain text representations, along with parameters for editor and image compression settings. To submit a text field use {@link IBodyPostTypeText}.
647
652
  */
648
653
  interface IBodyTypeText {
649
654
  marker: string;
650
655
  type: 'text';
651
- value: ITextValue;
656
+ value: ITextValue | ITextValue[];
652
657
  }
653
658
  /**
654
659
  * @interface ITextEditorParams
655
- * @property {boolean} isEditorDisabled - Whether the rich-text editor is disabled. Example: false.
660
+ * @property {boolean} [isEditorDisabled] - Whether the rich-text editor is disabled. Older records only; current reads carry `editorMode` instead. Example: false.
656
661
  * @property {boolean} isImageCompressed - Whether embedded images are compressed. Example: true.
662
+ * @property {string} [editorMode] - Editor the value was written in. Example: "html".
657
663
  * @description Editor parameters attached to text-type form values.
658
664
  */
659
665
  interface ITextEditorParams {
660
- isEditorDisabled: boolean;
666
+ isEditorDisabled?: boolean;
661
667
  isImageCompressed: boolean;
668
+ editorMode?: string;
662
669
  }
663
670
  /**
664
671
  * @interface ITextValue
665
672
  * @property {string} htmlValue - HTML representation of the text. Example: "<p>Hello world</p>".
666
- * @property {string} plainValue - Plain-text representation.
673
+ * @property {string} [plainValue] - Plain-text representation. Absent from current reads. Example: "Hello world".
667
674
  * @property {ITextEditorParams} params - Editor configuration applied to this value.
668
675
  * @description Value payload for `text` form fields.
669
676
  */
670
677
  interface ITextValue {
671
678
  htmlValue: string;
672
- plainValue: string;
679
+ plainValue?: string;
673
680
  params: ITextEditorParams;
674
681
  }
675
682
  /**
@@ -677,36 +684,37 @@ interface ITextValue {
677
684
  * @interface IBodyTypeTextWithHeader
678
685
  * @property {string} marker - marker name. Example: "about".
679
686
  * @property {string} type - Type value. Example: "textWithHeader".
680
- * @property {object} value - Text Object. Contains html as string, header and params.
687
+ * @property {ITextWithHeaderValue | ITextWithHeaderValue[]} value - Text with a header. A read returns a one-element **array**, without `plainValue` and with `params.editorMode`; older records may hold a single object.
681
688
  * @example
682
- {
683
- "header": "Headline",
684
- "htmlValue": "<p>Hello World</p>",
685
- "plainValue": "",
686
- "params": {
687
- "isEditorDisabled": false,
688
- "isImageCompressed": true
689
+ [
690
+ {
691
+ "header": "Headline",
692
+ "htmlValue": "<p>Hello World</p>",
693
+ "params": {
694
+ "isImageCompressed": true,
695
+ "editorMode": "html"
696
+ }
689
697
  }
690
- }
698
+ ]
691
699
  * @description Represents a text value with a header, HTML and plain text representations, along with parameters for editor and image compression settings.
692
700
  */
693
701
  interface IBodyTypeTextWithHeader {
694
702
  marker: string;
695
703
  type: 'textWithHeader';
696
- value: ITextWithHeaderValue;
704
+ value: ITextWithHeaderValue | ITextWithHeaderValue[];
697
705
  }
698
706
  /**
699
707
  * @interface ITextWithHeaderValue
700
708
  * @property {string} header - Headline text. Example: "Headline".
701
709
  * @property {string} htmlValue - HTML body. Example: "<p>Hello world</p>".
702
- * @property {string} plainValue - Plain-text body.
710
+ * @property {string} [plainValue] - Plain-text body. Absent from current reads. Example: "Hello world".
703
711
  * @property {ITextEditorParams} params - Editor configuration applied to this value.
704
712
  * @description Value payload for `textWithHeader` form fields.
705
713
  */
706
714
  interface ITextWithHeaderValue {
707
715
  header: string;
708
716
  htmlValue: string;
709
- plainValue: string;
717
+ plainValue?: string;
710
718
  params: ITextEditorParams;
711
719
  }
712
720
  /**
@@ -765,7 +773,7 @@ interface IImageValue {
765
773
  * @interface IBodyTypeFile
766
774
  * @property {string} marker - marker name. Example: "picture".
767
775
  * @property {'file'} type - Type value. Example: "file".
768
- * @property {object} value - The attached file. Three shapes are accepted and may be mixed in one array: a `File`/`Blob` (also a `FileList`), which the SDK uploads first; the descriptor `FileUploading.upload` returns for a file **already in storage**, which is passed through as it is; or a hand-built {@link IFileValue}. In a SUBMISSION the value must be an **array** — a lone descriptor or {@link IFileValue} answers `400 formData's marker '<marker>' value must be an array`, while a lone `File`/`Blob` is fine because the SDK wraps the upload result. A READ returns a single attached file as the object itself.
776
+ * @property {object} value - The attached file. Three shapes are accepted and may be mixed in one array: a `File`/`Blob` (also a `FileList`), which the SDK uploads first; the descriptor `FileUploading.upload` returns for a file **already in storage**, which is passed through as it is; or a hand-built {@link IFileValue}. In a SUBMISSION the value must be an **array** — a lone descriptor or {@link IFileValue} answers `400 formData's marker '<marker>' value must be an array`, while a lone `File`/`Blob` is fine because the SDK wraps the upload result. A READ returns the files as an array too — a single attached file is a one-element array.
769
777
  * @example
770
778
  [
771
779
  {
@@ -800,24 +808,41 @@ interface IFileValue {
800
808
  * @interface IBodyTypeRadioButtonList
801
809
  * @property {string} marker - marker name. Example: "selector".
802
810
  * @property {string} type - Type value. Example: 'list'.
803
- * @property {Array} value - Array of list or radioButton bojects.
811
+ * @property {IListOptionValue[] | string[] | string} value - Chosen option(s). A read of a submission returns the option **values as stored**: `list` — an array of strings (`["1"]`), `radioButton` — one string (`"1"`). The `[{ title, value, extended }]` form is the shape of a page attribute.
804
812
  * @example
805
- [
806
- {
807
- "title": "red",
808
- "value": "1",
809
- "extended": {
810
- "value": "red",
811
- "type": "string"
812
- }
813
- }
814
- ]
815
- * @description Represents a list or radio button selection with multiple options, each containing a title, value, and extended information.
813
+ ["1"]
814
+ * @description Represents a list or radio button selection. Look the titles up in the form's attribute (`Forms.getFormByMarker`) by the stored value.
816
815
  */
817
816
  interface IBodyTypeRadioButtonList {
818
817
  marker: string;
819
818
  type: 'list' | 'radioButton';
820
- value: IListOptionValue[];
819
+ value: IListOptionValue[] | string[] | string;
820
+ }
821
+ /**
822
+ * Represents an `entity` form data field — links to other entities.
823
+ * @interface IBodyTypeEntity
824
+ * @property {string} marker - marker name. Example: "related".
825
+ * @property {'entity'} type - Type value. Example: "entity".
826
+ * @property {number[]} value - Identifiers of the linked entities. Example: [2954, 2957].
827
+ * @description A form field that stores links to other entities (for example products) by id.
828
+ */
829
+ interface IBodyTypeEntity {
830
+ marker: string;
831
+ type: 'entity';
832
+ value: number[];
833
+ }
834
+ /**
835
+ * Represents a `timeInterval` form data field.
836
+ * @interface IBodyTypeTimeInterval
837
+ * @property {string} marker - marker name. Example: "booking".
838
+ * @property {'timeInterval'} type - Type value. Example: "timeInterval".
839
+ * @property {string[][]} value - Intervals as `[start, end]` pairs of ISO dates. Example: [["2025-02-11T16:00:00.000Z", "2025-02-13T16:00:00.000Z"]].
840
+ * @description A form field that stores one or more time intervals.
841
+ */
842
+ interface IBodyTypeTimeInterval {
843
+ marker: string;
844
+ type: 'timeInterval';
845
+ value: string[][];
821
846
  }
822
847
  /**
823
848
  * @interface IListOptionExtended
@@ -841,4 +866,4 @@ interface IListOptionValue {
841
866
  value: string;
842
867
  extended: IListOptionExtended;
843
868
  }
844
- export type { FormDataPostType, FormDataStatus, FormDataType, IBodyPostFormData, IBodyPostTypeList, IBodyPostTypeSpam, IBodyPostTypeText, IBodyTypeFile, IBodyTypeImageGroupOfImages, IBodyTypeRadioButtonList, IBodyTypeStringNumberFloat, IBodyTypeText, IBodyTypeTextWithHeader, IBodyTypeTimeDate, ICaptchaEvent, ICaptchaValue, IFileValue, IFormByMarkerDataEntity, IFormDataEntity, IFormDataSearchEntity, IFormsByMarkerDataEntity, IFormsData, IFormsDataEntity, IFormsDataFilter, IFormsDataSearchResponse, IFormsDataVectorSearch, IImageValue, IImageValueParams, IListOptionExtended, IListOptionValue, IPostFormResponse, IPostFormResponseData, ITextEditorParams, ITextSubmissionValue, ITextValue, ITextWithHeaderValue, ITimeDateValue, IUpdateFormsData, };
869
+ export type { FormDataPostType, FormDataStatus, FormDataType, IBodyPostFormData, IBodyPostTypeList, IBodyPostTypeSpam, IBodyPostTypeText, IBodyTypeEntity, IBodyTypeFile, IBodyTypeImageGroupOfImages, IBodyTypeRadioButtonList, IBodyTypeStringNumberFloat, IBodyTypeText, IBodyTypeTextWithHeader, IBodyTypeTimeDate, IBodyTypeTimeInterval, ICaptchaEvent, ICaptchaValue, IFileValue, IFormByMarkerDataEntity, IFormDataEntity, IFormDataSearchEntity, IFormsByMarkerDataEntity, IFormsData, IFormsDataEntity, IFormsDataFilter, IFormsDataSearchResponse, IFormsDataVectorSearch, IImageValue, IImageValueParams, IListOptionExtended, IListOptionValue, IPostFormResponse, IPostFormResponseData, ITextEditorParams, ITextSubmissionValue, ITextSubmissionValueHtml, ITextSubmissionValueMd, ITextSubmissionValuePlain, ITextValue, ITextWithHeaderValue, ITimeDateValue, IUpdateFormsData, };
@@ -19,7 +19,7 @@ interface IGeneralTypes {
19
19
  * Represents a general type entity.
20
20
  * @interface IGeneralTypesEntity
21
21
  * @property {number} id - ID of the type. Example: 1.
22
- * @property {BlockType} type - Type name: a `BlockType` value such as `"product"` or `"service"`. Example: "product", "category", "etc".
22
+ * @property {BlockType} type - Type name: a `BlockType` value such as `"product"`, `"catalog_page"`, `"product_block"` or `"service"`. Example: "product".
23
23
  * @description Represents a general type entity with an identifier and a type.
24
24
  */
25
25
  interface IGeneralTypesEntity {
package/dist/index.d.ts CHANGED
@@ -34,6 +34,7 @@ import WsApi from './web-socket/wsApi';
34
34
  export { getAdditionalFields, getAttributeFile, getAttributeFiles, isFileAttribute, isListAttribute, isNumberAttribute, isStringAttribute, } from './base/attributes';
35
35
  export { expandAttributeTimeIntervals, expandTimeIntervals, isTimeIntervalAttribute, } from './base/timeIntervals';
36
36
  export type * from './types';
37
+ export type { IDefineApi };
37
38
  /**
38
39
  * IDefineApi interface
39
40
  * @interface IDefineApi
@@ -132,17 +133,17 @@ interface IDefineApi {
132
133
  * @function defineOneEntry
133
134
  * @param {string} url - URl of your project.
134
135
  * @param {IConfig} config - Custom configuration settings
135
- * @param {string} [config.token] - Optional token parameter
136
+ * @param {string} config.token - App token of the project. Required: `defineOneEntry` throws without it.
136
137
  * @param {string} [config.guestId] - Optional guest identifier sent as the `x-guest-id` header for guest cart/wishlist/activity flows (only while unauthenticated). In the browser, if omitted, a stable per-device id is generated and persisted in localStorage. On the server you MUST pass a per-visitor `guestId` (or call `setGuestId`): the SDK never auto-generates a server id, to avoid sharing one guest across visitors.
137
138
  * @param {string} [config.deviceMetadata] - Optional device-metadata string sent as the `x-device-metadata` header instead of the environment-derived fingerprint. Refresh tokens are bound to this header, so a server issuing tokens for a browser (OAuth code exchange) must pass the browser's string (from `getDeviceMetadata()`), or the token will not be refreshable from that browser.
138
- * @param {string} [config.langCode] - Optional langCode parameter
139
+ * @param {string} [config.langCode] - Optional default language. Default: 'en_US'.
139
140
  * @param {boolean} [config.traficLimit] - Some methods use multiple queries to make it easier to work with the API. Set it to `true` to save traffic and decide for yourself what data you need: the SDK then skips its follow-up requests, and some results change shape (e.g. `searchPage` returns short `{ id, title }` cards). Default: false.
140
- * @param {string} [config.auth] - An object with authorization settings.
141
+ * @param {object} [config.auth] - An object with authorization settings.
141
142
  * @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.
142
- * @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.
143
+ * @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. On the server, also pass the `deviceMetadata` saved with the token: the API binds refresh tokens to it.
143
144
  * @param {string} [config.auth.providerMarker] - The marker of the authorization provider.
144
- * @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.
145
+ * @param {function(string): void} [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.
145
146
  * @returns {IDefineApi} List of methods set.
146
- * @description Define API.
147
+ * @description Define API. The returned client holds one session (tokens, guest id) shared by all its modules: on a server, create a client per request for user calls — a client shared between requests serves the signed-in user's data to every visitor. `logout` does not change the guest id.
147
148
  */
148
149
  export declare function defineOneEntry(url: string, config: IConfig): IDefineApi;
package/dist/index.js CHANGED
@@ -50,23 +50,55 @@ var timeIntervals_1 = require("./base/timeIntervals");
50
50
  Object.defineProperty(exports, "expandAttributeTimeIntervals", { enumerable: true, get: function () { return timeIntervals_1.expandAttributeTimeIntervals; } });
51
51
  Object.defineProperty(exports, "expandTimeIntervals", { enumerable: true, get: function () { return timeIntervals_1.expandTimeIntervals; } });
52
52
  Object.defineProperty(exports, "isTimeIntervalAttribute", { enumerable: true, get: function () { return timeIntervals_1.isTimeIntervalAttribute; } });
53
+ /**
54
+ * Checks the project URL every request path is appended to.
55
+ * @param {string} raw - The URL as passed, trimmed.
56
+ * @param {string} base - The URL with trailing `/` and `/api/content` removed.
57
+ * @returns {boolean} True for an http(s) origin (optionally with a path) or a same-origin proxy path.
58
+ * @description A backslash is read as `/` by browsers: `/\\evil.example` was a "path" that sent
59
+ * every request — and the app token — to another host. A query or fragment swallowed every
60
+ * path appended to it, and credentials in the URL make `fetch` throw on each call.
61
+ */
62
+ function _isProjectUrl(raw, base) {
63
+ if (/[\\?#\s]/.test(base)) {
64
+ return false;
65
+ }
66
+ if (raw.startsWith('/')) {
67
+ // `/` and `/api/content` leave an empty base: the site's own origin
68
+ return !raw.startsWith('//') && (base === '' || base.startsWith('/'));
69
+ }
70
+ // `https:evil.example` parses with that host, but a browser resolves it as a path
71
+ if (!/^https?:\/\//i.test(base)) {
72
+ return false;
73
+ }
74
+ try {
75
+ const parsed = new URL(base);
76
+ return ((parsed.protocol === 'http:' || parsed.protocol === 'https:') &&
77
+ !!parsed.hostname &&
78
+ !parsed.username &&
79
+ !parsed.password);
80
+ }
81
+ catch {
82
+ return false;
83
+ }
84
+ }
53
85
  /**
54
86
  * Define API.
55
87
  * @function defineOneEntry
56
88
  * @param {string} url - URl of your project.
57
89
  * @param {IConfig} config - Custom configuration settings
58
- * @param {string} [config.token] - Optional token parameter
90
+ * @param {string} config.token - App token of the project. Required: `defineOneEntry` throws without it.
59
91
  * @param {string} [config.guestId] - Optional guest identifier sent as the `x-guest-id` header for guest cart/wishlist/activity flows (only while unauthenticated). In the browser, if omitted, a stable per-device id is generated and persisted in localStorage. On the server you MUST pass a per-visitor `guestId` (or call `setGuestId`): the SDK never auto-generates a server id, to avoid sharing one guest across visitors.
60
92
  * @param {string} [config.deviceMetadata] - Optional device-metadata string sent as the `x-device-metadata` header instead of the environment-derived fingerprint. Refresh tokens are bound to this header, so a server issuing tokens for a browser (OAuth code exchange) must pass the browser's string (from `getDeviceMetadata()`), or the token will not be refreshable from that browser.
61
- * @param {string} [config.langCode] - Optional langCode parameter
93
+ * @param {string} [config.langCode] - Optional default language. Default: 'en_US'.
62
94
  * @param {boolean} [config.traficLimit] - Some methods use multiple queries to make it easier to work with the API. Set it to `true` to save traffic and decide for yourself what data you need: the SDK then skips its follow-up requests, and some results change shape (e.g. `searchPage` returns short `{ id, title }` cards). Default: false.
63
- * @param {string} [config.auth] - An object with authorization settings.
95
+ * @param {object} [config.auth] - An object with authorization settings.
64
96
  * @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.
65
- * @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.
97
+ * @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. On the server, also pass the `deviceMetadata` saved with the token: the API binds refresh tokens to it.
66
98
  * @param {string} [config.auth.providerMarker] - The marker of the authorization provider.
67
- * @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.
99
+ * @param {function(string): void} [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.
68
100
  * @returns {IDefineApi} List of methods set.
69
- * @description Define API.
101
+ * @description Define API. The returned client holds one session (tokens, guest id) shared by all its modules: on a server, create a client per request for user calls — a client shared between requests serves the signed-in user's data to every visitor. `logout` does not change the guest id.
70
102
  */
71
103
  function defineOneEntry(url, config) {
72
104
  if (typeof url !== 'string' || url.trim() === '') {
@@ -81,7 +113,18 @@ function defineOneEntry(url, config) {
81
113
  'Pass it via config, e.g. ' +
82
114
  'defineOneEntry("https://your-project.oneentry.cloud", { token: "your-app-token" }).');
83
115
  }
84
- const stateModule = new stateModule_1.default(url.endsWith('/') ? url.slice(0, -1) : url, config);
116
+ // Trailing slashes and a copied `/api/content` suffix used to double up in every path
117
+ // (`//api/content/…`, `/api/content/api/content/…`) and fail each call with a 404
118
+ const baseUrl = url
119
+ .trim()
120
+ .replace(/\/+$/, '')
121
+ .replace(/\/api\/content$/i, '');
122
+ if (!_isProjectUrl(url.trim(), baseUrl)) {
123
+ throw new Error('OneEntry SDK: project URL must be an http(s) URL without credentials, query or fragment, ' +
124
+ 'or a same-origin proxy path starting with "/", e.g. ' +
125
+ 'defineOneEntry("https://your-project.oneentry.cloud", { token: "your-app-token" }).');
126
+ }
127
+ const stateModule = new stateModule_1.default(baseUrl, config);
85
128
  const Admins = new adminsApi_1.default(stateModule);
86
129
  const AttributesSets = new attributeSetsApi_1.default(stateModule);
87
130
  const AuthProvider = new authProviderApi_1.default(stateModule);
@@ -86,11 +86,13 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
86
86
  * @handleName getICollectionRowsByMarker
87
87
  * @param {string} marker - Marker of the collection. Example: "collection1".
88
88
  * @param {string} [langCode] - Language code. Default: "en_US".
89
+ * @param {ICollectionQuery} [userQuery] - Pagination and entity filter, as in `getICollectionRowsById`. Without it the API returns the first 30 records only. Example: `{ limit: 100, offset: 0 }`.
89
90
  * @returns {Promise<ICollectionRowsResponce | IError>} Returns CollectionRowEntity object.
90
91
  * @throws {IError} When isShell=false and an error occurs during the fetch
92
+ * @description Records of the collection, one page at a time: `limit` defaults to 30 and `total` holds the full count.
91
93
  * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollectionRowsByMarker getICollectionRowsByMarker} documentation.
92
94
  */
93
- getICollectionRowsByMarker(marker: string, langCode?: string): Promise<ICollectionRowsResponce | IError>;
95
+ getICollectionRowsByMarker(marker: string, langCode?: string, userQuery?: ICollectionQuery): Promise<ICollectionRowsResponce | IError>;
94
96
  /**
95
97
  * Getting one record from the collection.
96
98
  * @handleName getICollectionRowByMarkerAndId
@@ -121,7 +123,7 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
121
123
  * @param {string} [langCode] - Language code. Default: "en_US".
122
124
  * @returns {Promise<ICollectionRow | IError>} Returns object of type ICollectionRow.
123
125
  * @throws {IError} When isShell=false and an error occurs during the fetch
124
- * @description Create a record in the collection.
126
+ * @description Create a record in the collection. The row is stored under the language key of `formData` when it is wrapped (`{ "en_US": [...] }`), not under `langCode` of the call; the returned `formData` is an array either way.
125
127
  * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/createICollectionRow createICollectionRow} documentation.
126
128
  */
127
129
  createICollectionRow(marker: string, body: ICollectionFormObject, langCode?: string): Promise<ICollectionRow | IError>;
@@ -147,7 +149,7 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
147
149
  * @param {string} [langCode] - Language code. Default: "en_US".
148
150
  * @returns {Promise<ICollectionRow | IError>} Returns object of type ICollectionRow.
149
151
  * @throws {IError} When isShell=false and an error occurs during the fetch
150
- * @description Edit a record in the collection.
152
+ * @description Edit a record in the collection. `formData` **replaces** every field of the row: fields left out of the body are removed, not kept.
151
153
  * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/updateICollectionRow updateICollectionRow} documentation.
152
154
  */
153
155
  updateICollectionRow(marker: string, id: number, body: {
@@ -159,10 +161,19 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
159
161
  * @handleName deleteICollectionRowByMarkerAndId
160
162
  * @param {string} marker - Marker of the collection. Example: "collection1".
161
163
  * @param {number} id - ID of the collection row. Example: 12.
162
- * @returns {Promise<boolean | IError>} Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
164
+ * @returns {Promise<boolean | IError>} Returns `true` once the row is deleted; a row that is not there (or already deleted) answers IError `404 Row not found`, not `false`. Permission "collections.row.delete" is required.
163
165
  * @throws {IError} When isShell=false and an error occurs during the fetch
164
166
  * @description Deletion of collection record object
165
167
  * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/deleteICollectionRowByMarkerAndId deleteICollectionRowByMarkerAndId} documentation.
166
168
  */
167
169
  deleteICollectionRowByMarkerAndId(marker: string, id: number): Promise<boolean | IError>;
170
+ /**
171
+ * Unwraps `formData` of a created or updated row that is still keyed by a language.
172
+ * @param {any} row - The normalized row.
173
+ * @returns {any} The row with `formData` as an array.
174
+ * @description The row is stored under the language key of the body, and the answer
175
+ * keeps that key: `createICollectionRow(…, 'ru_RU')` with `{ en_US: [...] }` returned
176
+ * `formData` as an object, while `ICollectionRow.formData` is an array.
177
+ */
178
+ private _rowFormDataAsArray;
168
179
  }
@@ -94,7 +94,8 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
94
94
  * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollectionById getICollectionById} documentation.
95
95
  */
96
96
  async getICollectionById(id, langCode = this.state.lang) {
97
- const result = await this._fetchGet(`/${id}?` + this._queryParamsToString({ langCode }));
97
+ const result = await this._fetchGet(`/${this._pathSegment(String(id))}?` +
98
+ this._queryParamsToString({ langCode }));
98
99
  // Validate response if validation is enabled
99
100
  const validated = await this._validateResponse(result, schema('CollectionEntitySchema'));
100
101
  return this._normalizeData(validated, langCode);
@@ -122,7 +123,7 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
122
123
  * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollectionRowsById getICollectionRowsById} documentation.
123
124
  */
124
125
  async getICollectionRowsById(id, langCode = this.state.lang, userQuery) {
125
- const result = await this._fetchGet(`/${id}/rows?` +
126
+ const result = await this._fetchGet(`/${this._pathSegment(String(id))}/rows?` +
126
127
  this._queryParamsToString({
127
128
  ...this._defaultQuery,
128
129
  ...userQuery,
@@ -146,7 +147,7 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
146
147
  * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/validateICollectionMarker validateICollectionMarker} documentation.
147
148
  */
148
149
  async validateICollectionMarker(marker) {
149
- const result = await this._fetchGet(`/marker-validation/${marker}`);
150
+ const result = await this._fetchGet(`/marker-validation/${this._pathSegment(marker)}`);
150
151
  // Validate response if validation is enabled
151
152
  const validated = await this._validateResponse(result, schema('CollectionIsValidSchema'));
152
153
  return this._normalizeData(validated);
@@ -156,12 +157,19 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
156
157
  * @handleName getICollectionRowsByMarker
157
158
  * @param {string} marker - Marker of the collection. Example: "collection1".
158
159
  * @param {string} [langCode] - Language code. Default: "en_US".
160
+ * @param {ICollectionQuery} [userQuery] - Pagination and entity filter, as in `getICollectionRowsById`. Without it the API returns the first 30 records only. Example: `{ limit: 100, offset: 0 }`.
159
161
  * @returns {Promise<ICollectionRowsResponce | IError>} Returns CollectionRowEntity object.
160
162
  * @throws {IError} When isShell=false and an error occurs during the fetch
163
+ * @description Records of the collection, one page at a time: `limit` defaults to 30 and `total` holds the full count.
161
164
  * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollectionRowsByMarker getICollectionRowsByMarker} documentation.
162
165
  */
163
- async getICollectionRowsByMarker(marker, langCode = this.state.lang) {
164
- const result = await this._fetchGet(`/marker/${marker}/rows?langCode=${langCode}`);
166
+ async getICollectionRowsByMarker(marker, langCode = this.state.lang, userQuery) {
167
+ const result = await this._fetchGet(`/marker/${this._pathSegment(marker)}/rows?` +
168
+ this._queryParamsToString({
169
+ ...this._defaultQuery,
170
+ ...userQuery,
171
+ langCode,
172
+ }));
165
173
  // Validate response if validation is enabled
166
174
  const validated = await this._validateResponse(result, schema('CollectionRowsResponseSchema'));
167
175
  return this._normalizeData(validated, langCode);
@@ -177,7 +185,7 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
177
185
  * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollectionRowByMarkerAndId getICollectionRowByMarkerAndId} documentation.
178
186
  */
179
187
  async getICollectionRowByMarkerAndId(marker, id, langCode = this.state.lang) {
180
- const result = await this._fetchGet(`/marker/${marker}/rows/${id}?langCode=${langCode}`);
188
+ const result = await this._fetchGet(`/marker/${this._pathSegment(marker)}/rows/${this._pathSegment(String(id))}?langCode=${encodeURIComponent(langCode)}`);
181
189
  // Validate response if validation is enabled
182
190
  const validated = await this._validateResponse(result, schema('CollectionRowSchema'));
183
191
  return this._normalizeData(validated, langCode);
@@ -201,14 +209,14 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
201
209
  * @param {string} [langCode] - Language code. Default: "en_US".
202
210
  * @returns {Promise<ICollectionRow | IError>} Returns object of type ICollectionRow.
203
211
  * @throws {IError} When isShell=false and an error occurs during the fetch
204
- * @description Create a record in the collection.
212
+ * @description Create a record in the collection. The row is stored under the language key of `formData` when it is wrapped (`{ "en_US": [...] }`), not under `langCode` of the call; the returned `formData` is an array either way.
205
213
  * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/createICollectionRow createICollectionRow} documentation.
206
214
  */
207
215
  async createICollectionRow(marker, body, langCode = this.state.lang) {
208
- const response = await this._fetchPost(`/marker/${marker}/rows?langCode=${langCode}`, body);
216
+ const response = await this._fetchPost(`/marker/${this._pathSegment(marker)}/rows?langCode=${encodeURIComponent(langCode)}`, body);
209
217
  // Validate response if validation is enabled
210
218
  const validated = await this._validateResponse(response, schema('CollectionRowSchema'));
211
- return this._normalizeData(validated, langCode);
219
+ return this._rowFormDataAsArray(this._normalizeData(validated, langCode));
212
220
  }
213
221
  /**
214
222
  * Edit a record in the collection.
@@ -232,28 +240,48 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
232
240
  * @param {string} [langCode] - Language code. Default: "en_US".
233
241
  * @returns {Promise<ICollectionRow | IError>} Returns object of type ICollectionRow.
234
242
  * @throws {IError} When isShell=false and an error occurs during the fetch
235
- * @description Edit a record in the collection.
243
+ * @description Edit a record in the collection. `formData` **replaces** every field of the row: fields left out of the body are removed, not kept.
236
244
  * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/updateICollectionRow updateICollectionRow} documentation.
237
245
  */
238
246
  async updateICollectionRow(marker, id, body, langCode = this.state.lang) {
239
- const response = await this._fetchPut(`/marker/${marker}/rows/${id}?` + `langCode=${langCode}`, body);
247
+ const response = await this._fetchPut(`/marker/${this._pathSegment(marker)}/rows/${this._pathSegment(String(id))}?` +
248
+ `langCode=${encodeURIComponent(langCode)}`, body);
240
249
  // Validate response if validation is enabled
241
250
  const validated = await this._validateResponse(response, schema('CollectionRowSchema'));
242
- return this._normalizeData(validated, langCode);
251
+ return this._rowFormDataAsArray(this._normalizeData(validated, langCode));
243
252
  }
244
253
  /**
245
254
  * Deletion of collection record object
246
255
  * @handleName deleteICollectionRowByMarkerAndId
247
256
  * @param {string} marker - Marker of the collection. Example: "collection1".
248
257
  * @param {number} id - ID of the collection row. Example: 12.
249
- * @returns {Promise<boolean | IError>} Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
258
+ * @returns {Promise<boolean | IError>} Returns `true` once the row is deleted; a row that is not there (or already deleted) answers IError `404 Row not found`, not `false`. Permission "collections.row.delete" is required.
250
259
  * @throws {IError} When isShell=false and an error occurs during the fetch
251
260
  * @description Deletion of collection record object
252
261
  * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/deleteICollectionRowByMarkerAndId deleteICollectionRowByMarkerAndId} documentation.
253
262
  */
254
263
  async deleteICollectionRowByMarkerAndId(marker, id) {
255
- const result = await this._fetchDelete(`/marker/${marker}/rows/${id}`);
264
+ const result = await this._fetchDelete(`/marker/${this._pathSegment(marker)}/rows/${this._pathSegment(String(id))}`);
256
265
  return result;
257
266
  }
267
+ /**
268
+ * Unwraps `formData` of a created or updated row that is still keyed by a language.
269
+ * @param {any} row - The normalized row.
270
+ * @returns {any} The row with `formData` as an array.
271
+ * @description The row is stored under the language key of the body, and the answer
272
+ * keeps that key: `createICollectionRow(…, 'ru_RU')` with `{ en_US: [...] }` returned
273
+ * `formData` as an object, while `ICollectionRow.formData` is an array.
274
+ */
275
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
276
+ _rowFormDataAsArray(row) {
277
+ const formData = row === null || row === void 0 ? void 0 : row.formData;
278
+ if (formData && typeof formData === 'object' && !Array.isArray(formData)) {
279
+ const keys = Object.keys(formData);
280
+ if (keys.length === 1 && Array.isArray(formData[keys[0]])) {
281
+ return { ...row, formData: formData[keys[0]] };
282
+ }
283
+ }
284
+ return row;
285
+ }
258
286
  }
259
287
  exports.default = IntegrationCollectionsApi;