@flashphoner/sfusdk 1.0.47 → 2.0.48

package/dist/src/sdk/sfu-extended.d.ts

@@ -0,0 +1,126 @@
+import { Calendar, ChannelSendPolicy, ChannelType, Chat, ChatMap, InternalMessage, Invite, Message, MessageAttachment, MessageStatus, SfuEvent, State, User, UserSpecificChatInfo } from "./constants";
+import { RoomExtended } from "./room-extended";
+declare type NotifyUnion = InternalMessage | Message | MessageStatus | Array<User> | Calendar | UserSpecificChatInfo | Invite | User | ChatMap | Chat;
+export declare class SfuExtended {
+    #private;
+    connect(options: {
+        url: string;
+        username: string;
+        password: string;
+        nickname: string;
+        timeout?: number;
+    }): Promise<{
+        username: string;
+        nickname: string;
+        pmi: string;
+    }>;
+    sendMessage(msg: {
+        body: string;
+        chatId: string;
+        attachments?: Array<MessageAttachment>;
+    }): Promise<MessageStatus>;
+    markMessageRead(msg: {
+        id: string;
+        chatId: string;
+    }): Promise<MessageStatus>;
+    markMessageUnread(msg: {
+        id: string;
+        chatId: string;
+    }): Promise<MessageStatus>;
+    getUserList(): Promise<User[]>;
+    getUserCalendar(): Promise<Calendar>;
+    addCalendarEvent(event: {
+        id: string;
+        title: string;
+        description: string;
+        start: number;
+        end: number;
+        recurring: boolean;
+        accessCode: string;
+        waitingRoom: boolean;
+        usePMI: boolean;
+        ownerVideo: boolean;
+        participantVideo: boolean;
+    }): Promise<void>;
+    removeCalendarEvent(event: {
+        id: string;
+    }): Promise<void>;
+    getUserChats(): Promise<ChatMap>;
+    getPublicChannels(): Promise<ChatMap>;
+    loadChat(chat: {
+        id: string;
+    }): Promise<Chat>;
+    createChat(chat: {
+        id?: string;
+        name?: string;
+        members?: Array<string>;
+        favourite?: boolean;
+        channel?: boolean;
+        channelType?: ChannelType;
+        channelSendPolicy?: ChannelSendPolicy;
+        sendPermissionList?: Array<string>;
+    }): Promise<UserSpecificChatInfo>;
+    deleteChat(chat: {
+        id: string;
+    }): Promise<void>;
+    renameChat(chat: {
+        id: string;
+        name: string;
+    }): Promise<void>;
+    addMemberToChat(chat: {
+        id: string;
+        member: string;
+    }): Promise<UserSpecificChatInfo>;
+    removeMemberFromChat(chat: {
+        id: string;
+        member: string;
+    }): Promise<UserSpecificChatInfo>;
+    inviteContact(invite: {
+        to: string;
+    }): Promise<User>;
+    confirmContact(invite: {
+        id: string;
+        from: string;
+        to: string;
+    }): Promise<User>;
+    removeContact(contact: {
+        id: string;
+    }): Promise<User>;
+    updateChannelSendPolicy(channel: {
+        id: string;
+        channelSendPolicy: ChannelSendPolicy;
+    }): Promise<UserSpecificChatInfo>;
+    addChannelSendPermissionListMember(channel: {
+        id: string;
+        member: string;
+    }): Promise<UserSpecificChatInfo>;
+    removeChannelSendPermissionListMember(channel: {
+        id: string;
+        member: string;
+    }): Promise<UserSpecificChatInfo>;
+    addChatToFavourites(chat: {
+        id: string;
+    }): Promise<UserSpecificChatInfo>;
+    removeChatFromFavourites(chat: {
+        id: string;
+    }): Promise<UserSpecificChatInfo>;
+    createRoom(options: {
+        pc: RTCPeerConnection;
+        name: string;
+        pin: string;
+    }): RoomExtended;
+    getRoom(options: {
+        name: string;
+    }): RoomExtended;
+    disconnect(): void;
+    user(): {
+        username: string;
+        nickname: string;
+        pmi: string;
+    };
+    server(): string;
+    state(): State;
+    on(event: SfuEvent, callback: (arg0: NotifyUnion) => void): SfuExtended;
+    off(event: SfuEvent, callback: (arg0: NotifyUnion) => void): SfuExtended;
+}
+export {};

