@fusionauth/angular-sdk 1.3.0 → 2.0.0

package/sdkcore/SDKConfig/SDKConfig.d.ts

@@ -1,79 +0,0 @@
-import { CookieAdapter } from '..';
-/**
- * Config for FusionAuth Web SDKs
- */
-export interface SDKConfig {
-    /**
-     * The URL of the server that performs the token exchange.
-     */
-    serverUrl: string;
-    /**
-     * The client id of the application.
-     */
-    clientId: string;
-    /**
-     * The redirect URI of the application.
-     */
-    redirectUri: string;
-    /**
-     * The OAuth2 scope parameter passed to the `/oauth2/authorize` endpoint. If not specified fusionauth will default this to `openid offline_access`.
-     */
-    scope?: string;
-    /**
-     * The redirect URI for post-logout. Defaults the provided `redirectUri`.
-     */
-    postLogoutRedirectUri?: string;
-    /**
-     * Enables automatic token refreshing. Defaults to false.
-     */
-    shouldAutoRefresh?: boolean;
-    /**
-     * Enables the SDK to automatically handle fetching user info when logged in. Defaults to false.
-     */
-    shouldAutoFetchUserInfo?: boolean;
-    /**
-     * The number of seconds before the access token expiry when the auto refresh functionality kicks in if enabled. Default is 30.
-     */
-    autoRefreshSecondsBeforeExpiry?: number;
-    /**
-     * Callback function to be invoked with the `state` value upon redirect from login or register.
-     */
-    onRedirect?: (state?: string) => void;
-    /**
-     * The path to the login endpoint.
-     */
-    loginPath?: string;
-    /**
-     * The path to the register endpoint.
-     */
-    registerPath?: string;
-    /**
-     * The path to the logout endpoint.
-     */
-    logoutPath?: string;
-    /**
-     * The path to the token refresh endpoint.
-     */
-    tokenRefreshPath?: string;
-    /**
-     * The path to the me endpoint.
-     */
-    mePath?: string;
-    /**
-     * The name of the access token expiration moment cookie.
-     * Only set this if you are hosting server that uses a custom name for the 'app.at_exp' cookie.
-     */
-    accessTokenExpireCookieName?: string;
-    /**
-     * Callback to be invoked if a request to refresh the access token fails during autorefresh.
-     */
-    onAutoRefreshFailure?: (error: Error) => void;
-    /**
-     * Adapter pattern for SSR frameworks such as next or nuxt
-     */
-    cookieAdapter?: CookieAdapter;
-    /**
-     * Callback to be invoked at the moment of access token expiration
-     */
-    onTokenExpiration: () => void;
-}

package/sdkcore/SDKConfig/index.d.ts

@@ -1 +0,0 @@
-export * from './SDKConfig';

package/sdkcore/SDKContext/SDKContext.d.ts

@@ -1,69 +0,0 @@
-/** The context provided by FusionAuth Web SDKs */
-export interface SDKContext {
-    /**
-     * Whether the user is logged in.
-     */
-    isLoggedIn: boolean;
-    /**
-     * Data fetched from the configured 'me' endpoint.
-     */
-    userInfo: UserInfo | null;
-    /**
-     * Fetches user info from the 'me' endpoint.
-     * This is handled automatically if the SDK is configured with `shouldAutoFetchUserInfo`.
-     * @returns {Promise<UserInfo>}
-     */
-    fetchUserInfo: () => Promise<UserInfo | undefined>;
-    /**
-     * Indicates that the fetchUserInfo call is unresolved.
-     */
-    isFetchingUserInfo: boolean;
-    /**
-     * Error occurred while fetching userInfo.
-     */
-    error: Error | null;
-    /**
-     * Initiates login flow.
-     * @param {string} [state] - Optional value to be echoed back to the SDK upon redirect.
-     */
-    startLogin: (state?: string) => void;
-    /**
-     * Initiates register flow.
-     * @param {string} [state] - Optional value to be echoed back to the SDK upon redirect.
-     */
-    startRegister: (state?: string) => void;
-    /**
-     * Initiates logout flow.
-     */
-    startLogout: () => void;
-    /**
-     * Refreshes the access token a single time.
-     * This is handled automatically if the SDK is configured with `shouldAutoRefresh`.
-     */
-    refreshToken: () => Promise<void>;
-    /**
-     * Initializes automatic access token refreshing.
-     * This is handled automatically if the SDK is configured with `shouldAutoRefresh`.
-     */
-    initAutoRefresh: () => void;
-}
-/**
- * User information returned from FusionAuth.
- */
-export type UserInfo = {
-    applicationId?: string;
-    birthdate?: string;
-    email?: string;
-    email_verified?: boolean;
-    family_name?: string;
-    given_name?: string;
-    name?: string;
-    middle_name?: string;
-    phone_number?: string;
-    picture?: string;
-    preferred_username?: string;
-    roles?: any[];
-    sid?: string;
-    sub?: string;
-    tid?: string;
-};

