opds-web-client/lib/AuthPlugin.d.ts

OPDS web client

import { AuthFormProps, AuthButtonProps } from "./components/AuthProviderSelectionForm";
import { AuthMethod, AuthCredentials } from "./interfaces";
/** Applications can implement this interface if they would like to support authentication
    methods other than basic auth. A list of `AuthPlugin`s can be passed as a prop to the
    `OPDSCatalog` component. */
interface AuthPlugin<T extends AuthMethod = AuthMethod> {
    type: string;
    lookForCredentials: () => {
        credentials?: AuthCredentials;
        error?: string;
    } | null | void;
    formComponent?: React.ComponentType<AuthFormProps<T>>;
    buttonComponent: React.ComponentType<AuthButtonProps<T>>;
}
export default AuthPlugin;