hischool.js 0.0.1

package/lib/esm/classes/SystemMessage.js

@@ -0,0 +1,171 @@
+/**
+ * System Message
+ */
+export class SystemMessage {
+    client;
+    type;
+    /**
+     * Construct System Message
+     * @param client Client
+     * @param type Type
+     */
+    constructor(client, type) {
+        this.client = client;
+        this.type = type;
+    }
+    /**
+     * Create an System Message from an API System Message
+     * @param client Client
+     * @param embed Data
+     * @returns System Message
+     */
+    static from(client, message) {
+        switch (message.type) {
+            case "text":
+                return new TextSystemMessage(client, message);
+            case "user_added":
+            case "user_remove":
+                return new UserModeratedSystemMessage(client, message);
+            case "user_joined":
+            case "user_left":
+            case "user_kicked":
+            case "user_banned":
+                return new UserSystemMessage(client, message);
+            case "channel_renamed":
+                return new ChannelRenamedSystemMessage(client, message);
+            case "channel_description_changed":
+            case "channel_icon_changed":
+                return new ChannelEditSystemMessage(client, message);
+            case "channel_ownership_changed":
+                return new ChannelOwnershipChangeSystemMessage(client, message);
+            default:
+                return new TextSystemMessage(client, {
+                    type: "text",
+                    content: `${message.type} is not supported.`,
+                });
+        }
+    }
+}
+/**
+ * Text System Message
+ */
+export class TextSystemMessage extends SystemMessage {
+    content;
+    /**
+     * Construct System Message
+     * @param client Client
+     * @param systemMessage System Message
+     */
+    constructor(client, systemMessage) {
+        super(client, systemMessage.type);
+        this.content = systemMessage.content;
+    }
+}
+/**
+ * User System Message
+ */
+export class UserSystemMessage extends SystemMessage {
+    userId;
+    /**
+     * Construct System Message
+     * @param client Client
+     * @param systemMessage System Message
+     */
+    constructor(client, systemMessage) {
+        super(client, systemMessage.type);
+        this.userId = systemMessage.id;
+    }
+    /**
+     * User this message concerns
+     */
+    get user() {
+        return this.client.users.get(this.userId);
+    }
+}
+/**
+ * User Moderated System Message
+ */
+export class UserModeratedSystemMessage extends UserSystemMessage {
+    byId;
+    /**
+     * Construct System Message
+     * @param client Client
+     * @param systemMessage System Message
+     */
+    constructor(client, systemMessage) {
+        super(client, systemMessage);
+        this.byId = systemMessage.by;
+    }
+    /**
+     * User this action was performed by
+     */
+    get by() {
+        console.info("deez!", this.byId);
+        return this.client.users.get(this.byId);
+    }
+}
+/**
+ * Channel Edit System Message
+ */
+export class ChannelEditSystemMessage extends SystemMessage {
+    byId;
+    /**
+     * Construct System Message
+     * @param client Client
+     * @param systemMessage System Message
+     */
+    constructor(client, systemMessage) {
+        super(client, systemMessage.type);
+        this.byId = systemMessage.by;
+    }
+    /**
+     * User this action was performed by
+     */
+    get by() {
+        return this.client.users.get(this.byId);
+    }
+}
+/**
+ * Channel Renamed System Message
+ */
+export class ChannelRenamedSystemMessage extends ChannelEditSystemMessage {
+    name;
+    /**
+     * Construct System Message
+     * @param client Client
+     * @param systemMessage System Message
+     */
+    constructor(client, systemMessage) {
+        super(client, systemMessage);
+        this.name = systemMessage.name;
+    }
+}
+/**
+ * Channel Ownership Change System Message
+ */
+export class ChannelOwnershipChangeSystemMessage extends SystemMessage {
+    fromId;
+    toId;
+    /**
+     * Construct System Message
+     * @param client Client
+     * @param systemMessage System Message
+     */
+    constructor(client, systemMessage) {
+        super(client, systemMessage.type);
+        this.fromId = systemMessage.from;
+        this.toId = systemMessage.to;
+    }
+    /**
+     * User giving away channel ownership
+     */
+    get from() {
+        return this.client.users.get(this.fromId);
+    }
+    /**
+     * User receiving channel ownership
+     */
+    get to() {
+        return this.client.users.get(this.toId);
+    }
+}

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

