fcr-core 3.4.0

package/lib/base-session.d.ts

@@ -0,0 +1,3 @@
+import { FcrSessionBase } from './type';
+export declare abstract class BaseSession<T extends FcrSessionBase> {
+}

package/lib/base-session.js

@@ -0,0 +1,8 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.BaseSession = void 0;
+class BaseSession {}
+exports.BaseSession = BaseSession;

package/lib/chat-connection/config.d.ts

@@ -0,0 +1,51 @@
+/**
+ * git do not control webim.config.js
+ * everyone should copy webim.config.js.demo to webim.config.js
+ * and have their own configs.
+ * In this way , others won't be influenced by this config while git pull.
+ */
+declare const agoraChatConfig: {
+    Host: string;
+    https: boolean;
+    isHttpDNS: boolean;
+    isMultiLoginSessions: boolean;
+    /**
+     * @parameter {Boolean} true or false
+     */
+    isSandBox: boolean;
+    /**
+     * Whether to console.log
+     * @parameter {Boolean} true or false
+     */
+    isDebug: boolean;
+    /**
+     * will auto connect the websocket server autoReconnectNumMax times in background when client is offline.
+     * won't auto connect if autoReconnectNumMax=0.
+     */
+    autoReconnectNumMax: number;
+    /**
+     * webrtc supports WebKit and https only
+     */
+    useOwnUploadFun: boolean;
+    isAutoLogin: boolean;
+    /**
+     * Size of message cache for person to person
+     */
+    p2pMessageCacheSize: number;
+    /**
+     * When a message arrived, the receiver send an ack message to the
+     * sender, in order to tell the sender the message has delivered.
+     * See call back function onReceivedMessage
+     */
+    delivery: boolean;
+    /**
+     * Size of message cache for group chating like group, chatroom etc. For use in this demo
+     */
+    groupMessageCacheSize: number;
+    /**
+     * enable localstorage for history messages. For use in this demo
+     */
+    enableLocalStorage: boolean;
+    deviceId: string;
+};
+export { agoraChatConfig };

package/lib/chat-connection/config.js

@@ -0,0 +1,105 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.agoraChatConfig = void 0;
+/**
+ * git do not control webim.config.js
+ * everyone should copy webim.config.js.demo to webim.config.js
+ * and have their own configs.
+ * In this way , others won't be influenced by this config while git pull.
+ */
+
+// for react native
+// var location = {
+//     protocol: "https"
+// }
+
+const agoraChatConfig = exports.agoraChatConfig = {
+  /*
+   * websocket server
+   * im-api-v2.easemob.com/ws 线上环境
+   * im-api-v2-hsb.easemob.com/ws 沙箱环境
+   */
+  // socketServer: getUrl().socketUrl, //(window.location.protocol === "https:" ? "https:" : "http:") + "//im-api-v2.easemob.com/ws",
+  /*
+   * Backend REST API URL
+   * a1.easemob.com 线上环境
+   * a1-hsb.easemob.com 沙箱环境
+   */
+  // restServer: getUrl().apiUrl, //(window.location.protocol === "https:" ? "https:" : "http:") + "//a1.easemob.com",
+  /*
+   * Application AppKey
+   */
+  // appkey: 'easemob-demo#cloudclass',
+  /*
+   * Application Host
+   */
+  Host: 'easemob.com',
+  /*
+   * Whether to use HTTPS
+   * @parameter {Boolean} true or false
+   */
+  https: true,
+  /*
+   * 公有云配置默认为 true，
+   * 私有云配置请设置 isHttpDNS = false , 详细文档：http://docs-im.easemob.com/im/web/other/privatedeploy
+   */
+  isHttpDNS: true,
+  /*
+   * isMultiLoginSessions
+   * true: A visitor can sign in to multiple webpages and receive messages at all the webpages.
+   * false: A visitor can sign in to only one webpage and receive messages at the webpage.
+   */
+  isMultiLoginSessions: true,
+  /**
+   * @parameter {Boolean} true or false
+   */
+  isSandBox: false,
+  //内部测试环境，集成时设为false
+  /**
+   * Whether to console.log
+   * @parameter {Boolean} true or false
+   */
+  isDebug: true,
+  /**
+   * will auto connect the websocket server autoReconnectNumMax times in background when client is offline.
+   * won't auto connect if autoReconnectNumMax=0.
+   */
+  autoReconnectNumMax: 10,
+  /**
+   * webrtc supports WebKit and https only
+   */
+  // isWebRTC: window.RTCPeerConnection && /^https\:$/.test(window.location.protocol),
+  /*
+   * Upload pictures or file to your own server and send message with url
+   * @parameter {Boolean} true or false
+   * true: Using the API provided by SDK to upload file to huanxin server
+   * false: Using your method to upload file to your own server
+   */
+  useOwnUploadFun: false,
+  /*
+   * Set to auto sign-in
+   */
+  isAutoLogin: false,
+  /**
+   * Size of message cache for person to person
+   */
+  p2pMessageCacheSize: 500,
+  /**
+   * When a message arrived, the receiver send an ack message to the
+   * sender, in order to tell the sender the message has delivered.
+   * See call back function onReceivedMessage
+   */
+  delivery: false,
+  /**
+   * Size of message cache for group chating like group, chatroom etc. For use in this demo
+   */
+  groupMessageCacheSize: 200,
+  /**
+   * enable localstorage for history messages. For use in this demo
+   */
+  enableLocalStorage: true,
+  deviceId: 'webim'
+};

