@asgardeo/javascript 0.0.1 → 0.1.1

package/README.md

@@ -28,8 +28,8 @@ import { AsgardeoAuth } from "@asgardeo/javascript";
 
 // Initialize the auth instance
 const auth = new AsgardeoAuth({
-    signInRedirectURL: "https://localhost:3000",
-    clientID: "<your_client_id>",
+    afterSignInUrl: "https://localhost:3000",
+    clientId: "<your_client_id>",
     baseUrl: "https://api.asgardeo.io/t/<org_name>"
 });
 
@@ -43,7 +43,7 @@ auth.signIn()
     });
 
 // Get authenticated user
-auth.getBasicUserInfo()
+auth.getUser()
     .then((userInfo) => {
         console.log(userInfo);
     });

package/dist/AsgardeoJavaScriptClient.d.ts

@@ -15,9 +15,12 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { AsgardeoClient, SignInOptions, SignOutOptions } from './models/client';
-import { User } from './models/user';
+import { AsgardeoClient, SignInOptions, SignOutOptions, SignUpOptions } from './models/client';
 import { Config } from './models/config';
+import { EmbeddedFlowExecuteRequestPayload, EmbeddedFlowExecuteResponse } from './models/embedded-flow';
+import { EmbeddedSignInFlowHandleRequestPayload } from './models/embedded-signin-flow';
+import { Organization } from './models/organization';
+import { User, UserProfile } from './models/user';
 /**
  * Base class for implementing Asgardeo clients.
  * This class provides the core functionality for managing user authentication and sessions.
@@ -25,57 +28,21 @@ import { Config } from './models/config';
  * @typeParam T - Configuration type that extends Config.
  */
 declare abstract class AsgardeoJavaScriptClient<T = Config> implements AsgardeoClient<T> {
-    /**
-     * Initializes the authentication client with provided configuration.
-     *
-     * @param config - SDK Client instance configuration options.
-     * @returns Promise resolving to boolean indicating success.
-     */
+    abstract switchOrganization(organization: Organization): Promise<void>;
     abstract initialize(config: T): Promise<boolean>;
-    /**
-     * Gets user information from the session.
-     *
-     * @returns User object containing user details.
-     */
     abstract getUser(): Promise<User>;
-    /**
-     * Checks if the client is currently loading.
-     * This can be used to determine if the client is in the process of initializing or fetching user data.
-     *
-     * @returns Boolean indicating if the client is loading.
-     */
+    abstract getOrganizations(): Promise<Organization[]>;
+    abstract getCurrentOrganization(): Promise<Organization | null>;
+    abstract getUserProfile(): Promise<UserProfile>;
     abstract isLoading(): boolean;
-    /**
-     * Checks if a user is signed in.
-     * FIXME: Check if this should return a boolean or a Promise<boolean>.
-     *
-     * @returns Promise resolving to boolean indicating sign-in status.
-     */
     abstract isSignedIn(): Promise<boolean>;
-    /**
-     * Initiates the sign-in process for the user.
-     *
-     * @param options - Optional sign-in options like additional parameters to be sent in the authorize request, etc.
-     * @returns Promise resolving the user upon successful sign in.
-     */
-    abstract signIn(options?: SignInOptions): Promise<User>;
-    /**
-     * Signs out the currently signed-in user.
-     *
-     * @param options - Optional sign-out options like additional parameters to be sent in the sign-out request, etc.
-     * @param afterSignOut - Callback function to be executed after sign-out is complete.
-     * @returns A promise that resolves to true if sign-out is successful
-     */
-    abstract signOut(options?: SignOutOptions, afterSignOut?: (redirectUrl: string) => void): Promise<string>;
-    /**
-     * Signs out the currently signed-in user with an optional session ID.
-     *
-     * @param options - Optional sign-out options like additional parameters to be sent in the sign-out request, etc.
-     * @param sessionId - Optional session ID to be used for sign-out.
-     *                    This can be useful in scenarios where multiple sessions are managed.
-     * @param afterSignOut - Callback function to be executed after sign-out is complete.
-     * @returns A promise that resolves to true if sign-out is successful
-     */
-    abstract signOut(options?: SignOutOptions, sessionId?: string, afterSignOut?: (redirectUrl: string) => void): Promise<string>;
+    abstract getConfiguration(): T;
+    abstract signIn(options?: SignInOptions, sessionId?: string, onSignInSuccess?: (afterSignInUrl: string) => void): Promise<User>;
+    abstract signIn(payload: EmbeddedSignInFlowHandleRequestPayload, request: Request, sessionId?: string, onSignInSuccess?: (afterSignInUrl: string) => void): Promise<User>;
+    abstract signOut(options?: SignOutOptions, afterSignOut?: (afterSignOutUrl: string) => void): Promise<string>;
+    abstract signOut(options?: SignOutOptions, sessionId?: string, afterSignOut?: (afterSignOutUrl: string) => void): Promise<string>;
+    abstract signUp(options?: SignUpOptions): Promise<void>;
+    abstract signUp(payload: EmbeddedFlowExecuteRequestPayload): Promise<EmbeddedFlowExecuteResponse>;
+    abstract signUp(payload?: unknown): Promise<void> | Promise<EmbeddedFlowExecuteResponse>;
 }
 export default AsgardeoJavaScriptClient;