@@ -0,0 +1,203 @@
+import { DataEditUser, Presence } from "../api";
+import { UserCollection } from "../collections/index.js";
+import { UserProfile } from "../index.js";
+/**
+ * User Class
+ */
+export declare class User {
+    #private;
+    readonly id: string;
+    /**
+     * Construct User
+     * @param collection Collection
+     * @param id Id
+     */
+    constructor(collection: UserCollection, id: string);
+    /**
+     * Write to string as a user mention
+     * @returns Formatted String
+     */
+    toString(): string;
+    /**
+     * Whether this object exists
+     */
+    get $exists(): boolean;
+    /**
+     * Time when this user created their account
+     */
+    get createdAt(): Date;
+    /**
+     * Username
+     */
+    get username(): string;
+    /**
+     * Discriminator
+     */
+    get discriminator(): string;
+    /**
+     * Display Name
+     */
+    get displayName(): string;
+    /**
+     * Avatar
+     */
+    get avatar(): import("./File").File | undefined;
+    /**
+     * Badges
+     */
+    get badges(): import("../index.js").UserBadges;
+    /**
+     * User Status
+     */
+    get status(): {
+        text?: string | null | undefined;
+        presence?: "Online" | "Idle" | "Focus" | "Busy" | "Invisible" | null | undefined;
+    } | undefined;
+    /**
+     * Relationship with user
+     */
+    get relationship(): "Blocked" | "None" | "User" | "Friend" | "Outgoing" | "Incoming" | "BlockedOther";
+    /**
+     * Whether the user is online
+     */
+    get online(): boolean;
+    /**
+     * Whether the user is privileged
+     */
+    get privileged(): boolean;
+    /**
+     * Flags
+     */
+    get flags(): import("../index.js").UserFlags;
+    /**
+     * Bot information
+     */
+    get bot(): {
+        owner: string;
+    } | undefined;
+    /**
+     * Whether this user is ourselves
+     */
+    get self(): boolean;
+    /**
+     * URL to the user's default avatar
+     */
+    get defaultAvatarURL(): string;
+    /**
+     * URL to the user's avatar
+     */
+    get avatarURL(): string;
+    /**
+     * URL to the user's animated avatar
+     */
+    get animatedAvatarURL(): string;
+    /**
+     * Presence
+     */
+    get presence(): "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
+    /**
+     * Generate status message
+     * @param translate Translation function
+     * @returns Status message
+     */
+    statusMessage(translate?: (presence: Presence) => string): string | undefined;
+    /**
+     * Permissions against this user
+     */
+    get permission(): number;
+    /**
+     * Edit the user
+     * @param data Changes
+     */
+    edit(data: DataEditUser): Promise<void>;
+    /**
+     * Change the username of the current user
+     * @param username New username
+     * @param password Current password
+     */
+    changeUsername(username: string, password: string): Promise<{
+        _id: string;
+        username: string;
+        discriminator: string;
+        display_name?: string | null | undefined;
+        avatar?: {
+            _id: string;
+            tag: string;
+            filename: string;
+            metadata: {
+                type: "File";
+            } | {
+                type: "Text";
+            } | {
+                type: "Image";
+                width: number;
+                height: number;
+            } | {
+                type: "Video";
+                width: number;
+                height: number;
+            } | {
+                type: "Audio";
+            };
+            content_type: string;
+            size: number;
+            deleted?: boolean | null | undefined;
+            reported?: boolean | null | undefined;
+            message_id?: string | null | undefined;
+            user_id?: string | null | undefined;
+            server_id?: string | null | undefined;
+            object_id?: string | null | undefined;
+        } | null | undefined;
+        relations?: {
+            _id: string;
+            status: "Blocked" | "None" | "User" | "Friend" | "Outgoing" | "Incoming" | "BlockedOther";
+        }[] | undefined;
+        badges?: number | undefined;
+        status?: {
+            text?: string | null | undefined;
+            presence?: "Online" | "Idle" | "Focus" | "Busy" | "Invisible" | null | undefined;
+        } | null | undefined;
+        flags?: number | undefined;
+        privileged?: boolean | undefined;
+        bot?: {
+            owner: string;
+        } | null | undefined;
+        relationship: "Blocked" | "None" | "User" | "Friend" | "Outgoing" | "Incoming" | "BlockedOther";
+        online: boolean;
+    }>;
+    /**
+     * Open a DM with a user
+     * @returns DM Channel
+     */
+    openDM(): Promise<import("./Channel").Channel>;
+    /**
+     * Send a friend request to a user
+     */
+    addFriend(): Promise<User>;
+    /**
+     * Remove a user from the friend list
+     */
+    removeFriend(): Promise<void>;
+    /**
+     * Block a user
+     */
+    blockUser(): Promise<void>;
+    /**
+     * Unblock a user
+     */
+    unblockUser(): Promise<void>;
+    /**
+     * Fetch the profile of a user
+     * @returns The profile of the user
+     */
+    fetchProfile(): Promise<UserProfile>;
+    /**
+     * Fetch the mutual connections of the current user and a target user
+     * @returns The mutual connections of the current user and a target user
+     */
+    fetchMutual(): Promise<{
+        users: string[];
+        servers: string[];
+    }>;
+}
+//# sourceMappingURL=User.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"User.d.ts","sourceRoot":"","sources":["../../../src/classes/User.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAI1C;;GAEG;AACH,qBAAa,IAAI;;IAEf,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;gBACS,UAAU,EAAE,cAAc,EAAE,EAAE,EAAE,MAAM;IAKlD;;;OAGG;IACH,QAAQ;IAIR;;OAEG;IACH,IAAI,OAAO,YAEV;IAED;;OAEG;IACH,IAAI,SAAS,SAEZ;IAED;;OAEG;IACH,IAAI,QAAQ,WAEX;IAED;;OAEG;IACH,IAAI,aAAa,WAEhB;IAED;;OAEG;IACH,IAAI,WAAW,WAKd;IAED;;OAEG;IACH,IAAI,MAAM,sCAET;IAED;;OAEG;IACH,IAAI,MAAM,qCAET;IAED;;OAEG;IACH,IAAI,MAAM;;;kBAKT;IAED;;OAEG;IACH,IAAI,YAAY,sFAEf;IAED;;OAEG;IACH,IAAI,MAAM,YAET;IAED;;OAEG;IACH,IAAI,UAAU,YAEb;IAED;;OAEG;IACH,IAAI,KAAK,oCAER;IAED;;OAEG;IACH,IAAI,GAAG;;kBAEN;IAED;;OAEG;IACH,IAAI,IAAI,YAEP;IAED;;OAEG;IACH,IAAI,gBAAgB,WAInB;IAED;;OAEG;IACH,IAAI,SAAS,WAIZ;IAED;;OAEG;IACH,IAAI,iBAAiB,WAKpB;IAED;;OAEG;IACH,IAAI,QAAQ,uDAEX;IAED;;;;OAIG;IACH,aAAa,CAAC,SAAS,GAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,MAAiB;IAOlE;;OAEG;IACH,IAAI,UAAU,WAgCb;IAED;;;OAGG;IACG,IAAI,CAAC,IAAI,EAAE,YAAY;IAS7B;;;;OAIG;IACG,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAOvD;;;OAGG;IACG,MAAM;IAwBZ;;OAEG;IACG,SAAS;IAQf;;OAEG;IACG,YAAY;IAIlB;;OAEG;IACG,SAAS;IAIf;;OAEG;IACG,WAAW;IAIjB;;;OAGG;IACG,YAAY;IAOlB;;;OAGG;IACG,WAAW;;;;CAKlB"}

