@bitblit/ratchet-warden-common 4.0.420-alpha → 4.0.425-alpha

package/lib/types.d.ts

@@ -1,372 +0,0 @@
-import { BuildInformation, CommonJwtToken } from '@bitblit/ratchet-common';
-import { AuthenticationResponseJSON, PublicKeyCredentialRequestOptionsJSON, PublicKeyCredentialCreationOptionsJSON, RegistrationResponseJSON } from '@simplewebauthn/types';
-import { BehaviorSubject } from 'rxjs';
-
-declare class RatchetWardenCommonInfo {
-    private constructor();
-    static buildInformation(): BuildInformation;
-}
-
-declare enum WardenContactType {
-    TextCapablePhoneNumber = "TextCapablePhoneNumber",
-    EmailAddress = "EmailAddress"
-}
-
-interface WardenContact {
-    value: string;
-    type: WardenContactType;
-}
-
-interface CreateAccount {
-    contact: WardenContact;
-    sendCode?: boolean;
-    label?: string;
-    tags?: string[];
-}
-
-interface RemoveWebAuthnRegistration {
-    userId: string;
-    credentialId: string;
-}
-
-interface WardenLoginRequest {
-    userId?: string;
-    contact?: WardenContact;
-    webAuthn?: AuthenticationResponseJSON;
-    expiringToken?: string;
-    jwtTokenToRefresh?: string;
-    createUserIfMissing?: boolean;
-}
-
-interface WardenContactLookup {
-    userId?: string;
-    contactType?: WardenContactType;
-}
-
-interface WardenCustomTemplateDescriptor {
-    textVersion?: string;
-    htmlVersion?: string;
-    baseLayout?: string;
-    subjectLine?: string;
-    meta?: Record<string, string>;
-}
-
-interface SendMagicLink {
-    overrideDestinationContact?: WardenContact;
-    contactLookup?: WardenContactLookup;
-    contact?: WardenContact;
-    landingUrl: string;
-    meta?: Record<string, string>;
-    ttlSeconds?: number;
-    customTemplate?: WardenCustomTemplateDescriptor;
-}
-
-interface WebAuthnObjectWrapper {
-    dataAsJson: string;
-}
-
-interface AddWebAuthnRegistrationToLoggedInUser {
-    webAuthn: WebAuthnObjectWrapper;
-    applicationName: string;
-    deviceLabel: string;
-}
-
-interface WardenCommand {
-    createAccount?: CreateAccount;
-    sendMagicLink?: SendMagicLink;
-    generateWebAuthnAuthenticationChallengeForUserId?: string;
-    generateWebAuthnRegistrationChallengeForLoggedInUser?: boolean;
-    sendExpiringValidationToken?: WardenContact;
-    addWebAuthnRegistrationToLoggedInUser?: AddWebAuthnRegistrationToLoggedInUser;
-    addContactToLoggedInUser?: WardenContact;
-    removeWebAuthnRegistrationFromLoggedInUser?: string;
-    removeContactFromLoggedInUser?: WardenContact;
-    removeWebAuthnRegistration?: RemoveWebAuthnRegistration;
-    performLogin?: WardenLoginRequest;
-    refreshJwtToken?: string;
-}
-
-interface WardenCommandExchangeProvider {
-    sendCommand(cmdString: string, jwtToken: string): Promise<string>;
-}
-
-interface WardenLoginResults {
-    request: WardenLoginRequest;
-    userId?: string;
-    jwtToken?: string;
-    error?: string;
-}
-
-interface WardenWebAuthnEntrySummary {
-    origin: string;
-    applicationName: string;
-    deviceLabel: string;
-    credentialIdBase64: string;
-}
-
-interface WardenEntrySummary {
-    userId: string;
-    userLabel: string;
-    contactMethods: WardenContact[];
-    webAuthnAuthenticatorSummaries: WardenWebAuthnEntrySummary[];
-}
-
-interface WardenCommandResponse {
-    createAccount?: string;
-    sendMagicLink?: boolean;
-    generateWebAuthnAuthenticationChallengeForUserId?: WebAuthnObjectWrapper;
-    generateWebAuthnRegistrationChallengeForLoggedInUser?: WebAuthnObjectWrapper;
-    removeWebAuthnRegistration?: WardenEntrySummary;
-    sendExpiringValidationToken?: boolean;
-    addWebAuthnRegistrationToLoggedInUser?: WardenEntrySummary;
-    addContactToLoggedInUser?: boolean;
-    performLogin?: WardenLoginResults;
-    refreshJwtToken?: string;
-    removeWebAuthnRegistrationFromLoggedInUser?: WardenEntrySummary;
-    removeContactFromLoggedInUser?: WardenEntrySummary;
-    error?: string;
-}
-
-interface WardenClientCurrentLoggedInJwtTokenProvider {
-    fetchCurrentLoggedInJwtToken(): string;
-}
-
-declare class WardenClient {
-    private commandSender;
-    private jwtProvider;
-    constructor(commandSender: WardenCommandExchangeProvider, jwtProvider: WardenClientCurrentLoggedInJwtTokenProvider);
-    exchangeCommand(cmd: WardenCommand, returnErrors?: boolean): Promise<WardenCommandResponse>;
-    createAccount(contact: WardenContact, sendCode?: boolean, label?: string, tags?: string[]): Promise<string>;
-    sendMagicLinkRaw(smlCmd: SendMagicLink): Promise<boolean>;
-    sendMagicLinkByUserId(userId: string, landingUrl: string, contactType?: WardenContactType, meta?: Record<string, string>): Promise<boolean>;
-    sendMagicLink(contact: WardenContact, landingUrl: string, meta?: Record<string, string>): Promise<boolean>;
-    generateWebAuthnAuthenticationChallengeForUserId(userId: string): Promise<PublicKeyCredentialRequestOptionsJSON>;
-    generateWebAuthnRegistrationChallengeForLoggedInUser(): Promise<PublicKeyCredentialCreationOptionsJSON>;
-    removeWebAuthnRegistration(userId: string, credId: string): Promise<WardenEntrySummary>;
-    removeWebAuthnRegistrationFromLoggedInUser(input: string): Promise<WardenEntrySummary>;
-    removeContactFromLoggedInUser(input: WardenContact): Promise<WardenEntrySummary>;
-    sendExpiringValidationToken(contact: WardenContact): Promise<boolean>;
-    addContactToLoggedInUser(contact: WardenContact): Promise<boolean>;
-    addWebAuthnRegistrationToLoggedInUser(applicationName: string, deviceLabel: string, data: RegistrationResponseJSON): Promise<WardenEntrySummary>;
-    performLoginCmd(login: WardenLoginRequest): Promise<WardenLoginResults>;
-    refreshJwtToken(oldJwtToken: string): Promise<string>;
-    executeExpiringTokenBasedLogin(contact: WardenContact, expiringToken: string): Promise<WardenLoginResults>;
-}
-
-interface WardenJwtToken<T> extends CommonJwtToken<T> {
-    loginData: WardenEntrySummary;
-}
-
-interface WardenLoggedInUserWrapper<T> {
-    userObject: WardenJwtToken<T>;
-    jwtToken: string;
-    expirationEpochSeconds: number;
-}
-
-interface WardenUserServiceEventProcessingProvider<T> {
-    onLogout(): void;
-    onSuccessfulLogin(newUser: WardenLoggedInUserWrapper<T>): void;
-    onLoginFailure(reason: string): void;
-    onAutomaticTokenRefresh(refreshUser: WardenLoggedInUserWrapper<T>): void;
-    onAutomaticLogout(): void;
-}
-
-declare class WardenDelegatingCurrentUserProvidingUserServiceEventProcessingProvider<T> implements WardenUserServiceEventProcessingProvider<T>, WardenClientCurrentLoggedInJwtTokenProvider {
-    private wrapped?;
-    private serveExpiredCredentials;
-    private _currentUserSubject;
-    constructor(wrapped?: Partial<WardenUserServiceEventProcessingProvider<T>>, serveExpiredCredentials?: boolean);
-    fetchCurrentLoggedInJwtToken(): string;
-    get currentUserSubject(): BehaviorSubject<WardenLoggedInUserWrapper<T>>;
-    onAutomaticLogout(): void;
-    onAutomaticTokenRefresh(refreshUser: WardenLoggedInUserWrapper<T>): void;
-    onLoginFailure(reason: string): void;
-    onLogout(): void;
-    onSuccessfulLogin(newUser: WardenLoggedInUserWrapper<T>): void;
-}
-
-interface WardenLoggedInUserProvider<T> {
-    fetchLoggedInUserWrapper(): WardenLoggedInUserWrapper<T>;
-    setLoggedInUserWrapper(wrapper: WardenLoggedInUserWrapper<T>): any;
-    logOutUser(): void;
-}
-
-interface WardenRecentLoginDescriptor {
-    user: WardenEntrySummary;
-    lastLoginEpochMS: number;
-}
-
-interface WardenClientRecentLoginProvider {
-    saveRecentLogin(entry: WardenEntrySummary): void;
-    saveNewUser(userId: string, label: string, contact: WardenContact): void;
-    removeUser(userId: string): void;
-    fetchAllLogins(): WardenRecentLoginDescriptor[];
-    clearAllLogins(): void;
-}
-
-interface WardenUserServiceOptions<T> {
-    recentLoginProvider?: WardenClientRecentLoginProvider;
-    loggedInUserProvider: WardenLoggedInUserProvider<T>;
-    wardenClient: WardenClient;
-    eventProcessor: WardenUserServiceEventProcessingProvider<T>;
-    loginCheckTimerPingSeconds?: number;
-    autoLoginHandlingThresholdSeconds?: number;
-    allowAutoRefresh?: boolean;
-    applicationName: string;
-    deviceLabelGenerator?: () => string;
-}
-
-declare class WardenUserService<T> {
-    private options;
-    private loggedInTimerSubscription;
-    private _autoRefreshEnabled;
-    constructor(options: WardenUserServiceOptions<T>);
-    cleanShutDown(): void;
-    get serviceOptions(): WardenUserServiceOptions<T>;
-    createAccount(contact: WardenContact, sendCode?: boolean, label?: string, tags?: string[]): Promise<string>;
-    addContactToLoggedInUser(contact: WardenContact): Promise<boolean>;
-    get autoRefreshEnabled(): boolean;
-    set autoRefreshEnabled(newValue: boolean);
-    checkForAutoLogoutOrRefresh(t: number): Promise<void>;
-    logout(): void;
-    fetchLoggedInUserWrapper(): WardenLoggedInUserWrapper<T>;
-    loggedInUserHasRole(role: string): boolean;
-    isLoggedIn(): boolean;
-    fetchLoggedInUserJwtObject(): WardenJwtToken<T>;
-    fetchLoggedInUserJwtToken(): string;
-    fetchLoggedInUserObject(): T;
-    fetchLoggedInUserExpirationEpochSeconds(): number;
-    fetchLoggedInUserRemainingSeconds(): number;
-    private updateLoggedInUserFromTokenString;
-    refreshToken(): Promise<WardenLoggedInUserWrapper<T>>;
-    sendExpiringCode(contact: WardenContact): Promise<boolean>;
-    private processWardenLoginResults;
-    private updateRecentLoginsFromWardenEntrySummary;
-    private updateRecentLoginsFromLoggedInUserWrapper;
-    executeWebAuthnBasedLogin(userId: string): Promise<WardenLoggedInUserWrapper<T>>;
-    removeWebAuthnRegistrationFromLoggedInUser(input: string): Promise<WardenEntrySummary>;
-    removeContactFromLoggedInUser(input: WardenContact): Promise<WardenEntrySummary>;
-    executeValidationTokenBasedLogin(contact: WardenContact, token: string, createUserIfMissing?: boolean): Promise<WardenLoggedInUserWrapper<T>>;
-    saveCurrentDeviceAsWebAuthnForCurrentUser(): Promise<WardenEntrySummary>;
-    private defaultDeviceLabelGenerator;
-    executeWebAuthnLoginToWardenLoginResults(userId: string): Promise<WardenLoginResults>;
-}
-
-declare abstract class WardenClientAbstractRecentLoginProvider implements WardenClientRecentLoginProvider {
-    abstract fetchCache(): WardenRecentLoginDescriptor[];
-    abstract updateCache(newValue: WardenRecentLoginDescriptor[]): any;
-    saveRecentLogin(entry: WardenEntrySummary): void;
-    saveNewUser(userId: string, label: string, contact: WardenContact): void;
-    removeUser(userId: string): void;
-    fetchAllLogins(): WardenRecentLoginDescriptor[];
-    clearAllLogins(): void;
-}
-
-declare class WardenClientLocalStorageLoggedInUserProvider<T> implements WardenLoggedInUserProvider<T> {
-    private localStorageKey;
-    constructor(localStorageKey: string);
-    fetchLoggedInUserWrapper(): WardenLoggedInUserWrapper<T>;
-    logOutUser(): void;
-    setLoggedInUserWrapper(wrapper: WardenLoggedInUserWrapper<T>): void;
-}
-
-declare class WardenClientLocalStorageRecentLoginProvider extends WardenClientAbstractRecentLoginProvider {
-    private localStorageKey;
-    constructor(localStorageKey: string);
-    fetchCache(): WardenRecentLoginDescriptor[];
-    updateCache(newValue: WardenRecentLoginDescriptor[]): void;
-}
-
-declare class WardenClientTransientMemoryLoggedInUserProvider<T> implements WardenLoggedInUserProvider<T> {
-    private wrapper;
-    fetchLoggedInUserWrapper(): WardenLoggedInUserWrapper<T>;
-    logOutUser(): void;
-    setLoggedInUserWrapper(wrapper: WardenLoggedInUserWrapper<T>): void;
-}
-
-declare class WardenClientTransientMemoryRecentLoginProvider extends WardenClientAbstractRecentLoginProvider {
-    private _cache;
-    fetchCache(): WardenRecentLoginDescriptor[];
-    updateCache(newValue: WardenRecentLoginDescriptor[]): void;
-}
-
-declare enum WardenCustomerMessageType {
-    ExpiringCode = "ExpiringCode",
-    MagicLink = "MagicLink",
-    Custom = "Custom"
-}
-
-declare enum WardenWebAuthnTransportFutureType {
-    ble = "ble",
-    internal = "internal",
-    nfc = "nfc",
-    usb = "usb",
-    cable = "cable",
-    hybrid = "hybrid"
-}
-
-interface WardenWebAuthnEntry {
-    origin: string;
-    applicationName: string;
-    deviceLabel: string;
-    credentialIdBase64: string;
-    credentialPublicKeyBase64: string;
-    counter: number;
-    credentialBackedUp: boolean;
-    credentialDeviceType: string;
-    transports?: WardenWebAuthnTransportFutureType[];
-}
-
-interface WardenEntry {
-    userId: string;
-    userLabel: string;
-    contactMethods: WardenContact[];
-    tags: string[];
-    webAuthnAuthenticators: WardenWebAuthnEntry[];
-    createdEpochMS: number;
-    updatedEpochMS: number;
-}
-
-declare enum WardenStoreRegistrationResponseType {
-    Verified = "Verified",
-    Failed = "Failed",
-    Error = "Error"
-}
-
-interface WardenStoreRegistrationResponse {
-    updatedEntry?: WardenEntry;
-    registrationResponseId: string;
-    result: WardenStoreRegistrationResponseType;
-    error?: string;
-}
-
-interface WardenTeamRole {
-    team: string;
-    role: string;
-}
-
-interface WardenUserDecoration<T> {
-    userTokenData: T;
-    userTokenExpirationSeconds: number;
-    userTeamRoles: WardenTeamRole[];
-}
-
-declare class WardenUtils {
-    constructor();
-    static extractContactsOfType(req: WardenEntry | WardenEntrySummary, type: WardenContactType): string[];
-    static validLoginRequest(req: WardenLoginRequest): boolean;
-    static stringToWardenContact(input: string): WardenContact;
-    static teamRolesToRoles(teamRoles: WardenTeamRole[]): string[];
-    static roleStringsToTeamRoles(roles: string[]): WardenTeamRole[];
-    static roleStringToTeamRole(role: string): WardenTeamRole;
-    static teamRoleToRoleString(tr: WardenTeamRole): string;
-    static stringToContactType(input: string): WardenContactType;
-    static validContact(contact: WardenContact): boolean;
-    static stringIsEmailAddress(value: string): boolean;
-    static stringIsPhoneNumber(value: string): boolean;
-    static stripWardenEntryToSummary(we: WardenEntry): WardenEntrySummary;
-    static stripWardenWebAuthnEntryToSummary(we: WardenWebAuthnEntry): WardenWebAuthnEntrySummary;
-    static wrapperIsExpired(value: WardenLoggedInUserWrapper<any>): boolean;
-}
-
-export { type AddWebAuthnRegistrationToLoggedInUser, type CreateAccount, RatchetWardenCommonInfo, type RemoveWebAuthnRegistration, type SendMagicLink, WardenClient, WardenClientAbstractRecentLoginProvider, type WardenClientCurrentLoggedInJwtTokenProvider, WardenClientLocalStorageLoggedInUserProvider, WardenClientLocalStorageRecentLoginProvider, type WardenClientRecentLoginProvider, WardenClientTransientMemoryLoggedInUserProvider, WardenClientTransientMemoryRecentLoginProvider, type WardenCommand, type WardenCommandExchangeProvider, type WardenCommandResponse, type WardenContact, type WardenContactLookup, WardenContactType, type WardenCustomTemplateDescriptor, WardenCustomerMessageType, WardenDelegatingCurrentUserProvidingUserServiceEventProcessingProvider, type WardenEntry, type WardenEntrySummary, type WardenJwtToken, type WardenLoggedInUserProvider, type WardenLoggedInUserWrapper, type WardenLoginRequest, type WardenLoginResults, type WardenRecentLoginDescriptor, type WardenStoreRegistrationResponse, WardenStoreRegistrationResponseType, type WardenTeamRole, type WardenUserDecoration, WardenUserService, type WardenUserServiceEventProcessingProvider, type WardenUserServiceOptions, WardenUtils, type WardenWebAuthnEntry, type WardenWebAuthnEntrySummary, WardenWebAuthnTransportFutureType, type WebAuthnObjectWrapper };