init

node_modules/matrix-js-sdk/lib/models/user.js

@@ -0,0 +1,223 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+/*
+Copyright 2015 - 2021 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { TypedEventEmitter } from "./typed-event-emitter.js";
+export let UserEvent = /*#__PURE__*/function (UserEvent) {
+  UserEvent["DisplayName"] = "User.displayName";
+  UserEvent["AvatarUrl"] = "User.avatarUrl";
+  UserEvent["Presence"] = "User.presence";
+  UserEvent["CurrentlyActive"] = "User.currentlyActive";
+  UserEvent["LastPresenceTs"] = "User.lastPresenceTs";
+  return UserEvent;
+}({});
+
+/**
+ * An object of extended profile attributes for a user as it arrives down the sync stream.
+ */
+
+export class User extends TypedEventEmitter {
+  /**
+   * Construct a new User. A User must have an ID and can optionally have extra information associated with it.
+   * @param userId - Required. The ID of this user.
+   * @deprecated use `User.createUser`
+   */
+  constructor(userId) {
+    super();
+    _defineProperty(this, "modified", -1);
+    /**
+     * The 'displayname' of the user if known.
+     * @privateRemarks
+     * Should be read-only
+     */
+    _defineProperty(this, "displayName", void 0);
+    _defineProperty(this, "rawDisplayName", void 0);
+    /**
+     * The 'avatar_url' of the user if known.
+     * @privateRemarks
+     * Should be read-only
+     */
+    _defineProperty(this, "avatarUrl", void 0);
+    /**
+     * The presence status message if known.
+     * @privateRemarks
+     * Should be read-only
+     */
+    _defineProperty(this, "presenceStatusMsg", void 0);
+    /**
+     * The presence enum if known.
+     * @privateRemarks
+     * Should be read-only
+     */
+    _defineProperty(this, "presence", "offline");
+    /**
+     * Timestamp (ms since the epoch) for when we last received presence data for this user.
+     * We can subtract lastActiveAgo from this to approximate an absolute value for when a user was last active.
+     * @privateRemarks
+     * Should be read-only
+     */
+    _defineProperty(this, "lastActiveAgo", 0);
+    /**
+     * The time elapsed in ms since the user interacted proactively with the server,
+     * or we saw a message from the user
+     * @privateRemarks
+     * Should be read-only
+     */
+    _defineProperty(this, "lastPresenceTs", 0);
+    /**
+     * Whether we should consider lastActiveAgo to be an approximation
+     * and that the user should be seen as active 'now'
+     * @privateRemarks
+     * Should be read-only
+     */
+    _defineProperty(this, "currentlyActive", false);
+    /**
+     * The events describing this user.
+     * @privateRemarks
+     * Should be read-only
+     */
+    _defineProperty(this, "events", {});
+    this.userId = userId;
+    this.displayName = userId;
+    this.rawDisplayName = userId;
+    this.updateModifiedTime();
+  }
+
+  /**
+   * Construct a new User whose events will also emit on MatrixClient.
+   * A User must have an ID and can optionally have extra information associated with it.
+   * @param userId - Required. The ID of this user.
+   * @param client - An instance of MatrixClient object
+   * @returns User object with reEmitter setup on client
+   */
+  static createUser(userId, client) {
+    const user = new User(userId);
+    client.reEmitter.reEmit(user, [UserEvent.AvatarUrl, UserEvent.DisplayName, UserEvent.Presence, UserEvent.CurrentlyActive, UserEvent.LastPresenceTs]);
+    return user;
+  }
+
+  /**
+   * Update this User with the given presence event. May fire "User.presence",
+   * "User.avatarUrl" and/or "User.displayName" if this event updates this user's
+   * properties.
+   * @param event - The `m.presence` event.
+   *
+   * @remarks
+   * Fires {@link UserEvent.Presence}
+   * Fires {@link UserEvent.DisplayName}
+   * Fires {@link UserEvent.AvatarUrl}
+   */
+  setPresenceEvent(event) {
+    if (event.getType() !== "m.presence") {
+      return;
+    }
+    const firstFire = this.events.presence === null;
+    this.events.presence = event;
+    const eventsToFire = [];
+    if (event.getContent().presence !== this.presence || firstFire) {
+      eventsToFire.push(UserEvent.Presence);
+    }
+    if (event.getContent().avatar_url && event.getContent().avatar_url !== this.avatarUrl) {
+      eventsToFire.push(UserEvent.AvatarUrl);
+    }
+    if (event.getContent().displayname && event.getContent().displayname !== this.displayName) {
+      eventsToFire.push(UserEvent.DisplayName);
+    }
+    if (event.getContent().currently_active !== undefined && event.getContent().currently_active !== this.currentlyActive) {
+      eventsToFire.push(UserEvent.CurrentlyActive);
+    }
+    this.presence = event.getContent().presence;
+    eventsToFire.push(UserEvent.LastPresenceTs);
+    if (event.getContent().status_msg) {
+      this.presenceStatusMsg = event.getContent().status_msg;
+    }
+    if (event.getContent().displayname) {
+      this.displayName = event.getContent().displayname;
+    }
+    if (event.getContent().avatar_url) {
+      this.avatarUrl = event.getContent().avatar_url;
+    }
+    this.lastActiveAgo = event.getContent().last_active_ago;
+    this.lastPresenceTs = Date.now();
+    this.currentlyActive = event.getContent().currently_active;
+    this.updateModifiedTime();
+    for (const eventToFire of eventsToFire) {
+      this.emit(eventToFire, event, this);
+    }
+  }
+
+  /**
+   * Manually set this user's display name. No event is emitted in response to this
+   * as there is no underlying MatrixEvent to emit with.
+   * @param name - The new display name.
+   */
+  setDisplayName(name) {
+    const oldName = this.displayName;
+    this.displayName = name;
+    if (name !== oldName) {
+      this.updateModifiedTime();
+    }
+  }
+
+  /**
+   * Manually set this user's non-disambiguated display name. No event is emitted
+   * in response to this as there is no underlying MatrixEvent to emit with.
+   * @param name - The new display name.
+   */
+  setRawDisplayName(name) {
+    this.rawDisplayName = name;
+  }
+
+  /**
+   * Manually set this user's avatar URL. No event is emitted in response to this
+   * as there is no underlying MatrixEvent to emit with.
+   * @param url - The new avatar URL.
+   */
+  setAvatarUrl(url) {
+    const oldUrl = this.avatarUrl;
+    this.avatarUrl = url;
+    if (url !== oldUrl) {
+      this.updateModifiedTime();
+    }
+  }
+
+  /**
+   * Update the last modified time to the current time.
+   */
+  updateModifiedTime() {
+    this.modified = Date.now();
+  }
+
+  /**
+   * Get the timestamp when this User was last updated. This timestamp is
+   * updated when this User receives a new Presence event which has updated a
+   * property on this object. It is updated <i>before</i> firing events.
+   * @returns The timestamp
+   */
+  getLastModifiedTime() {
+    return this.modified;
+  }
+
+  /**
+   * Get the absolute timestamp when this User was last known active on the server.
+   * It is *NOT* accurate if this.currentlyActive is true.
+   * @returns The timestamp
+   */
+  getLastActiveTs() {
+    return this.lastPresenceTs - this.lastActiveAgo;
+  }
+}
+//# sourceMappingURL=user.js.map