hischool.js 0.0.1

package/README.md

@@ -0,0 +1,41 @@
+# hischool.js
+
+**hischool.js** is a JavaScript (TypeScript) library for interacting with Hischool.
+
+## Example Usage
+
+```javascript
+// esm / typescript
+import { Client } from "hischool.js";
+// ...or commonjs
+const { Client } = require("hischool.js");
+
+let client = new Client();
+
+client.on("ready", async () =>
+  console.info(`Logged in as ${client.user.username}!`)
+);
+
+client.on("messageCreate", async (message) => {
+  if (message.content === "hello") {
+    message.channel.sendMessage("world");
+  }
+});
+
+client.loginBot("..");
+```
+
+## Reactivity with Signals & Solid.js Primitives
+
+All objects have reactivity built-in and can be dropped straight into any Solid.js project.
+
+```tsx
+const client = new Client();
+// initialise the client
+
+function MyApp() {
+  return (
+    <h1>Your username is: {client.user?.username ?? "[logging in...]"}</h1>
+  );
+}
+```

package/lib/cjs/Client.d.ts

@@ -0,0 +1,166 @@
+import type { DataLogin, HischoolConfig } from "./api";
+import { API, Role } from "./api";
+import { Channel, Emoji, Message, Server, ServerMember, User } from "./classes/index.js";
+import { AccountCollection } from "./collections/AccountCollection.js";
+import { BotCollection, ChannelCollection, ChannelUnreadCollection, ChannelWebhookCollection, EmojiCollection, MessageCollection, ServerCollection, ServerMemberCollection, SessionCollection, UserCollection } from "./collections/index.js";
+import { EventClient, EventClientOptions } from "./events/index.js";
+import { HydratedChannel, HydratedEmoji, HydratedMessage, HydratedServer, HydratedServerMember, HydratedUser } from "./hydration/index.js";
+import EventEmitter from "eventemitter3";
+import { Accessor } from "solid-js";
+export type Session = {
+    _id: string;
+    token: string;
+    user_id: string;
+} | string;
+/**
+ * Events provided by the client
+ */
+export type Events = {
+    error(error: Error): void;
+    connected(): void;
+    connecting(): void;
+    disconnected(): void;
+    ready(): void;
+    logout(): void;
+    messageCreate(message: Message): void;
+    messageUpdate(message: Message, previousMessage: HydratedMessage): void;
+    messageDelete(message: HydratedMessage): void;
+    messageDeleteBulk(messages: HydratedMessage[], channel?: Channel): void;
+    messageReactionAdd(message: Message, userId: string, emoji: string): void;
+    messageReactionRemove(message: Message, userId: string, emoji: string): void;
+    messageReactionRemoveEmoji(message: Message, emoji: string): void;
+    channelCreate(channel: Channel): void;
+    channelUpdate(channel: Channel, previousChannel: HydratedChannel): void;
+    channelDelete(channel: HydratedChannel): void;
+    channelGroupJoin(channel: Channel, user: User): void;
+    channelGroupLeave(channel: Channel, user?: User): void;
+    channelStartTyping(channel: Channel, user?: User): void;
+    channelStopTyping(channel: Channel, user?: User): void;
+    channelAcknowledged(channel: Channel, messageId: string): void;
+    serverCreate(server: Server): void;
+    serverUpdate(server: Server, previousServer: HydratedServer): void;
+    serverDelete(server: HydratedServer): void;
+    serverLeave(server: HydratedServer): void;
+    serverRoleUpdate(server: Server, roleId: string, previousRole: Role): void;
+    serverRoleDelete(server: Server, roleId: string, role: Role): void;
+    serverMemberUpdate(member: ServerMember, previousMember: HydratedServerMember): void;
+    serverMemberJoin(member: ServerMember): void;
+    serverMemberLeave(member: HydratedServerMember): void;
+    userUpdate(user: User, previousUser: HydratedUser): void;
+    userSettingsUpdate(id: string, update: Record<string, [number, string]>): void;
+    emojiCreate(emoji: Emoji): void;
+    emojiDelete(emoji: HydratedEmoji): void;
+};
+/**
+ * Client options object
+ */
+export type ClientOptions = Partial<EventClientOptions> & {
+    /**
+     * Base URL of the API server
+     */
+    baseURL: string;
+    /**
+     * Whether to allow partial objects to emit from events
+     * @default false
+     */
+    partials: boolean;
+    /**
+     * Whether to eagerly fetch users and members for incoming events
+     * @default true
+     * @deprecated
+     */
+    eagerFetching: boolean;
+    /**
+     * Whether to automatically sync unreads information
+     * @default false
+     */
+    syncUnreads: boolean;
+    /**
+     * Whether to reconnect when disconnected
+     * @default true
+     */
+    autoReconnect: boolean;
+    /**
+     * Whether to rewrite sent messages that include identifiers such as @silent
+     * @default true
+     */
+    messageRewrites: boolean;
+    /**
+     * Retry delay function
+     * @param retryCount Count
+     * @returns Delay in seconds
+     * @default (2^x-1) ±20%
+     */
+    retryDelayFunction(retryCount: number): number;
+    /**
+     * Check whether a channel is muted
+     * @param channel Channel
+     * @return Whether it is muted
+     * @default false
+     */
+    channelIsMuted(channel: Channel): boolean;
+};
+/**
+ * Hischool.js Clients
+ */
+export declare class Client extends EventEmitter<Events> {
+    #private;
+    readonly account: AccountCollection;
+    readonly bots: BotCollection;
+    readonly channels: ChannelCollection;
+    readonly channelUnreads: ChannelUnreadCollection;
+    readonly channelWebhooks: ChannelWebhookCollection;
+    readonly emojis: EmojiCollection;
+    readonly messages: MessageCollection;
+    readonly servers: ServerCollection;
+    readonly serverMembers: ServerMemberCollection;
+    readonly sessions: SessionCollection;
+    readonly users: UserCollection;
+    readonly api: API;
+    readonly options: ClientOptions;
+    readonly events: EventClient<1>;
+    configuration: HischoolConfig | undefined;
+    user: User | undefined;
+    readonly ready: Accessor<boolean>;
+    readonly connectionFailureCount: Accessor<number>;
+    /**
+     * Create Hischool.js Client
+     */
+    constructor(options?: Partial<ClientOptions>, configuration?: HischoolConfig);
+    /**
+     * Current session id
+     */
+    get sessionId(): string | undefined;
+    /**
+     * Connect to Hischool
+     */
+    connect(): void;
+    /**
+     * 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
+     */
+    login(details: DataLogin): Promise<void>;
+    /**
+     * Use an existing session
+     */
+    useExistingSession(session: Session): Promise<void>;
+    /**
+     * Log in as a bot
+     * @param token Bot token
+     */
+    loginBot(token: string): Promise<void>;
+    /**
+     * 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: string): string;
+    /**
+     * Proxy a file through January.
+     * @param url URL to proxy
+     * @returns Proxied media URL
+     */
+    proxyFile(url: string): string | undefined;
+}
+//# sourceMappingURL=Client.d.ts.map

