@asgardeo/javascript 0.0.1

package/dist/__legacy__/helpers/authentication-helper.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Copyright (c) 2020, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
+ *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { IsomorphicCrypto } from '../../IsomorphicCrypto';
+import { DataLayer } from '../data';
+import { AuthenticatedUserInfo } from '../models';
+import { TokenResponse } from '../../models/token';
+import { OIDCDiscoveryEndpointsApiResponse, OIDCDiscoveryApiResponse } from '../../models/oidc-discovery';
+export declare class AuthenticationHelper<T> {
+    private _dataLayer;
+    private _config;
+    private _oidcProviderMetaData;
+    private _cryptoHelper;
+    constructor(dataLayer: DataLayer<T>, cryptoHelper: IsomorphicCrypto);
+    resolveEndpoints(response: OIDCDiscoveryApiResponse): Promise<OIDCDiscoveryApiResponse>;
+    resolveEndpointsExplicitly(): Promise<OIDCDiscoveryEndpointsApiResponse>;
+    resolveEndpointsByBaseURL(): Promise<OIDCDiscoveryEndpointsApiResponse>;
+    validateIdToken(idToken: string): Promise<boolean>;
+    getAuthenticatedUserInfo(idToken: string): AuthenticatedUserInfo;
+    replaceCustomGrantTemplateTags(text: string, userID?: string): Promise<string>;
+    clearUserSessionData(userID?: string): Promise<void>;
+    handleTokenResponse(response: Response, userID?: string): Promise<TokenResponse>;
+}

package/dist/__legacy__/helpers/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) 2020, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
+ *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+export * from './authentication-helper';

package/dist/__legacy__/models/authorization-url.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) 2020, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
+ *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+export type AuthorizationURLParams = Omit<GetAuthURLConfig, "forceInit">;
+export interface StrictGetAuthURLConfig {
+    fidp?: string;
+    forceInit?: boolean;
+}
+export type GetAuthURLConfig = StrictGetAuthURLConfig & Record<string, string | boolean>;

package/dist/__legacy__/models/client-config.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Copyright (c) 2020, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
+ *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { ResponseMode } from '../../models/oauth-response';
+import { OIDCEndpoints } from '../../models/oidc-endpoints';
+export interface DefaultAuthClientConfig {
+    signInRedirectURL: string;
+    signOutRedirectURL?: string;
+    clientHost?: string;
+    clientID: string;
+    clientSecret?: string;
+    enablePKCE?: boolean;
+    prompt?: string;
+    responseMode?: ResponseMode;
+    scope?: string[];
+    validateIDToken?: boolean;
+    validateIDTokenIssuer?: boolean;
+    /**
+     * Allowed leeway for id_tokens (in seconds).
+     */
+    clockTolerance?: number;
+    /**
+     * Specifies if cookies should be sent with access-token requests, refresh-token requests,
+     * custom-grant requests, etc.
+     *
+     */
+    sendCookiesInRequests?: boolean;
+    sendIdTokenInLogoutRequest?: boolean;
+}
+export interface WellKnownAuthClientConfig extends DefaultAuthClientConfig {
+    wellKnownEndpoint: string;
+    endpoints?: Partial<OIDCEndpoints>;
+    baseUrl?: string;
+}
+export interface BaseURLAuthClientConfig extends DefaultAuthClientConfig {
+    baseUrl: string;
+    endpoints?: Partial<OIDCEndpoints>;
+    wellKnownEndpoint?: string;
+}
+export interface ExplicitAuthClientConfig extends DefaultAuthClientConfig {
+    endpoints: OIDCEndpoints;
+    baseUrl?: string;
+    wellKnownEndpoint?: string;
+}
+export type StrictAuthClientConfig = WellKnownAuthClientConfig | BaseURLAuthClientConfig | ExplicitAuthClientConfig;
+export type AuthClientConfig<T = unknown> = StrictAuthClientConfig & T;

package/dist/__legacy__/models/custom-grant.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Copyright (c) 2020, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
+ *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+export interface CustomGrantConfig {
+    id: string;
+    data: any;
+    signInRequired: boolean;
+    attachToken: boolean;
+    returnsSession: boolean;
+    tokenEndpoint?: string;
+    shouldReplayAfterRefresh?: boolean;
+}

