chore: switch to bigint handling for permissions

Author: insertish

package.json

@@ -1,6 +1,6 @@
 {
   "name": "stoat.js",
-  "version": "7.3.1",
+  "version": "7.3.2",
   "type": "module",
   "exports": {
     ".": "./lib/index.js"
@@ -29,8 +29,9 @@
     "@solid-primitives/map": "^0.7.1",
     "@solid-primitives/set": "^0.7.1",
     "@vladfrangu/async_event_emitter": "^2.4.6",
-    "stoat-api": "0.8.9-3",
+    "json-with-bigint": "^3.4.4",
     "solid-js": "^1.9.6",
+    "stoat-api": "0.8.9-4",
     "ulid": "^2.4.0"
   },
   "devDependencies": {

pnpm-lock.yaml

@@ -12,7 +12,7 @@ import type {
   Invite,
   Override,
 } from "stoat-api";
-import type { APIRoutes } from "stoat-api/lib/routes";
+import type { APIRoutes } from "stoat-api";
 import { decodeTime, ulid } from "ulid";
 
 import { ChannelCollection } from "../collections/index.js";
@@ -229,21 +229,21 @@ export class Channel {
   /**
    * Permissions allowed for users in this group
    */
-  get permissions(): number | undefined {
+  get permissions(): bigint | undefined {
     return this.#collection.getUnderlyingObject(this.id).permissions;
   }
 
   /**
    * Default permissions for this server channel
    */
-  get defaultPermissions(): { a: number; d: number } | undefined {
+  get defaultPermissions(): { a: bigint; d: bigint } | undefined {
     return this.#collection.getUnderlyingObject(this.id).defaultPermissions;
   }
 
   /**
    * Role permissions for this server channel
    */
-  get rolePermissions(): Record<string, { a: number; d: number }> | undefined {
+  get rolePermissions(): Record<string, { a: bigint; d: bigint }> | undefined {
     return this.#collection.getUnderlyingObject(this.id).rolePermissions;
   }
 
@@ -349,16 +349,16 @@ export class Channel {
   get potentiallyRestrictedChannel(): string | boolean | undefined {
     if (!this.serverId) return false;
     return (
-      bitwiseAndEq(this.defaultPermissions?.d ?? 0, Permission.ViewChannel) ||
+      bitwiseAndEq(this.defaultPermissions?.d ?? 0n, Permission.ViewChannel) ||
       !bitwiseAndEq(this.server!.defaultPermissions, Permission.ViewChannel) ||
       [...(this.server?.roles.keys() ?? [])].find(
         (role) =>
           bitwiseAndEq(
-            this.rolePermissions?.[role]?.d ?? 0,
+            this.rolePermissions?.[role]?.d ?? 0n,
             Permission.ViewChannel,
           ) ||
           bitwiseAndEq(
-            this.server?.roles.get(role)?.permissions.d ?? 0,
+            this.server?.roles.get(role)?.permissions.d ?? 0n,
             Permission.ViewChannel,
           ),
       )
@@ -368,7 +368,7 @@ export class Channel {
   /**
    * Permission the currently authenticated user has against this channel
    */
-  get permission(): number {
+  get permission(): bigint {
     return calculatePermission(this.#collection.client, this);
   }
 

src/classes/Channel.ts

@@ -167,7 +167,7 @@ export class Server {
   /**
    * Default permissions
    */
-  get defaultPermissions(): number {
+  get defaultPermissions(): bigint {
     return this.#collection.getUnderlyingObject(this.id).defaultPermissions;
   }
 
@@ -271,7 +271,7 @@ export class Server {
    */
   get orderedRoles(): {
     name: string;
-    permissions: OverrideField;
+    permissions: { a: bigint, d: bigint };
     colour?: string | null;
     hoist?: boolean;
     rank?: number;
@@ -337,7 +337,7 @@ export class Server {
   /**
    * Permission the currently authenticated user has against this server
    */
-  get permission(): number {
+  get permission(): bigint {
     return calculatePermission(this.#collection.client, this);
   }
 
@@ -514,12 +514,11 @@ export class Server {
    */
   async kickUser(user: string | User | ServerMember): Promise<void> {
     return await this.#collection.client.api.delete(
-      `/servers/${this.id as ""}/members/${
-        typeof user === "string"
-          ? user
-          : user instanceof User
-            ? user.id
-            : user.id.user
+      `/servers/${this.id as ""}/members/${typeof user === "string"
+        ? user
+        : user instanceof User
+          ? user.id
+          : user.id.user
       }`,
     );
   }
@@ -723,8 +722,7 @@ export class Server {
     query: string,
   ): Promise<{ members: ServerMember[]; users: User[] }> {
     const data = (await this.#collection.client.api.get(
-      `/servers/${
-        this.id as ""
+      `/servers/${this.id as ""
       }/members_experimental_query?experimental_api=true&query=${encodeURIComponent(
         query,
       )}` as never,

src/classes/Server.ts

@@ -110,7 +110,7 @@ export class ServerMember {
   /**
    * Ordered list of roles for this member, from lowest to highest priority.
    */
-  get orderedRoles(): (Partial<Role> & { id: string })[] {
+  get orderedRoles(): (Partial<Omit<Role, 'permissions'> & { permissions: { a: bigint, d: bigint } }> & { id: string })[] {
     const server = this.server!;
     return (
       this.roles
@@ -125,7 +125,7 @@ export class ServerMember {
   /**
    * Member's currently hoisted role.
    */
-  get hoistedRole(): Partial<Role> | null {
+  get hoistedRole(): Partial<Omit<Role, 'permissions'> & { permissions: { a: bigint, d: bigint } }> | null {
     const roles = this.orderedRoles.filter((x) => x.hoist);
     if (roles.length > 0) {
       return roles[roles.length - 1];
@@ -168,7 +168,7 @@ export class ServerMember {
    * @param target Target object to check permissions against
    * @returns Permissions that this member has
    */
-  getPermissions(target: Server | Channel): number {
+  getPermissions(target: Server | Channel): bigint {
     return calculatePermission(this.#collection.client, target, {
       member: this,
     });

src/classes/ServerMember.ts

@@ -1,4 +1,4 @@
-import type { Role as APIRole, OverrideField } from "stoat-api";
+import type { Role as APIRole } from "stoat-api";
 
 import type { Client } from "../Client.js";
 
@@ -11,7 +11,10 @@ export class ServerRole {
 
   readonly id: string;
   readonly name: string;
-  readonly permissions: OverrideField;
+  readonly permissions: {
+    a: bigint,
+    d: bigint
+  };
   readonly colour?: string;
   readonly hoist: boolean;
   readonly rank: number;
@@ -29,7 +32,10 @@ export class ServerRole {
 
     this.id = id;
     this.name = data.name;
-    this.permissions = data.permissions;
+    this.permissions = {
+      a: BigInt(data.permissions.a),
+      d: BigInt(data.permissions.d)
+    };
     this.colour = data.colour ?? undefined;
     this.hoist = data.hoist || false;
     this.rank = data.rank ?? 0;

src/classes/ServerRole.ts

@@ -6,6 +6,8 @@ import type { Error } from "stoat-api";
 
 import type { ProtocolV1 } from "./v1.js";
 
+import { JSONParse, JSONStringify } from 'json-with-bigint';
+
 /**
  * Available protocols to connect with
  */
@@ -94,7 +96,7 @@ export class EventClient<
   #connectTimeoutReference: number | undefined;
 
   #lastError: // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  { type: "socket"; data: any } | { type: "revolt"; data: Error } | undefined;
+    { type: "socket"; data: any } | { type: "revolt"; data: Error } | undefined;
 
   /**
    * Create a new event client.
@@ -179,7 +181,7 @@ export class EventClient<
 
       if (this.#transportFormat === "json") {
         if (typeof event.data === "string") {
-          this.handle(JSON.parse(event.data));
+          this.handle(JSONParse(event.data));
         }
       }
     };
@@ -214,7 +216,7 @@ export class EventClient<
   send(event: EventProtocol<T>["client"]): void {
     if (this.options.debug) console.debug("[C->S]", event);
     if (!this.#socket) throw "Socket closed, trying to send.";
-    this.#socket.send(JSON.stringify(event));
+    this.#socket.send(JSONStringify(event));
   }
 
   /**
@@ -273,14 +275,14 @@ export class EventClient<
    */
   get lastError():
     | {
-        type: "socket";
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        data: any;
-      }
+      type: "socket";
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      data: any;
+    }
     | {
-        type: "revolt";
-        data: Error;
-      }
+      type: "revolt";
+      data: Error;
+    }
     | undefined {
     return this.#lastError;
   }

src/events/EventClient.ts

@@ -641,7 +641,7 @@ export async function handleEvent(
         let role = {};
         const roles = server.roles;
         if (roles.has(event.role_id)) {
-          role = roles.get(event.role_id) as Role;
+          role = roles.get(event.role_id) as never;
           roles.delete(event.role_id);
         } else if (!client.servers.isPartial(event.id)) {
           return;

src/events/v1.ts

@@ -23,9 +23,9 @@ export type HydratedChannel = {
   ownerId?: string;
   serverId?: string;
 
-  permissions?: number;
-  defaultPermissions?: OverrideField;
-  rolePermissions?: Record<string, OverrideField>;
+  permissions?: bigint;
+  defaultPermissions?: { a: bigint, d: bigint };
+  rolePermissions?: Record<string, { a: bigint, d: bigint }>;
   nsfw: boolean;
 
   lastMessageId?: string;
@@ -57,9 +57,18 @@ export const channelHydration: Hydrate<Merge<APIChannel>, HydratedChannel> = {
     userId: (channel) => channel.user,
     ownerId: (channel) => channel.owner,
     serverId: (channel) => channel.server,
-    permissions: (channel) => channel.permissions!,
-    defaultPermissions: (channel) => channel.default_permissions!,
-    rolePermissions: (channel) => channel.role_permissions,
+    permissions: (channel) => BigInt(channel.permissions!),
+    defaultPermissions: (channel) => ({
+      a: BigInt(channel.default_permissions?.a ?? 0),
+      d: BigInt(channel.default_permissions?.d ?? 0),
+    }),
+    rolePermissions: (channel) => Object.fromEntries(
+      Object.entries(channel.role_permissions ?? {})
+        .map(([k, v]) => [k, {
+          a: BigInt(v.a),
+          d: BigInt(v.d)
+        }])
+    ),
     nsfw: (channel) => channel.nsfw || false,
     lastMessageId: (channel) => channel.last_message_id!,
     voice: (channel) => {

src/hydration/channel.ts

@@ -1,6 +1,6 @@
 import { ReactiveMap } from "@solid-primitives/map";
 import { ReactiveSet } from "@solid-primitives/set";
-import type { Interactions, Masquerade, Message } from "stoat-api";
+import type { Embed, Interactions, Masquerade, Message } from "stoat-api";
 
 import type { Client } from "../Client.js";
 import { File } from "../classes/File.js";