hischool.js 0.0.1

package/lib/esm/classes/ChannelWebhook.js

@@ -0,0 +1,83 @@
+import { hydrate } from "../hydration/index.js";
+/**
+ * Channel Webhook Class
+ */
+export class ChannelWebhook {
+    #collection;
+    id;
+    /**
+     * Construct Channel Webhook
+     * @param collection Collection
+     * @param id Webhook
+     */
+    constructor(collection, id) {
+        this.#collection = collection;
+        this.id = id;
+    }
+    /**
+     * Whether this object exists
+     */
+    get $exists() {
+        return !!this.#collection.getUnderlyingObject(this.id).id;
+    }
+    /**
+     * Webhook name
+     */
+    get name() {
+        return this.#collection.getUnderlyingObject(this.id).name;
+    }
+    /**
+     * Webhook avatar
+     */
+    get avatar() {
+        return this.#collection.getUnderlyingObject(this.id).avatar;
+    }
+    /**
+     * Webhook avatar URL
+     */
+    get avatarURL() {
+        return this.#collection
+            .getUnderlyingObject(this.id)
+            .avatar?.createFileURL({ max_side: 256 });
+    }
+    /**
+     * Channel ID this webhook belongs to
+     */
+    get channelId() {
+        return this.#collection.getUnderlyingObject(this.id).channelId;
+    }
+    /**
+     * Channel this webhook belongs to
+     */
+    get channel() {
+        return this.#collection.client.channels.get(this.#collection.getUnderlyingObject(this.id).channelId);
+    }
+    /**
+     * Secret token for sending messages to this webhook
+     */
+    get token() {
+        return this.#collection.getUnderlyingObject(this.id).token;
+    }
+    /**
+     * Edit this webhook
+     * TODO: not in production
+     */
+    async edit(data /*: DataEditWebhook*/) {
+        const webhook = await this.#collection.client.api.patch(
+        // @ts-expect-error not in prod
+        `/webhooks/${this.id}/${this.token}`, data);
+        this.#collection.updateUnderlyingObject(this.id, 
+        // @ts-expect-error not in prod
+        hydrate("channelWebhook", webhook, this.#collection.client));
+    }
+    /**
+     * Delete this webhook
+     * TODO: not in production
+     */
+    async delete() {
+        await this.#collection.client.api.delete(
+        // @ts-expect-error not in prod
+        `/webhooks/${this.id}/${this.token}`);
+        this.#collection.delete(this.id);
+    }
+}

package/lib/esm/classes/Emoji.d.ts

@@ -0,0 +1,57 @@
+import { EmojiCollection } from "../collections/index.js";
+/**
+ * Emoji Class
+ */
+export declare class Emoji {
+    #private;
+    readonly id: string;
+    /**
+     * Construct Emoji
+     * @param collection Collection
+     * @param id Emoji Id
+     */
+    constructor(collection: EmojiCollection, id: string);
+    /**
+     * Convert to string
+     * @returns String
+     */
+    toString(): string;
+    /**
+     * Whether this object exists
+     */
+    get $exists(): boolean;
+    /**
+     * Time when this emoji was created
+     */
+    get createdAt(): Date;
+    /**
+     * Information about the parent of this emoji
+     */
+    get parent(): {
+        type: "Server";
+        id: string;
+    } | {
+        type: "Detached";
+    };
+    /**
+     * Creator of the emoji
+     */
+    get creator(): import("./User.js").User | undefined;
+    /**
+     * Name
+     */
+    get name(): string;
+    /**
+     * Whether the emoji is animated
+     */
+    get animated(): boolean;
+    /**
+     * Whether the emoji is marked as mature
+     */
+    get mature(): boolean;
+    /**
+     * Delete Emoji
+     */
+    delete(): Promise<void>;
+}
+//# sourceMappingURL=Emoji.d.ts.map

