feat(javascript): refactor sign-in, sign-out, and sign-up options to improve organization and documentation

Author: brionmario

packages/javascript/src/index.ts

@@ -75,8 +75,18 @@ export {
   EmbeddedFlowExecuteRequestConfig,
 } from './models/embedded-flow';
 export {FlowMode} from './models/flow';
-export {AsgardeoClient, SignInOptions, SignOutOptions, SignUpOptions} from './models/client';
-export {BaseConfig, Config, Preferences, ThemePreferences, I18nPreferences, WithPreferences} from './models/config';
+export {AsgardeoClient} from './models/client';
+export {
+  BaseConfig,
+  Config,
+  Preferences,
+  ThemePreferences,
+  I18nPreferences,
+  WithPreferences,
+  SignInOptions,
+  SignOutOptions,
+  SignUpOptions,
+} from './models/config';
 export {TokenResponse, IdToken, TokenExchangeRequestConfig} from './models/token';
 export {Crypto, JWKInterface} from './models/crypto';
 export {OAuthResponseMode} from './models/oauth-response';

packages/javascript/src/models/client.ts

@@ -27,10 +27,7 @@ import {Organization} from './organization';
 import {User, UserProfile} from './user';
 import {TokenResponse} from './token';
 import {Storage} from './store';
-
-export type SignInOptions = Record<string, unknown>;
-export type SignOutOptions = Record<string, unknown>;
-export type SignUpOptions = Record<string, unknown>;
+import {SignInOptions, SignOutOptions, SignUpOptions} from './config';
 
 /**
  * Interface defining the core functionality for Asgardeo authentication clients.

packages/javascript/src/models/config.ts

@@ -20,6 +20,39 @@ import {I18nBundle} from './i18n';
 import {RecursivePartial} from './utility-types';
 import {ThemeConfig, ThemeMode} from '../theme/types';
 
+/**
+ * Interface representing the additional parameters to be sent in the sign-in request.
+ * This can include custom parameters that your authorization server supports.
+ * These parameters will be included in the authorization request sent to the server.
+ * If not provided, no additional parameters will be sent.
+ *
+ * @example
+ * signInOptions: { prompt: "login", fidp: "OrganizationSSO" }
+ */
+export type SignInOptions = Record<string, any>;
+
+/**
+ * Interface representing the additional parameters to be sent in the sign-out request.
+ * This can include custom parameters that your authorization server supports.
+ * These parameters will be included in the sign-out request sent to the server.
+ * If not provided, no additional parameters will be sent.
+ *
+ * @example
+ * signOutOptions: { idTokenHint: "your-id-token-hint" }
+ */
+export type SignOutOptions = Record<string, unknown>;
+
+/**
+ * Interface representing the additional parameters to be sent in the sign-up request.
+ * This can include custom parameters that your authorization server supports.
+ * These parameters will be included in the sign-up request sent to the server.
+ * If not provided, no additional parameters will be sent.
+ *
+ * @example
+ * signUpOptions: { appId: "your-app-id" }
+ */
+export type SignUpOptions = Record<string, unknown>;
+
 export interface BaseConfig<T = unknown> extends WithPreferences {
   /**
    * Optional URL where the authorization server should redirect after authentication.
@@ -134,6 +167,24 @@ export interface BaseConfig<T = unknown> extends WithPreferences {
       clockTolerance?: number;
     };
   };
+
+  /**
+   * Optional additional parameters to be sent in the authorize request.
+   * @see {@link SignInOptions} for more details.
+   */
+  signInOptions?: SignInOptions;
+
+  /**
+   * Optional additional parameters to be sent in the sign-out request.
+   * @see {@link SignOutOptions} for more details.
+   */
+  signOutOptions?: SignOutOptions;
+
+  /**
+   * Optional additional parameters to be sent in the sign-up request.
+   * @see {@link SignUpOptions} for more details.
+   */
+  signUpOptions?: SignUpOptions;
 }
 
 export interface WithPreferences {