User Typing indicator API

src/definition/accessors/INotifier.ts

@@ -3,6 +3,31 @@ import { IRoom } from '../rooms';
 import { IUser } from '../users';
 import { IMessageBuilder } from './IMessageBuilder';
 
+export enum TypingScope {
+    Room = 'room',
+}
+
+export interface ITypingOptions {
+    /**
+     * The typing scope where the typing message should be presented,
+     * TypingScope.Room by default.
+     */
+    scope?: TypingScope;
+    /**
+     * The id of the typing scope
+     *
+     * TypingScope.Room <-> room.id
+     */
+    id: string;
+    /**
+     * The name of the user who is typing the message
+     *
+     * **Note**: If not provided, it will use app assigned
+     * user's name by default.
+     */
+    username?: string;
+}
+
 export interface INotifier {
     /**
      * Notifies the provided user of the provided message.
@@ -26,6 +51,13 @@ export interface INotifier {
      */
     notifyRoom(room: IRoom, message: IMessage): Promise<void>;
 
+    /**
+     * Notifies all of the users a typing indicator in the provided scope.
+     *
+     * @returns a cancellation function to stop typing
+     */
+    typing(options: ITypingOptions): Promise<() => Promise<void>>;
+
     /** Gets a new message builder for building a notification message. */
     getMessageBuilder(): IMessageBuilder;
 }

src/server/accessors/Notifier.ts

@@ -1,4 +1,5 @@
 import { IMessageBuilder, INotifier } from '../../definition/accessors';
+import { ITypingOptions, TypingScope } from '../../definition/accessors/INotifier';
 import { IMessage } from '../../definition/messages';
 import { IRoom } from '../../definition/rooms';
 import { IUser } from '../../definition/users';
@@ -32,6 +33,19 @@ export class Notifier implements INotifier {
         await this.msgBridge.notifyRoom(room, message, this.appId);
     }
 
+    public async typing(options: ITypingOptions): Promise<() => Promise<void>> {
+        options.scope = options.scope || TypingScope.Room;
+
+        if (!options.username) {
+            const appUser = await this.userBridge.getAppUser(this.appId);
+            options.username = appUser && appUser.name || '';
+        }
+
+        this.msgBridge.typing({ ...options, isTyping: true });
+
+        return () => this.msgBridge.typing({ ...options, isTyping: false });
+    }
+
     public getMessageBuilder(): IMessageBuilder {
         return new MessageBuilder();
     }

src/server/bridges/IMessageBridge.ts

@@ -1,11 +1,17 @@
+import { ITypingOptions } from '../../definition/accessors/INotifier';
 import { IMessage } from '../../definition/messages';
 import { IRoom } from '../../definition/rooms';
 import { IUser } from '../../definition/users/IUser';
 
+export interface ITypingDescriptor extends ITypingOptions {
+    isTyping: boolean;
+}
+
 export interface IMessageBridge {
     create(message: IMessage, appId: string): Promise<string>;
     getById(messageId: string, appId: string): Promise<IMessage>;
     update(message: IMessage, appId: string): Promise<void>;
     notifyUser(user: IUser, message: IMessage, appId: string): Promise<void>;
     notifyRoom(room: IRoom, message: IMessage, appId: string): Promise<void>;
+    typing(options: ITypingDescriptor): Promise<void>;
 }

tests/test-data/bridges/messageBridge.ts

@@ -1,8 +1,8 @@
 import { IMessage } from '../../../src/definition/messages';
 import { IRoom } from '../../../src/definition/rooms';
 import { IUser } from '../../../src/definition/users';
-
 import { IMessageBridge } from '../../../src/server/bridges';
+import { ITypingDescriptor } from '../../../src/server/bridges/IMessageBridge';
 
 export class TestsMessageBridge implements IMessageBridge {
     public create(message: IMessage, appId: string): Promise<string> {
@@ -24,4 +24,8 @@ export class TestsMessageBridge implements IMessageBridge {
     public notifyRoom(room: IRoom, message: IMessage, appId: string): Promise<void> {
         throw new Error('Method not implemented.');
     }
+
+    public typing(options: ITypingDescriptor): Promise<void> {
+        throw new Error('Method not implemented.');
+    }
 }