@retailcrm/embed-ui-v1-types 0.9.24 → 0.9.26
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.
- package/README.md +32 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,4 +15,35 @@ npm i --save @retailcrm/embed-ui-v1-types
|
|
|
15
15
|
yarn:
|
|
16
16
|
```bash
|
|
17
17
|
yarn add @retailcrm/embed-ui-v1-types
|
|
18
|
-
```
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## `HostApi.httpCall`
|
|
21
|
+
|
|
22
|
+
`host.httpCall(path, payload)` вызывает backend action JS-расширения. Передавайте вторым аргументом
|
|
23
|
+
ровно тот POJO-объект или строку, которые ожидает backend API этого action:
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
await host.httpCall('/embed/api/admin/specialties/save', {
|
|
27
|
+
id: null,
|
|
28
|
+
name: 'Development',
|
|
29
|
+
})
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
CRM самостоятельно отправляет POST-запрос на backend модуля и кладет второй аргумент в
|
|
33
|
+
form-encoded параметр `payload`. Если передан объект, CRM сериализует его сама; если передана строка,
|
|
34
|
+
CRM передает строку как есть. Отдельная упаковка и `JSON.stringify` на стороне frontend обычно не нужны.
|
|
35
|
+
|
|
36
|
+
Ключ `payload` внутри второго аргумента используйте только если backend action действительно ожидает
|
|
37
|
+
объект такой формы:
|
|
38
|
+
|
|
39
|
+
```ts
|
|
40
|
+
await host.httpCall('/embed/api/admin/specialties/save', {
|
|
41
|
+
payload: {
|
|
42
|
+
id: null,
|
|
43
|
+
name: 'Development',
|
|
44
|
+
},
|
|
45
|
+
})
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Если вызов работает не так, как ожидается, сначала проверьте Network и фактический запрос,
|
|
49
|
+
который UI отправил на backend модуля: path, form-encoded параметры и значение `payload`.
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@retailcrm/embed-ui-v1-types",
|
|
3
3
|
"description": "Basic types declarations for RetailCRM JS API",
|
|
4
4
|
"type": "module",
|
|
5
|
-
"version": "0.9.
|
|
5
|
+
"version": "0.9.26",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"author": "RetailDriverLLC <integration@retailcrm.ru>",
|
|
8
8
|
"repository": {
|