hischool.js 0.0.1

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

@@ -0,0 +1,138 @@
+import type { DataBanCreate, DataMemberEdit, MemberCompositeKey } from "../api";
+import { ServerMemberCollection } from "../collections/index.js";
+import { Permission } from "../permissions/definitions.js";
+import { Channel } from "./Channel.js";
+import { Server } from "./Server.js";
+/**
+ * Server Member Class
+ */
+export declare class ServerMember {
+    #private;
+    readonly id: MemberCompositeKey;
+    /**
+     * Construct Server Member
+     * @param collection Collection
+     * @param id Id
+     */
+    constructor(collection: ServerMemberCollection, id: MemberCompositeKey);
+    /**
+     * Convert to string
+     * @returns String
+     */
+    toString(): string;
+    /**
+     * Whether this object exists
+     */
+    get $exists(): boolean;
+    /**
+     * Server this member belongs to
+     */
+    get server(): Server | undefined;
+    /**
+     * User corresponding to this member
+     */
+    get user(): import("./User").User | undefined;
+    /**
+     * When this user joined the server
+     */
+    get joinedAt(): Date;
+    /**
+     * Nickname
+     */
+    get nickname(): string | undefined;
+    /**
+     * Avatar
+     */
+    get avatar(): import("./File").File | undefined;
+    /**
+     * List of role IDs
+     */
+    get roles(): string[];
+    /**
+     * Time at which timeout expires
+     */
+    get timeout(): Date | undefined;
+    /**
+     * Ordered list of roles for this member, from lowest to highest priority.
+     */
+    get orderedRoles(): {
+        name?: string | undefined;
+        permissions?: {
+            a: number;
+            d: number;
+        } | undefined;
+        colour?: string | null | undefined;
+        hoist?: boolean | undefined;
+        rank?: number | undefined;
+        id: string;
+    }[];
+    /**
+     * Member's currently hoisted role.
+     */
+    get hoistedRole(): {
+        name?: string | undefined;
+        permissions?: {
+            a: number;
+            d: number;
+        } | undefined;
+        colour?: string | null | undefined;
+        hoist?: boolean | undefined;
+        rank?: number | undefined;
+        id: string;
+    } | null;
+    /**
+     * Member's current role colour.
+     */
+    get roleColour(): string | null | undefined;
+    /**
+     * Member's ranking
+     * Smaller values are ranked as higher priority
+     */
+    get ranking(): number;
+    /**
+     * Get the permissions that this member has against a certain object
+     * @param target Target object to check permissions against
+     * @returns Permissions that this member has
+     */
+    getPermissions(target: Server | Channel): number;
+    /**
+     * Check whether a member has a certain permission against a certain object
+     * @param target Target object to check permissions against
+     * @param permission Permission names to check for
+     * @returns Whether the member has this permission
+     */
+    hasPermission(target: Server | Channel, ...permission: (keyof typeof Permission)[]): boolean;
+    /**
+     * Checks whether the target member has a higher rank than this member.
+     * @param target The member to compare against
+     * @returns Whether this member is inferior to the target
+     */
+    inferiorTo(target: ServerMember): boolean;
+    /**
+     * Display name
+     */
+    get displayName(): string | undefined;
+    /**
+     * URL to the member's avatar
+     */
+    get avatarURL(): string | undefined;
+    /**
+     * URL to the member's animated avatar
+     */
+    get animatedAvatarURL(): string | undefined;
+    /**
+     * Edit a member
+     * @param data Changes
+     */
+    edit(data: DataMemberEdit): Promise<void>;
+    /**
+     * Ban this member from the server
+     * @param options Ban options
+     */
+    ban(options: DataBanCreate): Promise<void>;
+    /**
+     * Kick this member from the server
+     */
+    kick(): Promise<void>;
+}
+//# sourceMappingURL=ServerMember.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ServerMember.d.ts","sourceRoot":"","sources":["../../../src/classes/ServerMember.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,QAAQ,CAAC;AAChF,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAKjE,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAWrC;;GAEG;AACH,qBAAa,YAAY;;IAEvB,QAAQ,CAAC,EAAE,EAAE,kBAAkB,CAAC;IAEhC;;;;OAIG;gBACS,UAAU,EAAE,sBAAsB,EAAE,EAAE,EAAE,kBAAkB;IAKtE;;;OAGG;IACH,QAAQ;IAIR;;OAEG;IACH,IAAI,OAAO,YAEV;IAED;;OAEG;IACH,IAAI,MAAM,uBAET;IAED;;OAEG;IACH,IAAI,IAAI,sCAEP;IAED;;OAEG;IACH,IAAI,QAAQ,SAEX;IAED;;OAEG;IACH,IAAI,QAAQ,uBAEX;IAED;;OAEG;IACH,IAAI,MAAM,sCAET;IAED;;OAEG;IACH,IAAI,KAAK,aAER;IAED;;OAEG;IACH,IAAI,OAAO,qBAEV;IAED;;OAEG;IACH,IAAI,YAAY;;;;;;;;;;QAUf;IAED;;OAEG;IACH,IAAI,WAAW;;;;;;;;;;aAOd;IAED;;OAEG;IACH,IAAI,UAAU,8BAOb;IAED;;;OAGG;IACH,IAAI,OAAO,WAWV;IAED;;;;OAIG;IACH,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAMvC;;;;;OAKG;IACH,aAAa,CACX,MAAM,EAAE,MAAM,GAAG,OAAO,EACxB,GAAG,UAAU,EAAE,CAAC,MAAM,OAAO,UAAU,CAAC,EAAE;IAQ5C;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,YAAY;IAI/B;;OAEG;IACH,IAAI,WAAW,uBAEd;IAED;;OAEG;IACH,IAAI,SAAS,uBAIZ;IAED;;OAEG;IACH,IAAI,iBAAiB,uBAKpB;IAED;;;OAGG;IACG,IAAI,CAAC,IAAI,EAAE,cAAc;IAO/B;;;OAGG;IACG,GAAG,CAAC,OAAO,EAAE,aAAa;IAIhC;;OAEG;IACG,IAAI;CAGX"}

