@asgardeo/node 0.0.1 → 0.0.3

package/README.md

@@ -28,7 +28,7 @@ import { AsgardeoNodeClient } from "@asgardeo/node";
 
 // Initialize the client
 const authClient = new AsgardeoNodeClient({
-    clientID: "<your_client_id>",
+    clientId: "<your_client_id>",
     clientSecret: "<your_client_secret>",
     baseUrl: "https://api.asgardeo.io/t/<org_name>",
     callbackURL: "http://localhost:3000/callback"
@@ -40,7 +40,7 @@ const app = express();
 
 // Login endpoint
 app.get("/login", (req, res) => {
-    const authUrl = authClient.getAuthorizationURL();
+    const authUrl = authClient.getSignInUrl();
     res.redirect(authUrl);
 });
 

package/dist/AsgardeoNodeClient.d.ts

@@ -20,7 +20,7 @@ import { AsgardeoNodeConfig } from './models/config';
 /**
  * Base class for implementing Asgardeo in Node.js based applications.
  * This class provides the core functionality for managing user authentication and sessions.
- *
+ *getConfigData
  * @typeParam T - Configuration type that extends AsgardeoNodeConfig.
  */
 declare abstract class AsgardeoNodeClient<T = AsgardeoNodeConfig> extends AsgardeoJavaScriptClient<T> {

package/dist/__legacy__/client.d.ts

@@ -1,7 +1,7 @@
 /**
- * Copyright (c) 2022, WSO2 Inc. (http://www.wso2.com) All Rights Reserved.
+ * Copyright (c) {{year}}, WSO2 LLC. (https://www.wso2.com).
  *
- * WSO2 Inc. licenses this file to you under the Apache License,
+ * WSO2 LLC. licenses this file to you under the Apache License,
  * Version 2.0 (the "License"); you may not use this file except
  * in compliance with the License.
  * You may obtain a copy of the License at
@@ -15,7 +15,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { AuthClientConfig, BasicUserInfo, CustomGrantConfig, DataLayer, IdTokenPayload, FetchResponse, OIDCEndpoints, Store, TokenResponse } from '@asgardeo/javascript';
+import { AuthClientConfig, TokenExchangeRequestConfig, StorageManager, IdToken, OIDCEndpoints, Storage, TokenResponse, User, ExtendedAuthorizeRequestUrlParams } from '@asgardeo/javascript';
 import { AuthURLCallback } from './models';
 /**
  * This class provides the necessary methods needed to implement authentication.
@@ -29,15 +29,15 @@ export declare class AsgardeoNodeClient<T> {
       * This is the constructor method that returns an instance of the `AsgardeoNodeClient` class.
       *
       * @param {AuthClientConfig<T>} config - The configuration object.
-      * @param {Store} store - The store object.
+      * @param {Storage} store - The store object.
       *
       * @example
       * ```
-      * const _store: Store = new DataStore();
+      * const _store: Storage = new DataStore();
       * const _config = {
-             signInRedirectURL: "http://localhost:3000/sign-in",
-             signOutRedirectURL: "http://localhost:3000/dashboard",
-             clientID: "client ID",
+             afterSignInUrl: "http://localhost:3000/sign-in",
+             afterSignOutUrl: "http://localhost:3000/dashboard",
+             clientId: "client ID",
              serverOrigin: "https://api.asgardeo.io/t/<org_name>"
          };
       * const auth = new AsgardeoNodeClient(_config,_store);
@@ -47,13 +47,13 @@ export declare class AsgardeoNodeClient<T> {
       * @preserve
       */
     constructor();
-    initialize(config: AuthClientConfig<T>, store?: Store): Promise<boolean>;
+    initialize(config: AuthClientConfig<T>, store?: Storage): Promise<boolean>;
     /**
      * This method logs in a user. If the authorization code is not available it will resolve with the
      * authorization URL to authorize the user.
      * @param {string} authorizationCode - The authorization code obtained from Asgardeo after a user signs in.
      * @param {String} sessionState - The session state obtained from Asgardeo after a user signs in.
-     * @param {string} userID - (Optional) A unique ID of the user to be authenticated. This is useful in multi-user
+     * @param {string} userId - (Optional) A unique ID of the user to be authenticated. This is useful in multi-user
      * scenarios where each user should be uniquely identified.
      * @param {string} state - The state parameter in the redirect URL.
      *
@@ -81,6 +81,12 @@ export declare class AsgardeoNodeClient<T> {
      *
      */
     signIn(authURLCallback: AuthURLCallback, userId: string, authorizationCode?: string, sessionState?: string, state?: string, signInConfig?: Record<string, string | boolean>): Promise<TokenResponse>;
+    /**
+     * Method to get the configuration data.
+     *
+     * @returns {Promise<AuthClientConfig<Config>>} - A promise that resolves with the configuration data.
+     */
+    getConfigData(): Promise<AuthClientConfig<T>>;
     /**
      * This method clears all session data and returns the sign-out URL.
      * @param {string} userId - The userId of the user. (If you are using ExpressJS,
@@ -108,15 +114,15 @@ export declare class AsgardeoNodeClient<T> {
      *
      * @example
      * ```
-     * const isAuth = await authClient.isAuthenticated("a2a2972c-51cd-5e9d-a9ae-058fae9f7927");
+     * const isAuth = await authClient.isSignedIn("a2a2972c-51cd-5e9d-a9ae-058fae9f7927");
      * ```
      *
-     * @link https://github.com/asgardeo/asgardeo-auth-js-sdk/tree/master#isAuthenticated
+     * @link https://github.com/asgardeo/asgardeo-auth-js-sdk/tree/master#isSignedIn
      *
      * @memberof AsgardeoNodeClient
      *
      */
-    isAuthenticated(userId: string): Promise<boolean>;
+    isSignedIn(userId: string): Promise<boolean>;
     /**
      * This method returns the id token.
      * @param {string} userId - The userId of the user.
@@ -126,15 +132,15 @@ export declare class AsgardeoNodeClient<T> {
      *
      * @example
      * ```
-     * const isAuth = await authClient.getIDToken("a2a2972c-51cd-5e9d-a9ae-058fae9f7927");
+     * const isAuth = await authClient.getIdToken("a2a2972c-51cd-5e9d-a9ae-058fae9f7927");
      * ```
      *
-     * @link https://github.com/asgardeo/asgardeo-auth-js-sdk/tree/master#getIDToken
+     * @link https://github.com/asgardeo/asgardeo-auth-js-sdk/tree/master#getIdToken
      *
      * @memberof AsgardeoNodeClient
      *
      */
-    getIDToken(userId: string): Promise<string>;
+    getIdToken(userId: string): Promise<string>;
     /**
      * This method returns an object containing basic user information obtained from the id token.
      * @param {string} userId - The userId of the user.
@@ -145,15 +151,15 @@ export declare class AsgardeoNodeClient<T> {
      *
      * @example
      * ```
-     * const basicInfo = await authClient.getBasicUserInfo("a2a2972c-51cd-5e9d-a9ae-058fae9f7927");
+     * const basicInfo = await authClient.getUser("a2a2972c-51cd-5e9d-a9ae-058fae9f7927");
      * ```
      *
-     * @link https://github.com/asgardeo/asgardeo-auth-js-sdk/tree/master#getBasicUserInfo
+     * @link https://github.com/asgardeo/asgardeo-auth-js-sdk/tree/master#getUser
      *
      * @memberof AsgardeoNodeClient
      *
      */
-    getBasicUserInfo(userId: string): Promise<BasicUserInfo>;
+    getUser(userId: string): Promise<User>;
     /**
      * This method returns an object containing the OIDC service endpoints returned by the `.well-known` endpoint.
      * @return {Promise<OIDCEndpoints>} -A Promise that resolves with
@@ -161,34 +167,34 @@ export declare class AsgardeoNodeClient<T> {
      *
      * @example
      * ```
-     * const oidcEndpoints = await auth.getOIDCServiceEndpoints();
+     * const oidcEndpoints = await auth.getOpenIDProviderEndpoints();
      * ```
      *
-     * @link https://github.com/asgardeo/asgardeo-auth-js-sdk/tree/master#getOIDCServiceEndpoints
+     * @link https://github.com/asgardeo/asgardeo-auth-js-sdk/tree/master#getOpenIDProviderEndpoints
      *
      * @memberof AsgardeoNodeClient
      *
      */
-    getOIDCServiceEndpoints(): Promise<OIDCEndpoints>;
+    getOpenIDProviderEndpoints(): Promise<OIDCEndpoints>;
     /**
      * This method returns the decoded ID token payload.
      * @param {string} userId - The userId of the user.
      * (If you are using ExpressJS, you may get this from the request cookies)
      *
-     * @return {Promise<IdTokenPayload>} -A Promise that resolves with
+     * @return {Promise<IdToken>} -A Promise that resolves with
      * an object containing the decoded ID token payload.
      *
      * @example
      * ```
-     * const decodedIDTokenPayload = await auth.getDecodedIDToken("a2a2972c-51cd-5e9d-a9ae-058fae9f7927");
+     * const decodedIDTokenPayload = await auth.getDecodedIdToken("a2a2972c-51cd-5e9d-a9ae-058fae9f7927");
      * ```
      *
-     * @link https://github.com/asgardeo/asgardeo-auth-js-sdk/tree/master#getDecodedIDToken
+     * @link https://github.com/asgardeo/asgardeo-auth-js-sdk/tree/master#getDecodedIdToken
      *
      * @memberof AsgardeoNodeClient
      *
      */
-    getDecodedIDToken(userId?: string): Promise<IdTokenPayload>;
+    getDecodedIdToken(userId?: string): Promise<IdToken>;
     /**
      * This method returns the access token.
      * @param {string} userId - The userId of the user.
@@ -211,13 +217,13 @@ export declare class AsgardeoNodeClient<T> {
     /**
        * This method returns Promise that resolves with the token information
        * or the response returned by the server depending on the configuration passed.
-       * @param {CustomGrantConfig} config - The config object contains attributes that would be used
+       * @param {TokenExchangeRequestConfig} config - The config object contains attributes that would be used
        * to configure the custom grant request.
        *
        * @param {string} userId - The userId of the user.
        * (If you are using ExpressJS, you may get this from the request cookies)
        *
-       * @return {Promise<TokenResponse | FetchResponse>} -A Promise that resolves with the token information
+       * @return {Promise<TokenResponse | Response>} -A Promise that resolves with the token information
        * or the response returned by the server depending on the configuration passed.
        *
        * @example
@@ -225,7 +231,7 @@ export declare class AsgardeoNodeClient<T> {
        * const config = {
        *      attachToken: false,
        *      data: {
-       *          client_id: "{{clientID}}",
+       *          client_id: "{{clientId}}",
        *          grant_type: "account_switch",
        *          scope: "{{scope}}",
        *          token: "{{token}}",
@@ -236,19 +242,19 @@ export declare class AsgardeoNodeClient<T> {
        *      signInRequired: true
        * }
   
-       * auth.requestCustomGrant(config).then((response)=>{
+       * auth.exchangeToken(config).then((response)=>{
        *     console.log(response);
        * }).catch((error)=>{
        *     console.error(error);
        * });
        * ```
        *
-       * @link https://github.com/asgardeo/asgardeo-auth-js-sdk/tree/master#requestCustomGrant
+       * @link https://github.com/asgardeo/asgardeo-auth-js-sdk/tree/master#exchangeToken
        *
        * @memberof AsgardeoNodeClient
        *
        */
-    requestCustomGrant(config: CustomGrantConfig, userId?: string): Promise<TokenResponse | FetchResponse>;
+    exchangeToken(config: TokenExchangeRequestConfig, userId?: string): Promise<TokenResponse | Response>;
     /**
      * This method can be used to update the configurations passed into the constructor of the AsgardeoAuthClient.
      * @param {AuthClientConfig<T>} config - The config object containing the attributes
@@ -258,23 +264,24 @@ export declare class AsgardeoNodeClient<T> {
      *
      * @example
      * ```
-     * const updateConfig = await auth.updateConfig({
-     *       signOutRedirectURL: "http://localhost:3000/sign-out"
+     * const reInitialize = await auth.reInitialize({
+     *       afterSignOutUrl: "http://localhost:3000/sign-out"
      *   });
      * ```
      *
-     * @link https://github.com/asgardeo/asgardeo-auth-js-sdk/tree/master#updateConfig
+     * @link https://github.com/asgardeo/asgardeo-auth-js-sdk/tree/master#reInitialize
      *
      * @memberof AsgardeoNodeClient
      *
      */
-    updateConfig(config: Partial<AuthClientConfig<T>>): Promise<void>;
+    reInitialize(config: Partial<AuthClientConfig<T>>): Promise<void>;
+    getSignInUrl(requestConfig?: ExtendedAuthorizeRequestUrlParams, userId?: string): Promise<string>;
     /**
      * This method returns a Promise that resolves with the response returned by the server.
      * @param {string} userId - The userId of the user.
      * (If you are using ExpressJS, you may get this from the request cookies)
      *
-     * @return {Promise<FetchResponse>} -A Promise that resolves with the response returned by the server.
+     * @return {Promise<Response>} -A Promise that resolves with the response returned by the server.
      *
      * @example
      * ```
@@ -286,7 +293,7 @@ export declare class AsgardeoNodeClient<T> {
      * @memberof AsgardeoNodeClient
      *
      */
-    revokeAccessToken(userId?: string): Promise<FetchResponse>;
+    revokeAccessToken(userId?: string): Promise<Response>;
     /**
      * This method refreshes the access token and returns a Promise that resolves with the new access
      * token and other relevant data.
@@ -308,7 +315,7 @@ export declare class AsgardeoNodeClient<T> {
     refreshAccessToken(userId?: string): Promise<TokenResponse>;
     /**
      * This method returns if the user has been successfully signed out or not.
-     * @param {string} signOutRedirectURL - The URL to which the user is redirected to
+     * @param {string} afterSignOutUrl - The URL to which the user is redirected to
      * after signing out from the server.
      *
      * @return {boolean} - A boolean value indicating if the user has been signed out or not.
@@ -323,10 +330,10 @@ export declare class AsgardeoNodeClient<T> {
      * @memberof AsgardeoNodeClient
      *
      */
-    static isSignOutSuccessful(signOutRedirectURL: string): boolean;
+    static isSignOutSuccessful(afterSignOutUrl: string): boolean;
     /**
      * This method returns if sign-out failed or not
-     * @param {string} signOutRedirectURL - The URL to which the user is redirected to
+     * @param {string} afterSignOutUrl - The URL to which the user is redirected to
      * after signing out from the server.
      *
      * @return {boolean} - A boolean value indicating if sign-out failed or not.
@@ -341,6 +348,6 @@ export declare class AsgardeoNodeClient<T> {
      * @memberof AsgardeoNodeClient
      *
      */
-    static didSignOutFail(signOutRedirectURL: string): boolean;
-    getDataLayer(): Promise<DataLayer<T>>;
+    static didSignOutFail(afterSignOutUrl: string): boolean;
+    getStorageManager(): Promise<StorageManager<T>>;
 }

package/dist/__legacy__/core/authentication.d.ts

@@ -15,29 +15,30 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { AuthClientConfig, BasicUserInfo, CustomGrantConfig, DataLayer, IdTokenPayload, FetchResponse, OIDCEndpoints, Store, TokenResponse } from '@asgardeo/javascript';
+import { AuthClientConfig, TokenExchangeRequestConfig, StorageManager, IdToken, OIDCEndpoints, Storage, TokenResponse, User } from '@asgardeo/javascript';
 import { AuthURLCallback } from '../models';
 export declare class AsgardeoNodeCore<T> {
     private _auth;
     private _cryptoUtils;
     private _store;
-    private _dataLayer;
-    constructor(config: AuthClientConfig<T>, store?: Store);
-    signIn(authURLCallback: AuthURLCallback, userID: string, authorizationCode?: string, sessionState?: string, state?: string, signInConfig?: Record<string, string | boolean>): Promise<TokenResponse>;
+    private _storageManager;
+    constructor(config: AuthClientConfig<T>, store?: Storage);
+    signIn(authURLCallback: AuthURLCallback, userId: string, authorizationCode?: string, sessionState?: string, state?: string, signInConfig?: Record<string, string | boolean>): Promise<TokenResponse>;
     getAuthURL(userId: string, signInConfig?: Record<string, string | boolean>): Promise<string>;
     requestAccessToken(authorizationCode: string, sessionState: string, userId: string, state: string): Promise<TokenResponse>;
-    getIDToken(userId: string): Promise<string>;
+    getIdToken(userId: string): Promise<string>;
     refreshAccessToken(userId?: string): Promise<TokenResponse>;
-    isAuthenticated(userId: string): Promise<boolean>;
+    isSignedIn(userId: string): Promise<boolean>;
     signOut(userId: string): Promise<string>;
-    getBasicUserInfo(userId: string): Promise<BasicUserInfo>;
-    getOIDCServiceEndpoints(): Promise<OIDCEndpoints>;
-    getDecodedIDToken(userId?: string): Promise<IdTokenPayload>;
+    getUser(userId: string): Promise<User>;
+    getConfigData(): Promise<AuthClientConfig<T>>;
+    getOpenIDProviderEndpoints(): Promise<OIDCEndpoints>;
+    getDecodedIdToken(userId?: string): Promise<IdToken>;
     getAccessToken(userId?: string): Promise<string>;
-    requestCustomGrant(config: CustomGrantConfig, userId?: string): Promise<TokenResponse | FetchResponse>;
-    updateConfig(config: Partial<AuthClientConfig<T>>): Promise<void>;
-    revokeAccessToken(userId?: string): Promise<FetchResponse>;
-    static didSignOutFail(signOutRedirectURL: string): boolean;
-    static isSignOutSuccessful(signOutRedirectURL: string): boolean;
-    getDataLayer(): DataLayer<T>;
+    exchangeToken(config: TokenExchangeRequestConfig, userId?: string): Promise<TokenResponse | Response>;
+    reInitialize(config: Partial<AuthClientConfig<T>>): Promise<void>;
+    revokeAccessToken(userId?: string): Promise<Response>;
+    static didSignOutFail(afterSignOutUrl: string): boolean;
+    static isSignOutSuccessful(afterSignOutUrl: string): boolean;
+    getStorageManager(): StorageManager<T>;
 }

package/dist/__legacy__/stores/memory-cache-store.d.ts

@@ -15,8 +15,8 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { Store } from '@asgardeo/javascript';
-export declare class MemoryCacheStore implements Store {
+import { Storage } from '@asgardeo/javascript';
+export declare class MemoryCacheStore implements Storage {
     setData(key: string, value: string): Promise<void>;
     getData(key: string): Promise<string>;
     removeData(key: string): Promise<void>;

package/dist/__legacy__/utils/crypto-utils.d.ts

@@ -27,5 +27,5 @@ export declare class NodeCryptoUtils implements Crypto<Buffer | string> {
     base64URLDecode(value: string): string;
     hashSha256(data: string): string | Buffer;
     generateRandomBytes(length: number): string | Buffer;
-    verifyJwt(idToken: string, jwk: Partial<JWKInterface>, algorithms: string[], clientID: string, issuer: string, subject: string, clockTolerance?: number): Promise<boolean>;
+    verifyJwt(idToken: string, jwk: Partial<JWKInterface>, algorithms: string[], clientId: string, issuer: string, subject: string, clockTolerance?: number): Promise<boolean>;
 }