fcr-core 3.4.0

package/lib/plugins/chatroom.js

@@ -0,0 +1,331 @@
+"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.FcrChatRoomControlImpl = void 0;
+require("core-js/modules/es.error.cause.js");
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _imports = require("../imports");
+var _observable = require("agora-foundation/lib/utilities/observable");
+var _easemobWebsdk = _interopRequireDefault(require("easemob-websdk"));
+var _user = require("../utilities/user");
+var _error = require("../utilities/error");
+var _type = require("../room-control/chatroom-control/type");
+var _type2 = require("../chat-connection/type");
+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; }
+/**
+ * @internal
+ */
+class FcrChatRoomControlImpl {
+  _setConnectionState(state) {
+    this._connectionState = state;
+    this._observable.notifyObservers('onConnectionStateUpdated', this._scene.sceneId, state);
+  }
+  get conn() {
+    if (!this._chatConnection.getConnectionInstance()) {
+      throw (0, _error.generateFcrCoreClientError)(_error.FcrErrorModuleCode.ROOM_CHATROOM, _error.FcrErrorCode.UNDEFINED_ERROR, 'chat room connection not initialized, please get chat room token first', new Error('chat room connection not initialized, please get chat room token first'));
+    }
+    return this._chatConnection.getConnectionInstance();
+  }
+  get chatRoomId() {
+    return this._scene.getScenePropertiesByKeyPath('widgets.easemobIM.extra.chatRoomId');
+  }
+  constructor(_scene, _chatConnection) {
+    (0, _defineProperty2.default)(this, "logger", (0, _imports.getLogger)());
+    (0, _defineProperty2.default)(this, "_observable", new _observable.AgoraObservable());
+    (0, _defineProperty2.default)(this, "_connectionState", _type.FcrChatRoomConnectionState.Disconnected);
+    (0, _defineProperty2.default)(this, "_chatConnectionObserver", {
+      onConnectionStateUpdated: async state => {
+        // im reconnect
+        if (state === _type2.FcrChatConnectionState.DISCONNECTED && this.getConnectionState() === _type.FcrChatRoomConnectionState.Connected) {
+          this._setConnectionState(_type.FcrChatRoomConnectionState.Disconnected);
+        } else if (state === _type2.FcrChatConnectionState.CONNECTED && this.getConnectionState() !== _type.FcrChatRoomConnectionState.Connected) {
+          this._removeEventListener();
+          this._addEventListener();
+          await this._joinChatRoom(state);
+        }
+      },
+      onConnectionLoginSuccess: () => {
+        this._addEventListener();
+      }
+    });
+    (0, _defineProperty2.default)(this, "_joinChatRoom", async state => {
+      if (state === _type2.FcrChatConnectionState.CONNECTED && this.getConnectionState() === _type.FcrChatRoomConnectionState.Disconnected && this.chatRoomId) {
+        this._setConnectionState(_type.FcrChatRoomConnectionState.Connecting);
+        await this.conn.joinChatRoom({
+          roomId: this.chatRoomId
+        });
+        this._setConnectionState(_type.FcrChatRoomConnectionState.Connected);
+      }
+    });
+    (0, _defineProperty2.default)(this, "_convertAgoraChatMessageToFcrChatRoomReceiveMessage", msg => {
+      // TODO: 没看到有 contentsType 字段
+      //@ts-ignore
+      switch (msg.type) {
+        case 'txt':
+          {
+            const message = {
+              id: msg.id,
+              //@ts-ignore
+              from: msg.ext.sender,
+              type: _type.FcrChatRoomMessageType.Text,
+              //@ts-ignore
+              timestamp: parseInt(msg.time),
+              //@ts-ignore
+              content: msg.msg,
+              //@ts-ignore
+              isPrivate: msg.ext.isPrivate
+            };
+            return message;
+          }
+        // TODO: 3.x
+        // case 'IMAGE': {
+        //   const message: FcrChatRoomReceiveImageMessage = {
+        //     id: msg.id,
+        //     //@ts-ignore
+        //     from: msg.ext.sender,
+        //     type: FcrChatRoomMessageType.Image,
+        //     //@ts-ignore
+        //     timestamp: parseInt(msg.time),
+        //     //@ts-ignore
+        //     file: msg.url,
+        //     //@ts-ignore
+        //     isPrivate: msg.ext.isPrivate,
+        //   };
+        //   return message;
+        // }
+      }
+      throw (0, _error.generateFcrCoreClientError)(_error.FcrErrorModuleCode.ROOM_CHATROOM, _error.FcrErrorCode.UNDEFINED_ERROR, 'unknown remote message type', new Error('unknown remote message type'));
+    });
+    (0, _defineProperty2.default)(this, "_convertFcrChatRoomSendBaseMessageToAgoraChatMessage", msg => {
+      var _message$to;
+      switch (msg.type) {
+        case _type.FcrChatRoomMessageType.Text:
+          const message = msg;
+          const isPrivate = !!((_message$to = message.to) !== null && _message$to !== void 0 && _message$to.length);
+          const localUserInfo = this._scene.getUser(this._scene.getLocalUser().getLocalUserId());
+          return _easemobWebsdk.default.message.create({
+            to: this.chatRoomId,
+            msg: message.content,
+            type: 'txt',
+            chatType: 'chatRoom',
+            ext: {
+              sender: (0, _user.convertRteUserToFcrUser)(localUserInfo),
+              roomUuid: this._scene.sceneId,
+              isPrivate
+            },
+            receiverList: message.to
+          });
+      }
+      throw (0, _error.generateFcrCoreClientError)(_error.FcrErrorModuleCode.ROOM_CHATROOM, _error.FcrErrorCode.UNDEFINED_ERROR, 'unknown local message type', new Error('unknown local message type'));
+    });
+    this._scene = _scene;
+    this._chatConnection = _chatConnection;
+    this._chatConnection.addObserver(this._chatConnectionObserver);
+    if (this._chatConnection.getConnectionInstance()) {
+      this._addEventListener();
+    }
+  }
+  async join() {
+    await this._joinChatRoom(this._chatConnection.getConnectionState());
+  }
+  _removeEventListener() {
+    this.conn.removeEventHandler("chatroom".concat(this._scene.sceneId));
+  }
+  _addEventListener() {
+    this._removeEventListener();
+    this.conn.addEventHandler("chatroom".concat(this._scene.sceneId), {
+      onTextMessage: msg => {
+        if (msg.to !== this.chatRoomId) {
+          return;
+        }
+        const message = this._convertAgoraChatMessageToFcrChatRoomReceiveMessage(msg);
+        this._observable.notifyObservers('onTextMessageReceived', this._scene.sceneId, message);
+      }
+    });
+    // TODO: 3.x
+    // this.conn.onPictureMessage = (msg) => {
+    //   if (msg.to !== this.initConfig.chatRoomId) {
+    //     return;
+    //   }
+    //   const message: FcrChatRoomReceiveImageMessage =
+    //     this._convertAgoraChatMessageToFcrChatRoomReceiveMessage(
+    //       msg,
+    //     ) as FcrChatRoomReceiveImageMessage;
+    //   this._observable.notifyObservers('onImageMessageReceived', this._scene.sceneId, message);
+    // };
+
+    // TODO: 3.x
+    // this.conn.onCmdMessage = (msg) => {
+    //   if (msg.to !== this.initConfig.chatRoomId) {
+    //     return;
+    //   }
+    //   const message: FcrChatRoomReceiveCustomMessage =
+    //     this._convertAgoraChatMessageToFcrChatRoomReceiveMessage(msg);
+    //   this._observable.notifyObservers('onCustomMessageReceived', this._scene.sceneId, message);
+    // };
+
+    // TODO: 3.x
+    // this.conn.onChatroomEvent = (eventData: EasemobChat.ChatroomEvent) => {
+    //   if (eventData.operation === 'updateAnnouncement') {
+    //     this._observable.notifyObservers(
+    //       'onAnnouncementUpdated',
+    //       this._scene.sceneId,
+    //       // TODO: 应该用什么字段传递?
+    //       (eventData.attributes as { [key: string]: string })?.announcement,
+    //     );
+    //   } else if (eventData.operation === 'deleteAnnouncement') {
+    //     this._observable.notifyObservers('onAnnouncementDeleted', this._scene.sceneId);
+    //   }
+    // };
+  }
+  getConnectionState() {
+    return this._connectionState;
+  }
+  async sendMessage(message) {
+    var _message$to2;
+    const msg = this._convertFcrChatRoomSendBaseMessageToAgoraChatMessage(message);
+    await this.conn.send(msg);
+    const localUserInfo = this._scene.getUser(this._scene.getLocalUser().getLocalUserId());
+    const res = _objectSpread(_objectSpread({}, message.type === _type.FcrChatRoomMessageType.Text ? {
+      content: message.content
+    } : {
+      file: message.file
+    }), {}, {
+      from: (0, _user.convertRteUserToFcrUser)(localUserInfo),
+      id: msg.id,
+      type: _type.FcrChatRoomMessageType.Text,
+      properties: message.properties,
+      timestamp: Date.now(),
+      isPrivate: !!((_message$to2 = message.to) !== null && _message$to2 !== void 0 && _message$to2.length)
+    });
+    return res;
+  }
+  addObserver(observer) {
+    this._observable.addObserver(observer);
+  }
+  removeObserver(observer) {
+    this._observable.removeObserver(observer);
+  }
+  async leave() {
+    await new Promise(async (resolve, reject) => {
+      this._removeEventListener();
+      try {
+        await this.conn.leaveChatRoom({
+          roomId: this.chatRoomId,
+          success: () => {
+            resolve(undefined);
+          },
+          error: e => {
+            reject((0, _error.generateFcrCoreClientError)(_error.FcrErrorModuleCode.ROOM_CHATROOM, _error.FcrErrorCode.UNDEFINED_ERROR, 'leave chat room failed', e));
+          }
+        });
+      } catch (e) {
+        resolve(undefined);
+      }
+    });
+  }
+
+  // TODO: 3.x
+  // /**
+  //  *
+  //  * @param pageSize max 50
+  //  * @param startedMessageId
+  //  * @returns
+  //  */
+  // async getHistoryMessageList(
+  //   pageSize: number,
+  //   startedMessageId: string,
+  // ): Promise<Array<FcrChatRoomReceiveBaseMessage>> {
+  //   if (pageSize > 50) {
+  //     throw generateFcrCoreClientError(
+  //       FcrErrorModuleCode.ROOM_CHATROOM,
+  //       FcrErrorCode.UNDEFINED_ERROR,
+  //       'pageSize should be less than 50',
+  //       new Error('pageSize should be less than 50'),
+  //     );
+  //   }
+
+  //   const assembleRet = await this.conn.fetchHistoryMessages({
+  //     queue: this.initConfig.chatRoomId,
+  //     isGroup: true,
+  //     count: pageSize,
+  //     start: startedMessageId,
+  //     fail(error) {
+  //       throw generateFcrCoreClientError(
+  //         FcrErrorModuleCode.ROOM_CHATROOM,
+  //         FcrErrorCode.UNDEFINED_ERROR,
+  //         error.message,
+  //         new Error('get history message list failed'),
+  //       );
+  //     },
+  //   });
+
+  //   const ret: FcrChatRoomReceiveBaseMessage[] = assembleRet.map((msgBody) => {
+  //     return this._convertAgoraChatMessageToFcrChatRoomReceiveMessage(msgBody);
+  //   });
+  //   return ret;
+  // }
+
+  // TODO: 3.x
+  // async getAnnouncement(): Promise<string> {
+  //   const announcement = await this.conn.fetchChatRoomAnnouncement({
+  //     roomId: this.initConfig.chatRoomId,
+  //     error: (e) => {
+  //       throw generateFcrCoreClientError(
+  //         FcrErrorModuleCode.ROOM_CHATROOM,
+  //         FcrErrorCode.UNDEFINED_ERROR,
+  //         e.message,
+  //         new Error('get announcement failed'),
+  //       );
+  //     },
+  //   });
+
+  //   return announcement.data?.announcement || '';
+  // }
+
+  // TODO: 3.x
+  // async setAnnouncement(announcement: string) {
+  //   await this.conn.updateChatRoomAnnouncement({
+  //     roomId: this.initConfig.chatRoomId,
+  //     announcement,
+  //     success: (_) => {},
+  //     error: (e) => {
+  //       throw generateFcrCoreClientError(
+  //         FcrErrorModuleCode.ROOM_CHATROOM,
+  //         FcrErrorCode.UNDEFINED_ERROR,
+  //         e.message,
+  //         new Error('set announcement failed'),
+  //       );
+  //     },
+  //   });
+  // }
+
+  // TODO: 3.x
+  // async deleteAnnouncement() {
+  //   await this.conn.updateChatRoomAnnouncement({
+  //     roomId: this.initConfig.chatRoomId,
+  //     announcement: '',
+  //     success: (_) => {},
+  //     error: (e) => {
+  //       const { message } = e;
+  //       throw generateFcrCoreClientError(
+  //         FcrErrorModuleCode.ROOM_CHATROOM,
+  //         FcrErrorCode.UNDEFINED_ERROR,
+  //         message,
+  //         new Error('delete announcement failed'),
+  //       );
+  //     },
+  //   });
+  // }
+}
+exports.FcrChatRoomControlImpl = FcrChatRoomControlImpl;

