@schemavaults/auth-client-sdk 0.5.0

package/README.md

@@ -0,0 +1,14 @@
+# @schemavaults/auth-client-sdk
+
+TypeScript SDK for SchemaVaults Auth platform.
+
+## Usage
+
+See the downstream package [@schemavaults/auth-react-provider](https://github.com/schemavaults/auth-react-provider) for usage within a Next.js app.
+
+See the SchemaVaults CLI for an example of usage within a command line application: [@schemavaults/cli](https://github.com/schemavaults/cli)
+
+## Dependencies
+
+- [@schemavaults/auth](https://github.com/schemavaults/auth)
+- [@schemavaults/app-definitions](https://github.com/schemavaults/app-definitions)

package/dist/auth-client.d.ts

@@ -0,0 +1,128 @@
+import { type CodeChallengeWithDetails, type UserData, type AccessToken, type RefreshToken } from "@schemavaults/auth-common";
+import type { IAuthClientConstructorOptions } from "./types/IAuthClientConstructorOptions";
+import type { Credentials } from "./types/credentials";
+import type { ISchemaVaultsAuthClient } from "./types/ISchemaVaultsAuthClient";
+import type { AcquireAccessTokenOptions } from "./types/acquire-access-token-options";
+import { type AppId } from "@schemavaults/app-definitions";
+import type { AuthenticationOutcomeType } from "./lib/authentication-outcome-type";
+/**
+ * The SchemaVaultsAuthClient is a client SDK for the SchemaVaults Auth Server
+ * It is used to authenticate users, store tokens, and manage user data
+ * @name SchemaVaultsAuthClient
+ * @alias AuthClient
+ * @author jalexw
+ * @implements ISchemaVaultsAuthClient
+ */
+export declare class SchemaVaultsAuthClient extends EventTarget implements ISchemaVaultsAuthClient {
+    private readonly _adapter;
+    private readonly environment;
+    private readonly _authServerUri;
+    private readonly _successful_authentication_redirect_uri;
+    private readonly _successful_logout_redirect_uri;
+    private readonly _authorize_uri;
+    private readonly _app_id;
+    private listeners;
+    private readonly DEBUG;
+    private get debug();
+    private readonly _default_audiences;
+    constructor(opts: IAuthClientConstructorOptions);
+    /**
+     * @name handleAuthStateChange()
+     * @description Loops over attached listeners and calls each one
+     * @see this.listeners
+     */
+    private handleAuthStateChange;
+    /**
+     * @name adapter
+     * @description Returns the adapter instance used by the auth client.
+     * @type ISchemaVaultsAuthClientAdapter
+     */
+    private get adapter();
+    get app_id(): AppId;
+    private storeCodeVerifier;
+    private loadCodeVerifier;
+    generateCodeChallenge(challenge_time?: number): Promise<CodeChallengeWithDetails>;
+    private authenticateWithRedirect;
+    login(): Promise<void>;
+    register(): Promise<void>;
+    private triggerAuthStateChanged;
+    private storeMultipleAccessTokens;
+    /**
+     * @name isClientForAuthServer
+     * @description Determines whether this client is running on the frontend of the authentication server app
+     * (only the auth server can acquire access tokens for the auth server apis, as a security feature)
+     */
+    private get isClientForAuthServer();
+    private get defaultTokenAudiences();
+    loadSavedAuthorizationCodeVerifiers(): Promise<Record<number, string>>;
+    handleSuccessfulAuthentication(authorization_code: string, challenge_time: number, code_verifier?: string): Promise<void>;
+    logout(): Promise<void>;
+    hasHttpOnlyRefreshToken(): boolean;
+    get auth_server_uri(): string;
+    get secure(): boolean;
+    /**
+     * @name successful_authentication_redirect_uri
+     * @description Where to send the user after successful authentication
+     * @example "For example, maybe send them to their account dashboard: `/account`."
+     */
+    get successful_authentication_redirect_uri(): string;
+    get authorize_uri(): string | undefined;
+    /**
+     * @name storeRefreshToken(refresh_token)
+     * @param refresh_token A 'RefreshToken' object to be stored
+     * @returns nothing, after storing the refresh token via the adapter
+     */
+    private storeRefreshToken;
+    /**
+     * @name storeAccessToken(access_token)
+     * @param token_id The ID of the access token to be stored
+     * @param access_token An  'AccessToken' object to be stored
+     * @returns nothing, after storing the access token via the adapter
+     */
+    private storeAccessToken;
+    getAccessTokenFromCache(token_id: string): AccessToken | null;
+    getRefreshTokenFromCache(): RefreshToken | null;
+    /**
+     * @name acquireAccessToken
+     * @description Attempt to acquire an access token in order to communicate with a SchemaVaults resource server.
+     * This will attempt to load a locally-saved refresh token in order to exchange it for an access token.
+     * @see this.exchangeAuthTokens()
+     */
+    acquireAccessToken(opts: AcquireAccessTokenOptions): Promise<AccessToken>;
+    private storeUserData;
+    private getUserData;
+    protected getCurrentTimestamp(): number;
+    /**
+     * @name isAuthenticated
+     * @description Getter that returns true/false based on whether a user is currently signed into their account
+     */
+    get isAuthenticated(): boolean;
+    /**
+     * @name sendAuthenticateRequest
+     * @description Send credentials to acquire an authorization code
+     * @param authentication_type 'login' | 'register' | 'reset-password'
+     * @param credentials Username/email/password/invite code
+     * @param code_challenge A code challenge for Oauth2 PKCE flow. Allows ensuring that trading authorization code for refresh token is done by the client that initialized the attempt to acquire the authorization code!
+     * @returns A 'string' authorization code, that can be exchanged for refresh/access JWTs (in combination with the code verifier-- which was used to generate the code challenge!)
+     */
+    sendAuthenticateRequest(authentication_type: AuthenticationOutcomeType, credentials: Credentials, code_challenge: CodeChallengeWithDetails): Promise<string>;
+    /**
+     * @name currentUser
+     * @description If a user is signed in to this auth client and their user data is stored locally, return it. Else, returns null.
+     * @returns `UserData` | `null`
+     */
+    get currentUser(): UserData | null;
+    private assertHttpOnlyRefreshTokenCookieHasAccompanyingMarkerCookie;
+    private handleSuccessfulExchangeAuthTokensResponse;
+    private exchangeAuthTokens;
+    private uuid;
+    onAuthStateChanged(listener: () => void, listener_id?: string): string;
+    removeAuthStateChangeListener(listener_id: string): void;
+    /**
+     * @name successful_logout_redirect_uri
+     * @description Where to redirect after /auth/logout effect succeeds
+     * @example "Perhaps the user should be sent back to the homepage: `/`"
+     */
+    get successful_logout_redirect_uri(): string | undefined;
+    supports(feature_name: string): boolean;
+}