@grabjs/superapp-sdk 2.0.0-beta.51 → 2.0.0-beta.54
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 +3 -3
- package/api-reference/api.json +36226 -23720
- package/dist/index.d.ts +934 -185
- package/dist/index.esm.js +1 -1
- package/dist/index.js +1 -1
- package/package.json +1 -2
- package/skills/SKILL.md +46 -44
package/dist/index.d.ts
CHANGED
|
@@ -5,6 +5,9 @@ import * as v from 'valibot';
|
|
|
5
5
|
/**
|
|
6
6
|
* Request parameters for initiating an OAuth2 authorization flow with PKCE.
|
|
7
7
|
*
|
|
8
|
+
* @group Modules
|
|
9
|
+
* @category Identity
|
|
10
|
+
*
|
|
8
11
|
* @example
|
|
9
12
|
* **Production environment with redirect mode:**
|
|
10
13
|
* ```typescript
|
|
@@ -36,6 +39,9 @@ export declare type AuthorizeRequest = InferOutput<typeof AuthorizeRequestSchema
|
|
|
36
39
|
/**
|
|
37
40
|
* Valibot schema for {@link AuthorizeRequest}.
|
|
38
41
|
*
|
|
42
|
+
* @group Modules
|
|
43
|
+
* @category Identity
|
|
44
|
+
*
|
|
39
45
|
* @public
|
|
40
46
|
*/
|
|
41
47
|
export declare const AuthorizeRequestSchema: v.ObjectSchema<{
|
|
@@ -49,6 +55,9 @@ export declare const AuthorizeRequestSchema: v.ObjectSchema<{
|
|
|
49
55
|
/**
|
|
50
56
|
* Response when initiating an authorization flow.
|
|
51
57
|
*
|
|
58
|
+
* @group Modules
|
|
59
|
+
* @category Identity
|
|
60
|
+
*
|
|
52
61
|
* @remarks
|
|
53
62
|
* This response can have the following status codes:
|
|
54
63
|
* - `200`: Authorization completed successfully (native in_place flow). The `result` contains the authorization code, state, and PKCE artifacts (`codeVerifier`, `nonce`, `redirectUri`).
|
|
@@ -66,6 +75,9 @@ export declare type AuthorizeResponse = InferOutput<typeof AuthorizeResponseSche
|
|
|
66
75
|
/**
|
|
67
76
|
* Valibot schema for {@link AuthorizeResponse}.
|
|
68
77
|
*
|
|
78
|
+
* @group Modules
|
|
79
|
+
* @category Identity
|
|
80
|
+
*
|
|
69
81
|
* @public
|
|
70
82
|
*/
|
|
71
83
|
export declare const AuthorizeResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -99,6 +111,9 @@ export declare const AuthorizeResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
99
111
|
* Result object for the authorization flow.
|
|
100
112
|
* Contains the authorization code, state, and PKCE artifacts when native in_place flow completes successfully.
|
|
101
113
|
*
|
|
114
|
+
* @group Modules
|
|
115
|
+
* @category Identity
|
|
116
|
+
*
|
|
102
117
|
* @example
|
|
103
118
|
* ```typescript
|
|
104
119
|
* {
|
|
@@ -117,6 +132,9 @@ export declare type AuthorizeResult = InferOutput<typeof AuthorizeResultSchema>;
|
|
|
117
132
|
/**
|
|
118
133
|
* Valibot schema for {@link AuthorizeResult}.
|
|
119
134
|
*
|
|
135
|
+
* @group Modules
|
|
136
|
+
* @category Identity
|
|
137
|
+
*
|
|
120
138
|
* @public
|
|
121
139
|
*/
|
|
122
140
|
export declare const AuthorizeResultSchema: v.ObjectSchema<{
|
|
@@ -130,6 +148,9 @@ export declare const AuthorizeResultSchema: v.ObjectSchema<{
|
|
|
130
148
|
/**
|
|
131
149
|
* Response when triggering platform back navigation.
|
|
132
150
|
*
|
|
151
|
+
* @group Modules
|
|
152
|
+
* @category Platform
|
|
153
|
+
*
|
|
133
154
|
* @remarks
|
|
134
155
|
* This response can have the following status codes:
|
|
135
156
|
* - `204`: Back navigation triggered successfully.
|
|
@@ -143,6 +164,9 @@ export declare type BackResponse = InferOutput<typeof BackResponseSchema>;
|
|
|
143
164
|
/**
|
|
144
165
|
* Valibot schema for {@link BackResponse}.
|
|
145
166
|
*
|
|
167
|
+
* @group Modules
|
|
168
|
+
* @category Platform
|
|
169
|
+
*
|
|
146
170
|
* @public
|
|
147
171
|
*/
|
|
148
172
|
export declare const BackResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -159,32 +183,37 @@ export declare const BackResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
159
183
|
* Result when triggering platform back navigation.
|
|
160
184
|
* This operation returns no data on success.
|
|
161
185
|
*
|
|
186
|
+
* @group Modules
|
|
187
|
+
* @category Platform
|
|
188
|
+
*
|
|
162
189
|
* @public
|
|
163
190
|
*/
|
|
164
191
|
export declare type BackResult = void;
|
|
165
192
|
|
|
166
193
|
/**
|
|
167
|
-
* Base class for all
|
|
194
|
+
* Base class for all modules.
|
|
195
|
+
*
|
|
196
|
+
* @group Core
|
|
168
197
|
*
|
|
169
198
|
* @remarks
|
|
170
|
-
* On construction, the class wraps the
|
|
199
|
+
* On construction, the class wraps the module on `window` (e.g., `WrappedContainerModule`).
|
|
171
200
|
* This code must run on the Grab SuperApp's webview to function correctly.
|
|
172
201
|
*
|
|
173
202
|
* @public
|
|
174
203
|
*/
|
|
175
204
|
export declare class BaseModule {
|
|
176
205
|
/**
|
|
177
|
-
* The module name
|
|
206
|
+
* The module name.
|
|
178
207
|
*/
|
|
179
208
|
private readonly name;
|
|
180
209
|
/**
|
|
181
|
-
* Logger scoped to this module
|
|
210
|
+
* Logger scoped to this module.
|
|
182
211
|
*
|
|
183
212
|
* @protected
|
|
184
213
|
*/
|
|
185
214
|
protected readonly logger: Logger;
|
|
186
215
|
/**
|
|
187
|
-
* Returns the wrapped
|
|
216
|
+
* Returns the wrapped module from the global `window` object.
|
|
188
217
|
*
|
|
189
218
|
* @returns The wrapped module instance with native method bindings.
|
|
190
219
|
*
|
|
@@ -195,7 +224,7 @@ export declare class BaseModule {
|
|
|
195
224
|
* Creates a new module instance and wraps it on the global `window` object.
|
|
196
225
|
*
|
|
197
226
|
* @param moduleName - The name of the module (e.g., "ContainerModule", "ProfileModule").
|
|
198
|
-
* @throws Error when the
|
|
227
|
+
* @throws Error when the module fails to initialize.
|
|
199
228
|
*/
|
|
200
229
|
constructor(moduleName: string);
|
|
201
230
|
/**
|
|
@@ -212,10 +241,9 @@ export declare class BaseModule {
|
|
|
212
241
|
* Checks whether the current app version supports this method.
|
|
213
242
|
*
|
|
214
243
|
* @remarks
|
|
215
|
-
* Returns 501 if not running in the Grab app, 426 if the version check fails,
|
|
216
|
-
* or `null` if the method is supported.
|
|
244
|
+
* Returns `501` status code if not running in the Grab app, `426` status code if the version check fails. Otherwise, returns `null`.
|
|
217
245
|
*
|
|
218
|
-
* @param isSupported - A function receiving the detected app info, returning true if supported.
|
|
246
|
+
* @param isSupported - A function receiving the detected app info, returning `true` if supported.
|
|
219
247
|
* @returns An error response, or `null` if supported.
|
|
220
248
|
*
|
|
221
249
|
* @protected
|
|
@@ -228,112 +256,47 @@ export declare class BaseModule {
|
|
|
228
256
|
error: string;
|
|
229
257
|
} | null;
|
|
230
258
|
/**
|
|
231
|
-
* Invokes a
|
|
259
|
+
* Invokes a method.
|
|
232
260
|
*
|
|
233
261
|
* @remarks
|
|
234
|
-
* - Always checks if running in Grab app (returns 501 if not).
|
|
262
|
+
* - Always checks if running in Grab app (returns `501` status code if not).
|
|
235
263
|
* - All errors are reported via the `status_code` field; this method never rejects.
|
|
236
|
-
* - For streaming methods, use `invokeStream` instead.
|
|
237
264
|
*
|
|
238
265
|
* @param options - The invoke options including method name and params.
|
|
239
|
-
* @returns A promise resolving to the
|
|
266
|
+
* @returns A promise resolving to the SDK response.
|
|
240
267
|
*
|
|
241
268
|
* @protected
|
|
242
269
|
*/
|
|
243
|
-
protected invoke(options:
|
|
270
|
+
protected invoke(options: ModuleInvokeOptions): Promise<SDKResponse>;
|
|
244
271
|
/**
|
|
245
|
-
* Creates a
|
|
246
|
-
* Used for 501, 426, and 500 error scenarios in invokeStream.
|
|
272
|
+
* Creates a {@link SDKStream} that immediately emits an error response.
|
|
247
273
|
*
|
|
248
|
-
* @returns A
|
|
274
|
+
* @returns A {@link SDKStream} that immediately emits an error response.
|
|
249
275
|
*
|
|
250
276
|
* @private
|
|
251
277
|
*/
|
|
252
278
|
private createErrorStream;
|
|
253
279
|
/**
|
|
254
|
-
* Invokes a
|
|
280
|
+
* Invokes a streaming method that returns a {@link SDKStream}.
|
|
255
281
|
*
|
|
256
282
|
* @remarks
|
|
257
|
-
* - Always checks if running in Grab app (returns 501
|
|
258
|
-
* - Returns a
|
|
283
|
+
* - Always checks if running in Grab app (returns `501` status code if not).
|
|
284
|
+
* - Returns a {@link SDKStream} that can be subscribed to or awaited for the first value.
|
|
259
285
|
* - All errors are reported via error responses in the stream; this method never rejects.
|
|
260
286
|
*
|
|
261
287
|
* @param options - The invoke options including method name and params.
|
|
262
|
-
* @returns A
|
|
288
|
+
* @returns A {@link SDKStream} for receiving continuous data.
|
|
263
289
|
*
|
|
264
290
|
* @protected
|
|
265
291
|
*/
|
|
266
|
-
protected invokeStream(options:
|
|
292
|
+
protected invokeStream(options: ModuleInvokeOptions): SDKStream;
|
|
267
293
|
}
|
|
268
294
|
|
|
269
295
|
/**
|
|
270
|
-
*
|
|
271
|
-
*
|
|
272
|
-
* @remarks
|
|
273
|
-
* Every response has a numeric `status_code`. Success responses (200) carry `result`;
|
|
274
|
-
* error responses (4xx/5xx) carry `error`. Use the type guards ({@link isSuccess},
|
|
275
|
-
* {@link isError}, etc.) to narrow to a specific shape.
|
|
276
|
-
*
|
|
277
|
-
* Per-module response types (e.g., `ScanQRCodeResponse`) are derived from their valibot
|
|
278
|
-
* schemas via `v.InferOutput` and form proper discriminated unions — enabling precise
|
|
279
|
-
* TypeScript narrowing while this base type serves as the internal contract.
|
|
280
|
-
*
|
|
281
|
-
* @public
|
|
282
|
-
*/
|
|
283
|
-
export declare type BridgeResponse = {
|
|
284
|
-
/** HTTP-style status code indicating the outcome of the JSBridge method call */
|
|
285
|
-
status_code: number;
|
|
286
|
-
/** The result data from the JSBridge method, present on 200 responses */
|
|
287
|
-
result?: unknown;
|
|
288
|
-
/** Error message, present on 4xx/5xx responses */
|
|
289
|
-
error?: string;
|
|
290
|
-
};
|
|
291
|
-
|
|
292
|
-
/**
|
|
293
|
-
* A stream for receiving continuous data from JSBridge methods (e.g., location updates).
|
|
294
|
-
*
|
|
295
|
-
* @remarks
|
|
296
|
-
* Provides both Observable-like and Promise-like interfaces:
|
|
297
|
-
* - Use `subscribe()` to receive all values over time
|
|
298
|
-
* - Use `then()` or `await` to receive only the first value
|
|
299
|
-
*
|
|
300
|
-
* Note: Each `subscribe()` call creates a fresh subscription, allowing multiple independent listeners.
|
|
301
|
-
*
|
|
302
|
-
* @typeParam T - The response type emitted by the stream.
|
|
303
|
-
*
|
|
304
|
-
* @public
|
|
305
|
-
*/
|
|
306
|
-
export declare type BridgeStream<T extends BridgeResponse = BridgeResponse> = Readonly<{
|
|
307
|
-
/**
|
|
308
|
-
* Subscribe to receive stream data.
|
|
309
|
-
*
|
|
310
|
-
* @param handlers - Optional callbacks for data (`next`) and completion (`complete`).
|
|
311
|
-
* @returns A `Subscription` to terminate the stream when needed.
|
|
312
|
-
*/
|
|
313
|
-
subscribe: (handlers?: BridgeStreamHandlers<T>) => Subscription;
|
|
314
|
-
}> & PromiseLike<T>;
|
|
315
|
-
|
|
316
|
-
/**
|
|
317
|
-
* Callbacks for handling stream events.
|
|
318
|
-
*
|
|
319
|
-
* @remarks
|
|
320
|
-
* Pass these to `subscribe()` to receive data via `next` and completion via `complete`.
|
|
321
|
-
*
|
|
322
|
-
* @typeParam T - The response type emitted by the stream.
|
|
323
|
-
*
|
|
324
|
-
* @public
|
|
325
|
-
*/
|
|
326
|
-
export declare type BridgeStreamHandlers<T extends BridgeResponse = BridgeResponse> = Readonly<{
|
|
327
|
-
/** Called with each new value from the stream. */
|
|
328
|
-
next?: (data: T) => unknown;
|
|
329
|
-
/** Called when the stream ends and no more data will arrive. */
|
|
330
|
-
complete?: () => unknown;
|
|
331
|
-
}>;
|
|
332
|
-
|
|
333
|
-
/**
|
|
334
|
-
* JSBridge module for accessing the device camera.
|
|
296
|
+
* SDK module for accessing the device camera via `JSBridge`.
|
|
335
297
|
*
|
|
336
298
|
* @group Modules
|
|
299
|
+
* @category Camera
|
|
337
300
|
*
|
|
338
301
|
* @remarks
|
|
339
302
|
* Provides access to native camera functionality including QR code scanning.
|
|
@@ -375,7 +338,7 @@ export declare class CameraModule extends BaseModule {
|
|
|
375
338
|
* // Initialize the camera module
|
|
376
339
|
* const camera = new CameraModule();
|
|
377
340
|
*
|
|
378
|
-
* // Scan
|
|
341
|
+
* // Scan a QR code
|
|
379
342
|
* const response = await camera.scanQRCode({ title: 'Scan Payment QR' });
|
|
380
343
|
*
|
|
381
344
|
* // Handle the response
|
|
@@ -407,9 +370,10 @@ export declare class CameraModule extends BaseModule {
|
|
|
407
370
|
}
|
|
408
371
|
|
|
409
372
|
/**
|
|
410
|
-
*
|
|
373
|
+
* SDK module for triggering native payment flows via `JSBridge`.
|
|
411
374
|
*
|
|
412
375
|
* @group Modules
|
|
376
|
+
* @category Checkout
|
|
413
377
|
*
|
|
414
378
|
* @remarks
|
|
415
379
|
* Invokes the native Grab checkout/pay component to process payments.
|
|
@@ -501,8 +465,11 @@ export declare class CheckoutModule extends BaseModule {
|
|
|
501
465
|
/**
|
|
502
466
|
* Response when clearing stored authorization artifacts.
|
|
503
467
|
*
|
|
468
|
+
* @group Modules
|
|
469
|
+
* @category Identity
|
|
470
|
+
*
|
|
504
471
|
* @remarks
|
|
505
|
-
* This response returns status code `204` when artifacts are successfully
|
|
472
|
+
* This response returns status code `204` when artifacts are cleared successfully.
|
|
506
473
|
*
|
|
507
474
|
* @public
|
|
508
475
|
*/
|
|
@@ -511,6 +478,9 @@ export declare type ClearAuthorizationArtifactsResponse = InferOutput<typeof Cle
|
|
|
511
478
|
/**
|
|
512
479
|
* Valibot schema for {@link ClearAuthorizationArtifactsResponse}.
|
|
513
480
|
*
|
|
481
|
+
* @group Modules
|
|
482
|
+
* @category Identity
|
|
483
|
+
*
|
|
514
484
|
* @public
|
|
515
485
|
*/
|
|
516
486
|
export declare const ClearAuthorizationArtifactsResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -521,6 +491,9 @@ export declare const ClearAuthorizationArtifactsResponseSchema: v.UnionSchema<[v
|
|
|
521
491
|
* Result object for clearing authorization artifacts.
|
|
522
492
|
* This operation returns no data on success.
|
|
523
493
|
*
|
|
494
|
+
* @group Modules
|
|
495
|
+
* @category Identity
|
|
496
|
+
*
|
|
524
497
|
* @public
|
|
525
498
|
*/
|
|
526
499
|
export declare type ClearAuthorizationArtifactsResult = void;
|
|
@@ -528,6 +501,9 @@ export declare type ClearAuthorizationArtifactsResult = void;
|
|
|
528
501
|
/**
|
|
529
502
|
* Response when closing the container.
|
|
530
503
|
*
|
|
504
|
+
* @group Modules
|
|
505
|
+
* @category Container
|
|
506
|
+
*
|
|
531
507
|
* @remarks
|
|
532
508
|
* This response can have the following status codes:
|
|
533
509
|
* - `204`: Container closed successfully.
|
|
@@ -541,6 +517,9 @@ export declare type CloseResponse = InferOutput<typeof CloseResponseSchema>;
|
|
|
541
517
|
/**
|
|
542
518
|
* Valibot schema for {@link CloseResponse}.
|
|
543
519
|
*
|
|
520
|
+
* @group Modules
|
|
521
|
+
* @category Container
|
|
522
|
+
*
|
|
544
523
|
* @public
|
|
545
524
|
*/
|
|
546
525
|
export declare const CloseResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -557,6 +536,9 @@ export declare const CloseResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
557
536
|
* Result when closing the container.
|
|
558
537
|
* This operation returns no data on success.
|
|
559
538
|
*
|
|
539
|
+
* @group Modules
|
|
540
|
+
* @category Container
|
|
541
|
+
*
|
|
560
542
|
* @public
|
|
561
543
|
*/
|
|
562
544
|
export declare type CloseResult = void;
|
|
@@ -564,6 +546,9 @@ export declare type CloseResult = void;
|
|
|
564
546
|
/**
|
|
565
547
|
* Constants for container analytics event data.
|
|
566
548
|
*
|
|
549
|
+
* @group Modules
|
|
550
|
+
* @category Container
|
|
551
|
+
*
|
|
567
552
|
* @public
|
|
568
553
|
*/
|
|
569
554
|
export declare const ContainerAnalyticsEventData: {
|
|
@@ -575,6 +560,9 @@ export declare const ContainerAnalyticsEventData: {
|
|
|
575
560
|
/**
|
|
576
561
|
* Constants for container analytics event names.
|
|
577
562
|
*
|
|
563
|
+
* @group Modules
|
|
564
|
+
* @category Container
|
|
565
|
+
*
|
|
578
566
|
* @public
|
|
579
567
|
*/
|
|
580
568
|
export declare const ContainerAnalyticsEventName: {
|
|
@@ -584,6 +572,9 @@ export declare const ContainerAnalyticsEventName: {
|
|
|
584
572
|
/**
|
|
585
573
|
* Constants for container analytics event states.
|
|
586
574
|
*
|
|
575
|
+
* @group Modules
|
|
576
|
+
* @category Container
|
|
577
|
+
*
|
|
587
578
|
* @public
|
|
588
579
|
*/
|
|
589
580
|
export declare const ContainerAnalyticsEventState: {
|
|
@@ -594,9 +585,10 @@ export declare const ContainerAnalyticsEventState: {
|
|
|
594
585
|
};
|
|
595
586
|
|
|
596
587
|
/**
|
|
597
|
-
*
|
|
588
|
+
* SDK module for controlling the WebView container via `JSBridge`.
|
|
598
589
|
*
|
|
599
590
|
* @group Modules
|
|
591
|
+
* @category Container
|
|
600
592
|
*
|
|
601
593
|
* @remarks
|
|
602
594
|
* Provides methods to interact with the WebView container.
|
|
@@ -1038,7 +1030,7 @@ export declare class ContainerModule extends BaseModule {
|
|
|
1038
1030
|
*/
|
|
1039
1031
|
sendAnalyticsEvent(request: SendAnalyticsEventRequest): Promise<SendAnalyticsEventResponse>;
|
|
1040
1032
|
/**
|
|
1041
|
-
* Check if the web app is connected to the Grab SuperApp via JSBridge
|
|
1033
|
+
* Check if the web app is connected to the Grab SuperApp via `JSBridge`.
|
|
1042
1034
|
*
|
|
1043
1035
|
* @remarks
|
|
1044
1036
|
* Call this method to verify the connection status before using other features.
|
|
@@ -1111,9 +1103,10 @@ export declare class ContainerModule extends BaseModule {
|
|
|
1111
1103
|
}
|
|
1112
1104
|
|
|
1113
1105
|
/**
|
|
1114
|
-
*
|
|
1106
|
+
* SDK module for querying native device information via `JSBridge`.
|
|
1115
1107
|
*
|
|
1116
1108
|
* @group Modules
|
|
1109
|
+
* @category Device
|
|
1117
1110
|
*
|
|
1118
1111
|
* @remarks
|
|
1119
1112
|
* Provides access to device checks exposed by the native Grab app bridge.
|
|
@@ -1190,12 +1183,15 @@ export declare class DeviceModule extends BaseModule {
|
|
|
1190
1183
|
/**
|
|
1191
1184
|
* Response when dismissing the splash screen.
|
|
1192
1185
|
*
|
|
1186
|
+
* @group Modules
|
|
1187
|
+
* @category Splash Screen
|
|
1188
|
+
*
|
|
1193
1189
|
* @remarks
|
|
1194
1190
|
* Possible status codes:
|
|
1195
1191
|
* - `204`: No splash screen shown, or it was closed successfully.
|
|
1196
1192
|
* - `400`: Invalid input (Grablet / client validation error).
|
|
1197
1193
|
* - `403`: Missing consent for the required OAuth scope.
|
|
1198
|
-
* - `500`: Unexpected error while invoking
|
|
1194
|
+
* - `500`: Unexpected error while invoking `JSBridge`.
|
|
1199
1195
|
* - `501`: Not in the Grab app WebView environment.
|
|
1200
1196
|
*
|
|
1201
1197
|
* @example
|
|
@@ -1229,6 +1225,9 @@ export declare type DismissSplashScreenResponse = InferOutput<typeof DismissSpla
|
|
|
1229
1225
|
/**
|
|
1230
1226
|
* Valibot schema for {@link DismissSplashScreenResponse}.
|
|
1231
1227
|
*
|
|
1228
|
+
* @group Modules
|
|
1229
|
+
* @category Splash Screen
|
|
1230
|
+
*
|
|
1232
1231
|
* @public
|
|
1233
1232
|
*/
|
|
1234
1233
|
export declare const DismissSplashScreenResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -1248,7 +1247,10 @@ export declare const DismissSplashScreenResponseSchema: v.UnionSchema<[v.ObjectS
|
|
|
1248
1247
|
}, undefined>], undefined>;
|
|
1249
1248
|
|
|
1250
1249
|
/**
|
|
1251
|
-
* Request parameters for downloading a file
|
|
1250
|
+
* Request parameters for downloading a file through `JSBridge`.
|
|
1251
|
+
*
|
|
1252
|
+
* @group Modules
|
|
1253
|
+
* @category File
|
|
1252
1254
|
*
|
|
1253
1255
|
* @example
|
|
1254
1256
|
* ```typescript
|
|
@@ -1265,6 +1267,9 @@ export declare type DownloadFileRequest = InferOutput<typeof DownloadFileRequest
|
|
|
1265
1267
|
/**
|
|
1266
1268
|
* Valibot schema for {@link DownloadFileRequest}.
|
|
1267
1269
|
*
|
|
1270
|
+
* @group Modules
|
|
1271
|
+
* @category File
|
|
1272
|
+
*
|
|
1268
1273
|
* @public
|
|
1269
1274
|
*/
|
|
1270
1275
|
export declare const DownloadFileRequestSchema: v.ObjectSchema<{
|
|
@@ -1275,6 +1280,9 @@ export declare const DownloadFileRequestSchema: v.ObjectSchema<{
|
|
|
1275
1280
|
/**
|
|
1276
1281
|
* Response when requesting a native file download.
|
|
1277
1282
|
*
|
|
1283
|
+
* @group Modules
|
|
1284
|
+
* @category File
|
|
1285
|
+
*
|
|
1278
1286
|
* @remarks
|
|
1279
1287
|
* This response can have the following status codes:
|
|
1280
1288
|
* - `204`: File downloaded successfully.
|
|
@@ -1289,6 +1297,9 @@ export declare type DownloadFileResponse = InferOutput<typeof DownloadFileRespon
|
|
|
1289
1297
|
/**
|
|
1290
1298
|
* Valibot schema for {@link DownloadFileResponse}.
|
|
1291
1299
|
*
|
|
1300
|
+
* @group Modules
|
|
1301
|
+
* @category File
|
|
1302
|
+
*
|
|
1292
1303
|
* @public
|
|
1293
1304
|
*/
|
|
1294
1305
|
export declare const DownloadFileResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -1307,8 +1318,11 @@ export declare const DownloadFileResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
1307
1318
|
/**
|
|
1308
1319
|
* Result data structure for file download operations.
|
|
1309
1320
|
*
|
|
1321
|
+
* @group Modules
|
|
1322
|
+
* @category File
|
|
1323
|
+
*
|
|
1310
1324
|
* @remarks
|
|
1311
|
-
* This is a void result type as successful downloads return status code 204 with no content.
|
|
1325
|
+
* This is a void result type as successful downloads return status code `204` with no content.
|
|
1312
1326
|
*
|
|
1313
1327
|
* @public
|
|
1314
1328
|
*/
|
|
@@ -1317,6 +1331,9 @@ export declare type DownloadFileResult = void;
|
|
|
1317
1331
|
/**
|
|
1318
1332
|
* DRM content configuration for playback.
|
|
1319
1333
|
*
|
|
1334
|
+
* @group Modules
|
|
1335
|
+
* @category Media
|
|
1336
|
+
*
|
|
1320
1337
|
* @remarks
|
|
1321
1338
|
* Configuration object containing DRM license information, content URLs, and playback settings.
|
|
1322
1339
|
* The exact structure depends on the DRM provider (e.g., FairPlay, Widevine).
|
|
@@ -1350,6 +1367,9 @@ export declare type DRMContentConfig = Record<string, unknown>;
|
|
|
1350
1367
|
/**
|
|
1351
1368
|
* Result object for DRM playback events.
|
|
1352
1369
|
*
|
|
1370
|
+
* @group Modules
|
|
1371
|
+
* @category Media
|
|
1372
|
+
*
|
|
1353
1373
|
* @example
|
|
1354
1374
|
* **Playback started event:**
|
|
1355
1375
|
* ```typescript
|
|
@@ -1390,6 +1410,9 @@ export declare type DRMPlaybackEvent = InferOutput<typeof DRMPlaybackEventSchema
|
|
|
1390
1410
|
/**
|
|
1391
1411
|
* Valibot schema for {@link DRMPlaybackEvent}.
|
|
1392
1412
|
*
|
|
1413
|
+
* @group Modules
|
|
1414
|
+
* @category Media
|
|
1415
|
+
*
|
|
1393
1416
|
* @public
|
|
1394
1417
|
*/
|
|
1395
1418
|
export declare const DRMPlaybackEventSchema: v.ObjectSchema<{
|
|
@@ -1402,6 +1425,9 @@ export declare const DRMPlaybackEventSchema: v.ObjectSchema<{
|
|
|
1402
1425
|
/**
|
|
1403
1426
|
* Response when fetching the user's email.
|
|
1404
1427
|
*
|
|
1428
|
+
* @group Modules
|
|
1429
|
+
* @category Profile
|
|
1430
|
+
*
|
|
1405
1431
|
* @remarks
|
|
1406
1432
|
* This response can have the following status codes:
|
|
1407
1433
|
* - `200`: Email fetched successfully. The `result` contains the email address.
|
|
@@ -1419,6 +1445,9 @@ export declare type FetchEmailResponse = InferOutput<typeof FetchEmailResponseSc
|
|
|
1419
1445
|
/**
|
|
1420
1446
|
* Valibot schema for {@link FetchEmailResponse}.
|
|
1421
1447
|
*
|
|
1448
|
+
* @group Modules
|
|
1449
|
+
* @category Profile
|
|
1450
|
+
*
|
|
1422
1451
|
* @public
|
|
1423
1452
|
*/
|
|
1424
1453
|
export declare const FetchEmailResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -1448,6 +1477,9 @@ export declare const FetchEmailResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
1448
1477
|
/**
|
|
1449
1478
|
* Result object containing the user's email address.
|
|
1450
1479
|
*
|
|
1480
|
+
* @group Modules
|
|
1481
|
+
* @category Profile
|
|
1482
|
+
*
|
|
1451
1483
|
* @example
|
|
1452
1484
|
* ```typescript
|
|
1453
1485
|
* { email: 'user@example.com' }
|
|
@@ -1460,6 +1492,9 @@ export declare type FetchEmailResult = InferOutput<typeof FetchEmailResultSchema
|
|
|
1460
1492
|
/**
|
|
1461
1493
|
* Valibot schema for {@link FetchEmailResult}.
|
|
1462
1494
|
*
|
|
1495
|
+
* @group Modules
|
|
1496
|
+
* @category Profile
|
|
1497
|
+
*
|
|
1463
1498
|
* @public
|
|
1464
1499
|
*/
|
|
1465
1500
|
export declare const FetchEmailResultSchema: v.ObjectSchema<{
|
|
@@ -1467,9 +1502,10 @@ export declare const FetchEmailResultSchema: v.ObjectSchema<{
|
|
|
1467
1502
|
}, undefined>;
|
|
1468
1503
|
|
|
1469
1504
|
/**
|
|
1470
|
-
*
|
|
1505
|
+
* SDK module for downloading files to the user's device via `JSBridge`.
|
|
1471
1506
|
*
|
|
1472
1507
|
* @group Modules
|
|
1508
|
+
* @category File
|
|
1473
1509
|
*
|
|
1474
1510
|
* @remarks
|
|
1475
1511
|
* Initiates native file download handling in the Grab app using a file URL and file name.
|
|
@@ -1497,7 +1533,7 @@ export declare const FetchEmailResultSchema: v.ObjectSchema<{
|
|
|
1497
1533
|
export declare class FileModule extends BaseModule {
|
|
1498
1534
|
constructor();
|
|
1499
1535
|
/**
|
|
1500
|
-
* Downloads a file
|
|
1536
|
+
* Downloads a file through `JSBridge`.
|
|
1501
1537
|
*
|
|
1502
1538
|
* @param request - File information, including URL and target file name. See {@link DownloadFileRequest}.
|
|
1503
1539
|
*
|
|
@@ -1535,6 +1571,9 @@ export declare class FileModule extends BaseModule {
|
|
|
1535
1571
|
/**
|
|
1536
1572
|
* Response when retrieving stored authorization artifacts.
|
|
1537
1573
|
*
|
|
1574
|
+
* @group Modules
|
|
1575
|
+
* @category Identity
|
|
1576
|
+
*
|
|
1538
1577
|
* @remarks
|
|
1539
1578
|
* This response can have the following status codes:
|
|
1540
1579
|
* - `200`: All artifacts present. The `result` contains the PKCE artifacts needed for token exchange.
|
|
@@ -1548,6 +1587,9 @@ export declare type GetAuthorizationArtifactsResponse = InferOutput<typeof GetAu
|
|
|
1548
1587
|
/**
|
|
1549
1588
|
* Valibot schema for {@link GetAuthorizationArtifactsResponse}.
|
|
1550
1589
|
*
|
|
1590
|
+
* @group Modules
|
|
1591
|
+
* @category Identity
|
|
1592
|
+
*
|
|
1551
1593
|
* @public
|
|
1552
1594
|
*/
|
|
1553
1595
|
export declare const GetAuthorizationArtifactsResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -1569,6 +1611,9 @@ export declare const GetAuthorizationArtifactsResponseSchema: v.UnionSchema<[v.O
|
|
|
1569
1611
|
* Result object containing the stored PKCE authorization artifacts.
|
|
1570
1612
|
* These are used to complete the OAuth2 authorization code exchange.
|
|
1571
1613
|
*
|
|
1614
|
+
* @group Modules
|
|
1615
|
+
* @category Identity
|
|
1616
|
+
*
|
|
1572
1617
|
* @example
|
|
1573
1618
|
* **All artifacts present:**
|
|
1574
1619
|
* ```typescript
|
|
@@ -1587,6 +1632,9 @@ export declare type GetAuthorizationArtifactsResult = InferOutput<typeof GetAuth
|
|
|
1587
1632
|
/**
|
|
1588
1633
|
* Valibot schema for {@link GetAuthorizationArtifactsResult}.
|
|
1589
1634
|
*
|
|
1635
|
+
* @group Modules
|
|
1636
|
+
* @category Identity
|
|
1637
|
+
*
|
|
1590
1638
|
* @public
|
|
1591
1639
|
*/
|
|
1592
1640
|
export declare const GetAuthorizationArtifactsResultSchema: v.ObjectSchema<{
|
|
@@ -1599,6 +1647,9 @@ export declare const GetAuthorizationArtifactsResultSchema: v.ObjectSchema<{
|
|
|
1599
1647
|
/**
|
|
1600
1648
|
* Request parameters for getting a boolean value from storage.
|
|
1601
1649
|
*
|
|
1650
|
+
* @group Modules
|
|
1651
|
+
* @category Storage
|
|
1652
|
+
*
|
|
1602
1653
|
* @example
|
|
1603
1654
|
* ```typescript
|
|
1604
1655
|
* { key: 'isDarkMode' }
|
|
@@ -1611,6 +1662,9 @@ export declare type GetBooleanRequest = InferOutput<typeof GetBooleanRequestSche
|
|
|
1611
1662
|
/**
|
|
1612
1663
|
* Valibot schema for {@link GetBooleanRequest}.
|
|
1613
1664
|
*
|
|
1665
|
+
* @group Modules
|
|
1666
|
+
* @category Storage
|
|
1667
|
+
*
|
|
1614
1668
|
* @public
|
|
1615
1669
|
*/
|
|
1616
1670
|
export declare const GetBooleanRequestSchema: v.ObjectSchema<{
|
|
@@ -1620,6 +1674,9 @@ export declare const GetBooleanRequestSchema: v.ObjectSchema<{
|
|
|
1620
1674
|
/**
|
|
1621
1675
|
* Response when getting a boolean value.
|
|
1622
1676
|
*
|
|
1677
|
+
* @group Modules
|
|
1678
|
+
* @category Storage
|
|
1679
|
+
*
|
|
1623
1680
|
* @remarks
|
|
1624
1681
|
* This response can have the following status codes:
|
|
1625
1682
|
* - `200`: Value retrieved successfully. The `result` contains the boolean value.
|
|
@@ -1636,6 +1693,9 @@ export declare type GetBooleanResponse = InferOutput<typeof GetBooleanResponseSc
|
|
|
1636
1693
|
/**
|
|
1637
1694
|
* Valibot schema for {@link GetBooleanResponse}.
|
|
1638
1695
|
*
|
|
1696
|
+
* @group Modules
|
|
1697
|
+
* @category Storage
|
|
1698
|
+
*
|
|
1639
1699
|
* @public
|
|
1640
1700
|
*/
|
|
1641
1701
|
export declare const GetBooleanResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -1660,6 +1720,9 @@ export declare const GetBooleanResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
1660
1720
|
/**
|
|
1661
1721
|
* The boolean value returned when a key exists in storage.
|
|
1662
1722
|
*
|
|
1723
|
+
* @group Modules
|
|
1724
|
+
* @category Storage
|
|
1725
|
+
*
|
|
1663
1726
|
* @remarks
|
|
1664
1727
|
* When the key has no stored value, the response `status_code` is `204` instead.
|
|
1665
1728
|
*
|
|
@@ -1675,6 +1738,9 @@ export declare type GetBooleanResult = InferOutput<typeof GetBooleanResultSchema
|
|
|
1675
1738
|
/**
|
|
1676
1739
|
* Valibot schema for {@link GetBooleanResult}.
|
|
1677
1740
|
*
|
|
1741
|
+
* @group Modules
|
|
1742
|
+
* @category Storage
|
|
1743
|
+
*
|
|
1678
1744
|
* @public
|
|
1679
1745
|
*/
|
|
1680
1746
|
export declare const GetBooleanResultSchema: v.BooleanSchema<undefined>;
|
|
@@ -1682,6 +1748,9 @@ export declare const GetBooleanResultSchema: v.BooleanSchema<undefined>;
|
|
|
1682
1748
|
/**
|
|
1683
1749
|
* Response when getting the device coordinates.
|
|
1684
1750
|
*
|
|
1751
|
+
* @group Modules
|
|
1752
|
+
* @category Location
|
|
1753
|
+
*
|
|
1685
1754
|
* @remarks
|
|
1686
1755
|
* This response can have the following status codes:
|
|
1687
1756
|
* - `200`: Coordinates retrieved successfully. The `result` contains latitude and longitude.
|
|
@@ -1697,6 +1766,9 @@ export declare type GetCoordinateResponse = InferOutput<typeof GetCoordinateResp
|
|
|
1697
1766
|
/**
|
|
1698
1767
|
* Valibot schema for {@link GetCoordinateResponse}.
|
|
1699
1768
|
*
|
|
1769
|
+
* @group Modules
|
|
1770
|
+
* @category Location
|
|
1771
|
+
*
|
|
1700
1772
|
* @public
|
|
1701
1773
|
*/
|
|
1702
1774
|
export declare const GetCoordinateResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -1722,6 +1794,9 @@ export declare const GetCoordinateResponseSchema: v.UnionSchema<[v.ObjectSchema<
|
|
|
1722
1794
|
/**
|
|
1723
1795
|
* Result object containing the geographic coordinates.
|
|
1724
1796
|
*
|
|
1797
|
+
* @group Modules
|
|
1798
|
+
* @category Location
|
|
1799
|
+
*
|
|
1725
1800
|
* @example
|
|
1726
1801
|
* ```typescript
|
|
1727
1802
|
* { latitude: 1.3521, longitude: 103.8198 }
|
|
@@ -1734,6 +1809,9 @@ export declare type GetCoordinateResult = InferOutput<typeof GetCoordinateResult
|
|
|
1734
1809
|
/**
|
|
1735
1810
|
* Valibot schema for {@link GetCoordinateResult}.
|
|
1736
1811
|
*
|
|
1812
|
+
* @group Modules
|
|
1813
|
+
* @category Location
|
|
1814
|
+
*
|
|
1737
1815
|
* @public
|
|
1738
1816
|
*/
|
|
1739
1817
|
export declare const GetCoordinateResultSchema: v.ObjectSchema<{
|
|
@@ -1744,6 +1822,9 @@ export declare const GetCoordinateResultSchema: v.ObjectSchema<{
|
|
|
1744
1822
|
/**
|
|
1745
1823
|
* Response when getting the country code.
|
|
1746
1824
|
*
|
|
1825
|
+
* @group Modules
|
|
1826
|
+
* @category Location
|
|
1827
|
+
*
|
|
1747
1828
|
* @remarks
|
|
1748
1829
|
* This response can have the following status codes:
|
|
1749
1830
|
* - `200`: Country code retrieved successfully. The `result` is the ISO country code string.
|
|
@@ -1760,6 +1841,9 @@ export declare type GetCountryCodeResponse = InferOutput<typeof GetCountryCodeRe
|
|
|
1760
1841
|
/**
|
|
1761
1842
|
* Valibot schema for {@link GetCountryCodeResponse}.
|
|
1762
1843
|
*
|
|
1844
|
+
* @group Modules
|
|
1845
|
+
* @category Location
|
|
1846
|
+
*
|
|
1763
1847
|
* @public
|
|
1764
1848
|
*/
|
|
1765
1849
|
export declare const GetCountryCodeResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -1782,7 +1866,10 @@ export declare const GetCountryCodeResponseSchema: v.UnionSchema<[v.ObjectSchema
|
|
|
1782
1866
|
}, undefined>], undefined>;
|
|
1783
1867
|
|
|
1784
1868
|
/**
|
|
1785
|
-
* The ISO country code string returned from
|
|
1869
|
+
* The ISO country code string returned from `JSBridge`.
|
|
1870
|
+
*
|
|
1871
|
+
* @group Modules
|
|
1872
|
+
* @category Location
|
|
1786
1873
|
*
|
|
1787
1874
|
* @example
|
|
1788
1875
|
* ```typescript
|
|
@@ -1801,6 +1888,9 @@ export declare type GetCountryCodeResult = InferOutput<typeof GetCountryCodeResu
|
|
|
1801
1888
|
/**
|
|
1802
1889
|
* Valibot schema for {@link GetCountryCodeResult}.
|
|
1803
1890
|
*
|
|
1891
|
+
* @group Modules
|
|
1892
|
+
* @category Location
|
|
1893
|
+
*
|
|
1804
1894
|
* @public
|
|
1805
1895
|
*/
|
|
1806
1896
|
export declare const GetCountryCodeResultSchema: v.StringSchema<undefined>;
|
|
@@ -1808,6 +1898,9 @@ export declare const GetCountryCodeResultSchema: v.StringSchema<undefined>;
|
|
|
1808
1898
|
/**
|
|
1809
1899
|
* Request parameters for getting a double value from storage.
|
|
1810
1900
|
*
|
|
1901
|
+
* @group Modules
|
|
1902
|
+
* @category Storage
|
|
1903
|
+
*
|
|
1811
1904
|
* @example
|
|
1812
1905
|
* ```typescript
|
|
1813
1906
|
* { key: 'price' }
|
|
@@ -1820,6 +1913,9 @@ export declare type GetDoubleRequest = InferOutput<typeof GetDoubleRequestSchema
|
|
|
1820
1913
|
/**
|
|
1821
1914
|
* Valibot schema for {@link GetDoubleRequest}.
|
|
1822
1915
|
*
|
|
1916
|
+
* @group Modules
|
|
1917
|
+
* @category Storage
|
|
1918
|
+
*
|
|
1823
1919
|
* @public
|
|
1824
1920
|
*/
|
|
1825
1921
|
export declare const GetDoubleRequestSchema: v.ObjectSchema<{
|
|
@@ -1829,6 +1925,9 @@ export declare const GetDoubleRequestSchema: v.ObjectSchema<{
|
|
|
1829
1925
|
/**
|
|
1830
1926
|
* Response when getting a double value.
|
|
1831
1927
|
*
|
|
1928
|
+
* @group Modules
|
|
1929
|
+
* @category Storage
|
|
1930
|
+
*
|
|
1832
1931
|
* @remarks
|
|
1833
1932
|
* This response can have the following status codes:
|
|
1834
1933
|
* - `200`: Value retrieved successfully. The `result` contains the double value.
|
|
@@ -1845,6 +1944,9 @@ export declare type GetDoubleResponse = InferOutput<typeof GetDoubleResponseSche
|
|
|
1845
1944
|
/**
|
|
1846
1945
|
* Valibot schema for {@link GetDoubleResponse}.
|
|
1847
1946
|
*
|
|
1947
|
+
* @group Modules
|
|
1948
|
+
* @category Storage
|
|
1949
|
+
*
|
|
1848
1950
|
* @public
|
|
1849
1951
|
*/
|
|
1850
1952
|
export declare const GetDoubleResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -1869,6 +1971,9 @@ export declare const GetDoubleResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
1869
1971
|
/**
|
|
1870
1972
|
* The floating-point value returned when a key exists in storage.
|
|
1871
1973
|
*
|
|
1974
|
+
* @group Modules
|
|
1975
|
+
* @category Storage
|
|
1976
|
+
*
|
|
1872
1977
|
* @remarks
|
|
1873
1978
|
* When the key has no stored value, the response `status_code` is `204` instead.
|
|
1874
1979
|
*
|
|
@@ -1884,6 +1989,9 @@ export declare type GetDoubleResult = InferOutput<typeof GetDoubleResultSchema>;
|
|
|
1884
1989
|
/**
|
|
1885
1990
|
* Valibot schema for {@link GetDoubleResult}.
|
|
1886
1991
|
*
|
|
1992
|
+
* @group Modules
|
|
1993
|
+
* @category Storage
|
|
1994
|
+
*
|
|
1887
1995
|
* @public
|
|
1888
1996
|
*/
|
|
1889
1997
|
export declare const GetDoubleResultSchema: v.NumberSchema<undefined>;
|
|
@@ -1891,6 +1999,9 @@ export declare const GetDoubleResultSchema: v.NumberSchema<undefined>;
|
|
|
1891
1999
|
/**
|
|
1892
2000
|
* Request parameters for getting an integer value from storage.
|
|
1893
2001
|
*
|
|
2002
|
+
* @group Modules
|
|
2003
|
+
* @category Storage
|
|
2004
|
+
*
|
|
1894
2005
|
* @example
|
|
1895
2006
|
* ```typescript
|
|
1896
2007
|
* { key: 'userCount' }
|
|
@@ -1903,6 +2014,9 @@ export declare type GetIntRequest = InferOutput<typeof GetIntRequestSchema>;
|
|
|
1903
2014
|
/**
|
|
1904
2015
|
* Valibot schema for {@link GetIntRequest}.
|
|
1905
2016
|
*
|
|
2017
|
+
* @group Modules
|
|
2018
|
+
* @category Storage
|
|
2019
|
+
*
|
|
1906
2020
|
* @public
|
|
1907
2021
|
*/
|
|
1908
2022
|
export declare const GetIntRequestSchema: v.ObjectSchema<{
|
|
@@ -1912,6 +2026,9 @@ export declare const GetIntRequestSchema: v.ObjectSchema<{
|
|
|
1912
2026
|
/**
|
|
1913
2027
|
* Response when getting an integer value.
|
|
1914
2028
|
*
|
|
2029
|
+
* @group Modules
|
|
2030
|
+
* @category Storage
|
|
2031
|
+
*
|
|
1915
2032
|
* @remarks
|
|
1916
2033
|
* This response can have the following status codes:
|
|
1917
2034
|
* - `200`: Value retrieved successfully. The `result` contains the integer value.
|
|
@@ -1928,6 +2045,9 @@ export declare type GetIntResponse = InferOutput<typeof GetIntResponseSchema>;
|
|
|
1928
2045
|
/**
|
|
1929
2046
|
* Valibot schema for {@link GetIntResponse}.
|
|
1930
2047
|
*
|
|
2048
|
+
* @group Modules
|
|
2049
|
+
* @category Storage
|
|
2050
|
+
*
|
|
1931
2051
|
* @public
|
|
1932
2052
|
*/
|
|
1933
2053
|
export declare const GetIntResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -1952,6 +2072,9 @@ export declare const GetIntResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
1952
2072
|
/**
|
|
1953
2073
|
* The integer value returned when a key exists in storage.
|
|
1954
2074
|
*
|
|
2075
|
+
* @group Modules
|
|
2076
|
+
* @category Storage
|
|
2077
|
+
*
|
|
1955
2078
|
* @remarks
|
|
1956
2079
|
* When the key has no stored value, the response `status_code` is `204` instead.
|
|
1957
2080
|
*
|
|
@@ -1967,6 +2090,9 @@ export declare type GetIntResult = InferOutput<typeof GetIntResultSchema>;
|
|
|
1967
2090
|
/**
|
|
1968
2091
|
* Valibot schema for {@link GetIntResult}.
|
|
1969
2092
|
*
|
|
2093
|
+
* @group Modules
|
|
2094
|
+
* @category Storage
|
|
2095
|
+
*
|
|
1970
2096
|
* @public
|
|
1971
2097
|
*/
|
|
1972
2098
|
export declare const GetIntResultSchema: v.NumberSchema<undefined>;
|
|
@@ -1974,6 +2100,9 @@ export declare const GetIntResultSchema: v.NumberSchema<undefined>;
|
|
|
1974
2100
|
/**
|
|
1975
2101
|
* Response when getting the language locale identifier from the device.
|
|
1976
2102
|
*
|
|
2103
|
+
* @group Modules
|
|
2104
|
+
* @category Locale
|
|
2105
|
+
*
|
|
1977
2106
|
* @remarks
|
|
1978
2107
|
* This response can have the following status codes:
|
|
1979
2108
|
* - `200`: Locale identifier retrieved successfully.
|
|
@@ -1989,6 +2118,9 @@ export declare type GetLanguageLocaleIdentifierResponse = InferOutput<typeof Get
|
|
|
1989
2118
|
/**
|
|
1990
2119
|
* Valibot schema for {@link GetLanguageLocaleIdentifierResponse}.
|
|
1991
2120
|
*
|
|
2121
|
+
* @group Modules
|
|
2122
|
+
* @category Locale
|
|
2123
|
+
*
|
|
1992
2124
|
* @public
|
|
1993
2125
|
*/
|
|
1994
2126
|
export declare const GetLanguageLocaleIdentifierResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -2010,6 +2142,9 @@ export declare const GetLanguageLocaleIdentifierResponseSchema: v.UnionSchema<[v
|
|
|
2010
2142
|
/**
|
|
2011
2143
|
* Result object containing the language locale identifier.
|
|
2012
2144
|
*
|
|
2145
|
+
* @group Modules
|
|
2146
|
+
* @category Locale
|
|
2147
|
+
*
|
|
2013
2148
|
* @remarks
|
|
2014
2149
|
* The locale identifier is the language code of the device's language settings.
|
|
2015
2150
|
* Common values include:
|
|
@@ -2041,6 +2176,9 @@ export declare type GetLanguageLocaleIdentifierResult = InferOutput<typeof GetLa
|
|
|
2041
2176
|
/**
|
|
2042
2177
|
* Valibot schema for {@link GetLanguageLocaleIdentifierResult}.
|
|
2043
2178
|
*
|
|
2179
|
+
* @group Modules
|
|
2180
|
+
* @category Locale
|
|
2181
|
+
*
|
|
2044
2182
|
* @public
|
|
2045
2183
|
*/
|
|
2046
2184
|
export declare const GetLanguageLocaleIdentifierResultSchema: v.StringSchema<undefined>;
|
|
@@ -2048,6 +2186,9 @@ export declare const GetLanguageLocaleIdentifierResultSchema: v.StringSchema<und
|
|
|
2048
2186
|
/**
|
|
2049
2187
|
* Response when reading the selected travel destination lowercase ISO 3166-1 alpha-2 country code.
|
|
2050
2188
|
*
|
|
2189
|
+
* @group Modules
|
|
2190
|
+
* @category User Attributes
|
|
2191
|
+
*
|
|
2051
2192
|
* @remarks
|
|
2052
2193
|
* This response can have the following status codes:
|
|
2053
2194
|
* - `200`: The selected travel destination lowercase ISO 3166-1 alpha-2 country code was returned successfully.
|
|
@@ -2062,6 +2203,9 @@ export declare type GetSelectedTravelDestinationResponse = InferOutput<typeof Ge
|
|
|
2062
2203
|
/**
|
|
2063
2204
|
* Valibot schema for {@link GetSelectedTravelDestinationResponse}.
|
|
2064
2205
|
*
|
|
2206
|
+
* @group Modules
|
|
2207
|
+
* @category User Attributes
|
|
2208
|
+
*
|
|
2065
2209
|
* @public
|
|
2066
2210
|
*/
|
|
2067
2211
|
export declare const GetSelectedTravelDestinationResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -2080,6 +2224,9 @@ export declare const GetSelectedTravelDestinationResponseSchema: v.UnionSchema<[
|
|
|
2080
2224
|
/**
|
|
2081
2225
|
* Result containing the selected travel destination lowercase ISO 3166-1 alpha-2 country code.
|
|
2082
2226
|
*
|
|
2227
|
+
* @group Modules
|
|
2228
|
+
* @category User Attributes
|
|
2229
|
+
*
|
|
2083
2230
|
* @example
|
|
2084
2231
|
* ```typescript
|
|
2085
2232
|
* 'id'
|
|
@@ -2097,6 +2244,9 @@ export declare type GetSelectedTravelDestinationResult = InferOutput<typeof GetS
|
|
|
2097
2244
|
/**
|
|
2098
2245
|
* Valibot schema for {@link GetSelectedTravelDestinationResult}.
|
|
2099
2246
|
*
|
|
2247
|
+
* @group Modules
|
|
2248
|
+
* @category User Attributes
|
|
2249
|
+
*
|
|
2100
2250
|
* @public
|
|
2101
2251
|
*/
|
|
2102
2252
|
export declare const GetSelectedTravelDestinationResultSchema: v.StringSchema<undefined>;
|
|
@@ -2104,6 +2254,9 @@ export declare const GetSelectedTravelDestinationResultSchema: v.StringSchema<un
|
|
|
2104
2254
|
/**
|
|
2105
2255
|
* Response when getting session parameters.
|
|
2106
2256
|
*
|
|
2257
|
+
* @group Modules
|
|
2258
|
+
* @category Container
|
|
2259
|
+
*
|
|
2107
2260
|
* @remarks
|
|
2108
2261
|
* This response can have the following status codes:
|
|
2109
2262
|
* - `200`: Session parameters retrieved successfully.
|
|
@@ -2117,6 +2270,9 @@ export declare type GetSessionParamsResponse = InferOutput<typeof GetSessionPara
|
|
|
2117
2270
|
/**
|
|
2118
2271
|
* Valibot schema for {@link GetSessionParamsResponse}.
|
|
2119
2272
|
*
|
|
2273
|
+
* @group Modules
|
|
2274
|
+
* @category Container
|
|
2275
|
+
*
|
|
2120
2276
|
* @public
|
|
2121
2277
|
*/
|
|
2122
2278
|
export declare const GetSessionParamsResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -2135,6 +2291,9 @@ export declare const GetSessionParamsResponseSchema: v.UnionSchema<[v.ObjectSche
|
|
|
2135
2291
|
/**
|
|
2136
2292
|
* Result object containing session parameters as a JSON string.
|
|
2137
2293
|
*
|
|
2294
|
+
* @group Modules
|
|
2295
|
+
* @category Container
|
|
2296
|
+
*
|
|
2138
2297
|
* @remarks
|
|
2139
2298
|
* The `result` field contains a JSON string that must be parsed with `JSON.parse()` to use as an object.
|
|
2140
2299
|
* Session parameters can contain primitives, base64 encoded strings, or nested objects depending on the
|
|
@@ -2152,6 +2311,9 @@ export declare type GetSessionParamsResult = InferOutput<typeof GetSessionParams
|
|
|
2152
2311
|
/**
|
|
2153
2312
|
* Valibot schema for {@link GetSessionParamsResult}.
|
|
2154
2313
|
*
|
|
2314
|
+
* @group Modules
|
|
2315
|
+
* @category Container
|
|
2316
|
+
*
|
|
2155
2317
|
* @public
|
|
2156
2318
|
*/
|
|
2157
2319
|
export declare const GetSessionParamsResultSchema: v.StringSchema<undefined>;
|
|
@@ -2159,6 +2321,9 @@ export declare const GetSessionParamsResultSchema: v.StringSchema<undefined>;
|
|
|
2159
2321
|
/**
|
|
2160
2322
|
* Request parameters for getting a string value from storage.
|
|
2161
2323
|
*
|
|
2324
|
+
* @group Modules
|
|
2325
|
+
* @category Storage
|
|
2326
|
+
*
|
|
2162
2327
|
* @example
|
|
2163
2328
|
* ```typescript
|
|
2164
2329
|
* { key: 'username' }
|
|
@@ -2171,6 +2336,9 @@ export declare type GetStringRequest = InferOutput<typeof GetStringRequestSchema
|
|
|
2171
2336
|
/**
|
|
2172
2337
|
* Valibot schema for {@link GetStringRequest}.
|
|
2173
2338
|
*
|
|
2339
|
+
* @group Modules
|
|
2340
|
+
* @category Storage
|
|
2341
|
+
*
|
|
2174
2342
|
* @public
|
|
2175
2343
|
*/
|
|
2176
2344
|
export declare const GetStringRequestSchema: v.ObjectSchema<{
|
|
@@ -2180,6 +2348,9 @@ export declare const GetStringRequestSchema: v.ObjectSchema<{
|
|
|
2180
2348
|
/**
|
|
2181
2349
|
* Response when getting a string value.
|
|
2182
2350
|
*
|
|
2351
|
+
* @group Modules
|
|
2352
|
+
* @category Storage
|
|
2353
|
+
*
|
|
2183
2354
|
* @remarks
|
|
2184
2355
|
* This response can have the following status codes:
|
|
2185
2356
|
* - `200`: Value retrieved successfully. The `result` contains the string value.
|
|
@@ -2196,6 +2367,9 @@ export declare type GetStringResponse = InferOutput<typeof GetStringResponseSche
|
|
|
2196
2367
|
/**
|
|
2197
2368
|
* Valibot schema for {@link GetStringResponse}.
|
|
2198
2369
|
*
|
|
2370
|
+
* @group Modules
|
|
2371
|
+
* @category Storage
|
|
2372
|
+
*
|
|
2199
2373
|
* @public
|
|
2200
2374
|
*/
|
|
2201
2375
|
export declare const GetStringResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -2220,6 +2394,9 @@ export declare const GetStringResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
2220
2394
|
/**
|
|
2221
2395
|
* The string value returned when a key exists in storage.
|
|
2222
2396
|
*
|
|
2397
|
+
* @group Modules
|
|
2398
|
+
* @category Storage
|
|
2399
|
+
*
|
|
2223
2400
|
* @remarks
|
|
2224
2401
|
* When the key has no stored value, the response `status_code` is `204` instead.
|
|
2225
2402
|
*
|
|
@@ -2235,6 +2412,9 @@ export declare type GetStringResult = InferOutput<typeof GetStringResultSchema>;
|
|
|
2235
2412
|
/**
|
|
2236
2413
|
* Valibot schema for {@link GetStringResult}.
|
|
2237
2414
|
*
|
|
2415
|
+
* @group Modules
|
|
2416
|
+
* @category Storage
|
|
2417
|
+
*
|
|
2238
2418
|
* @public
|
|
2239
2419
|
*/
|
|
2240
2420
|
export declare const GetStringResultSchema: v.StringSchema<undefined>;
|
|
@@ -2242,6 +2422,8 @@ export declare const GetStringResultSchema: v.StringSchema<undefined>;
|
|
|
2242
2422
|
/**
|
|
2243
2423
|
* Represents parsed information from a Grab app user agent string.
|
|
2244
2424
|
*
|
|
2425
|
+
* @group Core
|
|
2426
|
+
*
|
|
2245
2427
|
* @public
|
|
2246
2428
|
*/
|
|
2247
2429
|
export declare interface GrabAppInfo {
|
|
@@ -2253,6 +2435,9 @@ export declare interface GrabAppInfo {
|
|
|
2253
2435
|
/**
|
|
2254
2436
|
* Request parameters for checking if the current client has access to a specific API.
|
|
2255
2437
|
*
|
|
2438
|
+
* @group Modules
|
|
2439
|
+
* @category Scope
|
|
2440
|
+
*
|
|
2256
2441
|
* @example
|
|
2257
2442
|
* ```typescript
|
|
2258
2443
|
* {
|
|
@@ -2268,6 +2453,9 @@ export declare type HasAccessToRequest = InferOutput<typeof HasAccessToRequestSc
|
|
|
2268
2453
|
/**
|
|
2269
2454
|
* Valibot schema for {@link HasAccessToRequest}.
|
|
2270
2455
|
*
|
|
2456
|
+
* @group Modules
|
|
2457
|
+
* @category Scope
|
|
2458
|
+
*
|
|
2271
2459
|
* @public
|
|
2272
2460
|
*/
|
|
2273
2461
|
export declare const HasAccessToRequestSchema: v.ObjectSchema<{
|
|
@@ -2278,6 +2466,9 @@ export declare const HasAccessToRequestSchema: v.ObjectSchema<{
|
|
|
2278
2466
|
/**
|
|
2279
2467
|
* Response when checking API access permissions.
|
|
2280
2468
|
*
|
|
2469
|
+
* @group Modules
|
|
2470
|
+
* @category Scope
|
|
2471
|
+
*
|
|
2281
2472
|
* @remarks
|
|
2282
2473
|
* This response can have the following status codes:
|
|
2283
2474
|
* - `200`: Access check completed successfully. The `result` contains the access status.
|
|
@@ -2293,6 +2484,9 @@ export declare type HasAccessToResponse = InferOutput<typeof HasAccessToResponse
|
|
|
2293
2484
|
/**
|
|
2294
2485
|
* Valibot schema for {@link HasAccessToResponse}.
|
|
2295
2486
|
*
|
|
2487
|
+
* @group Modules
|
|
2488
|
+
* @category Scope
|
|
2489
|
+
*
|
|
2296
2490
|
* @public
|
|
2297
2491
|
*/
|
|
2298
2492
|
export declare const HasAccessToResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -2315,6 +2509,9 @@ export declare const HasAccessToResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
2315
2509
|
/**
|
|
2316
2510
|
* Boolean result indicating whether the MiniApp has access to the specified API.
|
|
2317
2511
|
*
|
|
2512
|
+
* @group Modules
|
|
2513
|
+
* @category Scope
|
|
2514
|
+
*
|
|
2318
2515
|
* @example
|
|
2319
2516
|
* **Has access:**
|
|
2320
2517
|
* ```typescript
|
|
@@ -2334,34 +2531,42 @@ export declare type HasAccessToResult = InferOutput<typeof HasAccessToResultSche
|
|
|
2334
2531
|
/**
|
|
2335
2532
|
* Valibot schema for {@link HasAccessToResult}.
|
|
2336
2533
|
*
|
|
2534
|
+
* @group Modules
|
|
2535
|
+
* @category Scope
|
|
2536
|
+
*
|
|
2337
2537
|
* @public
|
|
2338
2538
|
*/
|
|
2339
2539
|
export declare const HasAccessToResultSchema: v.BooleanSchema<undefined>;
|
|
2340
2540
|
|
|
2341
2541
|
/**
|
|
2342
|
-
* Type guard to check if
|
|
2542
|
+
* Type guard to check if an SDK response has a `result` that is neither `null` nor `undefined`.
|
|
2543
|
+
*
|
|
2544
|
+
* @group Type Guards
|
|
2343
2545
|
*
|
|
2344
|
-
* @param response - The
|
|
2345
|
-
* @returns
|
|
2546
|
+
* @param response - The SDK response to check
|
|
2547
|
+
* @returns `true` if the response has a `result` that is neither `null` nor `undefined`, `false` otherwise
|
|
2346
2548
|
*
|
|
2347
2549
|
* @example
|
|
2348
2550
|
* ```typescript
|
|
2349
2551
|
* const response = await someBridgeMethod();
|
|
2350
|
-
* if (
|
|
2351
|
-
* // response
|
|
2552
|
+
* if (isOk(response) && hasResult(response)) {
|
|
2553
|
+
* // response narrowed to status code `200` variant, and `result` is available
|
|
2352
2554
|
* console.log('Result:', response.result);
|
|
2353
2555
|
* }
|
|
2354
2556
|
* ```
|
|
2355
2557
|
*
|
|
2356
2558
|
* @public
|
|
2357
2559
|
*/
|
|
2358
|
-
export declare function hasResult<T extends
|
|
2560
|
+
export declare function hasResult<T extends SDKResponse>(response: T): response is Extract<T, {
|
|
2359
2561
|
result: NonNullable<unknown>;
|
|
2360
2562
|
}>;
|
|
2361
2563
|
|
|
2362
2564
|
/**
|
|
2363
2565
|
* Response when hiding the back button.
|
|
2364
2566
|
*
|
|
2567
|
+
* @group Modules
|
|
2568
|
+
* @category Container
|
|
2569
|
+
*
|
|
2365
2570
|
* @remarks
|
|
2366
2571
|
* This response can have the following status codes:
|
|
2367
2572
|
* - `204`: Back button hidden successfully.
|
|
@@ -2375,6 +2580,9 @@ export declare type HideBackButtonResponse = InferOutput<typeof HideBackButtonRe
|
|
|
2375
2580
|
/**
|
|
2376
2581
|
* Valibot schema for {@link HideBackButtonResponse}.
|
|
2377
2582
|
*
|
|
2583
|
+
* @group Modules
|
|
2584
|
+
* @category Container
|
|
2585
|
+
*
|
|
2378
2586
|
* @public
|
|
2379
2587
|
*/
|
|
2380
2588
|
export declare const HideBackButtonResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -2391,6 +2599,9 @@ export declare const HideBackButtonResponseSchema: v.UnionSchema<[v.ObjectSchema
|
|
|
2391
2599
|
* Result when hiding the back button.
|
|
2392
2600
|
* This operation returns no data on success.
|
|
2393
2601
|
*
|
|
2602
|
+
* @group Modules
|
|
2603
|
+
* @category Container
|
|
2604
|
+
*
|
|
2394
2605
|
* @public
|
|
2395
2606
|
*/
|
|
2396
2607
|
export declare type HideBackButtonResult = void;
|
|
@@ -2398,6 +2609,9 @@ export declare type HideBackButtonResult = void;
|
|
|
2398
2609
|
/**
|
|
2399
2610
|
* Response when hiding the loader.
|
|
2400
2611
|
*
|
|
2612
|
+
* @group Modules
|
|
2613
|
+
* @category Container
|
|
2614
|
+
*
|
|
2401
2615
|
* @remarks
|
|
2402
2616
|
* This response can have the following status codes:
|
|
2403
2617
|
* - `204`: Loader hidden successfully.
|
|
@@ -2411,6 +2625,9 @@ export declare type HideLoaderResponse = InferOutput<typeof HideLoaderResponseSc
|
|
|
2411
2625
|
/**
|
|
2412
2626
|
* Valibot schema for {@link HideLoaderResponse}.
|
|
2413
2627
|
*
|
|
2628
|
+
* @group Modules
|
|
2629
|
+
* @category Container
|
|
2630
|
+
*
|
|
2414
2631
|
* @public
|
|
2415
2632
|
*/
|
|
2416
2633
|
export declare const HideLoaderResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -2427,6 +2644,9 @@ export declare const HideLoaderResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
2427
2644
|
* Result when hiding the loader.
|
|
2428
2645
|
* This operation returns no data on success.
|
|
2429
2646
|
*
|
|
2647
|
+
* @group Modules
|
|
2648
|
+
* @category Container
|
|
2649
|
+
*
|
|
2430
2650
|
* @public
|
|
2431
2651
|
*/
|
|
2432
2652
|
export declare type HideLoaderResult = void;
|
|
@@ -2434,6 +2654,9 @@ export declare type HideLoaderResult = void;
|
|
|
2434
2654
|
/**
|
|
2435
2655
|
* Response when hiding the refresh button.
|
|
2436
2656
|
*
|
|
2657
|
+
* @group Modules
|
|
2658
|
+
* @category Container
|
|
2659
|
+
*
|
|
2437
2660
|
* @remarks
|
|
2438
2661
|
* This response can have the following status codes:
|
|
2439
2662
|
* - `204`: Refresh button hidden successfully.
|
|
@@ -2447,6 +2670,9 @@ export declare type HideRefreshButtonResponse = InferOutput<typeof HideRefreshBu
|
|
|
2447
2670
|
/**
|
|
2448
2671
|
* Valibot schema for {@link HideRefreshButtonResponse}.
|
|
2449
2672
|
*
|
|
2673
|
+
* @group Modules
|
|
2674
|
+
* @category Container
|
|
2675
|
+
*
|
|
2450
2676
|
* @public
|
|
2451
2677
|
*/
|
|
2452
2678
|
export declare const HideRefreshButtonResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -2463,14 +2689,18 @@ export declare const HideRefreshButtonResponseSchema: v.UnionSchema<[v.ObjectSch
|
|
|
2463
2689
|
* Result when hiding the refresh button.
|
|
2464
2690
|
* This operation returns no data on success.
|
|
2465
2691
|
*
|
|
2692
|
+
* @group Modules
|
|
2693
|
+
* @category Container
|
|
2694
|
+
*
|
|
2466
2695
|
* @public
|
|
2467
2696
|
*/
|
|
2468
2697
|
export declare type HideRefreshButtonResult = void;
|
|
2469
2698
|
|
|
2470
2699
|
/**
|
|
2471
|
-
*
|
|
2700
|
+
* SDK module for authenticating users with GrabID via `JSBridge`.
|
|
2472
2701
|
*
|
|
2473
2702
|
* @group Modules
|
|
2703
|
+
* @category Identity
|
|
2474
2704
|
*
|
|
2475
2705
|
* @remarks
|
|
2476
2706
|
* Handles OAuth2/OIDC authentication flows with PKCE support, enabling MiniApps to obtain user identity tokens.
|
|
@@ -2640,7 +2870,7 @@ export declare class IdentityModule extends BaseModule {
|
|
|
2640
2870
|
* Determines whether to use web-based consent flow based on app version and environment.
|
|
2641
2871
|
*
|
|
2642
2872
|
* @param request - The authorization request containing the environment setting.
|
|
2643
|
-
* @returns
|
|
2873
|
+
* @returns `true` if web consent should be used, `false` for native consent.
|
|
2644
2874
|
*
|
|
2645
2875
|
* @internal
|
|
2646
2876
|
*/
|
|
@@ -2656,7 +2886,7 @@ export declare class IdentityModule extends BaseModule {
|
|
|
2656
2886
|
*/
|
|
2657
2887
|
private performWebAuthorization;
|
|
2658
2888
|
/**
|
|
2659
|
-
* Performs native in-app OAuth2 authorization using
|
|
2889
|
+
* Performs native in-app OAuth2 authorization using `JSBridge`.
|
|
2660
2890
|
*
|
|
2661
2891
|
* @param invokeParams - The authorization parameters.
|
|
2662
2892
|
*
|
|
@@ -2754,40 +2984,34 @@ export declare class IdentityModule extends BaseModule {
|
|
|
2754
2984
|
}
|
|
2755
2985
|
|
|
2756
2986
|
/**
|
|
2757
|
-
*
|
|
2987
|
+
* Type guard to check if an SDK response has a client error status code (`400`, `401`, `403`, `404`, `424`, `426`).
|
|
2758
2988
|
*
|
|
2759
|
-
* @
|
|
2760
|
-
*/
|
|
2761
|
-
export declare interface InvokeOptions {
|
|
2762
|
-
/** The name of the JSBridge method to invoke */
|
|
2763
|
-
method: string;
|
|
2764
|
-
/** The parameters to pass to the method */
|
|
2765
|
-
params?: unknown;
|
|
2766
|
-
}
|
|
2767
|
-
|
|
2768
|
-
/**
|
|
2769
|
-
* Type guard to check if a JSBridge response is a client error (4xx status codes).
|
|
2989
|
+
* @group Type Guards
|
|
2770
2990
|
*
|
|
2771
|
-
* @param response - The
|
|
2772
|
-
* @returns
|
|
2991
|
+
* @param response - The SDK response to check
|
|
2992
|
+
* @returns `true` if the response is a client error, `false` otherwise
|
|
2773
2993
|
*
|
|
2774
2994
|
* @example
|
|
2775
2995
|
* ```typescript
|
|
2776
2996
|
* const response = await someBridgeMethod();
|
|
2777
2997
|
* if (isClientError(response)) {
|
|
2778
|
-
*
|
|
2998
|
+
* // response narrowed to client error variants, `error` is available
|
|
2999
|
+
* console.error(response.error);
|
|
2779
3000
|
* }
|
|
2780
3001
|
* ```
|
|
2781
3002
|
*
|
|
2782
3003
|
* @public
|
|
2783
3004
|
*/
|
|
2784
|
-
export declare function isClientError<T extends
|
|
3005
|
+
export declare function isClientError<T extends SDKResponse>(response: T): response is Extract<T, {
|
|
2785
3006
|
status_code: 400 | 401 | 403 | 404 | 424 | 426;
|
|
2786
3007
|
}>;
|
|
2787
3008
|
|
|
2788
3009
|
/**
|
|
2789
3010
|
* Response when checking connection status.
|
|
2790
3011
|
*
|
|
3012
|
+
* @group Modules
|
|
3013
|
+
* @category Container
|
|
3014
|
+
*
|
|
2791
3015
|
* @remarks
|
|
2792
3016
|
* This response can have the following status codes:
|
|
2793
3017
|
* - `200`: Connected to Grab SuperApp. The `result` contains the connection status.
|
|
@@ -2800,6 +3024,9 @@ export declare type IsConnectedResponse = InferOutput<typeof IsConnectedResponse
|
|
|
2800
3024
|
/**
|
|
2801
3025
|
* Valibot schema for {@link IsConnectedResponse}.
|
|
2802
3026
|
*
|
|
3027
|
+
* @group Modules
|
|
3028
|
+
* @category Container
|
|
3029
|
+
*
|
|
2803
3030
|
* @public
|
|
2804
3031
|
*/
|
|
2805
3032
|
export declare const IsConnectedResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -2815,6 +3042,9 @@ export declare const IsConnectedResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
2815
3042
|
/**
|
|
2816
3043
|
* Result object containing the connection status.
|
|
2817
3044
|
*
|
|
3045
|
+
* @group Modules
|
|
3046
|
+
* @category Container
|
|
3047
|
+
*
|
|
2818
3048
|
* @example
|
|
2819
3049
|
* **Connected to Grab SuperApp:**
|
|
2820
3050
|
* ```typescript
|
|
@@ -2834,6 +3064,9 @@ export declare type IsConnectedResult = InferOutput<typeof IsConnectedResultSche
|
|
|
2834
3064
|
/**
|
|
2835
3065
|
* Valibot schema for {@link IsConnectedResult}.
|
|
2836
3066
|
*
|
|
3067
|
+
* @group Modules
|
|
3068
|
+
* @category Container
|
|
3069
|
+
*
|
|
2837
3070
|
* @public
|
|
2838
3071
|
*/
|
|
2839
3072
|
export declare const IsConnectedResultSchema: v.ObjectSchema<{
|
|
@@ -2841,31 +3074,34 @@ export declare const IsConnectedResultSchema: v.ObjectSchema<{
|
|
|
2841
3074
|
}, undefined>;
|
|
2842
3075
|
|
|
2843
3076
|
/**
|
|
2844
|
-
* Type guard to check if
|
|
3077
|
+
* Type guard to check if an SDK response has an error status code (`400`, `401`, `403`, `404`, `424`, `426`, `500`, `501`).
|
|
3078
|
+
*
|
|
3079
|
+
* @group Type Guards
|
|
2845
3080
|
*
|
|
2846
|
-
* @param response - The
|
|
2847
|
-
* @returns
|
|
3081
|
+
* @param response - The SDK response to check
|
|
3082
|
+
* @returns `true` if the response is an error, `false` otherwise
|
|
2848
3083
|
*
|
|
2849
3084
|
* @example
|
|
2850
3085
|
* ```typescript
|
|
2851
3086
|
* const response = await someBridgeMethod();
|
|
2852
3087
|
* if (isError(response)) {
|
|
2853
|
-
* // response narrowed to error variants
|
|
2854
|
-
* console.error(
|
|
2855
|
-
* } else {
|
|
2856
|
-
* console.log('Success!');
|
|
3088
|
+
* // response narrowed to error variants, `error` is available
|
|
3089
|
+
* console.error(response.error);
|
|
2857
3090
|
* }
|
|
2858
3091
|
* ```
|
|
2859
3092
|
*
|
|
2860
3093
|
* @public
|
|
2861
3094
|
*/
|
|
2862
|
-
export declare function isError<T extends
|
|
3095
|
+
export declare function isError<T extends SDKResponse>(response: T): response is Extract<T, {
|
|
2863
3096
|
error: string;
|
|
2864
3097
|
}>;
|
|
2865
3098
|
|
|
2866
3099
|
/**
|
|
2867
3100
|
* Response when checking whether the current device supports eSIM.
|
|
2868
3101
|
*
|
|
3102
|
+
* @group Modules
|
|
3103
|
+
* @category Device
|
|
3104
|
+
*
|
|
2869
3105
|
* @remarks
|
|
2870
3106
|
* This response can have the following status codes:
|
|
2871
3107
|
* - `200`: eSIM capability was checked successfully. The `result` contains `true` or `false`.
|
|
@@ -2882,6 +3118,9 @@ export declare type IsEsimSupportedResponse = InferOutput<typeof IsEsimSupported
|
|
|
2882
3118
|
/**
|
|
2883
3119
|
* Valibot schema for {@link IsEsimSupportedResponse}.
|
|
2884
3120
|
*
|
|
3121
|
+
* @group Modules
|
|
3122
|
+
* @category Device
|
|
3123
|
+
*
|
|
2885
3124
|
* @public
|
|
2886
3125
|
*/
|
|
2887
3126
|
export declare const IsEsimSupportedResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -2907,6 +3146,9 @@ export declare const IsEsimSupportedResponseSchema: v.UnionSchema<[v.ObjectSchem
|
|
|
2907
3146
|
/**
|
|
2908
3147
|
* Result indicating whether the current device supports eSIM.
|
|
2909
3148
|
*
|
|
3149
|
+
* @group Modules
|
|
3150
|
+
* @category Device
|
|
3151
|
+
*
|
|
2910
3152
|
* @example
|
|
2911
3153
|
* ```typescript
|
|
2912
3154
|
* true
|
|
@@ -2924,111 +3166,156 @@ export declare type IsEsimSupportedResult = InferOutput<typeof IsEsimSupportedRe
|
|
|
2924
3166
|
/**
|
|
2925
3167
|
* Valibot schema for {@link IsEsimSupportedResult}.
|
|
2926
3168
|
*
|
|
3169
|
+
* @group Modules
|
|
3170
|
+
* @category Device
|
|
3171
|
+
*
|
|
2927
3172
|
* @public
|
|
2928
3173
|
*/
|
|
2929
3174
|
export declare const IsEsimSupportedResultSchema: v.BooleanSchema<undefined>;
|
|
2930
3175
|
|
|
2931
3176
|
/**
|
|
2932
|
-
* Type guard to check if
|
|
3177
|
+
* Type guard to check if an SDK response has a `302` status code.
|
|
2933
3178
|
*
|
|
2934
|
-
* @
|
|
2935
|
-
*
|
|
3179
|
+
* @group Type Guards
|
|
3180
|
+
*
|
|
3181
|
+
* @param response - The SDK response to check
|
|
3182
|
+
* @returns `true` if the response has `302` status code, `false` otherwise
|
|
3183
|
+
*
|
|
3184
|
+
* @example
|
|
3185
|
+
* ```typescript
|
|
3186
|
+
* const response = await someBridgeMethod();
|
|
3187
|
+
* if (isFound(response)) {
|
|
3188
|
+
* // response narrowed to status code `302` variant
|
|
3189
|
+
* console.log('Redirecting...');
|
|
3190
|
+
* }
|
|
3191
|
+
* ```
|
|
2936
3192
|
*
|
|
2937
3193
|
* @public
|
|
2938
3194
|
*/
|
|
2939
|
-
export declare function isFound<T extends
|
|
3195
|
+
export declare function isFound<T extends SDKResponse>(response: T): response is Extract<T, {
|
|
2940
3196
|
status_code: 302;
|
|
2941
3197
|
}>;
|
|
2942
3198
|
|
|
2943
3199
|
/**
|
|
2944
|
-
* Type guard to check if
|
|
3200
|
+
* Type guard to check if an SDK response has a `204` status code.
|
|
3201
|
+
*
|
|
3202
|
+
* @group Type Guards
|
|
2945
3203
|
*
|
|
2946
|
-
* @param response - The
|
|
2947
|
-
* @returns
|
|
3204
|
+
* @param response - The SDK response to check
|
|
3205
|
+
* @returns `true` if the response has `204` status code, `false` otherwise
|
|
3206
|
+
*
|
|
3207
|
+
* @example
|
|
3208
|
+
* ```typescript
|
|
3209
|
+
* const response = await someBridgeMethod();
|
|
3210
|
+
* if (isNoContent(response)) {
|
|
3211
|
+
* // response narrowed to status code `204` variant, `result` is not available
|
|
3212
|
+
* console.log('No content');
|
|
3213
|
+
* }
|
|
3214
|
+
* ```
|
|
2948
3215
|
*
|
|
2949
3216
|
* @public
|
|
2950
3217
|
*/
|
|
2951
|
-
export declare function isNoContent<T extends
|
|
3218
|
+
export declare function isNoContent<T extends SDKResponse>(response: T): response is Extract<T, {
|
|
2952
3219
|
status_code: 204;
|
|
2953
3220
|
}>;
|
|
2954
3221
|
|
|
2955
3222
|
/**
|
|
2956
|
-
* Type guard to check if
|
|
3223
|
+
* Type guard to check if an SDK response has a `200` status code.
|
|
3224
|
+
*
|
|
3225
|
+
* @group Type Guards
|
|
2957
3226
|
*
|
|
2958
|
-
* @param response - The
|
|
2959
|
-
* @returns
|
|
3227
|
+
* @param response - The SDK response to check
|
|
3228
|
+
* @returns `true` if the response has `200` status code, `false` otherwise
|
|
3229
|
+
*
|
|
3230
|
+
* @example
|
|
3231
|
+
* ```typescript
|
|
3232
|
+
* const response = await someBridgeMethod();
|
|
3233
|
+
* if (isOk(response)) {
|
|
3234
|
+
* // response narrowed to status code `200` variant, `result` is available
|
|
3235
|
+
* console.log(response.result);
|
|
3236
|
+
* }
|
|
3237
|
+
* ```
|
|
2960
3238
|
*
|
|
2961
3239
|
* @public
|
|
2962
3240
|
*/
|
|
2963
|
-
export declare function isOk<T extends
|
|
3241
|
+
export declare function isOk<T extends SDKResponse>(response: T): response is Extract<T, {
|
|
2964
3242
|
status_code: 200;
|
|
2965
3243
|
}>;
|
|
2966
3244
|
|
|
2967
3245
|
/**
|
|
2968
|
-
* Type guard to check if
|
|
3246
|
+
* Type guard to check if an SDK response has a `302` status code.
|
|
3247
|
+
*
|
|
3248
|
+
* @group Type Guards
|
|
2969
3249
|
*
|
|
2970
|
-
* @param response - The
|
|
2971
|
-
* @returns
|
|
3250
|
+
* @param response - The SDK response to check
|
|
3251
|
+
* @returns `true` if the response is a redirect, `false` otherwise
|
|
2972
3252
|
*
|
|
2973
3253
|
* @example
|
|
2974
3254
|
* ```typescript
|
|
2975
3255
|
* const response = await someBridgeMethod();
|
|
2976
3256
|
* if (isRedirection(response)) {
|
|
3257
|
+
* // response narrowed to status code `302` variant
|
|
2977
3258
|
* console.log('Redirecting...');
|
|
2978
3259
|
* }
|
|
2979
3260
|
* ```
|
|
2980
3261
|
*
|
|
2981
3262
|
* @public
|
|
2982
3263
|
*/
|
|
2983
|
-
export declare function isRedirection<T extends
|
|
3264
|
+
export declare function isRedirection<T extends SDKResponse>(response: T): response is Extract<T, {
|
|
2984
3265
|
status_code: 302;
|
|
2985
3266
|
}>;
|
|
2986
3267
|
|
|
2987
3268
|
/**
|
|
2988
|
-
* Type guard to check if
|
|
3269
|
+
* Type guard to check if an SDK response has a server error status code (`500`, `501`).
|
|
3270
|
+
*
|
|
3271
|
+
* @group Type Guards
|
|
2989
3272
|
*
|
|
2990
|
-
* @param response - The
|
|
2991
|
-
* @returns
|
|
3273
|
+
* @param response - The SDK response to check
|
|
3274
|
+
* @returns `true` if the response is a server error, `false` otherwise
|
|
2992
3275
|
*
|
|
2993
3276
|
* @example
|
|
2994
3277
|
* ```typescript
|
|
2995
3278
|
* const response = await someBridgeMethod();
|
|
2996
3279
|
* if (isServerError(response)) {
|
|
2997
|
-
*
|
|
3280
|
+
* // response narrowed to server error variants, `error` is available
|
|
3281
|
+
* console.error(response.error);
|
|
2998
3282
|
* }
|
|
2999
3283
|
* ```
|
|
3000
3284
|
*
|
|
3001
3285
|
* @public
|
|
3002
3286
|
*/
|
|
3003
|
-
export declare function isServerError<T extends
|
|
3287
|
+
export declare function isServerError<T extends SDKResponse>(response: T): response is Extract<T, {
|
|
3004
3288
|
status_code: 500 | 501;
|
|
3005
3289
|
}>;
|
|
3006
3290
|
|
|
3007
3291
|
/**
|
|
3008
|
-
* Type guard to check if
|
|
3292
|
+
* Type guard to check if an SDK response has a success status code (`200`, `204`).
|
|
3009
3293
|
*
|
|
3010
|
-
* @
|
|
3011
|
-
*
|
|
3294
|
+
* @group Type Guards
|
|
3295
|
+
*
|
|
3296
|
+
* @param response - The SDK response to check
|
|
3297
|
+
* @returns `true` if the response is successful, `false` otherwise
|
|
3012
3298
|
*
|
|
3013
3299
|
* @example
|
|
3014
3300
|
* ```typescript
|
|
3015
3301
|
* const response = await someBridgeMethod();
|
|
3016
3302
|
* if (isSuccess(response)) {
|
|
3017
|
-
* // response narrowed to success variants
|
|
3018
|
-
* console.log(response
|
|
3303
|
+
* // response narrowed to success variants
|
|
3304
|
+
* console.log(response);
|
|
3019
3305
|
* }
|
|
3020
3306
|
* ```
|
|
3021
3307
|
*
|
|
3022
3308
|
* @public
|
|
3023
3309
|
*/
|
|
3024
|
-
export declare function isSuccess<T extends
|
|
3310
|
+
export declare function isSuccess<T extends SDKResponse>(response: T): response is Extract<T, {
|
|
3025
3311
|
status_code: 200 | 204;
|
|
3026
3312
|
}>;
|
|
3027
3313
|
|
|
3028
3314
|
/**
|
|
3029
|
-
*
|
|
3315
|
+
* SDK module for accessing device locale settings via `JSBridge`.
|
|
3030
3316
|
*
|
|
3031
3317
|
* @group Modules
|
|
3318
|
+
* @category Locale
|
|
3032
3319
|
*
|
|
3033
3320
|
* @remarks
|
|
3034
3321
|
* Provides the user's preferred language and region settings from the native device.
|
|
@@ -3087,9 +3374,10 @@ export declare class LocaleModule extends BaseModule {
|
|
|
3087
3374
|
}
|
|
3088
3375
|
|
|
3089
3376
|
/**
|
|
3090
|
-
*
|
|
3377
|
+
* SDK module for accessing device location services via `JSBridge`.
|
|
3091
3378
|
*
|
|
3092
3379
|
* @group Modules
|
|
3380
|
+
* @category Location
|
|
3093
3381
|
*
|
|
3094
3382
|
* @remarks
|
|
3095
3383
|
* Provides access to the device's geolocation data including coordinates and country code.
|
|
@@ -3160,11 +3448,11 @@ export declare class LocationModule extends BaseModule {
|
|
|
3160
3448
|
* @requiredOAuthScope mobile.geolocation
|
|
3161
3449
|
*
|
|
3162
3450
|
* @remarks
|
|
3163
|
-
* This method returns
|
|
3451
|
+
* This method returns an `SDKStream` that continuously emits location updates.
|
|
3164
3452
|
* Remember to call `unsubscribe()` on the subscription when you no longer need updates
|
|
3165
3453
|
* to conserve battery and free resources.
|
|
3166
3454
|
*
|
|
3167
|
-
* @returns
|
|
3455
|
+
* @returns An `SDKStream` that emits location updates as the device location changes.
|
|
3168
3456
|
* Use `subscribe()` to listen for updates, or `await` to get the first value only. See {@link ObserveLocationChangeResponse}.
|
|
3169
3457
|
*
|
|
3170
3458
|
* @example
|
|
@@ -3244,6 +3532,8 @@ export declare class LocationModule extends BaseModule {
|
|
|
3244
3532
|
/**
|
|
3245
3533
|
* Provides scoped logging for SDK modules.
|
|
3246
3534
|
*
|
|
3535
|
+
* @group Core
|
|
3536
|
+
*
|
|
3247
3537
|
* @remarks
|
|
3248
3538
|
* Log messages are prefixed with `[SuperAppSDK][ModuleName.methodName]`
|
|
3249
3539
|
* (e.g. `[SuperAppSDK][ContainerModule.setTitle] An error occurred`).
|
|
@@ -3259,9 +3549,10 @@ export declare class Logger {
|
|
|
3259
3549
|
}
|
|
3260
3550
|
|
|
3261
3551
|
/**
|
|
3262
|
-
*
|
|
3552
|
+
* SDK module for playing DRM-protected media content via `JSBridge`.
|
|
3263
3553
|
*
|
|
3264
3554
|
* @group Modules
|
|
3555
|
+
* @category Media
|
|
3265
3556
|
*
|
|
3266
3557
|
* @remarks
|
|
3267
3558
|
* Provides access to the native media player with DRM support for secure content playback.
|
|
@@ -3379,9 +3670,24 @@ export declare class MediaModule extends BaseModule {
|
|
|
3379
3670
|
}
|
|
3380
3671
|
|
|
3381
3672
|
/**
|
|
3382
|
-
*
|
|
3673
|
+
* Options for invoking an SDK method.
|
|
3674
|
+
*
|
|
3675
|
+
* @group Core
|
|
3676
|
+
*
|
|
3677
|
+
* @public
|
|
3678
|
+
*/
|
|
3679
|
+
export declare interface ModuleInvokeOptions {
|
|
3680
|
+
/** The name of the SDK method to invoke */
|
|
3681
|
+
method: string;
|
|
3682
|
+
/** The parameters to pass to the method */
|
|
3683
|
+
params?: unknown;
|
|
3684
|
+
}
|
|
3685
|
+
|
|
3686
|
+
/**
|
|
3687
|
+
* SDK module for making network requests through the native layer via `JSBridge`.
|
|
3383
3688
|
*
|
|
3384
3689
|
* @group Modules
|
|
3690
|
+
* @category Network
|
|
3385
3691
|
*
|
|
3386
3692
|
* @remarks
|
|
3387
3693
|
* Provides access to native network functionality for making HTTP requests.
|
|
@@ -3411,7 +3717,7 @@ export declare class MediaModule extends BaseModule {
|
|
|
3411
3717
|
export declare class NetworkModule extends BaseModule {
|
|
3412
3718
|
constructor();
|
|
3413
3719
|
/**
|
|
3414
|
-
* Sends a network request
|
|
3720
|
+
* Sends a network request through `JSBridge`.
|
|
3415
3721
|
*
|
|
3416
3722
|
* @param request - The network request parameters including endpoint, method, headers, query, body, and timeout. See {@link SendRequest}.
|
|
3417
3723
|
*
|
|
@@ -3452,18 +3758,24 @@ export declare class NetworkModule extends BaseModule {
|
|
|
3452
3758
|
/**
|
|
3453
3759
|
* Response stream for observing DRM playback events.
|
|
3454
3760
|
*
|
|
3761
|
+
* @group Modules
|
|
3762
|
+
* @category Media
|
|
3763
|
+
*
|
|
3455
3764
|
* @remarks
|
|
3456
|
-
* This is
|
|
3765
|
+
* This is an `SDKStream` that can be:
|
|
3457
3766
|
* - Subscribed to via `.subscribe()` for continuous updates
|
|
3458
3767
|
* - Awaited via `await` to get the first value only
|
|
3459
3768
|
*
|
|
3460
|
-
* The stream can emit status codes 200 (event data), 500 (server error), or 501 (not implemented).
|
|
3769
|
+
* The stream can emit status codes `200` (event data), `500` (server error), or `501` (not implemented).
|
|
3461
3770
|
*
|
|
3462
3771
|
* @public
|
|
3463
3772
|
*/
|
|
3464
|
-
export declare type ObserveDRMPlaybackResponse =
|
|
3773
|
+
export declare type ObserveDRMPlaybackResponse = SDKStream<InferOutput<typeof ObserveDRMPlaybackResponseSchema>>;
|
|
3465
3774
|
|
|
3466
3775
|
/**
|
|
3776
|
+
* @group Modules
|
|
3777
|
+
* @category Media
|
|
3778
|
+
*
|
|
3467
3779
|
* @public
|
|
3468
3780
|
*/
|
|
3469
3781
|
export declare const ObserveDRMPlaybackResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -3485,8 +3797,11 @@ export declare const ObserveDRMPlaybackResponseSchema: v.UnionSchema<[v.ObjectSc
|
|
|
3485
3797
|
/**
|
|
3486
3798
|
* Response when observing the device coordinates.
|
|
3487
3799
|
*
|
|
3800
|
+
* @group Modules
|
|
3801
|
+
* @category Location
|
|
3802
|
+
*
|
|
3488
3803
|
* @remarks
|
|
3489
|
-
* This is
|
|
3804
|
+
* This is an `SDKStream` that can be:
|
|
3490
3805
|
* - Subscribed to via `.subscribe()` for continuous updates
|
|
3491
3806
|
* - Awaited via `await` to get the first value only
|
|
3492
3807
|
*
|
|
@@ -3494,11 +3809,14 @@ export declare const ObserveDRMPlaybackResponseSchema: v.UnionSchema<[v.ObjectSc
|
|
|
3494
3809
|
*
|
|
3495
3810
|
* @public
|
|
3496
3811
|
*/
|
|
3497
|
-
export declare type ObserveLocationChangeResponse =
|
|
3812
|
+
export declare type ObserveLocationChangeResponse = SDKStream<GetCoordinateResponse>;
|
|
3498
3813
|
|
|
3499
3814
|
/**
|
|
3500
3815
|
* Response when notifying content loaded.
|
|
3501
3816
|
*
|
|
3817
|
+
* @group Modules
|
|
3818
|
+
* @category Container
|
|
3819
|
+
*
|
|
3502
3820
|
* @remarks
|
|
3503
3821
|
* This response can have the following status codes:
|
|
3504
3822
|
* - `200`: Notification sent successfully.
|
|
@@ -3513,6 +3831,9 @@ export declare type OnContentLoadedResponse = InferOutput<typeof OnContentLoaded
|
|
|
3513
3831
|
/**
|
|
3514
3832
|
* Valibot schema for {@link OnContentLoadedResponse}.
|
|
3515
3833
|
*
|
|
3834
|
+
* @group Modules
|
|
3835
|
+
* @category Container
|
|
3836
|
+
*
|
|
3516
3837
|
* @public
|
|
3517
3838
|
*/
|
|
3518
3839
|
export declare const OnContentLoadedResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -3532,6 +3853,9 @@ export declare const OnContentLoadedResponseSchema: v.UnionSchema<[v.ObjectSchem
|
|
|
3532
3853
|
* Result when notifying content loaded.
|
|
3533
3854
|
* This operation returns no data on success.
|
|
3534
3855
|
*
|
|
3856
|
+
* @group Modules
|
|
3857
|
+
* @category Container
|
|
3858
|
+
*
|
|
3535
3859
|
* @public
|
|
3536
3860
|
*/
|
|
3537
3861
|
export declare type OnContentLoadedResult = void;
|
|
@@ -3539,6 +3863,9 @@ export declare type OnContentLoadedResult = void;
|
|
|
3539
3863
|
/**
|
|
3540
3864
|
* Request parameters for notifying CTA tap.
|
|
3541
3865
|
*
|
|
3866
|
+
* @group Modules
|
|
3867
|
+
* @category Container
|
|
3868
|
+
*
|
|
3542
3869
|
* @example
|
|
3543
3870
|
* ```typescript
|
|
3544
3871
|
* 'AV_LANDING_PAGE_CONTINUE'
|
|
@@ -3551,6 +3878,9 @@ export declare type OnCtaTapRequest = string;
|
|
|
3551
3878
|
/**
|
|
3552
3879
|
* Response when notifying CTA tap.
|
|
3553
3880
|
*
|
|
3881
|
+
* @group Modules
|
|
3882
|
+
* @category Container
|
|
3883
|
+
*
|
|
3554
3884
|
* @remarks
|
|
3555
3885
|
* This response can have the following status codes:
|
|
3556
3886
|
* - `200`: CTA tap notification sent successfully.
|
|
@@ -3564,6 +3894,9 @@ export declare type OnCtaTapResponse = InferOutput<typeof OnCtaTapResponseSchema
|
|
|
3564
3894
|
/**
|
|
3565
3895
|
* Valibot schema for {@link OnCtaTapResponse}.
|
|
3566
3896
|
*
|
|
3897
|
+
* @group Modules
|
|
3898
|
+
* @category Container
|
|
3899
|
+
*
|
|
3567
3900
|
* @public
|
|
3568
3901
|
*/
|
|
3569
3902
|
export declare const OnCtaTapResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -3581,6 +3914,9 @@ export declare const OnCtaTapResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
3581
3914
|
* Result when notifying CTA tap.
|
|
3582
3915
|
* This operation returns no data on success.
|
|
3583
3916
|
*
|
|
3917
|
+
* @group Modules
|
|
3918
|
+
* @category Container
|
|
3919
|
+
*
|
|
3584
3920
|
* @public
|
|
3585
3921
|
*/
|
|
3586
3922
|
export declare type OnCtaTapResult = void;
|
|
@@ -3588,6 +3924,9 @@ export declare type OnCtaTapResult = void;
|
|
|
3588
3924
|
/**
|
|
3589
3925
|
* Request parameters for opening an external link.
|
|
3590
3926
|
*
|
|
3927
|
+
* @group Modules
|
|
3928
|
+
* @category Container
|
|
3929
|
+
*
|
|
3591
3930
|
* @example
|
|
3592
3931
|
* ```typescript
|
|
3593
3932
|
* 'https://example.com'
|
|
@@ -3600,6 +3939,9 @@ export declare type OpenExternalLinkRequest = string;
|
|
|
3600
3939
|
/**
|
|
3601
3940
|
* Response when opening an external link.
|
|
3602
3941
|
*
|
|
3942
|
+
* @group Modules
|
|
3943
|
+
* @category Container
|
|
3944
|
+
*
|
|
3603
3945
|
* @remarks
|
|
3604
3946
|
* This response can have the following status codes:
|
|
3605
3947
|
* - `204`: External link opened successfully.
|
|
@@ -3614,6 +3956,9 @@ export declare type OpenExternalLinkResponse = InferOutput<typeof OpenExternalLi
|
|
|
3614
3956
|
/**
|
|
3615
3957
|
* Valibot schema for {@link OpenExternalLinkResponse}.
|
|
3616
3958
|
*
|
|
3959
|
+
* @group Modules
|
|
3960
|
+
* @category Container
|
|
3961
|
+
*
|
|
3617
3962
|
* @public
|
|
3618
3963
|
*/
|
|
3619
3964
|
export declare const OpenExternalLinkResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -3633,6 +3978,9 @@ export declare const OpenExternalLinkResponseSchema: v.UnionSchema<[v.ObjectSche
|
|
|
3633
3978
|
* Result when opening an external link.
|
|
3634
3979
|
* This operation returns no data on success.
|
|
3635
3980
|
*
|
|
3981
|
+
* @group Modules
|
|
3982
|
+
* @category Container
|
|
3983
|
+
*
|
|
3636
3984
|
* @public
|
|
3637
3985
|
*/
|
|
3638
3986
|
export declare type OpenExternalLinkResult = void;
|
|
@@ -3640,14 +3988,17 @@ export declare type OpenExternalLinkResult = void;
|
|
|
3640
3988
|
/**
|
|
3641
3989
|
* Represents the mobile operating system platform.
|
|
3642
3990
|
*
|
|
3991
|
+
* @group Core
|
|
3992
|
+
*
|
|
3643
3993
|
* @public
|
|
3644
3994
|
*/
|
|
3645
3995
|
export declare type Platform = 'Android' | 'iOS';
|
|
3646
3996
|
|
|
3647
3997
|
/**
|
|
3648
|
-
*
|
|
3998
|
+
* SDK module for controlling platform navigation via `JSBridge`.
|
|
3649
3999
|
*
|
|
3650
4000
|
* @group Modules
|
|
4001
|
+
* @category Platform
|
|
3651
4002
|
*
|
|
3652
4003
|
* @remarks
|
|
3653
4004
|
* Provides methods to interact with the native platform navigation stack, such as triggering the back action.
|
|
@@ -3709,6 +4060,9 @@ export declare class PlatformModule extends BaseModule {
|
|
|
3709
4060
|
/**
|
|
3710
4061
|
* Response when initiating DRM content playback.
|
|
3711
4062
|
*
|
|
4063
|
+
* @group Modules
|
|
4064
|
+
* @category Media
|
|
4065
|
+
*
|
|
3712
4066
|
* @remarks
|
|
3713
4067
|
* This response can have the following status codes:
|
|
3714
4068
|
* - `200`: Playback initiated successfully (streaming content).
|
|
@@ -3723,6 +4077,9 @@ export declare type PlayDRMContentResponse = InferOutput<typeof PlayDRMContentRe
|
|
|
3723
4077
|
/**
|
|
3724
4078
|
* Valibot schema for {@link PlayDRMContentResponse}.
|
|
3725
4079
|
*
|
|
4080
|
+
* @group Modules
|
|
4081
|
+
* @category Media
|
|
4082
|
+
*
|
|
3726
4083
|
* @public
|
|
3727
4084
|
*/
|
|
3728
4085
|
export declare const PlayDRMContentResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -3753,14 +4110,18 @@ export declare const PlayDRMContentResponseSchema: v.UnionSchema<[v.ObjectSchema
|
|
|
3753
4110
|
* Result object for DRM content playback initiation.
|
|
3754
4111
|
* This operation returns no data on success.
|
|
3755
4112
|
*
|
|
4113
|
+
* @group Modules
|
|
4114
|
+
* @category Media
|
|
4115
|
+
*
|
|
3756
4116
|
* @public
|
|
3757
4117
|
*/
|
|
3758
4118
|
export declare type PlayDRMContentResult = void;
|
|
3759
4119
|
|
|
3760
4120
|
/**
|
|
3761
|
-
*
|
|
4121
|
+
* SDK module for accessing user profile information via `JSBridge`.
|
|
3762
4122
|
*
|
|
3763
4123
|
* @group Modules
|
|
4124
|
+
* @category Profile
|
|
3764
4125
|
*
|
|
3765
4126
|
* @remarks
|
|
3766
4127
|
* Provides access to user profile data such as email verification.
|
|
@@ -3905,6 +4266,9 @@ export declare class ProfileModule extends BaseModule {
|
|
|
3905
4266
|
/**
|
|
3906
4267
|
* Request parameters for redirecting to the system web view.
|
|
3907
4268
|
*
|
|
4269
|
+
* @group Modules
|
|
4270
|
+
* @category System WebView Kit
|
|
4271
|
+
*
|
|
3908
4272
|
* @example
|
|
3909
4273
|
* ```typescript
|
|
3910
4274
|
* {
|
|
@@ -3919,6 +4283,9 @@ export declare type RedirectToSystemWebViewRequest = InferOutput<typeof Redirect
|
|
|
3919
4283
|
/**
|
|
3920
4284
|
* Valibot schema for {@link RedirectToSystemWebViewRequest}.
|
|
3921
4285
|
*
|
|
4286
|
+
* @group Modules
|
|
4287
|
+
* @category System WebView Kit
|
|
4288
|
+
*
|
|
3922
4289
|
* @public
|
|
3923
4290
|
*/
|
|
3924
4291
|
export declare const RedirectToSystemWebViewRequestSchema: v.ObjectSchema<{
|
|
@@ -3928,6 +4295,9 @@ export declare const RedirectToSystemWebViewRequestSchema: v.ObjectSchema<{
|
|
|
3928
4295
|
/**
|
|
3929
4296
|
* Response when redirecting to the system web view.
|
|
3930
4297
|
*
|
|
4298
|
+
* @group Modules
|
|
4299
|
+
* @category System WebView Kit
|
|
4300
|
+
*
|
|
3931
4301
|
* @remarks
|
|
3932
4302
|
* This response can have the following status codes:
|
|
3933
4303
|
* - `200`: Redirect initiated successfully.
|
|
@@ -3943,6 +4313,9 @@ export declare type RedirectToSystemWebViewResponse = InferOutput<typeof Redirec
|
|
|
3943
4313
|
/**
|
|
3944
4314
|
* Valibot schema for {@link RedirectToSystemWebViewResponse}.
|
|
3945
4315
|
*
|
|
4316
|
+
* @group Modules
|
|
4317
|
+
* @category System WebView Kit
|
|
4318
|
+
*
|
|
3946
4319
|
* @public
|
|
3947
4320
|
*/
|
|
3948
4321
|
export declare const RedirectToSystemWebViewResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -3966,6 +4339,9 @@ export declare const RedirectToSystemWebViewResponseSchema: v.UnionSchema<[v.Obj
|
|
|
3966
4339
|
* Result object for redirecting to the system web view.
|
|
3967
4340
|
* This operation returns no data on success.
|
|
3968
4341
|
*
|
|
4342
|
+
* @group Modules
|
|
4343
|
+
* @category System WebView Kit
|
|
4344
|
+
*
|
|
3969
4345
|
* @public
|
|
3970
4346
|
*/
|
|
3971
4347
|
export declare type RedirectToSystemWebViewResult = void;
|
|
@@ -3973,6 +4349,9 @@ export declare type RedirectToSystemWebViewResult = void;
|
|
|
3973
4349
|
/**
|
|
3974
4350
|
* Response when reloading consented scopes.
|
|
3975
4351
|
*
|
|
4352
|
+
* @group Modules
|
|
4353
|
+
* @category Scope
|
|
4354
|
+
*
|
|
3976
4355
|
* @remarks
|
|
3977
4356
|
* This response can have the following status codes:
|
|
3978
4357
|
* - `204`: Scopes reloaded successfully (no content).
|
|
@@ -3987,6 +4366,9 @@ export declare type ReloadScopesResponse = InferOutput<typeof ReloadScopesRespon
|
|
|
3987
4366
|
/**
|
|
3988
4367
|
* Valibot schema for {@link ReloadScopesResponse}.
|
|
3989
4368
|
*
|
|
4369
|
+
* @group Modules
|
|
4370
|
+
* @category Scope
|
|
4371
|
+
*
|
|
3990
4372
|
* @public
|
|
3991
4373
|
*/
|
|
3992
4374
|
export declare const ReloadScopesResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4006,6 +4388,9 @@ export declare const ReloadScopesResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4006
4388
|
* Result object for reloading scopes.
|
|
4007
4389
|
* This operation returns no data on success.
|
|
4008
4390
|
*
|
|
4391
|
+
* @group Modules
|
|
4392
|
+
* @category Scope
|
|
4393
|
+
*
|
|
4009
4394
|
* @public
|
|
4010
4395
|
*/
|
|
4011
4396
|
export declare type ReloadScopesResult = void;
|
|
@@ -4013,6 +4398,9 @@ export declare type ReloadScopesResult = void;
|
|
|
4013
4398
|
/**
|
|
4014
4399
|
* Response when removing all values.
|
|
4015
4400
|
*
|
|
4401
|
+
* @group Modules
|
|
4402
|
+
* @category Storage
|
|
4403
|
+
*
|
|
4016
4404
|
* @remarks
|
|
4017
4405
|
* This response can have the following status codes:
|
|
4018
4406
|
* - `204`: All values removed successfully.
|
|
@@ -4027,6 +4415,9 @@ export declare type RemoveAllResponse = InferOutput<typeof RemoveAllResponseSche
|
|
|
4027
4415
|
/**
|
|
4028
4416
|
* Valibot schema for {@link RemoveAllResponse}.
|
|
4029
4417
|
*
|
|
4418
|
+
* @group Modules
|
|
4419
|
+
* @category Storage
|
|
4420
|
+
*
|
|
4030
4421
|
* @public
|
|
4031
4422
|
*/
|
|
4032
4423
|
export declare const RemoveAllResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4046,6 +4437,9 @@ export declare const RemoveAllResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4046
4437
|
* Result object for removing all values.
|
|
4047
4438
|
* This operation returns no data on success.
|
|
4048
4439
|
*
|
|
4440
|
+
* @group Modules
|
|
4441
|
+
* @category Storage
|
|
4442
|
+
*
|
|
4049
4443
|
* @public
|
|
4050
4444
|
*/
|
|
4051
4445
|
export declare type RemoveAllResult = void;
|
|
@@ -4053,6 +4447,9 @@ export declare type RemoveAllResult = void;
|
|
|
4053
4447
|
/**
|
|
4054
4448
|
* Response when removing a value.
|
|
4055
4449
|
*
|
|
4450
|
+
* @group Modules
|
|
4451
|
+
* @category Storage
|
|
4452
|
+
*
|
|
4056
4453
|
* @remarks
|
|
4057
4454
|
* This response can have the following status codes:
|
|
4058
4455
|
* - `204`: Value removed successfully.
|
|
@@ -4068,6 +4465,9 @@ export declare type RemoveResponse = InferOutput<typeof RemoveResponseSchema>;
|
|
|
4068
4465
|
/**
|
|
4069
4466
|
* Valibot schema for {@link RemoveResponse}.
|
|
4070
4467
|
*
|
|
4468
|
+
* @group Modules
|
|
4469
|
+
* @category Storage
|
|
4470
|
+
*
|
|
4071
4471
|
* @public
|
|
4072
4472
|
*/
|
|
4073
4473
|
export declare const RemoveResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4090,6 +4490,9 @@ export declare const RemoveResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4090
4490
|
* Result object for removing a value.
|
|
4091
4491
|
* This operation returns no data on success.
|
|
4092
4492
|
*
|
|
4493
|
+
* @group Modules
|
|
4494
|
+
* @category Storage
|
|
4495
|
+
*
|
|
4093
4496
|
* @public
|
|
4094
4497
|
*/
|
|
4095
4498
|
export declare type RemoveResult = void;
|
|
@@ -4097,6 +4500,9 @@ export declare type RemoveResult = void;
|
|
|
4097
4500
|
/**
|
|
4098
4501
|
* Request parameters for scanning QR codes.
|
|
4099
4502
|
*
|
|
4503
|
+
* @group Modules
|
|
4504
|
+
* @category Camera
|
|
4505
|
+
*
|
|
4100
4506
|
* @example
|
|
4101
4507
|
* **Request with custom title:**
|
|
4102
4508
|
* ```typescript
|
|
@@ -4116,6 +4522,9 @@ export declare type ScanQRCodeRequest = InferOutput<typeof ScanQRCodeRequestSche
|
|
|
4116
4522
|
/**
|
|
4117
4523
|
* Valibot schema for {@link ScanQRCodeRequest}.
|
|
4118
4524
|
*
|
|
4525
|
+
* @group Modules
|
|
4526
|
+
* @category Camera
|
|
4527
|
+
*
|
|
4119
4528
|
* @public
|
|
4120
4529
|
*/
|
|
4121
4530
|
export declare const ScanQRCodeRequestSchema: v.ObjectSchema<{
|
|
@@ -4125,6 +4534,9 @@ export declare const ScanQRCodeRequestSchema: v.ObjectSchema<{
|
|
|
4125
4534
|
/**
|
|
4126
4535
|
* Response when scanning a QR code.
|
|
4127
4536
|
*
|
|
4537
|
+
* @group Modules
|
|
4538
|
+
* @category Camera
|
|
4539
|
+
*
|
|
4128
4540
|
* @remarks
|
|
4129
4541
|
* This response can have the following status codes:
|
|
4130
4542
|
* - `200`: Successfully scanned QR code. The `result` contains the scanned QR code data.
|
|
@@ -4141,6 +4553,9 @@ export declare type ScanQRCodeResponse = InferOutput<typeof ScanQRCodeResponseSc
|
|
|
4141
4553
|
/**
|
|
4142
4554
|
* Valibot schema for {@link ScanQRCodeResponse}.
|
|
4143
4555
|
*
|
|
4556
|
+
* @group Modules
|
|
4557
|
+
* @category Camera
|
|
4558
|
+
*
|
|
4144
4559
|
* @public
|
|
4145
4560
|
*/
|
|
4146
4561
|
export declare const ScanQRCodeResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4167,6 +4582,9 @@ export declare const ScanQRCodeResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4167
4582
|
/**
|
|
4168
4583
|
* Result object containing the scanned QR code data.
|
|
4169
4584
|
*
|
|
4585
|
+
* @group Modules
|
|
4586
|
+
* @category Camera
|
|
4587
|
+
*
|
|
4170
4588
|
* @example
|
|
4171
4589
|
* ```typescript
|
|
4172
4590
|
* { qrCode: 'https://example.com/payment/123' }
|
|
@@ -4179,6 +4597,9 @@ export declare type ScanQRCodeResult = InferOutput<typeof ScanQRCodeResultSchema
|
|
|
4179
4597
|
/**
|
|
4180
4598
|
* Valibot schema for {@link ScanQRCodeResult}.
|
|
4181
4599
|
*
|
|
4600
|
+
* @group Modules
|
|
4601
|
+
* @category Camera
|
|
4602
|
+
*
|
|
4182
4603
|
* @public
|
|
4183
4604
|
*/
|
|
4184
4605
|
export declare const ScanQRCodeResultSchema: v.ObjectSchema<{
|
|
@@ -4186,9 +4607,10 @@ export declare const ScanQRCodeResultSchema: v.ObjectSchema<{
|
|
|
4186
4607
|
}, undefined>;
|
|
4187
4608
|
|
|
4188
4609
|
/**
|
|
4189
|
-
*
|
|
4610
|
+
* SDK module for checking and refreshing API access permissions via `JSBridge`.
|
|
4190
4611
|
*
|
|
4191
4612
|
* @group Modules
|
|
4613
|
+
* @category Scope
|
|
4192
4614
|
*
|
|
4193
4615
|
* @remarks
|
|
4194
4616
|
* Manages OAuth scope permissions, allowing the MiniApp to check access rights and reload scopes from the server.
|
|
@@ -4216,9 +4638,9 @@ export declare const ScanQRCodeResultSchema: v.ObjectSchema<{
|
|
|
4216
4638
|
export declare class ScopeModule extends BaseModule {
|
|
4217
4639
|
constructor();
|
|
4218
4640
|
/**
|
|
4219
|
-
* Checks if the current client has access to a specific JSBridge API method.
|
|
4641
|
+
* Checks if the current client has access to a specific `JSBridge` API method.
|
|
4220
4642
|
*
|
|
4221
|
-
* @param module - The name of the
|
|
4643
|
+
* @param module - The name of the SDK module to check access for (e.g., 'CameraModule').
|
|
4222
4644
|
* @param method - The method name within the module to check access for (e.g., 'scanQRCode').
|
|
4223
4645
|
*
|
|
4224
4646
|
* @returns Whether the MiniApp has permission to access the specified method. See {@link HasAccessToResponse}.
|
|
@@ -4279,9 +4701,149 @@ export declare class ScopeModule extends BaseModule {
|
|
|
4279
4701
|
reloadScopes(): Promise<ReloadScopesResponse>;
|
|
4280
4702
|
}
|
|
4281
4703
|
|
|
4704
|
+
/**
|
|
4705
|
+
* Client error status codes for SDK error responses.
|
|
4706
|
+
*
|
|
4707
|
+
* @group Core
|
|
4708
|
+
*
|
|
4709
|
+
* @public
|
|
4710
|
+
*/
|
|
4711
|
+
export declare type SDKClientErrorStatusCode = 400 | 401 | 403 | 404 | 424 | 426;
|
|
4712
|
+
|
|
4713
|
+
/**
|
|
4714
|
+
* SDK error status code response with a `error` message.
|
|
4715
|
+
*
|
|
4716
|
+
* @group Core
|
|
4717
|
+
*
|
|
4718
|
+
* @public
|
|
4719
|
+
*/
|
|
4720
|
+
export declare interface SDKErrorResponse<C extends SDKErrorStatusCode> {
|
|
4721
|
+
readonly status_code: C;
|
|
4722
|
+
readonly error: string;
|
|
4723
|
+
}
|
|
4724
|
+
|
|
4725
|
+
/**
|
|
4726
|
+
* Error status codes for SDK error responses.
|
|
4727
|
+
*
|
|
4728
|
+
* @group Core
|
|
4729
|
+
*
|
|
4730
|
+
* @public
|
|
4731
|
+
*/
|
|
4732
|
+
export declare type SDKErrorStatusCode = SDKClientErrorStatusCode | SDKServerErrorStatusCode;
|
|
4733
|
+
|
|
4734
|
+
/**
|
|
4735
|
+
* SDK `204` status code response.
|
|
4736
|
+
*
|
|
4737
|
+
* @group Core
|
|
4738
|
+
*
|
|
4739
|
+
* @public
|
|
4740
|
+
*/
|
|
4741
|
+
export declare interface SDKNoContentResponse {
|
|
4742
|
+
readonly status_code: 204;
|
|
4743
|
+
}
|
|
4744
|
+
|
|
4745
|
+
/**
|
|
4746
|
+
* SDK `200` status code response with a typed `result` payload.
|
|
4747
|
+
*
|
|
4748
|
+
* @group Core
|
|
4749
|
+
*
|
|
4750
|
+
* @public
|
|
4751
|
+
*/
|
|
4752
|
+
export declare interface SDKOkResponse<T> {
|
|
4753
|
+
readonly status_code: 200;
|
|
4754
|
+
readonly result: T;
|
|
4755
|
+
}
|
|
4756
|
+
|
|
4757
|
+
/**
|
|
4758
|
+
* SDK `302` status code response.
|
|
4759
|
+
*
|
|
4760
|
+
* @group Core
|
|
4761
|
+
*
|
|
4762
|
+
* @public
|
|
4763
|
+
*/
|
|
4764
|
+
export declare interface SDKRedirectResponse {
|
|
4765
|
+
readonly status_code: 302;
|
|
4766
|
+
}
|
|
4767
|
+
|
|
4768
|
+
/**
|
|
4769
|
+
* Base SDK response shape.
|
|
4770
|
+
*
|
|
4771
|
+
* @group Core
|
|
4772
|
+
*
|
|
4773
|
+
* @remarks
|
|
4774
|
+
* Use the type guards to narrow to a specific shape.
|
|
4775
|
+
*
|
|
4776
|
+
* @public
|
|
4777
|
+
*/
|
|
4778
|
+
export declare type SDKResponse = {
|
|
4779
|
+
/** HTTP-style status code indicating the outcome of the SDK method call */
|
|
4780
|
+
status_code: number;
|
|
4781
|
+
/** The result data from the SDK method, present on 200 status code responses */
|
|
4782
|
+
result?: unknown;
|
|
4783
|
+
/** Error message, present on error status code responses */
|
|
4784
|
+
error?: string;
|
|
4785
|
+
};
|
|
4786
|
+
|
|
4787
|
+
/**
|
|
4788
|
+
* Server error status codes for SDK error responses.
|
|
4789
|
+
*
|
|
4790
|
+
* @group Core
|
|
4791
|
+
*
|
|
4792
|
+
* @public
|
|
4793
|
+
*/
|
|
4794
|
+
export declare type SDKServerErrorStatusCode = 500 | 501;
|
|
4795
|
+
|
|
4796
|
+
/**
|
|
4797
|
+
* A stream for receiving continuous data from SDK methods (e.g., location updates).
|
|
4798
|
+
*
|
|
4799
|
+
* @group Core
|
|
4800
|
+
*
|
|
4801
|
+
* @remarks
|
|
4802
|
+
* Provides both Observable-like and Promise-like interfaces:
|
|
4803
|
+
* - Use `subscribe()` to receive all values over time
|
|
4804
|
+
* - Use `then()` or `await` to receive only the first value
|
|
4805
|
+
*
|
|
4806
|
+
* Note: Each `subscribe()` call creates a fresh subscription, allowing multiple independent listeners.
|
|
4807
|
+
*
|
|
4808
|
+
* @typeParam T - The response type emitted by the stream.
|
|
4809
|
+
*
|
|
4810
|
+
* @public
|
|
4811
|
+
*/
|
|
4812
|
+
export declare type SDKStream<T extends SDKResponse = SDKResponse> = Readonly<{
|
|
4813
|
+
/**
|
|
4814
|
+
* Subscribe to receive stream data.
|
|
4815
|
+
*
|
|
4816
|
+
* @param handlers - Optional callbacks for data (`next`) and completion (`complete`).
|
|
4817
|
+
* @returns A `Subscription` to terminate the stream when needed.
|
|
4818
|
+
*/
|
|
4819
|
+
subscribe: (handlers?: SDKStreamHandlers<T>) => Subscription;
|
|
4820
|
+
}> & PromiseLike<T>;
|
|
4821
|
+
|
|
4822
|
+
/**
|
|
4823
|
+
* Callbacks for handling stream events.
|
|
4824
|
+
*
|
|
4825
|
+
* @group Core
|
|
4826
|
+
*
|
|
4827
|
+
* @remarks
|
|
4828
|
+
* Pass these to `subscribe()` to receive data via `next` and completion via `complete`.
|
|
4829
|
+
*
|
|
4830
|
+
* @typeParam T - The response type emitted by the stream.
|
|
4831
|
+
*
|
|
4832
|
+
* @public
|
|
4833
|
+
*/
|
|
4834
|
+
export declare type SDKStreamHandlers<T extends SDKResponse = SDKResponse> = Readonly<{
|
|
4835
|
+
/** Called with each new value from the stream. */
|
|
4836
|
+
next?: (data: T) => unknown;
|
|
4837
|
+
/** Called when the stream ends and no more data will arrive. */
|
|
4838
|
+
complete?: () => unknown;
|
|
4839
|
+
}>;
|
|
4840
|
+
|
|
4282
4841
|
/**
|
|
4283
4842
|
* Request parameters for sending analytics events.
|
|
4284
4843
|
*
|
|
4844
|
+
* @group Modules
|
|
4845
|
+
* @category Container
|
|
4846
|
+
*
|
|
4285
4847
|
* @remarks
|
|
4286
4848
|
* Use predefined constants to ensure consistency across the platform:
|
|
4287
4849
|
* - **States:** {@link ContainerAnalyticsEventState}
|
|
@@ -4313,6 +4875,9 @@ export declare type SendAnalyticsEventRequest = InferOutput<typeof SendAnalytics
|
|
|
4313
4875
|
/**
|
|
4314
4876
|
* Valibot schema for {@link SendAnalyticsEventRequest}.
|
|
4315
4877
|
*
|
|
4878
|
+
* @group Modules
|
|
4879
|
+
* @category Container
|
|
4880
|
+
*
|
|
4316
4881
|
* @public
|
|
4317
4882
|
*/
|
|
4318
4883
|
export declare const SendAnalyticsEventRequestSchema: v.ObjectSchema<{
|
|
@@ -4324,6 +4889,9 @@ export declare const SendAnalyticsEventRequestSchema: v.ObjectSchema<{
|
|
|
4324
4889
|
/**
|
|
4325
4890
|
* Response when sending analytics events.
|
|
4326
4891
|
*
|
|
4892
|
+
* @group Modules
|
|
4893
|
+
* @category Container
|
|
4894
|
+
*
|
|
4327
4895
|
* @remarks
|
|
4328
4896
|
* This response can have the following status codes:
|
|
4329
4897
|
* - `204`: Analytics event sent successfully.
|
|
@@ -4338,6 +4906,9 @@ export declare type SendAnalyticsEventResponse = InferOutput<typeof SendAnalytic
|
|
|
4338
4906
|
/**
|
|
4339
4907
|
* Valibot schema for {@link SendAnalyticsEventResponse}.
|
|
4340
4908
|
*
|
|
4909
|
+
* @group Modules
|
|
4910
|
+
* @category Container
|
|
4911
|
+
*
|
|
4341
4912
|
* @public
|
|
4342
4913
|
*/
|
|
4343
4914
|
export declare const SendAnalyticsEventResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4357,6 +4928,9 @@ export declare const SendAnalyticsEventResponseSchema: v.UnionSchema<[v.ObjectSc
|
|
|
4357
4928
|
* Result when sending analytics events.
|
|
4358
4929
|
* This operation returns no data on success.
|
|
4359
4930
|
*
|
|
4931
|
+
* @group Modules
|
|
4932
|
+
* @category Container
|
|
4933
|
+
*
|
|
4360
4934
|
* @public
|
|
4361
4935
|
*/
|
|
4362
4936
|
export declare type SendAnalyticsEventResult = void;
|
|
@@ -4364,6 +4938,9 @@ export declare type SendAnalyticsEventResult = void;
|
|
|
4364
4938
|
/**
|
|
4365
4939
|
* Request parameters for sending a network request.
|
|
4366
4940
|
*
|
|
4941
|
+
* @group Modules
|
|
4942
|
+
* @category Network
|
|
4943
|
+
*
|
|
4367
4944
|
* @example
|
|
4368
4945
|
* **GET request with headers:**
|
|
4369
4946
|
* ```typescript
|
|
@@ -4403,6 +4980,9 @@ export declare type SendRequest = InferOutput<typeof SendRequestSchema>;
|
|
|
4403
4980
|
/**
|
|
4404
4981
|
* Valibot schema for {@link SendRequest}.
|
|
4405
4982
|
*
|
|
4983
|
+
* @group Modules
|
|
4984
|
+
* @category Network
|
|
4985
|
+
*
|
|
4406
4986
|
* @remarks
|
|
4407
4987
|
* This schema defines the structure of a network request with the following properties:
|
|
4408
4988
|
* - `endpoint`: API endpoint URL to send the request to
|
|
@@ -4426,6 +5006,9 @@ export declare const SendRequestSchema: v.ObjectSchema<{
|
|
|
4426
5006
|
/**
|
|
4427
5007
|
* Response when sending a network request.
|
|
4428
5008
|
*
|
|
5009
|
+
* @group Modules
|
|
5010
|
+
* @category Network
|
|
5011
|
+
*
|
|
4429
5012
|
* @remarks
|
|
4430
5013
|
* This response can have any HTTP status code returned by the external API:
|
|
4431
5014
|
* - Success codes (2xx): Contains the `result` with response data, except 204 which has no body.
|
|
@@ -4440,6 +5023,9 @@ export declare type SendResponse = InferOutput<typeof SendResponseSchema>;
|
|
|
4440
5023
|
/**
|
|
4441
5024
|
* Valibot schema for {@link SendResponse}.
|
|
4442
5025
|
*
|
|
5026
|
+
* @group Modules
|
|
5027
|
+
* @category Network
|
|
5028
|
+
*
|
|
4443
5029
|
* @public
|
|
4444
5030
|
*/
|
|
4445
5031
|
export declare const SendResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4476,9 +5062,12 @@ export declare const SendResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4476
5062
|
/**
|
|
4477
5063
|
* Result object containing the network response data.
|
|
4478
5064
|
*
|
|
5065
|
+
* @group Modules
|
|
5066
|
+
* @category Network
|
|
5067
|
+
*
|
|
4479
5068
|
* @remarks
|
|
4480
5069
|
* The result type is `Record<string, unknown>` as response bodies are always
|
|
4481
|
-
* returned as objects. String responses from
|
|
5070
|
+
* returned as objects. String responses from `JSBridge` are automatically
|
|
4482
5071
|
* parsed to JSON.
|
|
4483
5072
|
*
|
|
4484
5073
|
* @public
|
|
@@ -4488,6 +5077,9 @@ export declare type SendResult = InferOutput<typeof SendResultSchema>;
|
|
|
4488
5077
|
/**
|
|
4489
5078
|
* Valibot schema for {@link SendResult}.
|
|
4490
5079
|
*
|
|
5080
|
+
* @group Modules
|
|
5081
|
+
* @category Network
|
|
5082
|
+
*
|
|
4491
5083
|
* @public
|
|
4492
5084
|
*/
|
|
4493
5085
|
export declare const SendResultSchema: v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>;
|
|
@@ -4495,6 +5087,9 @@ export declare const SendResultSchema: v.RecordSchema<v.StringSchema<undefined>,
|
|
|
4495
5087
|
/**
|
|
4496
5088
|
* Request parameters for setting the background color.
|
|
4497
5089
|
*
|
|
5090
|
+
* @group Modules
|
|
5091
|
+
* @category Container
|
|
5092
|
+
*
|
|
4498
5093
|
* @example
|
|
4499
5094
|
* ```typescript
|
|
4500
5095
|
* '#ffffff'
|
|
@@ -4507,6 +5102,9 @@ export declare type SetBackgroundColorRequest = string;
|
|
|
4507
5102
|
/**
|
|
4508
5103
|
* Response when setting the background color.
|
|
4509
5104
|
*
|
|
5105
|
+
* @group Modules
|
|
5106
|
+
* @category Container
|
|
5107
|
+
*
|
|
4510
5108
|
* @remarks
|
|
4511
5109
|
* This response can have the following status codes:
|
|
4512
5110
|
* - `204`: Background color set successfully.
|
|
@@ -4521,6 +5119,9 @@ export declare type SetBackgroundColorResponse = InferOutput<typeof SetBackgroun
|
|
|
4521
5119
|
/**
|
|
4522
5120
|
* Valibot schema for {@link SetBackgroundColorResponse}.
|
|
4523
5121
|
*
|
|
5122
|
+
* @group Modules
|
|
5123
|
+
* @category Container
|
|
5124
|
+
*
|
|
4524
5125
|
* @public
|
|
4525
5126
|
*/
|
|
4526
5127
|
export declare const SetBackgroundColorResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4540,6 +5141,9 @@ export declare const SetBackgroundColorResponseSchema: v.UnionSchema<[v.ObjectSc
|
|
|
4540
5141
|
* Result when setting the background color.
|
|
4541
5142
|
* This operation returns no data on success.
|
|
4542
5143
|
*
|
|
5144
|
+
* @group Modules
|
|
5145
|
+
* @category Container
|
|
5146
|
+
*
|
|
4543
5147
|
* @public
|
|
4544
5148
|
*/
|
|
4545
5149
|
export declare type SetBackgroundColorResult = void;
|
|
@@ -4547,6 +5151,9 @@ export declare type SetBackgroundColorResult = void;
|
|
|
4547
5151
|
/**
|
|
4548
5152
|
* Request parameters for storing a boolean value in storage.
|
|
4549
5153
|
*
|
|
5154
|
+
* @group Modules
|
|
5155
|
+
* @category Storage
|
|
5156
|
+
*
|
|
4550
5157
|
* @example
|
|
4551
5158
|
* ```typescript
|
|
4552
5159
|
* { key: 'isDarkMode', value: true }
|
|
@@ -4559,6 +5166,9 @@ export declare type SetBooleanRequest = InferOutput<typeof SetBooleanRequestSche
|
|
|
4559
5166
|
/**
|
|
4560
5167
|
* Valibot schema for {@link SetBooleanRequest}.
|
|
4561
5168
|
*
|
|
5169
|
+
* @group Modules
|
|
5170
|
+
* @category Storage
|
|
5171
|
+
*
|
|
4562
5172
|
* @public
|
|
4563
5173
|
*/
|
|
4564
5174
|
export declare const SetBooleanRequestSchema: v.ObjectSchema<{
|
|
@@ -4569,6 +5179,9 @@ export declare const SetBooleanRequestSchema: v.ObjectSchema<{
|
|
|
4569
5179
|
/**
|
|
4570
5180
|
* Response when setting a boolean value.
|
|
4571
5181
|
*
|
|
5182
|
+
* @group Modules
|
|
5183
|
+
* @category Storage
|
|
5184
|
+
*
|
|
4572
5185
|
* @remarks
|
|
4573
5186
|
* This response can have the following status codes:
|
|
4574
5187
|
* - `204`: Value stored successfully.
|
|
@@ -4584,6 +5197,9 @@ export declare type SetBooleanResponse = InferOutput<typeof SetBooleanResponseSc
|
|
|
4584
5197
|
/**
|
|
4585
5198
|
* Valibot schema for {@link SetBooleanResponse}.
|
|
4586
5199
|
*
|
|
5200
|
+
* @group Modules
|
|
5201
|
+
* @category Storage
|
|
5202
|
+
*
|
|
4587
5203
|
* @public
|
|
4588
5204
|
*/
|
|
4589
5205
|
export declare const SetBooleanResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4606,6 +5222,9 @@ export declare const SetBooleanResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4606
5222
|
* Result object for setting a boolean value.
|
|
4607
5223
|
* This operation returns no data on success.
|
|
4608
5224
|
*
|
|
5225
|
+
* @group Modules
|
|
5226
|
+
* @category Storage
|
|
5227
|
+
*
|
|
4609
5228
|
* @public
|
|
4610
5229
|
*/
|
|
4611
5230
|
export declare type SetBooleanResult = void;
|
|
@@ -4613,6 +5232,9 @@ export declare type SetBooleanResult = void;
|
|
|
4613
5232
|
/**
|
|
4614
5233
|
* Request parameters for storing a double value in storage.
|
|
4615
5234
|
*
|
|
5235
|
+
* @group Modules
|
|
5236
|
+
* @category Storage
|
|
5237
|
+
*
|
|
4616
5238
|
* @example
|
|
4617
5239
|
* ```typescript
|
|
4618
5240
|
* { key: 'price', value: 19.99 }
|
|
@@ -4625,6 +5247,9 @@ export declare type SetDoubleRequest = InferOutput<typeof SetDoubleRequestSchema
|
|
|
4625
5247
|
/**
|
|
4626
5248
|
* Valibot schema for {@link SetDoubleRequest}.
|
|
4627
5249
|
*
|
|
5250
|
+
* @group Modules
|
|
5251
|
+
* @category Storage
|
|
5252
|
+
*
|
|
4628
5253
|
* @public
|
|
4629
5254
|
*/
|
|
4630
5255
|
export declare const SetDoubleRequestSchema: v.ObjectSchema<{
|
|
@@ -4635,6 +5260,9 @@ export declare const SetDoubleRequestSchema: v.ObjectSchema<{
|
|
|
4635
5260
|
/**
|
|
4636
5261
|
* Response when setting a double value.
|
|
4637
5262
|
*
|
|
5263
|
+
* @group Modules
|
|
5264
|
+
* @category Storage
|
|
5265
|
+
*
|
|
4638
5266
|
* @remarks
|
|
4639
5267
|
* This response can have the following status codes:
|
|
4640
5268
|
* - `204`: Value stored successfully.
|
|
@@ -4650,6 +5278,9 @@ export declare type SetDoubleResponse = InferOutput<typeof SetDoubleResponseSche
|
|
|
4650
5278
|
/**
|
|
4651
5279
|
* Valibot schema for {@link SetDoubleResponse}.
|
|
4652
5280
|
*
|
|
5281
|
+
* @group Modules
|
|
5282
|
+
* @category Storage
|
|
5283
|
+
*
|
|
4653
5284
|
* @public
|
|
4654
5285
|
*/
|
|
4655
5286
|
export declare const SetDoubleResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4672,6 +5303,9 @@ export declare const SetDoubleResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4672
5303
|
* Result object for setting a double value.
|
|
4673
5304
|
* This operation returns no data on success.
|
|
4674
5305
|
*
|
|
5306
|
+
* @group Modules
|
|
5307
|
+
* @category Storage
|
|
5308
|
+
*
|
|
4675
5309
|
* @public
|
|
4676
5310
|
*/
|
|
4677
5311
|
export declare type SetDoubleResult = void;
|
|
@@ -4679,6 +5313,9 @@ export declare type SetDoubleResult = void;
|
|
|
4679
5313
|
/**
|
|
4680
5314
|
* Request parameters for storing an integer value in storage.
|
|
4681
5315
|
*
|
|
5316
|
+
* @group Modules
|
|
5317
|
+
* @category Storage
|
|
5318
|
+
*
|
|
4682
5319
|
* @example
|
|
4683
5320
|
* ```typescript
|
|
4684
5321
|
* { key: 'userCount', value: 42 }
|
|
@@ -4691,6 +5328,9 @@ export declare type SetIntRequest = InferOutput<typeof SetIntRequestSchema>;
|
|
|
4691
5328
|
/**
|
|
4692
5329
|
* Valibot schema for {@link SetIntRequest}.
|
|
4693
5330
|
*
|
|
5331
|
+
* @group Modules
|
|
5332
|
+
* @category Storage
|
|
5333
|
+
*
|
|
4694
5334
|
* @public
|
|
4695
5335
|
*/
|
|
4696
5336
|
export declare const SetIntRequestSchema: v.ObjectSchema<{
|
|
@@ -4701,6 +5341,9 @@ export declare const SetIntRequestSchema: v.ObjectSchema<{
|
|
|
4701
5341
|
/**
|
|
4702
5342
|
* Response when setting an integer value.
|
|
4703
5343
|
*
|
|
5344
|
+
* @group Modules
|
|
5345
|
+
* @category Storage
|
|
5346
|
+
*
|
|
4704
5347
|
* @remarks
|
|
4705
5348
|
* This response can have the following status codes:
|
|
4706
5349
|
* - `204`: Value stored successfully.
|
|
@@ -4716,6 +5359,9 @@ export declare type SetIntResponse = InferOutput<typeof SetIntResponseSchema>;
|
|
|
4716
5359
|
/**
|
|
4717
5360
|
* Valibot schema for {@link SetIntResponse}.
|
|
4718
5361
|
*
|
|
5362
|
+
* @group Modules
|
|
5363
|
+
* @category Storage
|
|
5364
|
+
*
|
|
4719
5365
|
* @public
|
|
4720
5366
|
*/
|
|
4721
5367
|
export declare const SetIntResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4738,6 +5384,9 @@ export declare const SetIntResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4738
5384
|
* Result object for setting an integer value.
|
|
4739
5385
|
* This operation returns no data on success.
|
|
4740
5386
|
*
|
|
5387
|
+
* @group Modules
|
|
5388
|
+
* @category Storage
|
|
5389
|
+
*
|
|
4741
5390
|
* @public
|
|
4742
5391
|
*/
|
|
4743
5392
|
export declare type SetIntResult = void;
|
|
@@ -4745,6 +5394,9 @@ export declare type SetIntResult = void;
|
|
|
4745
5394
|
/**
|
|
4746
5395
|
* Request parameters for storing a string value in storage.
|
|
4747
5396
|
*
|
|
5397
|
+
* @group Modules
|
|
5398
|
+
* @category Storage
|
|
5399
|
+
*
|
|
4748
5400
|
* @example
|
|
4749
5401
|
* ```typescript
|
|
4750
5402
|
* { key: 'username', value: 'john_doe' }
|
|
@@ -4757,6 +5409,9 @@ export declare type SetStringRequest = InferOutput<typeof SetStringRequestSchema
|
|
|
4757
5409
|
/**
|
|
4758
5410
|
* Valibot schema for {@link SetStringRequest}.
|
|
4759
5411
|
*
|
|
5412
|
+
* @group Modules
|
|
5413
|
+
* @category Storage
|
|
5414
|
+
*
|
|
4760
5415
|
* @public
|
|
4761
5416
|
*/
|
|
4762
5417
|
export declare const SetStringRequestSchema: v.ObjectSchema<{
|
|
@@ -4767,6 +5422,9 @@ export declare const SetStringRequestSchema: v.ObjectSchema<{
|
|
|
4767
5422
|
/**
|
|
4768
5423
|
* Response when setting a string value.
|
|
4769
5424
|
*
|
|
5425
|
+
* @group Modules
|
|
5426
|
+
* @category Storage
|
|
5427
|
+
*
|
|
4770
5428
|
* @remarks
|
|
4771
5429
|
* This response can have the following status codes:
|
|
4772
5430
|
* - `204`: Value stored successfully.
|
|
@@ -4782,6 +5440,9 @@ export declare type SetStringResponse = InferOutput<typeof SetStringResponseSche
|
|
|
4782
5440
|
/**
|
|
4783
5441
|
* Valibot schema for {@link SetStringResponse}.
|
|
4784
5442
|
*
|
|
5443
|
+
* @group Modules
|
|
5444
|
+
* @category Storage
|
|
5445
|
+
*
|
|
4785
5446
|
* @public
|
|
4786
5447
|
*/
|
|
4787
5448
|
export declare const SetStringResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4804,6 +5465,9 @@ export declare const SetStringResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4804
5465
|
* Result object for setting a string value.
|
|
4805
5466
|
* This operation returns no data on success.
|
|
4806
5467
|
*
|
|
5468
|
+
* @group Modules
|
|
5469
|
+
* @category Storage
|
|
5470
|
+
*
|
|
4807
5471
|
* @public
|
|
4808
5472
|
*/
|
|
4809
5473
|
export declare type SetStringResult = void;
|
|
@@ -4811,6 +5475,9 @@ export declare type SetStringResult = void;
|
|
|
4811
5475
|
/**
|
|
4812
5476
|
* Request parameters for setting the title.
|
|
4813
5477
|
*
|
|
5478
|
+
* @group Modules
|
|
5479
|
+
* @category Container
|
|
5480
|
+
*
|
|
4814
5481
|
* @example
|
|
4815
5482
|
* ```typescript
|
|
4816
5483
|
* 'Home Page'
|
|
@@ -4823,6 +5490,9 @@ export declare type SetTitleRequest = string;
|
|
|
4823
5490
|
/**
|
|
4824
5491
|
* Response when setting the title.
|
|
4825
5492
|
*
|
|
5493
|
+
* @group Modules
|
|
5494
|
+
* @category Container
|
|
5495
|
+
*
|
|
4826
5496
|
* @remarks
|
|
4827
5497
|
* This response can have the following status codes:
|
|
4828
5498
|
* - `204`: Title set successfully.
|
|
@@ -4837,6 +5507,9 @@ export declare type SetTitleResponse = InferOutput<typeof SetTitleResponseSchema
|
|
|
4837
5507
|
/**
|
|
4838
5508
|
* Valibot schema for {@link SetTitleResponse}.
|
|
4839
5509
|
*
|
|
5510
|
+
* @group Modules
|
|
5511
|
+
* @category Container
|
|
5512
|
+
*
|
|
4840
5513
|
* @public
|
|
4841
5514
|
*/
|
|
4842
5515
|
export declare const SetTitleResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4856,6 +5529,9 @@ export declare const SetTitleResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4856
5529
|
* Result when setting the title.
|
|
4857
5530
|
* This operation returns no data on success.
|
|
4858
5531
|
*
|
|
5532
|
+
* @group Modules
|
|
5533
|
+
* @category Container
|
|
5534
|
+
*
|
|
4859
5535
|
* @public
|
|
4860
5536
|
*/
|
|
4861
5537
|
export declare type SetTitleResult = void;
|
|
@@ -4863,6 +5539,9 @@ export declare type SetTitleResult = void;
|
|
|
4863
5539
|
/**
|
|
4864
5540
|
* Response when showing the back button.
|
|
4865
5541
|
*
|
|
5542
|
+
* @group Modules
|
|
5543
|
+
* @category Container
|
|
5544
|
+
*
|
|
4866
5545
|
* @remarks
|
|
4867
5546
|
* This response can have the following status codes:
|
|
4868
5547
|
* - `204`: Back button shown successfully.
|
|
@@ -4876,6 +5555,9 @@ export declare type ShowBackButtonResponse = InferOutput<typeof ShowBackButtonRe
|
|
|
4876
5555
|
/**
|
|
4877
5556
|
* Valibot schema for {@link ShowBackButtonResponse}.
|
|
4878
5557
|
*
|
|
5558
|
+
* @group Modules
|
|
5559
|
+
* @category Container
|
|
5560
|
+
*
|
|
4879
5561
|
* @public
|
|
4880
5562
|
*/
|
|
4881
5563
|
export declare const ShowBackButtonResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4892,6 +5574,9 @@ export declare const ShowBackButtonResponseSchema: v.UnionSchema<[v.ObjectSchema
|
|
|
4892
5574
|
* Result when showing the back button.
|
|
4893
5575
|
* This operation returns no data on success.
|
|
4894
5576
|
*
|
|
5577
|
+
* @group Modules
|
|
5578
|
+
* @category Container
|
|
5579
|
+
*
|
|
4895
5580
|
* @public
|
|
4896
5581
|
*/
|
|
4897
5582
|
export declare type ShowBackButtonResult = void;
|
|
@@ -4899,6 +5584,9 @@ export declare type ShowBackButtonResult = void;
|
|
|
4899
5584
|
/**
|
|
4900
5585
|
* Response when showing the loader.
|
|
4901
5586
|
*
|
|
5587
|
+
* @group Modules
|
|
5588
|
+
* @category Container
|
|
5589
|
+
*
|
|
4902
5590
|
* @remarks
|
|
4903
5591
|
* This response can have the following status codes:
|
|
4904
5592
|
* - `204`: Loader shown successfully.
|
|
@@ -4912,6 +5600,9 @@ export declare type ShowLoaderResponse = InferOutput<typeof ShowLoaderResponseSc
|
|
|
4912
5600
|
/**
|
|
4913
5601
|
* Valibot schema for {@link ShowLoaderResponse}.
|
|
4914
5602
|
*
|
|
5603
|
+
* @group Modules
|
|
5604
|
+
* @category Container
|
|
5605
|
+
*
|
|
4915
5606
|
* @public
|
|
4916
5607
|
*/
|
|
4917
5608
|
export declare const ShowLoaderResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4928,6 +5619,9 @@ export declare const ShowLoaderResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4928
5619
|
* Result when showing the loader.
|
|
4929
5620
|
* This operation returns no data on success.
|
|
4930
5621
|
*
|
|
5622
|
+
* @group Modules
|
|
5623
|
+
* @category Container
|
|
5624
|
+
*
|
|
4931
5625
|
* @public
|
|
4932
5626
|
*/
|
|
4933
5627
|
export declare type ShowLoaderResult = void;
|
|
@@ -4935,6 +5629,9 @@ export declare type ShowLoaderResult = void;
|
|
|
4935
5629
|
/**
|
|
4936
5630
|
* Response when showing the refresh button.
|
|
4937
5631
|
*
|
|
5632
|
+
* @group Modules
|
|
5633
|
+
* @category Container
|
|
5634
|
+
*
|
|
4938
5635
|
* @remarks
|
|
4939
5636
|
* This response can have the following status codes:
|
|
4940
5637
|
* - `204`: Refresh button shown successfully.
|
|
@@ -4948,6 +5645,9 @@ export declare type ShowRefreshButtonResponse = InferOutput<typeof ShowRefreshBu
|
|
|
4948
5645
|
/**
|
|
4949
5646
|
* Valibot schema for {@link ShowRefreshButtonResponse}.
|
|
4950
5647
|
*
|
|
5648
|
+
* @group Modules
|
|
5649
|
+
* @category Container
|
|
5650
|
+
*
|
|
4951
5651
|
* @public
|
|
4952
5652
|
*/
|
|
4953
5653
|
export declare const ShowRefreshButtonResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4964,14 +5664,18 @@ export declare const ShowRefreshButtonResponseSchema: v.UnionSchema<[v.ObjectSch
|
|
|
4964
5664
|
* Result when showing the refresh button.
|
|
4965
5665
|
* This operation returns no data on success.
|
|
4966
5666
|
*
|
|
5667
|
+
* @group Modules
|
|
5668
|
+
* @category Container
|
|
5669
|
+
*
|
|
4967
5670
|
* @public
|
|
4968
5671
|
*/
|
|
4969
5672
|
export declare type ShowRefreshButtonResult = void;
|
|
4970
5673
|
|
|
4971
5674
|
/**
|
|
4972
|
-
*
|
|
5675
|
+
* SDK module for controlling the native splash / Lottie loading screen via `JSBridge`.
|
|
4973
5676
|
*
|
|
4974
5677
|
* @group Modules
|
|
5678
|
+
* @category Splash Screen
|
|
4975
5679
|
*
|
|
4976
5680
|
* @remarks
|
|
4977
5681
|
* Dismisses the splash overlay once the MiniApp is ready. Requires the Grab SuperApp WebView.
|
|
@@ -5024,9 +5728,10 @@ export declare class SplashScreenModule extends BaseModule {
|
|
|
5024
5728
|
}
|
|
5025
5729
|
|
|
5026
5730
|
/**
|
|
5027
|
-
*
|
|
5731
|
+
* SDK module for persisting key-value data to native storage via `JSBridge`.
|
|
5028
5732
|
*
|
|
5029
5733
|
* @group Modules
|
|
5734
|
+
* @category Storage
|
|
5030
5735
|
*
|
|
5031
5736
|
* @remarks
|
|
5032
5737
|
* Stores data in the native app's persistent storage, allowing data to survive WebView restarts.
|
|
@@ -5405,7 +6110,9 @@ export declare class StorageModule extends BaseModule {
|
|
|
5405
6110
|
}
|
|
5406
6111
|
|
|
5407
6112
|
/**
|
|
5408
|
-
* Controls an active stream subscription.
|
|
6113
|
+
* Controls an active stream subscription.
|
|
6114
|
+
*
|
|
6115
|
+
* @group Core
|
|
5409
6116
|
*
|
|
5410
6117
|
* @remarks
|
|
5411
6118
|
* Returned by `subscribe()`. Use `unsubscribe()` to terminate the stream early.
|
|
@@ -5414,16 +6121,17 @@ export declare class StorageModule extends BaseModule {
|
|
|
5414
6121
|
* @public
|
|
5415
6122
|
*/
|
|
5416
6123
|
export declare type Subscription = Readonly<{
|
|
5417
|
-
/** Returns true if this subscription has been terminated. */
|
|
6124
|
+
/** Returns `true` if this subscription has been terminated. */
|
|
5418
6125
|
isUnsubscribed: () => boolean;
|
|
5419
6126
|
/** Terminates the subscription. No further data will be received. */
|
|
5420
6127
|
unsubscribe: () => unknown;
|
|
5421
6128
|
}>;
|
|
5422
6129
|
|
|
5423
6130
|
/**
|
|
5424
|
-
*
|
|
6131
|
+
* SDK module for opening URLs in the device's system browser via `JSBridge`.
|
|
5425
6132
|
*
|
|
5426
6133
|
* @group Modules
|
|
6134
|
+
* @category System WebView Kit
|
|
5427
6135
|
*
|
|
5428
6136
|
* @remarks
|
|
5429
6137
|
* Allows MiniApps to redirect users to external content using the native system browser.
|
|
@@ -5488,6 +6196,9 @@ export declare class SystemWebViewKitModule extends BaseModule {
|
|
|
5488
6196
|
/**
|
|
5489
6197
|
* Request parameters for triggering the checkout flow.
|
|
5490
6198
|
*
|
|
6199
|
+
* @group Modules
|
|
6200
|
+
* @category Checkout
|
|
6201
|
+
*
|
|
5491
6202
|
* @remarks
|
|
5492
6203
|
* This type is intentionally flexible as the checkout parameters vary depending on the specific payment flow and partner requirements.
|
|
5493
6204
|
* Consult the Grab SuperApp SDK documentation for the specific parameters required for your use case.
|
|
@@ -5512,6 +6223,9 @@ export declare type TriggerCheckoutRequest = InferOutput<typeof TriggerCheckoutR
|
|
|
5512
6223
|
/**
|
|
5513
6224
|
* Valibot schema for {@link TriggerCheckoutRequest}.
|
|
5514
6225
|
*
|
|
6226
|
+
* @group Modules
|
|
6227
|
+
* @category Checkout
|
|
6228
|
+
*
|
|
5515
6229
|
* @remarks
|
|
5516
6230
|
* The checkout parameters vary depending on the specific payment flow and partner requirements.
|
|
5517
6231
|
*
|
|
@@ -5522,6 +6236,9 @@ export declare const TriggerCheckoutRequestSchema: v.RecordSchema<v.StringSchema
|
|
|
5522
6236
|
/**
|
|
5523
6237
|
* Response when triggering the checkout flow.
|
|
5524
6238
|
*
|
|
6239
|
+
* @group Modules
|
|
6240
|
+
* @category Checkout
|
|
6241
|
+
*
|
|
5525
6242
|
* @remarks
|
|
5526
6243
|
* This response can have the following status codes:
|
|
5527
6244
|
* - `200`: Checkout completed successfully. The `result` contains transaction details.
|
|
@@ -5536,6 +6253,9 @@ export declare type TriggerCheckoutResponse = InferOutput<typeof TriggerCheckout
|
|
|
5536
6253
|
/**
|
|
5537
6254
|
* Valibot schema for {@link TriggerCheckoutResponse}.
|
|
5538
6255
|
*
|
|
6256
|
+
* @group Modules
|
|
6257
|
+
* @category Checkout
|
|
6258
|
+
*
|
|
5539
6259
|
* @public
|
|
5540
6260
|
*/
|
|
5541
6261
|
export declare const TriggerCheckoutResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -5568,6 +6288,9 @@ export declare const TriggerCheckoutResponseSchema: v.UnionSchema<[v.ObjectSchem
|
|
|
5568
6288
|
/**
|
|
5569
6289
|
* Result object containing the checkout transaction details.
|
|
5570
6290
|
*
|
|
6291
|
+
* @group Modules
|
|
6292
|
+
* @category Checkout
|
|
6293
|
+
*
|
|
5571
6294
|
* @remarks
|
|
5572
6295
|
* - `status: 'success'` → `transactionID`
|
|
5573
6296
|
* - `status: 'failure'` → `transactionID`, `errorMessage`, `errorCode`
|
|
@@ -5618,6 +6341,9 @@ export declare type TriggerCheckoutResult = InferOutput<typeof TriggerCheckoutRe
|
|
|
5618
6341
|
/**
|
|
5619
6342
|
* Valibot schema for {@link TriggerCheckoutResult}.
|
|
5620
6343
|
*
|
|
6344
|
+
* @group Modules
|
|
6345
|
+
* @category Checkout
|
|
6346
|
+
*
|
|
5621
6347
|
* @public
|
|
5622
6348
|
*/
|
|
5623
6349
|
export declare const TriggerCheckoutResultSchema: v.VariantSchema<"status", [v.ObjectSchema<{
|
|
@@ -5636,9 +6362,10 @@ export declare const TriggerCheckoutResultSchema: v.VariantSchema<"status", [v.O
|
|
|
5636
6362
|
}, undefined>], undefined>;
|
|
5637
6363
|
|
|
5638
6364
|
/**
|
|
5639
|
-
*
|
|
6365
|
+
* SDK module for reading user-related attributes from native code via `JSBridge`.
|
|
5640
6366
|
*
|
|
5641
6367
|
* @group Modules
|
|
6368
|
+
* @category User Attributes
|
|
5642
6369
|
*
|
|
5643
6370
|
* @remarks
|
|
5644
6371
|
* Provides access to user and traveller attributes exposed by the native Grab app bridge.
|
|
@@ -5706,6 +6433,9 @@ export declare class UserAttributesModule extends BaseModule {
|
|
|
5706
6433
|
/**
|
|
5707
6434
|
* Request parameters for verifying the user's email.
|
|
5708
6435
|
*
|
|
6436
|
+
* @group Modules
|
|
6437
|
+
* @category Profile
|
|
6438
|
+
*
|
|
5709
6439
|
* @remarks
|
|
5710
6440
|
* Both properties are optional. If email is provided and skipUserInput is true,
|
|
5711
6441
|
* the verify OTP bottom sheet will be triggered directly without user editing.
|
|
@@ -5725,6 +6455,9 @@ export declare type VerifyEmailRequest = InferOutput<typeof VerifyEmailRequestSc
|
|
|
5725
6455
|
/**
|
|
5726
6456
|
* Valibot schema for {@link VerifyEmailRequest}.
|
|
5727
6457
|
*
|
|
6458
|
+
* @group Modules
|
|
6459
|
+
* @category Profile
|
|
6460
|
+
*
|
|
5728
6461
|
* @public
|
|
5729
6462
|
*/
|
|
5730
6463
|
export declare const VerifyEmailRequestSchema: v.ObjectSchema<{
|
|
@@ -5735,6 +6468,9 @@ export declare const VerifyEmailRequestSchema: v.ObjectSchema<{
|
|
|
5735
6468
|
/**
|
|
5736
6469
|
* Response when verifying the user's email.
|
|
5737
6470
|
*
|
|
6471
|
+
* @group Modules
|
|
6472
|
+
* @category Profile
|
|
6473
|
+
*
|
|
5738
6474
|
* @remarks
|
|
5739
6475
|
* This response can have the following status codes:
|
|
5740
6476
|
* - `200`: Success, email verified and returned in `result`.
|
|
@@ -5767,6 +6503,9 @@ export declare type VerifyEmailResponse = InferOutput<typeof VerifyEmailResponse
|
|
|
5767
6503
|
/**
|
|
5768
6504
|
* Valibot schema for {@link VerifyEmailResponse}.
|
|
5769
6505
|
*
|
|
6506
|
+
* @group Modules
|
|
6507
|
+
* @category Profile
|
|
6508
|
+
*
|
|
5770
6509
|
* @public
|
|
5771
6510
|
*/
|
|
5772
6511
|
export declare const VerifyEmailResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -5796,6 +6535,9 @@ export declare const VerifyEmailResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
5796
6535
|
/**
|
|
5797
6536
|
* Result object for verifying the user's email.
|
|
5798
6537
|
*
|
|
6538
|
+
* @group Modules
|
|
6539
|
+
* @category Profile
|
|
6540
|
+
*
|
|
5799
6541
|
* @example
|
|
5800
6542
|
* ```typescript
|
|
5801
6543
|
* { email: 'user@example.com' }
|
|
@@ -5808,6 +6550,9 @@ export declare type VerifyEmailResult = InferOutput<typeof VerifyEmailResultSche
|
|
|
5808
6550
|
/**
|
|
5809
6551
|
* Valibot schema for {@link VerifyEmailResult}.
|
|
5810
6552
|
*
|
|
6553
|
+
* @group Modules
|
|
6554
|
+
* @category Profile
|
|
6555
|
+
*
|
|
5811
6556
|
* @public
|
|
5812
6557
|
*/
|
|
5813
6558
|
export declare const VerifyEmailResultSchema: v.ObjectSchema<{
|
|
@@ -5817,6 +6562,8 @@ export declare const VerifyEmailResultSchema: v.ObjectSchema<{
|
|
|
5817
6562
|
/**
|
|
5818
6563
|
* Represents a semantic version with major, minor, and patch components.
|
|
5819
6564
|
*
|
|
6565
|
+
* @group Core
|
|
6566
|
+
*
|
|
5820
6567
|
* @public
|
|
5821
6568
|
*/
|
|
5822
6569
|
export declare interface Version {
|
|
@@ -5826,12 +6573,14 @@ export declare interface Version {
|
|
|
5826
6573
|
}
|
|
5827
6574
|
|
|
5828
6575
|
/**
|
|
5829
|
-
* Generic interface for all
|
|
6576
|
+
* Generic interface for all SDK module wrappers exposed through `JSBridge`.
|
|
6577
|
+
*
|
|
6578
|
+
* @group Core
|
|
5830
6579
|
*
|
|
5831
6580
|
* @public
|
|
5832
6581
|
*/
|
|
5833
6582
|
export declare interface WrappedModule {
|
|
5834
|
-
invoke(method: string, params?: unknown):
|
|
6583
|
+
invoke(method: string, params?: unknown): SDKStream | Promise<SDKResponse>;
|
|
5835
6584
|
}
|
|
5836
6585
|
|
|
5837
6586
|
export { }
|