hischool.js 0.0.1

package/lib/esm/events/v1.d.ts

@@ -0,0 +1,214 @@
+import type { Channel, Emoji, FieldsChannel, FieldsMember, FieldsServer, FieldsUser, Member, MemberCompositeKey, Message, RelationshipStatus, Role, Server, User } from "../api";
+import { Client } from "../index.js";
+import { Setter } from "solid-js";
+/**
+ * Version 1 of the events protocol
+ */
+export type ProtocolV1 = {
+    client: ClientMessage;
+    server: ServerMessage;
+};
+/**
+ * Messages sent to the server
+ */
+type ClientMessage = {
+    type: "Authenticate";
+    token: string;
+} | {
+    type: "BeginTyping";
+    channel: string;
+} | {
+    type: "EndTyping";
+    channel: string;
+} | {
+    type: "Ping";
+    data: number;
+} | {
+    type: "Pong";
+    data: number;
+};
+/**
+ * Messages sent from the server
+ */
+type ServerMessage = ({
+    type: "Error";
+} & WebSocketError) | {
+    type: "Bulk";
+    v: ServerMessage[];
+} | {
+    type: "Authenticated";
+} | ({
+    type: "Ready";
+} & ReadyData) | {
+    type: "Ping";
+    data: number;
+} | {
+    type: "Pong";
+    data: number;
+} | ({
+    type: "Message";
+} & Message) | {
+    type: "MessageUpdate";
+    id: string;
+    channel: string;
+    data: Partial<Message>;
+} | {
+    type: "MessageAppend";
+    id: string;
+    channel: string;
+    append: Pick<Partial<Message>, "embeds">;
+} | {
+    type: "MessageDelete";
+    id: string;
+    channel: string;
+} | {
+    type: "MessageReact";
+    id: string;
+    channel_id: string;
+    user_id: string;
+    emoji_id: string;
+} | {
+    type: "MessageUnreact";
+    id: string;
+    channel_id: string;
+    user_id: string;
+    emoji_id: string;
+} | {
+    type: "MessageRemoveReaction";
+    id: string;
+    channel_id: string;
+    emoji_id: string;
+} | {
+    type: "BulkMessageDelete";
+    channel: string;
+    ids: string[];
+} | ({
+    type: "ChannelCreate";
+} & Channel) | {
+    type: "ChannelUpdate";
+    id: string;
+    data: Partial<Channel>;
+    clear?: FieldsChannel[];
+} | {
+    type: "ChannelDelete";
+    id: string;
+} | {
+    type: "ChannelGroupJoin";
+    id: string;
+    user: string;
+} | {
+    type: "ChannelGroupLeave";
+    id: string;
+    user: string;
+} | {
+    type: "ChannelStartTyping";
+    id: string;
+    user: string;
+} | {
+    type: "ChannelStopTyping";
+    id: string;
+    user: string;
+} | {
+    type: "ChannelAck";
+    id: string;
+    user: string;
+    message_id: string;
+} | {
+    type: "ServerCreate";
+    id: string;
+    server: Server;
+    channels: Channel[];
+} | {
+    type: "ServerUpdate";
+    id: string;
+    data: Partial<Server>;
+    clear?: FieldsServer[];
+} | {
+    type: "ServerDelete";
+    id: string;
+} | {
+    type: "ServerMemberUpdate";
+    id: MemberCompositeKey;
+    data: Partial<Member>;
+    clear?: FieldsMember[];
+} | {
+    type: "ServerMemberJoin";
+    id: string;
+    user: string;
+} | {
+    type: "ServerMemberLeave";
+    id: string;
+    user: string;
+} | {
+    type: "ServerRoleUpdate";
+    id: string;
+    role_id: string;
+    data: Partial<Role>;
+} | {
+    type: "ServerRoleDelete";
+    id: string;
+    role_id: string;
+} | {
+    type: "UserUpdate";
+    id: string;
+    data: Partial<User>;
+    clear?: FieldsUser[];
+} | {
+    type: "UserRelationship";
+    user: User;
+    status: RelationshipStatus;
+} | {
+    type: "UserPresence";
+    id: string;
+    online: boolean;
+} | {
+    type: "UserSettingsUpdate";
+    id: string;
+    update: {
+        [key: string]: [number, string];
+    };
+} | {
+    type: "UserPlatformWipe";
+    user_id: string;
+    flags: number;
+} | ({
+    type: "EmojiCreate";
+} & Emoji) | {
+    type: "EmojiDelete";
+    id: string;
+} | ({
+    type: "Auth";
+} & ({
+    event_type: "DeleteSession";
+    user_id: string;
+    session_id: string;
+} | {
+    event_type: "DeleteAllSessions";
+    user_id: string;
+    exclude_session_id: string;
+}));
+/**
+ * Initial synchronisation packet
+ */
+type ReadyData = {
+    users: User[];
+    servers: Server[];
+    channels: Channel[];
+    members: Member[];
+    emojis: Emoji[];
+};
+/**
+ * Websocket error packet
+ */
+type WebSocketError = {
+    error: "InternalError" | "InvalidSession" | "OnboardingNotFinished" | "AlreadyAuthenticated";
+};
+/**
+ * Handle an event for the Client
+ * @param client Client
+ * @param event Event
+ * @param setReady Signal state change
+ */
+export declare function handleEvent(client: Client, event: ServerMessage, setReady: Setter<boolean>): Promise<void>;
+export {};
+//# sourceMappingURL=v1.d.ts.map