package/lib/esm/classes/ServerMember.js

@@ -0,0 +1,199 @@
+import { bitwiseAndEq, calculatePermission, } from "../permissions/calculator.js";
+import { Permission } from "../permissions/definitions.js";
+/**
+ * Deterministic conversion of member composite key to string ID
+ * @param key Key
+ * @returns String key
+ */
+function key(key) {
+    return key.server + key.user;
+}
+/**
+ * Server Member Class
+ */
+export class ServerMember {
+    #collection;
+    id;
+    /**
+     * Construct Server Member
+     * @param collection Collection
+     * @param id Id
+     */
+    constructor(collection, id) {
+        this.#collection = collection;
+        this.id = id;
+    }
+    /**
+     * Convert to string
+     * @returns String
+     */
+    toString() {
+        return `<@${this.id.user}>`;
+    }
+    /**
+     * Whether this object exists
+     */
+    get $exists() {
+        return !this.#collection.getUnderlyingObject(key(this.id)).id;
+    }
+    /**
+     * Server this member belongs to
+     */
+    get server() {
+        return this.#collection.client.servers.get(this.id.server);
+    }
+    /**
+     * User corresponding to this member
+     */
+    get user() {
+        return this.#collection.client.users.get(this.id.user);
+    }
+    /**
+     * When this user joined the server
+     */
+    get joinedAt() {
+        return this.#collection.getUnderlyingObject(key(this.id)).joinedAt;
+    }
+    /**
+     * Nickname
+     */
+    get nickname() {
+        return this.#collection.getUnderlyingObject(key(this.id)).nickname;
+    }
+    /**
+     * Avatar
+     */
+    get avatar() {
+        return this.#collection.getUnderlyingObject(key(this.id)).avatar;
+    }
+    /**
+     * List of role IDs
+     */
+    get roles() {
+        return this.#collection.getUnderlyingObject(key(this.id)).roles;
+    }
+    /**
+     * Time at which timeout expires
+     */
+    get timeout() {
+        return this.#collection.getUnderlyingObject(key(this.id)).timeout;
+    }
+    /**
+     * Ordered list of roles for this member, from lowest to highest priority.
+     */
+    get orderedRoles() {
+        const server = this.server;
+        return (this.roles
+            ?.map((id) => ({
+            id,
+            ...server.roles?.get(id),
+        }))
+            .sort((a, b) => b.rank - a.rank) ?? []);
+    }
+    /**
+     * Member's currently hoisted role.
+     */
+    get hoistedRole() {
+        const roles = this.orderedRoles.filter((x) => x.hoist);
+        if (roles.length > 0) {
+            return roles[roles.length - 1];
+        }
+        else {
+            return null;
+        }
+    }
+    /**
+     * Member's current role colour.
+     */
+    get roleColour() {
+        const roles = this.orderedRoles.filter((x) => x.colour);
+        if (roles.length > 0) {
+            return roles[roles.length - 1].colour;
+        }
+        else {
+            return null;
+        }
+    }
+    /**
+     * Member's ranking
+     * Smaller values are ranked as higher priority
+     */
+    get ranking() {
+        if (this.id.user === this.server?.ownerId) {
+            return -Infinity;
+        }
+        const roles = this.orderedRoles;
+        if (roles.length > 0) {
+            return roles[roles.length - 1].rank;
+        }
+        else {
+            return Infinity;
+        }
+    }
+    /**
+     * Get the permissions that this member has against a certain object
+     * @param target Target object to check permissions against
+     * @returns Permissions that this member has
+     */
+    getPermissions(target) {
+        return calculatePermission(this.#collection.client, target, {
+            member: this,
+        });
+    }
+    /**
+     * Check whether a member has a certain permission against a certain object
+     * @param target Target object to check permissions against
+     * @param permission Permission names to check for
+     * @returns Whether the member has this permission
+     */
+    hasPermission(target, ...permission) {
+        return bitwiseAndEq(this.getPermissions(target), ...permission.map((x) => Permission[x]));
+    }
+    /**
+     * Checks whether the target member has a higher rank than this member.
+     * @param target The member to compare against
+     * @returns Whether this member is inferior to the target
+     */
+    inferiorTo(target) {
+        return target.ranking < this.ranking;
+    }
+    /**
+     * Display name
+     */
+    get displayName() {
+        return this.nickname ?? this.user?.displayName;
+    }
+    /**
+     * URL to the member's avatar
+     */
+    get avatarURL() {
+        return (this.avatar?.createFileURL({ max_side: 256 }) ?? this.user?.avatarURL);
+    }
+    /**
+     * URL to the member's animated avatar
+     */
+    get animatedAvatarURL() {
+        return (this.avatar?.createFileURL({ max_side: 256 }, true) ??
+            this.user?.animatedAvatarURL);
+    }
+    /**
+     * Edit a member
+     * @param data Changes
+     */
+    async edit(data) {
+        await this.#collection.client.api.patch(`/servers/${this.id.server}/members/${this.id.user}`, data);
+    }
+    /**
+     * Ban this member from the server
+     * @param options Ban options
+     */
+    async ban(options) {
+        this.server?.banUser(this, options);
+    }
+    /**
+     * Kick this member from the server
+     */
+    async kick() {
+        this.server?.kickUser(this);
+    }
+}

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

