@inrupt/solid-client-authn-browser 1.17.1 → 1.17.3

package/dist/login/oidc/IssuerConfigFetcher.d.ts

@@ -1,5 +1,15 @@
+/**
+ * @hidden
+ * @packageDocumentation
+ */
+/**
+ * Responsible for fetching an IDP configuration
+ */
 import type { IIssuerConfig, IIssuerConfigFetcher, IStorageUtility } from "@inrupt/solid-client-authn-core";
 export declare const WELL_KNOWN_OPENID_CONFIG = ".well-known/openid-configuration";
+/**
+ * @hidden
+ */
 export default class IssuerConfigFetcher implements IIssuerConfigFetcher {
     private storageUtility;
     constructor(storageUtility: IStorageUtility);

package/dist/login/oidc/OidcLoginHandler.d.ts

@@ -1,4 +1,14 @@
+/**
+ * @hidden
+ * @packageDocumentation
+ */
+/**
+ * Handles Common Oidc login functions (Like fetching the configuration)
+ */
 import type { IClientRegistrar, IIssuerConfigFetcher, ILoginOptions, ILoginHandler, IOidcHandler, IStorageUtility, LoginResult } from "@inrupt/solid-client-authn-core";
+/**
+ * @hidden
+ */
 export default class OidcLoginHandler implements ILoginHandler {
     private storageUtility;
     private oidcHandler;

package/dist/login/oidc/Redirector.d.ts

@@ -1,4 +1,11 @@
+/**
+ * @hidden
+ * @packageDocumentation
+ */
 import type { IRedirector, IRedirectorOptions } from "@inrupt/solid-client-authn-core";
+/**
+ * @hidden
+ */
 export default class Redirector implements IRedirector {
     redirect(redirectUrl: string, options?: IRedirectorOptions): void;
 }

package/dist/login/oidc/incomingRedirectHandler/AuthCodeRedirectHandler.d.ts

@@ -1,6 +1,9 @@
 /// <reference types="node" />
 import type { IClientRegistrar, IIssuerConfigFetcher, IIncomingRedirectHandler, ISessionInfoManager, IStorageUtility, ITokenRefresher, IncomingRedirectResult } from "@inrupt/solid-client-authn-core";
 import type { EventEmitter } from "events";
+/**
+ * @hidden
+ */
 export declare class AuthCodeRedirectHandler implements IIncomingRedirectHandler {
     private storageUtility;
     private sessionInfoManager;

package/dist/login/oidc/incomingRedirectHandler/ErrorOidcHandler.d.ts

@@ -1,6 +1,16 @@
 /// <reference types="node" />
+/**
+ * @hidden
+ * @packageDocumentation
+ */
 import type { IIncomingRedirectHandler, ISessionInfo } from "@inrupt/solid-client-authn-core";
 import type { EventEmitter } from "events";
+/**
+ * This class handles redirect IRIs without any query params, and returns an unauthenticated
+ * session. It serves as a fallback so that consuming libraries don't have to test
+ * for the query params themselves, and can always try to use them as a redirect IRI.
+ * @hidden
+ */
 export declare class ErrorOidcHandler implements IIncomingRedirectHandler {
     canHandle(redirectUrl: string): Promise<boolean>;
     handle(redirectUrl: string, eventEmitter?: EventEmitter): Promise<ISessionInfo & {

package/dist/login/oidc/incomingRedirectHandler/FallbackRedirectHandler.d.ts

@@ -1,4 +1,14 @@
+/**
+ * @hidden
+ * @packageDocumentation
+ */
 import type { IIncomingRedirectHandler, ISessionInfo } from "@inrupt/solid-client-authn-core";
+/**
+ * This class handles redirect IRIs without any query params, and returns an unauthenticated
+ * session. It serves as a fallback so that consuming libraries don't have to test
+ * for the query params themselves, and can always try to use them as a redirect IRI.
+ * @hidden
+ */
 export declare class FallbackRedirectHandler implements IIncomingRedirectHandler {
     canHandle(redirectUrl: string): Promise<boolean>;
     handle(_redirectUrl: string): Promise<ISessionInfo & {

package/dist/login/oidc/oidcHandlers/AuthorizationCodeWithPkceOidcHandler.d.ts

@@ -1,5 +1,17 @@
+/**
+ * @hidden
+ * @packageDocumentation
+ */
+/**
+ * Handler for the Authorization Code with PKCE Flow
+ */
 import type { IOidcHandler, IOidcOptions, LoginResult } from "@inrupt/solid-client-authn-core";
 import { AuthorizationCodeWithPkceOidcHandlerBase } from "@inrupt/solid-client-authn-core";
+/**
+ * @hidden
+ * Authorization code flow spec: https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth
+ * PKCE: https://tools.ietf.org/html/rfc7636
+ */
 export default class AuthorizationCodeWithPkceOidcHandler extends AuthorizationCodeWithPkceOidcHandlerBase implements IOidcHandler {
     handle(oidcLoginOptions: IOidcOptions): Promise<LoginResult>;
 }

package/dist/login/oidc/refresh/TokenRefresher.d.ts

@@ -1,6 +1,13 @@
 /// <reference types="node" />
+/**
+ * @hidden
+ * @packageDocumentation
+ */
 import type { IClientRegistrar, IIssuerConfigFetcher, IStorageUtility, KeyPair, ITokenRefresher, TokenEndpointResponse } from "@inrupt/solid-client-authn-core";
 import type { EventEmitter } from "events";
+/**
+ * @hidden
+ */
 export default class TokenRefresher implements ITokenRefresher {
     private storageUtility;
     private issuerConfigFetcher;

package/dist/logout/buildRpInitiatedLogout.d.ts

@@ -1,2 +1,9 @@
 import type { IEndSessionOptions, IRpLogoutOptions } from "@inrupt/solid-client-authn-core";
+/**
+ * @param options.endSessionEndpoint The end_session_endpoint advertised by the server
+ * @param options.idTokenHint The idToken supplied by the server after logging in
+ * Redirects the window to the location required to perform RP initiated logout
+ *
+ * @hidden
+ */
 export declare function buildRpInitiatedLogout({ endSessionEndpoint, idTokenHint, }: Omit<IEndSessionOptions, keyof IRpLogoutOptions>): ({ state, postLogoutUrl }: IRpLogoutOptions) => void;

package/dist/sessionInfo/SessionInfoManager.d.ts

@@ -1,8 +1,26 @@
+/**
+ * @hidden
+ * @packageDocumentation
+ */
 import type { ISessionInfo, ISessionInfoManager, ISessionInternalInfo, IStorageUtility } from "@inrupt/solid-client-authn-core";
 import { SessionInfoManagerBase } from "@inrupt/solid-client-authn-core";
 export { getUnauthenticatedSession } from "@inrupt/solid-client-authn-core";
+/**
+ * @param sessionId
+ * @param storage
+ * @hidden
+ */
 export declare function clear(sessionId: string, storage: IStorageUtility): Promise<void>;
+/**
+ * @hidden
+ */
 export declare class SessionInfoManager extends SessionInfoManagerBase implements ISessionInfoManager {
     get(sessionId: string): Promise<(ISessionInfo & ISessionInternalInfo) | undefined>;
+    /**
+     * This function removes all session-related information from storage.
+     * @param sessionId the session identifier
+     * @param storage the storage where session info is stored
+     * @hidden
+     */
     clear(sessionId: string): Promise<void>;
 }