polfan-server-js-client 0.3.2 → 0.4.0

package/src/types/src/schemes/User.ts

@@ -1,9 +1,25 @@
 export type UserTags = 'bot' | 'temp' | string;
 
+/**
+ * Availability of a user, aggregated over all of their sessions.
+ *
+ * - `Offline` - no session is connected and none can be reached asynchronously.
+ * - `Online` - at least one session holds a live connection.
+ * - `OnlineAsync` - no live connection, but a push-registered device was active
+ *   recently, so a message will still reach the user.
+ */
+export enum UserStatus {
+    Offline = 0,
+    Online = 1,
+    OnlineAsync = 2,
+}
+
 export interface User {
     id: string;
     nick: string;
     avatar: string;
     tags: UserTags[];
+    status: UserStatus;
+    /** @deprecated Use {@link status}. Kept for clients older than the numeric status. */
     online: boolean;
-}
+}

package/src/types/src/schemes/UserData.ts

@@ -2,4 +2,9 @@ export type PrivateMessagePolicy = 'None' | 'Mutual' | 'All';
 
 export interface UserData {
     privateMessagePolicy: PrivateMessagePolicy;
+    /**
+     * Whether others may see that the user is reachable on a push-registered
+     * device while disconnected. When false the user simply reads as offline.
+     */
+    showAsyncPresence: boolean;
 }

package/src/types/src/schemes/commands/SetSessionData.ts

@@ -1,10 +1,19 @@
+import {SessionPlatform} from "../SessionData";
+
 export interface SessionPush {
     token?: string;
-    platform?: 'ios' | 'android' | 'web';
     active?: boolean;
+    /**
+     * @deprecated The platform describes the session, not its push registration.
+     * Use {@link SetSessionData.platform} (or the `platform` connection query
+     * parameter). Still accepted by the server, but the top-level field wins.
+     */
+    platform?: SessionPlatform;
 }
 
 export interface SetSessionData {
     clientFocused?: boolean;
     push?: SessionPush;
-}
+    /** Client platform of this session; null leaves the stored value unchanged. */
+    platform?: SessionPlatform;
+}

package/src/types/src/schemes/commands/SetUserData.ts

@@ -2,4 +2,5 @@ import {PrivateMessagePolicy} from "../UserData";
 
 export interface SetUserData {
     privateMessagePolicy?: PrivateMessagePolicy;
+    showAsyncPresence?: boolean;
 }

package/tests/async-utils.test.ts