package/lib/chat-connection/index.d.ts

@@ -0,0 +1,25 @@
+import { EasemobChat } from '../imports';
+import { FcrChatConnection, FcrChatConnectionObserver, FcrChatConnectionState } from './type';
+import { FcrCoreServiceApi } from '../service/api';
+import { FcrCoreEngineConfig } from '../type';
+export declare class FcrChatConnectionImpl implements FcrChatConnection {
+    private _config;
+    private _api;
+    protected logger: import("agora-foundation/lib/logger").Logger;
+    private _observable;
+    private _initConfig?;
+    private _chatIpList?;
+    private _restIpList?;
+    private _conn?;
+    private _connectionState;
+    constructor(_config: FcrCoreEngineConfig, _api: FcrCoreServiceApi);
+    login(): Promise<void>;
+    private _addEventListeners;
+    logout(): void;
+    private _setConnectionState;
+    getConnectionState(): FcrChatConnectionState;
+    getConnectionInstance(): EasemobChat.Connection;
+    addObserver(observer: FcrChatConnectionObserver): void;
+    removeObserver(observer: FcrChatConnectionObserver): void;
+    private _getPrivateConfig;
+}

package/lib/chat-connection/index.js

@@ -0,0 +1,118 @@
+"use strict";
+
+require("core-js/modules/es.array.push.js");
+require("core-js/modules/esnext.async-iterator.filter.js");
+require("core-js/modules/esnext.async-iterator.for-each.js");
+require("core-js/modules/esnext.iterator.constructor.js");
+require("core-js/modules/esnext.iterator.filter.js");
+require("core-js/modules/esnext.iterator.for-each.js");
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FcrChatConnectionImpl = void 0;
+require("core-js/modules/es.json.stringify.js");
+require("core-js/modules/es.regexp.exec.js");
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _imports = require("../imports");
+var _type = require("./type");
+var _parameters = require("../utilities/parameters");
+var _config2 = require("./config");
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+class FcrChatConnectionImpl {
+  constructor(_config, _api) {
+    (0, _defineProperty2.default)(this, "logger", (0, _imports.getLogger)());
+    (0, _defineProperty2.default)(this, "_observable", new _imports.AgoraObservable());
+    (0, _defineProperty2.default)(this, "_connectionState", _type.FcrChatConnectionState.DISCONNECTED);
+    this._config = _config;
+    this._api = _api;
+  }
+  async login() {
+    this._chatIpList = (0, _parameters.getEasemobChatIpList)(this._config.parameters);
+    this._restIpList = (0, _parameters.getEasemobRestIpList)(this._config.parameters);
+    const privateConfig = this._getPrivateConfig();
+    if (privateConfig) {
+      this.logger.info('[ChatRoomControl] use private config:', JSON.stringify(privateConfig));
+    }
+    await (0, _imports.to)((0, _imports.retryAttempt)(async () => {
+      const tokenResult = await this._api.getUserToken(this._config.userId);
+      this._initConfig = tokenResult;
+      const connParams = _objectSpread(_objectSpread(_objectSpread({}, _config2.agoraChatConfig), privateConfig), {}, {
+        appKey: tokenResult.appKey
+      });
+      this._conn = new _imports.EasemobChatSDK.connection(connParams);
+      await this._conn.open({
+        accessToken: this._initConfig.token,
+        user: this._config.userId
+      });
+      this._observable.notifyObservers('onConnectionLoginSuccess');
+      this._addEventListeners();
+    }, [], {
+      retriesMax: 3
+    }).fail(async _ref => {
+      let {
+        error,
+        timeFn,
+        currentRetry
+      } = _ref;
+      if (error instanceof _imports.AgoraRestfulClientError) {
+        throw error;
+      }
+      this.logger.error("[ChatConnection] retry to login ChatConnection, ".concat(error.message, ",retry ").concat(currentRetry, " times"));
+      await timeFn();
+      return true;
+    }).exec());
+  }
+  _addEventListeners() {
+    var _this$_conn;
+    (_this$_conn = this._conn) === null || _this$_conn === void 0 || _this$_conn.addEventHandler('connection', {
+      onError: e => {
+        // this._observable.notifyObservers('onErrorOccurred', this._initConfig.roomId);
+      },
+      onConnected: () => {
+        this._setConnectionState(_type.FcrChatConnectionState.CONNECTED);
+      },
+      onDisconnected: () => {
+        this._setConnectionState(_type.FcrChatConnectionState.DISCONNECTED);
+      }
+    });
+  }
+  logout() {
+    var _this$_conn2;
+    (_this$_conn2 = this._conn) === null || _this$_conn2 === void 0 || _this$_conn2.close();
+  }
+  _setConnectionState(state) {
+    this._connectionState = state;
+    this._observable.notifyObservers('onConnectionStateUpdated', state);
+  }
+  getConnectionState() {
+    return this._connectionState;
+  }
+  getConnectionInstance() {
+    return this._conn;
+  }
+  addObserver(observer) {
+    this._observable.addObserver(observer);
+  }
+  removeObserver(observer) {
+    this._observable.removeObserver(observer);
+  }
+  _getPrivateConfig() {
+    var _this$_chatIpList, _this$_restIpList;
+    if ((_this$_chatIpList = this._chatIpList) !== null && _this$_chatIpList !== void 0 && _this$_chatIpList.length || (_this$_restIpList = this._restIpList) !== null && _this$_restIpList !== void 0 && _this$_restIpList.length) {
+      var _this$_chatIpList2, _this$_restIpList2;
+      const privateConfig = {
+        isHttpDNS: false
+      };
+      if ((_this$_chatIpList2 = this._chatIpList) !== null && _this$_chatIpList2 !== void 0 && _this$_chatIpList2.length) {
+        privateConfig.url = this._chatIpList[0];
+      }
+      if ((_this$_restIpList2 = this._restIpList) !== null && _this$_restIpList2 !== void 0 && _this$_restIpList2.length) {
+        privateConfig.apiUrl = this._restIpList[0];
+      }
+      return privateConfig;
+    }
+  }
+}
+exports.FcrChatConnectionImpl = FcrChatConnectionImpl;