package/lib/esm/classes/User.js

@@ -0,0 +1,252 @@
+import { UserProfile } from "../index.js";
+import { U32_MAX, UserPermission } from "../permissions/definitions.js";
+import { decodeTime } from "ulid";
+/**
+ * User Class
+ */
+export class User {
+    #collection;
+    id;
+    /**
+     * Construct User
+     * @param collection Collection
+     * @param id Id
+     */
+    constructor(collection, id) {
+        this.#collection = collection;
+        this.id = id;
+    }
+    /**
+     * Write to string as a user mention
+     * @returns Formatted String
+     */
+    toString() {
+        return `<@${this.id}>`;
+    }
+    /**
+     * Whether this object exists
+     */
+    get $exists() {
+        return !!this.#collection.getUnderlyingObject(this.id).id;
+    }
+    /**
+     * Time when this user created their account
+     */
+    get createdAt() {
+        return new Date(decodeTime(this.id));
+    }
+    /**
+     * Username
+     */
+    get username() {
+        return this.#collection.getUnderlyingObject(this.id).username;
+    }
+    /**
+     * Discriminator
+     */
+    get discriminator() {
+        return this.#collection.getUnderlyingObject(this.id).discriminator;
+    }
+    /**
+     * Display Name
+     */
+    get displayName() {
+        return (this.#collection.getUnderlyingObject(this.id).displayName ??
+            this.#collection.getUnderlyingObject(this.id).username);
+    }
+    /**
+     * Avatar
+     */
+    get avatar() {
+        return this.#collection.getUnderlyingObject(this.id).avatar;
+    }
+    /**
+     * Badges
+     */
+    get badges() {
+        return this.#collection.getUnderlyingObject(this.id).badges;
+    }
+    /**
+     * User Status
+     */
+    get status() {
+        // TODO: issue with API, upstream fix required #319
+        if (!this.online)
+            return { text: undefined, presence: "Invisible" };
+        return this.#collection.getUnderlyingObject(this.id).status;
+    }
+    /**
+     * Relationship with user
+     */
+    get relationship() {
+        return this.#collection.getUnderlyingObject(this.id).relationship;
+    }
+    /**
+     * Whether the user is online
+     */
+    get online() {
+        return this.#collection.getUnderlyingObject(this.id).online;
+    }
+    /**
+     * Whether the user is privileged
+     */
+    get privileged() {
+        return this.#collection.getUnderlyingObject(this.id).privileged;
+    }
+    /**
+     * Flags
+     */
+    get flags() {
+        return this.#collection.getUnderlyingObject(this.id).flags;
+    }
+    /**
+     * Bot information
+     */
+    get bot() {
+        return this.#collection.getUnderlyingObject(this.id).bot;
+    }
+    /**
+     * Whether this user is ourselves
+     */
+    get self() {
+        return this.#collection.client.user === this;
+    }
+    /**
+     * URL to the user's default avatar
+     */
+    get defaultAvatarURL() {
+        return `${this.#collection.client.options.baseURL}/users/${this.id}/default_avatar`;
+    }
+    /**
+     * URL to the user's avatar
+     */
+    get avatarURL() {
+        return (this.avatar?.createFileURL({ max_side: 256 }) ?? this.defaultAvatarURL);
+    }
+    /**
+     * URL to the user's animated avatar
+     */
+    get animatedAvatarURL() {
+        return (this.avatar?.createFileURL({ max_side: 256 }, true) ??
+            this.defaultAvatarURL);
+    }
+    /**
+     * Presence
+     */
+    get presence() {
+        return this.online ? this.status?.presence ?? "Online" : "Invisible";
+    }
+    /**
+     * Generate status message
+     * @param translate Translation function
+     * @returns Status message
+     */
+    statusMessage(translate = (a) => a) {
+        return this.online
+            ? this.status?.text ??
+                (this.presence === "Focus" ? translate("Focus") : undefined)
+            : undefined;
+    }
+    /**
+     * Permissions against this user
+     */
+    get permission() {
+        let permissions = 0;
+        switch (this.relationship) {
+            case "Friend":
+            case "User":
+                return U32_MAX;
+            case "Blocked":
+            case "BlockedOther":
+                return UserPermission.Access;
+            case "Incoming":
+            case "Outgoing":
+                permissions = UserPermission.Access;
+        }
+        if (this.#collection.client.channels.find((channel) => (channel.type === "Group" || channel.type === "DirectMessage") &&
+            channel.recipientIds.has(this.id)) ||
+            this.#collection.client.serverMembers.find((member) => member.id.user === this.id)) {
+            if (this.#collection.client.user?.bot || this.bot) {
+                permissions |= UserPermission.SendMessage;
+            }
+            permissions |= UserPermission.Access | UserPermission.ViewProfile;
+        }
+        return permissions;
+    }
+    /**
+     * Edit the user
+     * @param data Changes
+     */
+    async edit(data) {
+        await this.#collection.client.api.patch(`/users/${this.id === this.#collection.client.user?.id ? "@me" : this.id}`, data);
+    }
+    /**
+     * Change the username of the current user
+     * @param username New username
+     * @param password Current password
+     */
+    async changeUsername(username, password) {
+        return await this.#collection.client.api.patch("/users/@me/username", {
+            username,
+            password,
+        });
+    }
+    /**
+     * Open a DM with a user
+     * @returns DM Channel
+     */
+    async openDM() {
+        let dm = [...this.#collection.client.channels.values()].find((x) => x.type === "DirectMessage" && x.recipient == this);
+        if (dm) {
+            if (!dm.active) {
+                this.#collection.client.channels.updateUnderlyingObject(dm.id, "active", true);
+            }
+        }
+        else {
+            const data = await this.#collection.client.api.get(`/users/${this.id}/dm`);
+            dm = this.#collection.client.channels.getOrCreate(data._id, data);
+        }
+        return dm;
+    }
+    /**
+     * Send a friend request to a user
+     */
+    async addFriend() {
+        const user = await this.#collection.client.api.post(`/users/friend`, {
+            username: this.username,
+        });
+        return this.#collection.getOrCreate(user._id, user);
+    }
+    /**
+     * Remove a user from the friend list
+     */
+    async removeFriend() {
+        await this.#collection.client.api.delete(`/users/${this.id}/friend`);
+    }
+    /**
+     * Block a user
+     */
+    async blockUser() {
+        await this.#collection.client.api.put(`/users/${this.id}/block`);
+    }
+    /**
+     * Unblock a user
+     */
+    async unblockUser() {
+        await this.#collection.client.api.delete(`/users/${this.id}/block`);
+    }
+    /**
+     * Fetch the profile of a user
+     * @returns The profile of the user
+     */
+    async fetchProfile() {
+        return new UserProfile(this.#collection.client, await this.#collection.client.api.get(`/users/${this.id}/profile`));
+    }
+    /**
+     * Fetch the mutual connections of the current user and a target user
+     * @returns The mutual connections of the current user and a target user
+     */
+    async fetchMutual() {
+        return await this.#collection.client.api.get(`/users/${this.id}/mutual`);
+    }
+}

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