package/lib/plugins/electron-rtc-plugin.d.ts

@@ -0,0 +1 @@
+export { default as ElectronRtcPlugin } from 'agora-rte-sdk/lib/plugin/rtc/electron';

package/lib/plugins/electron-rtc-plugin.js

@@ -0,0 +1,13 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "ElectronRtcPlugin", {
+  enumerable: true,
+  get: function () {
+    return _electron.default;
+  }
+});
+var _electron = _interopRequireDefault(require("agora-rte-sdk/lib/plugin/rtc/electron"));

package/lib/plugins/rtm-plugin.d.ts

@@ -0,0 +1 @@
+export { default as RtmPlugin } from 'agora-rte-sdk/lib/plugin/rtm';

package/lib/plugins/rtm-plugin.js

@@ -0,0 +1,13 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "RtmPlugin", {
+  enumerable: true,
+  get: function () {
+    return _rtm.default;
+  }
+});
+var _rtm = _interopRequireDefault(require("agora-rte-sdk/lib/plugin/rtm"));

package/lib/plugins/web-rtc-plugin.d.ts

@@ -0,0 +1 @@
+export { default as WebRtcPlugin } from 'agora-rte-sdk/lib/plugin/rtc/web';

package/lib/plugins/web-rtc-plugin.js

@@ -0,0 +1,13 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "WebRtcPlugin", {
+  enumerable: true,
+  get: function () {
+    return _web.default;
+  }
+});
+var _web = _interopRequireDefault(require("agora-rte-sdk/lib/plugin/rtc/web"));

package/lib/room-control/chatroom-control/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/room-control/chatroom-control/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/room-control/chatroom-control/index.d.ts

@@ -0,0 +1 @@
+export {};