@asgardeo/javascript 0.7.0 → 0.7.2

package/dist/models/oidc-discovery.d.ts

@@ -46,39 +46,50 @@
  */
 export interface OIDCDiscoveryApiResponse extends OIDCDiscoveryEndpointsApiResponse {
     /**
-     * Supported OAuth 2.0 scope values.
-     * Lists the permission scopes this server can handle.
-     *
-     * @remarks
-     * Common values include:
-     * - 'openid' - Required for OIDC flows
-     * - 'profile' - Basic user information
-     * - 'email' - User's email address
-     * - 'address' - User's postal address
-     * - 'phone' - User's phone number
+     * Supported Authentication Context Class References.
+     * Indicates the OP's ability to satisfy specific authentication requirements.
      */
-    scopes_supported?: string[];
+    acr_values_supported?: string[];
     /**
-     * Supported OAuth 2.0 response_type values.
-     *
-     * @remarks
-     * Common values include:
-     * - 'code' - Authorization Code flow
-     * - 'token' - Implicit flow
-     * - 'id_token' - OIDC implicit flow
-     * - 'code token' - Hybrid flow
+     * Boolean value specifying whether the OP can pass a sid (session ID) Claim in the Logout Token to
+     * identify the RP session with the OP.
      */
-    response_types_supported?: string[];
+    backchannel_logout_session_supported?: boolean;
     /**
-     * Supported OAuth 2.0 response_mode values.
-     *
-     * @remarks
-     * Determines how the authorization response is returned:
-     * - 'query' - Parameters in URL query string
-     * - 'fragment' - Parameters in URL fragment
-     * - 'form_post' - Parameters via POST
+     * Boolean value specifying whether the OP supports back-channel logout, with true indicating support.
+     * If omitted, the default value is false.
      */
-    response_modes_supported?: string[];
+    backchannel_logout_supported?: boolean;
+    /**
+     * JSON array containing a list of the Claim Types that the OpenID Provider supports.
+     */
+    claim_types_supported?: string[];
+    /**
+     * Languages and scripts supported for values in Claims being returned, represented as a JSON array
+     * of BCP47 [RFC5646] language tag values. Not all languages and scripts are necessarily
+     * supported for all Claim values.
+     */
+    claims_locales_supported?: string[];
+    /**
+     *  Boolean value specifying whether the OP supports use of the claims parameter,
+     * with true indicating support. If omitted, the default value is false.
+     */
+    claims_parameter_supported?: boolean;
+    /**
+     * JSON array containing a list of the Claim Names of the Claims that
+     * the OpenID Provider MAY be able to supply values for.
+     */
+    claims_supported?: string[];
+    /**
+     * JSON array containing a list of Proof Key for Code
+     * Exchange (PKCE) [RFC7636] code challenge methods supported by this
+     * authorization server.
+     */
+    code_challenge_methods_supported?: string[];
+    /**
+     * JSON array containing a list of the display parameter values that the OpenID Provider supports.
+     */
+    display_values_supported?: string[];
     /**
      * Supported OAuth 2.0 grant type values.
      *
@@ -90,26 +101,6 @@ export interface OIDCDiscoveryApiResponse extends OIDCDiscoveryEndpointsApiRespo
      * - 'client_credentials' - Client credentials grant
      */
     grant_types_supported?: string[];
-    /**
-     * Supported Authentication Context Class References.
-     * Indicates the OP's ability to satisfy specific authentication requirements.
-     */
-    acr_values_supported?: string[];
-    /**
-     * Supported Subject Identifier types.
-     * Defines how the OP identifies users across sessions.
-     *
-     * @remarks
-     * Common values:
-     * - 'public' - Same sub value for all clients
-     * - 'pairwise' - Different sub values for different clients
-     */
-    subject_types_supported?: string[];
-    /**
-     * JSON array containing a list of the JWS signing algorithms (alg values)
-     * supported by the OP for the ID Token to encode the Claims in a JWT [JWT].
-     */
-    id_token_signing_alg_values_supported?: string[];
     /**
      * JSON array containing a list of the JWE encryption algorithms (alg values)
      * supported by the OP for the ID Token to encode the Claims in a JWT [JWT].
@@ -121,24 +112,33 @@ export interface OIDCDiscoveryApiResponse extends OIDCDiscoveryEndpointsApiRespo
      */
     id_token_encryption_enc_values_supported?: string[];
     /**
-     * JSON array containing a list of the JWS [JWS] signing algorithms (alg values) [JWA]
-     * supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT].
+     * JSON array containing a list of the JWS signing algorithms (alg values)
+     * supported by the OP for the ID Token to encode the Claims in a JWT [JWT].
      */
-    userinfo_signing_alg_values_supported?: string[];
+    id_token_signing_alg_values_supported?: string[];
     /**
-     * JSON array containing a list of the JWE [JWE] encryption algorithms (alg values)
-     * [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT].
+     * JSON array containing a list of client authentication
+     * methods supported by this introspection endpoint.
      */
-    userinfo_encryption_alg_values_supported?: string[];
+    introspection_endpoint_auth_methods_supported?: string[];
     /**
-     * JSON array containing a list of the JWE encryption algorithms (enc values) [JWA]
-     * supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT]
+     * JSON array containing a list of the JWS signing
+     * algorithms ("alg" values) supported by the introspection endpoint
+     * for the signature on the JWT [JWT] used to authenticate the client
+     * at the introspection endpoint for the "private_key_jwt" and
+     * "client_secret_jwt" authentication methods.
      */
-    userinfo_encryption_enc_values_supported?: string[];
+    introspection_endpoint_auth_signing_alg_values_supported?: string[];
     /**
-     * JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for Request Objects
+     * URL that the OpenID Provider provides to the person registering the Client
+     * to read about the OP's requirements on how the Relying Party can use the data provided by the OP.
      */
-    request_object_signing_alg_values_supported?: string[];
+    op_policy_uri?: string;
+    /**
+     * URL that the OpenID Provider provides to the person registering the Client
+     * to read about OpenID Provider's terms of service.
+     */
+    op_tos_uri?: string;
     /**
      * JSON array containing a list of the JWE encryption algorithms (alg values)
      * supported by the OP for Request Objects.
@@ -150,49 +150,9 @@ export interface OIDCDiscoveryApiResponse extends OIDCDiscoveryEndpointsApiRespo
      */
     request_object_encryption_enc_values_supported?: string[];
     /**
-     * JSON array containing a list of Client Authentication methods supported by this Token Endpoint.
-     */
-    token_endpoint_auth_methods_supported?: string[];
-    /**
-     * JSON array containing a list of the JWS signing algorithms (alg values) supported by the Token Endpoint
-     * for the signature on the JWT [JWT] used to authenticate the Client at the Token Endpoint for the
-     * private_key_jwt and client_secret_jwt authentication methods.
-     */
-    token_endpoint_auth_signing_alg_values_supported?: string[];
-    /**
-     * JSON array containing a list of the display parameter values that the OpenID Provider supports.
-     */
-    display_values_supported?: string[];
-    /**
-     * JSON array containing a list of the Claim Types that the OpenID Provider supports.
-     */
-    claim_types_supported?: string[];
-    /**
-     * JSON array containing a list of the Claim Names of the Claims that
-     * the OpenID Provider MAY be able to supply values for.
-     */
-    claims_supported?: string[];
-    /**
-     * URL of a page containing human-readable information that developers
-     * might want or need to know when using the OpenID Provider.
-     */
-    service_documentation?: string;
-    /**
-     * Languages and scripts supported for values in Claims being returned, represented as a JSON array
-     * of BCP47 [RFC5646] language tag values. Not all languages and scripts are necessarily
-     * supported for all Claim values.
-     */
-    claims_locales_supported?: string[];
-    /**
-     * Languages and scripts supported for the user interface,
-     * represented as a JSON array of BCP47 [RFC5646] language tag values.
-     */
-    ui_locales_supported?: string[];
-    /**
-     *  Boolean value specifying whether the OP supports use of the claims parameter,
-     * with true indicating support. If omitted, the default value is false.
+     * JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for Request Objects
      */
-    claims_parameter_supported?: boolean;
+    request_object_signing_alg_values_supported?: string[];
     /**
      * Boolean value specifying whether the OP supports use of the request parameter,
      * with true indicating support. If omitted, the default value is false.
@@ -209,15 +169,26 @@ export interface OIDCDiscoveryApiResponse extends OIDCDiscoveryEndpointsApiRespo
      */
     require_request_uri_registration?: boolean;
     /**
-     * URL that the OpenID Provider provides to the person registering the Client
-     * to read about the OP's requirements on how the Relying Party can use the data provided by the OP.
+     * Supported OAuth 2.0 response_mode values.
+     *
+     * @remarks
+     * Determines how the authorization response is returned:
+     * - 'query' - Parameters in URL query string
+     * - 'fragment' - Parameters in URL fragment
+     * - 'form_post' - Parameters via POST
      */
-    op_policy_uri?: string;
+    response_modes_supported?: string[];
     /**
-     * URL that the OpenID Provider provides to the person registering the Client
-     * to read about OpenID Provider's terms of service.
+     * Supported OAuth 2.0 response_type values.
+     *
+     * @remarks
+     * Common values include:
+     * - 'code' - Authorization Code flow
+     * - 'token' - Implicit flow
+     * - 'id_token' - OIDC implicit flow
+     * - 'code token' - Hybrid flow
      */
-    op_tos_uri?: string;
+    response_types_supported?: string[];
     /**
      * JSON array containing a list of client authentication
      * methods supported by this revocation endpoint.
@@ -232,34 +203,63 @@ export interface OIDCDiscoveryApiResponse extends OIDCDiscoveryEndpointsApiRespo
      */
     revocation_endpoint_auth_signing_alg_values_supported?: string[];
     /**
-     * JSON array containing a list of client authentication
-     * methods supported by this introspection endpoint.
+     * Supported OAuth 2.0 scope values.
+     * Lists the permission scopes this server can handle.
+     *
+     * @remarks
+     * Common values include:
+     * - 'openid' - Required for OIDC flows
+     * - 'profile' - Basic user information
+     * - 'email' - User's email address
+     * - 'address' - User's postal address
+     * - 'phone' - User's phone number
      */
-    introspection_endpoint_auth_methods_supported?: string[];
+    scopes_supported?: string[];
     /**
-     * JSON array containing a list of the JWS signing
-     * algorithms ("alg" values) supported by the introspection endpoint
-     * for the signature on the JWT [JWT] used to authenticate the client
-     * at the introspection endpoint for the "private_key_jwt" and
-     * "client_secret_jwt" authentication methods.
+     * URL of a page containing human-readable information that developers
+     * might want or need to know when using the OpenID Provider.
      */
-    introspection_endpoint_auth_signing_alg_values_supported?: string[];
+    service_documentation?: string;
     /**
-     * JSON array containing a list of Proof Key for Code
-     * Exchange (PKCE) [RFC7636] code challenge methods supported by this
-     * authorization server.
+     * Supported Subject Identifier types.
+     * Defines how the OP identifies users across sessions.
+     *
+     * @remarks
+     * Common values:
+     * - 'public' - Same sub value for all clients
+     * - 'pairwise' - Different sub values for different clients
      */
-    code_challenge_methods_supported?: string[];
+    subject_types_supported?: string[];
     /**
-     * Boolean value specifying whether the OP supports back-channel logout, with true indicating support.
-     * If omitted, the default value is false.
+     * JSON array containing a list of Client Authentication methods supported by this Token Endpoint.
      */
-    backchannel_logout_supported?: boolean;
+    token_endpoint_auth_methods_supported?: string[];
     /**
-     * Boolean value specifying whether the OP can pass a sid (session ID) Claim in the Logout Token to
-     * identify the RP session with the OP.
+     * JSON array containing a list of the JWS signing algorithms (alg values) supported by the Token Endpoint
+     * for the signature on the JWT [JWT] used to authenticate the Client at the Token Endpoint for the
+     * private_key_jwt and client_secret_jwt authentication methods.
      */
-    backchannel_logout_session_supported?: boolean;
+    token_endpoint_auth_signing_alg_values_supported?: string[];
+    /**
+     * Languages and scripts supported for the user interface,
+     * represented as a JSON array of BCP47 [RFC5646] language tag values.
+     */
+    ui_locales_supported?: string[];
+    /**
+     * JSON array containing a list of the JWE [JWE] encryption algorithms (alg values)
+     * [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT].
+     */
+    userinfo_encryption_alg_values_supported?: string[];
+    /**
+     * JSON array containing a list of the JWE encryption algorithms (enc values) [JWA]
+     * supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT]
+     */
+    userinfo_encryption_enc_values_supported?: string[];
+    /**
+     * JSON array containing a list of the JWS [JWS] signing algorithms (alg values) [JWA]
+     * supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT].
+     */
+    userinfo_signing_alg_values_supported?: string[];
 }
 /**
  * Essential OpenID Connect (OIDC) Provider endpoints configuration.
@@ -290,15 +290,6 @@ export interface OIDCDiscoveryApiResponse extends OIDCDiscoveryEndpointsApiRespo
  * ```
  */
 export interface OIDCDiscoveryEndpointsApiResponse {
-    /**
-     * HTTPS URL that the OP asserts as its Issuer Identifier.
-     * Must not contain query or fragment components.
-     *
-     * @remarks
-     * This is a crucial identifier for the OpenID Provider and should
-     * match the iss claim in issued JWT tokens.
-     */
-    issuer?: string;
     /**
      * OAuth 2.0 Authorization Endpoint URL.
      * Used to initiate the authentication and authorization process.
@@ -309,23 +300,29 @@ export interface OIDCDiscoveryEndpointsApiResponse {
      */
     authorization_endpoint?: string;
     /**
-     * OAuth 2.0 Token Endpoint URL.
-     * Used to obtain tokens using various grant types.
-     *
-     * @remarks
-     * Clients use this endpoint to exchange authorization codes for tokens
-     * and to refresh expired access tokens.
+     * URL of an OP iframe that supports cross-origin communications for session state information with the RP
+     * Client, using the HTML5 postMessage API.
      */
-    token_endpoint?: string;
+    check_session_iframe?: string;
     /**
-     * UserInfo Endpoint URL.
-     * Returns claims about the authenticated end-user.
+     * URL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the
+     * OP.
+     */
+    end_session_endpoint?: string;
+    /**
+     * URL of the authorization server's OAuth 2.0
+     * introspection endpoint.
+     */
+    introspection_endpoint?: string;
+    /**
+     * HTTPS URL that the OP asserts as its Issuer Identifier.
+     * Must not contain query or fragment components.
      *
      * @remarks
-     * Requires a valid access token with appropriate scope.
-     * May return claims in JWT format if signing/encryption is configured.
+     * This is a crucial identifier for the OpenID Provider and should
+     * match the iss claim in issued JWT tokens.
      */
-    userinfo_endpoint?: string;
+    issuer?: string;
     /**
      * JSON Web Key Set (JWKS) document URL.
      * Contains the cryptographic keys used to secure communications.
@@ -347,23 +344,26 @@ export interface OIDCDiscoveryEndpointsApiResponse {
      */
     registration_endpoint?: string;
     /**
-     * URL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the
-     * OP.
-     */
-    end_session_endpoint?: string;
-    /**
-     * URL of an OP iframe that supports cross-origin communications for session state information with the RP
-     * Client, using the HTML5 postMessage API.
+     * URL of the authorization server's OAuth 2.0 revocation
+     * endpoint.
      */
-    check_session_iframe?: string;
+    revocation_endpoint?: string;
     /**
-     * URL of the authorization server's OAuth 2.0
-     * introspection endpoint.
+     * OAuth 2.0 Token Endpoint URL.
+     * Used to obtain tokens using various grant types.
+     *
+     * @remarks
+     * Clients use this endpoint to exchange authorization codes for tokens
+     * and to refresh expired access tokens.
      */
-    introspection_endpoint?: string;
+    token_endpoint?: string;
     /**
-     * URL of the authorization server's OAuth 2.0 revocation
-     * endpoint.
+     * UserInfo Endpoint URL.
+     * Returns claims about the authenticated end-user.
+     *
+     * @remarks
+     * Requires a valid access token with appropriate scope.
+     * May return claims in JWT format if signing/encryption is configured.
      */
-    revocation_endpoint?: string;
+    userinfo_endpoint?: string;
 }

