@ngx-addons/omni-auth-ui-material/index.d.ts

User interface components for OmniAuth in Angular applications.

import * as _angular_core from '@angular/core';
import { SignInProviderKey, OmniAuthService, AuthRouteService } from '@ngx-addons/omni-auth-core';

type AdditionalAttributeFieldConfig = {
    key: string;
    type: 'checkbox';
    label: string;
    isRequired: boolean;
};
type SignUpComponentConfig = {
    additionalAttributes?: AdditionalAttributeFieldConfig[];
};

type SignInProvider = {
    /**
     *  @description Key used to identify the social provider in the OmniAuthService.
     */
    key: SignInProviderKey;
    /**
     *  @description Name of the social provider, e.g. 'Google', 'Facebook', etc.
     */
    label: string;
    /**
     *  @description Tooltip text that appears when hovering over the button.
     */
    tooltip?: string;
    /**
     *  @description Icon configuration for the social provider button. Preferably, use SVG icons for better scalability.
     */
    icon?: {
        src: string;
        alt: string;
    };
};
declare class SocialButtonsComponent {
    #private;
    readonly content: _angular_core.InputSignal<Pick<{
        loggedIn: {
            welcomeMessage: string;
            welcomeMessageNoDisplayName: string;
        };
        common: {
            emailLabel: string;
            passwordLabel: string;
            nameLabel: string;
            nameErrorRequiredText: string;
            nameErrorMinLengthText: string;
            namePlaceholder: string;
            emailErrorRequiredText: string;
            emailErrorPatternText: string;
            emailPlaceholder: string;
            passwordErrorRequiredText: string;
            passwordErrorMinLengthText: string;
            passwordPatternText: string;
            passwordPlaceholder: string;
            codeLabel: string;
            codeErrorRequiredText: string;
            codePlaceholder: string;
            backToSignInLabel: string;
            icons: {
                back: string;
                email: string;
            };
        };
        signIn: {
            title: string;
            errorSubmitMessage: string;
            submitLabel: string;
            forgetPassword: string;
        };
        signUp: {
            title: string;
            errorSubmitMessage: string;
            submitLabel: string;
            termsAndConditionsText: string;
            termsAndConditionsLinkText: string;
        };
        confirmationSignUp: {
            subTitle: string;
            paragraph: string;
            errorSubmitMessage: string;
            submitLabel: string;
            resendLabel: string;
            errorResendMessage: string;
        };
        resetPassword: {
            title: string;
            sendCodeMessage: string;
            providePasswordMessage: string;
            repeatPassword: string;
            errorSubmitMessage: string;
            errorSendCodeMessage: string;
            sendCodeLabel: string;
            submitLabel: string;
        };
        socialButtons: {
            orLine: string;
            signInWithGoogle: string;
            signInWithApple: string;
            signInWithFacebook: string;
        };
        errors: {
            invalidCode: string;
            usernameNotFound: string;
            incorrectUsernameOrPassword: string;
            userDoesNotExist: string;
            alreadySignedIn: string;
            signInWithRedirectFailure: string;
            invalidConfiguration: string;
            cancelledFlow: string;
            unknown: string;
        };
    }, "errors" | "common" | "socialButtons">>;
    readonly error: _angular_core.WritableSignal<string | null>;
    readonly processing: _angular_core.WritableSignal<string | null>;
    readonly signInProviders: _angular_core.InputSignal<SignInProvider[]>;
    onSocialButtonClick: (provider: SignInProvider) => Promise<void>;
    protected readonly name: void;
    static ɵfac: _angular_core.ɵɵFactoryDeclaration<SocialButtonsComponent, never>;
    static ɵcmp: _angular_core.ɵɵComponentDeclaration<SocialButtonsComponent, "omni-auth-ui-mat-social-buttons", never, { "content": { "alias": "content"; "required": true; "isSignal": true; }; "signInProviders": { "alias": "signInProviders"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
}

type SignInComponentConfig = {
    signInProviders?: SignInProvider[];
};

type AuthComponentConfig = {
    signUp?: SignUpComponentConfig;
    signIn?: SignInComponentConfig;
};
declare class AuthComponent {
    authService: OmniAuthService;
    authRouteService: AuthRouteService;
    content: _angular_core.InputSignal<{
        loggedIn: {
            welcomeMessage: string;
            welcomeMessageNoDisplayName: string;
        };
        common: {
            emailLabel: string;
            passwordLabel: string;
            nameLabel: string;
            nameErrorRequiredText: string;
            nameErrorMinLengthText: string;
            namePlaceholder: string;
            emailErrorRequiredText: string;
            emailErrorPatternText: string;
            emailPlaceholder: string;
            passwordErrorRequiredText: string;
            passwordErrorMinLengthText: string;
            passwordPatternText: string;
            passwordPlaceholder: string;
            codeLabel: string;
            codeErrorRequiredText: string;
            codePlaceholder: string;
            backToSignInLabel: string;
            icons: {
                back: string;
                email: string;
            };
        };
        signIn: {
            title: string;
            errorSubmitMessage: string;
            submitLabel: string;
            forgetPassword: string;
        };
        signUp: {
            title: string;
            errorSubmitMessage: string;
            submitLabel: string;
            termsAndConditionsText: string;
            termsAndConditionsLinkText: string;
        };
        confirmationSignUp: {
            subTitle: string;
            paragraph: string;
            errorSubmitMessage: string;
            submitLabel: string;
            resendLabel: string;
            errorResendMessage: string;
        };
        resetPassword: {
            title: string;
            sendCodeMessage: string;
            providePasswordMessage: string;
            repeatPassword: string;
            errorSubmitMessage: string;
            errorSendCodeMessage: string;
            sendCodeLabel: string;
            submitLabel: string;
        };
        socialButtons: {
            orLine: string;
            signInWithGoogle: string;
            signInWithApple: string;
            signInWithFacebook: string;
        };
        errors: {
            invalidCode: string;
            usernameNotFound: string;
            incorrectUsernameOrPassword: string;
            userDoesNotExist: string;
            alreadySignedIn: string;
            signInWithRedirectFailure: string;
            invalidConfiguration: string;
            cancelledFlow: string;
            unknown: string;
        };
    }>;
    config: _angular_core.InputSignal<AuthComponentConfig | undefined>;
    static ɵfac: _angular_core.ɵɵFactoryDeclaration<AuthComponent, never>;
    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AuthComponent, "omni-auth-ui-mat", never, { "content": { "alias": "content"; "required": false; "isSignal": true; }; "config": { "alias": "config"; "required": false; "isSignal": true; }; }, {}, never, ["[sign-up-footer]"], true, never>;
}

export { AuthComponent, SocialButtonsComponent };
export type { AuthComponentConfig };