@authgear/web - npm Package Compare versions

Comparing version 2.5.1 to 2.6.0

index.d.ts

@@ -222,2 +222,3 @@ /**
     canReauthenticate: boolean;
+    roles?: string[];
     raw: Record<string, unknown>;
@@ -266,3 +267,4 @@ customAttributes: Record<string, unknown>;
     /**
-     * Redirect uri. Redirection URI to which the response will be sent after authorization.
+     * The value should be a valid Redirect URI to which the response will be sent after authentication.
+     * You must also add a Redirect URI in Authgear Poral via the Redirect URI section of your Authgear Application.
      */
@@ -296,3 +298,8 @@ redirectURI: string;
     /**
-     * UI locale tags
+     * UI locale tags. You can use this parameter to set the display language for Auth UI.
+     *
+     * First, enable the language you want to change to in Authgear Portal (Your project \> UI Settings \> click on the settings icon beside Language.)
+     *
+     * For example, to change the language for Auth UI to Hong Kong,
+     * set the value for uiLocales to ["zh-HK"] after enabling "Chinese (Hong Kong)" in Authgear Portal.
      */
@@ -309,3 +316,7 @@ uiLocales?: string[];
     /**
-     * Auto redirect the user to the oauth provider
+     * Auto-redirect the user to the OAuth provider. You can set the value for each OAuth provider in Authgear portal via
+     * Authentication \> Social / Enterprise Login.
+     *
+     * For example, to auto-redirect your users to sign in with Google, first, set the alias for Sign in with Google to "google" in Authgear portal,
+     * then set oauthProviderAlias to "google".
      */
@@ -388,3 +399,4 @@ oauthProviderAlias?: string;
     /**
-     * Redirect uri. Redirection URI to which the response will be sent after authorization.
+     * The value should be a valid Redirect URI to which the response will be sent after authentication.
+     * You must also add a Redirect URI in Authgear Poral via the Redirect URI section of your Authgear Application.
      */
@@ -401,3 +413,8 @@ redirectURI: string;
     /**
-     * UI locale tags
+     * UI locale tags. You can use this parameter to set the display language for Auth UI.
+     *
+     * First, enable the language you want to change to in Authgear Portal (Your project \> UI Settings \> click on the settings icon beside Language.)
+     *
+     * For example, to change the language for Auth UI to Hong Kong,
+     * set the value for uiLocales to ["zh-HK"] after enabling "Chinese (Hong Kong)" in Authgear Portal.
      */
@@ -417,3 +434,4 @@ uiLocales?: string[];
     /**
-     * Redirect uri. Redirection URI to which the response will be sent after authorization.
+     * The value should be a valid Redirect URI to which the response will be sent after authentication.
+     * You must also add a Redirect URI in Authgear Poral via the Redirect URI section of your Authgear Application.
      */
@@ -430,3 +448,8 @@ redirectURI: string;
     /**
-     * UI locale tags
+     * UI locale tags. You can use this parameter to set the display language for Auth UI.
+     *
+     * First, enable the language you want to change to in Authgear Portal (Your project \> UI Settings \> click on the settings icon beside Language.)
+     *
+     * For example, to change the language for Auth UI to Hong Kong,
+     * set the value for uiLocales to ["zh-HK"] after enabling "Chinese (Hong Kong)" in Authgear Portal.
      */
@@ -461,3 +484,8 @@ uiLocales?: string[];
     /**
-     * UI locale tags
+     * UI locale tags. You can use this parameter to set the display language for Auth UI.
+     *
+     * First, enable the language you want to change to in Authgear Portal (Your project \> UI Settings \> click on the settings icon beside Language.)
+     *
+     * For example, to change the language for Auth UI to Hong Kong,
+     * set the value for uiLocales to ["zh-HK"] after enabling "Chinese (Hong Kong)" in Authgear Portal.
      */
@@ -464,0 +492,0 @@ uiLocales?: string[];

package.json

 {
   "name": "@authgear/web",
-  "version": "2.5.1",
+  "version": "2.6.0",
   "license": "Apache-2.0",
@@ -14,5 +14,5 @@ "main": "dist/authgear-web.cjs.js",
   "devDependencies": {
-    "@authgear/core": "2.5.1",
+    "@authgear/core": "2.6.0",
     "core-js-pure": "3.22.7"
   }
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

850008

increased by0.3%

Lines of code

22631

increased by0.14%

No dependency changes