@rxstack/core/dist/kernel/interfaces.d.ts

RxStackCore

import { Request } from './models/request';
import { Response } from './models/response';
/**
 * Available http methods
 */
export type HttpMethod = 'HEAD' | 'GET' | 'PUT' | 'PATCH' | 'POST' | 'DELETE';
/**
 * Available transports
 */
export type Transport = 'HTTP' | 'SOCKET';
export interface BaseDefinition {
    name: string;
    handler: (request: Request) => Promise<Response>;
}
export interface HttpDefinition extends BaseDefinition {
    path: string;
    method: HttpMethod;
}
export interface WebSocketDefinition extends BaseDefinition {
}
export type TransportDefinition = HttpDefinition | WebSocketDefinition;
export interface UserInterface {
    username: string;
    password?: string;
    roles: string[];
}
export interface TokenInterface {
    getCredentials(): string;
    eraseCredentials(): void;
    getUsername(): string;
    getRoles(): string[];
    hasRole(role: string): boolean;
    getUser(): UserInterface;
    setUser(user: UserInterface): void;
    setAuthenticated(authenticated: boolean): void;
    isAuthenticated(): boolean;
    setFullyAuthenticated(fullyAuthenticated: boolean): void;
    isFullyAuthenticated(): boolean;
}