@authgear/web - npm Package Compare versions

Comparing version 0.22.0 to 1.0.0

index.d.ts

@@ -18,18 +18,2 @@ /**
 /**
- * Result of authorization.
- *
- * @public
- */
-export declare interface AuthorizeResult {
-    /**
-     * OAuth 2.0 state value.
-     */
-    state?: string;
-    /**
-     * UserInfo.
-     */
-    userInfo: UserInfo;
-}
-
-/**
  * CancelError means cancel.
@@ -100,23 +84,15 @@ * If you catch an error and it is instanceof CancelError,
 /**
- * Prompt parameter options.
- *
  * @public
  */
-export declare type PromptOption = "none" | "login" | "consent" | "select_account";
+export declare enum Page {
+    Settings = "/settings",
+    Identities = "/settings/identities"
+}
 
 /**
- * Result of reauthentication
+ * Prompt parameter options.
  *
  * @public
  */
-export declare interface ReauthenticateResult {
-    /**
-     * OAuth 2.0 state value.
-     */
-    state?: string;
-    /**
-     * UserInfo.
-     */
-    userInfo: UserInfo;
-}
+export declare type PromptOption = "none" | "login" | "consent" | "select_account";
 
@@ -257,3 +233,3 @@ /**
  */
-export declare interface AuthorizeOptions {
+export declare interface AuthenticateOptions {
     /**
@@ -296,7 +272,27 @@ * Redirect uri. Redirection URI to which the response will be sent after authorization.
     page?: string;
+    /**
+     * Auto redirect the user to the oauth provider
+     */
+    oauthProviderAlias?: string;
 }
 
 /**
+ * Result of authorization.
+ *
  * @public
  */
+export declare interface AuthenticateResult {
+    /**
+     * OAuth 2.0 state value.
+     */
+    state?: string;
+    /**
+     * UserInfo.
+     */
+    userInfo: UserInfo;
+}
+
+/**
+ * @public
+ */
 export declare interface ConfigureOptions {
@@ -386,2 +382,28 @@ /**
 /**
+ * Result of reauthentication
+ *
+ * @public
+ */
+export declare interface ReauthenticateResult {
+    /**
+     * OAuth 2.0 state value.
+     */
+    state?: string;
+    /**
+     * UserInfo.
+     */
+    userInfo: UserInfo;
+}
+
+/**
+ * @public
+ */
+export declare interface SettingOptions {
+    /**
+     * UI locale tags
+     */
+    uiLocales?: string[];
+}
+
+/**
  * Web Container
@@ -471,5 +493,5 @@ *
     /**
-     * Start authorization by redirecting to the authorization endpoint.
+     * Start authentication by redirecting to the authorization endpoint.
      */
-    startAuthorization(options: AuthorizeOptions): Promise<void>;
+    startAuthentication(options: AuthenticateOptions): Promise<void>;
     /**
@@ -484,7 +506,7 @@ * Start reauthentication by redirecting to the authorization endpoint.
     /**
-     * Finish authorization.
+     * Finish authentication.
      *
      * It may reject with OAuthError.
      */
-    finishAuthorization(): Promise<AuthorizeResult>;
+    finishAuthentication(): Promise<AuthenticateResult>;
     /**
@@ -503,2 +525,7 @@ * Finish reauthentication.
     /**
+     * Open the URL with the user agent authenticated with current user.
+     */
+    openURL(url: string, options?: SettingOptions): Promise<void>;
+    open(page: Page, options?: SettingOptions): Promise<void>;
+    /**
      * Logout.
@@ -510,3 +537,4 @@ *
      *
-     * `redirectURI` will be used only for the first party app
+     * `redirectURI` is required. User will be redirected to the uri after they
+     * have logged out.
      *
@@ -517,3 +545,3 @@ * @param options - Logout options
         force?: boolean;
-        redirectURI?: string;
+        redirectURI: string;
     }): Promise<void>;
@@ -523,5 +551,6 @@ /**
      */
-    authenticateAnonymously(): Promise<AuthorizeResult>;
+    authenticateAnonymously(): Promise<AuthenticateResult>;
     private _logoutRefreshToken;
     private _logoutCookie;
+    private _redirectToEndSessionEndpoint;
     /**
@@ -533,3 +562,3 @@ * Make authorize URL makes authorize URL based on options.
      */
-    makeAuthorizeURL(options: AuthorizeOptions): Promise<string>;
+    makeAuthorizeURL(options: AuthenticateOptions): Promise<string>;
     /**
@@ -536,0 +565,0 @@ * Fetch user info.

package.json

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

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

907579

increased by14.78%

Lines of code

24510

increased by15.41%

Number of low quality alerts

1

decreased by-50%

No dependency changes