package/lib/chat-connection/type.d.ts

@@ -0,0 +1,17 @@
+export interface FcrChatConnection {
+    login(): Promise<void>;
+    logout(): void;
+    getConnectionState(): FcrChatConnectionState;
+    getConnectionInstance(): unknown;
+    addObserver(observer: FcrChatConnectionObserver): void;
+    removeObserver(observer: FcrChatConnectionObserver): void;
+}
+export interface FcrChatConnectionObserver {
+    onConnectionStateUpdated(state: FcrChatConnectionState): void;
+    onConnectionLoginSuccess(): void;
+}
+export declare enum FcrChatConnectionState {
+    DISCONNECTED = 0,
+    CONNECTION = 1,
+    CONNECTED = 2
+}

package/lib/chat-connection/type.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FcrChatConnectionState = void 0;
+let FcrChatConnectionState = exports.FcrChatConnectionState = /*#__PURE__*/function (FcrChatConnectionState) {
+  FcrChatConnectionState[FcrChatConnectionState["DISCONNECTED"] = 0] = "DISCONNECTED";
+  FcrChatConnectionState[FcrChatConnectionState["CONNECTION"] = 1] = "CONNECTION";
+  FcrChatConnectionState[FcrChatConnectionState["CONNECTED"] = 2] = "CONNECTED";
+  return FcrChatConnectionState;
+}({});