@@ -1,30 +1,30 @@
-import {PromiseRegistry} from "../src/state-tracker/AsyncUtils";
-
-test('promise registry - limit the calling of async process', async () => {
-    const pr = new PromiseRegistry();
-    let generationCount = 0;
-
-    async function generateResult() {
-        return ++generationCount;
-    }
-
-    async function getResult() {
-        const resultKey = 'test';
-
-        if (pr.notExist('test')) {
-            pr.registerByFunction(generateResult, resultKey);
-        }
-
-        await pr.get(resultKey);
-        return generationCount;
-    }
-
-    const call1 = await getResult();
-    expect(call1).toBe(1);
-    const call2 = await getResult();
-    expect(call2).toBe(1);
-    const call3 = await getResult();
-    expect(call3).toBe(1);
-
-    expect(generationCount).toBe(1);
+import {PromiseRegistry} from "../src/state-tracker/AsyncUtils";
+
+test('promise registry - limit the calling of async process', async () => {
+    const pr = new PromiseRegistry();
+    let generationCount = 0;
+
+    async function generateResult() {
+        return ++generationCount;
+    }
+
+    async function getResult() {
+        const resultKey = 'test';
+
+        if (pr.notExist('test')) {
+            pr.registerByFunction(generateResult, resultKey);
+        }
+
+        await pr.get(resultKey);
+        return generationCount;
+    }
+
+    const call1 = await getResult();
+    expect(call1).toBe(1);
+    const call2 = await getResult();
+    expect(call2).toBe(1);
+    const call3 = await getResult();
+    expect(call3).toBe(1);
+
+    expect(generationCount).toBe(1);
 });

package/tests/space-roles.test.ts

@@ -1,43 +1,43 @@
-import {IndexedObjectCollection} from "../src";
-import {Role} from "pserv-ts-types";
-import {reorderRolesOnPriorityUpdate} from "../src/state-tracker/functions";
-
-const createCollection = () => new IndexedObjectCollection<Role>(
-    role => role.id,
-    [
-        {id: 'id1', name: 'everyone', priority: 0, color: '#ff0000'},
-        {id: 'id2', name: 'roleA', priority: 1, color: '#ff0000'},
-        {id: 'id3', name: 'roleB', priority: 2, color: '#ff0000'},
-        {id: 'id4', name: 'roleC', priority: 3, color: '#ff0000'},
-        {id: 'id5', name: 'roleD', priority: 4, color: '#ff0000'},
-    ],
-);
-
-test('roles reorder - increase', () => {
-    const collection = createCollection();
-    const oldRole = collection.get('id2');
-    const newRole: Role = {...oldRole, priority: 4};
-    const result = reorderRolesOnPriorityUpdate(collection.items, oldRole, newRole);
-    collection.set(newRole, ...result);
-
-    //expect(result.length).toBe(3);
-    expect(collection.get('id1').priority).toBe(0);
-    expect(collection.get('id2').priority).toBe(4);
-    expect(collection.get('id3').priority).toBe(1);
-    expect(collection.get('id4').priority).toBe(2);
-    expect(collection.get('id5').priority).toBe(3);
-});
-
-test('roles reorder - decrease', () => {
-    const collection = createCollection();
-    const oldRole = collection.get('id5');
-    const newRole: Role = {...oldRole, priority: 0};
-    const result = reorderRolesOnPriorityUpdate(collection.items, oldRole, newRole);
-    collection.set(newRole, ...result);
-
-    expect(collection.get('id1').priority).toBe(1);
-    expect(collection.get('id2').priority).toBe(2);
-    expect(collection.get('id3').priority).toBe(3);
-    expect(collection.get('id4').priority).toBe(4);
-    expect(collection.get('id5').priority).toBe(0);
+import {IndexedObjectCollection} from "../src";
+import {Role} from "pserv-ts-types";
+import {reorderRolesOnPriorityUpdate} from "../src/state-tracker/functions";
+
+const createCollection = () => new IndexedObjectCollection<Role>(
+    role => role.id,
+    [
+        {id: 'id1', name: 'everyone', priority: 0, color: '#ff0000'},
+        {id: 'id2', name: 'roleA', priority: 1, color: '#ff0000'},
+        {id: 'id3', name: 'roleB', priority: 2, color: '#ff0000'},
+        {id: 'id4', name: 'roleC', priority: 3, color: '#ff0000'},
+        {id: 'id5', name: 'roleD', priority: 4, color: '#ff0000'},
+    ],
+);
+
+test('roles reorder - increase', () => {
+    const collection = createCollection();
+    const oldRole = collection.get('id2');
+    const newRole: Role = {...oldRole, priority: 4};
+    const result = reorderRolesOnPriorityUpdate(collection.items, oldRole, newRole);
+    collection.set(newRole, ...result);
+
+    //expect(result.length).toBe(3);
+    expect(collection.get('id1').priority).toBe(0);
+    expect(collection.get('id2').priority).toBe(4);
+    expect(collection.get('id3').priority).toBe(1);
+    expect(collection.get('id4').priority).toBe(2);
+    expect(collection.get('id5').priority).toBe(3);
+});
+
+test('roles reorder - decrease', () => {
+    const collection = createCollection();
+    const oldRole = collection.get('id5');
+    const newRole: Role = {...oldRole, priority: 0};
+    const result = reorderRolesOnPriorityUpdate(collection.items, oldRole, newRole);
+    collection.set(newRole, ...result);
+
+    expect(collection.get('id1').priority).toBe(1);
+    expect(collection.get('id2').priority).toBe(2);
+    expect(collection.get('id3').priority).toBe(3);
+    expect(collection.get('id4').priority).toBe(4);
+    expect(collection.get('id5').priority).toBe(0);
 });