hischool.js 0.0.1

package/lib/cjs/classes/PublicBot.js

@@ -0,0 +1,60 @@
+"use strict";
+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 _PublicBot_client;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublicBot = void 0;
+const index_js_1 = require("../index.js");
+/**
+ * Public Bot Class
+ */
+class PublicBot {
+    /**
+     * Construct Public Bot
+     * @param client Client
+     * @param data Data
+     */
+    constructor(client, data) {
+        _PublicBot_client.set(this, void 0);
+        __classPrivateFieldSet(this, _PublicBot_client, client, "f");
+        this.id = data._id;
+        this.username = data.username;
+        this.avatar = data.avatar
+            ? new index_js_1.File(client, {
+                _id: data.avatar,
+                tag: "avatars",
+            })
+            : undefined;
+        this.description = data.description;
+    }
+    /**
+     * Add the bot to a server
+     * @param server Server
+     */
+    addToServer(server) {
+        __classPrivateFieldGet(this, _PublicBot_client, "f").api.post(`/bots/${this.id}/invite`, {
+            server: server instanceof index_js_1.Server ? server.id : server,
+        });
+    }
+    /**
+     * Add the bot to a group
+     * @param group Group
+     */
+    addToGroup(group) {
+        // TODO: should use GroupChannel once that is added
+        __classPrivateFieldGet(this, _PublicBot_client, "f").api.post(`/bots/${this.id}/invite`, {
+            group: group instanceof index_js_1.Channel ? group.id : group,
+        });
+    }
+}
+exports.PublicBot = PublicBot;
+_PublicBot_client = new WeakMap();

package/lib/cjs/classes/PublicInvite.d.ts

@@ -0,0 +1,57 @@
+import { ServerFlags } from "../hydration/server.js";
+import { API, Client, File } from "../index.js";
+/**
+ * Public Channel Invite
+ */
+export declare abstract class PublicChannelInvite {
+    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 Response
+     * @param client Client
+     * @param invite Data
+     * @returns Invite
+     */
+    static from(client: Client, invite: API.InviteResponse): PublicChannelInvite;
+}
+/**
+ * Public invite of unknown type
+ */
+export declare class UnknownPublicInvite extends PublicChannelInvite {
+}
+/**
+ * Public Server Invite
+ */
+export declare class ServerPublicInvite extends PublicChannelInvite {
+    readonly code: string;
+    readonly userName: string;
+    readonly userAvatar?: File;
+    readonly serverId: string;
+    readonly serverName: string;
+    readonly serverIcon?: File;
+    readonly serverBanner?: File;
+    readonly serverFlags: ServerFlags;
+    readonly memberCount: number;
+    readonly channelId: string;
+    readonly channelName: string;
+    readonly channelDescription?: string;
+    /**
+     * Construct Server Invite
+     * @param client Client
+     * @param invite Invite
+     */
+    constructor(client: Client, invite: API.InviteResponse & {
+        type: "Server";
+    });
+    /**
+     * Join the server
+     */
+    join(): Promise<import("./Server.js").Server>;
+}
+//# sourceMappingURL=PublicInvite.d.ts.map

package/lib/cjs/classes/PublicInvite.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PublicInvite.d.ts","sourceRoot":"","sources":["../../../src/classes/PublicInvite.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAGhD;;GAEG;AACH,8BAAsB,mBAAmB;IACvC,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,cAAc,GAAG,mBAAmB;CAQ7E;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,mBAAmB;CAAG;AAE/D;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,mBAAmB;IACzD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC;IAE3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC;IAC3B,QAAQ,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC;IAC7B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAE7B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAErC;;;;OAIG;gBACS,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,cAAc,GAAG;QAAE,IAAI,EAAE,QAAQ,CAAA;KAAE;IAyB3E;;OAEG;IACG,IAAI;CAsBX"}

package/lib/cjs/classes/PublicInvite.js