package/lib/esm/classes/Emoji.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Emoji.d.ts","sourceRoot":"","sources":["../../../src/classes/Emoji.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAG1D;;GAEG;AACH,qBAAa,KAAK;;IAEhB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;gBACS,UAAU,EAAE,eAAe,EAAE,EAAE,EAAE,MAAM;IAKnD;;;OAGG;IACH,QAAQ;IAIR;;OAEG;IACH,IAAI,OAAO,YAEV;IAED;;OAEG;IACH,IAAI,SAAS,SAEZ;IAED;;OAEG;IACH,IAAI,MAAM;;;;;MAET;IAED;;OAEG;IACH,IAAI,OAAO,yCAIV;IAED;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,QAAQ,YAEX;IAED;;OAEG;IACH,IAAI,MAAM,YAET;IAED;;OAEG;IACG,MAAM;CASb"}

package/lib/esm/classes/Emoji.js

@@ -0,0 +1,77 @@
+import { decodeTime } from "ulid";
+/**
+ * Emoji Class
+ */
+export class Emoji {
+    #collection;
+    id;
+    /**
+     * Construct Emoji
+     * @param collection Collection
+     * @param id Emoji Id
+     */
+    constructor(collection, id) {
+        this.#collection = collection;
+        this.id = id;
+    }
+    /**
+     * Convert to string
+     * @returns String
+     */
+    toString() {
+        return `:${this.id}:`;
+    }
+    /**
+     * Whether this object exists
+     */
+    get $exists() {
+        return !!this.#collection.getUnderlyingObject(this.id).id;
+    }
+    /**
+     * Time when this emoji was created
+     */
+    get createdAt() {
+        return new Date(decodeTime(this.id));
+    }
+    /**
+     * Information about the parent of this emoji
+     */
+    get parent() {
+        return this.#collection.getUnderlyingObject(this.id).parent;
+    }
+    /**
+     * Creator of the emoji
+     */
+    get creator() {
+        return this.#collection.client.users.get(this.#collection.getUnderlyingObject(this.id).creatorId);
+    }
+    /**
+     * Name
+     */
+    get name() {
+        return this.#collection.getUnderlyingObject(this.id).name;
+    }
+    /**
+     * Whether the emoji is animated
+     */
+    get animated() {
+        return this.#collection.getUnderlyingObject(this.id).animated;
+    }
+    /**
+     * Whether the emoji is marked as mature
+     */
+    get mature() {
+        return this.#collection.getUnderlyingObject(this.id).nsfw;
+    }
+    /**
+     * Delete Emoji
+     */
+    async delete() {
+        await this.#collection.client.api.delete(`/custom/emoji/${this.id}`);
+        const emoji = this.#collection.getUnderlyingObject(this.id);
+        if (emoji) {
+            this.#collection.client.emit("emojiDelete", emoji);
+            this.#collection.delete(this.id);
+        }
+    }
+}

package/lib/esm/classes/File.d.ts

@@ -0,0 +1,67 @@
+import { Metadata } from "../api";
+import { API, Client } from "../index.js";
+/**
+ * Uploaded File
+ */
+export declare class File {
+    #private;
+    /**
+     * File Id
+     */
+    readonly id: string;
+    /**
+     * File bucket
+     */
+    readonly tag: string;
+    /**
+     * Original filename
+     */
+    readonly filename?: string;
+    /**
+     * Parsed metadata of the file
+     */
+    readonly metadata: Metadata;
+    /**
+     * Raw content type of this file
+     */
+    readonly contentType?: string;
+    /**
+     * Size of the file (in bytes)
+     */
+    readonly size?: number;
+    /**
+     * Construct File
+     * @param client Client
+     * @param file File
+     */
+    constructor(client: Client, file: Pick<API.File, "_id" | "tag" | "metadata"> & Partial<API.File>);
+    /**
+     * Direct URL to the file
+     */
+    get url(): string;
+    /**
+     * Download URL for the file
+     */
+    get downloadURL(): string;
+    /**
+     * Human readable file size
+     */
+    get humanReadableSize(): string;
+    /**
+     * Whether this file should have a spoiler
+     */
+    get isSpoiler(): boolean;
+    /**
+     * Creates a URL to a given file with given options.
+     * @param options Optional query parameters to modify object
+     * @param allowAnimation Returns GIF if applicable, no operations occur on image
+     * @returns Generated URL or nothing
+     */
+    createFileURL(options?: {
+        max_side?: number;
+        size?: number;
+        width?: number;
+        height?: number;
+    }, allowAnimation?: boolean): string | undefined;
+}
+//# sourceMappingURL=File.d.ts.map