package/lib/cjs/Client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Client.d.ts","sourceRoot":"","sources":["../../src/Client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACvD,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,EACL,OAAO,EACP,KAAK,EACL,OAAO,EACP,MAAM,EACN,YAAY,EACZ,IAAI,EACL,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,uBAAuB,EACvB,wBAAwB,EACxB,eAAe,EACf,iBAAiB,EACjB,gBAAgB,EAChB,sBAAsB,EACtB,iBAAiB,EACjB,cAAc,EACf,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAEL,WAAW,EACX,kBAAkB,EAEnB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,eAAe,EACf,aAAa,EACb,eAAe,EACf,cAAc,EACd,oBAAoB,EACpB,YAAY,EACb,MAAM,sBAAsB,CAAC;AAE9B,OAAO,YAAY,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,QAAQ,EAA+B,MAAM,UAAU,CAAC;AAEjE,MAAM,MAAM,OAAO,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IAEnB,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IAE1B,SAAS,IAAI,IAAI,CAAC;IAClB,UAAU,IAAI,IAAI,CAAC;IACnB,YAAY,IAAI,IAAI,CAAC;IACrB,KAAK,IAAI,IAAI,CAAC;IACd,MAAM,IAAI,IAAI,CAAC;IAEf,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACtC,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,eAAe,GAAG,IAAI,CAAC;IACxE,aAAa,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI,CAAC;IAC9C,iBAAiB,CAAC,QAAQ,EAAE,eAAe,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACxE,kBAAkB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1E,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7E,0BAA0B,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAElE,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACtC,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,eAAe,GAAG,IAAI,CAAC;IACxE,aAAa,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI,CAAC;IAC9C,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IACrD,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACvD,kBAAkB,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACxD,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACvD,mBAAmB,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/D,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,cAAc,GAAG,IAAI,CAAC;IACnE,YAAY,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC;IAC3C,WAAW,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC;IAC1C,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,GAAG,IAAI,CAAC;IAC3E,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IACnE,kBAAkB,CAChB,MAAM,EAAE,YAAY,EACpB,cAAc,EAAE,oBAAoB,GACnC,IAAI,CAAC;IACR,gBAAgB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;IAC7C,iBAAiB,CAAC,MAAM,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAEtD,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAGzD,kBAAkB,CAChB,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GACvC,IAAI,CAAC;IAER,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IAChC,WAAW,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,kBAAkB,CAAC,GAAG;IACxD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;;;;OAKG;IACH,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAAC;IAE/C;;;;;OAKG;IACH,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,qBAAa,MAAO,SAAQ,YAAY,CAAC,MAAM,CAAC;;IAC9C,QAAQ,CAAC,OAAO,oBAAC;IACjB,QAAQ,CAAC,IAAI,gBAAC;IACd,QAAQ,CAAC,QAAQ,oBAAC;IAClB,QAAQ,CAAC,cAAc,0BAAC;IACxB,QAAQ,CAAC,eAAe,2BAAC;IACzB,QAAQ,CAAC,MAAM,kBAAC;IAChB,QAAQ,CAAC,QAAQ,oBAAC;IAClB,QAAQ,CAAC,OAAO,mBAAC;IACjB,QAAQ,CAAC,aAAa,yBAAC;IACvB,QAAQ,CAAC,QAAQ,oBAAC;IAClB,QAAQ,CAAC,KAAK,iBAAC;IAEf,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAClB,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;IAChC,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAEhC,aAAa,EAAE,cAAc,GAAG,SAAS,CAAC;IAE1C,IAAI,EAAE,IAAI,GAAG,SAAS,CAAC;IAEvB,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAGlC,QAAQ,CAAC,sBAAsB,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAIlD;;OAEG;gBAED,OAAO,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,EAChC,aAAa,CAAC,EAAE,cAAc;IA0FhC;;OAEG;IACH,IAAI,SAAS,uBAEZ;IAED;;OAEG;IACH,OAAO;IA+BP;;;;OAIG;IACG,KAAK,CAAC,OAAO,EAAE,SAAS;IAW9B;;OAEG;IACG,kBAAkB,CAAC,OAAO,EAAE,OAAO;IAKzC;;;OAGG;IACG,QAAQ,CAAC,KAAK,EAAE,MAAM;IAO5B;;;;OAIG;IACH,cAAc,CAAC,MAAM,EAAE,MAAM;IAuB7B;;;;OAIG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;CAS3C"}

