polfan-server-js-client 0.3.3 → 0.4.0

package/package.json

@@ -1,43 +1,43 @@
-{
-  "name": "polfan-server-js-client",
-  "version": "0.3.3",
-  "description": "JavaScript client library for handling communication with Polfan chat server.",
-  "author": "Jarosław Żak",
-  "license": "MIT",
-  "main": "build/index.cjs.js",
-  "browser": "build/index.umd.js",
-  "types": "build/types/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./build/types/index.d.ts",
-      "require": "./build/index.cjs.js",
-      "browser": "./build/index.umd.js",
-      "default": "./build/index.cjs.js"
-    }
-  },
-  "scripts": {
-    "build": "npm run build:node && npm run build:browser && tsc",
-    "build:node": "webpack --config webpack.config.node.js",
-    "build:browser": "webpack --config webpack.config.browser.js",
-    "test": "jest",
-    "coverage": "npm run test -- --coverage",
-    "trypublish": "npm publish || true"
-  },
-  "devDependencies": {
-    "@babel/cli": "^7.28.3",
-    "@babel/core": "^7.28.5",
-    "@babel/preset-env": "^7.28.5",
-    "@babel/preset-typescript": "^7.28.5",
-    "@types/jest": "^29.5.14",
-    "babel-loader": "^9.2.1",
-    "file-loader": "^6.2.0",
-    "jest": "^29.7.0",
-    "ts-node": "^10.9.2",
-    "typescript": "^4.9.5",
-    "webpack": "^5.103.0",
-    "webpack-cli": "^5.1.4"
-  },
-  "dependencies": {
-    "terser-webpack-plugin": "^5.3.14"
-  }
-}
+{
+  "name": "polfan-server-js-client",
+  "version": "0.4.0",
+  "description": "JavaScript client library for handling communication with Polfan chat server.",
+  "author": "Jarosław Żak",
+  "license": "MIT",
+  "main": "build/index.cjs.js",
+  "browser": "build/index.umd.js",
+  "types": "build/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./build/types/index.d.ts",
+      "require": "./build/index.cjs.js",
+      "browser": "./build/index.umd.js",
+      "default": "./build/index.cjs.js"
+    }
+  },
+  "scripts": {
+    "build": "npm run build:node && npm run build:browser && tsc",
+    "build:node": "webpack --config webpack.config.node.js",
+    "build:browser": "webpack --config webpack.config.browser.js",
+    "test": "jest",
+    "coverage": "npm run test -- --coverage",
+    "trypublish": "npm publish || true"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.28.3",
+    "@babel/core": "^7.28.5",
+    "@babel/preset-env": "^7.28.5",
+    "@babel/preset-typescript": "^7.28.5",
+    "@types/jest": "^29.5.14",
+    "babel-loader": "^9.2.1",
+    "file-loader": "^6.2.0",
+    "jest": "^29.7.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^4.9.5",
+    "webpack": "^5.103.0",
+    "webpack-cli": "^5.1.4"
+  },
+  "dependencies": {
+    "terser-webpack-plugin": "^5.3.14"
+  }
+}

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/RoomMessagesHistory.ts

@@ -6,7 +6,6 @@ import {TopicHistoryWindow, WindowState} from "./TopicHistoryWindow";
 export class RoomMessagesHistory {
     private historyWindows = new IndexedCollection<string, TopicHistoryWindow>();
     private traverseLock: boolean = false;
-    private timeLimitedHistory: boolean = false;
 
     public constructor(
         private room: Room,
@@ -16,7 +15,7 @@ export class RoomMessagesHistory {
         this.tracker.client.on('NewTopic', ev => this.handleNewTopic(ev));
         this.tracker.client.on('TopicDeleted', ev => this.handleTopicDeleted(ev));
 
-        this.updateHistoryMode(this.room);
+        this.updateTraverseLock(this.room);
 
         if (this.room.defaultTopic) {
             this.createHistoryWindowForTopic(this.room.defaultTopic);
@@ -47,23 +46,13 @@ export class RoomMessagesHistory {
      *
      * The window bindings are preserved; only windows that the application had
      * actually pulled to the latest page (state === LATEST) are refreshed, with
-     * a single request instead of a chain of catch-up requests. Windows that
-     * were never pulled (LIVE) or belong to an ephemeral room are left untouched
-     * so their in-memory context survives the reconnect.
-     *
-     * How a refreshed window is rebuilt depends on the room history mode: rooms
-     * keeping the full history are simply reset to the latest page (it can
-     * always be traversed back on demand), while rooms with a time-limited
-     * history (MaxAge) load the messages missed during the downtime on top of
-     * the already loaded ones, with the messages returned in both deduplicated.
-     * The maxAge retention applies to what the server serves - so that users
-     * joining later do not see the older conversation - and never to what this
-     * client already has: messages the user witnessed stay in the window until
-     * they are pushed out by its own size limit.
+     * a single resetToLatest instead of a chain of catch-up requests. Windows
+     * that were never pulled (LIVE) or belong to an ephemeral room are left
+     * untouched so their in-memory context survives the reconnect.
      */
     public async resync(room: Room): Promise<void> {
         this.room = room;
-        this.updateHistoryMode(room);
+        this.updateTraverseLock(room);
 
         if (this.room.defaultTopic) {
             this.createHistoryWindowForTopic(this.room.defaultTopic);
@@ -79,13 +68,7 @@ export class RoomMessagesHistory {
                     continue;
                 }
 
-                if (window.state !== WindowState.LATEST) {
-                    continue;
-                }
-
-                if (this.timeLimitedHistory) {
-                    await window.resyncToLatest();
-                } else {
+                if (window.state === WindowState.LATEST) {
                     await window.resetToLatest(true);
                 }
             } catch (_e) {
@@ -100,7 +83,7 @@ export class RoomMessagesHistory {
         if (this.room.id === ev.room.id) {
             this.room = ev.room;
 
-            this.updateHistoryMode(ev.room);
+            this.updateTraverseLock(ev.room);
 
             if (ev.room.defaultTopic) {
                 this.createHistoryWindowForTopic(ev.room.defaultTopic);
@@ -151,8 +134,7 @@ export class RoomMessagesHistory {
         }
     }
 
-    private updateHistoryMode(room: Room): void {
-        this.traverseLock = room.history?.mode === 'Ephemeral';
-        this.timeLimitedHistory = room.history?.mode === 'MaxAge';
+    private updateTraverseLock(room: Room): void {
+        this.traverseLock = room.history.mode === 'Ephemeral';
     }
 }