polfan-server-js-client 0.2.54 → 0.2.56

package/build/types/IndexedObjectCollection.d.ts

@@ -1,9 +1,7 @@
 import { EventTarget, ObservableInterface } from "./EventTarget";
 export declare class IndexedCollection<KeyT, ValueT> {
     protected _items: Map<KeyT, ValueT>;
-    protected _mutationCounter: number;
     constructor(items?: [key: KeyT, value: ValueT][]);
-    get mutationCounter(): number;
     get items(): Map<KeyT, ValueT>;
     get length(): number;
     set(...items: [KeyT, ValueT][]): void;
@@ -12,6 +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>;
 }
 export declare class IndexedObjectCollection<T> {
     readonly id: keyof T | ((item: T) => any);
@@ -19,7 +18,6 @@ export declare class IndexedObjectCollection<T> {
     constructor(id: keyof T | ((item: T) => any), items?: T[]);
     get items(): T[];
     get length(): number;
-    get mutationCounter(): number;
     set(...items: T[]): void;
     get(id: any): T | undefined;
     getAt(index: number): T | undefined;
@@ -27,6 +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>;
     protected getId(item: T): any;
 }
 interface ObservableCollectionEvent<KeyT> {
@@ -39,6 +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>;
     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,6 +50,7 @@ export declare class ObservableIndexedObjectCollection<T> extends IndexedObjectC
     set(...items: T[]): void;
     delete(...ids: string[]): void;
     deleteAll(): void;
+    shallowCopy(): 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

@@ -1,6 +1,6 @@
 import { Message, Topic } from "../types/src";
 import { ChatStateTracker } from "./ChatStateTracker";
-import { ObservableIndexedObjectCollection } from "../IndexedObjectCollection";
+import { IndexedObjectCollection, ObservableIndexedObjectCollection } from "../IndexedObjectCollection";
 export declare enum WindowState {
     /**
      * The latest messages (those received live) are available in the history window, history has not been fetched.
@@ -31,9 +31,10 @@ export declare abstract class TraversableRemoteCollection<T> extends ObservableI
      * Null for unlimited.
      */
     limit: number | null;
-    private currentState;
-    private fetchingState;
     oldestId: string;
+    protected currentState: WindowState;
+    protected fetchingState: WindowState;
+    abstract shallowCopy(): IndexedObjectCollection<T>;
     get hasLatest(): boolean;
     get hasOldest(): boolean;
     resetToLatest(): Promise<void>;
@@ -60,6 +61,7 @@ export declare class TopicHistoryWindow extends TraversableRemoteCollection<Mess
     readonly WindowState: typeof WindowState;
     private traverseLock;
     constructor(roomId: string, topicId: string, tracker: ChatStateTracker);
+    shallowCopy(): IndexedObjectCollection<Message>;
     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.54",
+  "version": "0.2.56",
   "description": "JavaScript client library for handling communication with Polfan chat server.",
   "author": "Jarosław Żak",
   "license": "MIT",

package/src/IndexedObjectCollection.ts

@@ -2,16 +2,11 @@ import {EventTarget, ObservableInterface} from "./EventTarget";
 
 export class IndexedCollection<KeyT, ValueT> {
     protected _items: Map<KeyT, ValueT> = new Map();
-    protected _mutationCounter: number = 0;
 
     public constructor(items: [key: KeyT, value: ValueT][] = []) {
         this.set(...items);
     }
 
-    public get mutationCounter(): number {
-        return this._mutationCounter;
-    }
-
     public get items(): Map<KeyT, ValueT> {
         return this._items;
     }
@@ -21,7 +16,6 @@ export class IndexedCollection<KeyT, ValueT> {
     }
 
     public set(...items: [KeyT, ValueT][]): void {
-        this._mutationCounter++;
         for (const item of items) {
             this._items.set(item[0], item[1]);
         }
@@ -39,12 +33,10 @@ export class IndexedCollection<KeyT, ValueT> {
         for (const id of ids) {
             this.items.delete(id);
         }
-        this._mutationCounter++;
     }
 
     public deleteAll(): void {
         this.items.clear();
-        this._mutationCounter++;
     }
 
     public findBy(field: keyof ValueT, valueToFind: any, limit: number = null): IndexedCollection<KeyT, ValueT> {
@@ -60,6 +52,12 @@ export class IndexedCollection<KeyT, ValueT> {
         }
         return result;
     }
+
+    public shallowCopy(): IndexedCollection<KeyT, ValueT> {
+        const copy = new IndexedCollection<KeyT, ValueT>();
+        copy._items = this._items;
+        return copy;
+    }
 }
 
 export class IndexedObjectCollection<T> {
@@ -81,10 +79,6 @@ export class IndexedObjectCollection<T> {
         return this._items.length;
     }
 
-    public get mutationCounter(): number {
-        return this._items.mutationCounter;
-    }
-
     public set(...items: T[]): void {
         this._items.set(...(items.map(item => [this.getId(item), item] as [string, T])));
     }
@@ -122,6 +116,12 @@ export class IndexedObjectCollection<T> {
         return result;
     }
 
+    public shallowCopy(): IndexedObjectCollection<T> {
+        const copy = new IndexedObjectCollection<T>(this.id);
+        copy._items = this._items;
+        return copy;
+    }
+
     protected getId(item: T): any {
         return typeof this.id === 'function' ? this.id(item) : item[this.id];
     }
@@ -163,6 +163,13 @@ export class ObservableIndexedCollection<KeyT, ValueT> extends IndexedCollection
         }
     }
 
+    public shallowCopy(): ObservableIndexedCollection<KeyT, ValueT> {
+        const copy = new ObservableIndexedCollection<KeyT, ValueT>();
+        copy.eventTarget = this.eventTarget;
+        copy._items = this._items;
+        return copy;
+    }
+
     public on(eventName: 'change', handler: (ev?: ObservableCollectionEvent<KeyT>) => void): this {
         this.eventTarget.on(eventName, handler);
         return this;
@@ -213,6 +220,13 @@ export class ObservableIndexedObjectCollection<T> extends IndexedObjectCollectio
         }
     }
 
+    public shallowCopy(): IndexedObjectCollection<T> {
+        const copy = new ObservableIndexedObjectCollection<T>(this.id);
+        copy.eventTarget = this.eventTarget;
+        copy._items = this._items;
+        return copy;
+    }
+
     public on(eventName: 'change', handler: (ev?: ObservableCollectionEvent<string>) => void): this {
         this.eventTarget.on(eventName, handler);
         return this;

package/src/state-tracker/TopicHistoryWindow.ts

@@ -1,6 +1,6 @@
 import {Message, NewMessage, Session, Topic} from "../types/src";
 import {ChatStateTracker} from "./ChatStateTracker";
-import {ObservableIndexedObjectCollection} from "../IndexedObjectCollection";
+import {IndexedObjectCollection, ObservableIndexedObjectCollection} from "../IndexedObjectCollection";
 
 export enum WindowState {
     /**
@@ -40,10 +40,13 @@ export abstract class TraversableRemoteCollection<T> extends ObservableIndexedOb
      */
     public limit: number | null = 50;
 
-    private currentState: WindowState = WindowState.LIVE;
-    private fetchingState: WindowState = undefined;
     public oldestId: string = null;
 
+    protected currentState: WindowState = WindowState.LIVE;
+    protected fetchingState: WindowState = undefined;
+
+    public abstract shallowCopy(): IndexedObjectCollection<T>;
+
     public get hasLatest(): boolean {
         return [WindowState.LATEST, WindowState.LIVE].includes(this.state);
     }
@@ -199,6 +202,16 @@ export class TopicHistoryWindow extends TraversableRemoteCollection<Message> {
         this.tracker.client.on('NewMessage', ev => this.handleNewMessage(ev));
     }
 
+    public shallowCopy(): IndexedObjectCollection<Message> {
+        const copy = new TopicHistoryWindow(this.roomId, this.topicId, this.tracker);
+        copy._items = this._items;
+        copy.limit = this.limit;
+        copy.currentState = this.currentState;
+        copy.fetchingState = this.fetchingState;
+        copy.oldestId = this.oldestId;
+        return copy;
+    }
+
     public get isTraverseLocked(): boolean {
         return this.traverseLock;
     }

package/tests/history-window.test.ts

@@ -1,4 +1,5 @@
-import {TraversableRemoteCollection, WindowState} from "../src/state-tracker/TopicHistoryWindow";
+import { IndexedObjectCollection } from "../src";
+import {TopicHistoryWindow, TraversableRemoteCollection, WindowState} from "../src/state-tracker/TopicHistoryWindow";
 
 interface SimpleMessage {
     id: number;
@@ -18,6 +19,10 @@ const messages: SimpleMessage[] = [
 ];
 
 class TestableHistoryWindow extends TraversableRemoteCollection<SimpleMessage> {
+    public shallowCopy(): IndexedObjectCollection<SimpleMessage> {
+        throw new Error('Method not implemented.');
+    }
+
     public constructor() {
         super('id');
     }