package/lib/esm/classes/File.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"File.d.ts","sourceRoot":"","sources":["../../../src/classes/File.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1C;;GAEG;AACH,qBAAa,IAAI;;IAGf;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;gBAED,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,UAAU,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC;IAWtE;;OAEG;IACH,IAAI,GAAG,WAIN;IAED;;OAEG;IACH,IAAI,WAAW,WAId;IAED;;OAEG;IACH,IAAI,iBAAiB,WAUpB;IAED;;OAEG;IACH,IAAI,SAAS,YAEZ;IAED;;;;;OAKG;IACH,aAAa,CACX,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,EACD,cAAc,CAAC,EAAE,OAAO;CA4B3B"}

package/lib/esm/classes/File.js

@@ -0,0 +1,105 @@
+/**
+ * Uploaded File
+ */
+export class File {
+    #client;
+    /**
+     * File Id
+     */
+    id;
+    /**
+     * File bucket
+     */
+    tag;
+    /**
+     * Original filename
+     */
+    filename;
+    /**
+     * Parsed metadata of the file
+     */
+    metadata;
+    /**
+     * Raw content type of this file
+     */
+    contentType;
+    /**
+     * Size of the file (in bytes)
+     */
+    size;
+    /**
+     * Construct File
+     * @param client Client
+     * @param file File
+     */
+    constructor(client, file) {
+        this.#client = client;
+        this.id = file._id;
+        this.tag = file.tag;
+        this.filename = file.filename;
+        this.metadata = file.metadata;
+        this.contentType = file.content_type;
+        this.size = file.size;
+    }
+    /**
+     * Direct URL to the file
+     */
+    get url() {
+        return `${this.#client.configuration?.features.autumn.url}/${this.tag}/${this.id}/${this.filename}`;
+    }
+    /**
+     * Download URL for the file
+     */
+    get downloadURL() {
+        return `${this.#client.configuration?.features.autumn.url}/${this.tag}/download/${this.id}/${this.filename}`;
+    }
+    /**
+     * Human readable file size
+     */
+    get humanReadableSize() {
+        if (!this.size)
+            return "Unknown size";
+        if (this.size > 1e6) {
+            return `${(this.size / 1e6).toFixed(2)} MB`;
+        }
+        else if (this.size > 1e3) {
+            return `${(this.size / 1e3).toFixed(2)} KB`;
+        }
+        return `${this.size} B`;
+    }
+    /**
+     * Whether this file should have a spoiler
+     */
+    get isSpoiler() {
+        return this.filename?.toLowerCase().startsWith("spoiler_") ?? false;
+    }
+    /**
+     * Creates a URL to a given file with given options.
+     * @param options Optional query parameters to modify object
+     * @param allowAnimation Returns GIF if applicable, no operations occur on image
+     * @returns Generated URL or nothing
+     */
+    createFileURL(options, allowAnimation) {
+        const autumn = this.#client.configuration?.features.autumn;
+        if (!autumn?.enabled)
+            return;
+        // TODO: server-side
+        if (this.metadata?.type === "Image") {
+            if (Math.min(this.metadata.width, this.metadata.height) <= 0 ||
+                (this.contentType === "image/gif" &&
+                    Math.max(this.metadata.width, this.metadata.height) >= 4096))
+                return;
+        }
+        let query = "";
+        if (options) {
+            if (!allowAnimation || this.contentType !== "image/gif") {
+                query =
+                    "?" +
+                        Object.keys(options)
+                            .map((k) => `${k}=${options[k]}`)
+                            .join("&");
+            }
+        }
+        return `${autumn.url}/${this.tag}/${this.id}${query}`;
+    }
+}

package/lib/esm/classes/Invite.d.ts