@@ -0,0 +1,23 @@
+import { API, Client, File } from "../index.js";
+/**
+ * User Profile Class
+ */
+export declare class UserProfile {
+    readonly content?: string;
+    readonly banner?: File;
+    /**
+     * Construct Public Bot
+     * @param client Client
+     * @param data Data
+     */
+    constructor(client: Client, data: API.UserProfile);
+    /**
+     * URL to the user's banner
+     */
+    get bannerURL(): string | undefined;
+    /**
+     * URL to the user's animated banner
+     */
+    get animatedBannerURL(): string | undefined;
+}
+//# sourceMappingURL=UserProfile.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"UserProfile.d.ts","sourceRoot":"","sources":["../../../src/classes/UserProfile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAEhD;;GAEG;AACH,qBAAa,WAAW;IACtB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC;IAEvB;;;;OAIG;gBACS,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC,WAAW;IAOjD;;OAEG;IACH,IAAI,SAAS,uBAEZ;IAED;;OAEG;IACH,IAAI,iBAAiB,uBAEpB;CACF"}

package/lib/esm/classes/UserProfile.js

@@ -0,0 +1,31 @@
+import { File } from "../index.js";
+/**
+ * User Profile Class
+ */
+export class UserProfile {
+    content;
+    banner;
+    /**
+     * Construct Public Bot
+     * @param client Client
+     * @param data Data
+     */
+    constructor(client, data) {
+        this.content = data.content;
+        this.banner = data.background
+            ? new File(client, data.background)
+            : undefined;
+    }
+    /**
+     * URL to the user's banner
+     */
+    get bannerURL() {
+        return this.banner?.createFileURL({ width: 1000 });
+    }
+    /**
+     * URL to the user's animated banner
+     */
+    get animatedBannerURL() {
+        return this.banner?.createFileURL({ width: 1000 }, true);
+    }
+}

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

@@ -0,0 +1,21 @@
+export * from "./BannedUser.js";
+export * from "./Bot.js";
+export * from "./Channel.js";
+export * from "./ChannelUnread.js";
+export * from "./ChannelWebhook.js";
+export * from "./Emoji.js";
+export * from "./File.js";
+export * from "./Invite.js";
+export * from "./Message.js";
+export * from "./MessageEmbed.js";
+export * from "./PublicBot.js";
+export * from "./PublicInvite.js";
+export * from "./Server.js";
+export * from "./ServerBan.js";
+export * from "./ServerMember.js";
+export * from "./Session.js";
+export * from "./SystemMessage.js";
+export * from "./User.js";
+export * from "./MFA.js";
+export * from "./UserProfile.js";
+//# sourceMappingURL=index.d.ts.map