package/sdkcore/SDKContext/index.d.ts

@@ -1 +0,0 @@
-export * from './SDKContext';

package/sdkcore/SDKCore/SDKCore.d.ts

@@ -1,28 +0,0 @@
-/// <reference types="node" />
-import { SDKConfig } from '../SDKConfig';
-import { UserInfo } from '../SDKContext';
-/** A class containing framework-agnostic SDK methods */
-export declare class SDKCore {
-    private config;
-    private urlHelper;
-    private redirectHelper;
-    private tokenExpirationTimeout?;
-    constructor(config: SDKConfig);
-    startLogin(state?: string): void;
-    startRegister(state?: string): void;
-    startLogout(): void;
-    manageAccount(): void;
-    fetchUserInfo<T = UserInfo>(): Promise<T>;
-    refreshToken(): Promise<Response>;
-    initAutoRefresh(): NodeJS.Timeout | undefined;
-    handlePostRedirect(callback?: (state?: string) => void): void;
-    get isLoggedIn(): boolean;
-    /** The moment of access token expiration in milliseconds since epoch. */
-    private get at_exp();
-    /**
-     * Schedules `onTokenExpiration` at moment of access token expiration.
-     * SDKCore is not necessarily reactive like React, Angular, and Vue.
-     * so `onTokenExpiration` is for reactive frameworks to hook in and perform actions as on token expiration.
-     */
-    private scheduleTokenExpiration;
-}

package/sdkcore/SDKCore/index.d.ts

@@ -1 +0,0 @@
-export * from './SDKCore';

package/sdkcore/UrlHelper/UrlHelper.d.ts

@@ -1,23 +0,0 @@
-import { UrlHelperConfig } from './UrlHelperTypes';
-/** A class responsible for generating URLs that FusionAuth SDKs interact with. */
-export declare class UrlHelper {
-    serverUrl: string;
-    clientId: string;
-    redirectUri: string;
-    scope?: string;
-    mePath: string;
-    loginPath: string;
-    registerPath: string;
-    logoutPath: string;
-    tokenRefreshPath: string;
-    postLogoutRedirectUri?: string;
-    constructor(config: UrlHelperConfig);
-    getMeUrl(): URL;
-    getLoginUrl(state?: string): URL;
-    getRegisterUrl(state?: string): URL;
-    getLogoutUrl(): URL;
-    getTokenRefreshUrl(): URL;
-    getAccountManagementUrl(): URL;
-    private generateUrl;
-    private generateURLSearchParams;
-}

package/sdkcore/UrlHelper/UrlHelperTypes.d.ts

@@ -1,11 +0,0 @@
-import { SDKConfig } from '../SDKConfig';
-/** A configuration object for the UrlHelper class. */
-export type UrlHelperConfig = Pick<SDKConfig, 'serverUrl' | 'clientId' | 'redirectUri' | 'mePath' | 'loginPath' | 'registerPath' | 'logoutPath' | 'tokenRefreshPath' | 'scope' | 'postLogoutRedirectUri'>;
-/** The query params associated with URLs generated by the UrlHelper class. */
-export type UrlHelperQueryParams = {
-    client_id: string;
-    redirect_uri?: string;
-    post_logout_redirect_uri?: string;
-    scope?: string;
-    state?: string;
-};

package/sdkcore/UrlHelper/index.d.ts

@@ -1,2 +0,0 @@
-export * from './UrlHelper';
-export * from './UrlHelperTypes';

package/sdkcore/index.d.ts

@@ -1,5 +0,0 @@
-export * from './SDKCore';
-export * from './SDKConfig';
-export { type SDKContext } from './SDKContext';
-export * from './testUtils';
-export { type CookieAdapter } from './CookieHelpers';

package/sdkcore/testUtils/index.d.ts

@@ -1,2 +0,0 @@
-export * from './mockLoggedIn';
-export * from './mockWindowLocation';

package/sdkcore/testUtils/mockLoggedIn.d.ts

@@ -1,5 +0,0 @@
-/** Sets `app.at_exp` moment cookie so the user will be logged in for 1 hour. */
-declare function mockIsLoggedIn(): void;
-/** Removes the `app.at_exp` cookie. */
-declare function removeAt_expCookie(): void;
-export { mockIsLoggedIn, removeAt_expCookie };

package/sdkcore/testUtils/mockWindowLocation.d.ts

@@ -1,18 +0,0 @@
-import { VitestUtils } from 'vitest';
-declare function mockWindowLocation(vi: VitestUtils): {
-    assign: import("@vitest/spy").Mock<any, any>;
-    ancestorOrigins: DOMStringList;
-    hash: string;
-    host: string;
-    hostname: string;
-    href: string;
-    toString(): string;
-    origin: string;
-    pathname: string;
-    port: string;
-    protocol: string;
-    search: string;
-    reload(): void;
-    replace(url: string | URL): void;
-};
-export { mockWindowLocation };