@kosdev-code/kos-ui-sdk 3.0.10 → 3.0.11
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/core/core/kosCore.d.ts +7 -0
- package/core/core/kosCore.d.ts.map +1 -1
- package/core/core/lifecycle/kosCoreLifecycle.d.ts +4 -1
- package/core/core/lifecycle/kosCoreLifecycle.d.ts.map +1 -1
- package/core/core/transport/webSocketTransport.d.ts +30 -2
- package/core/core/transport/webSocketTransport.d.ts.map +1 -1
- package/core/types/utils/kos-fetch.d.ts +17 -0
- package/core/types/utils/kos-fetch.d.ts.map +1 -1
- package/core/util/abortable-when.d.ts +21 -0
- package/core/util/abortable-when.d.ts.map +1 -0
- package/core/util/index.d.ts +1 -0
- package/core/util/index.d.ts.map +1 -1
- package/core/util/kos-fetch.d.ts.map +1 -1
- package/core/util/kos-model-utils.d.ts +43 -0
- package/core/util/kos-model-utils.d.ts.map +1 -1
- package/core/util/kos-service-request.d.ts +10 -0
- package/core/util/kos-service-request.d.ts.map +1 -1
- package/core/util/transport-not-ready-error.d.ts +67 -0
- package/core/util/transport-not-ready-error.d.ts.map +1 -0
- package/index.cjs +187 -17
- package/index.cjs.map +1 -1
- package/index.js +187 -17
- package/index.js.map +1 -1
- package/package.json +2 -2
package/core/core/kosCore.d.ts
CHANGED
|
@@ -8,6 +8,11 @@ declare global {
|
|
|
8
8
|
}
|
|
9
9
|
}
|
|
10
10
|
export interface IKosCoreLifecycle {
|
|
11
|
+
/**
|
|
12
|
+
* Starts the lifecycle state machine. Idempotent; called by `create()` once
|
|
13
|
+
* the core has a model manager.
|
|
14
|
+
*/
|
|
15
|
+
startLifecycle(): void;
|
|
11
16
|
/**
|
|
12
17
|
* lifecycle function to initialize the core and provide initial values that
|
|
13
18
|
* will be used by the system. For example, loading the logger, setting up
|
|
@@ -52,8 +57,10 @@ export declare class KosCore implements IKosCoreManager {
|
|
|
52
57
|
isOnline: boolean;
|
|
53
58
|
private _reloading;
|
|
54
59
|
private _unloading;
|
|
60
|
+
private lifecycleStarted;
|
|
55
61
|
connectionAlias?: string;
|
|
56
62
|
private constructor();
|
|
63
|
+
startLifecycle(): void;
|
|
57
64
|
get onlineStatus(): boolean;
|
|
58
65
|
get reloading(): boolean;
|
|
59
66
|
get unloading(): boolean;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"kosCore.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ui-sdk/src/core/core/kosCore.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,oBAAoB,EAGrB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAKpD,OAAO,yBAAyB,CAAC;AAIjC,OAAO,EAEL,YAAY,EACZ,OAAO,EACR,MAAM,8BAA8B,CAAC;AAGtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAInE,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,OAAO,EAAE,eAAe,CAAC;KAC1B;CACF;AAoGD,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAExB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAExB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3B,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAExB,OAAO,EAAE,OAAO,CAAC;CAClB;AACD,MAAM,WAAW,+BAA+B;IAC9C,SAAS,EAAE,oBAAoB,CAAC;IAChC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AACD,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,YAAY,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,gBAAgB,CAAC;CAChC;AAED,MAAM,MAAM,eAAe,GAAG,iBAAiB,GAC7C,yBAAyB,GACzB,+BAA+B,GAAG;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,CAAC;AAE3D,oBAAY,SAAS;IACnB,SAAS,cAAc;IACvB,UAAU,eAAe;CAC1B;AACD,qBAAa,OAAQ,YAAW,eAAe;IAC7C,UAAU,EAAE,UAAU,CAAC,OAAO,OAAO,CAAC,CAAC;IAEvC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAkB;IAE1C,MAAM,EAAE,YAAY,CAAC;IAErB,OAAO,CAAC,WAAW,CAAU;IAE7B,OAAO,CAAC,MAAM,CAAU;IAExB,OAAO,CAAC,UAAU,CAAuB;IAElC,YAAY,EAAG,gBAAgB,CAAC;IAEhC,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAEzB,OAAO,CAAC,UAAU,CAAU;IAC5B,OAAO,CAAC,UAAU,CAAU;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,OAAO;
|
|
1
|
+
{"version":3,"file":"kosCore.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ui-sdk/src/core/core/kosCore.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,oBAAoB,EAGrB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAKpD,OAAO,yBAAyB,CAAC;AAIjC,OAAO,EAEL,YAAY,EACZ,OAAO,EACR,MAAM,8BAA8B,CAAC;AAGtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAInE,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,OAAO,EAAE,eAAe,CAAC;KAC1B;CACF;AAoGD,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,cAAc,IAAI,IAAI,CAAC;IAEvB;;;;OAIG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAExB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAExB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3B,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAExB,OAAO,EAAE,OAAO,CAAC;CAClB;AACD,MAAM,WAAW,+BAA+B;IAC9C,SAAS,EAAE,oBAAoB,CAAC;IAChC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AACD,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,YAAY,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,gBAAgB,CAAC;CAChC;AAED,MAAM,MAAM,eAAe,GAAG,iBAAiB,GAC7C,yBAAyB,GACzB,+BAA+B,GAAG;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,CAAC;AAE3D,oBAAY,SAAS;IACnB,SAAS,cAAc;IACvB,UAAU,eAAe;CAC1B;AACD,qBAAa,OAAQ,YAAW,eAAe;IAC7C,UAAU,EAAE,UAAU,CAAC,OAAO,OAAO,CAAC,CAAC;IAEvC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAkB;IAE1C,MAAM,EAAE,YAAY,CAAC;IAErB,OAAO,CAAC,WAAW,CAAU;IAE7B,OAAO,CAAC,MAAM,CAAU;IAExB,OAAO,CAAC,UAAU,CAAuB;IAElC,YAAY,EAAG,gBAAgB,CAAC;IAEhC,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAEzB,OAAO,CAAC,UAAU,CAAU;IAC5B,OAAO,CAAC,UAAU,CAAU;IAC5B,OAAO,CAAC,gBAAgB,CAAS;IACjC,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,OAAO;IAmGP,cAAc;IAQd,IAAI,YAAY,YAEf;IACD,IAAI,SAAS,YAEZ;IAED,IAAI,SAAS,YAEZ;IACK,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAiDvB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAOvB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAKxB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAmBvB,SAAS;IAGT,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IA+C5B,IAAI,OAAO,YAEV;IACD,IAAI,SAAS,CAAC,SAAS,EAAE,oBAAoB,EAE5C;IACD,IAAI,SAAS,IAHY,oBAAoB,CAK5C;IAED,IAAI,eAAe,YAElB;IAED,IAAI,YAAY,YAEf;IAEK,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAYrB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;WASb,MAAM,CAClB,QAAQ,EAAE,YAAY,EACtB,KAAK,CAAC,EAAE,OAAO,EACf,eAAe,CAAC,EAAE,MAAM;WAiFZ,WAAW,CAAC,IAAI,CAAC,EAAE;QAC/B,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,GAAG,eAAe;CAWpB"}
|
|
@@ -12,7 +12,8 @@ export declare enum KosCoreState {
|
|
|
12
12
|
OFFLINE = "offline",
|
|
13
13
|
UNLOADING = "unloading",
|
|
14
14
|
UNLOADED = "unloaded",
|
|
15
|
-
RELOADING = "reloading"
|
|
15
|
+
RELOADING = "reloading",
|
|
16
|
+
FAILED = "failed"
|
|
16
17
|
}
|
|
17
18
|
export declare enum KosCoreEvents {
|
|
18
19
|
CREATE = "create",
|
|
@@ -60,6 +61,7 @@ export declare const coreFsm: (core: IKosCoreManager) => {
|
|
|
60
61
|
loaded: import('robot3').MachineState;
|
|
61
62
|
readying: import('robot3').MachineState;
|
|
62
63
|
reloading: import('robot3').MachineState;
|
|
64
|
+
failed: import('robot3').MachineState;
|
|
63
65
|
ready: import('robot3').MachineState;
|
|
64
66
|
unloaded: import('robot3').MachineState;
|
|
65
67
|
}, {}, import('robot3').AllStateKeys<{
|
|
@@ -71,6 +73,7 @@ export declare const coreFsm: (core: IKosCoreManager) => {
|
|
|
71
73
|
loaded: unknown;
|
|
72
74
|
readying: unknown;
|
|
73
75
|
reloading: unknown;
|
|
76
|
+
failed: unknown;
|
|
74
77
|
ready: unknown;
|
|
75
78
|
unloaded: unknown;
|
|
76
79
|
}>>>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"kosCoreLifecycle.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-ui-sdk/src/core/core/lifecycle/kosCoreLifecycle.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAElD,oBAAY,YAAY;IACtB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,YAAY,iBAAiB;IAC7B,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,SAAS,cAAc;
|
|
1
|
+
{"version":3,"file":"kosCoreLifecycle.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-ui-sdk/src/core/core/lifecycle/kosCoreLifecycle.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAElD,oBAAY,YAAY;IACtB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,YAAY,iBAAiB;IAC7B,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,MAAM,WAAW;CAClB;AAED,oBAAY,aAAa;IACvB,MAAM,WAAW;IACjB,UAAU,SAAS;IACnB,KAAK,UAAU;IACf,SAAS,cAAc;IACvB,UAAU,eAAe;IACzB,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAED,MAAM,WAAW,KAAK;IACpB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,SAAS,CAAC,OAAO;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IACxC,MAAM,EAAE;QACN,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AACD,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,KAAK,CAAC;CACX;AACD,MAAM,WAAW,0BAA0B,CAAC,OAAO;IACjD,CAAC,CAAC,EAAE,MAAM,GAAG;QACX,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,0BAA0B,CAAC,OAAO,CAAC,CAAC;QAC7C,EAAE,CAAC,EAAE,KAAK,CAAC;QACX,MAAM,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;KAC7B,CAAC;CACH;AAED,MAAM,WAAW,YAAY,CAAC,OAAO,GAAG,GAAG;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,0BAA0B,CAAC,OAAO,CAAC,CAAC;IAC5C,OAAO,EAAE,OAAO,CAAC;CAClB;AAoBD,eAAO,MAAM,OAAO,GAAI,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkH5C,CAAC"}
|
|
@@ -13,6 +13,23 @@ export interface IKosConnectionStatus {
|
|
|
13
13
|
status: string;
|
|
14
14
|
message?: string;
|
|
15
15
|
}
|
|
16
|
+
/**
|
|
17
|
+
* Options for {@link IKosServiceTransport.whenReady}.
|
|
18
|
+
*
|
|
19
|
+
* @kosService core.transport
|
|
20
|
+
* @kosApiLevel 23
|
|
21
|
+
*/
|
|
22
|
+
export interface KosTransportReadyOptions {
|
|
23
|
+
/**
|
|
24
|
+
* Cancels the readiness wait when it aborts. Without one the wait is
|
|
25
|
+
* indefinite, which is correct for startup/lifecycle code but not for a
|
|
26
|
+
* request working against a deadline.
|
|
27
|
+
*
|
|
28
|
+
* When the signal aborts, `whenReady` rejects with the signal's reason and
|
|
29
|
+
* disposes the underlying reactive waiter.
|
|
30
|
+
*/
|
|
31
|
+
signal?: AbortSignal;
|
|
32
|
+
}
|
|
16
33
|
export interface KosSubscriptionParams {
|
|
17
34
|
topic: string;
|
|
18
35
|
callback: EventCallback;
|
|
@@ -32,7 +49,7 @@ export interface IKosServiceTransport {
|
|
|
32
49
|
socket?: MessageTransport;
|
|
33
50
|
init(): IKosServiceTransport;
|
|
34
51
|
subscribeTopic(params: KosSubscriptionParams): VoidFunction;
|
|
35
|
-
whenReady(): Promise<IKosConnectionStatus>;
|
|
52
|
+
whenReady(options?: KosTransportReadyOptions): Promise<IKosConnectionStatus>;
|
|
36
53
|
fosSocket?: MessageTransport;
|
|
37
54
|
}
|
|
38
55
|
export type KosCallback = (msg: IKosMessage) => void;
|
|
@@ -78,7 +95,18 @@ export declare class WebSocketTransport implements IKosServiceTransport {
|
|
|
78
95
|
private calculateBackoffDelay;
|
|
79
96
|
private _sendSubscriptionMessage;
|
|
80
97
|
subscribeTopic({ topic, callback, fos, bridge, destinationAddress, explicitDestination, }: KosSubscriptionParams): () => void;
|
|
81
|
-
|
|
98
|
+
/**
|
|
99
|
+
* Resolves once the transport can carry requests: the socket (and the FOS
|
|
100
|
+
* socket, when used) is connected and the connection is authorized.
|
|
101
|
+
*
|
|
102
|
+
* Pass `options.signal` to bound the wait. `connectionEstablished` flips back
|
|
103
|
+
* to `false` on socket close, so an unbounded wait parks indefinitely while
|
|
104
|
+
* the transport is down — callers with a deadline must supply a signal.
|
|
105
|
+
*
|
|
106
|
+
* @param options - See {@link KosTransportReadyOptions}.
|
|
107
|
+
* @throws The signal's abort reason if it aborts before the transport is ready.
|
|
108
|
+
*/
|
|
109
|
+
whenReady(options?: KosTransportReadyOptions): Promise<{
|
|
82
110
|
status: string;
|
|
83
111
|
}>;
|
|
84
112
|
get token(): string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"webSocketTransport.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-ui-sdk/src/core/core/transport/webSocketTransport.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"webSocketTransport.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-ui-sdk/src/core/core/transport/webSocketTransport.ts"],"names":[],"mappings":"AAEA,OAAO,EAAY,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAK1D,OAAO,EAAE,gBAAgB,EAAmB,MAAM,0BAA0B,CAAC;AAY7E,oBAAY,oBAAoB;IAC9B,eAAe,oBAAoB;IACnC,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,MAAM,WAAW;CAClB;AACD,MAAM,WAAW,WAAW;IAC1B,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;CACxC;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,aAAa,CAAC;IACxB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AACD,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qBAAqB,EAAE,OAAO,CAAC;IAC/B,UAAU,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,IAAI,IAAI,oBAAoB,CAAC;IAC7B,cAAc,CAAC,MAAM,EAAE,qBAAqB,GAAG,YAAY,CAAC;IAC5D,SAAS,CAAC,OAAO,CAAC,EAAE,wBAAwB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC7E,SAAS,CAAC,EAAE,gBAAgB,CAAC;CAC9B;AAED,MAAM,MAAM,WAAW,GAAG,CAAC,GAAG,EAAE,WAAW,KAAK,IAAI,CAAC;AAGrD,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAE3D,UAAU,wBAAwB;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED,qBAAa,kBAAmB,YAAW,oBAAoB;IAC7D,OAAO,CAAC,MAAM,CAAC,SAAS,CAAuB;IAE/C,IAAI,EAAE,MAAM,CAAC;IAEb,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,CAAC,MAAM,CAAC,CAAS;IAExB,OAAO,CAAC,kBAAkB,CAA0B;IAEpD,UAAU,EAAE,OAAO,CAAC;IAEpB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAE7B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,eAAe,EAAE,OAAO,CAAC;IAGzB,OAAO,CAAC,iBAAiB,CAAK;IAC9B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,sBAAsB,CAAM;IACpD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAQ;IAC7C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAS;gBAEjC,EACV,IAAkB,EAClB,IAAW,EACX,QAAkB,EAClB,KAAK,EACL,UAAU,EACV,KAAK,EACL,GAAG,GACJ,EAAE,wBAAwB;IA+C3B,IAAI,qBAAqB,YAsBxB;IAED,IAAI;IA+BJ;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAwBzB,OAAO,CAAC,qBAAqB;IAU7B,OAAO,CAAC,wBAAwB;IAyChC,cAAc,CAAC,EACb,KAAK,EACL,QAAQ,EACR,GAAG,EACH,MAAM,EACN,kBAAkB,EAClB,mBAAmB,GACpB,EAAE,qBAAqB;IA4BxB;;;;;;;;;;OAUG;IACG,SAAS,CAAC,OAAO,CAAC,EAAE,wBAAwB;;;IAkBlD,IAAI,KAAK,IAGQ,MAAM,CADtB;IACD,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,EAGtB;WACa,IAAI,CAAC,IAAI,SAAc;WAKvB,IAAI,CAAC,IAAI,SAAO;WAKhB,KAAK,CAAC,KAAK,EAAE,MAAM;WAInB,WAAW,CAAC,IAAI,SAAO,EAAE,KAAK,CAAC,EAAE,MAAM;CAStD"}
|
|
@@ -141,6 +141,23 @@ export interface KosFetchOptions {
|
|
|
141
141
|
* @internal
|
|
142
142
|
*/
|
|
143
143
|
bridge?: boolean;
|
|
144
|
+
/**
|
|
145
|
+
* Timeout budget for the **entire call**, in milliseconds: waiting for the
|
|
146
|
+
* transport to become ready plus the request itself.
|
|
147
|
+
*
|
|
148
|
+
* A request issued while the socket is down or reconnecting settles within
|
|
149
|
+
* this budget — it rejects with a `TransportNotReadyError` if the transport
|
|
150
|
+
* never becomes ready — rather than queuing indefinitely. If the transport
|
|
151
|
+
* becomes ready with budget remaining, the remainder applies to the request,
|
|
152
|
+
* which then rejects with a `TimeoutError` `DOMException`. The two errors are
|
|
153
|
+
* distinct so callers can tell "service is slow" from "transport is down".
|
|
154
|
+
*
|
|
155
|
+
* Defaults to the `KOS_WS_TIMEOUT` environment value, or 30000.
|
|
156
|
+
*
|
|
157
|
+
* Pass `0` or `Infinity` to opt out of the budget entirely and queue until
|
|
158
|
+
* the transport recovers — a request that does this can never settle while
|
|
159
|
+
* the socket is down.
|
|
160
|
+
*/
|
|
144
161
|
timeout?: number;
|
|
145
162
|
/**
|
|
146
163
|
* @kosApiLevel 5
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"kos-fetch.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-ui-sdk/src/core/types/utils/kos-fetch.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,eAAe;IACzB,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,MAAM,WAAW;CAClB;AAED,KAAK,kBAAkB,GAAG,MAAM,OAAO,eAAe,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1C,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IACjC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAC3B,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,OAAO,CACL,UAAU,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,KAAK,IAAI,EACjE,OAAO,CAAC,EAAE,GAAG,GACZ,IAAI,CAAC;CACT;AAED,UAAU,IAAI;IACZ,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IACjD,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,WAAW,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IACpC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACtB,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC9B,IAAI,CAAC,CAAC,GAAG,GAAG,KAAK,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IACnC,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,QAAS,SAAQ,IAAI;IACpC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,KAAK,IAAI,QAAQ,CAAC;CACnB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,WAAW,WAAW;IAC1B,6EAA6E;IAC7E,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,sEAAsE;IACtE,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,qEAAqE;IACrE,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC;CAC3C;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI,GAAG,QAAQ,GAAG,UAAU,CAAC;IAE3D;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,GAAG,CAAC,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,MAAM,CAAC;IAExD;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,WAAW,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAClC,EAAE,EAAE,OAAO,CAAC;IACZ,IAAI,EAAE,CACJ,CAAC,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,OACzD,OAAO,CAAC,CAAC,CAAC,CAAC;IAClB,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,iBACf,SAAQ,IAAI,CAAC,eAAe,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAC;IAC9D,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AACD;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC5D,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,IAAI,CAAC,EAAE,MAAM,CAAC;CACf"}
|
|
1
|
+
{"version":3,"file":"kos-fetch.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-ui-sdk/src/core/types/utils/kos-fetch.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,eAAe;IACzB,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,MAAM,WAAW;CAClB;AAED,KAAK,kBAAkB,GAAG,MAAM,OAAO,eAAe,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1C,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IACjC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAC3B,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,OAAO,CACL,UAAU,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,KAAK,IAAI,EACjE,OAAO,CAAC,EAAE,GAAG,GACZ,IAAI,CAAC;CACT;AAED,UAAU,IAAI;IACZ,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IACjD,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,WAAW,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IACpC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACtB,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC9B,IAAI,CAAC,CAAC,GAAG,GAAG,KAAK,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IACnC,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,QAAS,SAAQ,IAAI;IACpC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,KAAK,IAAI,QAAQ,CAAC;CACnB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,WAAW,WAAW;IAC1B,6EAA6E;IAC7E,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,sEAAsE;IACtE,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,qEAAqE;IACrE,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC;CAC3C;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI,GAAG,QAAQ,GAAG,UAAU,CAAC;IAE3D;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,GAAG,CAAC,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,MAAM,CAAC;IAExD;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,WAAW,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAClC,EAAE,EAAE,OAAO,CAAC;IACZ,IAAI,EAAE,CACJ,CAAC,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,OACzD,OAAO,CAAC,CAAC,CAAC,CAAC;IAClB,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,iBACf,SAAQ,IAAI,CAAC,eAAe,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAC;IAC9D,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AACD;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC5D,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,IAAI,CAAC,EAAE,MAAM,CAAC;CACf"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Waits for a MobX predicate to become `true`, but gives up as soon as the
|
|
3
|
+
* supplied signal aborts.
|
|
4
|
+
*
|
|
5
|
+
* MobX's `when()` waits forever by design. That is the right default for
|
|
6
|
+
* lifecycle code, but a caller working against a deadline needs the wait to be
|
|
7
|
+
* cancellable — and, more importantly, needs the underlying reaction disposed
|
|
8
|
+
* when it gives up. Without disposal, every abandoned waiter leaves a live
|
|
9
|
+
* reaction observing the predicate for the lifetime of the process.
|
|
10
|
+
*
|
|
11
|
+
* @param predicate - The reactive condition to wait for.
|
|
12
|
+
* @param signal - Optional signal that cancels the wait. When omitted the wait
|
|
13
|
+
* is indefinite, matching plain `when()`.
|
|
14
|
+
* @returns A promise that resolves once the predicate holds.
|
|
15
|
+
* @throws The signal's abort reason (a `TimeoutError` or `AbortError`
|
|
16
|
+
* `DOMException` for signals created by the SDK) if it aborts first.
|
|
17
|
+
*
|
|
18
|
+
* @internal
|
|
19
|
+
*/
|
|
20
|
+
export declare const abortableWhen: (predicate: () => boolean, signal?: AbortSignal) => Promise<void>;
|
|
21
|
+
//# sourceMappingURL=abortable-when.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"abortable-when.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ui-sdk/src/core/util/abortable-when.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,aAAa,GACxB,WAAW,MAAM,OAAO,EACxB,SAAS,WAAW,KACnB,OAAO,CAAC,IAAI,CAqCd,CAAC"}
|
package/core/util/index.d.ts
CHANGED
|
@@ -30,6 +30,7 @@ export * from './service-factory';
|
|
|
30
30
|
export * from './service-request-error';
|
|
31
31
|
export * from './service-response';
|
|
32
32
|
export * from './session-utils';
|
|
33
|
+
export * from './transport-not-ready-error';
|
|
33
34
|
export * from './wait-for-request';
|
|
34
35
|
export * from './when-ready';
|
|
35
36
|
//# sourceMappingURL=index.d.ts.map
|
package/core/util/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ui-sdk/src/core/util/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,OAAO,KAAK,WAAW,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,eAAe,CAAC;AAC9B,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,QAAQ,CAAC;AACvB,cAAc,kCAAkC,CAAC;AACjD,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ui-sdk/src/core/util/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,OAAO,KAAK,WAAW,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,eAAe,CAAC;AAC9B,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,QAAQ,CAAC;AACvB,cAAc,kCAAkC,CAAC;AACjD,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"kos-fetch.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ui-sdk/src/core/util/kos-fetch.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;
|
|
1
|
+
{"version":3,"file":"kos-fetch.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ui-sdk/src/core/util/kos-fetch.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAoBrE;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC;IACnC,IAAI,EAAE,CAAC,CAAC;IACR,MAAM,EAAE,MAAM,CAAC;CAChB;AA4XD;;;;;GAKG;AACH,QAAA,IAAI,QAAQ,QAAS,CAAC;AACtB;;;;;GAKG;AACH,QAAA,IAAI,QAAQ,QA9OL,MAAM,YACD,eAAe,KACxB,OAAO,CAAC,QAAQ,CA4OM,CAAC;AAS1B,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { IKosDataModel, IKosModel } from '../core/kosModel';
|
|
2
|
+
import { KosModelState } from '../core/lifecycle';
|
|
2
3
|
/**
|
|
3
4
|
* Asynchronously destroys a KOS data model.
|
|
4
5
|
*
|
|
@@ -143,4 +144,46 @@ export declare const isKosModel: <T extends IKosDataModel>(type: string) => (mod
|
|
|
143
144
|
* @kosApiLevel 2
|
|
144
145
|
*/
|
|
145
146
|
export declare const isKosModelReady: (model: IKosDataModel) => boolean;
|
|
147
|
+
/**
|
|
148
|
+
* An observable, read-only view of a model's activation lifecycle.
|
|
149
|
+
*
|
|
150
|
+
* Models that fetch lazily do so in `activate()`, so activation state — not
|
|
151
|
+
* `loaded`, which tracks the `load()` lifecycle — is what tells a consumer
|
|
152
|
+
* whether that fetch has settled and whether it succeeded. Exposing just this
|
|
153
|
+
* lets a view react to activation without taking a dependency on the whole
|
|
154
|
+
* {@link IKosModel}.
|
|
155
|
+
*/
|
|
156
|
+
export interface KosModelActivationState {
|
|
157
|
+
/** The model's current activation state. */
|
|
158
|
+
readonly activeStatus: KosModelState;
|
|
159
|
+
/** Activation is in flight — nothing conclusive to render yet. */
|
|
160
|
+
readonly isActivating: boolean;
|
|
161
|
+
/** Activation completed; the model's activate() work is done. */
|
|
162
|
+
readonly isActive: boolean;
|
|
163
|
+
/** Activation threw — the model's data is absent, not empty. */
|
|
164
|
+
readonly isFailed: boolean;
|
|
165
|
+
}
|
|
166
|
+
/**
|
|
167
|
+
* Retrieves an observable view of a model's activation state.
|
|
168
|
+
*
|
|
169
|
+
* Every member is a getter, so reads happen at access time and stay tracked —
|
|
170
|
+
* call this once and read its properties inside a `kosComponent` (or any MobX
|
|
171
|
+
* reaction) to re-render as the model activates, succeeds, or fails.
|
|
172
|
+
*
|
|
173
|
+
* @param model - The KOS data model to observe.
|
|
174
|
+
* @returns The activation view, or `undefined` when the model has no wrapper
|
|
175
|
+
* yet (not created, or already destroyed).
|
|
176
|
+
*
|
|
177
|
+
* @example Distinguishing "still loading" from "empty" from "failed"
|
|
178
|
+
* ```tsx
|
|
179
|
+
* const activation = getKosModelActivationState(container);
|
|
180
|
+
* if (!activation || activation.isActivating) return <Blank />;
|
|
181
|
+
* if (activation.isFailed) return <LoadError />;
|
|
182
|
+
* return <Versions items={container.items} />;
|
|
183
|
+
* ```
|
|
184
|
+
*
|
|
185
|
+
* @kosService core.utils
|
|
186
|
+
* @kosApiLevel 15
|
|
187
|
+
*/
|
|
188
|
+
export declare const getKosModelActivationState: (model: IKosDataModel | undefined) => KosModelActivationState | undefined;
|
|
146
189
|
//# sourceMappingURL=kos-model-utils.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"kos-model-utils.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ui-sdk/src/core/util/kos-model-utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;
|
|
1
|
+
{"version":3,"file":"kos-model-utils.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ui-sdk/src/core/util/kos-model-utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACjE,OAAO,EAAkB,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAIlE;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,GAAU,OAAO,aAAa,kBAGzD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAU,WAAW,aAAa,kBAS5D,CAAC;AACF;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa,GAAU,OAAO,aAAa,kBAevD,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,GAAU,SAAS,MAAM,gCAQpD,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,WAAW,GAAU,CAAC,SAAS,aAAa,GAAG,aAAa,EACvE,SAAS,MAAM;WAQqB,CAAC;;EACtC,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,GAAI,CAAC,SAAS,aAAa,GAAG,aAAa,EACrE,SAAS,MAAM;WAOqB,CAAC;;CACtC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,aAAa,EAChD,WAAW,MAAM,EACjB,WAAW;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,KASZ,CAAC,EACrB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,aAAa,EAC/C,WAAW,MAAM,EACjB,WAAW;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,MACU,CAAC;AAE5C;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB,GAAI,CAAC,SAAS,aAAa,EAC1D,OAAO,aAAa,EACpB,MAAM,MAAM,KAWwB,CACrC,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,wBAAwB,GAAI,OAAO,aAAa,oBAc5D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB,GAAI,SAAS,MAAM,mEAYtD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,mBAAmB,GAAI,CAAC,SAAS,aAAa,EACzD,SAAS,MAAM,EACf,UAAU,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,KAC9B,SAAS,GAAG,SAWd,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,GACpB,CAAC,SAAS,aAAa,EAAE,MAAM,MAAM,MACrC,OAAO,GAAG,KAAG,KAAK,IAAI,CAC4B,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,eAAe,GAAI,OAAO,aAAa,YAMnD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,WAAW,uBAAuB;IACtC,4CAA4C;IAC5C,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC;IACrC,kEAAkE;IAClE,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAC/B,iEAAiE;IACjE,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,gEAAgE;IAChE,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;CAC5B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,0BAA0B,GACrC,OAAO,aAAa,GAAG,SAAS,KAC/B,uBAAuB,GAAG,SAuB5B,CAAC"}
|
|
@@ -13,6 +13,16 @@ export declare const resolveBaseUrl: () => {
|
|
|
13
13
|
isMock: boolean;
|
|
14
14
|
URL: string;
|
|
15
15
|
};
|
|
16
|
+
/**
|
|
17
|
+
* Error string returned when the transport never became ready inside the
|
|
18
|
+
* request's timeout budget, so the request was never sent. Distinct from
|
|
19
|
+
* `"Request timed out"`, which means the request was sent and the service was
|
|
20
|
+
* slow.
|
|
21
|
+
*
|
|
22
|
+
* @kosService core.service-request
|
|
23
|
+
* @kosApiLevel 23
|
|
24
|
+
*/
|
|
25
|
+
export declare const ERROR_TRANSPORT_NOT_READY = "Transport not ready";
|
|
16
26
|
type NonNeverKeys<T> = {
|
|
17
27
|
[K in keyof T]-?: T[K] extends never | undefined ? never : K;
|
|
18
28
|
}[keyof T];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"kos-service-request.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ui-sdk/src/core/util/kos-service-request.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAe,MAAM,UAAU,CAAC;AAG7D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;
|
|
1
|
+
{"version":3,"file":"kos-service-request.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ui-sdk/src/core/util/kos-service-request.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAe,MAAM,UAAU,CAAC;AAG7D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAGpE,YAAY,EAAE,oBAAoB,EAAE,CAAC;AAErC;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc;;;CAI1B,CAAC;AAKF;;;;;;;;GAQG;AACH,eAAO,MAAM,yBAAyB,wBAAwB,CAAC;AAC/D,KAAK,YAAY,CAAC,CAAC,IAAI;KACpB,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,CAAC;CAC7D,CAAC,MAAM,CAAC,CAAC,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,OAAO,CACvC,YAAY,CAAC,CAAC,CAAC,EACf,YAAY,GAAG,aAAa,CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI;KAC5B,MAAM,IAAI,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG;SAC5C,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,SAAS,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;KAClE,CAAC,MAAM,CAAC,GAAG,MAAM;SAAG,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,SAAS,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;KAAE,CAAC;CAC7E,CAAC;AAEF,KAAK,eAAe,CAClB,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACjC,CAAC,SAAS,MAAM,KAAK,IACnB,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS;IAAE,UAAU,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAC;AAEhE,KAAK,gBAAgB,CACnB,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACjC,CAAC,SAAS,MAAM,KAAK,IACnB,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS;IAAE,UAAU,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAC;AAEjE,KAAK,eAAe,CAClB,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACjC,CAAC,SAAS,MAAM,KAAK,IACnB,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS;IAAE,UAAU,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAC;AAEhE,KAAK,kBAAkB,CACrB,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACjC,CAAC,SAAS,MAAM,KAAK,IACnB,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS;IAAE,UAAU,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAC;AASnE,KAAK,cAAc,CACjB,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACjC,CAAC,SAAS,MAAM,KAAK,IACnB,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS;IAAE,WAAW,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAC9D,CAAC,CAAC,MAAM,CAAC,CAAC,GACV,KAAK,CAAC;AAEV,KAAK,aAAa,CAChB,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACjC,CAAC,SAAS,MAAM,KAAK,IACnB,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS;IAAE,WAAW,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GAC7D,CAAC,CAAC,MAAM,CAAC,CAAC,GACV,KAAK,CAAC;AASV;;GAEG;AACH,MAAM,MAAM,cAAc,CACxB,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACjC,CAAC,SAAS,MAAM,KAAK,EACrB,CAAC,SAAS,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,IAC3C,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;IAAE,SAAS,EAAE;QAAE,GAAG,EAAE;YAAE,OAAO,EAAE,MAAM,CAAC,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,GAChE,CAAC,CAAC,MAAM,CAAC,CAAC,GACV,OAAO,CAAC;AAEZ;;GAEG;AACH,MAAM,MAAM,YAAY,CACtB,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACjC,CAAC,SAAS,MAAM,KAAK,EACrB,CAAC,SAAS,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,IAC3C,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;IAAE,UAAU,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,UAAU,CACpB,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACjC,CAAC,SAAS,MAAM,KAAK,EACrB,CAAC,SAAS,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,IAC3C,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;IAAE,WAAW,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GACzD,CAAC,CAAC,MAAM,CAAC,CAAC,GACV,KAAK,CAAC;AAEV;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IACzB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,EAAE,oBAAoB,CAAC,GAChE,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AAE3B;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI;KAC3B,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GACjC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAClB,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GAC3B,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GACtB,CAAC,CAAC,CAAC,CAAC;CACT,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,KAAK,CAAC;AA4O/D,KAAK,cAAc,GAAG,IAAI,CAAC,eAAe,EAAE,QAAQ,GAAG,MAAM,CAAC,CAAC;AAC/D;;;GAGG;AACH,wBAAgB,YAAY,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;UAKpD,CAAC,8MACK,CAAC,WACF,eAAe,CAAC,KAAK,EAAE,CAAC,CAAC,YACxB,cAAc;WAGnB,CAAC,gNACI,CAAC,WACF,gBAAgB,CAAC,KAAK,EAAE,CAAC,CAAC,yDAEzB,cAAc;UAIpB,CAAC,8MACK,CAAC,WACF,eAAe,CAAC,KAAK,EAAE,CAAC,CAAC,wDAExB,cAAc;aAGjB,CAAC,oNACE,CAAC,WACF,kBAAkB,CAAC,KAAK,EAAE,CAAC,CAAC,wDAE3B,cAAc;EAU7B"}
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Discriminator carried by every {@link TransportNotReadyError}.
|
|
3
|
+
*
|
|
4
|
+
* Prefer checking `error.code === TRANSPORT_NOT_READY` over `instanceof` when
|
|
5
|
+
* the error may have crossed a bundle boundary (an app and the SDK can end up
|
|
6
|
+
* with separate copies of the class).
|
|
7
|
+
*
|
|
8
|
+
* @category Service Request
|
|
9
|
+
* @kosService core.fetch
|
|
10
|
+
* @kosApiLevel 23
|
|
11
|
+
*/
|
|
12
|
+
export declare const TRANSPORT_NOT_READY = "TRANSPORT_NOT_READY";
|
|
13
|
+
/**
|
|
14
|
+
* Raised when a request's timeout budget expires while waiting for the KOS
|
|
15
|
+
* transport to become ready — the socket is closed, reconnecting, or not yet
|
|
16
|
+
* authorized — so the request was never sent.
|
|
17
|
+
*
|
|
18
|
+
* This is deliberately distinct from the `TimeoutError` `DOMException` raised
|
|
19
|
+
* when the request itself times out. The two call for different reactions:
|
|
20
|
+
*
|
|
21
|
+
* - `TimeoutError` — the request reached the service and the service was slow.
|
|
22
|
+
* Retrying later is usually reasonable.
|
|
23
|
+
* - `TransportNotReadyError` — connectivity is down. Retrying the same request
|
|
24
|
+
* will fail the same way until the socket comes back; surface a connectivity
|
|
25
|
+
* state to the user or trigger a reconnect/reload instead.
|
|
26
|
+
*
|
|
27
|
+
* @example
|
|
28
|
+
* ```typescript
|
|
29
|
+
* try {
|
|
30
|
+
* await api.get("/api/device/status", { timeout: 3000 });
|
|
31
|
+
* } catch (error) {
|
|
32
|
+
* if (isTransportNotReadyError(error)) {
|
|
33
|
+
* // websocket is down — show the offline UI
|
|
34
|
+
* }
|
|
35
|
+
* }
|
|
36
|
+
* ```
|
|
37
|
+
*
|
|
38
|
+
* @category Service Request
|
|
39
|
+
* @kosService core.fetch
|
|
40
|
+
* @kosApiLevel 23
|
|
41
|
+
*/
|
|
42
|
+
export declare class TransportNotReadyError extends Error {
|
|
43
|
+
/** Stable discriminator; see {@link TRANSPORT_NOT_READY}. */
|
|
44
|
+
readonly code = "TRANSPORT_NOT_READY";
|
|
45
|
+
/**
|
|
46
|
+
* The budget, in milliseconds, that expired while waiting. `undefined` when
|
|
47
|
+
* the wait was cut short by a caller-supplied timeout signal rather than by
|
|
48
|
+
* the request's own budget.
|
|
49
|
+
*/
|
|
50
|
+
readonly timeout?: number;
|
|
51
|
+
/** The URL of the request that was never sent. */
|
|
52
|
+
readonly url?: string;
|
|
53
|
+
constructor(details?: {
|
|
54
|
+
timeout?: number;
|
|
55
|
+
url?: string;
|
|
56
|
+
});
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Type guard for {@link TransportNotReadyError} that works across bundle
|
|
60
|
+
* boundaries by checking the `code` discriminator rather than the prototype.
|
|
61
|
+
*
|
|
62
|
+
* @category Service Request
|
|
63
|
+
* @kosService core.fetch
|
|
64
|
+
* @kosApiLevel 23
|
|
65
|
+
*/
|
|
66
|
+
export declare const isTransportNotReadyError: (error: unknown) => error is TransportNotReadyError;
|
|
67
|
+
//# sourceMappingURL=transport-not-ready-error.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"transport-not-ready-error.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ui-sdk/src/core/util/transport-not-ready-error.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,mBAAmB,wBAAwB,CAAC;AAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,sBAAuB,SAAQ,KAAK;IAC/C,6DAA6D;IAC7D,QAAQ,CAAC,IAAI,yBAAuB;IAEpC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAE1B,kDAAkD;IAClD,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;gBAEV,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAO;CAU7D;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,GACnC,OAAO,OAAO,KACb,KAAK,IAAI,sBAC+D,CAAC"}
|