@retailcrm/embed-ui-v1-types 0.9.27 → 0.9.29
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 +14 -0
- package/host.d.ts +5 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -47,3 +47,17 @@ await host.httpCall('/embed/api/admin/specialties/save', {
|
|
|
47
47
|
|
|
48
48
|
Если вызов работает не так, как ожидается, сначала проверьте Network и фактический запрос,
|
|
49
49
|
который UI отправил на backend модуля: path, form-encoded параметры и значение `payload`.
|
|
50
|
+
|
|
51
|
+
## `HostApi.onBeforeRouteLeave`
|
|
52
|
+
|
|
53
|
+
`host.onBeforeRouteLeave(hook)` регистрирует callback, через который расширение сообщает host,
|
|
54
|
+
готово ли оно к уходу с текущей страницы.
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
host.onBeforeRouteLeave(() => !formHasUnsavedChanges.value)
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Если callback возвращает `true`, расширение подтверждает, что переход можно продолжить. Если callback
|
|
61
|
+
возвращает `false`, расширение сообщает, что переход сейчас нежелателен, например из-за несохраненных
|
|
62
|
+
изменений. Host может использовать этот результат, чтобы показать подтверждение или удержать текущий
|
|
63
|
+
URL, но это уведомительный механизм: окончательное решение о навигации остается на стороне host.
|
package/host.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { Pojo, Scalar } from './scaffolding'
|
|
1
|
+
import type { MaybePromise, Pojo, Scalar } from './scaffolding'
|
|
2
2
|
|
|
3
3
|
export type HostQueryInputValue = Scalar | Scalar[]
|
|
4
4
|
export type HostQueryInput = Record<string, HostQueryInputValue>
|
|
@@ -17,6 +17,8 @@ export type HostQueryOptions = {
|
|
|
17
17
|
preserveExisting?: boolean;
|
|
18
18
|
}
|
|
19
19
|
|
|
20
|
+
export type BeforeRouteLeaveHook = () => MaybePromise<boolean>
|
|
21
|
+
|
|
20
22
|
export type HostApi = {
|
|
21
23
|
goTo (route: string, params?: Record<string, unknown>): void;
|
|
22
24
|
|
|
@@ -30,4 +32,6 @@ export type HostApi = {
|
|
|
30
32
|
replaceQuery (query: HostQueryInput, options?: HostQueryOptions): void;
|
|
31
33
|
|
|
32
34
|
pushQuery (query: HostQueryInput, options?: HostQueryOptions): void;
|
|
35
|
+
|
|
36
|
+
onBeforeRouteLeave (hook: BeforeRouteLeaveHook): void;
|
|
33
37
|
}
|
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.29",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"author": "RetailDriverLLC <integration@retailcrm.ru>",
|
|
8
8
|
"repository": {
|