@@ -0,0 +1,60 @@
+import { API, Client } from "../index.js";
+/**
+ * Channel Invite
+ */
+export declare abstract class ChannelInvite {
+    protected client?: Client;
+    readonly type: API.Invite["type"] | "None";
+    /**
+     * Construct Channel Invite
+     * @param client Client
+     * @param type Type
+     */
+    constructor(client?: Client, type?: API.Invite["type"] | "None");
+    /**
+     * Create an Invite from an API Invite
+     * @param client Client
+     * @param invite Data
+     * @returns Invite
+     */
+    static from(client: Client, invite: API.Invite): ChannelInvite;
+}
+/**
+ * Invite of unknown type
+ */
+export declare class UnknownInvite extends ChannelInvite {
+}
+/**
+ * Server Invite
+ */
+export declare class ServerInvite extends ChannelInvite {
+    readonly id: string;
+    readonly creatorId: string;
+    readonly serverId: string;
+    readonly channelId: string;
+    /**
+     * Construct Server Invite
+     * @param client Client
+     * @param invite Invite
+     */
+    constructor(client: Client, invite: API.Invite & {
+        type: "Server";
+    });
+    /**
+     * Creator of the invite
+     */
+    get creator(): import("./User.js").User | undefined;
+    /**
+     * Server this invite points to
+     */
+    get server(): import("./Server.js").Server | undefined;
+    /**
+     * Channel this invite points to
+     */
+    get channel(): import("./Channel.js").Channel | undefined;
+    /**
+     * Delete the invite
+     */
+    delete(): Promise<void>;
+}
+//# sourceMappingURL=Invite.d.ts.map

package/lib/esm/classes/Invite.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Invite.d.ts","sourceRoot":"","sources":["../../../src/classes/Invite.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1C;;GAEG;AACH,8BAAsB,aAAa;IACjC,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAE3C;;;;OAIG;gBACS,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,GAAE,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,MAAe;IAKvE;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,aAAa;CAQ/D;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,aAAa;CAAG;AAEnD;;GAEG;AACH,qBAAa,YAAa,SAAQ,aAAa;IAC7C,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;gBACS,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG;QAAE,IAAI,EAAE,QAAQ,CAAA;KAAE;IASnE;;OAEG;IACH,IAAI,OAAO,yCAEV;IAED;;OAEG;IACH,IAAI,MAAM,6CAET;IAED;;OAEG;IACH,IAAI,OAAO,+CAEV;IAED;;OAEG;IACG,MAAM;CAGb"}

package/lib/esm/classes/Invite.js

@@ -0,0 +1,80 @@
+/**
+ * Channel Invite
+ */
+export class ChannelInvite {
+    client;
+    type;
+    /**
+     * Construct Channel Invite
+     * @param client Client
+     * @param type Type
+     */
+    constructor(client, type = "None") {
+        this.client = client;
+        this.type = type;
+    }
+    /**
+     * Create an Invite from an API Invite
+     * @param client Client
+     * @param invite Data
+     * @returns Invite
+     */
+    static from(client, invite) {
+        switch (invite.type) {
+            case "Server":
+                return new ServerInvite(client, invite);
+            default:
+                return new UnknownInvite(client);
+        }
+    }
+}
+/**
+ * Invite of unknown type
+ */
+export class UnknownInvite extends ChannelInvite {
+}
+/**
+ * Server Invite
+ */
+export class ServerInvite extends ChannelInvite {
+    id;
+    creatorId;
+    serverId;
+    channelId;
+    /**
+     * Construct Server Invite
+     * @param client Client
+     * @param invite Invite
+     */
+    constructor(client, invite) {
+        super(client, "Server");
+        this.id = invite._id;
+        this.creatorId = invite.creator;
+        this.serverId = invite.server;
+        this.channelId = invite.server;
+    }
+    /**
+     * Creator of the invite
+     */
+    get creator() {
+        return this.client.users.get(this.creatorId);
+    }
+    /**
+     * Server this invite points to
+     */
+    get server() {
+        return this.client.servers.get(this.serverId);
+    }
+    /**
+     * Channel this invite points to
+     */
+    get channel() {
+        return this.client.channels.get(this.channelId);
+    }
+    /**
+     * Delete the invite
+     */
+    async delete() {
+        await this.client.api.delete(`/invites/${this.id}`);
+    }
+}

