polfan-server-js-client 0.2.57 → 0.2.58

package/build/types/IndexedObjectCollection.d.ts

@@ -10,7 +10,7 @@ export declare class IndexedCollection<KeyT, ValueT> {
     delete(...ids: KeyT[]): void;
     deleteAll(): void;
     findBy(field: keyof ValueT, valueToFind: any, limit?: number): IndexedCollection<KeyT, ValueT>;
-    shallowCopy(): IndexedCollection<KeyT, ValueT>;
+    createMirror(): IndexedCollection<KeyT, ValueT>;
 }
 export declare class IndexedObjectCollection<T> {
     readonly id: keyof T | ((item: T) => any);
@@ -25,7 +25,7 @@ export declare class IndexedObjectCollection<T> {
     delete(...ids: any[]): void;
     deleteAll(): void;
     findBy(field: keyof T, valueToFind: any, limit?: number): IndexedObjectCollection<T>;
-    shallowCopy(): IndexedObjectCollection<T>;
+    createMirror(): IndexedObjectCollection<T>;
     protected getId(item: T): any;
 }
 interface ObservableCollectionEvent<KeyT> {
@@ -38,7 +38,7 @@ export declare class ObservableIndexedCollection<KeyT, ValueT> extends IndexedCo
     set(...items: [KeyT, ValueT][]): void;
     delete(...ids: KeyT[]): void;
     deleteAll(): void;
-    shallowCopy(): ObservableIndexedCollection<KeyT, ValueT>;
+    createMirror(): ObservableIndexedCollection<KeyT, ValueT>;
     on(eventName: 'change', handler: (ev?: ObservableCollectionEvent<KeyT>) => void): this;
     once(eventName: 'change', handler: (ev?: ObservableCollectionEvent<KeyT>) => void): this;
     off(eventName: string, handler: (ev?: ObservableCollectionEvent<KeyT>) => void): this;
@@ -50,7 +50,7 @@ export declare class ObservableIndexedObjectCollection<T> extends IndexedObjectC
     set(...items: T[]): void;
     delete(...ids: string[]): void;
     deleteAll(): void;
-    shallowCopy(): IndexedObjectCollection<T>;
+    createMirror(): IndexedObjectCollection<T>;
     on(eventName: 'change', handler: (ev?: ObservableCollectionEvent<string>) => void): this;
     once(eventName: 'change', handler: (ev?: ObservableCollectionEvent<string>) => void): this;
     off(eventName: string, handler: (ev?: ObservableCollectionEvent<string>) => void): this;

package/build/types/state-tracker/TopicHistoryWindow.d.ts

@@ -26,17 +26,25 @@ export declare abstract class TraversableRemoteCollection<T> extends ObservableI
      * Current mode od collection window. To change mode, call one of available fetch methods.
      */
     get state(): WindowState;
+    protected internalState: {
+        current: WindowState;
+        ongoing?: WindowState;
+        limit: number | null;
+        oldestId: string | null;
+    };
     /**
      * Maximum numer of items stored in window.
      * Null for unlimited.
      */
-    limit: number | null;
-    oldestId: string;
-    protected currentState: WindowState;
-    protected fetchingState: WindowState;
-    abstract shallowCopy(): IndexedObjectCollection<T>;
+    get limit(): number | null;
+    /**
+     * Maximum numer of items stored in window.
+     * Null for unlimited.
+     */
+    set limit(value: number | null);
     get hasLatest(): boolean;
     get hasOldest(): boolean;
+    abstract createMirror(): IndexedObjectCollection<T>;
     resetToLatest(): Promise<void>;
     fetchPrevious(): Promise<void>;
     fetchNext(): Promise<void>;
@@ -59,9 +67,11 @@ export declare class TopicHistoryWindow extends TraversableRemoteCollection<Mess
      * Reexported available window modes enum.
      */
     readonly WindowState: typeof WindowState;
-    private traverseLock;
-    constructor(roomId: string, topicId: string, tracker: ChatStateTracker);
-    shallowCopy(): IndexedObjectCollection<Message>;
+    protected internalState: typeof TraversableRemoteCollection<Message>['prototype']['internalState'] & {
+        traverseLock: boolean;
+    };
+    constructor(roomId: string, topicId: string, tracker: ChatStateTracker, bindEvents?: boolean);
+    createMirror(): TopicHistoryWindow;
     get isTraverseLocked(): boolean;
     setTraverseLock(lock: boolean): Promise<void>;
     resetToLatest(): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polfan-server-js-client",
-  "version": "0.2.57",
+  "version": "0.2.58",
   "description": "JavaScript client library for handling communication with Polfan chat server.",
   "author": "Jarosław Żak",
   "license": "MIT",
@@ -31,7 +31,7 @@
     "@babel/plugin-transform-typescript": "^7.20.2",
     "@babel/polyfill": "^7.12.1",
     "@babel/preset-env": "^7.20.2",
-    "@babel/preset-typescript": "^7.27.1",
+    "@babel/preset-typescript": "^7.28.5",
     "@types/jest": "^29.2.5",
     "@typescript-eslint/eslint-plugin": "^4.33.0",
     "@typescript-eslint/parser": "^4.33.0",

package/src/IndexedObjectCollection.ts

@@ -53,7 +53,7 @@ export class IndexedCollection<KeyT, ValueT> {
         return result;
     }
 
-    public shallowCopy(): IndexedCollection<KeyT, ValueT> {
+    public createMirror(): IndexedCollection<KeyT, ValueT> {
         const copy = new IndexedCollection<KeyT, ValueT>();
         copy._items = this._items;
         return copy;
@@ -116,7 +116,7 @@ export class IndexedObjectCollection<T> {
         return result;
     }
 
-    public shallowCopy(): IndexedObjectCollection<T> {
+    public createMirror(): IndexedObjectCollection<T> {
         const copy = new IndexedObjectCollection<T>(this.id);
         copy._items = this._items;
         return copy;
@@ -163,7 +163,7 @@ export class ObservableIndexedCollection<KeyT, ValueT> extends IndexedCollection
         }
     }
 
-    public shallowCopy(): ObservableIndexedCollection<KeyT, ValueT> {
+    public createMirror(): ObservableIndexedCollection<KeyT, ValueT> {
         const copy = new ObservableIndexedCollection<KeyT, ValueT>();
         copy.eventTarget = this.eventTarget;
         copy._items = this._items;
@@ -220,7 +220,7 @@ export class ObservableIndexedObjectCollection<T> extends IndexedObjectCollectio
         }
     }
 
-    public shallowCopy(): IndexedObjectCollection<T> {
+    public createMirror(): IndexedObjectCollection<T> {
         const copy = new ObservableIndexedObjectCollection<T>(this.id);
         copy.eventTarget = this.eventTarget;
         copy._items = this._items;

package/src/state-tracker/TopicHistoryWindow.ts

@@ -31,63 +31,80 @@ export abstract class TraversableRemoteCollection<T> extends ObservableIndexedOb
      * Current mode od collection window. To change mode, call one of available fetch methods.
      */
     public get state(): WindowState {
-        return this.currentState;
+        return this.internalState.current;
     }
 
+    protected internalState: {
+        current: WindowState,
+        ongoing?: WindowState,
+        limit: number | null,
+        oldestId: string | null,
+    } = {
+        current: WindowState.LIVE,
+        ongoing: undefined,
+        limit: 50,
+        oldestId: null,
+    };
+
     /**
      * Maximum numer of items stored in window.
      * Null for unlimited.
      */
-    public limit: number | null = 50;
-
-    public oldestId: string = null;
-
-    protected currentState: WindowState = WindowState.LIVE;
-    protected fetchingState: WindowState = undefined;
+    public get limit(): number | null {
+        return this.internalState.limit;
+    }
 
-    public abstract shallowCopy(): IndexedObjectCollection<T>;
+    /**
+     * Maximum numer of items stored in window.
+     * Null for unlimited.
+     */
+    public set limit(value: number | null) {
+        this.internalState.limit = value;
+    }
 
     public get hasLatest(): boolean {
         return [WindowState.LATEST, WindowState.LIVE].includes(this.state);
     }
 
     public get hasOldest(): boolean {
-        return this.state === WindowState.OLDEST || this.oldestId !== null && this.has(this.oldestId);
+        return this.state === WindowState.OLDEST || this.internalState.oldestId !== null && this.has(this.internalState.oldestId);
     }
 
+    public abstract createMirror(): IndexedObjectCollection<T>;
+
     public async resetToLatest(): Promise<void> {
-        if (this.fetchingState || this.currentState === WindowState.LATEST) {
+        if (this.internalState.ongoing || this.internalState.current === WindowState.LATEST) {
             return;
         }
 
-        this.fetchingState = WindowState.LATEST;
+        this.internalState.ongoing = WindowState.LATEST;
 
         let result;
 
         try {
             result = await this.fetchLatestItems();
         } finally {
-            this.fetchingState = undefined;
+            this.internalState.ongoing = undefined;
         }
 
         this.deleteAll();
         this.addItems(result, 'tail');
-        this.currentState = WindowState.LATEST;
+        this.internalState.current = WindowState.LATEST;
     }
 
     public async fetchPrevious(): Promise<void> {
-        if (this.fetchingState || this.hasOldest) {
+        if (this.internalState.ongoing || this.hasOldest) {
             return;
         }
 
-        this.fetchingState = WindowState.PAST;
+        this.internalState.ongoing = WindowState.PAST;
 
         let result;
 
         try {
             result = await this.fetchItemsBefore();
         } finally {
-            this.fetchingState = undefined;
+            this.internalState.ongoing = undefined;
         }
 
         if (! result) {
@@ -96,13 +113,13 @@ export abstract class TraversableRemoteCollection<T> extends ObservableIndexedOb
 
         if (! result.length) {
             const firstItem = this.getAt(0);
-            this.oldestId = firstItem ? this.getId(firstItem) : null;
+            this.internalState.oldestId = firstItem ? this.getId(firstItem) : null;
 
             await this.refreshFetchedState();
 
             // LATEST state has priority over OLDEST
-            if (this.currentState === WindowState.PAST) {
-                this.currentState = WindowState.OLDEST;
+            if (this.internalState.current === WindowState.PAST) {
+                this.internalState.current = WindowState.OLDEST;
             }
 
             return;
@@ -113,18 +130,18 @@ export abstract class TraversableRemoteCollection<T> extends ObservableIndexedOb
     }
 
     public async fetchNext(): Promise<void> {
-        if (this.fetchingState || this.hasLatest) {
+        if (this.internalState.ongoing || this.hasLatest) {
             return;
         }
 
-        this.fetchingState = WindowState.PAST;
+        this.internalState.ongoing = WindowState.PAST;
 
         let result;
 
         try {
             result = await this.fetchItemsAfter();
         } finally {
-            this.fetchingState = undefined;
+            this.internalState.ongoing = undefined;
         }
 
         if (! result) {
@@ -148,7 +165,7 @@ export abstract class TraversableRemoteCollection<T> extends ObservableIndexedOb
     protected abstract isLatestItemLoaded(): Promise<boolean>;
 
     protected async refreshFetchedState(): Promise<void> {
-        this.currentState = (await this.isLatestItemLoaded()) ? WindowState.LATEST : WindowState.PAST;
+        this.internalState.current = (await this.isLatestItemLoaded()) ? WindowState.LATEST : WindowState.PAST;
     }
 
     protected addItems(newItems: T[], to: 'head' | 'tail'): void {
@@ -190,36 +207,40 @@ export class TopicHistoryWindow extends TraversableRemoteCollection<Message> {
      */
     public readonly WindowState: typeof WindowState = WindowState;
 
-    private traverseLock: boolean = false;
+    declare protected internalState: typeof TraversableRemoteCollection<Message>['prototype']['internalState'] & {
+        traverseLock: boolean,
+    };
 
     public constructor(
         private roomId: string,
         private topicId: string,
         private tracker: ChatStateTracker,
+        bindEvents: boolean = true,
     ) {
         super('id');
-        this.tracker.client.on('Session', ev => this.handleSession(ev));
-        this.tracker.client.on('NewMessage', ev => this.handleNewMessage(ev));
+
+        this.internalState.traverseLock = false;
+
+        if (bindEvents) {
+            this.tracker.client.on('Session', ev => this.handleSession(ev));
+            this.tracker.client.on('NewMessage', ev => this.handleNewMessage(ev));
+        }
     }
 
-    public shallowCopy(): IndexedObjectCollection<Message> {
-        const copy = new TopicHistoryWindow(this.roomId, this.topicId, this.tracker);
+    public createMirror(): TopicHistoryWindow {
+        const copy = new TopicHistoryWindow(this.roomId, this.topicId, this.tracker, false);
         copy.eventTarget = this.eventTarget;
         copy._items = this._items;
-        copy.limit = this.limit;
-        copy.currentState = this.currentState;
-        copy.fetchingState = this.fetchingState;
-        copy.oldestId = this.oldestId;
-        copy.traverseLock = this.traverseLock;
+        copy.internalState = this.internalState;
         return copy;
     }
 
     public get isTraverseLocked(): boolean {
-        return this.traverseLock;
+        return this.internalState.traverseLock;
     }
 
     public async setTraverseLock(lock: boolean): Promise<void> {
-        this.traverseLock = lock;
+        this.internalState.traverseLock = lock;
 
         if (lock && (this.state !== WindowState.LIVE && this.state !== WindowState.LATEST)) {
             await super.resetToLatest();
@@ -227,21 +248,21 @@ export class TopicHistoryWindow extends TraversableRemoteCollection<Message> {
     }
 
     public async resetToLatest(): Promise<void> {
-        if (this.traverseLock) {
+        if (this.internalState.traverseLock) {
             return;
         }
         return super.resetToLatest();
     }
 
     public async fetchNext(): Promise<void> {
-        if (this.traverseLock) {
+        if (this.internalState.traverseLock) {
             return;
         }
         return super.fetchNext();
     }
 
     public async fetchPrevious(): Promise<void> {
-        if (this.traverseLock) {
+        if (this.internalState.traverseLock) {
             return;
         }
         return super.fetchPrevious();
@@ -274,7 +295,7 @@ export class TopicHistoryWindow extends TraversableRemoteCollection<Message> {
         const rooms = ev.state.rooms;
 
         if (rooms.find(room => room.id === this.roomId)) {
-            this.resetToLatest();
+            void this.resetToLatest();
         } else {
             this.deleteAll();
         }

package/tests/history-window.test.ts

@@ -19,7 +19,7 @@ const messages: SimpleMessage[] = [
 ];
 
 class TestableHistoryWindow extends TraversableRemoteCollection<SimpleMessage> {
-    public shallowCopy(): IndexedObjectCollection<SimpleMessage> {
+    public createMirror(): IndexedObjectCollection<SimpleMessage> {
         throw new Error('Method not implemented.');
     }