hischool.js 0.0.1

package/lib/esm/Client.js

@@ -0,0 +1,214 @@
+import { API } from "./api";
+import { AccountCollection } from "./collections/AccountCollection.js";
+import { BotCollection, ChannelCollection, ChannelUnreadCollection, ChannelWebhookCollection, EmojiCollection, MessageCollection, ServerCollection, ServerMemberCollection, SessionCollection, UserCollection, } from "./collections/index.js";
+import { ConnectionState, EventClient, handleEventV1, } from "./events/index.js";
+import { RE_CHANNELS, RE_MENTIONS, RE_SPOILER } from "./lib/regex.js";
+import EventEmitter from "eventemitter3";
+import { batch, createSignal } from "solid-js";
+/**
+ * Hischool.js Clients
+ */
+export class Client extends EventEmitter {
+    account;
+    bots;
+    channels;
+    channelUnreads;
+    channelWebhooks;
+    emojis;
+    messages;
+    servers;
+    serverMembers;
+    sessions;
+    users;
+    api;
+    options;
+    events;
+    configuration;
+    #session;
+    user;
+    ready;
+    #setReady;
+    connectionFailureCount;
+    #setConnectionFailureCount;
+    #reconnectTimeout;
+    /**
+     * Create Hischool.js Client
+     */
+    constructor(options, configuration) {
+        super();
+        this.options = {
+            baseURL: "https://api.hischool.mn",
+            partials: false,
+            eagerFetching: true,
+            syncUnreads: false,
+            autoReconnect: true,
+            messageRewrites: true,
+            /**
+             * Retry delay function
+             * @param retryCount Count
+             * @returns Delay in seconds
+             */
+            retryDelayFunction(retryCount) {
+                return (Math.pow(2, retryCount) - 1) * (0.8 + Math.random() * 0.4);
+            },
+            /**
+             * Check whether a channel is muted
+             * @param channel Channel
+             * @return Whether it is muted
+             */
+            channelIsMuted() {
+                return false;
+            },
+            ...options,
+        };
+        this.configuration = configuration;
+        this.api = new API({
+            baseURL: this.options.baseURL,
+        });
+        const [ready, setReady] = createSignal(false);
+        this.ready = ready;
+        this.#setReady = setReady;
+        const [connectionFailureCount, setConnectionFailureCount] = createSignal(0);
+        this.connectionFailureCount = connectionFailureCount;
+        this.#setConnectionFailureCount = setConnectionFailureCount;
+        this.account = new AccountCollection(this);
+        this.bots = new BotCollection(this);
+        this.channels = new ChannelCollection(this);
+        this.channelUnreads = new ChannelUnreadCollection(this);
+        this.channelWebhooks = new ChannelWebhookCollection(this);
+        this.emojis = new EmojiCollection(this);
+        this.messages = new MessageCollection(this);
+        this.servers = new ServerCollection(this);
+        this.serverMembers = new ServerMemberCollection(this);
+        this.sessions = new SessionCollection(this);
+        this.users = new UserCollection(this);
+        this.events = new EventClient(1, "json", this.options);
+        this.events.on("error", (error) => this.emit("error", error));
+        this.events.on("state", (state) => {
+            switch (state) {
+                case ConnectionState.Connected:
+                    batch(() => {
+                        this.servers.forEach((server) => server.resetSyncStatus());
+                        this.#setConnectionFailureCount(0);
+                        this.emit("connected");
+                    });
+                    break;
+                case ConnectionState.Connecting:
+                    this.emit("connecting");
+                    break;
+                case ConnectionState.Disconnected:
+                    this.emit("disconnected");
+                    if (this.options.autoReconnect) {
+                        this.#reconnectTimeout = setTimeout(() => this.connect(), this.options.retryDelayFunction(this.connectionFailureCount()) *
+                            1e3);
+                        this.#setConnectionFailureCount((count) => count + 1);
+                    }
+                    break;
+            }
+        });
+        this.events.on("event", (event) => handleEventV1(this, event, this.#setReady));
+    }
+    /**
+     * Current session id
+     */
+    get sessionId() {
+        return typeof this.#session === "string" ? undefined : this.#session?._id;
+    }
+    /**
+     * Connect to Hischool
+     */
+    connect() {
+        clearTimeout(this.#reconnectTimeout);
+        this.events.disconnect();
+        this.#setReady(false);
+        this.events.connect(this.configuration?.ws ?? "wss://ws.hischool.mn", typeof this.#session === "string" ? this.#session : this.#session.token);
+    }
+    /**
+     * Fetches the configuration of the server if it has not been already fetched.
+     */
+    async #fetchConfiguration() {
+        if (!this.configuration) {
+            this.configuration = await this.api.get("/");
+        }
+    }
+    /**
+     * Update API object to use authentication.
+     */
+    #updateHeaders() {
+        this.api = new API({
+            baseURL: this.options.baseURL,
+            authentication: {
+                hischool: this.#session,
+            },
+        });
+    }
+    /**
+     * Log in with auth data, creating a new session in the process.
+     * @param details Login data object
+     * @returns An on-boarding function if on-boarding is required, undefined otherwise
+     */
+    async login(details) {
+        await this.#fetchConfiguration();
+        const data = await this.api.post("/auth/session/login", details);
+        if (data.result === "Success") {
+            this.#session = data;
+            // TODO: return await this.connect();
+        }
+        else {
+            throw "MFA not implemented!";
+        }
+    }
+    /**
+     * Use an existing session
+     */
+    async useExistingSession(session) {
+        this.#session = session;
+        this.#updateHeaders();
+    }
+    /**
+     * Log in as a bot
+     * @param token Bot token
+     */
+    async loginBot(token) {
+        await this.#fetchConfiguration();
+        this.#session = token;
+        this.#updateHeaders();
+        this.connect();
+    }
+    /**
+     * Prepare a markdown-based message to be displayed to the user as plain text.
+     * @param source Source markdown text
+     * @returns Modified plain text
+     */
+    markdownToText(source) {
+        return source
+            .replace(RE_MENTIONS, (sub, id) => {
+            const user = this.users.get(id);
+            if (user) {
+                return `@${user.username}`;
+            }
+            return sub;
+        })
+            .replace(RE_CHANNELS, (sub, id) => {
+            const channel = this.channels.get(id);
+            if (channel) {
+                return `#${channel.displayName}`;
+            }
+            return sub;
+        })
+            .replace(RE_SPOILER, "<spoiler>");
+    }
+    /**
+     * Proxy a file through January.
+     * @param url URL to proxy
+     * @returns Proxied media URL
+     */
+    proxyFile(url) {
+        if (this.configuration?.features.january.enabled) {
+            return `${this.configuration.features.january.url}/proxy?url=${encodeURIComponent(url)}`;
+        }
+        else {
+            return url;
+        }
+    }
+}

package/lib/esm/api/baseURL.d.ts

@@ -0,0 +1,2 @@
+export declare const defaultBaseURL = "https://api.hischool.mn";
+//# sourceMappingURL=baseURL.d.ts.map

package/lib/esm/api/baseURL.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseURL.d.ts","sourceRoot":"","sources":["../../../src/api/baseURL.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,cAAc,4BAA4B,CAAC"}

package/lib/esm/api/baseURL.js

@@ -0,0 +1,2 @@
+// API Base URL
+export const defaultBaseURL = "https://api.hischool.mn";

package/lib/esm/api/index.d.ts

@@ -0,0 +1,177 @@
+import type { APIRoutes } from "./routes";
+import type { AxiosRequestConfig } from "axios";
+export * from "./types";
+type Methods = APIRoutes["method"];
+type PickRoutes<Method extends Methods> = APIRoutes & {
+    method: Method;
+};
+type GetRoutes = PickRoutes<"get">;
+type PatchRoutes = PickRoutes<"patch">;
+type PutRoutes = PickRoutes<"put">;
+type DeleteRoutes = PickRoutes<"delete">;
+type PostRoutes = PickRoutes<"post">;
+type Count<Str extends string, SubStr extends string, Matches extends null[] = []> = Str extends `${infer _}${SubStr}${infer After}` ? Count<After, SubStr, [...Matches, null]> : Matches["length"];
+/**
+ * Get the specific path name of any given path.
+ * @param anyPath Any path
+ * @returns Specific path
+ */
+export declare function getPathName(anyPath: string): string | undefined;
+/**
+ * Client configuration options
+ */
+export interface Options {
+    /**
+     * Base URL of the Hischool node
+     */
+    baseURL: string;
+    /**
+     * Authentication used for requests
+     */
+    authentication: {
+        rauth?: string | undefined;
+        hischool?: {
+            token: string;
+        } | string | undefined;
+    };
+}
+/**
+ * API Client
+ */
+export declare class API {
+    private baseURL;
+    private authentication;
+    constructor({ baseURL, authentication }?: Partial<Options>);
+    /**
+     * Generate authentication options.
+     */
+    get auth(): AxiosRequestConfig;
+    /**
+     * Generate config to pass through to API.
+     */
+    get config(): AxiosRequestConfig;
+    /**
+     * Send any arbitrary request.
+     * @param method HTTP Method
+     * @param path Path
+     * @param params Body or Query Parameters
+     * @param config Axios configuration
+     * @returns Typed Response Data
+     */
+    req<Method extends Methods, Routes extends PickRoutes<Method>, Path extends Routes["path"], Route extends Routes & {
+        path: Path;
+        parts: Count<Path, "/">;
+    }>(method: Method, path: Path, params: Route["params"], config?: AxiosRequestConfig): Promise<Route["response"]>;
+    /**
+     * Send HTTP GET request.
+     * @param path Path
+     * @param params Body or Query Parameters
+     * @param config Axios configuration
+     * @returns Typed Response Data
+     */
+    get<Path extends GetRoutes["path"], Route extends GetRoutes & {
+        path: Path;
+        parts: Count<Path, "/">;
+    }>(path: Path, params: Route["params"], config?: AxiosRequestConfig): Promise<Route["response"]>;
+    /**
+     * Send HTTP GET request.
+     * @param path Path
+     * @returns Typed Response Data
+     */
+    get<Path extends (GetRoutes & {
+        params: undefined;
+    })["path"], Route extends GetRoutes & {
+        path: Path;
+        parts: Count<Path, "/">;
+    }>(path: Path): Promise<Route["response"]>;
+    /**
+     * Send HTTP PATCH request.
+     * @param path Path
+     * @param params Body or Query Parameters
+     * @param config Axios configuration
+     * @returns Typed Response Data
+     */
+    patch<Path extends PatchRoutes["path"], Route extends PatchRoutes & {
+        path: Path;
+        parts: Count<Path, "/">;
+    }>(path: Path, params: Route["params"], config?: AxiosRequestConfig): Promise<Route["response"]>;
+    /**
+     * Send HTTP PATCH request.
+     * @param path Path
+     * @returns Typed Response Data
+     */
+    patch<Path extends (PatchRoutes & {
+        params: undefined;
+    })["path"], Route extends PatchRoutes & {
+        path: Path;
+        parts: Count<Path, "/">;
+    }>(path: Path): Promise<Route["response"]>;
+    /**
+     * Send HTTP PUT request.
+     * @param path Path
+     * @param params Body or Query Parameters
+     * @param config Axios configuration
+     * @returns Typed Response Data
+     */
+    put<Path extends PutRoutes["path"], Route extends PutRoutes & {
+        path: Path;
+        parts: Count<Path, "/">;
+    }>(path: Path, params: Route["params"], config?: AxiosRequestConfig): Promise<Route["response"]>;
+    /**
+     * Send HTTP PUT request.
+     * @param path Path
+     * @returns Typed Response Data
+     */
+    put<Path extends (PutRoutes & {
+        params: undefined;
+    })["path"], Route extends PutRoutes & {
+        path: Path;
+        parts: Count<Path, "/">;
+    }>(path: Path): Promise<Route["response"]>;
+    /**
+     * Send HTTP DELETE request.
+     * @param path Path
+     * @param params Body or Query Parameters
+     * @param config Axios configuration
+     * @returns Typed Response Data
+     */
+    delete<Path extends DeleteRoutes["path"], Route extends DeleteRoutes & {
+        path: Path;
+        parts: Count<Path, "/">;
+    }>(path: Path, params?: any, config?: AxiosRequestConfig): Promise<Route["response"]>;
+    /**
+     * Send HTTP DELETE request.
+     * @param path Path
+     * @param params Body or Query Parameters
+     * @returns Typed Response Data
+     */
+    delete<Path extends (DeleteRoutes & {
+        params: undefined;
+    })["path"], Route extends DeleteRoutes & {
+        path: Path;
+        parts: Count<Path, "/">;
+    }>(path: Path, params?: any): Promise<Route["response"]>;
+    /**
+     * Send HTTP POST request.
+     * @param path Path
+     * @param params Body or Query Parameters
+     * @param config Axios configuration
+     * @returns Typed Response Data
+     */
+    post<Path extends PostRoutes["path"], Route extends PostRoutes & {
+        path: Path;
+        parts: Count<Path, "/">;
+    }>(path: Path, params: Route["params"], config?: AxiosRequestConfig): Promise<Route["response"]>;
+    /**
+     * Send HTTP POST request.
+     * @param path Path
+     * @returns Typed Response Data
+     */
+    post<Path extends (PostRoutes & {
+        params: undefined;
+    })["path"], Route extends PostRoutes & {
+        path: Path;
+        parts: Count<Path, "/">;
+    }>(path: Path): Promise<Route["response"]>;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/esm/api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAE1C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAGhD,cAAc,SAAS,CAAC;AAExB,KAAK,OAAO,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;AACnC,KAAK,UAAU,CAAC,MAAM,SAAS,OAAO,IAAI,SAAS,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAEzE,KAAK,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;AACnC,KAAK,WAAW,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;AACvC,KAAK,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;AACnC,KAAK,YAAY,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;AACzC,KAAK,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;AAErC,KAAK,KAAK,CACR,GAAG,SAAS,MAAM,EAClB,MAAM,SAAS,MAAM,EACrB,OAAO,SAAS,IAAI,EAAE,GAAG,EAAE,IACzB,GAAG,SAAS,GAAG,MAAM,CAAC,GAAG,MAAM,GAAG,MAAM,KAAK,EAAE,GAC/C,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC,GAAG,OAAO,EAAE,IAAI,CAAC,CAAC,GACxC,OAAO,CAAC,QAAQ,CAAC,CAAC;AAEtB;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,sBAmB1C;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,cAAc,EAAE;QACd,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC3B,QAAQ,CAAC,EAAE;YAAE,KAAK,EAAE,MAAM,CAAA;SAAE,GAAG,MAAM,GAAG,SAAS,CAAC;KACnD,CAAC;CACH;AAED;;GAEG;AACH,qBAAa,GAAG;IACd,OAAO,CAAC,OAAO,CAAqB;IACpC,OAAO,CAAC,cAAc,CAA4B;gBAEtC,EAAE,OAAO,EAAE,cAAc,EAAE,GAAE,OAAO,CAAC,OAAO,CAAM;IAK9D;;OAEG;IACH,IAAI,IAAI,IAAI,kBAAkB,CA6B7B;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,kBAAkB,CAK/B;IAED;;;;;;;OAOG;IACH,GAAG,CACD,MAAM,SAAS,OAAO,EACtB,MAAM,SAAS,UAAU,CAAC,MAAM,CAAC,EACjC,IAAI,SAAS,MAAM,CAAC,MAAM,CAAC,EAC3B,KAAK,SAAS,MAAM,GAAG;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;KAAE,EAE9D,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,EACvB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAwC7B;;;;;;OAMG;IACH,GAAG,CACD,IAAI,SAAS,SAAS,CAAC,MAAM,CAAC,EAC9B,KAAK,SAAS,SAAS,GAAG;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;KAAE,EAEjE,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,EACvB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAE7B;;;;OAIG;IACH,GAAG,CACD,IAAI,SAAS,CAAC,SAAS,GAAG;QAAE,MAAM,EAAE,SAAS,CAAA;KAAE,CAAC,CAAC,MAAM,CAAC,EACxD,KAAK,SAAS,SAAS,GAAG;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;KAAE,EACjE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAOzC;;;;;;OAMG;IACH,KAAK,CACH,IAAI,SAAS,WAAW,CAAC,MAAM,CAAC,EAChC,KAAK,SAAS,WAAW,GAAG;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;KAAE,EAEnE,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,EACvB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAE7B;;;;OAIG;IACH,KAAK,CACH,IAAI,SAAS,CAAC,WAAW,GAAG;QAAE,MAAM,EAAE,SAAS,CAAA;KAAE,CAAC,CAAC,MAAM,CAAC,EAC1D,KAAK,SAAS,WAAW,GAAG;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;KAAE,EACnE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAOzC;;;;;;OAMG;IACH,GAAG,CACD,IAAI,SAAS,SAAS,CAAC,MAAM,CAAC,EAC9B,KAAK,SAAS,SAAS,GAAG;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;KAAE,EAEjE,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,EACvB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAE7B;;;;OAIG;IACH,GAAG,CACD,IAAI,SAAS,CAAC,SAAS,GAAG;QAAE,MAAM,EAAE,SAAS,CAAA;KAAE,CAAC,CAAC,MAAM,CAAC,EACxD,KAAK,SAAS,SAAS,GAAG;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;KAAE,EACjE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAOzC;;;;;;OAMG;IACH,MAAM,CACJ,IAAI,SAAS,YAAY,CAAC,MAAM,CAAC,EACjC,KAAK,SAAS,YAAY,GAAG;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;KAAE,EAEpE,IAAI,EAAE,IAAI,EACV,MAAM,CAAC,EAAE,GAAG,EACZ,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAE7B;;;;;OAKG;IACH,MAAM,CACJ,IAAI,SAAS,CAAC,YAAY,GAAG;QAAE,MAAM,EAAE,SAAS,CAAA;KAAE,CAAC,CAAC,MAAM,CAAC,EAC3D,KAAK,SAAS,YAAY,GAAG;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;KAAE,EACpE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAOvD;;;;;;OAMG;IACH,IAAI,CACF,IAAI,SAAS,UAAU,CAAC,MAAM,CAAC,EAC/B,KAAK,SAAS,UAAU,GAAG;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;KAAE,EAElE,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,EACvB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAE7B;;;;OAIG;IACH,IAAI,CACF,IAAI,SAAS,CAAC,UAAU,GAAG;QAAE,MAAM,EAAE,SAAS,CAAA;KAAE,CAAC,CAAC,MAAM,CAAC,EACzD,KAAK,SAAS,UAAU,GAAG;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;KAAE,EAClE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;CAM1C"}

package/lib/esm/api/index.js

@@ -0,0 +1,139 @@
+// API
+import { defaultBaseURL } from "./baseURL";
+import { pathResolve, queryParams } from "./params";
+import Axios from "axios";
+import defaultsDeep from "lodash.defaultsdeep";
+export * from "./types";
+/**
+ * Get the specific path name of any given path.
+ * @param anyPath Any path
+ * @returns Specific path
+ */
+export function getPathName(anyPath) {
+    const segments = anyPath.split("/");
+    const list = pathResolve[(segments.length - 1).toString()] || [];
+    for (const entry of list) {
+        let i = 1;
+        let copy = [...segments];
+        for (i; i < segments.length; i++) {
+            if (Array.isArray(entry[i - 1])) {
+                copy[i] = entry[i - 1];
+                continue;
+            }
+            else if (entry[i - 1] !== segments[i])
+                break;
+        }
+        if (i === segments.length)
+            return copy.join("/");
+    }
+}
+/**
+ * API Client
+ */
+export class API {
+    baseURL;
+    authentication;
+    constructor({ baseURL, authentication } = {}) {
+        this.baseURL = baseURL || defaultBaseURL;
+        this.authentication = authentication || {};
+    }
+    /**
+     * Generate authentication options.
+     */
+    get auth() {
+        if (this.authentication.rauth) {
+            if (typeof this.authentication.rauth === "string") {
+                return {
+                    headers: {
+                        "X-Session-Token": this.authentication.rauth,
+                    },
+                };
+            }
+        }
+        else if (this.authentication.hischool) {
+            switch (typeof this.authentication.hischool) {
+                case "string": {
+                    return {
+                        headers: {
+                            "X-Bot-Token": this.authentication.hischool,
+                        },
+                    };
+                }
+                case "object": {
+                    return {
+                        headers: {
+                            "X-Session-Token": this.authentication.hischool.token,
+                        },
+                    };
+                }
+            }
+        }
+        return {};
+    }
+    /**
+     * Generate config to pass through to API.
+     */
+    get config() {
+        return {
+            baseURL: this.baseURL,
+            ...this.auth,
+        };
+    }
+    /**
+     * Send any arbitrary request.
+     * @param method HTTP Method
+     * @param path Path
+     * @param params Body or Query Parameters
+     * @param config Axios configuration
+     * @returns Typed Response Data
+     */
+    req(method, path, params, config) {
+        let query, body;
+        let named = getPathName(path);
+        // If we are aware of this route, then match the parameters given.
+        if (named && typeof params === "object") {
+            const route = queryParams[named];
+            const allowed_query = route[method];
+            // Map each parameter to the correct object.
+            for (const parameter of Object.keys(params)) {
+                if (allowed_query?.includes(parameter)) {
+                    query = {
+                        ...(query || {}),
+                        [parameter]: params[parameter],
+                    };
+                }
+                else {
+                    body = {
+                        ...(body || {}),
+                        [parameter]: params[parameter],
+                    };
+                }
+            }
+        }
+        return Axios(path, defaultsDeep({
+            method,
+            params: query,
+            data: body,
+        }, defaultsDeep(config, this.config))).then((res) => res.data);
+    }
+    get(path, params, config) {
+        // @ts-ignore-next-line
+        return this.req("get", path, params, config);
+    }
+    patch(path, params, config) {
+        // @ts-ignore-next-line
+        return this.req("patch", path, params, config);
+    }
+    put(path, params, config) {
+        // @ts-ignore-next-line
+        return this.req("put", path, params, config);
+    }
+    delete(path, params, config) {
+        // @ts-ignore-next-line
+        return this.req("delete", path, params, config);
+    }
+    post(path, params, config) {
+        // @ts-ignore-next-line
+        return this.req("post", path, params, config);
+    }
+}