@grabjs/superapp-sdk 2.0.0-beta.23 → 2.0.0-beta.28
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 +55 -55
- package/api-reference/api.json +44309 -0
- package/dist/index.d.ts +2163 -2607
- package/dist/index.esm.js +1 -1
- package/dist/index.js +1 -1
- package/package.json +14 -9
- package/skills/SKILL.md +368 -0
- package/api-reference/json/api.json +0 -27688
- package/api-reference/markdown/README.md +0 -194
- package/api-reference/markdown/classes/BaseModule.md +0 -123
- package/api-reference/markdown/classes/CameraModule.md +0 -177
- package/api-reference/markdown/classes/CheckoutModule.md +0 -181
- package/api-reference/markdown/classes/ContainerModule.md +0 -751
- package/api-reference/markdown/classes/DeviceCapabilityModule.md +0 -161
- package/api-reference/markdown/classes/FileModule.md +0 -178
- package/api-reference/markdown/classes/IdentityModule.md +0 -299
- package/api-reference/markdown/classes/LocaleModule.md +0 -161
- package/api-reference/markdown/classes/LocationModule.md +0 -239
- package/api-reference/markdown/classes/MediaModule.md +0 -219
- package/api-reference/markdown/classes/PlatformModule.md +0 -162
- package/api-reference/markdown/classes/ProfileModule.md +0 -224
- package/api-reference/markdown/classes/ScopeModule.md +0 -219
- package/api-reference/markdown/classes/StorageModule.md +0 -608
- package/api-reference/markdown/classes/SystemWebViewKitModule.md +0 -177
- package/api-reference/markdown/classes/UserAttributesModule.md +0 -164
- package/api-reference/markdown/functions/isClientError.md +0 -37
- package/api-reference/markdown/functions/isErrorResponse.md +0 -40
- package/api-reference/markdown/functions/isRedirection.md +0 -37
- package/api-reference/markdown/functions/isServerError.md +0 -37
- package/api-reference/markdown/functions/isSuccess.md +0 -39
- package/api-reference/markdown/globals.md +0 -176
- package/api-reference/markdown/interfaces/GrabAppInfo.md +0 -23
- package/api-reference/markdown/interfaces/InvokeOptions.md +0 -63
- package/api-reference/markdown/interfaces/Version.md +0 -23
- package/api-reference/markdown/interfaces/WrappedModule.md +0 -51
- package/api-reference/markdown/type-aliases/AuthorizeRequest.md +0 -79
- package/api-reference/markdown/type-aliases/AuthorizeResponse.md +0 -58
- package/api-reference/markdown/type-aliases/AuthorizeResult.md +0 -33
- package/api-reference/markdown/type-aliases/BackResponse.md +0 -37
- package/api-reference/markdown/type-aliases/BackResult.md +0 -8
- package/api-reference/markdown/type-aliases/BridgeClientError.md +0 -9
- package/api-reference/markdown/type-aliases/BridgeError.md +0 -8
- package/api-reference/markdown/type-aliases/BridgeRedirection.md +0 -8
- package/api-reference/markdown/type-aliases/BridgeResponse.md +0 -40
- package/api-reference/markdown/type-aliases/BridgeServerError.md +0 -8
- package/api-reference/markdown/type-aliases/BridgeStatusCode.md +0 -7
- package/api-reference/markdown/type-aliases/BridgeStream.md +0 -29
- package/api-reference/markdown/type-aliases/BridgeStreamHandlers.md +0 -25
- package/api-reference/markdown/type-aliases/BridgeSuccessResponse.md +0 -14
- package/api-reference/markdown/type-aliases/ClearAuthorizationArtifactsResponse.md +0 -18
- package/api-reference/markdown/type-aliases/ClearAuthorizationArtifactsResult.md +0 -8
- package/api-reference/markdown/type-aliases/CloseResponse.md +0 -37
- package/api-reference/markdown/type-aliases/CloseResult.md +0 -8
- package/api-reference/markdown/type-aliases/DRMContentConfig.md +0 -34
- package/api-reference/markdown/type-aliases/DRMPlaybackEvent.md +0 -43
- package/api-reference/markdown/type-aliases/DownloadFileRequest.md +0 -32
- package/api-reference/markdown/type-aliases/DownloadFileResponse.md +0 -48
- package/api-reference/markdown/type-aliases/DownloadFileResult.md +0 -11
- package/api-reference/markdown/type-aliases/ErrorResponse.md +0 -32
- package/api-reference/markdown/type-aliases/FetchEmailResponse.md +0 -58
- package/api-reference/markdown/type-aliases/FetchEmailResult.md +0 -21
- package/api-reference/markdown/type-aliases/GetAuthorizationArtifactsResponse.md +0 -42
- package/api-reference/markdown/type-aliases/GetAuthorizationArtifactsResult.md +0 -57
- package/api-reference/markdown/type-aliases/GetBooleanRequest.md +0 -21
- package/api-reference/markdown/type-aliases/GetBooleanResponse.md +0 -57
- package/api-reference/markdown/type-aliases/GetBooleanResult.md +0 -27
- package/api-reference/markdown/type-aliases/GetCoordinateResponse.md +0 -49
- package/api-reference/markdown/type-aliases/GetCoordinateResult.md +0 -29
- package/api-reference/markdown/type-aliases/GetCountryCodeResponse.md +0 -57
- package/api-reference/markdown/type-aliases/GetCountryCodeResult.md +0 -25
- package/api-reference/markdown/type-aliases/GetDoubleRequest.md +0 -21
- package/api-reference/markdown/type-aliases/GetDoubleResponse.md +0 -57
- package/api-reference/markdown/type-aliases/GetDoubleResult.md +0 -27
- package/api-reference/markdown/type-aliases/GetIntRequest.md +0 -21
- package/api-reference/markdown/type-aliases/GetIntResponse.md +0 -57
- package/api-reference/markdown/type-aliases/GetIntResult.md +0 -27
- package/api-reference/markdown/type-aliases/GetLanguageLocaleIdentifierResponse.md +0 -48
- package/api-reference/markdown/type-aliases/GetLanguageLocaleIdentifierResult.md +0 -31
- package/api-reference/markdown/type-aliases/GetSelectedTravelDestinationResponse.md +0 -48
- package/api-reference/markdown/type-aliases/GetSelectedTravelDestinationResult.md +0 -17
- package/api-reference/markdown/type-aliases/GetSessionParamsResponse.md +0 -40
- package/api-reference/markdown/type-aliases/GetSessionParamsResult.md +0 -27
- package/api-reference/markdown/type-aliases/GetStringRequest.md +0 -21
- package/api-reference/markdown/type-aliases/GetStringResponse.md +0 -57
- package/api-reference/markdown/type-aliases/GetStringResult.md +0 -27
- package/api-reference/markdown/type-aliases/HasAccessToResponse.md +0 -66
- package/api-reference/markdown/type-aliases/HasAccessToResult.md +0 -27
- package/api-reference/markdown/type-aliases/HideBackButtonResponse.md +0 -37
- package/api-reference/markdown/type-aliases/HideBackButtonResult.md +0 -8
- package/api-reference/markdown/type-aliases/HideLoaderResponse.md +0 -37
- package/api-reference/markdown/type-aliases/HideLoaderResult.md +0 -8
- package/api-reference/markdown/type-aliases/HideRefreshButtonResponse.md +0 -37
- package/api-reference/markdown/type-aliases/HideRefreshButtonResult.md +0 -8
- package/api-reference/markdown/type-aliases/IsConnectedResponse.md +0 -31
- package/api-reference/markdown/type-aliases/IsConnectedResult.md +0 -27
- package/api-reference/markdown/type-aliases/IsEsimSupportedResponse.md +0 -48
- package/api-reference/markdown/type-aliases/IsEsimSupportedResult.md +0 -17
- package/api-reference/markdown/type-aliases/ObserveDRMPlaybackResponse.md +0 -15
- package/api-reference/markdown/type-aliases/ObserveLocationChangeResponse.md +0 -15
- package/api-reference/markdown/type-aliases/OnContentLoadedResponse.md +0 -37
- package/api-reference/markdown/type-aliases/OnContentLoadedResult.md +0 -8
- package/api-reference/markdown/type-aliases/OnCtaTapRequest.md +0 -13
- package/api-reference/markdown/type-aliases/OnCtaTapResponse.md +0 -37
- package/api-reference/markdown/type-aliases/OnCtaTapResult.md +0 -8
- package/api-reference/markdown/type-aliases/OpenExternalLinkRequest.md +0 -13
- package/api-reference/markdown/type-aliases/OpenExternalLinkResponse.md +0 -46
- package/api-reference/markdown/type-aliases/OpenExternalLinkResult.md +0 -8
- package/api-reference/markdown/type-aliases/Platform.md +0 -7
- package/api-reference/markdown/type-aliases/PlayDRMContentResponse.md +0 -43
- package/api-reference/markdown/type-aliases/PlayDRMContentResult.md +0 -8
- package/api-reference/markdown/type-aliases/RedirectToSystemWebViewRequest.md +0 -23
- package/api-reference/markdown/type-aliases/RedirectToSystemWebViewResponse.md +0 -55
- package/api-reference/markdown/type-aliases/RedirectToSystemWebViewResult.md +0 -8
- package/api-reference/markdown/type-aliases/ReloadScopesResponse.md +0 -46
- package/api-reference/markdown/type-aliases/ReloadScopesResult.md +0 -8
- package/api-reference/markdown/type-aliases/RemoveAllResponse.md +0 -37
- package/api-reference/markdown/type-aliases/RemoveAllResult.md +0 -8
- package/api-reference/markdown/type-aliases/RemoveResponse.md +0 -46
- package/api-reference/markdown/type-aliases/RemoveResult.md +0 -8
- package/api-reference/markdown/type-aliases/ResponseStatusCode200.md +0 -34
- package/api-reference/markdown/type-aliases/ResponseStatusCode204.md +0 -20
- package/api-reference/markdown/type-aliases/ResponseStatusCode302.md +0 -20
- package/api-reference/markdown/type-aliases/ResponseStatusCode400.md +0 -7
- package/api-reference/markdown/type-aliases/ResponseStatusCode401.md +0 -7
- package/api-reference/markdown/type-aliases/ResponseStatusCode403.md +0 -7
- package/api-reference/markdown/type-aliases/ResponseStatusCode404.md +0 -7
- package/api-reference/markdown/type-aliases/ResponseStatusCode424.md +0 -7
- package/api-reference/markdown/type-aliases/ResponseStatusCode426.md +0 -12
- package/api-reference/markdown/type-aliases/ResponseStatusCode500.md +0 -7
- package/api-reference/markdown/type-aliases/ResponseStatusCode501.md +0 -12
- package/api-reference/markdown/type-aliases/ScanQRCodeRequest.md +0 -27
- package/api-reference/markdown/type-aliases/ScanQRCodeResponse.md +0 -64
- package/api-reference/markdown/type-aliases/ScanQRCodeResult.md +0 -21
- package/api-reference/markdown/type-aliases/SendAnalyticsEventRequest.md +0 -56
- package/api-reference/markdown/type-aliases/SendAnalyticsEventResponse.md +0 -46
- package/api-reference/markdown/type-aliases/SendAnalyticsEventResult.md +0 -8
- package/api-reference/markdown/type-aliases/SetBackgroundColorRequest.md +0 -13
- package/api-reference/markdown/type-aliases/SetBackgroundColorResponse.md +0 -46
- package/api-reference/markdown/type-aliases/SetBackgroundColorResult.md +0 -8
- package/api-reference/markdown/type-aliases/SetBooleanResponse.md +0 -46
- package/api-reference/markdown/type-aliases/SetBooleanResult.md +0 -8
- package/api-reference/markdown/type-aliases/SetDoubleResponse.md +0 -46
- package/api-reference/markdown/type-aliases/SetDoubleResult.md +0 -8
- package/api-reference/markdown/type-aliases/SetIntResponse.md +0 -46
- package/api-reference/markdown/type-aliases/SetIntResult.md +0 -8
- package/api-reference/markdown/type-aliases/SetStringResponse.md +0 -46
- package/api-reference/markdown/type-aliases/SetStringResult.md +0 -8
- package/api-reference/markdown/type-aliases/SetTitleRequest.md +0 -13
- package/api-reference/markdown/type-aliases/SetTitleResponse.md +0 -46
- package/api-reference/markdown/type-aliases/SetTitleResult.md +0 -8
- package/api-reference/markdown/type-aliases/ShowBackButtonResponse.md +0 -37
- package/api-reference/markdown/type-aliases/ShowBackButtonResult.md +0 -8
- package/api-reference/markdown/type-aliases/ShowLoaderResponse.md +0 -37
- package/api-reference/markdown/type-aliases/ShowLoaderResult.md +0 -8
- package/api-reference/markdown/type-aliases/ShowRefreshButtonResponse.md +0 -37
- package/api-reference/markdown/type-aliases/ShowRefreshButtonResult.md +0 -8
- package/api-reference/markdown/type-aliases/StatusCodeMap.md +0 -80
- package/api-reference/markdown/type-aliases/Subscription.md +0 -12
- package/api-reference/markdown/type-aliases/TriggerCheckoutRequest.md +0 -26
- package/api-reference/markdown/type-aliases/TriggerCheckoutResponse.md +0 -76
- package/api-reference/markdown/type-aliases/TriggerCheckoutResult.md +0 -75
- package/api-reference/markdown/type-aliases/VerifyEmailRequest.md +0 -32
- package/api-reference/markdown/type-aliases/VerifyEmailResponse.md +0 -55
- package/api-reference/markdown/type-aliases/VerifyEmailResult.md +0 -8
- package/api-reference/markdown/variables/ContainerAnalyticsEventData.md +0 -21
- package/api-reference/markdown/variables/ContainerAnalyticsEventName.md +0 -13
- package/api-reference/markdown/variables/ContainerAnalyticsEventState.md +0 -25
|
@@ -1,176 +0,0 @@
|
|
|
1
|
-
# @grabjs/superapp-sdk
|
|
2
|
-
|
|
3
|
-
## Modules
|
|
4
|
-
|
|
5
|
-
- [CameraModule](classes/CameraModule.md)
|
|
6
|
-
- [CheckoutModule](classes/CheckoutModule.md)
|
|
7
|
-
- [ContainerModule](classes/ContainerModule.md)
|
|
8
|
-
- [DeviceCapabilityModule](classes/DeviceCapabilityModule.md)
|
|
9
|
-
- [FileModule](classes/FileModule.md)
|
|
10
|
-
- [IdentityModule](classes/IdentityModule.md)
|
|
11
|
-
- [LocaleModule](classes/LocaleModule.md)
|
|
12
|
-
- [LocationModule](classes/LocationModule.md)
|
|
13
|
-
- [MediaModule](classes/MediaModule.md)
|
|
14
|
-
- [PlatformModule](classes/PlatformModule.md)
|
|
15
|
-
- [ProfileModule](classes/ProfileModule.md)
|
|
16
|
-
- [ScopeModule](classes/ScopeModule.md)
|
|
17
|
-
- [StorageModule](classes/StorageModule.md)
|
|
18
|
-
- [SystemWebViewKitModule](classes/SystemWebViewKitModule.md)
|
|
19
|
-
- [UserAttributesModule](classes/UserAttributesModule.md)
|
|
20
|
-
|
|
21
|
-
## Classes
|
|
22
|
-
|
|
23
|
-
- [BaseModule](classes/BaseModule.md)
|
|
24
|
-
|
|
25
|
-
## Interfaces
|
|
26
|
-
|
|
27
|
-
- [GrabAppInfo](interfaces/GrabAppInfo.md)
|
|
28
|
-
- [InvokeOptions](interfaces/InvokeOptions.md)
|
|
29
|
-
- [Version](interfaces/Version.md)
|
|
30
|
-
- [WrappedModule](interfaces/WrappedModule.md)
|
|
31
|
-
|
|
32
|
-
## Type Aliases
|
|
33
|
-
|
|
34
|
-
- [AuthorizeRequest](type-aliases/AuthorizeRequest.md)
|
|
35
|
-
- [AuthorizeResponse](type-aliases/AuthorizeResponse.md)
|
|
36
|
-
- [AuthorizeResult](type-aliases/AuthorizeResult.md)
|
|
37
|
-
- [BackResponse](type-aliases/BackResponse.md)
|
|
38
|
-
- [BackResult](type-aliases/BackResult.md)
|
|
39
|
-
- [BridgeClientError](type-aliases/BridgeClientError.md)
|
|
40
|
-
- [BridgeError](type-aliases/BridgeError.md)
|
|
41
|
-
- [BridgeRedirection](type-aliases/BridgeRedirection.md)
|
|
42
|
-
- [BridgeResponse](type-aliases/BridgeResponse.md)
|
|
43
|
-
- [BridgeServerError](type-aliases/BridgeServerError.md)
|
|
44
|
-
- [BridgeStatusCode](type-aliases/BridgeStatusCode.md)
|
|
45
|
-
- [BridgeStream](type-aliases/BridgeStream.md)
|
|
46
|
-
- [BridgeStreamHandlers](type-aliases/BridgeStreamHandlers.md)
|
|
47
|
-
- [BridgeSuccessResponse](type-aliases/BridgeSuccessResponse.md)
|
|
48
|
-
- [ClearAuthorizationArtifactsResponse](type-aliases/ClearAuthorizationArtifactsResponse.md)
|
|
49
|
-
- [ClearAuthorizationArtifactsResult](type-aliases/ClearAuthorizationArtifactsResult.md)
|
|
50
|
-
- [CloseResponse](type-aliases/CloseResponse.md)
|
|
51
|
-
- [CloseResult](type-aliases/CloseResult.md)
|
|
52
|
-
- [DownloadFileRequest](type-aliases/DownloadFileRequest.md)
|
|
53
|
-
- [DownloadFileResponse](type-aliases/DownloadFileResponse.md)
|
|
54
|
-
- [DownloadFileResult](type-aliases/DownloadFileResult.md)
|
|
55
|
-
- [DRMContentConfig](type-aliases/DRMContentConfig.md)
|
|
56
|
-
- [DRMPlaybackEvent](type-aliases/DRMPlaybackEvent.md)
|
|
57
|
-
- [ErrorResponse](type-aliases/ErrorResponse.md)
|
|
58
|
-
- [FetchEmailResponse](type-aliases/FetchEmailResponse.md)
|
|
59
|
-
- [FetchEmailResult](type-aliases/FetchEmailResult.md)
|
|
60
|
-
- [GetAuthorizationArtifactsResponse](type-aliases/GetAuthorizationArtifactsResponse.md)
|
|
61
|
-
- [GetAuthorizationArtifactsResult](type-aliases/GetAuthorizationArtifactsResult.md)
|
|
62
|
-
- [GetBooleanRequest](type-aliases/GetBooleanRequest.md)
|
|
63
|
-
- [GetBooleanResponse](type-aliases/GetBooleanResponse.md)
|
|
64
|
-
- [GetBooleanResult](type-aliases/GetBooleanResult.md)
|
|
65
|
-
- [GetCoordinateResponse](type-aliases/GetCoordinateResponse.md)
|
|
66
|
-
- [GetCoordinateResult](type-aliases/GetCoordinateResult.md)
|
|
67
|
-
- [GetCountryCodeResponse](type-aliases/GetCountryCodeResponse.md)
|
|
68
|
-
- [GetCountryCodeResult](type-aliases/GetCountryCodeResult.md)
|
|
69
|
-
- [GetDoubleRequest](type-aliases/GetDoubleRequest.md)
|
|
70
|
-
- [GetDoubleResponse](type-aliases/GetDoubleResponse.md)
|
|
71
|
-
- [GetDoubleResult](type-aliases/GetDoubleResult.md)
|
|
72
|
-
- [GetIntRequest](type-aliases/GetIntRequest.md)
|
|
73
|
-
- [GetIntResponse](type-aliases/GetIntResponse.md)
|
|
74
|
-
- [GetIntResult](type-aliases/GetIntResult.md)
|
|
75
|
-
- [GetLanguageLocaleIdentifierResponse](type-aliases/GetLanguageLocaleIdentifierResponse.md)
|
|
76
|
-
- [GetLanguageLocaleIdentifierResult](type-aliases/GetLanguageLocaleIdentifierResult.md)
|
|
77
|
-
- [GetSelectedTravelDestinationResponse](type-aliases/GetSelectedTravelDestinationResponse.md)
|
|
78
|
-
- [GetSelectedTravelDestinationResult](type-aliases/GetSelectedTravelDestinationResult.md)
|
|
79
|
-
- [GetSessionParamsResponse](type-aliases/GetSessionParamsResponse.md)
|
|
80
|
-
- [GetSessionParamsResult](type-aliases/GetSessionParamsResult.md)
|
|
81
|
-
- [GetStringRequest](type-aliases/GetStringRequest.md)
|
|
82
|
-
- [GetStringResponse](type-aliases/GetStringResponse.md)
|
|
83
|
-
- [GetStringResult](type-aliases/GetStringResult.md)
|
|
84
|
-
- [HasAccessToResponse](type-aliases/HasAccessToResponse.md)
|
|
85
|
-
- [HasAccessToResult](type-aliases/HasAccessToResult.md)
|
|
86
|
-
- [HideBackButtonResponse](type-aliases/HideBackButtonResponse.md)
|
|
87
|
-
- [HideBackButtonResult](type-aliases/HideBackButtonResult.md)
|
|
88
|
-
- [HideLoaderResponse](type-aliases/HideLoaderResponse.md)
|
|
89
|
-
- [HideLoaderResult](type-aliases/HideLoaderResult.md)
|
|
90
|
-
- [HideRefreshButtonResponse](type-aliases/HideRefreshButtonResponse.md)
|
|
91
|
-
- [HideRefreshButtonResult](type-aliases/HideRefreshButtonResult.md)
|
|
92
|
-
- [IsConnectedResponse](type-aliases/IsConnectedResponse.md)
|
|
93
|
-
- [IsConnectedResult](type-aliases/IsConnectedResult.md)
|
|
94
|
-
- [IsEsimSupportedResponse](type-aliases/IsEsimSupportedResponse.md)
|
|
95
|
-
- [IsEsimSupportedResult](type-aliases/IsEsimSupportedResult.md)
|
|
96
|
-
- [ObserveDRMPlaybackResponse](type-aliases/ObserveDRMPlaybackResponse.md)
|
|
97
|
-
- [ObserveLocationChangeResponse](type-aliases/ObserveLocationChangeResponse.md)
|
|
98
|
-
- [OnContentLoadedResponse](type-aliases/OnContentLoadedResponse.md)
|
|
99
|
-
- [OnContentLoadedResult](type-aliases/OnContentLoadedResult.md)
|
|
100
|
-
- [OnCtaTapRequest](type-aliases/OnCtaTapRequest.md)
|
|
101
|
-
- [OnCtaTapResponse](type-aliases/OnCtaTapResponse.md)
|
|
102
|
-
- [OnCtaTapResult](type-aliases/OnCtaTapResult.md)
|
|
103
|
-
- [OpenExternalLinkRequest](type-aliases/OpenExternalLinkRequest.md)
|
|
104
|
-
- [OpenExternalLinkResponse](type-aliases/OpenExternalLinkResponse.md)
|
|
105
|
-
- [OpenExternalLinkResult](type-aliases/OpenExternalLinkResult.md)
|
|
106
|
-
- [Platform](type-aliases/Platform.md)
|
|
107
|
-
- [PlayDRMContentResponse](type-aliases/PlayDRMContentResponse.md)
|
|
108
|
-
- [PlayDRMContentResult](type-aliases/PlayDRMContentResult.md)
|
|
109
|
-
- [RedirectToSystemWebViewRequest](type-aliases/RedirectToSystemWebViewRequest.md)
|
|
110
|
-
- [RedirectToSystemWebViewResponse](type-aliases/RedirectToSystemWebViewResponse.md)
|
|
111
|
-
- [RedirectToSystemWebViewResult](type-aliases/RedirectToSystemWebViewResult.md)
|
|
112
|
-
- [ReloadScopesResponse](type-aliases/ReloadScopesResponse.md)
|
|
113
|
-
- [ReloadScopesResult](type-aliases/ReloadScopesResult.md)
|
|
114
|
-
- [RemoveAllResponse](type-aliases/RemoveAllResponse.md)
|
|
115
|
-
- [RemoveAllResult](type-aliases/RemoveAllResult.md)
|
|
116
|
-
- [RemoveResponse](type-aliases/RemoveResponse.md)
|
|
117
|
-
- [RemoveResult](type-aliases/RemoveResult.md)
|
|
118
|
-
- [ResponseStatusCode200](type-aliases/ResponseStatusCode200.md)
|
|
119
|
-
- [ResponseStatusCode204](type-aliases/ResponseStatusCode204.md)
|
|
120
|
-
- [ResponseStatusCode302](type-aliases/ResponseStatusCode302.md)
|
|
121
|
-
- [ResponseStatusCode400](type-aliases/ResponseStatusCode400.md)
|
|
122
|
-
- [ResponseStatusCode401](type-aliases/ResponseStatusCode401.md)
|
|
123
|
-
- [ResponseStatusCode403](type-aliases/ResponseStatusCode403.md)
|
|
124
|
-
- [ResponseStatusCode404](type-aliases/ResponseStatusCode404.md)
|
|
125
|
-
- [ResponseStatusCode424](type-aliases/ResponseStatusCode424.md)
|
|
126
|
-
- [ResponseStatusCode426](type-aliases/ResponseStatusCode426.md)
|
|
127
|
-
- [ResponseStatusCode500](type-aliases/ResponseStatusCode500.md)
|
|
128
|
-
- [ResponseStatusCode501](type-aliases/ResponseStatusCode501.md)
|
|
129
|
-
- [ScanQRCodeRequest](type-aliases/ScanQRCodeRequest.md)
|
|
130
|
-
- [ScanQRCodeResponse](type-aliases/ScanQRCodeResponse.md)
|
|
131
|
-
- [ScanQRCodeResult](type-aliases/ScanQRCodeResult.md)
|
|
132
|
-
- [SendAnalyticsEventRequest](type-aliases/SendAnalyticsEventRequest.md)
|
|
133
|
-
- [SendAnalyticsEventResponse](type-aliases/SendAnalyticsEventResponse.md)
|
|
134
|
-
- [SendAnalyticsEventResult](type-aliases/SendAnalyticsEventResult.md)
|
|
135
|
-
- [SetBackgroundColorRequest](type-aliases/SetBackgroundColorRequest.md)
|
|
136
|
-
- [SetBackgroundColorResponse](type-aliases/SetBackgroundColorResponse.md)
|
|
137
|
-
- [SetBackgroundColorResult](type-aliases/SetBackgroundColorResult.md)
|
|
138
|
-
- [SetBooleanResponse](type-aliases/SetBooleanResponse.md)
|
|
139
|
-
- [SetBooleanResult](type-aliases/SetBooleanResult.md)
|
|
140
|
-
- [SetDoubleResponse](type-aliases/SetDoubleResponse.md)
|
|
141
|
-
- [SetDoubleResult](type-aliases/SetDoubleResult.md)
|
|
142
|
-
- [SetIntResponse](type-aliases/SetIntResponse.md)
|
|
143
|
-
- [SetIntResult](type-aliases/SetIntResult.md)
|
|
144
|
-
- [SetStringResponse](type-aliases/SetStringResponse.md)
|
|
145
|
-
- [SetStringResult](type-aliases/SetStringResult.md)
|
|
146
|
-
- [SetTitleRequest](type-aliases/SetTitleRequest.md)
|
|
147
|
-
- [SetTitleResponse](type-aliases/SetTitleResponse.md)
|
|
148
|
-
- [SetTitleResult](type-aliases/SetTitleResult.md)
|
|
149
|
-
- [ShowBackButtonResponse](type-aliases/ShowBackButtonResponse.md)
|
|
150
|
-
- [ShowBackButtonResult](type-aliases/ShowBackButtonResult.md)
|
|
151
|
-
- [ShowLoaderResponse](type-aliases/ShowLoaderResponse.md)
|
|
152
|
-
- [ShowLoaderResult](type-aliases/ShowLoaderResult.md)
|
|
153
|
-
- [ShowRefreshButtonResponse](type-aliases/ShowRefreshButtonResponse.md)
|
|
154
|
-
- [ShowRefreshButtonResult](type-aliases/ShowRefreshButtonResult.md)
|
|
155
|
-
- [StatusCodeMap](type-aliases/StatusCodeMap.md)
|
|
156
|
-
- [Subscription](type-aliases/Subscription.md)
|
|
157
|
-
- [TriggerCheckoutRequest](type-aliases/TriggerCheckoutRequest.md)
|
|
158
|
-
- [TriggerCheckoutResponse](type-aliases/TriggerCheckoutResponse.md)
|
|
159
|
-
- [TriggerCheckoutResult](type-aliases/TriggerCheckoutResult.md)
|
|
160
|
-
- [VerifyEmailRequest](type-aliases/VerifyEmailRequest.md)
|
|
161
|
-
- [VerifyEmailResponse](type-aliases/VerifyEmailResponse.md)
|
|
162
|
-
- [VerifyEmailResult](type-aliases/VerifyEmailResult.md)
|
|
163
|
-
|
|
164
|
-
## Variables
|
|
165
|
-
|
|
166
|
-
- [ContainerAnalyticsEventData](variables/ContainerAnalyticsEventData.md)
|
|
167
|
-
- [ContainerAnalyticsEventName](variables/ContainerAnalyticsEventName.md)
|
|
168
|
-
- [ContainerAnalyticsEventState](variables/ContainerAnalyticsEventState.md)
|
|
169
|
-
|
|
170
|
-
## Functions
|
|
171
|
-
|
|
172
|
-
- [isClientError](functions/isClientError.md)
|
|
173
|
-
- [isErrorResponse](functions/isErrorResponse.md)
|
|
174
|
-
- [isRedirection](functions/isRedirection.md)
|
|
175
|
-
- [isServerError](functions/isServerError.md)
|
|
176
|
-
- [isSuccess](functions/isSuccess.md)
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
[@grabjs/superapp-sdk](../globals.md) / GrabAppInfo
|
|
2
|
-
|
|
3
|
-
# Interface: GrabAppInfo
|
|
4
|
-
|
|
5
|
-
Represents parsed information from a Grab app user agent string.
|
|
6
|
-
|
|
7
|
-
## Properties
|
|
8
|
-
|
|
9
|
-
### appName
|
|
10
|
-
|
|
11
|
-
> **appName**: `string`
|
|
12
|
-
|
|
13
|
-
***
|
|
14
|
-
|
|
15
|
-
### platform
|
|
16
|
-
|
|
17
|
-
> **platform**: [`Platform`](../type-aliases/Platform.md)
|
|
18
|
-
|
|
19
|
-
***
|
|
20
|
-
|
|
21
|
-
### version
|
|
22
|
-
|
|
23
|
-
> **version**: [`Version`](Version.md)
|
|
@@ -1,63 +0,0 @@
|
|
|
1
|
-
[@grabjs/superapp-sdk](../globals.md) / InvokeOptions
|
|
2
|
-
|
|
3
|
-
# Interface: InvokeOptions\<T\>
|
|
4
|
-
|
|
5
|
-
Options for invoking a JSBridge method.
|
|
6
|
-
|
|
7
|
-
## Type Parameters
|
|
8
|
-
|
|
9
|
-
### T
|
|
10
|
-
|
|
11
|
-
`T`
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### isSupported()?
|
|
16
|
-
|
|
17
|
-
> `optional` **isSupported**: (`appInfo`: [`GrabAppInfo`](GrabAppInfo.md)) => `boolean`
|
|
18
|
-
|
|
19
|
-
Validator function - returns false = 426 with default error
|
|
20
|
-
|
|
21
|
-
#### Parameters
|
|
22
|
-
|
|
23
|
-
##### appInfo
|
|
24
|
-
|
|
25
|
-
[`GrabAppInfo`](GrabAppInfo.md)
|
|
26
|
-
|
|
27
|
-
#### Returns
|
|
28
|
-
|
|
29
|
-
`boolean`
|
|
30
|
-
|
|
31
|
-
***
|
|
32
|
-
|
|
33
|
-
### method
|
|
34
|
-
|
|
35
|
-
> **method**: `string`
|
|
36
|
-
|
|
37
|
-
The name of the JSBridge method to invoke
|
|
38
|
-
|
|
39
|
-
***
|
|
40
|
-
|
|
41
|
-
### params?
|
|
42
|
-
|
|
43
|
-
> `optional` **params**: `unknown`
|
|
44
|
-
|
|
45
|
-
The parameters to pass to the method
|
|
46
|
-
|
|
47
|
-
***
|
|
48
|
-
|
|
49
|
-
### transformResponse()?
|
|
50
|
-
|
|
51
|
-
> `optional` **transformResponse**: (`response`: [`BridgeResponse`](../type-aliases/BridgeResponse.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>) => [`BridgeResponse`](../type-aliases/BridgeResponse.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>
|
|
52
|
-
|
|
53
|
-
Optional response transformation function
|
|
54
|
-
|
|
55
|
-
#### Parameters
|
|
56
|
-
|
|
57
|
-
##### response
|
|
58
|
-
|
|
59
|
-
[`BridgeResponse`](../type-aliases/BridgeResponse.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>
|
|
60
|
-
|
|
61
|
-
#### Returns
|
|
62
|
-
|
|
63
|
-
[`BridgeResponse`](../type-aliases/BridgeResponse.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
[@grabjs/superapp-sdk](../globals.md) / Version
|
|
2
|
-
|
|
3
|
-
# Interface: Version
|
|
4
|
-
|
|
5
|
-
Represents a semantic version with major, minor, and patch components.
|
|
6
|
-
|
|
7
|
-
## Properties
|
|
8
|
-
|
|
9
|
-
### major
|
|
10
|
-
|
|
11
|
-
> **major**: `number`
|
|
12
|
-
|
|
13
|
-
***
|
|
14
|
-
|
|
15
|
-
### minor
|
|
16
|
-
|
|
17
|
-
> **minor**: `number`
|
|
18
|
-
|
|
19
|
-
***
|
|
20
|
-
|
|
21
|
-
### patch
|
|
22
|
-
|
|
23
|
-
> **patch**: `number`
|
|
@@ -1,51 +0,0 @@
|
|
|
1
|
-
[@grabjs/superapp-sdk](../globals.md) / WrappedModule
|
|
2
|
-
|
|
3
|
-
# Interface: WrappedModule
|
|
4
|
-
|
|
5
|
-
Generic interface for all native JSBridge module wrappers.
|
|
6
|
-
|
|
7
|
-
## Remarks
|
|
8
|
-
|
|
9
|
-
This is the base interface that all Wrapped*Module interfaces implement.
|
|
10
|
-
Modules can use this directly for generic method invocation, or extend it
|
|
11
|
-
with method-specific overloads for stricter typing.
|
|
12
|
-
|
|
13
|
-
## Examples
|
|
14
|
-
|
|
15
|
-
Using directly (CameraModule, ContainerModule):
|
|
16
|
-
```typescript
|
|
17
|
-
invoke<ScanQRCodeResult>('scanQRCode', request)
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Extending with method overloads (ProfileModule, LocationModule):
|
|
21
|
-
```typescript
|
|
22
|
-
export interface WrappedProfileModule extends WrappedModule {
|
|
23
|
-
invoke(method: 'fetchEmail', params?: any): Promise<BridgeResponse<BridgeStatusCode, string>>;
|
|
24
|
-
}
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
## Methods
|
|
28
|
-
|
|
29
|
-
### invoke()
|
|
30
|
-
|
|
31
|
-
> **invoke**\<`T`\>(`method`: `string`, `params?`: `unknown`): [`BridgeStream`](../type-aliases/BridgeStream.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\> \| `Promise`\<[`BridgeResponse`](../type-aliases/BridgeResponse.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>\>
|
|
32
|
-
|
|
33
|
-
#### Type Parameters
|
|
34
|
-
|
|
35
|
-
##### T
|
|
36
|
-
|
|
37
|
-
`T`
|
|
38
|
-
|
|
39
|
-
#### Parameters
|
|
40
|
-
|
|
41
|
-
##### method
|
|
42
|
-
|
|
43
|
-
`string`
|
|
44
|
-
|
|
45
|
-
##### params?
|
|
46
|
-
|
|
47
|
-
`unknown`
|
|
48
|
-
|
|
49
|
-
#### Returns
|
|
50
|
-
|
|
51
|
-
[`BridgeStream`](../type-aliases/BridgeStream.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\> \| `Promise`\<[`BridgeResponse`](../type-aliases/BridgeResponse.md)\<keyof [`StatusCodeMap`](../type-aliases/StatusCodeMap.md)\<`unknown`\>, `T`\>\>
|
|
@@ -1,79 +0,0 @@
|
|
|
1
|
-
[@grabjs/superapp-sdk](../globals.md) / AuthorizeRequest
|
|
2
|
-
|
|
3
|
-
# Type Alias: AuthorizeRequest
|
|
4
|
-
|
|
5
|
-
> **AuthorizeRequest** = \{ `clientId`: `string`; `environment`: `"staging"` \| `"production"`; `redirectUri`: `string`; `responseMode?`: `"redirect"` \| `"in_place"`; `scope`: `string`; \}
|
|
6
|
-
|
|
7
|
-
Request parameters for initiating an OAuth2 authorization flow with PKCE.
|
|
8
|
-
|
|
9
|
-
## Examples
|
|
10
|
-
|
|
11
|
-
**Production environment with redirect mode:**
|
|
12
|
-
```typescript
|
|
13
|
-
{
|
|
14
|
-
clientId: 'your-client-id',
|
|
15
|
-
redirectUri: 'https://your-app.com/callback',
|
|
16
|
-
scope: 'openid profile',
|
|
17
|
-
environment: 'production',
|
|
18
|
-
responseMode: 'redirect'
|
|
19
|
-
}
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
**Staging environment with in_place mode:**
|
|
23
|
-
```typescript
|
|
24
|
-
{
|
|
25
|
-
clientId: 'staging-client-id',
|
|
26
|
-
redirectUri: 'https://staging-app.com/callback',
|
|
27
|
-
scope: 'openid',
|
|
28
|
-
environment: 'staging',
|
|
29
|
-
responseMode: 'in_place'
|
|
30
|
-
}
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
## Properties
|
|
34
|
-
|
|
35
|
-
### clientId
|
|
36
|
-
|
|
37
|
-
> **clientId**: `string`
|
|
38
|
-
|
|
39
|
-
The OAuth2 client ID for your MiniApp.
|
|
40
|
-
|
|
41
|
-
***
|
|
42
|
-
|
|
43
|
-
### environment
|
|
44
|
-
|
|
45
|
-
> **environment**: `"staging"` \| `"production"`
|
|
46
|
-
|
|
47
|
-
The environment to use for authorization ('staging' or 'production').
|
|
48
|
-
|
|
49
|
-
***
|
|
50
|
-
|
|
51
|
-
### redirectUri
|
|
52
|
-
|
|
53
|
-
> **redirectUri**: `string`
|
|
54
|
-
|
|
55
|
-
The redirect URI registered for your MiniApp.
|
|
56
|
-
|
|
57
|
-
***
|
|
58
|
-
|
|
59
|
-
### responseMode?
|
|
60
|
-
|
|
61
|
-
> `optional` **responseMode**: `"redirect"` \| `"in_place"`
|
|
62
|
-
|
|
63
|
-
The response mode for the authorization flow.
|
|
64
|
-
- 'redirect': User is redirected to the redirect URI after authorization
|
|
65
|
-
- 'in_place': Authorization happens within the current page context
|
|
66
|
-
|
|
67
|
-
#### Default Value
|
|
68
|
-
|
|
69
|
-
```ts
|
|
70
|
-
'redirect'
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
***
|
|
74
|
-
|
|
75
|
-
### scope
|
|
76
|
-
|
|
77
|
-
> **scope**: `string`
|
|
78
|
-
|
|
79
|
-
The OAuth2 scopes to request (space-separated string).
|
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
[@grabjs/superapp-sdk](../globals.md) / AuthorizeResponse
|
|
2
|
-
|
|
3
|
-
# Type Alias: AuthorizeResponse
|
|
4
|
-
|
|
5
|
-
> **AuthorizeResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `302` \| `204` \| `400` \| `401` \| `403` \| `500` \| `501`, [`AuthorizeResult`](AuthorizeResult.md)\>
|
|
6
|
-
|
|
7
|
-
Response when initiating an authorization flow.
|
|
8
|
-
|
|
9
|
-
## Remarks
|
|
10
|
-
|
|
11
|
-
This response can have the following status codes:
|
|
12
|
-
- `200`: Authorization completed successfully (native in_place flow). The `result` contains the authorization code and state.
|
|
13
|
-
- `302`: Redirect in progress (web redirect flow). The page will navigate away.
|
|
14
|
-
- `204`: No content - user cancelled or flow completed without result data.
|
|
15
|
-
- `400`: Bad request - missing required OAuth parameters or invalid configuration.
|
|
16
|
-
- `401`: Unauthorized - user not authenticated or session expired.
|
|
17
|
-
- `403`: Forbidden - client not authorized for the requested scope.
|
|
18
|
-
- `500`: Internal server error - unexpected error during native authorization.
|
|
19
|
-
- `501`: Not implemented - this method requires the Grab app environment.
|
|
20
|
-
|
|
21
|
-
## Examples
|
|
22
|
-
|
|
23
|
-
**Success response (200) - native in_place flow:**
|
|
24
|
-
```typescript
|
|
25
|
-
{
|
|
26
|
-
status_code: 200,
|
|
27
|
-
result: {
|
|
28
|
-
code: 'auth-code-abc123',
|
|
29
|
-
state: 'csrf-state-xyz789'
|
|
30
|
-
}
|
|
31
|
-
}
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
**Redirect response (302) - web flow:**
|
|
35
|
-
```typescript
|
|
36
|
-
{ status_code: 302 }
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
**Cancelled response (204):**
|
|
40
|
-
```typescript
|
|
41
|
-
{ status_code: 204 }
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
**Bad request response (400):**
|
|
45
|
-
```typescript
|
|
46
|
-
{
|
|
47
|
-
status_code: 400,
|
|
48
|
-
error: 'Missing required OAuth parameters'
|
|
49
|
-
}
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
**Not implemented response (501) - outside Grab app:**
|
|
53
|
-
```typescript
|
|
54
|
-
{
|
|
55
|
-
status_code: 501,
|
|
56
|
-
error: 'Not implemented: This method requires the Grab app environment'
|
|
57
|
-
}
|
|
58
|
-
```
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
[@grabjs/superapp-sdk](../globals.md) / AuthorizeResult
|
|
2
|
-
|
|
3
|
-
# Type Alias: AuthorizeResult
|
|
4
|
-
|
|
5
|
-
> **AuthorizeResult** = \{ `code`: `string`; `state`: `string`; \}
|
|
6
|
-
|
|
7
|
-
Result object for the authorization flow.
|
|
8
|
-
Contains the authorization code and state when native in_place flow completes successfully.
|
|
9
|
-
|
|
10
|
-
## Example
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
{
|
|
14
|
-
code: 'auth-code-abc123',
|
|
15
|
-
state: 'csrf-state-xyz789'
|
|
16
|
-
}
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
## Properties
|
|
20
|
-
|
|
21
|
-
### code
|
|
22
|
-
|
|
23
|
-
> **code**: `string`
|
|
24
|
-
|
|
25
|
-
The authorization code returned from the server.
|
|
26
|
-
|
|
27
|
-
***
|
|
28
|
-
|
|
29
|
-
### state
|
|
30
|
-
|
|
31
|
-
> **state**: `string`
|
|
32
|
-
|
|
33
|
-
The state parameter returned from the server for CSRF protection.
|
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
[@grabjs/superapp-sdk](../globals.md) / BackResponse
|
|
2
|
-
|
|
3
|
-
# Type Alias: BackResponse
|
|
4
|
-
|
|
5
|
-
> **BackResponse** = [`BridgeResponse`](BridgeResponse.md)\<`204` \| `500` \| `501`, [`BackResult`](BackResult.md)\>
|
|
6
|
-
|
|
7
|
-
Response when triggering platform back navigation.
|
|
8
|
-
|
|
9
|
-
## Remarks
|
|
10
|
-
|
|
11
|
-
This response can have the following status codes:
|
|
12
|
-
- `204`: Back navigation triggered successfully.
|
|
13
|
-
- `500`: Internal server error - an unexpected error occurred on the native side.
|
|
14
|
-
- `501`: Not implemented - this method requires the Grab app environment.
|
|
15
|
-
|
|
16
|
-
## Examples
|
|
17
|
-
|
|
18
|
-
**Success response (204):**
|
|
19
|
-
```typescript
|
|
20
|
-
{ status_code: 204 }
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
**Not implemented response (501) - outside Grab app:**
|
|
24
|
-
```typescript
|
|
25
|
-
{
|
|
26
|
-
status_code: 501,
|
|
27
|
-
error: 'Not implemented: This method requires the Grab app environment'
|
|
28
|
-
}
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
**Internal server error response (500):**
|
|
32
|
-
```typescript
|
|
33
|
-
{
|
|
34
|
-
status_code: 500,
|
|
35
|
-
error: 'Internal server error'
|
|
36
|
-
}
|
|
37
|
-
```
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
[@grabjs/superapp-sdk](../globals.md) / BridgeClientError
|
|
2
|
-
|
|
3
|
-
# Type Alias: BridgeClientError
|
|
4
|
-
|
|
5
|
-
> **BridgeClientError** = [`ResponseStatusCode400`](ResponseStatusCode400.md) \| [`ResponseStatusCode401`](ResponseStatusCode401.md) \| [`ResponseStatusCode403`](ResponseStatusCode403.md) \| [`ResponseStatusCode404`](ResponseStatusCode404.md) \| [`ResponseStatusCode424`](ResponseStatusCode424.md) \| [`ResponseStatusCode426`](ResponseStatusCode426.md)
|
|
6
|
-
|
|
7
|
-
Union type representing all client error JSBridge responses (4xx status codes).
|
|
8
|
-
Includes: 400 (Bad Request), 401 (Unauthorized), 403 (Forbidden), 404 (Not Found),
|
|
9
|
-
424 (Failed Dependency), and 426 (Upgrade Required).
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
[@grabjs/superapp-sdk](../globals.md) / BridgeError
|
|
2
|
-
|
|
3
|
-
# Type Alias: BridgeError
|
|
4
|
-
|
|
5
|
-
> **BridgeError** = [`BridgeClientError`](BridgeClientError.md) \| [`BridgeServerError`](BridgeServerError.md)
|
|
6
|
-
|
|
7
|
-
Union type representing all error JSBridge responses (4xx and 5xx status codes).
|
|
8
|
-
Combines both client errors and server errors.
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
[@grabjs/superapp-sdk](../globals.md) / BridgeRedirection
|
|
2
|
-
|
|
3
|
-
# Type Alias: BridgeRedirection
|
|
4
|
-
|
|
5
|
-
> **BridgeRedirection** = [`ResponseStatusCode302`](ResponseStatusCode302.md)
|
|
6
|
-
|
|
7
|
-
Union type representing redirect JSBridge responses.
|
|
8
|
-
Currently only includes status code 302.
|
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
[@grabjs/superapp-sdk](../globals.md) / BridgeResponse
|
|
2
|
-
|
|
3
|
-
# Type Alias: BridgeResponse\<Codes, T\>
|
|
4
|
-
|
|
5
|
-
> **BridgeResponse**\<`Codes`, `T`\> = [`StatusCodeMap`](StatusCodeMap.md)\<`T`\>\[`Codes`\]
|
|
6
|
-
|
|
7
|
-
Universal response type for JSBridge method callbacks.
|
|
8
|
-
|
|
9
|
-
## Type Parameters
|
|
10
|
-
|
|
11
|
-
### Codes
|
|
12
|
-
|
|
13
|
-
`Codes` *extends* [`BridgeStatusCode`](BridgeStatusCode.md) = [`BridgeStatusCode`](BridgeStatusCode.md)
|
|
14
|
-
|
|
15
|
-
### T
|
|
16
|
-
|
|
17
|
-
`T` = `void`
|
|
18
|
-
|
|
19
|
-
## Remarks
|
|
20
|
-
|
|
21
|
-
Represents the response shape from a JSBridge method call. Use with specific status codes
|
|
22
|
-
to constrain which responses are possible, or use `BridgeStatusCode` for the full union.
|
|
23
|
-
|
|
24
|
-
This type works for both single (non-streaming) responses and as the item type
|
|
25
|
-
emitted by [BridgeStream](BridgeStream.md).
|
|
26
|
-
|
|
27
|
-
Status codes come first in the type parameters for better readability at module call sites.
|
|
28
|
-
|
|
29
|
-
## Example
|
|
30
|
-
|
|
31
|
-
```typescript
|
|
32
|
-
// Constrained to specific status codes (common case)
|
|
33
|
-
type SuccessOrError = BridgeResponse<200 | 500, string>;
|
|
34
|
-
|
|
35
|
-
// Only success
|
|
36
|
-
type OnlySuccess = BridgeResponse<200, string>;
|
|
37
|
-
|
|
38
|
-
// Unconstrained - all status codes possible (internal use)
|
|
39
|
-
type AnyResponse = BridgeResponse<BridgeStatusCode, string>;
|
|
40
|
-
```
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
[@grabjs/superapp-sdk](../globals.md) / BridgeServerError
|
|
2
|
-
|
|
3
|
-
# Type Alias: BridgeServerError
|
|
4
|
-
|
|
5
|
-
> **BridgeServerError** = [`ResponseStatusCode500`](ResponseStatusCode500.md) \| [`ResponseStatusCode501`](ResponseStatusCode501.md)
|
|
6
|
-
|
|
7
|
-
Union type representing server error JSBridge responses (5xx status codes).
|
|
8
|
-
Includes status codes 500 (Internal Server Error) and 501 (Not Implemented).
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
[@grabjs/superapp-sdk](../globals.md) / BridgeStream
|
|
2
|
-
|
|
3
|
-
# Type Alias: BridgeStream\<Codes, T\>
|
|
4
|
-
|
|
5
|
-
> **BridgeStream**\<`Codes`, `T`\> = `Readonly`\<\{ `subscribe`: (`handlers?`: [`BridgeStreamHandlers`](BridgeStreamHandlers.md)\<`Codes`, `T`\>) => [`Subscription`](Subscription.md); \}\> & `PromiseLike`\<[`BridgeResponse`](BridgeResponse.md)\<`Codes`, `T`\>\>
|
|
6
|
-
|
|
7
|
-
A stream for receiving continuous data from JSBridge methods (e.g., location updates).
|
|
8
|
-
|
|
9
|
-
## Type Parameters
|
|
10
|
-
|
|
11
|
-
### Codes
|
|
12
|
-
|
|
13
|
-
`Codes` *extends* [`BridgeStatusCode`](BridgeStatusCode.md) = [`BridgeStatusCode`](BridgeStatusCode.md)
|
|
14
|
-
|
|
15
|
-
The status codes that can be emitted by the stream.
|
|
16
|
-
|
|
17
|
-
### T
|
|
18
|
-
|
|
19
|
-
`T` = `void`
|
|
20
|
-
|
|
21
|
-
The type of data emitted by the stream.
|
|
22
|
-
|
|
23
|
-
## Remarks
|
|
24
|
-
|
|
25
|
-
Provides both Observable-like and Promise-like interfaces:
|
|
26
|
-
- Use `subscribe()` to receive all values over time
|
|
27
|
-
- Use `then()` or `await` to receive only the first value
|
|
28
|
-
|
|
29
|
-
Note: Each `subscribe()` call creates a fresh subscription, allowing multiple independent listeners.
|