package/dist/__legacy__/models/data.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Copyright (c) 2020, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
+ *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+export interface SessionData {
+    access_token: string;
+    id_token: string;
+    expires_in: string;
+    scope: string;
+    refresh_token?: string;
+    token_type: string;
+    session_state: string;
+    created_at: number;
+}

package/dist/__legacy__/models/fetch.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Copyright (c) 2020, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
+ *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+export type Method = "get" | "GET" | "delete" | "DELETE" | "head" | "HEAD" | "options" | "OPTIONS" | "post" | "POST" | "put" | "PUT" | "patch" | "PATCH" | "purge" | "PURGE" | "link" | "LINK" | "unlink" | "UNLINK";
+export type FetchCredentials = "omit" | "same-origin" | "include";
+export type FetchRedirect = "follow" | "error" | "manual";
+export interface FetchRequestConfig extends RequestInit {
+    method?: Method;
+    url?: string;
+    credentials?: FetchCredentials;
+    body?: any;
+    bodyUsed?: boolean;
+    cache?: any;
+    destination?: string;
+    integrity?: string;
+    mode?: any;
+    redirect?: FetchRedirect;
+    referrer?: string;
+    referrerPolicy?: any;
+}
+export interface FetchResponse<T = any> extends ResponseInit {
+    body: T;
+    ok: boolean;
+    bodyUsed?: boolean;
+    redirected?: boolean;
+    type: any;
+    url: string;
+    json(): any;
+    text(): any;
+    formData(): any;
+    blob(): any;
+    arrayBuffer(): any;
+}
+export interface FetchError<T = any> extends Error {
+    config: FetchRequestConfig;
+    code?: string;
+    request?: any;
+    response?: FetchResponse<T>;
+    isFetchError: boolean;
+    toJSON: () => object;
+}

package/dist/__legacy__/models/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) 2020, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
+ *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+export * from './client-config';
+export * from './data';
+export * from './custom-grant';
+export * from './authorization-url';
+export * from './user';
+export * from './fetch';

package/dist/__legacy__/models/user.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Copyright (c) 2020, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
+ *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+/**
+ * Interface containing the basic user information.
+ */
+export interface BasicUserInfo {
+    /**
+     * The email address of the user.
+     */
+    email?: string | undefined;
+    /**
+     * 	The username of the user.
+     */
+    username?: string | undefined;
+    /**
+     * The display name of the user. It is the preferred_username in the id token payload or the `sub`.
+     */
+    displayName?: string | undefined;
+    /**
+     * The scopes allowed for the user.
+     */
+    allowedScopes: string;
+    /**
+     * The tenant domain to which the user belongs.
+     */
+    tenantDomain?: string | undefined;
+    /**
+     * The session state.
+     */
+    sessionState: string;
+    /**
+     * The `uid` corresponding to the user who the ID token belongs to.
+     */
+    sub?: string;
+    /**
+     * Any other attributes retrieved from teh `id_token`.
+     */
+    [key: string]: any;
+}
+/**
+ * Interface of the authenticated user.
+ */
+export interface AuthenticatedUserInfo {
+    /**
+     * Authenticated user's display name.
+     */
+    displayName?: string | undefined;
+    /**
+     * Authenticated user's display name.
+     * @deprecated Use `displayName` instead.
+     */
+    display_name?: string | undefined;
+    /**
+     * User's email.
+     */
+    email?: string | undefined;
+    /**
+     * Available scopes.
+     */
+    scope?: string | undefined;
+    /**
+     * Authenticated user's tenant domain.
+     */
+    tenantDomain?: string | undefined;
+    /**
+     * Authenticated user's username.
+     */
+    username: string;
+    [key: string]: any;
+}

package/dist/api/oidc/getUserInfo.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
+ *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { User } from '../../models/user';
+/**
+ * Retrieves the user information from the specified OIDC userinfo endpoint.
+ *
+ * @param requestConfig - Request configuration object.
+ * @returns A promise that resolves with the user information.
+ * @throw
+ *   const userInfo = await getUserInfo({
+ *     url: "https://api.asgardeo.io/t/<ORGANIZATION>/oauth2/userinfo",
+ *   });
+ *   console.log(userInfo);
+ * } catch (error) {
+ *   if (error instanceof AsgardeoAPIError) {
+ *     console.error('Failed to get user info:', error.message);
+ *   }
+ * }
+ * ```
+ */
+declare const getUserInfo: ({ url, ...requestConfig }: Partial<Request>) => Promise<User>;
+export default getUserInfo;