package/lib/esm/events/v1.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"v1.d.ts","sourceRoot":"","sources":["../../../src/events/v1.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EAEP,KAAK,EACL,aAAa,EACb,YAAY,EACZ,YAAY,EACZ,UAAU,EACV,MAAM,EACN,kBAAkB,EAClB,OAAO,EACP,kBAAkB,EAClB,IAAI,EACJ,MAAM,EACN,IAAI,EACL,MAAM,QAAQ,CAAC;AAEhB,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EAAE,MAAM,EAAS,MAAM,UAAU,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE,aAAa,CAAC;IACtB,MAAM,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,KAAK,aAAa,GACd;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GACvC;IACE,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;CACjB,GACD;IACE,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB,GACD;IACE,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd,GACD;IACE,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEN;;GAEG;AACH,KAAK,aAAa,GACd,CAAC;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GAAG,cAAc,CAAC,GACpC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,aAAa,EAAE,CAAA;CAAE,GACpC;IAAE,IAAI,EAAE,eAAe,CAAA;CAAE,GACzB,CAAC;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GAAG,SAAS,CAAC,GAC/B;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC9B;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC9B,CAAC;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GAAG,OAAO,CAAC,GAC/B;IACE,IAAI,EAAE,eAAe,CAAC;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;CACxB,GACD;IACE,IAAI,EAAE,eAAe,CAAC;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC;CAC1C,GACD;IAAE,IAAI,EAAE,eAAe,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GACtD;IACE,IAAI,EAAE,cAAc,CAAC;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB,GACD;IACE,IAAI,EAAE,gBAAgB,CAAC;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB,GACD;IACE,IAAI,EAAE,uBAAuB,CAAC;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB,GACD;IAAE,IAAI,EAAE,mBAAmB,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,EAAE,CAAA;CAAE,GAC7D,CAAC;IAAE,IAAI,EAAE,eAAe,CAAA;CAAE,GAAG,OAAO,CAAC,GACrC;IACE,IAAI,EAAE,eAAe,CAAC;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACvB,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;CACzB,GACD;IAAE,IAAI,EAAE,eAAe,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,GACrC;IAAE,IAAI,EAAE,kBAAkB,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GACtD;IAAE,IAAI,EAAE,mBAAmB,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GACvD;IAAE,IAAI,EAAE,oBAAoB,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GACxD;IAAE,IAAI,EAAE,mBAAmB,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GACvD;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,GACpE;IACE,IAAI,EAAE,cAAc,CAAC;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB,GACD;IACE,IAAI,EAAE,cAAc,CAAC;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACtB,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;CACxB,GACD;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,GACpC;IACE,IAAI,EAAE,oBAAoB,CAAC;IAC3B,EAAE,EAAE,kBAAkB,CAAC;IACvB,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACtB,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;CACxB,GACD;IAAE,IAAI,EAAE,kBAAkB,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GACtD;IAAE,IAAI,EAAE,mBAAmB,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GACvD;IACE,IAAI,EAAE,kBAAkB,CAAC;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;CACrB,GACD;IAAE,IAAI,EAAE,kBAAkB,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GACzD;IACE,IAAI,EAAE,YAAY,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACpB,KAAK,CAAC,EAAE,UAAU,EAAE,CAAC;CACtB,GACD;IAAE,IAAI,EAAE,kBAAkB,CAAC;IAAC,IAAI,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,kBAAkB,CAAA;CAAE,GACpE;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE,GACrD;IACE,IAAI,EAAE,oBAAoB,CAAC;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;CAC7C,GACD;IAAE,IAAI,EAAE,kBAAkB,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAC5D,CAAC;IAAE,IAAI,EAAE,aAAa,CAAA;CAAE,GAAG,KAAK,CAAC,GACjC;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,GACnC,CAAC;IACC,IAAI,EAAE,MAAM,CAAC;CACd,GAAG,CACA;IACE,UAAU,EAAE,eAAe,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACpB,GACD;IACE,UAAU,EAAE,mBAAmB,CAAC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CACJ,CAAC,CAAC;AAEP;;GAEG;AACH,KAAK,SAAS,GAAG;IACf,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,KAAK,cAAc,GAAG;IACpB,KAAK,EACD,eAAe,GACf,gBAAgB,GAChB,uBAAuB,GACvB,sBAAsB,CAAC;CAC5B,CAAC;AAEF;;;;;GAKG;AACH,wBAAsB,WAAW,CAC/B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,aAAa,EACpB,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,iBA+mB1B"}