@@ -0,0 +1,104 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerPublicInvite = exports.UnknownPublicInvite = exports.PublicChannelInvite = void 0;
+const index_js_1 = require("../index.js");
+const solid_js_1 = require("solid-js");
+/**
+ * Public Channel Invite
+ */
+class PublicChannelInvite {
+    /**
+     * 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 Response
+     * @param client Client
+     * @param invite Data
+     * @returns Invite
+     */
+    static from(client, invite) {
+        switch (invite.type) {
+            case "Server":
+                return new ServerPublicInvite(client, invite);
+            default:
+                return new UnknownPublicInvite(client);
+        }
+    }
+}
+exports.PublicChannelInvite = PublicChannelInvite;
+/**
+ * Public invite of unknown type
+ */
+class UnknownPublicInvite extends PublicChannelInvite {
+}
+exports.UnknownPublicInvite = UnknownPublicInvite;
+/**
+ * Public Server Invite
+ */
+class ServerPublicInvite extends PublicChannelInvite {
+    /**
+     * Construct Server Invite
+     * @param client Client
+     * @param invite Invite
+     */
+    constructor(client, invite) {
+        var _a;
+        super(client, "Server");
+        this.code = invite.code;
+        this.userName = invite.user_name;
+        this.userAvatar = invite.user_avatar
+            ? new index_js_1.File(client, invite.user_avatar)
+            : undefined;
+        this.serverId = invite.server_id;
+        this.serverName = invite.server_name;
+        this.serverIcon = invite.server_icon
+            ? new index_js_1.File(client, invite.server_icon)
+            : undefined;
+        this.serverBanner = invite.server_banner
+            ? new index_js_1.File(client, invite.server_banner)
+            : undefined;
+        this.serverFlags = (_a = invite.server_flags) !== null && _a !== void 0 ? _a : 0;
+        this.memberCount = invite.member_count;
+        this.channelId = invite.channel_id;
+        this.channelName = invite.channel_name;
+        this.channelDescription = invite.channel_description;
+    }
+    /**
+     * Join the server
+     */
+    join() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const existingServer = this.client.servers.get(this.serverId);
+            if (existingServer)
+                return existingServer;
+            const invite = yield this.client.api.post(`/invites/${this.code}`);
+            if (invite.type === "Server") {
+                return (0, solid_js_1.batch)(() => {
+                    for (const channel of invite.channels) {
+                        this.client.channels.getOrCreate(channel._id, channel);
+                    }
+                    return this.client.servers.getOrCreate(invite.server._id, invite.server, true);
+                });
+            }
+            else {
+                throw "unreachable";
+            }
+        });
+    }
+}
+exports.ServerPublicInvite = ServerPublicInvite;

package/lib/cjs/classes/Server.d.ts