@@ -0,0 +1,45 @@
+import { SessionCollection } from "../collections/index.js";
+/**
+ * Session Class
+ */
+export declare class Session {
+    #private;
+    readonly id: string;
+    /**
+     * Construct Session
+     * @param collection Collection
+     * @param id Id
+     */
+    constructor(collection: SessionCollection, id: string);
+    /**
+     * Convert to string
+     * @returns String
+     */
+    toString(): string;
+    /**
+     * Whether this object exists
+     */
+    get $exists(): boolean;
+    /**
+     * Time when this session was created
+     */
+    get createdAt(): Date;
+    /**
+     * Whether this is the current session
+     */
+    get current(): boolean;
+    /**
+     * Name
+     */
+    get name(): string;
+    /**
+     * Rename a session
+     * @param name New name
+     */
+    rename(name: string): Promise<void>;
+    /**
+     * Delete a session
+     */
+    delete(): Promise<void>;
+}
+//# sourceMappingURL=Session.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Session.d.ts","sourceRoot":"","sources":["../../../src/classes/Session.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAG5D;;GAEG;AACH,qBAAa,OAAO;;IAElB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;gBACS,UAAU,EAAE,iBAAiB,EAAE,EAAE,EAAE,MAAM;IAKrD;;;OAGG;IACH,QAAQ;IAIR;;OAEG;IACH,IAAI,OAAO,YAEV;IAED;;OAEG;IACH,IAAI,SAAS,SAEZ;IAED;;OAEG;IACH,IAAI,OAAO,YAEV;IAED;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;;OAGG;IACG,MAAM,CAAC,IAAI,EAAE,MAAM;IAQzB;;OAEG;IACG,MAAM;CAIb"}