package/lib/cjs/Client.js

@@ -0,0 +1,221 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _Client_instances, _Client_session, _Client_setReady, _Client_setConnectionFailureCount, _Client_reconnectTimeout, _Client_fetchConfiguration, _Client_updateHeaders;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = void 0;
+const api_1 = require("./api");
+const AccountCollection_js_1 = require("./collections/AccountCollection.js");
+const index_js_1 = require("./collections/index.js");
+const index_js_2 = require("./events/index.js");
+const regex_js_1 = require("./lib/regex.js");
+const eventemitter3_1 = __importDefault(require("eventemitter3"));
+const solid_js_1 = require("solid-js");
+/**
+ * Hischool.js Clients
+ */
+class Client extends eventemitter3_1.default {
+    /**
+     * Create Hischool.js Client
+     */
+    constructor(options, configuration) {
+        super();
+        _Client_instances.add(this);
+        _Client_session.set(this, void 0);
+        _Client_setReady.set(this, void 0);
+        _Client_setConnectionFailureCount.set(this, void 0);
+        _Client_reconnectTimeout.set(this, void 0);
+        this.options = Object.assign({ 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_1.API({
+            baseURL: this.options.baseURL,
+        });
+        const [ready, setReady] = (0, solid_js_1.createSignal)(false);
+        this.ready = ready;
+        __classPrivateFieldSet(this, _Client_setReady, setReady, "f");
+        const [connectionFailureCount, setConnectionFailureCount] = (0, solid_js_1.createSignal)(0);
+        this.connectionFailureCount = connectionFailureCount;
+        __classPrivateFieldSet(this, _Client_setConnectionFailureCount, setConnectionFailureCount, "f");
+        this.account = new AccountCollection_js_1.AccountCollection(this);
+        this.bots = new index_js_1.BotCollection(this);
+        this.channels = new index_js_1.ChannelCollection(this);
+        this.channelUnreads = new index_js_1.ChannelUnreadCollection(this);
+        this.channelWebhooks = new index_js_1.ChannelWebhookCollection(this);
+        this.emojis = new index_js_1.EmojiCollection(this);
+        this.messages = new index_js_1.MessageCollection(this);
+        this.servers = new index_js_1.ServerCollection(this);
+        this.serverMembers = new index_js_1.ServerMemberCollection(this);
+        this.sessions = new index_js_1.SessionCollection(this);
+        this.users = new index_js_1.UserCollection(this);
+        this.events = new index_js_2.EventClient(1, "json", this.options);
+        this.events.on("error", (error) => this.emit("error", error));
+        this.events.on("state", (state) => {
+            switch (state) {
+                case index_js_2.ConnectionState.Connected:
+                    (0, solid_js_1.batch)(() => {
+                        this.servers.forEach((server) => server.resetSyncStatus());
+                        __classPrivateFieldGet(this, _Client_setConnectionFailureCount, "f").call(this, 0);
+                        this.emit("connected");
+                    });
+                    break;
+                case index_js_2.ConnectionState.Connecting:
+                    this.emit("connecting");
+                    break;
+                case index_js_2.ConnectionState.Disconnected:
+                    this.emit("disconnected");
+                    if (this.options.autoReconnect) {
+                        __classPrivateFieldSet(this, _Client_reconnectTimeout, setTimeout(() => this.connect(), this.options.retryDelayFunction(this.connectionFailureCount()) *
+                            1e3), "f");
+                        __classPrivateFieldGet(this, _Client_setConnectionFailureCount, "f").call(this, (count) => count + 1);
+                    }
+                    break;
+            }
+        });
+        this.events.on("event", (event) => (0, index_js_2.handleEventV1)(this, event, __classPrivateFieldGet(this, _Client_setReady, "f")));
+    }
+    /**
+     * Current session id
+     */
+    get sessionId() {
+        var _a;
+        return typeof __classPrivateFieldGet(this, _Client_session, "f") === "string" ? undefined : (_a = __classPrivateFieldGet(this, _Client_session, "f")) === null || _a === void 0 ? void 0 : _a._id;
+    }
+    /**
+     * Connect to Hischool
+     */
+    connect() {
+        var _a, _b;
+        clearTimeout(__classPrivateFieldGet(this, _Client_reconnectTimeout, "f"));
+        this.events.disconnect();
+        __classPrivateFieldGet(this, _Client_setReady, "f").call(this, false);
+        this.events.connect((_b = (_a = this.configuration) === null || _a === void 0 ? void 0 : _a.ws) !== null && _b !== void 0 ? _b : "wss://ws.hischool.mn", typeof __classPrivateFieldGet(this, _Client_session, "f") === "string" ? __classPrivateFieldGet(this, _Client_session, "f") : __classPrivateFieldGet(this, _Client_session, "f").token);
+    }
+    /**
+     * 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
+     */
+    login(details) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield __classPrivateFieldGet(this, _Client_instances, "m", _Client_fetchConfiguration).call(this);
+            const data = yield this.api.post("/auth/session/login", details);
+            if (data.result === "Success") {
+                __classPrivateFieldSet(this, _Client_session, data, "f");
+                // TODO: return await this.connect();
+            }
+            else {
+                throw "MFA not implemented!";
+            }
+        });
+    }
+    /**
+     * Use an existing session
+     */
+    useExistingSession(session) {
+        return __awaiter(this, void 0, void 0, function* () {
+            __classPrivateFieldSet(this, _Client_session, session, "f");
+            __classPrivateFieldGet(this, _Client_instances, "m", _Client_updateHeaders).call(this);
+        });
+    }
+    /**
+     * Log in as a bot
+     * @param token Bot token
+     */
+    loginBot(token) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield __classPrivateFieldGet(this, _Client_instances, "m", _Client_fetchConfiguration).call(this);
+            __classPrivateFieldSet(this, _Client_session, token, "f");
+            __classPrivateFieldGet(this, _Client_instances, "m", _Client_updateHeaders).call(this);
+            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(regex_js_1.RE_MENTIONS, (sub, id) => {
+            const user = this.users.get(id);
+            if (user) {
+                return `@${user.username}`;
+            }
+            return sub;
+        })
+            .replace(regex_js_1.RE_CHANNELS, (sub, id) => {
+            const channel = this.channels.get(id);
+            if (channel) {
+                return `#${channel.displayName}`;
+            }
+            return sub;
+        })
+            .replace(regex_js_1.RE_SPOILER, "<spoiler>");
+    }
+    /**
+     * Proxy a file through January.
+     * @param url URL to proxy
+     * @returns Proxied media URL
+     */
+    proxyFile(url) {
+        var _a;
+        if ((_a = this.configuration) === null || _a === void 0 ? void 0 : _a.features.january.enabled) {
+            return `${this.configuration.features.january.url}/proxy?url=${encodeURIComponent(url)}`;
+        }
+        else {
+            return url;
+        }
+    }
+}
+exports.Client = Client;
+_Client_session = new WeakMap(), _Client_setReady = new WeakMap(), _Client_setConnectionFailureCount = new WeakMap(), _Client_reconnectTimeout = new WeakMap(), _Client_instances = new WeakSet(), _Client_fetchConfiguration = function _Client_fetchConfiguration() {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!this.configuration) {
+            this.configuration = yield this.api.get("/");
+        }
+    });
+}, _Client_updateHeaders = function _Client_updateHeaders() {
+    this.api = new api_1.API({
+        baseURL: this.options.baseURL,
+        authentication: {
+            hischool: __classPrivateFieldGet(this, _Client_session, "f"),
+        },
+    });
+};

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

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

package/lib/cjs/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/cjs/api/baseURL.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultBaseURL = void 0;
+// API Base URL
+exports.defaultBaseURL = "https://api.hischool.mn";

package/lib/cjs/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/cjs/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"}