district.js 0.2.0 → 0.3.0

package/dist/enums.d.ts

@@ -0,0 +1,15 @@
+export declare const ChannelType: {
+    readonly Text: "text";
+    readonly Voice: "voice";
+    readonly Stage: "stage";
+    readonly Event: "event";
+    readonly Lobby: "lobby";
+    readonly Announcement: "announcement";
+    readonly Rules: "rules";
+    readonly Calendar: "calendar";
+    readonly Media: "media";
+    readonly DM: "dm";
+    readonly Overview: "overview";
+    readonly AuditLog: "audit-log";
+};
+export type ChannelTypeValue = (typeof ChannelType)[keyof typeof ChannelType];

package/dist/enums.js

@@ -0,0 +1,15 @@
+// District channel kinds (mirrors the channels.kind check constraint).
+export const ChannelType = {
+    Text: "text",
+    Voice: "voice",
+    Stage: "stage",
+    Event: "event",
+    Lobby: "lobby",
+    Announcement: "announcement",
+    Rules: "rules",
+    Calendar: "calendar",
+    Media: "media",
+    DM: "dm",
+    Overview: "overview",
+    AuditLog: "audit-log",
+};

package/dist/index.d.ts

@@ -1,8 +1,9 @@
 export { Client, type ClientEvents } from "./client.js";
 export { REST, DistrictAPIError, DEFAULT_API_BASE } from "./rest.js";
-export { ClientUser, Message, TextChannel, Interaction, User, Space, SpaceMember, Role, type ClientContext, } from "./structures.js";
+export { ClientUser, Message, TextChannel, Interaction, User, Space, SpaceMember, Role, Attachment, Ban, Invite, Webhook, type ClientContext, } from "./structures.js";
 export { Collection } from "./collection.js";
 export { PermissionsBitField, type PermissionResolvable, type PermissionFlagName } from "./permissions.js";
 export { Formatters } from "./formatters.js";
+export { ChannelType, type ChannelTypeValue } from "./enums.js";
 export { verifySignature, parseEvent, verifyAndParse, type EventHeaders } from "./webhook.js";
-export type { ClientOptions, RawMessage, RawSelfUser, RawUser, RawSpace, RawChannel, RawRole, RawMember, DistrictEvent, ReactionEvent, DeletedMessage, } from "./types.js";
+export type { ClientOptions, RawMessage, RawSelfUser, RawUser, RawSpace, RawChannel, RawRole, RawMember, RawAttachment, RawBan, RawInvite, RawWebhook, DistrictEvent, ReactionEvent, DeletedMessage, } from "./types.js";

package/dist/index.js

@@ -6,8 +6,9 @@
 //   client.listen(3000);
 export { Client } from "./client.js";
 export { REST, DistrictAPIError, DEFAULT_API_BASE } from "./rest.js";
-export { ClientUser, Message, TextChannel, Interaction, User, Space, SpaceMember, Role, } from "./structures.js";
+export { ClientUser, Message, TextChannel, Interaction, User, Space, SpaceMember, Role, Attachment, Ban, Invite, Webhook, } from "./structures.js";
 export { Collection } from "./collection.js";
 export { PermissionsBitField } from "./permissions.js";
 export { Formatters } from "./formatters.js";
+export { ChannelType } from "./enums.js";
 export { verifySignature, parseEvent, verifyAndParse } from "./webhook.js";

package/dist/structures.d.ts

@@ -1,5 +1,5 @@
 import type { REST } from "./rest.js";
-import type { RawMessage, RawSelfUser, RawUser, RawSpace, RawChannel, RawRole, RawMember } from "./types.js";
+import type { RawMessage, RawSelfUser, RawUser, RawSpace, RawChannel, RawRole, RawMember, RawAttachment, RawBan, RawInvite, RawWebhook } from "./types.js";
 import { Collection } from "./collection.js";
 import { PermissionsBitField } from "./permissions.js";
 /** Minimal client surface the structures need (avoids a circular import). */