package/lib/esm/classes/Session.js

@@ -0,0 +1,65 @@
+import { decodeTime } from "ulid";
+/**
+ * Session Class
+ */
+export class Session {
+    #collection;
+    id;
+    /**
+     * Construct Session
+     * @param collection Collection
+     * @param id Id
+     */
+    constructor(collection, id) {
+        this.#collection = collection;
+        this.id = id;
+    }
+    /**
+     * Convert to string
+     * @returns String
+     */
+    toString() {
+        return this.name;
+    }
+    /**
+     * Whether this object exists
+     */
+    get $exists() {
+        return !!this.#collection.getUnderlyingObject(this.id).id;
+    }
+    /**
+     * Time when this session was created
+     */
+    get createdAt() {
+        return new Date(decodeTime(this.id));
+    }
+    /**
+     * Whether this is the current session
+     */
+    get current() {
+        return this.id === this.#collection.client.sessionId;
+    }
+    /**
+     * Name
+     */
+    get name() {
+        return this.#collection.getUnderlyingObject(this.id).name;
+    }
+    /**
+     * Rename a session
+     * @param name New name
+     */
+    async rename(name) {
+        await this.#collection.client.api.patch(`/auth/session/${this.id}`, {
+            friendly_name: name,
+        });
+        this.#collection.updateUnderlyingObject(this.id, "name", name);
+    }
+    /**
+     * Delete a session
+     */
+    async delete() {
+        await this.#collection.client.api.delete(`/auth/session/${this.id}`);
+        this.#collection.delete(this.id);
+    }
+}

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

