@inweb/client 25.4.1 → 25.4.2

package/lib/Api/Client.d.ts

@@ -92,13 +92,22 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      */
     signInWithEmail(email: string, password: string): Promise<User>;
     /**
-     * Log in an existing user using API Key.
+     * Log in an existing user using access token (API Key).
      *
      * @async
-     * @param token - An access token for authentication request. See
-     *   {@link User#token | User.token} for more details.
+     * @param token - An access token for authentication request. See {@link User.token} for more details.
      */
     signInWithToken(token: string): Promise<User>;
+    /**
+     * Get the list of server indentity providers.
+     *
+     * To sign in with the provider in your web application:
+     *
+     * - Open the `provider.url` link using `window.open()`.
+     * - Add a `/oauth` path (server-defined) handler to the router. In this handler, show an error
+     *   message if the `error` search parameter is present, or log in with the `token` search parameter.
+     */
+    getIdentityProviders(): Promise<any>;
     private setCurrentUser;
     private clearCurrentUser;
     /**

package/lib/Api/User.d.ts

@@ -132,7 +132,7 @@ export declare class User {
      */
     get projectsLimit(): number;
     /**
-     * The user's API key.
+     * The user's access token (API key). Use {@link Client.signInWithToken()} to log in using token.
      *
      * @readonly
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "25.4.1",
+  "version": "25.4.2",
   "description": "JavaScript REST API client for the Open Cloud Server",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",
@@ -26,6 +26,6 @@
     "ts-docs": "typedoc"
   },
   "dependencies": {
-    "@inweb/eventemitter2": "~25.4.1"
+    "@inweb/eventemitter2": "~25.4.2"
   }
 }

package/src/Api/Client.ts

@@ -205,11 +205,10 @@ export class Client extends EventEmitter2<ClientEventMap> {
   }
 
   /**
-   * Log in an existing user using API Key.
+   * Log in an existing user using access token (API Key).
    *
    * @async
-   * @param token - An access token for authentication request. See
-   *   {@link User#token | User.token} for more details.
+   * @param token - An access token for authentication request. See {@link User.token} for more details.
    */
   async signInWithToken(token: string): Promise<User> {
     this._httpClient.headers = { Authorization: token };
@@ -218,6 +217,19 @@ export class Client extends EventEmitter2<ClientEventMap> {
     return this.setCurrentUser(data);
   }
 
+  /**
+   * Get the list of server indentity providers.
+   *
+   * To sign in with the provider in your web application:
+   *
+   * - Open the `provider.url` link using `window.open()`.
+   * - Add a `/oauth` path (server-defined) handler to the router. In this handler, show an error
+   *   message if the `error` search parameter is present, or log in with the `token` search parameter.
+   */
+  getIdentityProviders(): Promise<any> {
+    return this._httpClient.get("/identity").then((response) => response.json());
+  }
+
   // Save the current logged in user information for internal use.
 
   private setCurrentUser(data: any): User {

package/src/Api/User.ts

@@ -233,7 +233,7 @@ export class User {
   }
 
   /**
-   * The user's API key.
+   * The user's access token (API key). Use {@link Client.signInWithToken()} to log in using token.
    *
    * @readonly
    */