package/dist/src/sdk/sfu.d.ts

@@ -0,0 +1,22 @@
+import { InternalMessage, SfuEvent, State } from "./constants";
+import { Room } from "./room";
+export declare class Sfu {
+    #private;
+    connect(options: {
+        url: string;
+        timeout?: number;
+        nickname: string;
+        logGroup: string;
+    }): Promise<void>;
+    createRoom(options: {
+        pc: RTCPeerConnection;
+        name: string;
+        pin: string;
+    }): Room;
+    disconnect(): void;
+    room(): Room;
+    nickname(): string;
+    state(): State;
+    on(event: SfuEvent, callback: (arg0: InternalMessage) => void): Sfu;
+    off(event: SfuEvent, callback: (arg0: InternalMessage) => void): Sfu;
+}

package/package.json

@@ -1,31 +1,20 @@
 {
   "name": "@flashphoner/sfusdk",
+  "version": "2.0.48",
   "description": "Official Flashphoner WebCallServer SFU SDK package",
-  "version": "1.0.47",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
   "scripts": {
-    "test": "jest --runInBand"
-  },
-  "dependencies": {
-    "bootstrap": "^4.6.0",
-    "datatables.net": "^1.10.24",
-    "datatables.net-dt": "^1.10.24",
-    "jquery": "^3.6.0",
-    "jquery-ui": "^1.12.1",
-    "popper.js": "^1.16.1",
-    "sdp-transform": "^2.14.0",
-    "uuid": "^8.3.0",
-    "webrtc-adapter": "^7.2.6"
-  },
-  "devDependencies": {
-    "@mapbox/node-pre-gyp": "^1.0.8",
-    "grunt": "^1.0.1",
-    "grunt-browserify": "^5.0.0",
-    "grunt-contrib-clean": "^1.0.0",
-    "grunt-contrib-copy": "^1.0.0",
-    "grunt-jsdoc": "^2.4.0",
-    "grunt-run": "^0.8.1",
-    "jest": "^27.4.7",
-    "wrtc": "^0.4.7"
+    "clean": "rm -rf dist/*",
+    "test": "jest --runInBand --forceExit",
+    "build": "tsc",
+    "build-examples": "webpack --mode=production",
+    "publish-lib": "npm run build && npm publish",
+    "publish-beta": "npm run build && npm publish --tag beta",
+    "publish-dryrun": "npm run build && npm publish --dry-run"
   },
   "keywords": [
     "Flashphoner",
@@ -34,8 +23,19 @@
   ],
   "author": "Flashphoner",
   "license": "MIT",
-  "jest" : {
-    "testEnvironment": "jsdom",
-    "testRunner": "jest-jasmine2"
+  "devDependencies": {
+    "@mapbox/node-pre-gyp": "^1.0.8",
+    "@types/jest": "^27.4.1",
+    "jest": "^27.4.7",
+    "ts-jest": "^27.1.4",
+    "ts-loader": "^9.2.8",
+    "typescript": "^4.6.3",
+    "webpack": "^5.72.0",
+    "webpack-cli": "^4.9.2",
+    "wrtc": "^0.4.7"
+  },
+  "dependencies": {
+    "uuid": "^8.3.0",
+    "webrtc-adapter": "^7.2.6"
   }
 }

package/Gruntfile.js

@@ -1,79 +0,0 @@
-module.exports = function(grunt) {
-    grunt.initConfig({
-        pkg: grunt.file.readJSON('package.json'),
-        browserify: {
-            PSFUOBject: {
-                src: ['./src/sdk/sfu.js'],
-                dest: './out/sfu.js',
-                options: {
-                    browserifyOptions: {
-                        standalone: 'SFU'
-                    }
-                }
-            },
-            ZSFUOBject: {
-                src: ['./src/sdk/sfu-extended.js'],
-                dest: './out/sfu-extended.js',
-                options: {
-                    browserifyOptions: {
-                        standalone: 'SFUExtended'
-                    }
-                }
-            }
-        },
-        copy: {
-            examples: {
-                files: [
-                    {
-                        expand: true,
-                        cwd: './src',
-                        src: [
-                            'examples/**'
-                        ],
-                        dest: 'out'
-                    }
-                ]
-            }
-        },
-        jsdoc: {
-            src: ['./src/sdk/sfu.js', './src/sdk/sfu-extended.js', './src/sdk/room.js', './src/sdk/constants.js'],
-            options: {
-                template: './docTemplate',
-                readme: './docTemplate/README.md',
-                destination: 'out/doc/'
-            }
-        },
-        clean: {
-            build: [
-                'out/'
-            ],
-            release: [
-                'release'
-            ]
-        },
-        run: {
-            options: {
-                // ...
-            },
-            test: {
-                cmd: 'npm',
-                args: [
-                    'run',
-                    'test'
-                ]
-            }
-        }
-    });
-
-    grunt.loadNpmTasks('grunt-browserify');
-    grunt.loadNpmTasks('grunt-contrib-copy');
-    grunt.loadNpmTasks('grunt-contrib-clean');
-    grunt.loadNpmTasks('grunt-jsdoc');
-    grunt.loadNpmTasks('grunt-run');
-    grunt.registerTask('build', [
-        'clean:build',
-        'copy',
-        'browserify',
-        'jsdoc'
-    ]);
-};

package/README.md

@@ -1,95 +0,0 @@
-# @flashphoner/sfusdk
-
-# Flashphoner WebCallServer SFU JavaScript API (SFU SDK)
-
-Flashphoner [WebCallServer](https://flashphoner.com) [SFU](https://docs.flashphoner.com/display/WCS52EN/SFU+functions+with+Simulcast) JavaScript API (SFU SDK) implementation.
-
-## Install
-```
-npm install @flashphoner/sfusdk
-```
-
-## Usage example
-```
-import React, {useState} from "react";
-import * as SFU from '@flashphoner/sfusdk/src/sdk/sfu.js'
-import * as Constants from '@flashphoner/sfusdk/src/sdk/constants.js'
-
-export default function TestApp() {
-    const [url, setUrl] = useState("ws://localhost:8080");
-    const [established, setEstablished] = useState("Not connected");
-    const [buttonText, setButtonText] = useState("Connect");
-    const [session, setSession] = useState(null);
-
-    function onClick() {
-        if (session == null) {
-            console.log("Trying to connect");
-            const pc = new RTCPeerConnection();
-            const s = SFU.createRoom({
-                url: url,
-                roomName: "ROOM",
-                pin: "1234",
-                nickname: "Test",
-                pc: pc
-            }).on(Constants.SFU_EVENT.CONNECTED, (room) => {
-                console.log("Connected!");
-                setEstablished("Connected!");
-                setButtonText("Disconnect");
-                setSession(s);
-                room.join();
-            }).on(Constants.SFU_EVENT.DISCONNECTED, () => {
-                console.log("Disconnected!");
-                setEstablished("Not connected!");
-                setButtonText("Connect");
-                setSession(null);
-            });
-        } else {
-            let room = session.room();
-            if(room) {
-                room.destroyRoom()
-            }
-            session.disconnect();            
-        }
-    }
-
-    return(
-        <div>
-            <div>
-                <input type="text" value={url} placeholder="Enter server websocket URL" onChange={(e) => setUrl(e.target.value)}/>
-                <button onClick={() => onClick()}>{buttonText}</button>
-            </div>
-            <div>{established}</div>
-        </div>
-        
-    )
-}
-```
-
-## Building browserified JS bundle
-
-### Install grunt (if this is not installed)
-```
-npm install grunt
-```
-
-### Build
-```
-grunt build
-```
-
-### Deploy to web server
-```
-mkdir -p /var/www/html/flashphoner-sfu-test
-cp -r out/* /var/www/html/flashphoner-sfu-test
-```
-
-## Documentation
-
-[SFU functions description](https://docs.flashphoner.com/display/WCS52EN/SFU+functions+with+Simulcast)
-[SFU SDK documentation](https://docs.flashphoner.com/display/SS1E/SFU+SDK+1.0+-+EN)
-[SFU examples description](https://docs.flashphoner.com/display/SS1E/SFU+SDK+Examples)
-[API documentation](http://flashphoner.com/docs/api/WCS5/client/sfu-sdk/latest)
-
-## Known issues
-
-SFU SDK is built with [webrtc/adapter](https://github.com/webrtc/adapter/) library version not lower than 7.2.6. In this regard, direct use of this library together with WebSDK should be avoided.