@medrunner/api-client 0.0.1-rc.1

package/README.md

@@ -0,0 +1,18 @@
+# Medrunner API Client
+This typescript library acts as a client for the Medrunner API.
+
+## Getting Started
+
+```ts
+import MedrunnerApiClient from "@medrunner/api-client";
+
+const apiConfig = {
+  baseUrl: "https://api.medrunner.space",
+  token: () => "MY_API_TOKEN",
+};
+
+const api = MedrunnerApiClient.buildClient(apiConfig);
+const self = await api.client.get();
+
+console.log(self)
+```

package/dist/index.d.ts

@@ -0,0 +1,444 @@
+import { Logger } from 'ts-log';
+import { HubConnection } from '@microsoft/signalr';
+
+type Func<T> = () => T;
+type AsyncProvider<T> = Func<Promise<T>>;
+type AsyncAction<T> = (arg: T) => Promise<void>;
+type HeaderProvider<T extends Headers = Headers> = AsyncProvider<T>;
+type Headers = {
+    [key: string]: unknown;
+};
+
+interface DbItem {
+    id: string;
+    created: string;
+    updated: string;
+}
+
+interface ApiToken extends DbItem {
+    userId: string;
+    name: string;
+    expirationDate?: number;
+    lastUsed?: string;
+}
+
+interface ApiResponse<T = unknown> {
+    success: boolean;
+    data?: T;
+    errorMessage?: string;
+    statusCode?: number;
+}
+
+interface TokenGrant {
+    accessToken: string;
+    refreshToken: string;
+}
+
+interface ApiConfig {
+    baseUrl: string;
+    accessToken?: string;
+    refreshToken?: string;
+}
+
+declare class TokenManager extends ApiEndpoint {
+    private readonly refreshCallback?;
+    private accessToken?;
+    private refreshToken?;
+    constructor(config: ApiConfig, refreshCallback?: AsyncAction<TokenGrant> | undefined, log?: Logger, headerProvider?: HeaderProvider);
+    protected endpoint(): string;
+    getAccessToken(): Promise<string | undefined>;
+    private fetchToken;
+    private static getJwtFromAccessToken;
+}
+
+declare abstract class ApiEndpoint {
+    readonly baseUrl: string;
+    readonly tokenManager: TokenManager;
+    protected readonly log?: Logger | undefined;
+    private readonly headerProvider?;
+    protected constructor(baseUrl: string, tokenManager: TokenManager, log?: Logger | undefined, headerProvider?: HeaderProvider | undefined);
+    protected abstract endpoint(): string;
+    protected endpointUrl(): string;
+    private headersForRequest;
+    protected getRequest<T = unknown>(endpoint: string, queryParams?: {
+        [key: string]: unknown;
+    }, noAuthentication?: boolean): Promise<ApiResponse<T>>;
+    protected postRequest<T = unknown>(endpoint: string, data?: unknown, noAuthentication?: boolean): Promise<ApiResponse<T>>;
+    protected putRequest<T = unknown>(endpoint: string, data?: unknown, noAuthentication?: boolean): Promise<ApiResponse<T>>;
+    protected patchRequest<T = unknown>(endpoint: string, data?: unknown, noAuthentication?: boolean): Promise<ApiResponse<T>>;
+    protected deleteRequest(endpoint: string, queryParams?: {
+        [key: string]: unknown;
+    }, noAuthentication?: boolean): Promise<ApiResponse>;
+    private makeRequestWithBody;
+    private makeRequestWithoutBody;
+    private buildUrl;
+    private makeRequest;
+}
+
+interface CreateApiTokenRequest {
+    name: string;
+    expirationDate?: Date;
+}
+
+interface SignOutRequest {
+    refreshToken: string;
+}
+
+declare class AuthEndpoint extends ApiEndpoint {
+    constructor(baseUrl: string, tokenManager: TokenManager, log?: Logger, headerProvider?: HeaderProvider);
+    protected endpoint(): string;
+    signOut(oldToken: SignOutRequest): Promise<ApiResponse>;
+    getApiTokens(): Promise<ApiResponse<ApiToken[]>>;
+    createApiToken(newToken: CreateApiTokenRequest): Promise<ApiResponse<string>>;
+    deleteApiToken(id: string): Promise<ApiResponse>;
+}
+
+interface ChatMessage extends DbItem {
+    emergencyId: string;
+    senderId: string;
+    messageSentTimestamp: number;
+    contents: string;
+}
+
+interface PaginatedResponse<T = unknown> {
+    data: T[];
+    paginationToken?: string;
+}
+
+interface ChatMessageRequest {
+    emergencyId: string;
+    contents: string;
+}
+
+declare class ChatMessageEndpoint extends ApiEndpoint {
+    constructor(baseUrl: string, tokenManager: TokenManager, log?: Logger, headerProvider?: HeaderProvider);
+    protected endpoint(): string;
+    getHistory(emergencyId: string, limit: number, paginationToken?: string): Promise<ApiResponse<PaginatedResponse<ChatMessage>>>;
+    sendMessage(message: ChatMessageRequest): Promise<ApiResponse<ChatMessage>>;
+}
+
+interface ClientHistory extends DbItem {
+    emergencyId: string;
+    clientId: string;
+    emergencyCreationTimestamp: string;
+}
+
+interface EmergencyStats {
+    success: number;
+    failed: number;
+    noContact: number;
+    refused: number;
+    aborted: number;
+    serverError: number;
+    canceled: number;
+}
+
+interface WritableDbItem extends DbItem {
+    updated: string;
+}
+
+interface Person extends WritableDbItem {
+    discordId: string;
+    rsiHandle?: string;
+    roles: UserRoles;
+    personType: PersonType;
+    active: boolean;
+    deactivationReason: AccountDeactivationReason;
+    clientStats: ClientStats;
+    activeEmergency?: string;
+    clientPortalPreferences: Record<string, unknown>;
+}
+declare enum UserRoles {
+    CLIENT = 1,
+    STAFF = 2,
+    DEVELOPER = 524288,
+    BOT = 1048576
+}
+declare enum PersonType {
+    CLIENT = 0,
+    STAFF = 1,
+    BOT = 2
+}
+declare enum AccountDeactivationReason {
+    NONE = 0,
+    CLIENT_DRIVEN_DELETION = 1,
+    TERMINATED = 2,
+    BLOCKED = 3
+}
+interface ClientStats {
+    missions: EmergencyStats;
+}
+
+declare class ClientEndpoint extends ApiEndpoint {
+    constructor(baseUrl: string, tokenManager: TokenManager, log?: Logger, headerProvider?: HeaderProvider);
+    protected endpoint(): string;
+    get(): Promise<ApiResponse<Person>>;
+    getHistory(limit: number, paginationToken?: string): Promise<ApiResponse<PaginatedResponse<ClientHistory>>>;
+    linkClient(rsiHandle: string): Promise<ApiResponse>;
+    setSettings(settings: Record<string, unknown>): Promise<ApiResponse<Record<string, unknown>>>;
+}
+
+declare enum CancellationReason {
+    NONE = 0,
+    OTHER = 1,
+    SUCCUMBED_TO_WOUNDS = 2,
+    SERVER_ERROR = 3,
+    RESPAWNED = 4,
+    RESCUED = 5
+}
+
+declare enum MissionStatus {
+    CREATED = 0,
+    RECEIVED = 1,
+    IN_PROGRESS = 2,
+    SUCCESS = 3,
+    FAILED = 4,
+    NO_CONTACT = 5,
+    CANCELED = 6,
+    REFUSED = 7,
+    ABORTED = 8,
+    SERVER_ERROR = 9
+}
+
+declare enum ResponseRating {
+    NONE = 0,
+    GOOD = 1,
+    BAD = 2
+}
+
+declare enum Class {
+    NONE = 0,
+    MEDIC = 1,
+    SECURITY = 2,
+    PILOT = 3,
+    LEAD = 4,
+    DISPATCH = 5,
+    DISPATCH_LEAD = 6,
+    DISPATCH_TRAINEE = 7,
+    DISPATCH_OBSERVER = 8,
+    QRF = 9,
+    LOGISTICS = 10
+}
+
+interface TeamMember {
+    discordId: string;
+    id: string;
+    rsiHandle?: string;
+    class: Class;
+    teamId?: string;
+}
+
+interface Team {
+    staff: TeamMember[];
+    dispatchers: TeamMember[];
+    allMembers: TeamMember[];
+    maxMembers: number;
+}
+
+declare enum ThreatLevel {
+    UNKNOWN = 0,
+    LOW = 1,
+    MEDIUM = 2,
+    HIGH = 3
+}
+
+interface Emergency extends WritableDbItem {
+    system: string;
+    subsystem: string;
+    tertiaryLocation?: string;
+    threatLevel: ThreatLevel;
+    remarks?: string;
+    clientRsiHandle: string;
+    clientDiscordId?: string;
+    clientId?: string;
+    subscriptionTier: string;
+    status: MissionStatus;
+    alertMessage?: MessageCache;
+    clientMessage?: MessageCache;
+    coordinationThread?: MessageCache;
+    afterActionReportMessage?: MessageCache;
+    interactionMessageId?: string;
+    respondingTeam: Team;
+    respondingTeams: RespondingTeam[];
+    creationTimestamp: number;
+    acceptedTimestamp?: number;
+    completionTimestamp?: number;
+    rating: ResponseRating;
+    ratingRemarks?: string;
+    test: boolean;
+    cancellationReason: CancellationReason;
+    refusalReason?: string;
+    origin: Origin;
+    clientData?: ClientData;
+    isComplete: boolean;
+    missionName?: string;
+    afterActionReport?: AfterActionReport;
+    submissionSource: SubmissionSource;
+}
+interface MessageCache {
+    id: string;
+    channelId: string;
+}
+interface ClientData {
+    rsiHandle: string;
+    rsiProfileLink: string;
+    gotClientData: boolean;
+    redactedOrgOnProfile: boolean;
+    reported: boolean;
+}
+interface AfterActionReport {
+    remarks?: string;
+    submitterStaffId: string;
+    servicesProvided: MissionServices;
+    suspectedTrap: boolean;
+    hasBeenEdited: boolean;
+    submittedOn: number;
+    editHistory: AfterActionReportEdit[];
+}
+interface AfterActionReportEdit {
+    editorStaffId: string;
+    editTime: number;
+}
+declare enum MissionServices {
+    NONE = 0,
+    PVE = 1,
+    PVP = 2,
+    REVIVED_HEALED = 4,
+    HEALED_IN_SHIP = 8,
+    EXTRACT_SAFE_ZONE = 16
+}
+declare enum Origin {
+    UNKNOWN = 0,
+    REPORT = 1,
+    BEACON = 2,
+    EVALUATION = 3
+}
+declare enum SubmissionSource {
+    UNKNOWN = 0,
+    API = 1,
+    BOT = 2
+}
+interface RespondingTeam {
+    id: string;
+    teamName: string;
+}
+
+interface CreateEmergencyRequest {
+    remarks?: string;
+    location: Location;
+    threatLevel: ThreatLevel;
+}
+interface Location {
+    system: string;
+    subsystem: string;
+    tertiaryLocation?: string;
+}
+
+interface LocationDetail {
+    name: string;
+    type: LocationType;
+    children: LocationDetail[];
+}
+declare enum LocationType {
+    UNKNOWN = 0,
+    SYSTEM = 1,
+    PLANET = 2,
+    MOON = 3
+}
+
+declare enum Level {
+    None = 0,
+    Tier1Section1 = 101,
+    Tier1Section2 = 102,
+    Tier1Section3 = 103,
+    Tier2Section1 = 201,
+    Tier2Section2 = 202,
+    Tier2Section3 = 203,
+    Tier3Section1 = 301,
+    Tier3Section2 = 302,
+    Tier3Section3 = 303,
+    Tier4Section1 = 401,
+    Tier4Section2 = 402,
+    Tier4Section3 = 403,
+    Tier5Section1 = 501,
+    Tier5Section2 = 502,
+    Tier5Section3 = 503,
+    Tier6Section1 = 601,
+    Tier6Section2 = 602,
+    Tier6Section3 = 603,
+    Tier7Section1 = 701,
+    Tier7Section2 = 702,
+    Tier7Section3 = 703,
+    Tier8Section1 = 801,
+    Tier8Section2 = 802,
+    Tier8Section3 = 803,
+    Tier9Section1 = 901,
+    Tier9Section2 = 902,
+    Tier9Section3 = 903,
+    Tier10Section1 = 1001,
+    Tier10Section2 = 1002,
+    Tier10Section3 = 1003
+}
+
+interface TeamDetailsResponse {
+    stats: ResponderDetails[];
+    aggregatedSuccessRate: number;
+}
+interface ResponderDetails {
+    id: string;
+    level: Level;
+    missionSuccessRate: number;
+    dispatchSuccessRate: number;
+}
+
+declare class EmergencyEndpoint extends ApiEndpoint {
+    constructor(baseUrl: string, tokenManager: TokenManager, log?: Logger | undefined, headerProvider?: HeaderProvider | undefined);
+    protected endpoint(): string;
+    getEmergency(id: string): Promise<ApiResponse<Emergency>>;
+    getEmergencies(ids: string[]): Promise<ApiResponse<Emergency[]>>;
+    createEmergency(newEmergency: CreateEmergencyRequest): Promise<ApiResponse<Emergency>>;
+    cancelEmergencyWithReason(id: string, reason: CancellationReason): Promise<ApiResponse>;
+    rateServices(id: string, rating: ResponseRating, remarks?: string): Promise<ApiResponse>;
+    teamDetails(id: string): Promise<ApiResponse<TeamDetailsResponse>>;
+    emergencyLocations(): Promise<ApiResponse<LocationDetail[]>>;
+}
+
+interface MedalInformation {
+    level: Level;
+    successfulMissions: number;
+}
+
+declare class StaffEndpoint extends ApiEndpoint {
+    constructor(baseUrl: string, tokenManager: TokenManager, log?: Logger, headerProvider?: HeaderProvider);
+    protected endpoint(): string;
+    medalsInformation(): Promise<ApiResponse<MedalInformation[]>>;
+}
+
+declare class WebsocketEndpoint extends ApiEndpoint {
+    constructor(baseUrl: string, tokenManager: TokenManager, log?: Logger | undefined, headerProvider?: HeaderProvider | undefined);
+    private websocketManager;
+    protected endpoint(): string;
+    initialize(): Promise<HubConnection>;
+}
+
+interface ApiClient<TEmergency extends EmergencyEndpoint = EmergencyEndpoint, TClient extends ClientEndpoint = ClientEndpoint, TStaff extends StaffEndpoint = StaffEndpoint, TChatMessage extends ChatMessageEndpoint = ChatMessageEndpoint, TAuth extends AuthEndpoint = AuthEndpoint, TWebsocket extends WebsocketEndpoint = WebsocketEndpoint> {
+    emergency: TEmergency;
+    client: TClient;
+    staff: TStaff;
+    chatMessage: TChatMessage;
+    auth: TAuth;
+    websocket: TWebsocket;
+}
+
+declare class MedrunnerApiClient<TEmergency extends EmergencyEndpoint = EmergencyEndpoint, TClient extends ClientEndpoint = ClientEndpoint, TStaff extends StaffEndpoint = StaffEndpoint, TChatMessage extends ChatMessageEndpoint = ChatMessageEndpoint, TAuth extends AuthEndpoint = AuthEndpoint, TWebsocket extends WebsocketEndpoint = WebsocketEndpoint> implements ApiClient<TEmergency, TClient, TStaff, TChatMessage, TAuth, TWebsocket> {
+    readonly emergency: TEmergency;
+    readonly client: TClient;
+    readonly staff: TStaff;
+    readonly chatMessage: TChatMessage;
+    readonly auth: TAuth;
+    readonly websocket: TWebsocket;
+    protected constructor(emergency: TEmergency, client: TClient, staff: TStaff, chatMessage: TChatMessage, auth: TAuth, websocket: TWebsocket);
+    static buildClient(config: ApiConfig, refreshCallback?: AsyncAction<TokenGrant>, log?: Logger): MedrunnerApiClient;
+}
+
+export { AccountDeactivationReason, AfterActionReport, AfterActionReportEdit, ApiClient, ApiConfig, ApiEndpoint, ApiResponse, ApiToken, AsyncAction, AsyncProvider, AuthEndpoint, CancellationReason, ChatMessage, ChatMessageEndpoint, ChatMessageRequest, Class, ClientData, ClientEndpoint, ClientHistory, ClientStats, CreateEmergencyRequest, DbItem, Emergency, EmergencyEndpoint, EmergencyStats, Func, HeaderProvider, Headers, Level, Location, LocationDetail, LocationType, MedalInformation, MedrunnerApiClient, MessageCache, MissionServices, MissionStatus, Origin, PaginatedResponse, Person, PersonType, ResponderDetails, RespondingTeam, ResponseRating, StaffEndpoint, SubmissionSource, Team, TeamDetailsResponse, TeamMember, ThreatLevel, TokenGrant, TokenManager, UserRoles, WebsocketEndpoint };