@@ -0,0 +1,473 @@
+import type { Category, DataBanCreate, DataCreateEmoji, DataCreateServerChannel, DataEditRole, DataEditServer, Override } from "../api";
+import { ServerCollection } from "../collections/index.js";
+import { ServerMember, User } from "../index.js";
+import { Permission } from "../permissions/definitions.js";
+import { Channel } from "./Channel.js";
+import { ChannelInvite } from "./Invite.js";
+import { ServerBan } from "./ServerBan.js";
+/**
+ * Server Class
+ */
+export declare class Server {
+    #private;
+    readonly id: string;
+    /**
+     * Construct Server
+     * @param collection Collection
+     * @param id Id
+     */
+    constructor(collection: ServerCollection, id: string);
+    /**
+     * Convert to string
+     * @returns String
+     */
+    toString(): string;
+    /**
+     * Whether this object exists
+     */
+    get $exists(): boolean;
+    /**
+     * Time when this server was created
+     */
+    get createdAt(): Date;
+    /**
+     * Owner's user ID
+     */
+    get ownerId(): string;
+    /**
+     * Owner
+     */
+    get owner(): User | undefined;
+    /**
+     * Name
+     */
+    get name(): string;
+    /**
+     * Description
+     */
+    get description(): string | undefined;
+    /**
+     * Icon
+     */
+    get icon(): import("./File").File | undefined;
+    /**
+     * Banner
+     */
+    get banner(): import("./File").File | undefined;
+    /**
+     * Channel IDs
+     */
+    get channelIds(): import("@solid-primitives/set").ReactiveSet<string>;
+    /**
+     * Channels
+     */
+    get channels(): Channel[];
+    /**
+     * Categories
+     */
+    get categories(): {
+        id: string;
+        title: string;
+        channels: string[];
+    }[] | undefined;
+    /**
+     * System message channels
+     */
+    get systemMessages(): {
+        user_joined?: string | null | undefined;
+        user_left?: string | null | undefined;
+        user_kicked?: string | null | undefined;
+        user_banned?: string | null | undefined;
+    } | undefined;
+    /**
+     * Roles
+     */
+    get roles(): import("@solid-primitives/map").ReactiveMap<string, {
+        name: string;
+        permissions: {
+            a: number;
+            d: number;
+        };
+        colour?: string | null | undefined;
+        hoist?: boolean | undefined;
+        rank?: number | undefined;
+    }>;
+    /**
+     * Default permissions
+     */
+    get defaultPermissions(): number;
+    /**
+     * Server flags
+     */
+    get flags(): import("../index.js").ServerFlags;
+    /**
+     * Whether analytics are enabled for this server
+     */
+    get analytics(): boolean;
+    /**
+     * Whether this server is publicly discoverable
+     */
+    get discoverable(): boolean;
+    /**
+     * Whether this server is marked as mature
+     */
+    get mature(): boolean;
+    /**
+     * Get an array of ordered categories with their respective channels.
+     * Uncategorised channels are returned in `id="default"` category.
+     */
+    get orderedChannels(): (Omit<Category, "channels"> & {
+        channels: Channel[];
+    })[];
+    /**
+     * Default channel for this server
+     */
+    get defaultChannel(): Channel | undefined;
+    /**
+     * Get an ordered array of roles with their IDs attached.
+     * The highest ranking roles will be first followed by lower
+     * ranking roles. This is dictated by the "rank" property
+     * which is smaller for higher priority roles.
+     */
+    get orderedRoles(): {
+        name: string;
+        permissions: {
+            a: number;
+            d: number;
+        };
+        colour?: string | null | undefined;
+        hoist?: boolean | undefined;
+        rank?: number | undefined;
+        id: string;
+    }[];
+    /**
+     * Check whether the server is currently unread
+     * @returns Whether the server is unread
+     */
+    get unread(): Channel | undefined;
+    /**
+     * Find all message IDs of unread messages
+     * @returns Array of message IDs which are unread
+     */
+    get mentions(): string[];
+    /**
+     * URL to the server's icon
+     */
+    get iconURL(): string | undefined;
+    /**
+     * URL to the server's animated icon
+     */
+    get animatedIconURL(): string | undefined;
+    /**
+     * URL to the server's banner
+     */
+    get bannerURL(): string | undefined;
+    /**
+     * Own member object for this server
+     */
+    get member(): ServerMember | undefined;
+    /**
+     * Permission the currently authenticated user has against this server
+     */
+    get permission(): number;
+    /**
+     * Check whether we have a given permission in a server
+     * @param permission Permission Names
+     * @returns Whether we have this permission
+     */
+    havePermission(...permission: (keyof typeof Permission)[]): boolean;
+    /**
+     * Check whether we have at least one of the given permissions in a server
+     * @param permission Permission Names
+     * @returns Whether we have one of the permissions
+     */
+    orPermission(...permission: (keyof typeof Permission)[]): boolean;
+    /**
+     * Helper function to retrieve cached server member by their ID in this server
+     * @param userId User's ID
+     * @returns Server Member (if cached)
+     */
+    getMember(userId: string): ServerMember | undefined;
+    /**
+     * Create a channel
+     * @param data Channel create route data
+     * @returns The newly-created channel
+     */
+    createChannel(data: DataCreateServerChannel): Promise<Channel>;
+    /**
+     * Edit a server
+     * @param data Changes
+     */
+    edit(data: DataEditServer): Promise<void>;
+    /**
+     * Delete the underlying server
+     * @param leaveEvent Whether we are leaving
+     */
+    $delete(leaveEvent?: boolean): void;
+    /**
+     * Delete or leave a server
+     * @param leaveSilently Whether to not send a message on leave
+     */
+    delete(leaveSilently?: boolean): Promise<void>;
+    /**
+     * Mark a server as read
+     */
+    ack(): Promise<void>;
+    /**
+     * Ban user from this server
+     * @param user User
+     * @param options Ban options
+     */
+    banUser(user: string | User | ServerMember, options?: DataBanCreate): Promise<ServerBan>;
+    /**
+     * Kick user from this server
+     * @param user User
+     */
+    kickUser(user: string | User | ServerMember): Promise<undefined>;
+    /**
+     * Pardon user's ban
+     * @param user User
+     */
+    unbanUser(user: string | User): Promise<undefined>;
+    /**
+     * Fetch a server's invites
+     * @returns An array of the server's invites
+     */
+    fetchInvites(): Promise<ChannelInvite[]>;
+    /**
+     * Fetch a server's bans
+     * @returns An array of the server's bans.
+     */
+    fetchBans(): Promise<ServerBan[]>;
+    /**
+     * Set role permissions
+     * @param roleId Role Id, set to 'default' to affect all users
+     * @param permissions Permission value
+     */
+    setPermissions(roleId: string | undefined, permissions: Override | number): Promise<{
+        _id: string;
+        owner: string;
+        name: string;
+        description?: string | null | undefined;
+        channels: string[];
+        categories?: {
+            id: string;
+            title: string;
+            channels: string[];
+        }[] | null | undefined;
+        system_messages?: {
+            user_joined?: string | null | undefined;
+            user_left?: string | null | undefined;
+            user_kicked?: string | null | undefined;
+            user_banned?: string | null | undefined;
+        } | null | undefined;
+        roles?: {
+            [key: string]: {
+                name: string;
+                permissions: {
+                    a: number;
+                    d: number;
+                };
+                colour?: string | null | undefined;
+                hoist?: boolean | undefined;
+                rank?: number | undefined;
+            };
+        } | undefined;
+        default_permissions: number;
+        icon?: {
+            _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;
+        banner?: {
+            _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;
+        flags?: number | undefined;
+        nsfw?: boolean | undefined;
+        analytics?: boolean | undefined;
+        discoverable?: boolean | undefined;
+    }>;
+    /**
+     * Create role
+     * @param name Role name
+     */
+    createRole(name: string): Promise<{
+        id: string;
+        role: {
+            name: string;
+            permissions: {
+                a: number;
+                d: number;
+            };
+            colour?: string | null | undefined;
+            hoist?: boolean | undefined;
+            rank?: number | undefined;
+        };
+    }>;
+    /**
+     * Edit a role
+     * @param roleId Role ID
+     * @param data Role editing route data
+     */
+    editRole(roleId: string, data: DataEditRole): Promise<{
+        name: string;
+        permissions: {
+            a: number;
+            d: number;
+        };
+        colour?: string | null | undefined;
+        hoist?: boolean | undefined;
+        rank?: number | undefined;
+    }>;
+    /**
+     * Delete role
+     * @param roleId Role ID
+     */
+    deleteRole(roleId: string): Promise<undefined>;
+    /**
+     * Fetch a server member
+     * @param user User
+     * @returns Server member object
+     */
+    fetchMember(user: User | string): Promise<ServerMember>;
+    /**
+     * Optimised member fetch route
+     * @param excludeOffline
+     */
+    syncMembers(excludeOffline?: boolean): Promise<void>;
+    /**
+     * Reset member sync status
+     */
+    resetSyncStatus(): void;
+    /**
+     * Fetch a server's members
+     * @returns List of the server's members and their user objects
+     */
+    fetchMembers(): Promise<{
+        members: ServerMember[];
+        users: User[];
+    }>;
+    /**
+     * Query members from a server by name
+     * @param query Name
+     * @returns List of the server's members and their user objects
+     */
+    queryMembersExperimental(query: string): Promise<{
+        members: ServerMember[];
+        users: User[];
+    }>;
+    /**
+     * Create an emoji on the server
+     * @param autumnId Autumn Id
+     * @param options Options
+     */
+    createEmoji(autumnId: string, options: Omit<DataCreateEmoji, "parent">): Promise<import("./Emoji").Emoji>;
+    /**
+     * Fetch a server's emoji
+     * @returns List of server emoji
+     */
+    fetchEmojis(): Promise<import("./Emoji").Emoji[]>;
+    /**
+     * Delete emoji
+     * @param emojiId Emoji ID
+     */
+    deleteEmoji(emojiId: 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;
+    } | undefined>;
+}
+//# sourceMappingURL=Server.d.ts.map