package/lib/esm/classes/MFA.d.ts

@@ -0,0 +1,83 @@
+import { MFAMethod, MFAResponse, MultiFactorStatus, MFATicket as TicketType } from "../api";
+import { Client } from "../index.js";
+import { SetStoreFunction } from "solid-js/store";
+/**
+ * Multi-Factor Authentication
+ */
+export declare class MFA {
+    #private;
+    /**
+     * Construct MFA helper
+     * @param client Client
+     * @param state State
+     */
+    constructor(client: Client, state: MultiFactorStatus);
+    /**
+     * Whether authenticator app is enabled
+     */
+    get authenticatorEnabled(): boolean;
+    /**
+     * Whether recovery codes are enabled
+     */
+    get recoveryEnabled(): boolean;
+    /**
+     * Available MFA methods for generating tickets
+     */
+    get availableMethods(): MFAMethod[];
+    /**
+     * Create an MFA ticket
+     * @param params
+     * @returns Token
+     */
+    createTicket(params: MFAResponse): Promise<MFATicket>;
+    /**
+     * Enable authenticator using token generated from secret found earlier
+     * @param token Token
+     */
+    enableAuthenticator(token: string): Promise<void>;
+}
+/**
+ * MFA Ticket
+ */
+export declare class MFATicket {
+    #private;
+    /**
+     * Construct MFA Ticket
+     * @param client Client
+     * @param ticket Ticket
+     * @param mutate Mutate the store
+     */
+    constructor(client: Client, ticket: TicketType, mutate: SetStoreFunction<MultiFactorStatus>);
+    /**
+     * Token
+     */
+    get token(): string;
+    /**
+     * Fetch recovery codes
+     * @returns List of codes
+     */
+    fetchRecoveryCodes(): Promise<string[]>;
+    /**
+     * Generate new set of recovery codes
+     * @returns List of codes
+     */
+    generateRecoveryCodes(): Promise<string[]>;
+    /**
+     * Generate new authenticator secret
+     * @returns Secret
+     */
+    generateAuthenticatorSecret(): Promise<string>;
+    /**
+     * Disable authenticator
+     */
+    disableAuthenticator(): Promise<void>;
+    /**
+     * Disable account
+     */
+    disableAccount(): Promise<undefined>;
+    /**
+     * Delete account
+     */
+    deleteAccount(): Promise<undefined>;
+}
+//# sourceMappingURL=MFA.d.ts.map

package/lib/esm/classes/MFA.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MFA.d.ts","sourceRoot":"","sources":["../../../src/classes/MFA.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,WAAW,EACX,iBAAiB,EACjB,SAAS,IAAI,UAAU,EACxB,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,gBAAgB,EAAe,MAAM,gBAAgB,CAAC;AAE/D;;GAEG;AACH,qBAAa,GAAG;;IAId;;;;OAIG;gBACS,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB;IAKpD;;OAEG;IACH,IAAI,oBAAoB,YAEvB;IAED;;OAEG;IACH,IAAI,eAAe,YAElB;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,SAAS,EAAE,CAMlC;IAED;;;;OAIG;IACH,YAAY,CAAC,MAAM,EAAE,WAAW;IAMhC;;;OAGG;IACG,mBAAmB,CAAC,KAAK,EAAE,MAAM;CAIxC;AAED;;GAEG;AACH,qBAAa,SAAS;;IAMpB;;;;;OAKG;gBAED,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,gBAAgB,CAAC,iBAAiB,CAAC;IAO7C;;OAEG;IACH,IAAI,KAAK,WAER;IAUD;;;OAGG;IACH,kBAAkB;IASlB;;;OAGG;IACG,qBAAqB;IAiB3B;;;OAGG;IACH,2BAA2B;IAW3B;;OAEG;IACG,oBAAoB;IAY1B;;OAEG;IACH,cAAc;IASd;;OAEG;IACH,aAAa;CAQd"}