@@ -25,6 +25,8 @@ export declare class Message {
     createdAt: string | null;
     editedAt: string | null;
     parentId: string | null;
+    /** Media/files on the message (populated from fetchMessages / fetchAttachments). */
+    attachments: Attachment[];
     constructor(client: ClientContext, raw: RawMessage);
     /** True if this message was sent by the current bot. */
     get authoredByMe(): boolean;
@@ -42,6 +44,8 @@ export declare class Message {
     fetchAuthor(): Promise<User>;
     /** A handle to the channel this message is in. */
     get channel(): TextChannel;
+    /** Fetch this message's attachments (useful for messages from events). */
+    fetchAttachments(): Promise<Attachment[]>;
 }
 export declare class TextChannel {
     private client;
@@ -61,6 +65,12 @@ export declare class TextChannel {
     send(content: string): Promise<Message>;
     /** Fetch recent messages (oldest → newest), up to 100. */
     fetchMessages(limit?: number): Promise<Collection<string, Message>>;
+    /** The channel's webhooks. */
+    webhooks(): Promise<Collection<string, Webhook>>;
+    /** Create a webhook. The returned Webhook has a one-time url + token you can send() with. */
+    createWebhook(name: string, options?: {
+        avatarUrl?: string;
+    }): Promise<Webhook>;
 }
 /** A District user's public profile. */
 export declare class User {
@@ -94,6 +104,76 @@ export declare class Space {
     roles(): Promise<Collection<string, Role>>;
     /** The space owner's profile. */
     fetchOwner(): Promise<User>;
+    /** Banned users. */
+    bans(): Promise<Collection<string, Ban>>;
+    /** Ban a user (needs the Ban Members permission). Removes their membership. */
+    ban(userId: string, options?: {
+        reason?: string;
+        until?: string | Date;
+    }): Promise<void>;
+    /** Lift a user's ban. */
+    unban(userId: string): Promise<void>;
+    /** Active invites. */
+    invites(): Promise<Collection<string, Invite>>;
+    /** Create an invite (needs Create Invites). `expiresIn` is seconds. */
+    createInvite(options?: {
+        maxUses?: number;
+        expiresIn?: number;
+    }): Promise<Invite>;
+}
+/** A file or media on a message. */
+export declare class Attachment {
+    id: string;
+    kind: string;
+    url: string;
+    thumbUrl: string | null;
+    filename: string | null;
+    mimeType: string | null;
+    size: number | null;
+    width: number | null;
+    height: number | null;
+    spoiler: boolean;
+    constructor(raw: RawAttachment);
+    get isImage(): boolean;
+    get isVideo(): boolean;
+}
+/** A space ban. */
+export declare class Ban {
+    userId: string;
+    reason: string | null;
+    until: string | null;
+    by: string;
+    constructor(raw: RawBan);
+    /** True if the ban is permanent (no expiry). */
+    get permanent(): boolean;
+}
+/** A space invite. */
+export declare class Invite {
+    id: string;
+    code: string;
+    url: string;
+    maxUses: number | null;
+    useCount: number;
+    expiresAt: string | null;
+    constructor(raw: RawInvite);
+}
+/** A channel webhook. `url`/`token` are only present on the one you just created. */
+export declare class Webhook {
+    private client;
+    id: string;
+    name: string;
+    channelId: string;
+    avatarUrl: string | null;
+    url: string | null;
+    token: string | null;
+    constructor(client: ClientContext, raw: RawWebhook);
+    /** Post via this webhook. Only works on a webhook you just created (has a url). */
+    send(content: string, options?: {
+        username?: string;
+        avatarUrl?: string;
+    }): Promise<void>;
+    /** Delete this webhook. */
+    delete(): Promise<void>;
 }
 /** A user's membership in a space. */
 export declare class SpaceMember {

package/dist/structures.js

@@ -25,6 +25,8 @@ export class Message {
     createdAt;
     editedAt;
     parentId;
+    /** Media/files on the message (populated from fetchMessages / fetchAttachments). */
+    attachments;
     constructor(client, raw) {
         this.client = client;
         this.id = raw.id;
@@ -34,6 +36,7 @@ export class Message {
         this.createdAt = raw.created_at ?? null;
         this.editedAt = raw.edited_at ?? null;
         this.parentId = raw.parent_id ?? null;
+        this.attachments = (raw.attachments ?? []).map((a) => new Attachment(a));
     }
     /** True if this message was sent by the current bot. */
     get authoredByMe() { return !!this.client.user && this.authorId === this.client.user.id; }
@@ -69,6 +72,11 @@ export class Message {
     get channel() {
         return new TextChannel(this.client, this.channelId);
     }
+    /** Fetch this message's attachments (useful for messages from events). */
+    async fetchAttachments() {
+        const { attachments } = await this.client.rest.get(`/channels/${this.channelId}/messages/${this.id}/attachments`);
+        return (attachments ?? []).map((a) => new Attachment(a));
+    }
 }
 export class TextChannel {
     client;
@@ -110,6 +118,19 @@ export class TextChannel {
             out.set(m.id, new Message(this.client, m));
         return out;
     }
+    /** The channel's webhooks. */
+    async webhooks() {
+        const { webhooks } = await this.client.rest.get(`/channels/${this.id}/webhooks`);
+        const out = new Collection();
+        for (const w of (webhooks ?? []))
+            out.set(w.id, new Webhook(this.client, w));
+        return out;
+    }
+    /** Create a webhook. The returned Webhook has a one-time url + token you can send() with. */
+    async createWebhook(name, options) {
+        const { webhook } = await this.client.rest.post(`/channels/${this.id}/webhooks`, { name, avatarUrl: options?.avatarUrl });
+        return new Webhook(this.client, webhook);
+    }
 }
 /** A District user's public profile. */
 export class User {
@@ -182,6 +203,128 @@ export class Space {
         const { user } = await this.client.rest.get(`/users/${this.ownerId}`);
         return new User(user);
     }
+    /** Banned users. */
+    async bans() {
+        const { bans } = await this.client.rest.get(`/spaces/${this.id}/bans`);
+        const out = new Collection();
+        for (const b of (bans ?? []))
+            out.set(b.user_id, new Ban(b));
+        return out;
+    }
+    /** Ban a user (needs the Ban Members permission). Removes their membership. */
+    async ban(userId, options) {
+        const until = options?.until ? new Date(options.until).toISOString() : undefined;
+        await this.client.rest.put(`/spaces/${this.id}/bans/${userId}`, { reason: options?.reason, until });
+    }
+    /** Lift a user's ban. */
+    async unban(userId) {
+        await this.client.rest.delete(`/spaces/${this.id}/bans/${userId}`);
+    }
+    /** Active invites. */
+    async invites() {
+        const { invites } = await this.client.rest.get(`/spaces/${this.id}/invites`);
+        const out = new Collection();
+        for (const i of (invites ?? []))
+            out.set(i.code, new Invite(i));
+        return out;
+    }
+    /** Create an invite (needs Create Invites). `expiresIn` is seconds. */
+    async createInvite(options) {
+        const { invite } = await this.client.rest.post(`/spaces/${this.id}/invites`, { maxUses: options?.maxUses, expiresIn: options?.expiresIn });
+        return new Invite(invite);
+    }
+}
+/** A file or media on a message. */
+export class Attachment {
+    id;
+    kind;
+    url;
+    thumbUrl;
+    filename;
+    mimeType;
+    size;
+    width;
+    height;
+    spoiler;
+    constructor(raw) {
+        this.id = raw.id;
+        this.kind = raw.kind;
+        this.url = raw.url;
+        this.thumbUrl = raw.thumb_url ?? null;
+        this.filename = raw.filename ?? null;
+        this.mimeType = raw.mime_type ?? null;
+        this.size = raw.size_bytes ?? null;
+        this.width = raw.width ?? null;
+        this.height = raw.height ?? null;
+        this.spoiler = raw.spoiler ?? false;
+    }
+    get isImage() { return this.kind === "image" || this.kind === "gifv"; }
+    get isVideo() { return this.kind === "video"; }
+}
+/** A space ban. */
+export class Ban {
+    userId;
+    reason;
+    until;
+    by;
+    constructor(raw) {
+        this.userId = raw.user_id;
+        this.reason = raw.reason;
+        this.until = raw.until;
+        this.by = raw.by;
+    }
+    /** True if the ban is permanent (no expiry). */
+    get permanent() { return this.until === null; }
+}
+/** A space invite. */
+export class Invite {
+    id;
+    code;
+    url;
+    maxUses;
+    useCount;
+    expiresAt;
+    constructor(raw) {
+        this.id = raw.id;
+        this.code = raw.code;
+        this.url = raw.url ?? `https://usedistrict.org/i/${raw.code}`;
+        this.maxUses = raw.max_uses;
+        this.useCount = raw.use_count ?? 0;
+        this.expiresAt = raw.expires_at;
+    }
+}
+/** A channel webhook. `url`/`token` are only present on the one you just created. */
+export class Webhook {
+    client;
+    id;
+    name;
+    channelId;
+    avatarUrl;
+    url;
+    token;
+    constructor(client, raw) {
+        this.client = client;
+        this.id = raw.id;
+        this.name = raw.name;
+        this.channelId = raw.channel_id;
+        this.avatarUrl = raw.avatar_url ?? null;
+        this.url = raw.url ?? null;
+        this.token = raw.token ?? null;
+    }
+    /** Post via this webhook. Only works on a webhook you just created (has a url). */
+    async send(content, options) {
+        if (!this.url)
+            throw new Error("This webhook has no url/token — those are only returned when it's first created.");
+        await fetch(this.url, {
+            method: "POST",
+            headers: { "content-type": "application/json" },
+            body: JSON.stringify({ content, username: options?.username, avatar_url: options?.avatarUrl }),
+        });
+    }
+    /** Delete this webhook. */
+    async delete() {
+        await this.client.rest.delete(`/channels/${this.channelId}/webhooks/${this.id}`);
+    }
 }
 /** A user's membership in a space. */
 export class SpaceMember {

package/dist/types.d.ts

@@ -19,6 +19,47 @@ export interface RawMessage {
     created_at?: string;
     edited_at?: string | null;
     parent_id?: string | null;
+    attachments?: RawAttachment[];
+}
+/** A message attachment (image/video/file/…). */
+export interface RawAttachment {
+    id: string;
+    kind: string;
+    url: string;
+    thumb_url?: string | null;
+    filename?: string | null;
+    mime_type?: string | null;
+    size_bytes?: number | null;
+    width?: number | null;
+    height?: number | null;
+    spoiler?: boolean;
+}
+/** A space ban (`GET /spaces/:id/bans`). */
+export interface RawBan {
+    user_id: string;
+    reason: string | null;
+    until: string | null;
+    by: string;
+    created_at?: string;
+}
+/** A space invite (`GET/POST /spaces/:id/invites`). */
+export interface RawInvite {
+    id: string;
+    code: string;
+    url?: string;
+    max_uses: number | null;
+    use_count?: number;
+    expires_at: string | null;
+    revoked_at?: string | null;
+}
+/** A channel webhook (`GET/POST /channels/:id/webhooks`). */
+export interface RawWebhook {
+    id: string;
+    name: string;
+    channel_id: string;
+    avatar_url?: string | null;
+    token?: string;
+    url?: string;
 }
 /** The bot's own identity (`GET /me`). */
 export interface RawSelfUser {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "district.js",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "A powerful Node.js module for building District bots — post, react, run slash commands, and receive events.",
   "type": "module",
   "main": "./dist/index.js",