package/dist/models/oidc-endpoints.d.ts

@@ -21,14 +21,14 @@
  */
 export interface LegacyOIDCEndpoints {
     authorizationEndpoint: string;
-    tokenEndpoint: string;
-    userinfoEndpoint: string;
+    checkSessionIframe: string;
+    endSessionEndpoint: string;
+    introspectionEndpoint?: string;
     jwksUri: string;
     registrationEndpoint?: string;
     revocationEndpoint: string;
-    introspectionEndpoint?: string;
-    checkSessionIframe: string;
-    endSessionEndpoint: string;
+    tokenEndpoint: string;
+    userinfoEndpoint: string;
 }
 /**
  * Interface representing OpenID Connect endpoints configuration.
@@ -36,25 +36,25 @@ export interface LegacyOIDCEndpoints {
  */
 export interface OIDCEndpoints extends Partial<LegacyOIDCEndpoints> {
     /**
-     * The issuer identifier URL for the OpenID Provider
+     * The authorization endpoint URL where the authentication request is sent
      */
-    issuer: string;
+    authorization: string;
     /**
      * The OpenID Provider's discovery endpoint URL
      */
     discovery: string;
     /**
-     * The authorization endpoint URL where the authentication request is sent
-     */
-    authorization: string;
-    /**
-     * The userinfo endpoint URL that returns claims about the authenticated user
+     * The end session endpoint URL used to terminate the user's session
      */
-    userinfo: string;
+    endSession: string;
     /**
      * The introspection endpoint URL used to validate tokens
      */
     introspection: string;
+    /**
+     * The issuer identifier URL for the OpenID Provider
+     */
+    issuer: string;
     /**
      * The JSON Web Key Set endpoint URL that provides the public keys to verify tokens
      */
@@ -64,7 +64,7 @@ export interface OIDCEndpoints extends Partial<LegacyOIDCEndpoints> {
      */
     revocation: string;
     /**
-     * The end session endpoint URL used to terminate the user's session
+     * The userinfo endpoint URL that returns claims about the authenticated user
      */
-    endSession: string;
+    userinfo: string;
 }

package/dist/models/platforms.d.ts

@@ -28,10 +28,10 @@
 export declare enum Platform {
     /** Asgardeo cloud identity platform (asgardeo.io domains) */
     Asgardeo = "ASGARDEO",
-    /** WSO2 Identity Server (on-prem or custom domains) */
-    IdentityServer = "IDENTITY_SERVER",
     /** @experimental WSO2 Asgardeo V2 */
     AsgardeoV2 = "AsgardeoV2",
+    /** WSO2 Identity Server (on-prem or custom domains) */
+    IdentityServer = "IDENTITY_SERVER",
     /** Unknown or unsupported platform */
     Unknown = "UNKNOWN"
 }

package/dist/models/scim2-schema.d.ts

@@ -16,34 +16,34 @@
  * under the License.
  */
 export interface SchemaAttribute {
-    name: string;
-    type: string;
-    multiValued: boolean;
-    description?: string;
-    required?: boolean;
     caseExact: boolean;
-    mutability: string;
-    returned: string;
-    uniqueness: string;
+    description?: string;
     displayName?: string;
     displayOrder?: string;
+    multiValued: boolean;
+    mutability: string;
+    name: string;
     regEx?: string;
-    supportedByDefault?: string;
+    required?: boolean;
+    returned: string;
     sharedProfileValueResolvingMethod?: string;
     subAttributes?: SchemaAttribute[];
+    supportedByDefault?: string;
+    type: string;
+    uniqueness: string;
 }
 /**
  * Represents a SCIM2 schema definition
  */
 export interface Schema {
+    /** Schema attributes */
+    attributes: SchemaAttribute[];
+    /** Schema description */
+    description: string;
     /** Schema identifier */
     id: string;
     /** Schema name */
     name: string;
-    /** Schema description */
-    description: string;
-    /** Schema attributes */
-    attributes: SchemaAttribute[];
 }
 export interface FlattenedSchema extends Schema {
     schemaId: string;
@@ -54,12 +54,12 @@ export interface FlattenedSchema extends Schema {
 export declare enum WellKnownSchemaIds {
     /** Core Schema */
     Core = "urn:ietf:params:scim:schemas:core:2.0",
-    /** User Schema */
-    User = "urn:ietf:params:scim:schemas:core:2.0:User",
+    /** Custom User Schema */
+    CustomUser = "urn:scim:schemas:extension:custom:User",
     /** Enterprise User Schema */
     EnterpriseUser = "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
     /** System User Schema */
     SystemUser = "urn:scim:wso2:schema",
-    /** Custom User Schema */
-    CustomUser = "urn:scim:schemas:extension:custom:User"
+    /** User Schema */
+    User = "urn:ietf:params:scim:schemas:core:2.0:User"
 }

package/dist/models/session.d.ts

@@ -17,13 +17,13 @@
  */
 export interface SessionData {
     access_token: string;
-    id_token: string;
+    created_at: number;
     expires_in: string;
-    scope: string;
+    id_token: string;
     refresh_token?: string;
-    token_type: string;
+    scope: string;
     session_state: string;
-    created_at: number;
+    token_type: string;
 }
 export interface UserSession {
     scopes: string[];

package/dist/models/store.d.ts

@@ -22,15 +22,6 @@ import { OIDCEndpoints } from './oidc-endpoints';
  * memory cache, or distributed caches like Redis or Memcached.
  */
 export interface Storage {
-    /**
-     * Stores a value with the specified key.
-     *
-     * @param key - The unique identifier for the stored value
-     * @param value - The string value to store
-     * @returns A promise that resolves when the value is successfully stored
-     * @throws Error if storage operation fails
-     */
-    setData(key: string, value: string): Promise<void>;
     /**
      * Retrieves a value by its key.
      *
@@ -47,6 +38,15 @@ export interface Storage {
      * @throws Error if removal fails or the key doesn't exist
      */
     removeData(key: string): Promise<void>;
+    /**
+     * Stores a value with the specified key.
+     *
+     * @param key - The unique identifier for the stored value
+     * @param value - The string value to store
+     * @returns A promise that resolves when the value is successfully stored
+     * @throws Error if storage operation fails
+     */
+    setData(key: string, value: string): Promise<void>;
 }
 /**
  * Represents the possible value types that can be stored in the temporary data storage.

package/dist/models/user.d.ts

@@ -17,17 +17,17 @@
  */
 import { Schema } from './scim2-schema';
 export interface KnownUser {
-    username?: string;
+    displayName?: string;
     email?: string;
-    givenName?: string;
     familyName?: string;
-    displayName?: string;
+    givenName?: string;
+    username?: string;
 }
 export interface User extends KnownUser {
     [key: string]: any;
 }
 export interface UserProfile {
-    schemas: Schema[];
-    profile: User;
     flattenedProfile: User;
+    profile: User;
+    schemas: Schema[];
 }