Skip to content
This repository was archived by the owner on Sep 24, 2025. It is now read-only.

Commit 0442f0a

Browse files
authored
chore (nhost-js): update openapi (#44)
1 parent b26878a commit 0442f0a

5 files changed

Lines changed: 3212 additions & 2469 deletions

File tree

docs/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
## main
44

5+
- 20250705 feat chore (nhost-js): update openapi #44
56
- 20250704 feat (packages/nhost-js): added functions.post method and improve documentation #43
67
- 20250627 feat (packages/nhost-js): graphql.post -> graphql.request #41
78
- 20250624 feat (packages/nhost-js): add decoded token to session storage #37

docs/reference/javascript/nhost-js/auth.mdx

Lines changed: 252 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -462,6 +462,28 @@ This method may return different T based on the response code:
462462

463463
`Promise`<[`FetchResponse`](fetch#fetchresponse)<[`JWKSet`](#jwkset)>>
464464

465+
##### getUser()
466+
467+
```ts
468+
getUser(options?: RequestInit): Promise<FetchResponse<User>>;
469+
```
470+
471+
Summary: Get user information
472+
473+
This method may return different T based on the response code:
474+
475+
- 200: User
476+
477+
###### Parameters
478+
479+
| Parameter | Type |
480+
| ---------- | ------------- |
481+
| `options?` | `RequestInit` |
482+
483+
###### Returns
484+
485+
`Promise`&lt;[`FetchResponse`](fetch#fetchresponse)&lt;[`User`](#user-2)&gt;&gt;
486+
465487
##### getVersion()
466488

467489
```ts
@@ -757,6 +779,29 @@ This method may return different T based on the response code:
757779

758780
`Promise`&lt;[`FetchResponse`](fetch#fetchresponse)&lt;`"OK"`&gt;&gt;
759781

782+
##### signInPasswordlessSms()
783+
784+
```ts
785+
signInPasswordlessSms(body: SignInPasswordlessSmsRequest, options?: RequestInit): Promise<FetchResponse<"OK">>;
786+
```
787+
788+
Summary: Sign in with a one time password sent to user's phone number. If the user doesn't exist, it will be created. The options object is optional and can be used to configure the user's when signing up a new user. It is ignored if the user already exists.
789+
790+
This method may return different T based on the response code:
791+
792+
- 200: OKResponse
793+
794+
###### Parameters
795+
796+
| Parameter | Type |
797+
| ---------- | --------------------------------------------------------------- |
798+
| `body` | [`SignInPasswordlessSmsRequest`](#signinpasswordlesssmsrequest) |
799+
| `options?` | `RequestInit` |
800+
801+
###### Returns
802+
803+
`Promise`&lt;[`FetchResponse`](fetch#fetchresponse)&lt;`"OK"`&gt;&gt;
804+
760805
##### signInPAT()
761806

762807
```ts
@@ -832,7 +877,7 @@ This method may return different T based on the response code:
832877
##### signOut()
833878

834879
```ts
835-
signOut(body: SignOutSchema, options?: RequestInit): Promise<FetchResponse<"OK">>;
880+
signOut(body: SignOutRequest, options?: RequestInit): Promise<FetchResponse<"OK">>;
836881
```
837882

838883
Summary: Sign out
@@ -843,10 +888,10 @@ This method may return different T based on the response code:
843888

844889
###### Parameters
845890

846-
| Parameter | Type |
847-
| ---------- | --------------------------------- |
848-
| `body` | [`SignOutSchema`](#signoutschema) |
849-
| `options?` | `RequestInit` |
891+
| Parameter | Type |
892+
| ---------- | ----------------------------------- |
893+
| `body` | [`SignOutRequest`](#signoutrequest) |
894+
| `options?` | `RequestInit` |
850895

851896
###### Returns
852897

@@ -1020,6 +1065,29 @@ This method may return different T based on the response code:
10201065

10211066
`Promise`&lt;[`FetchResponse`](fetch#fetchresponse)&lt;[`SignInOTPEmailVerifyResponse`](#signinotpemailverifyresponse)&gt;&gt;
10221067

1068+
##### verifySignInPasswordlessSms()
1069+
1070+
```ts
1071+
verifySignInPasswordlessSms(body: SignInPasswordlessSmsOtpRequest, options?: RequestInit): Promise<FetchResponse<SignInPasswordlessSmsOtpResponse>>;
1072+
```
1073+
1074+
Summary: Verify SMS OTP and return a session if validation is successful
1075+
1076+
This method may return different T based on the response code:
1077+
1078+
- 200: SignInPasswordlessSmsOtpResponse
1079+
1080+
###### Parameters
1081+
1082+
| Parameter | Type |
1083+
| ---------- | --------------------------------------------------------------------- |
1084+
| `body` | [`SignInPasswordlessSmsOtpRequest`](#signinpasswordlesssmsotprequest) |
1085+
| `options?` | `RequestInit` |
1086+
1087+
###### Returns
1088+
1089+
`Promise`&lt;[`FetchResponse`](fetch#fetchresponse)&lt;[`SignInPasswordlessSmsOtpResponse`](#signinpasswordlesssmsotpresponse)&gt;&gt;
1090+
10231091
##### verifySignInWebauthn()
10241092

10251093
```ts
@@ -1089,6 +1157,30 @@ As this method is a redirect, it returns a URL string instead of a Promise
10891157

10901158
`string`
10911159

1160+
##### verifyToken()
1161+
1162+
```ts
1163+
verifyToken(body?: VerifyTokenRequest, options?: RequestInit): Promise<FetchResponse<string>>;
1164+
```
1165+
1166+
Summary: Verify JWT token
1167+
If request body is not passed the authorization header will be used to be verified
1168+
1169+
This method may return different T based on the response code:
1170+
1171+
- 200: string
1172+
1173+
###### Parameters
1174+
1175+
| Parameter | Type |
1176+
| ---------- | ------------------------------------------- |
1177+
| `body?` | [`VerifyTokenRequest`](#verifytokenrequest) |
1178+
| `options?` | `RequestInit` |
1179+
1180+
###### Returns
1181+
1182+
`Promise`&lt;[`FetchResponse`](fetch#fetchresponse)&lt;`string`&gt;&gt;
1183+
10921184
---
10931185

10941186
### CreatePATRequest
@@ -2035,6 +2127,74 @@ optional options: SignUpOptions;
20352127

20362128
---
20372129

2130+
### SignInPasswordlessSmsOtpRequest
2131+
2132+
#### Properties
2133+
2134+
##### otp
2135+
2136+
```ts
2137+
otp: string;
2138+
```
2139+
2140+
(`string`) - One-time password received by SMS
2141+
2142+
##### phoneNumber
2143+
2144+
```ts
2145+
phoneNumber: string;
2146+
```
2147+
2148+
(`string`) - Phone number of the user
2149+
2150+
- Example - `"+123456789"`
2151+
2152+
---
2153+
2154+
### SignInPasswordlessSmsOtpResponse
2155+
2156+
#### Properties
2157+
2158+
##### mfa?
2159+
2160+
```ts
2161+
optional mfa: MFAChallengePayload;
2162+
```
2163+
2164+
Challenge payload for multi-factor authentication
2165+
2166+
##### session?
2167+
2168+
```ts
2169+
optional session: Session;
2170+
```
2171+
2172+
User authentication session containing tokens and user information
2173+
2174+
---
2175+
2176+
### SignInPasswordlessSmsRequest
2177+
2178+
#### Properties
2179+
2180+
##### options?
2181+
2182+
```ts
2183+
optional options: SignUpOptions;
2184+
```
2185+
2186+
##### phoneNumber
2187+
2188+
```ts
2189+
phoneNumber: string;
2190+
```
2191+
2192+
(`string`) - Phone number of the user
2193+
2194+
- Example - `"+123456789"`
2195+
2196+
---
2197+
20382198
### SignInPATRequest
20392199

20402200
#### Properties
@@ -2156,7 +2316,7 @@ Format - email
21562316

21572317
---
21582318

2159-
### SignOutSchema
2319+
### SignOutRequest
21602320

21612321
#### Properties
21622322

@@ -2168,13 +2328,13 @@ optional all: boolean;
21682328

21692329
Sign out from all connected devices
21702330

2171-
##### refreshToken
2331+
##### refreshToken?
21722332

21732333
```ts
2174-
refreshToken: string;
2334+
optional refreshToken: string;
21752335
```
21762336

2177-
(`string`) - Refresh token for the current session
2337+
Refresh token for the current session
21782338

21792339
---
21802340

@@ -2360,6 +2520,14 @@ User profile and account information
23602520

23612521
#### Properties
23622522

2523+
##### activeMfaType?
2524+
2525+
```ts
2526+
optional activeMfaType: string;
2527+
```
2528+
2529+
Active MFA type for the user
2530+
23632531
##### avatarUrl
23642532

23652533
```ts
@@ -2495,6 +2663,50 @@ roles: string[];
24952663

24962664
---
24972665

2666+
### UserAddSecurityKeyVerifyRequest
2667+
2668+
#### Properties
2669+
2670+
##### credential
2671+
2672+
```ts
2673+
credential: Record<string, unknown>;
2674+
```
2675+
2676+
(`Record<string, unknown>`) -
2677+
2678+
##### nickname?
2679+
2680+
```ts
2681+
optional nickname: string;
2682+
```
2683+
2684+
Optional nickname for the security key
2685+
2686+
---
2687+
2688+
### UserAddSecurityKeyVerifyResponse
2689+
2690+
#### Properties
2691+
2692+
##### id
2693+
2694+
```ts
2695+
id: string;
2696+
```
2697+
2698+
(`string`) - ID of the newly added security key
2699+
2700+
##### nickname?
2701+
2702+
```ts
2703+
optional nickname: string;
2704+
```
2705+
2706+
Nickname of the security key
2707+
2708+
---
2709+
24982710
### UserDeanonymizeRequest
24992711

25002712
#### Properties
@@ -2780,6 +2992,20 @@ Type of the ticket. Deprecated, no longer used
27802992

27812993
- Type of the ticket
27822994

2995+
---
2996+
2997+
### VerifyTokenRequest
2998+
2999+
#### Properties
3000+
3001+
##### token?
3002+
3003+
```ts
3004+
optional token: string;
3005+
```
3006+
3007+
JWT token to verify
3008+
27833009
## Type Aliases
27843010

27853011
### AttestationFormat
@@ -2873,7 +3099,13 @@ type ErrorResponseError =
28733099
| "no-totp-secret"
28743100
| "invalid-totp"
28753101
| "mfa-type-not-found"
2876-
| "totp-already-active";
3102+
| "totp-already-active"
3103+
| "invalid-state"
3104+
| "oauth-token-echange-failed"
3105+
| "oauth-profile-fetch-failed"
3106+
| "oauth-provider-error"
3107+
| "invalid-otp"
3108+
| "cannot-send-sms";
28773109
```
28783110

28793111
Error code identifying the specific application error
@@ -2935,7 +3167,16 @@ type SignInProvider =
29353167
| "google"
29363168
| "linkedin"
29373169
| "discord"
2938-
| "spotify";
3170+
| "spotify"
3171+
| "twitch"
3172+
| "gitlab"
3173+
| "bitbucket"
3174+
| "workos"
3175+
| "azuread"
3176+
| "strava"
3177+
| "facebook"
3178+
| "windowslive"
3179+
| "twitter";
29393180
```
29403181

29413182
---

packages/nhost-js/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# dev
22

3+
- chore (nhost-js): update openapi #44
34
- feat (packages/nhost-js): added functions.post method and improve documentation #43
45
- feat (packages/nhost-js): add decoded token to session storage #37
56
- feat (packages/nhost-js): graphql.post -> graphql.request #41

0 commit comments

Comments
 (0)