@@ -0,0 +1,127 @@
+import { API, Client } from "../index.js";
+/**
+ * System Message
+ */
+export declare abstract class SystemMessage {
+    protected client?: Client;
+    readonly type: API.SystemMessage["type"];
+    /**
+     * Construct System Message
+     * @param client Client
+     * @param type Type
+     */
+    constructor(client: Client, type: API.SystemMessage["type"]);
+    /**
+     * Create an System Message from an API System Message
+     * @param client Client
+     * @param embed Data
+     * @returns System Message
+     */
+    static from(client: Client, message: API.SystemMessage): SystemMessage;
+}
+/**
+ * Text System Message
+ */
+export declare class TextSystemMessage extends SystemMessage {
+    readonly content: string;
+    /**
+     * Construct System Message
+     * @param client Client
+     * @param systemMessage System Message
+     */
+    constructor(client: Client, systemMessage: API.SystemMessage & {
+        type: "text";
+    });
+}
+/**
+ * User System Message
+ */
+export declare class UserSystemMessage extends SystemMessage {
+    readonly userId: string;
+    /**
+     * Construct System Message
+     * @param client Client
+     * @param systemMessage System Message
+     */
+    constructor(client: Client, systemMessage: API.SystemMessage & {
+        type: "user_added" | "user_remove" | "user_joined" | "user_left" | "user_kicked" | "user_banned";
+    });
+    /**
+     * User this message concerns
+     */
+    get user(): import("./User.js").User | undefined;
+}
+/**
+ * User Moderated System Message
+ */
+export declare class UserModeratedSystemMessage extends UserSystemMessage {
+    readonly byId: string;
+    /**
+     * Construct System Message
+     * @param client Client
+     * @param systemMessage System Message
+     */
+    constructor(client: Client, systemMessage: API.SystemMessage & {
+        type: "user_added" | "user_remove";
+    });
+    /**
+     * User this action was performed by
+     */
+    get by(): import("./User.js").User | undefined;
+}
+/**
+ * Channel Edit System Message
+ */
+export declare class ChannelEditSystemMessage extends SystemMessage {
+    readonly byId: string;
+    /**
+     * Construct System Message
+     * @param client Client
+     * @param systemMessage System Message
+     */
+    constructor(client: Client, systemMessage: API.SystemMessage & {
+        type: "channel_renamed" | "channel_description_changed" | "channel_icon_changed";
+    });
+    /**
+     * User this action was performed by
+     */
+    get by(): import("./User.js").User | undefined;
+}
+/**
+ * Channel Renamed System Message
+ */
+export declare class ChannelRenamedSystemMessage extends ChannelEditSystemMessage {
+    readonly name: string;
+    /**
+     * Construct System Message
+     * @param client Client
+     * @param systemMessage System Message
+     */
+    constructor(client: Client, systemMessage: API.SystemMessage & {
+        type: "channel_renamed";
+    });
+}
+/**
+ * Channel Ownership Change System Message
+ */
+export declare class ChannelOwnershipChangeSystemMessage extends SystemMessage {
+    readonly fromId: string;
+    readonly toId: string;
+    /**
+     * Construct System Message
+     * @param client Client
+     * @param systemMessage System Message
+     */
+    constructor(client: Client, systemMessage: API.SystemMessage & {
+        type: "channel_ownership_changed";
+    });
+    /**
+     * User giving away channel ownership
+     */
+    get from(): import("./User.js").User | undefined;
+    /**
+     * User receiving channel ownership
+     */
+    get to(): import("./User.js").User | undefined;
+}
+//# sourceMappingURL=SystemMessage.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SystemMessage.d.ts","sourceRoot":"","sources":["../../../src/classes/SystemMessage.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,aAAa,CAAC,MAAM,CAAC,CAAC;IAEzC;;;;OAIG;gBACS,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC;IAK3D;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,aAAa,GAAG,aAAa;CA0BvE;AAED;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,aAAa;IAClD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;gBAED,MAAM,EAAE,MAAM,EACd,aAAa,EAAE,GAAG,CAAC,aAAa,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;CAKtD;AAED;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,aAAa;IAClD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB;;;;OAIG;gBAED,MAAM,EAAE,MAAM,EACd,aAAa,EAAE,GAAG,CAAC,aAAa,GAAG;QACjC,IAAI,EACA,YAAY,GACZ,aAAa,GACb,aAAa,GACb,WAAW,GACX,aAAa,GACb,aAAa,CAAC;KACnB;IAMH;;OAEG;IACH,IAAI,IAAI,yCAEP;CACF;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,iBAAiB;IAC/D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;gBAED,MAAM,EAAE,MAAM,EACd,aAAa,EAAE,GAAG,CAAC,aAAa,GAAG;QACjC,IAAI,EAAE,YAAY,GAAG,aAAa,CAAC;KACpC;IAMH;;OAEG;IACH,IAAI,EAAE,yCAGL;CACF;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,aAAa;IACzD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;gBAED,MAAM,EAAE,MAAM,EACd,aAAa,EAAE,GAAG,CAAC,aAAa,GAAG;QACjC,IAAI,EACA,iBAAiB,GACjB,6BAA6B,GAC7B,sBAAsB,CAAC;KAC5B;IAMH;;OAEG;IACH,IAAI,EAAE,yCAEL;CACF;AAED;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,wBAAwB;IACvE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;gBAED,MAAM,EAAE,MAAM,EACd,aAAa,EAAE,GAAG,CAAC,aAAa,GAAG;QACjC,IAAI,EAAE,iBAAiB,CAAC;KACzB;CAKJ;AAED;;GAEG;AACH,qBAAa,mCAAoC,SAAQ,aAAa;IACpE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;gBAED,MAAM,EAAE,MAAM,EACd,aAAa,EAAE,GAAG,CAAC,aAAa,GAAG;QACjC,IAAI,EAAE,2BAA2B,CAAC;KACnC;IAOH;;OAEG;IACH,IAAI,IAAI,yCAEP;IAED;;OAEG;IACH,IAAI,EAAE,yCAEL;CACF"}