@asgardeo/javascript 0.1.10 → 0.1.12

package/dist/models/client.d.ts

@@ -22,9 +22,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.
  *

package/dist/models/config.d.ts

@@ -18,6 +18,36 @@
 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.
@@ -122,6 +152,32 @@ 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;
+    /**
+     * Flag to indicate whether the Application session should be synchronized with the IdP session.
+     * @remarks This uses the OIDC iframe base session management feature to keep the application session in sync with the IdP session.
+     * WARNING: This may not work in all browsers due to 3rd party cookie restrictions.
+     * It is recommended to use this feature only if you are aware of the implications and have tested it in your target browsers.
+     * If you are not sure, it is safer to leave this option as `false`.
+     * @example
+     * syncSession: true
+     * @see {@link https://openid.net/specs/openid-connect-session-management-1_0.html#IframeBasedSessionManagement}
+     */
+    syncSession?: boolean;
 }
 export interface WithPreferences {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asgardeo/javascript",
-  "version": "0.1.10",
+  "version": "0.1.12",
   "description": "Framework agnostic JavaScript SDK for Asgardeo.",
   "keywords": [
     "asgardeo",
@@ -9,9 +9,9 @@
     "agnostic",
     "js"
   ],
-  "homepage": "https://github.com/asgardeo/web-ui-sdks/tree/main/packages/javascript#readme",
+  "homepage": "https://github.com/asgardeo/javascript/tree/main/packages/javascript#readme",
   "bugs": {
-    "url": "https://github.com/asgardeo/web-ui-sdks/issues"
+    "url": "https://github.com/asgardeo/javascript/issues"
   },
   "author": "WSO2",
   "license": "Apache-2.0",
@@ -30,7 +30,7 @@
   "types": "dist/index.d.ts",
   "repository": {
     "type": "git",
-    "url": "https://github.com/asgardeo/web-ui-sdks",
+    "url": "https://github.com/asgardeo/javascript",
     "directory": "packages/javascript"
   },
   "devDependencies": {