@crossauth/frontend 0.0.14 → 0.0.15

package/dist/oauth/autorefresher.d.ts

@@ -2,7 +2,7 @@ import { CrossauthError } from '@crossauth/common';
 import { OAuthTokenProvider } from './tokenprovider.ts';
 
 /**
- * Used by {@link OAuthClient} and {@link OAuthBsffClient} to automatically
+ * Used by {@link OAuthClient} and {@link OAuthBffClient} to automatically
  * refresh access and ID tokens
  */
 export declare class OAuthAutoRefresher {

package/dist/oauth/bffclient.d.ts

@@ -4,7 +4,10 @@ import { CrossauthError } from '@crossauth/common';
  * A browser-side OAuth client designed with work with the
  * backend-for-frontend (BFF) mode of the backend OAuth client.
  *
- * See {@link @crossauth/fastify!FastifyOAuthClient}.
+ * You may use this, or alternatively the backend OAuth clients, eg
+ *
+ * `@crossauth/fastify/FastifyOAuthClient` or
+ * .`@crossauth/sveltekit/SvelteKitOAuthClient`
  */
 export declare class OAuthBffClient {
     private bffPrefix;
@@ -64,7 +67,7 @@ export declare class OAuthBffClient {
      * This only returns something if the ID token was returned to the BFF
      * client in a previous OAuth call.  Otherwise it returns an empty JSON.
      *
-     * @param crfToken the CSRF token.  If emtpy, one will be fetched before
+     * @param csrfToken the CSRF token.  If emtpy, one will be fetched before
      *        making the request
      * @returns the ID token payload or an empty object if there isn't one
      */
@@ -75,7 +78,7 @@ export declare class OAuthBffClient {
      * Returns whether or not there is an ID token stored in the BFF server
      * for this client.
      *
-     * @param crfToken the CSRF token.  If emtpy, one will be fetched before
+     * @param csrfToken the CSRF token.  If emtpy, one will be fetched before
      *        making the request
      * @returns true or false
      */
@@ -86,10 +89,8 @@ export declare class OAuthBffClient {
      * This only returns something if the access token was returned to the BFF
      * client in a previous OAuth call.  Otherwise it returns an empty JSON.
      *
-     * @param crfToken the CSRF token.  If emtpy, one will be fetched before
+     * @param csrfToken the CSRF token.  If emtpy, one will be fetched before
      *        making the request
-     * @param headers any additional headers to add (will be added to
-     *         the ones given with {@link OAuthBffClient.addHeader} )
      * @returns the access token payload or an empty object if there isn't one
      */
     getAccessToken(csrfToken?: string): Promise<{
@@ -99,7 +100,7 @@ export declare class OAuthBffClient {
      * Returns whether or not there is an access token stored in the BFF server
      * for this client.
      *
-     * @param crfToken the CSRF token.  If emtpy, one will be fetched before
+     * @param csrfToken the CSRF token.  If emtpy, one will be fetched before
      *        making the request
      * @returns true or false
      */
@@ -110,7 +111,7 @@ export declare class OAuthBffClient {
      * This only returns something if the refresh token was returned to the BFF
      * client in a previous OAuth call.  Otherwise it returns an empty JSON.
      *
-     * @param crfToken the CSRF token.  If emtpy, one will be fetched before
+     * @param csrfToken the CSRF token.  If emtpy, one will be fetched before
      *        making the request
      * @returns the refresh token payload or an empty object if there isn't one
      */
@@ -121,7 +122,7 @@ export declare class OAuthBffClient {
      * Returns whether or not there is a refresh token stored in the BFF server
      * for this client.
      *
-     * @param crfToken the CSRF token.  If emtpy, one will be fetched before
+     * @param csrfToken the CSRF token.  If emtpy, one will be fetched before
      *        making the request
      * @returns true or false
      */
@@ -169,8 +170,8 @@ export declare class OAuthBffClient {
     stopAutoRefresh(): void;
     /**
      * Turns polling for a device code
-     * @param tokensToFetch which tokens to fetch
-     * @param errorFn what to call in case of error
+     * @param deviceCode the device code to poll for (returned when the device code flow was started)
+     * @param pollResultFn THis function will be called with the result of each poll
      */
     startDeviceCodePolling(deviceCode: string, pollResultFn: (status: ("complete" | "completeAndRedirect" | "authorization_pending" | "expired_token" | "error"), error?: string, location?: string) => void, interval?: number): Promise<void>;
     /**
@@ -179,7 +180,7 @@ export declare class OAuthBffClient {
     stopDeviceCodePolling(): void;
     /**
      * Fetches the expiry times for each token.
-     * @param crfToken the CSRF token.  If emtpy
+     * @param csrfToken the CSRF token.  If emtpy
      * , one will be fetched before
      *        making the request
      * @returns for each token, either the expiry, `null` if it does not
@@ -194,7 +195,7 @@ export declare class OAuthBffClient {
      * Makes a fetch, adding in the requested token
      * @param url the URL to fetch
      * @param params parameters to add to the fetch
-     * @param token which token to add
+     * @param _token unused
      * @returns parsed JSON response
      */
     jsonFetchWithToken(url: string, params: {

package/dist/oauth/client.d.ts

@@ -68,7 +68,7 @@ export declare class OAuthClient extends OAuthClientBase {
      *   - `deviceAuthorization` URL, relative to the authorization server base,
      *      for starting the device code flow.  Default `device_authorization`
      *      Default is `/devicecodepoll`
-     *  For other options see {@link @crossauth/common/OAuthClientBase}.
+     *  For other options see {@link OAuthClientBase}.
      */
     constructor(options: {
         authServerBaseUrl: string;
@@ -111,14 +111,9 @@ export declare class OAuthClient extends OAuthClientBase {
      * endpoint is called.  Depending on whether that returned an error,
      * either `receiveTokenFn` or `errorFn` will be called.
      *
-     * @param receiveTokenFn if defined, called if a token is returned.
-     *
-     * @param errorFn if defined, called if any OAuth endpoint returned `error`,
-     *        or if the `state` was not correct.
-     *
-     * @returns the result of `receiveTokenFn`, `errorFn` or `undefined`.  If
-     *          `receiveTokenFn`/`errorFn` is not defined, rather than calling
-     *          it, this function just returns the OAuth response.
+     * @returns the result of `receiveTokenFn` or undefined if there was
+     *          neither a code in the URL search params nor an error `undefined`.  If
+     * @throws CrossauthError if an `error` was passed in the URL search params
      *
      */
     handleRedirectUri(): Promise<any | undefined>;
@@ -134,8 +129,8 @@ export declare class OAuthClient extends OAuthClientBase {
     stopAutoRefresh(): void;
     /**
      * Turns polling for a device code
-     * @param tokensToFetch which tokens to fetch
-     * @param errorFn what to call in case of error
+     * @param deviceCode the device code to poll for (this was returned when the device code flow was started)
+     * @param pollResultFn called with the result of each poll
      */
     startDeviceCodePolling(deviceCode: string, pollResultFn: (status: ("complete" | "completeAndRedirect" | "authorization_pending" | "expired_token" | "error"), error?: string, location?: string) => void, interval?: number): Promise<void>;
     /**
@@ -183,9 +178,8 @@ export declare class OAuthClient extends OAuthClientBase {
     }>;
     /**
      * Fetches the expiry times for each token.
-     * @param crfToken the CSRF token.  If emtpy
-     * , one will be fetched before
-     *        making the request
+     * @param _tokensToFetch unused
+     * @param _csrfToken unused
      * @returns for each token, either the expiry, `null` if it does not
      *          expire, or `undefined` if the token does not exist
      */
@@ -218,27 +212,29 @@ export declare class OAuthClient extends OAuthClientBase {
         refresh_token?: string | null;
     }): Promise<void>;
     /**
-     * See {@link @crossuath/common!OAuthClientBase}.  Calls the base function
+     * See {@link OAuthClientBase}.  Calls the base function
      * then saves the tokens, as per the requested method
      * @param scope
      */
     clientCredentialsFlow(scope?: string): Promise<OAuthTokenResponse>;
     /**
-     * See {@link @crossuath/common!OAuthClientBase}.  Calls the base function
+     * See {@link OAuthClientBase}.  Calls the base function
      * then saves the tokens, as per the requested method
      * @param scope
      */
     passwordFlow(username: string, password: string, scope?: string): Promise<OAuthTokenResponse>;
     /**
-     * See {@link @crossuath/common!OAuthClientBase}.  Calls the base function
+     * See {@link OAuthClientBase}.  Calls the base function
      * then saves the tokens, as per the requested method
      * @param scope
      */
     deviceCodeFlow(scope?: string): Promise<OAuthDeviceAuthorizationResponse>;
     /**
-     * See {@link @crossuath/common!OAuthClientBase}.  Calls the base function
+     * See {@link OAuthClientBase}.  Calls the base function
      * then saves the tokens, as per the requested method
-     * @param scope
+     * @param mfaToken the MFA token returned when the flow was started
+     * @param otp the One time password entered by the user
+     * @return the response from the MFA OTP OAuth call
      */
     mfaOtpComplete(mfaToken: string, otp: string): Promise<{
         access_token?: string;
@@ -251,15 +247,18 @@ export declare class OAuthClient extends OAuthClientBase {
         error_description?: string;
     }>;
     /**
-     * See {@link @crossuath/common!OAuthClientBase}.  Calls the base function
+     * See {@link OAuthClientBase}.  Calls the base function
      * then saves the tokens, as per the requested method
-     * @param scope
+     * @param mfaToken the MFA token returned when the flow was started
+     * @param oobCode the code entered by the user
+     * @return the response from the MFA OOB OAuth call
      */
     mfaOobComplete(mfaToken: string, oobCode: string, bindingCode: string): Promise<OAuthTokenResponse>;
     /**
-     * See {@link @crossuath/common!OAuthClientBase}.  Calls the base function
+     * See {@link OAuthClientBase}.  Calls the base function
      * then saves the tokens, as per the requested method
-     * @param scope
+     * @param refreshToken  the refresh token.  Do not pass this if you have
+     * it stored in this object already
      */
     refreshTokenFlow(refreshToken?: string): Promise<OAuthTokenResponse>;
     /**

package/dist/oauth/devicecodepoller.d.ts

@@ -1,7 +1,7 @@
 import { OAuthClientBase } from '@crossauth/common';
 
 /**
- * Used by {@link OAuthClient} and {@link OAuthBsffClient} to poll for
+ * Used by {@link OAuthClient} and {@link OAuthBffClient} to poll for
  * authorization in the device code flow
  */
 export declare class OAuthDeviceCodePoller {

package/dist/oauth/tokenprovider.d.ts

@@ -10,7 +10,7 @@ export declare abstract class OAuthTokenProvider {
     getCsrfToken(): Promise<string | undefined>;
     /**
      * Fetches the expiry times for each token.
-     * @param crfToken the CSRF token.  If emtpy
+     * @param csrfToken the CSRF token.  If emtpy
      * , one will be fetched before
      *        making the request
      * @returns for each token, either the expiry, `null` if it does not

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@crossauth/frontend",
   "private": false,
-  "version": "0.0.14",
+  "version": "0.0.15",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -22,7 +22,7 @@
   },
   "dependencies": {
     "@esbuild-plugins/node-modules-polyfill": "^0.2.2",
-    "@crossauth/common": "^0.0.14"
+    "@crossauth/common": "^0.0.15"
   },
   "scripts": {
     "dev": "vite",