@casual-simulation/aux-records 3.0.16 → 3.0.18-alpha.2720826118

package/AuthController.d.ts

@@ -0,0 +1,306 @@
+import { AddressType, AuthStore } from './AuthStore';
+import { ServerError } from './Errors';
+import { AuthMessenger } from './AuthMessenger';
+/**
+ * The number of miliseconds that a login request should be valid for before expiration.
+ */
+export declare const LOGIN_REQUEST_LIFETIME_MS: number;
+/**
+ * The number of bytes that should be used for login request IDs.
+ */
+export declare const LOGIN_REQUEST_ID_BYTE_LENGTH = 16;
+/**
+ * The number of bytes that should be used for session IDs.
+ */
+export declare const SESSION_ID_BYTE_LENGTH = 16;
+/**
+ * The number of bytes that should be used for session secrets.
+ */
+export declare const SESSION_SECRET_BYTE_LENGTH = 16;
+/**
+ * The number of miliseconds that a login session should be valid for before expiration.
+ */
+export declare const SESSION_LIFETIME_MS: number;
+/**
+ * The error message that should be used for invalid_request error messages.
+ */
+export declare const INVALID_REQUEST_ERROR_MESSAGE = "The login request is invalid.";
+/**
+ * The maximum allowed number of attempts for completing a login request.
+ */
+export declare const MAX_LOGIN_REQUEST_ATTEMPTS = 5;
+/**
+ * The error message that should be used for invalid_key error messages.
+ */
+export declare const INVALID_KEY_ERROR_MESSAGE = "The session key is invalid.";
+/**
+ * Defines a class that is able to authenticate users.
+ */
+export declare class AuthController {
+    private _store;
+    private _messenger;
+    constructor(authStore: AuthStore, messenger: AuthMessenger);
+    requestLogin(request: LoginRequest): Promise<LoginRequestResult>;
+    completeLogin(request: CompleteLoginRequest): Promise<CompleteLoginResult>;
+    validateSessionKey(key: string): Promise<ValidateSessionKeyResult>;
+    revokeSession(request: RevokeSessionRequest): Promise<RevokeSessionResult>;
+    /**
+     * Attempts to revoke all the sessions for the specified user.
+     * @param request The request.
+     */
+    revokeAllSessions(request: RevokeAllSessionsRequest): Promise<RevokeAllSessionsResult>;
+    /**
+     * Attempts to replace the given session key with a new key.
+     * @param request The request.
+     */
+    replaceSession(request: ReplaceSessionRequest): Promise<ReplaceSessionResult>;
+    /**
+     * Lists all the sessions for a given user.
+     * @param request The request.
+     */
+    listSessions(request: ListSessionsRequest): Promise<ListSessionsResult>;
+}
+export interface LoginRequest {
+    /**
+     * The address that the login is for.
+     */
+    address: string;
+    /**
+     * The type of the address.
+     */
+    addressType: AddressType;
+    /**
+     * The IP address that the login is from.
+     */
+    ipAddress: string;
+}
+export declare type LoginRequestResult = LoginRequestSuccess | LoginRequestFailure;
+export interface LoginRequestSuccess {
+    success: true;
+    /**
+     * The ID of the user that the request is for.
+     */
+    userId: string;
+    /**
+     * The ID of the generated login request.
+     */
+    requestId: string;
+    /**
+     * The address that the login request is for.
+     */
+    address: string;
+    /**
+     * The type of the address.
+     */
+    addressType: AddressType;
+    /**
+     * The unix timestamp in miliseconds that the login request will expire at.
+     */
+    expireTimeMs: number;
+}
+export interface LoginRequestFailure {
+    success: false;
+    /**
+     * The error code for the failure.
+     */
+    errorCode: 'unacceptable_address' | 'unacceptable_address_type' | 'unacceptable_ip_address' | 'address_type_not_supported' | ServerError;
+    /**
+     * The error message for the failure.
+     */
+    errorMessage: string;
+}
+export interface CompleteLoginRequest {
+    /**
+     * The ID of the user that the login request is for.
+     */
+    userId: string;
+    /**
+     * The ID of the login request.
+     */
+    requestId: string;
+    /**
+     * The code that was sent to the address.
+     */
+    code: string;
+    /**
+     * The IP address that the request is coming from.
+     */
+    ipAddress: string;
+}
+export declare type CompleteLoginResult = CompleteLoginSuccess | CompleteLoginFailure;
+export interface CompleteLoginSuccess {
+    success: true;
+    /**
+     * The ID of the user that the session is for.
+     */
+    userId: string;
+    /**
+     * The secret key that provides access for the session.
+     */
+    sessionKey: string;
+    /**
+     * The unix timestamp in miliseconds that the session will expire at.
+     */
+    expireTimeMs: number;
+}
+export interface CompleteLoginFailure {
+    success: false;
+    /**
+     * The error code for the failure.
+     */
+    errorCode: 'unacceptable_user_id' | 'unacceptable_request_id' | 'unacceptable_code' | 'invalid_code' | 'unacceptable_ip_address' | 'invalid_request' | ServerError;
+    /**
+     * The error message for the failure.
+     */
+    errorMessage: string;
+}
+export declare type ValidateSessionKeyResult = ValidateSessionKeySuccess | ValidateSessionKeyFailure;
+export interface ValidateSessionKeySuccess {
+    success: true;
+    userId: string;
+    sessionId: string;
+    allSessionsRevokedTimeMs?: number;
+}
+export interface ValidateSessionKeyFailure {
+    success: false;
+    errorCode: 'unacceptable_session_key' | 'invalid_key' | 'session_expired' | ServerError;
+    errorMessage: string;
+}
+export interface RevokeSessionRequest {
+    /**
+     * The ID of the user whose session should be revoked.
+     */
+    userId: string;
+    /**
+     * The ID of the session that should be revoked.
+     */
+    sessionId: string;
+    /**
+     * The session key that should authenticate the request.
+     */
+    sessionKey: string;
+}
+export declare type RevokeSessionResult = RevokeSessionSuccess | RevokeSessionFailure;
+export interface RevokeSessionSuccess {
+    success: true;
+}
+export interface RevokeSessionFailure {
+    success: false;
+    errorCode: 'unacceptable_user_id' | 'unacceptable_session_id' | 'unacceptable_session_key' | 'invalid_key' | 'session_expired' | 'session_not_found' | 'session_already_revoked' | ServerError;
+    errorMessage: string;
+}
+export interface RevokeAllSessionsRequest {
+    /**
+     * The ID of the user whose sessions should be revoked.
+     */
+    userId: string;
+    /**
+     * The session key that should authenticate the request.
+     */
+    sessionKey: string;
+}
+export declare type RevokeAllSessionsResult = RevokeAllSessionsSuccess | RevokeAllSessionsFailure;
+export interface RevokeAllSessionsSuccess {
+    success: true;
+}
+export interface RevokeAllSessionsFailure {
+    success: false;
+    errorCode: 'unacceptable_user_id' | 'unacceptable_session_key' | 'invalid_key' | 'session_expired' | ServerError;
+    errorMessage: string;
+}
+export interface ListSessionsRequest {
+    /**
+     * The ID of the user whose sessions should be listed.
+     */
+    userId: string;
+    /**
+     * The expiration time that the listing should start after.
+     */
+    expireTimeMs?: number | null;
+    /**
+     * The key that should be used to authorize the request.
+     */
+    sessionKey: string;
+}
+export declare type ListSessionsResult = ListSessionsSuccess | ListSessionsFailure;
+export interface ListSessionsSuccess {
+    success: true;
+    /**
+     *
+     */
+    sessions: ListedSession[];
+}
+export interface ListSessionsFailure {
+    success: false;
+    errorCode: 'unacceptable_user_id' | 'unacceptable_expire_time' | 'unacceptable_session_key' | 'invalid_key' | 'session_expired' | ServerError;
+    errorMessage: string;
+}
+/**
+ * Defines an interface for a session that has been listed.
+ */
+export interface ListedSession {
+    /**
+     * The ID of the user that this session belongs to.
+     */
+    userId: string;
+    /**
+     * The ID of the session.
+     */
+    sessionId: string;
+    /**
+     * The unix time that the session was granted at.
+     */
+    grantedTimeMs: number;
+    /**
+     * The unix time that the session will expire at.
+     */
+    expireTimeMs: number;
+    /**
+     * The unix time that the session was revoked at.
+     */
+    revokeTimeMs: number;
+    /**
+     * The IP address that the session was granted to.
+     */
+    ipAddress: string;
+    /**
+     * Whether this session represents the session key that was used to access the session list.
+     */
+    currentSession: boolean;
+    /**
+     * The ID of the session that replaced this session.
+     */
+    nextSessionId: string;
+}
+export interface ReplaceSessionRequest {
+    /**
+     * The session key that should be replaced.
+     */
+    sessionKey: string;
+    /**
+     * The IP Address that is making this request.
+     */
+    ipAddress: string;
+}
+export declare type ReplaceSessionResult = ReplaceSessionSuccess | ReplaceSessionFailure;
+export interface ReplaceSessionSuccess {
+    success: true;
+    /**
+     * The ID of the user that the session is for.
+     */
+    userId: string;
+    /**
+     * The secret key that provides access for the session.
+     */
+    sessionKey: string;
+    /**
+     * The unix timestamp in miliseconds that the session will expire at.
+     */
+    expireTimeMs: number;
+}
+export interface ReplaceSessionFailure {
+    success: false;
+    errorCode: 'unacceptable_session_key' | 'unacceptable_ip_address' | ValidateSessionKeyFailure['errorCode'] | ServerError;
+    errorMessage: string;
+}
+//# sourceMappingURL=AuthController.d.ts.map