polfan-server-js-client 0.3.2 → 0.4.0

package/scripts/getPackageJson.js

@@ -1,25 +1,25 @@
-const fs = require('fs');
-const path = require('path');
-
-/**
- * A module to get package informations from package.json
- * @module getPackageJson
- * @param {...string} keys from package.json if no arguments passed it returns package.json content as object
- * @returns {object} with given keys or content of package.json as object
- */
-
-/**
- * Returns package info
- */
-const getPackageJson = function(...args) {
-  const packageJSON = JSON.parse(fs.readFileSync(path.join(__dirname, '../package.json')));
-  if (!args.length) {
-    return packageJSON;
-  }
-  return args.reduce((out, key) => {
-    out[key] = packageJSON[key];
-    return out;
-  }, {});
-};
-
+const fs = require('fs');
+const path = require('path');
+
+/**
+ * A module to get package informations from package.json
+ * @module getPackageJson
+ * @param {...string} keys from package.json if no arguments passed it returns package.json content as object
+ * @returns {object} with given keys or content of package.json as object
+ */
+
+/**
+ * Returns package info
+ */
+const getPackageJson = function(...args) {
+  const packageJSON = JSON.parse(fs.readFileSync(path.join(__dirname, '../package.json')));
+  if (!args.length) {
+    return packageJSON;
+  }
+  return args.reduce((out, key) => {
+    out[key] = packageJSON[key];
+    return out;
+  }, {});
+};
+
 module.exports = getPackageJson;

package/src/FilesClient.ts

