@fusionauth/angular-sdk 0.1.7 → 1.0.2

package/lib/fusion-auth.service.d.ts

@@ -1,42 +1,51 @@
 import { FusionAuthConfig, UserInfo } from './types';
+import { Observable } from 'rxjs';
 /**
  * Service class to use with FusionAuth backend endpoints.
  */
 export declare class FusionAuthService {
-    private config;
+    private core;
+    private autoRefreshTimer?;
+    private isLoggedInSubject;
     constructor(config: FusionAuthConfig);
+    /** An observable representing whether the user is logged in. */
+    isLoggedIn$: Observable<boolean>;
+    /** A function that returns whether the user is logged in. This returned value is non-observable. */
+    isLoggedIn(): boolean;
     /**
-     * Calls the 'me' endpoint to retrieve user info.
-     * @return {Promise<UserInfo>} the user info response.
+     * Refreshes the access token a single time.
+     * Automatic token refreshing can be enabled if the SDK is configured with `shouldAutoRefresh`.
      */
-    getUserInfo(): Promise<UserInfo>;
+    refreshToken(): Promise<Response>;
     /**
-     * Checks for the 'app.at_exp' cookie and if present sets a timer to refresh the access token.
-     * Will attempt to refresh the configured seconds before the access token expires (default is ten seconds).
+     * Initializes automatic access token refreshing.
+     * This is handled automatically if the SDK is configured with `shouldAutoRefresh`.
      */
     initAutoRefresh(): void;
     /**
-     * Checks that the 'app.at_exp' cookie is present and for a time in the future to determine logged-in state.
-     * @return {boolean} app.at_exp is present and not for a time in the past
+     * Returns an observable request that fetches userInfo, and catches error.
      */
-    isLoggedIn(): boolean;
+    getUserInfoObservable(callbacks?: {
+        onBegin?: () => void;
+        onDone?: () => void;
+    }): Observable<UserInfo>;
     /**
-     * Calls the configured 'refresh' endpoint to attempt to refresh the access token cookie.
+     * Fetches userInfo from the 'me' endpoint.
+     * @throws {Error} - if an error occurred while fetching.
      */
-    refreshToken(): Promise<void>;
+    getUserInfo(): Promise<UserInfo>;
     /**
-     * Invokes a redirect to the configured 'login' endpoint.
+     * Initiates login flow.
+     * @param {string} [state] - Optional value to be echoed back to the SDK upon redirect.
      */
     startLogin(state?: string): void;
     /**
-     * Invokes a redirect to the configured 'refresh' endpoint.
+     * Initiates register flow.
+     * @param {string} [state] - Optional value to be echoed back to the SDK upon redirect.
      */
     startRegistration(state?: string): void;
     /**
-     * Invokes a redirect to the configured 'logout' endpoint.
+     * Initiates logout flow.
      */
     logout(): void;
-    private doRedirectForPath;
-    private getUrlForPath;
-    private getExpTime;
 }

package/lib/types.d.ts

@@ -1,12 +1,58 @@
+/**
+ * Config for FusionAuth Angular SDK
+ */
 export interface FusionAuthConfig {
+    /**
+     * The URL of the server that performs the token exchange.
+     */
     serverUrl: string;
+    /**
+     * The client id of the application.
+     */
     clientId: string;
-    redirectUri?: 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;
+    /**
+     * Enables automatic token refreshing. Defaults to false.
+     */
+    shouldAutoRefresh?: boolean;
+    /**
+     * The number of seconds before the access token expiry when the auto refresh functionality kicks in if enabled. Default is 10.
+     */
     autoRefreshSecondsBeforeExpiry?: number;
+    /**
+     * Callback function to be invoked with the `state` value upon redirect from login or register.
+     */
+    onRedirect?: (state?: string) => void;
+    /**
+     * Callback to be invoked if a request to refresh the access token fails during autorefresh.
+     */
+    onAutoRefreshFailure?: (error: Error) => void;
+    /**
+     * The path to the login endpoint.
+     */
     loginPath?: string;
-    logoutPath?: 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;
 }
 export interface UserInfo {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fusionauth/angular-sdk",
-  "version": "0.1.7",
+  "version": "1.0.2",
   "peerDependencies": {
     "@angular/common": "^17.2.0",
     "@angular/core": "^17.2.0"