package/dist/IsomorphicCrypto.d.ts

@@ -16,7 +16,7 @@
  * under the License.
  */
 import { Crypto, JWKInterface } from './models/crypto';
-import { IdTokenPayload } from './models/id-token';
+import { IdToken } from './models/token';
 export declare class IsomorphicCrypto<T = any> {
     private _cryptoUtils;
     constructor(cryptoUtils: Crypto<T>);
@@ -50,7 +50,7 @@ export declare class IsomorphicCrypto<T = any> {
      *
      * @param idToken - id_token received from the IdP.
      * @param jwk - public key used for signing.
-     * @param clientID - app identification.
+     * @param clientId - app identification.
      * @param issuer - id_token issuer.
      * @param username - Username.
      * @param clockTolerance - Allowed leeway for id_tokens (in seconds).
@@ -59,7 +59,7 @@ export declare class IsomorphicCrypto<T = any> {
      *
      * @throws
      */
-    isValidIdToken(idToken: string, jwk: JWKInterface, clientID: string, issuer: string, username: string, clockTolerance: number | undefined, validateJwtIssuer: boolean | undefined): Promise<boolean>;
+    isValidIdToken(idToken: string, jwk: JWKInterface, clientId: string, issuer: string, username: string, clockTolerance: number | undefined, validateJwtIssuer: boolean | undefined): Promise<boolean>;
     /**
      * This function decodes the payload of an id token and returns it.
      *
@@ -69,5 +69,5 @@ export declare class IsomorphicCrypto<T = any> {
      *
      * @throws
      */
-    decodeIDToken(idToken: string): IdTokenPayload;
+    decodeIdToken(idToken: string): IdToken;
 }

package/dist/{__legacy__/data/data-layer.d.ts → StorageManager.d.ts}

@@ -15,50 +15,51 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { Stores } from '../../models/store';
-import { Store } from '../../models/store';
-import { AuthClientConfig, SessionData } from '../models';
-import { TemporaryStore, TemporaryStoreValue } from '../../models/store';
-import { OIDCDiscoveryApiResponse } from '../../models/oidc-discovery';
+import { Stores } from './models/store';
+import { Storage } from './models/store';
+import { AuthClientConfig } from './__legacy__/models';
+import { SessionData } from './models/session';
+import { TemporaryStore, TemporaryStoreValue } from './models/store';
+import { OIDCDiscoveryApiResponse } from './models/oidc-discovery';
 type PartialData<T> = Partial<AuthClientConfig<T> | OIDCDiscoveryApiResponse | SessionData | TemporaryStore>;
 export declare const ASGARDEO_SESSION_ACTIVE: string;
-export declare class DataLayer<T> {
+declare class StorageManager<T> {
     protected _id: string;
-    protected _store: Store;
-    constructor(instanceID: string, store: Store);
+    protected _store: Storage;
+    constructor(instanceID: string, store: Storage);
     protected setDataInBulk(key: string, data: PartialData<T>): Promise<void>;
     protected setValue(key: string, attribute: keyof AuthClientConfig<T> | keyof OIDCDiscoveryApiResponse | keyof SessionData | keyof TemporaryStore, value: TemporaryStoreValue): Promise<void>;
     protected removeValue(key: string, attribute: keyof AuthClientConfig<T> | keyof OIDCDiscoveryApiResponse | keyof SessionData | keyof TemporaryStore): Promise<void>;
-    protected _resolveKey(store: Stores | string, userID?: string): string;
+    protected _resolveKey(store: Stores | string, userId?: string): string;
     protected isLocalStorageAvailable(): boolean;
     setConfigData(config: Partial<AuthClientConfig<T>>): Promise<void>;
     setOIDCProviderMetaData(oidcProviderMetaData: Partial<OIDCDiscoveryApiResponse>): Promise<void>;
-    setTemporaryData(temporaryData: Partial<TemporaryStore>, userID?: string): Promise<void>;
-    setSessionData(sessionData: Partial<SessionData>, userID?: string): Promise<void>;
-    setCustomData<K>(key: string, customData: Partial<K>, userID?: string): Promise<void>;
-    getConfigData(): Promise<AuthClientConfig<T>>;
-    getOIDCProviderMetaData(): Promise<OIDCDiscoveryApiResponse>;
-    getTemporaryData(userID?: string): Promise<TemporaryStore>;
-    getSessionData(userID?: string): Promise<SessionData>;
-    getCustomData<K>(key: string, userID?: string): Promise<K>;
+    setTemporaryData(temporaryData: Partial<TemporaryStore>, userId?: string): Promise<void>;
+    setSessionData(sessionData: Partial<SessionData>, userId?: string): Promise<void>;
+    setCustomData<K>(key: string, customData: Partial<K>, userId?: string): Promise<void>;
+    getConfigData(userId?: string): Promise<AuthClientConfig<T>>;
+    loadOpenIDProviderConfiguration(): Promise<OIDCDiscoveryApiResponse>;
+    getTemporaryData(userId?: string): Promise<TemporaryStore>;
+    getSessionData(userId?: string): Promise<SessionData>;
+    getCustomData<K>(key: string, userId?: string): Promise<K>;
     setSessionStatus(status: string): void;
     getSessionStatus(): string;
     removeSessionStatus(): void;
     removeConfigData(): Promise<void>;
     removeOIDCProviderMetaData(): Promise<void>;
-    removeTemporaryData(userID?: string): Promise<void>;
-    removeSessionData(userID?: string): Promise<void>;
+    removeTemporaryData(userId?: string): Promise<void>;
+    removeSessionData(userId?: string): Promise<void>;
     getConfigDataParameter(key: keyof AuthClientConfig<T>): Promise<TemporaryStoreValue>;
     getOIDCProviderMetaDataParameter(key: keyof OIDCDiscoveryApiResponse): Promise<TemporaryStoreValue>;
-    getTemporaryDataParameter(key: keyof TemporaryStore, userID?: string): Promise<TemporaryStoreValue>;
-    getSessionDataParameter(key: keyof SessionData, userID?: string): Promise<TemporaryStoreValue>;
+    getTemporaryDataParameter(key: keyof TemporaryStore, userId?: string): Promise<TemporaryStoreValue>;
+    getSessionDataParameter(key: keyof SessionData, userId?: string): Promise<TemporaryStoreValue>;
     setConfigDataParameter(key: keyof AuthClientConfig<T>, value: TemporaryStoreValue): Promise<void>;
     setOIDCProviderMetaDataParameter(key: keyof OIDCDiscoveryApiResponse, value: TemporaryStoreValue): Promise<void>;
-    setTemporaryDataParameter(key: keyof TemporaryStore, value: TemporaryStoreValue, userID?: string): Promise<void>;
-    setSessionDataParameter(key: keyof SessionData, value: TemporaryStoreValue, userID?: string): Promise<void>;
+    setTemporaryDataParameter(key: keyof TemporaryStore, value: TemporaryStoreValue, userId?: string): Promise<void>;
+    setSessionDataParameter(key: keyof SessionData, value: TemporaryStoreValue, userId?: string): Promise<void>;
     removeConfigDataParameter(key: keyof AuthClientConfig<T>): Promise<void>;
     removeOIDCProviderMetaDataParameter(key: keyof OIDCDiscoveryApiResponse): Promise<void>;
-    removeTemporaryDataParameter(key: keyof TemporaryStore, userID?: string): Promise<void>;
-    removeSessionDataParameter(key: keyof SessionData, userID?: string): Promise<void>;
+    removeTemporaryDataParameter(key: keyof TemporaryStore, userId?: string): Promise<void>;
+    removeSessionDataParameter(key: keyof SessionData, userId?: string): Promise<void>;
 }
-export {};
+export default StorageManager;