@logto/js 4.1.0 → 4.1.1
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/lib/core/sign-in.d.ts +15 -6
- package/lib/types/index.d.ts +2 -2
- package/package.json +1 -1
package/lib/core/sign-in.d.ts
CHANGED
|
@@ -1,16 +1,15 @@
|
|
|
1
1
|
import { Prompt } from '../consts/index.js';
|
|
2
2
|
import type { FirstScreen, InteractionMode } from '../types/index.js';
|
|
3
|
+
/** @experimental Don't use this type as it's under development. */
|
|
3
4
|
export type DirectSignInOptions = {
|
|
4
5
|
/**
|
|
5
6
|
* The method to be used for the direct sign-in.
|
|
6
7
|
*/
|
|
7
|
-
method: 'social'
|
|
8
|
+
method: 'social';
|
|
8
9
|
/**
|
|
9
10
|
* The target to be used for the direct sign-in.
|
|
10
11
|
*
|
|
11
12
|
* - For `method: 'social'`, it should be the social connector target.
|
|
12
|
-
* - For `method: 'email'`, it should be the email address.
|
|
13
|
-
* - For `method: 'sms'`, it should be the phone number.
|
|
14
13
|
*/
|
|
15
14
|
target: string;
|
|
16
15
|
};
|
|
@@ -23,15 +22,25 @@ export type SignInUriParameters = {
|
|
|
23
22
|
scopes?: string[];
|
|
24
23
|
resources?: string[];
|
|
25
24
|
prompt?: Prompt | Prompt[];
|
|
26
|
-
/**
|
|
25
|
+
/**
|
|
26
|
+
* The first screen to be shown in the sign-in experience.
|
|
27
|
+
*
|
|
28
|
+
* @experimental Don't use this field as it's under development.
|
|
29
|
+
*/
|
|
27
30
|
firstScreen?: FirstScreen;
|
|
28
|
-
/**
|
|
31
|
+
/** The first screen to be shown in the sign-in experience. */
|
|
29
32
|
interactionMode?: InteractionMode;
|
|
30
33
|
/**
|
|
31
34
|
* Login hint indicates the current user (usually an email address or a phone number).
|
|
35
|
+
*
|
|
36
|
+
* @experimental Don't use this field as it's under development.
|
|
32
37
|
*/
|
|
33
38
|
loginHint?: string;
|
|
34
|
-
/**
|
|
39
|
+
/**
|
|
40
|
+
* Parameters for direct sign-in.
|
|
41
|
+
*
|
|
42
|
+
* @experimental Don't use this field as it's under development.
|
|
43
|
+
*/
|
|
35
44
|
directSignIn?: DirectSignInOptions;
|
|
36
45
|
/**
|
|
37
46
|
* Extra parameters for the authentication request. Note that the parameters should be supported
|
package/lib/types/index.d.ts
CHANGED
|
@@ -13,12 +13,12 @@ export type Requester = <T>(...args: Parameters<typeof fetch>) => Promise<T>;
|
|
|
13
13
|
*
|
|
14
14
|
* - `signIn`: The authorization request will be initiated with a sign-in page.
|
|
15
15
|
* - `signUp`: The authorization request will be initiated with a sign-up page.
|
|
16
|
-
*
|
|
17
|
-
* @deprecated Use {@link FirstScreen} instead.
|
|
18
16
|
*/
|
|
19
17
|
export type InteractionMode = 'signIn' | 'signUp';
|
|
20
18
|
/**
|
|
21
19
|
* The first screen to be shown in the sign-in experience. Note it's not a part of the OIDC
|
|
22
20
|
* standard, but a Logto-specific extension.
|
|
21
|
+
*
|
|
22
|
+
* @experimental Don't use this type as it's under development.
|
|
23
23
|
*/
|
|
24
24
|
export type FirstScreen = 'signIn' | 'register';
|