package/lib/engine/index.d.ts

@@ -0,0 +1,86 @@
+import { FcrCoreEngineConfig, FcrCoreEngineObserver } from '../type';
+import { FcrMainRoomControl, FcrRoomJoinOptions, FcrWaitingRoomControl } from '../room-control/type';
+import { FcrPeerSessionControl } from '../peer-session/type';
+import { FcrMonitorControl } from '../monitor-control/type';
+import { FcrDesktopMediaControl, FcrMobileMediaControl } from '../media-control/type';
+export declare class FcrCoreEngine {
+    constructor(config: FcrCoreEngineConfig);
+    /**
+     * Releases the engine and all its resources.
+     */
+    release(): void;
+    /**
+     * Logins to the RTE service.
+     */
+    login(): Promise<void>;
+    /**
+     * Logouts from the RTE service.
+     */
+    logout(): Promise<void>;
+    /**
+     * Gets the version of the SDK.
+     * @returns The version of the SDK.
+     */
+    getVersion(): string;
+    /**
+     * Creates a room control.
+     * @param roomId
+     * @returns The room control.
+     */
+    createMainRoomControl(roomId: string): FcrMainRoomControl;
+    /**
+     * Creates a waiting room control.
+     * @param roomId
+     * @returns The room control.
+     */
+    createWaitingRoomControl(roomId: string): FcrWaitingRoomControl;
+    /**
+     * Creates a main room control or a waiting room control.
+     * @param roomId
+     * @returns The room control.
+     */
+    createRoomControlAndJoin: (roomId: string, options: FcrRoomJoinOptions) => Promise<FcrMainRoomControl | FcrWaitingRoomControl>;
+    /**
+     * Gets the media control.
+     * @returns The media control.
+     */
+    getDesktopMediaControl(): FcrDesktopMediaControl;
+    /**
+     * Gets the mobile media control.
+     * @returns The mobile media control.
+     */
+    getMobileMediaControl(): FcrMobileMediaControl;
+    /**
+     * Gets the monitor control.
+     * @returns The monitor control.
+     */
+    getMonitorControl(): FcrMonitorControl;
+    /**
+     * Gets the peer session control.
+     * @returns The peer session control.
+     */
+    getPeerSessionControl(): FcrPeerSessionControl;
+    /**
+     * Sends a peer message.
+     * @param payload
+     * @param guaranteedDelivery
+     * @param receiverId
+     */
+    sendPeerMessage(payload: Record<string, unknown>, guaranteedDelivery: boolean, receiverId: string): Promise<void>;
+    /**
+     * Sets the parameters.
+     * @param parameters
+     */
+    setParameters(parameters: Record<string, unknown>): void;
+    /**
+     * Adds an observer.
+     * @param observer
+     */
+    addObserver(observer: FcrCoreEngineObserver): void;
+    /**
+     * Removes an observer.
+     * @param observer
+     */
+    removeObserver(observer: FcrCoreEngineObserver): void;
+    private _addRteEngineObserver;
+}