@@ -1,43 +1,43 @@
-import {AbstractRestClient, RestClientResponse} from "./AbstractRestClient";
-
-export interface File {
-    id: string;
-    url: string;
-    name: string;
-    mime: string;
-    size: number;
-    width?: number;
-    height?: number;
-}
-
-export class FilesClient extends AbstractRestClient {
-    protected defaultUrl: string = 'https://files.devana.pl';
-
-    public async uploadFile(file: globalThis.File | Blob): Promise<RestClientResponse<File>> {
-        const name = encodeURIComponent((file as globalThis.File).name ?? '');
-        let headers = {
-            ...this.getAuthHeaders(),
-            Accept: 'application/json',
-            'Content-Disposition': `attachment; filename="${name}"`,
-            'Content-Length': file.size
-        };
-
-        const response = await fetch(this.getUrl('files'), {
-            method: 'POST',
-            body: file,
-            headers
-        });
-
-        return this.convertFetchResponse<File>(response);
-    }
-
-    public async getFileMeta(id: string): Promise<RestClientResponse<File>> {
-        return this.send('GET', 'files/' + id);
-    }
-
-    public async getFileMetaBulk(ids: string[]): Promise<RestClientResponse<File[]>> {
-        const searchParams = new URLSearchParams();
-        ids.forEach(id => searchParams.append('id[]', id));
-        return this.send('GET', 'files?' + searchParams);
-    }
+import {AbstractRestClient, RestClientResponse} from "./AbstractRestClient";
+
+export interface File {
+    id: string;
+    url: string;
+    name: string;
+    mime: string;
+    size: number;
+    width?: number;
+    height?: number;
+}
+
+export class FilesClient extends AbstractRestClient {
+    protected defaultUrl: string = 'https://files.devana.pl';
+
+    public async uploadFile(file: globalThis.File | Blob): Promise<RestClientResponse<File>> {
+        const name = encodeURIComponent((file as globalThis.File).name ?? '');
+        let headers = {
+            ...this.getAuthHeaders(),
+            Accept: 'application/json',
+            'Content-Disposition': `attachment; filename="${name}"`,
+            'Content-Length': file.size
+        };
+
+        const response = await fetch(this.getUrl('files'), {
+            method: 'POST',
+            body: file,
+            headers
+        });
+
+        return this.convertFetchResponse<File>(response);
+    }
+
+    public async getFileMeta(id: string): Promise<RestClientResponse<File>> {
+        return this.send('GET', 'files/' + id);
+    }
+
+    public async getFileMetaBulk(ids: string[]): Promise<RestClientResponse<File[]>> {
+        const searchParams = new URLSearchParams();
+        ids.forEach(id => searchParams.append('id[]', id));
+        return this.send('GET', 'files?' + searchParams);
+    }
 }

package/src/index.ts

@@ -1,30 +1,32 @@
-import {WebSocketChatClient} from "./WebSocketChatClient";
-import {WebApiChatClient} from "./WebApiChatClient";
-import {
-    IndexedCollection,
-    IndexedObjectCollection,
-    ObservableIndexedCollection,
-    ObservableIndexedObjectCollection
-} from "./IndexedObjectCollection";
-import {FilesClient, File} from "./FilesClient";
-import { Permissions, PermissionDefinition, Layer } from "./Permissions";
-import * as ChatTypes from './types/src';
-import {extractUserFromMember} from "./state-tracker/functions";
-import {AbstractRestClient} from "./AbstractRestClient";
-import {UnreadSummary} from "./state-tracker/FollowedTopicsManager";
-
-export {
-    IndexedCollection, ObservableIndexedCollection,
-    IndexedObjectCollection, ObservableIndexedObjectCollection,
-    Permissions, PermissionDefinition, Layer,
-    WebSocketChatClient, WebApiChatClient,
-    FilesClient,
-    AbstractRestClient,
-    extractUserFromMember,
-};
-
-export type {
-    ChatTypes,
-    File,
-    UnreadSummary,
+import {WebSocketChatClient} from "./WebSocketChatClient";
+import {WebApiChatClient} from "./WebApiChatClient";
+import {
+    IndexedCollection,
+    IndexedObjectCollection,
+    ObservableIndexedCollection,
+    ObservableIndexedObjectCollection
+} from "./IndexedObjectCollection";
+import {FilesClient, File} from "./FilesClient";
+import { Permissions, PermissionDefinition, Layer } from "./Permissions";
+import * as ChatTypes from './types/src';
+import {UserStatus} from './types/src';
+import {extractUserFromMember} from "./state-tracker/functions";
+import {AbstractRestClient} from "./AbstractRestClient";
+import {UnreadSummary} from "./state-tracker/FollowedTopicsManager";
+
+export {
+    IndexedCollection, ObservableIndexedCollection,
+    IndexedObjectCollection, ObservableIndexedObjectCollection,
+    Permissions, PermissionDefinition, Layer,
+    WebSocketChatClient, WebApiChatClient,
+    FilesClient,
+    AbstractRestClient,
+    extractUserFromMember,
+    UserStatus,
+};
+
+export type {
+    ChatTypes,
+    File,
+    UnreadSummary,
 };

package/src/state-tracker/ChatStateTracker.ts

@@ -1,72 +1,72 @@
-import {WebSocketChatClient} from "../WebSocketChatClient";
-import {Session, User} from "../types/src";
-import {RoomsManager} from "./RoomsManager";
-import {SpacesManager} from "./SpacesManager";
-import {PermissionsManager} from "./PermissionsManager";
-import {DeferredTask} from "./AsyncUtils";
-import {EmoticonsManager} from "./EmoticonsManager";
-import {UsersManager} from "./UsersManager";
-import {RelationshipsManager} from "./RelationshipsManager";
-
-export class ChatStateTracker {
-    public readonly client: WebSocketChatClient;
-
-    /**
-     * State of your permissions.
-     */
-    public readonly permissions: PermissionsManager;
-
-    /**
-     * State of the rooms you are in.
-     */
-    public readonly rooms: RoomsManager;
-
-    /**
-     * State of the spaces you are in.
-     */
-    public readonly spaces: SpacesManager;
-
-    /**
-     * State of the emoticons (global and space-related).
-     */
-    public readonly emoticons: EmoticonsManager;
-
-    /**
-     * Users related state.
-     */
-    public readonly users: UsersManager;
-
-    /**
-     * State of relationships with other users.
-     */
-    public readonly relationships: RelationshipsManager;
-
-    private _me: User = null;
-    private readonly deferredSession = new DeferredTask();
-
-    public constructor(client: WebSocketChatClient) {
-        this.client = client;
-        this.client.on('Session', ev => this.handleSession(ev));
-
-        this.permissions = new PermissionsManager(this);
-        this.rooms = new RoomsManager(this);
-        this.spaces = new SpacesManager(this);
-        this.emoticons = new EmoticonsManager(this);
-        this.users = new UsersManager(this);
-        this.relationships = new RelationshipsManager(this);
-    }
-
-    public get me(): User | null {
-        return this._me;
-    }
-
-    public async getMe(): Promise<User> {
-        await this.deferredSession.promise;
-        return this._me;
-    }
-
-    private handleSession(ev: Session): void {
-        this._me = ev.user;
-        this.deferredSession.resolve();
-    }
+import {WebSocketChatClient} from "../WebSocketChatClient";
+import {Session, User} from "../types/src";
+import {RoomsManager} from "./RoomsManager";
+import {SpacesManager} from "./SpacesManager";
+import {PermissionsManager} from "./PermissionsManager";
+import {DeferredTask} from "./AsyncUtils";
+import {EmoticonsManager} from "./EmoticonsManager";
+import {UsersManager} from "./UsersManager";
+import {RelationshipsManager} from "./RelationshipsManager";
+
+export class ChatStateTracker {
+    public readonly client: WebSocketChatClient;
+
+    /**
+     * State of your permissions.
+     */
+    public readonly permissions: PermissionsManager;
+
+    /**
+     * State of the rooms you are in.
+     */
+    public readonly rooms: RoomsManager;
+
+    /**
+     * State of the spaces you are in.
+     */
+    public readonly spaces: SpacesManager;
+
+    /**
+     * State of the emoticons (global and space-related).
+     */
+    public readonly emoticons: EmoticonsManager;
+
+    /**
+     * Users related state.
+     */
+    public readonly users: UsersManager;
+
+    /**
+     * State of relationships with other users.
+     */
+    public readonly relationships: RelationshipsManager;
+
+    private _me: User = null;
+    private readonly deferredSession = new DeferredTask();
+
+    public constructor(client: WebSocketChatClient) {
+        this.client = client;
+        this.client.on('Session', ev => this.handleSession(ev));
+
+        this.permissions = new PermissionsManager(this);
+        this.rooms = new RoomsManager(this);
+        this.spaces = new SpacesManager(this);
+        this.emoticons = new EmoticonsManager(this);
+        this.users = new UsersManager(this);
+        this.relationships = new RelationshipsManager(this);
+    }
+
+    public get me(): User | null {
+        return this._me;
+    }
+
+    public async getMe(): Promise<User> {
+        await this.deferredSession.promise;
+        return this._me;
+    }
+
+    private handleSession(ev: Session): void {
+        this._me = ev.user;
+        this.deferredSession.resolve();
+    }
 }

package/src/state-tracker/UsersManager.ts

@@ -1,52 +1,52 @@
-import {ChatStateTracker} from "./ChatStateTracker";
-import {ObservableIndexedObjectCollection} from "../IndexedObjectCollection";
-import {RoomMember, Session, SpaceMember, User} from "../types/src";
-import {extractUserFromMember} from "./functions";
-import {EventTarget} from "../EventTarget";
-
-export class UsersManager {
-    public readonly onlineStatus = new EventTarget<{ change: User }>();
-
-    private readonly users: ObservableIndexedObjectCollection<User> = new ObservableIndexedObjectCollection('id');
-
-    public constructor(private tracker: ChatStateTracker) {
-        // RoomMemberUpdated & SpaceMemberUpdated events are not contains user object
-        tracker.client.on('UserUpdated', event => this.handleUsers([event.user]));
-        tracker.client.on('RoomMembersJoined', event => this.handleMembers(event.members));
-        tracker.client.on('SpaceMemberJoined', event => this.handleMembers([event.member]));
-        tracker.client.on('SpaceMembers', event => this.handleMembers(event.members));
-        tracker.client.on('RoomMembers', event => this.handleMembers(event.members));
-        tracker.client.on('Messages', event => this.handleUsers(event.messages.map(message => message.author.user)));
-        tracker.client.on('NewMessage', event => this.handleUsers([event.message.author.user]));
-        tracker.client.on('Session', event => this.handleSession(event));
-    }
-
-    /**
-     * Get all available (cached) user objects at once.
-     */
-    public async getAvailable(): Promise<ObservableIndexedObjectCollection<User>> {
-        return this.users;
-    }
-
-    private handleMembers(members: (RoomMember | SpaceMember)[]): void {
-        this.handleUsers(members.map(extractUserFromMember));
-    }
-
-    private handleSession(session: Session): void {
-        // Keep the "seen users" cache across reconnects so bound user lists do
-        // not blank out; just ensure our own user is present/updated. Stale
-        // entries are refreshed as member/message collections refetch.
-        this.handleUsers([session.user]);
-    }
-
-    private handleUsers(users: User[]): void {
-        users.forEach(newUser => {
-            const oldUser = this.users.get(newUser.id);
-            if (oldUser && oldUser.online !== newUser.online) {
-                this.onlineStatus.emit('change', newUser);
-            }
-        });
-
-        this.users.set(...users);
-    }
+import {ChatStateTracker} from "./ChatStateTracker";
+import {ObservableIndexedObjectCollection} from "../IndexedObjectCollection";
+import {RoomMember, Session, SpaceMember, User} from "../types/src";
+import {extractUserFromMember} from "./functions";
+import {EventTarget} from "../EventTarget";
+
+export class UsersManager {
+    public readonly onlineStatus = new EventTarget<{ change: User }>();
+
+    private readonly users: ObservableIndexedObjectCollection<User> = new ObservableIndexedObjectCollection('id');
+
+    public constructor(private tracker: ChatStateTracker) {
+        // RoomMemberUpdated & SpaceMemberUpdated events are not contains user object
+        tracker.client.on('UserUpdated', event => this.handleUsers([event.user]));
+        tracker.client.on('RoomMembersJoined', event => this.handleMembers(event.members));
+        tracker.client.on('SpaceMemberJoined', event => this.handleMembers([event.member]));
+        tracker.client.on('SpaceMembers', event => this.handleMembers(event.members));
+        tracker.client.on('RoomMembers', event => this.handleMembers(event.members));
+        tracker.client.on('Messages', event => this.handleUsers(event.messages.map(message => message.author.user)));
+        tracker.client.on('NewMessage', event => this.handleUsers([event.message.author.user]));
+        tracker.client.on('Session', event => this.handleSession(event));
+    }
+
+    /**
+     * Get all available (cached) user objects at once.
+     */
+    public async getAvailable(): Promise<ObservableIndexedObjectCollection<User>> {
+        return this.users;
+    }
+
+    private handleMembers(members: (RoomMember | SpaceMember)[]): void {
+        this.handleUsers(members.map(extractUserFromMember));
+    }
+
+    private handleSession(session: Session): void {
+        // Keep the "seen users" cache across reconnects so bound user lists do
+        // not blank out; just ensure our own user is present/updated. Stale
+        // entries are refreshed as member/message collections refetch.
+        this.handleUsers([session.user]);
+    }
+
+    private handleUsers(users: User[]): void {
+        users.forEach(newUser => {
+            const oldUser = this.users.get(newUser.id);
+            if (oldUser && oldUser.status !== newUser.status) {
+                this.onlineStatus.emit('change', newUser);
+            }
+        });
+
+        this.users.set(...users);
+    }
 }

package/src/state-tracker/functions.ts

@@ -1,29 +1,29 @@
-import {Role, RoomMember, SpaceMember, User} from "../types/src";
-
-export function reorderRolesOnPriorityUpdate(allRoles: Role[], oldRole: Role, updatedRole: Role): Role[] {
-    // If the priority has changed, adjust the rest of roles
-    const increased = (updatedRole.priority - oldRole.priority) > 0;
-    const decreased = ! increased;
-    const changedRoles: Role[] = [];
-
-    allRoles.forEach(role => {
-        if (role.id === updatedRole.id) {
-            // Skip the updated role
-            return;
-        }
-        if (increased && oldRole.priority <= role.priority) {
-            role.priority--;
-            changedRoles.push(role);
-        }
-        if (decreased && updatedRole.priority <= role.priority) {
-            role.priority++;
-            changedRoles.push(role);
-        }
-    });
-
-    return changedRoles;
-}
-
-export function extractUserFromMember(member: RoomMember | SpaceMember): User | null {
-    return member.user ?? (member as RoomMember).spaceMember?.user;
+import {Role, RoomMember, SpaceMember, User} from "../types/src";
+
+export function reorderRolesOnPriorityUpdate(allRoles: Role[], oldRole: Role, updatedRole: Role): Role[] {
+    // If the priority has changed, adjust the rest of roles
+    const increased = (updatedRole.priority - oldRole.priority) > 0;
+    const decreased = ! increased;
+    const changedRoles: Role[] = [];
+
+    allRoles.forEach(role => {
+        if (role.id === updatedRole.id) {
+            // Skip the updated role
+            return;
+        }
+        if (increased && oldRole.priority <= role.priority) {
+            role.priority--;
+            changedRoles.push(role);
+        }
+        if (decreased && updatedRole.priority <= role.priority) {
+            role.priority++;
+            changedRoles.push(role);
+        }
+    });
+
+    return changedRoles;
+}
+
+export function extractUserFromMember(member: RoomMember | SpaceMember): User | null {
+    return member.user ?? (member as RoomMember).spaceMember?.user;
 }