@unwanted/matrix-sdk-mini 34.12.0-1

package/lib/models/user.d.ts

@@ -0,0 +1,195 @@
+import { MatrixClient } from "../matrix.ts";
+import { MatrixEvent } from "./event.ts";
+import { TypedEventEmitter } from "./typed-event-emitter.ts";
+export declare enum UserEvent {
+    DisplayName = "User.displayName",
+    AvatarUrl = "User.avatarUrl",
+    Presence = "User.presence",
+    CurrentlyActive = "User.currentlyActive",
+    LastPresenceTs = "User.lastPresenceTs"
+}
+export type UserEventHandlerMap = {
+    /**
+     * Fires whenever any user's display name changes.
+     * @param event - The matrix event which caused this event to fire.
+     * @param user - The user whose User.displayName changed.
+     * @example
+     * ```
+     * matrixClient.on("User.displayName", function(event, user){
+     *   var newName = user.displayName;
+     * });
+     * ```
+     */
+    [UserEvent.DisplayName]: (event: MatrixEvent | undefined, user: User) => void;
+    /**
+     * Fires whenever any user's avatar URL changes.
+     * @param event - The matrix event which caused this event to fire.
+     * @param user - The user whose User.avatarUrl changed.
+     * @example
+     * ```
+     * matrixClient.on("User.avatarUrl", function(event, user){
+     *   var newUrl = user.avatarUrl;
+     * });
+     * ```
+     */
+    [UserEvent.AvatarUrl]: (event: MatrixEvent | undefined, user: User) => void;
+    /**
+     * Fires whenever any user's presence changes.
+     * @param event - The matrix event which caused this event to fire.
+     * @param user - The user whose User.presence changed.
+     * @example
+     * ```
+     * matrixClient.on("User.presence", function(event, user){
+     *   var newPresence = user.presence;
+     * });
+     * ```
+     */
+    [UserEvent.Presence]: (event: MatrixEvent | undefined, user: User) => void;
+    /**
+     * Fires whenever any user's currentlyActive changes.
+     * @param event - The matrix event which caused this event to fire.
+     * @param user - The user whose User.currentlyActive changed.
+     * @example
+     * ```
+     * matrixClient.on("User.currentlyActive", function(event, user){
+     *   var newCurrentlyActive = user.currentlyActive;
+     * });
+     * ```
+     */
+    [UserEvent.CurrentlyActive]: (event: MatrixEvent | undefined, user: User) => void;
+    /**
+     * Fires whenever any user's lastPresenceTs changes,
+     * ie. whenever any presence event is received for a user.
+     * @param event - The matrix event which caused this event to fire.
+     * @param user - The user whose User.lastPresenceTs changed.
+     * @example
+     * ```
+     * matrixClient.on("User.lastPresenceTs", function(event, user){
+     *   var newlastPresenceTs = user.lastPresenceTs;
+     * });
+     * ```
+     */
+    [UserEvent.LastPresenceTs]: (event: MatrixEvent | undefined, user: User) => void;
+};
+export declare class User extends TypedEventEmitter<UserEvent, UserEventHandlerMap> {
+    readonly userId: string;
+    private modified;
+    /**
+     * The 'displayname' of the user if known.
+     * @privateRemarks
+     * Should be read-only
+     */
+    displayName?: string;
+    rawDisplayName?: string;
+    /**
+     * The 'avatar_url' of the user if known.
+     * @privateRemarks
+     * Should be read-only
+     */
+    avatarUrl?: string;
+    /**
+     * The presence status message if known.
+     * @privateRemarks
+     * Should be read-only
+     */
+    presenceStatusMsg?: string;
+    /**
+     * The presence enum if known.
+     * @privateRemarks
+     * Should be read-only
+     */
+    presence: string;
+    /**
+     * 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
+     */
+    lastActiveAgo: number;
+    /**
+     * 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
+     */
+    lastPresenceTs: number;
+    /**
+     * Whether we should consider lastActiveAgo to be an approximation
+     * and that the user should be seen as active 'now'
+     * @privateRemarks
+     * Should be read-only
+     */
+    currentlyActive: boolean;
+    /**
+     * The events describing this user.
+     * @privateRemarks
+     * Should be read-only
+     */
+    events: {
+        /** The m.presence event for this user. */
+        presence?: MatrixEvent;
+        profile?: MatrixEvent;
+    };
+    /**
+     * 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: string);
+    /**
+     * 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: string, client: MatrixClient): 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: MatrixEvent): void;
+    /**
+     * 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: string): void;
+    /**
+     * 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?: string): void;
+    /**
+     * 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?: string): void;
+    /**
+     * Update the last modified time to the current time.
+     */
+    private updateModifiedTime;
+    /**
+     * 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(): number;
+    /**
+     * 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(): number;
+}
+//# sourceMappingURL=user.d.ts.map

package/lib/models/user.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../src/models/user.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D,oBAAY,SAAS;IACjB,WAAW,qBAAqB;IAChC,SAAS,mBAAmB;IAC5B,QAAQ,kBAAkB;IAC1B,eAAe,yBAAyB;IACxC,cAAc,wBAAwB;CACzC;AAED,MAAM,MAAM,mBAAmB,GAAG;IAC9B;;;;;;;;;;OAUG;IACH,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,GAAG,SAAS,EAAE,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;IAC9E;;;;;;;;;;OAUG;IACH,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,GAAG,SAAS,EAAE,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;IAC5E;;;;;;;;;;OAUG;IACH,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,GAAG,SAAS,EAAE,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;IAC3E;;;;;;;;;;OAUG;IACH,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,GAAG,SAAS,EAAE,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;IAClF;;;;;;;;;;;OAWG;IACH,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,GAAG,SAAS,EAAE,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;CACpF,CAAC;AAEF,qBAAa,IAAK,SAAQ,iBAAiB,CAAC,SAAS,EAAE,mBAAmB,CAAC;aAiEpC,MAAM,EAAE,MAAM;IAhEjD,OAAO,CAAC,QAAQ,CAAM;IAEtB;;;;OAIG;IACI,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IAC/B;;;;OAIG;IACI,SAAS,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACI,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAClC;;;;OAIG;IACI,QAAQ,SAAa;IAC5B;;;;;OAKG;IACI,aAAa,SAAK;IACzB;;;;;OAKG;IACI,cAAc,SAAK;IAC1B;;;;;OAKG;IACI,eAAe,UAAS;IAC/B;;;;OAIG;IACI,MAAM,EAAE;QACX,0CAA0C;QAC1C,QAAQ,CAAC,EAAE,WAAW,CAAC;QACvB,OAAO,CAAC,EAAE,WAAW,CAAC;KACzB,CAAM;IAEP;;;;OAIG;gBACgC,MAAM,EAAE,MAAM;IAOjD;;;;;;OAMG;WACW,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,IAAI;IAYpE;;;;;;;;;;OAUG;IACI,gBAAgB,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IA+CjD;;;;OAIG;IACI,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAQzC;;;;OAIG;IACI,iBAAiB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI;IAI7C;;;;OAIG;IACI,YAAY,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI;IAQvC;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAI1B;;;;;OAKG;IACI,mBAAmB,IAAI,MAAM;IAIpC;;;;OAIG;IACI,eAAe,IAAI,MAAM;CAGnC"}

package/lib/models/user.js

@@ -0,0 +1,218 @@
+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 var 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;
+}({});
+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();
+    this.userId = userId;
+    _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.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) {
+    var 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;
+    }
+    var firstFire = this.events.presence === null;
+    this.events.presence = event;
+    var 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 (var 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) {
+    var 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) {
+    var 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

package/lib/models/user.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.js","names":["TypedEventEmitter","UserEvent","User","constructor","userId","_defineProperty","displayName","rawDisplayName","updateModifiedTime","createUser","client","user","reEmitter","reEmit","AvatarUrl","DisplayName","Presence","CurrentlyActive","LastPresenceTs","setPresenceEvent","event","getType","firstFire","events","presence","eventsToFire","getContent","push","avatar_url","avatarUrl","displayname","currently_active","undefined","currentlyActive","status_msg","presenceStatusMsg","lastActiveAgo","last_active_ago","lastPresenceTs","Date","now","eventToFire","emit","setDisplayName","name","oldName","setRawDisplayName","setAvatarUrl","url","oldUrl","modified","getLastModifiedTime","getLastActiveTs"],"sources":["../../src/models/user.ts"],"sourcesContent":["/*\nCopyright 2015 - 2021 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport { MatrixClient } from \"../matrix.ts\";\nimport { MatrixEvent } from \"./event.ts\";\nimport { TypedEventEmitter } from \"./typed-event-emitter.ts\";\n\nexport enum UserEvent {\n    DisplayName = \"User.displayName\",\n    AvatarUrl = \"User.avatarUrl\",\n    Presence = \"User.presence\",\n    CurrentlyActive = \"User.currentlyActive\",\n    LastPresenceTs = \"User.lastPresenceTs\",\n}\n\nexport type UserEventHandlerMap = {\n    /**\n     * Fires whenever any user's display name changes.\n     * @param event - The matrix event which caused this event to fire.\n     * @param user - The user whose User.displayName changed.\n     * @example\n     * ```\n     * matrixClient.on(\"User.displayName\", function(event, user){\n     *   var newName = user.displayName;\n     * });\n     * ```\n     */\n    [UserEvent.DisplayName]: (event: MatrixEvent | undefined, user: User) => void;\n    /**\n     * Fires whenever any user's avatar URL changes.\n     * @param event - The matrix event which caused this event to fire.\n     * @param user - The user whose User.avatarUrl changed.\n     * @example\n     * ```\n     * matrixClient.on(\"User.avatarUrl\", function(event, user){\n     *   var newUrl = user.avatarUrl;\n     * });\n     * ```\n     */\n    [UserEvent.AvatarUrl]: (event: MatrixEvent | undefined, user: User) => void;\n    /**\n     * Fires whenever any user's presence changes.\n     * @param event - The matrix event which caused this event to fire.\n     * @param user - The user whose User.presence changed.\n     * @example\n     * ```\n     * matrixClient.on(\"User.presence\", function(event, user){\n     *   var newPresence = user.presence;\n     * });\n     * ```\n     */\n    [UserEvent.Presence]: (event: MatrixEvent | undefined, user: User) => void;\n    /**\n     * Fires whenever any user's currentlyActive changes.\n     * @param event - The matrix event which caused this event to fire.\n     * @param user - The user whose User.currentlyActive changed.\n     * @example\n     * ```\n     * matrixClient.on(\"User.currentlyActive\", function(event, user){\n     *   var newCurrentlyActive = user.currentlyActive;\n     * });\n     * ```\n     */\n    [UserEvent.CurrentlyActive]: (event: MatrixEvent | undefined, user: User) => void;\n    /**\n     * Fires whenever any user's lastPresenceTs changes,\n     * ie. whenever any presence event is received for a user.\n     * @param event - The matrix event which caused this event to fire.\n     * @param user - The user whose User.lastPresenceTs changed.\n     * @example\n     * ```\n     * matrixClient.on(\"User.lastPresenceTs\", function(event, user){\n     *   var newlastPresenceTs = user.lastPresenceTs;\n     * });\n     * ```\n     */\n    [UserEvent.LastPresenceTs]: (event: MatrixEvent | undefined, user: User) => void;\n};\n\nexport class User extends TypedEventEmitter<UserEvent, UserEventHandlerMap> {\n    private modified = -1;\n\n    /**\n     * The 'displayname' of the user if known.\n     * @privateRemarks\n     * Should be read-only\n     */\n    public displayName?: string;\n    public rawDisplayName?: string;\n    /**\n     * The 'avatar_url' of the user if known.\n     * @privateRemarks\n     * Should be read-only\n     */\n    public avatarUrl?: string;\n    /**\n     * The presence status message if known.\n     * @privateRemarks\n     * Should be read-only\n     */\n    public presenceStatusMsg?: string;\n    /**\n     * The presence enum if known.\n     * @privateRemarks\n     * Should be read-only\n     */\n    public presence = \"offline\";\n    /**\n     * Timestamp (ms since the epoch) for when we last received presence data for this user.\n     * We can subtract lastActiveAgo from this to approximate an absolute value for when a user was last active.\n     * @privateRemarks\n     * Should be read-only\n     */\n    public lastActiveAgo = 0;\n    /**\n     * The time elapsed in ms since the user interacted proactively with the server,\n     * or we saw a message from the user\n     * @privateRemarks\n     * Should be read-only\n     */\n    public lastPresenceTs = 0;\n    /**\n     * Whether we should consider lastActiveAgo to be an approximation\n     * and that the user should be seen as active 'now'\n     * @privateRemarks\n     * Should be read-only\n     */\n    public currentlyActive = false;\n    /**\n     * The events describing this user.\n     * @privateRemarks\n     * Should be read-only\n     */\n    public events: {\n        /** The m.presence event for this user. */\n        presence?: MatrixEvent;\n        profile?: MatrixEvent;\n    } = {};\n\n    /**\n     * Construct a new User. A User must have an ID and can optionally have extra information associated with it.\n     * @param userId - Required. The ID of this user.\n     * @deprecated use `User.createUser`\n     */\n    public constructor(public readonly userId: string) {\n        super();\n        this.displayName = userId;\n        this.rawDisplayName = userId;\n        this.updateModifiedTime();\n    }\n\n    /**\n     * Construct a new User whose events will also emit on MatrixClient.\n     * A User must have an ID and can optionally have extra information associated with it.\n     * @param userId - Required. The ID of this user.\n     * @param client - An instance of MatrixClient object\n     * @returns User object with reEmitter setup on client\n     */\n    public static createUser(userId: string, client: MatrixClient): User {\n        const user = new User(userId);\n        client.reEmitter.reEmit(user, [\n            UserEvent.AvatarUrl,\n            UserEvent.DisplayName,\n            UserEvent.Presence,\n            UserEvent.CurrentlyActive,\n            UserEvent.LastPresenceTs,\n        ]);\n        return user;\n    }\n\n    /**\n     * Update this User with the given presence event. May fire \"User.presence\",\n     * \"User.avatarUrl\" and/or \"User.displayName\" if this event updates this user's\n     * properties.\n     * @param event - The `m.presence` event.\n     *\n     * @remarks\n     * Fires {@link UserEvent.Presence}\n     * Fires {@link UserEvent.DisplayName}\n     * Fires {@link UserEvent.AvatarUrl}\n     */\n    public setPresenceEvent(event: MatrixEvent): void {\n        if (event.getType() !== \"m.presence\") {\n            return;\n        }\n        const firstFire = this.events.presence === null;\n        this.events.presence = event;\n\n        const eventsToFire: UserEvent[] = [];\n        if (event.getContent().presence !== this.presence || firstFire) {\n            eventsToFire.push(UserEvent.Presence);\n        }\n        if (event.getContent().avatar_url && event.getContent().avatar_url !== this.avatarUrl) {\n            eventsToFire.push(UserEvent.AvatarUrl);\n        }\n        if (event.getContent().displayname && event.getContent().displayname !== this.displayName) {\n            eventsToFire.push(UserEvent.DisplayName);\n        }\n        if (\n            event.getContent().currently_active !== undefined &&\n            event.getContent().currently_active !== this.currentlyActive\n        ) {\n            eventsToFire.push(UserEvent.CurrentlyActive);\n        }\n\n        this.presence = event.getContent().presence;\n        eventsToFire.push(UserEvent.LastPresenceTs);\n\n        if (event.getContent().status_msg) {\n            this.presenceStatusMsg = event.getContent().status_msg;\n        }\n        if (event.getContent().displayname) {\n            this.displayName = event.getContent().displayname;\n        }\n        if (event.getContent().avatar_url) {\n            this.avatarUrl = event.getContent().avatar_url;\n        }\n        this.lastActiveAgo = event.getContent().last_active_ago;\n        this.lastPresenceTs = Date.now();\n        this.currentlyActive = event.getContent().currently_active;\n\n        this.updateModifiedTime();\n\n        for (const eventToFire of eventsToFire) {\n            this.emit(eventToFire, event, this);\n        }\n    }\n\n    /**\n     * Manually set this user's display name. No event is emitted in response to this\n     * as there is no underlying MatrixEvent to emit with.\n     * @param name - The new display name.\n     */\n    public setDisplayName(name: string): void {\n        const oldName = this.displayName;\n        this.displayName = name;\n        if (name !== oldName) {\n            this.updateModifiedTime();\n        }\n    }\n\n    /**\n     * Manually set this user's non-disambiguated display name. No event is emitted\n     * in response to this as there is no underlying MatrixEvent to emit with.\n     * @param name - The new display name.\n     */\n    public setRawDisplayName(name?: string): void {\n        this.rawDisplayName = name;\n    }\n\n    /**\n     * Manually set this user's avatar URL. No event is emitted in response to this\n     * as there is no underlying MatrixEvent to emit with.\n     * @param url - The new avatar URL.\n     */\n    public setAvatarUrl(url?: string): void {\n        const oldUrl = this.avatarUrl;\n        this.avatarUrl = url;\n        if (url !== oldUrl) {\n            this.updateModifiedTime();\n        }\n    }\n\n    /**\n     * Update the last modified time to the current time.\n     */\n    private updateModifiedTime(): void {\n        this.modified = Date.now();\n    }\n\n    /**\n     * Get the timestamp when this User was last updated. This timestamp is\n     * updated when this User receives a new Presence event which has updated a\n     * property on this object. It is updated <i>before</i> firing events.\n     * @returns The timestamp\n     */\n    public getLastModifiedTime(): number {\n        return this.modified;\n    }\n\n    /**\n     * Get the absolute timestamp when this User was last known active on the server.\n     * It is *NOT* accurate if this.currentlyActive is true.\n     * @returns The timestamp\n     */\n    public getLastActiveTs(): number {\n        return this.lastPresenceTs - this.lastActiveAgo;\n    }\n}\n"],"mappings":";AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA,SAASA,iBAAiB,QAAQ,0BAA0B;AAE5D,WAAYC,SAAS,0BAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAAA,OAATA,SAAS;AAAA;AAwErB,OAAO,MAAMC,IAAI,SAASF,iBAAiB,CAAiC;EA4DxE;AACJ;AACA;AACA;AACA;EACWG,WAAWA,CAAiBC,MAAc,EAAE;IAC/C,KAAK,CAAC,CAAC;IAAC,KADuBA,MAAc,GAAdA,MAAc;IAAAC,eAAA,mBAhE9B,CAAC,CAAC;IAErB;AACJ;AACA;AACA;AACA;IAJIA,eAAA;IAAAA,eAAA;IAOA;AACJ;AACA;AACA;AACA;IAJIA,eAAA;IAMA;AACJ;AACA;AACA;AACA;IAJIA,eAAA;IAMA;AACJ;AACA;AACA;AACA;IAJIA,eAAA,mBAKkB,SAAS;IAC3B;AACJ;AACA;AACA;AACA;AACA;IALIA,eAAA,wBAMuB,CAAC;IACxB;AACJ;AACA;AACA;AACA;AACA;IALIA,eAAA,yBAMwB,CAAC;IACzB;AACJ;AACA;AACA;AACA;AACA;IALIA,eAAA,0BAMyB,KAAK;IAC9B;AACJ;AACA;AACA;AACA;IAJIA,eAAA,iBASI,CAAC,CAAC;IASF,IAAI,CAACC,WAAW,GAAGF,MAAM;IACzB,IAAI,CAACG,cAAc,GAAGH,MAAM;IAC5B,IAAI,CAACI,kBAAkB,CAAC,CAAC;EAC7B;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACI,OAAcC,UAAUA,CAACL,MAAc,EAAEM,MAAoB,EAAQ;IACjE,IAAMC,IAAI,GAAG,IAAIT,IAAI,CAACE,MAAM,CAAC;IAC7BM,MAAM,CAACE,SAAS,CAACC,MAAM,CAACF,IAAI,EAAE,CAC1BV,SAAS,CAACa,SAAS,EACnBb,SAAS,CAACc,WAAW,EACrBd,SAAS,CAACe,QAAQ,EAClBf,SAAS,CAACgB,eAAe,EACzBhB,SAAS,CAACiB,cAAc,CAC3B,CAAC;IACF,OAAOP,IAAI;EACf;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACWQ,gBAAgBA,CAACC,KAAkB,EAAQ;IAC9C,IAAIA,KAAK,CAACC,OAAO,CAAC,CAAC,KAAK,YAAY,EAAE;MAClC;IACJ;IACA,IAAMC,SAAS,GAAG,IAAI,CAACC,MAAM,CAACC,QAAQ,KAAK,IAAI;IAC/C,IAAI,CAACD,MAAM,CAACC,QAAQ,GAAGJ,KAAK;IAE5B,IAAMK,YAAyB,GAAG,EAAE;IACpC,IAAIL,KAAK,CAACM,UAAU,CAAC,CAAC,CAACF,QAAQ,KAAK,IAAI,CAACA,QAAQ,IAAIF,SAAS,EAAE;MAC5DG,YAAY,CAACE,IAAI,CAAC1B,SAAS,CAACe,QAAQ,CAAC;IACzC;IACA,IAAII,KAAK,CAACM,UAAU,CAAC,CAAC,CAACE,UAAU,IAAIR,KAAK,CAACM,UAAU,CAAC,CAAC,CAACE,UAAU,KAAK,IAAI,CAACC,SAAS,EAAE;MACnFJ,YAAY,CAACE,IAAI,CAAC1B,SAAS,CAACa,SAAS,CAAC;IAC1C;IACA,IAAIM,KAAK,CAACM,UAAU,CAAC,CAAC,CAACI,WAAW,IAAIV,KAAK,CAACM,UAAU,CAAC,CAAC,CAACI,WAAW,KAAK,IAAI,CAACxB,WAAW,EAAE;MACvFmB,YAAY,CAACE,IAAI,CAAC1B,SAAS,CAACc,WAAW,CAAC;IAC5C;IACA,IACIK,KAAK,CAACM,UAAU,CAAC,CAAC,CAACK,gBAAgB,KAAKC,SAAS,IACjDZ,KAAK,CAACM,UAAU,CAAC,CAAC,CAACK,gBAAgB,KAAK,IAAI,CAACE,eAAe,EAC9D;MACER,YAAY,CAACE,IAAI,CAAC1B,SAAS,CAACgB,eAAe,CAAC;IAChD;IAEA,IAAI,CAACO,QAAQ,GAAGJ,KAAK,CAACM,UAAU,CAAC,CAAC,CAACF,QAAQ;IAC3CC,YAAY,CAACE,IAAI,CAAC1B,SAAS,CAACiB,cAAc,CAAC;IAE3C,IAAIE,KAAK,CAACM,UAAU,CAAC,CAAC,CAACQ,UAAU,EAAE;MAC/B,IAAI,CAACC,iBAAiB,GAAGf,KAAK,CAACM,UAAU,CAAC,CAAC,CAACQ,UAAU;IAC1D;IACA,IAAId,KAAK,CAACM,UAAU,CAAC,CAAC,CAACI,WAAW,EAAE;MAChC,IAAI,CAACxB,WAAW,GAAGc,KAAK,CAACM,UAAU,CAAC,CAAC,CAACI,WAAW;IACrD;IACA,IAAIV,KAAK,CAACM,UAAU,CAAC,CAAC,CAACE,UAAU,EAAE;MAC/B,IAAI,CAACC,SAAS,GAAGT,KAAK,CAACM,UAAU,CAAC,CAAC,CAACE,UAAU;IAClD;IACA,IAAI,CAACQ,aAAa,GAAGhB,KAAK,CAACM,UAAU,CAAC,CAAC,CAACW,eAAe;IACvD,IAAI,CAACC,cAAc,GAAGC,IAAI,CAACC,GAAG,CAAC,CAAC;IAChC,IAAI,CAACP,eAAe,GAAGb,KAAK,CAACM,UAAU,CAAC,CAAC,CAACK,gBAAgB;IAE1D,IAAI,CAACvB,kBAAkB,CAAC,CAAC;IAEzB,KAAK,IAAMiC,WAAW,IAAIhB,YAAY,EAAE;MACpC,IAAI,CAACiB,IAAI,CAACD,WAAW,EAAErB,KAAK,EAAE,IAAI,CAAC;IACvC;EACJ;;EAEA;AACJ;AACA;AACA;AACA;EACWuB,cAAcA,CAACC,IAAY,EAAQ;IACtC,IAAMC,OAAO,GAAG,IAAI,CAACvC,WAAW;IAChC,IAAI,CAACA,WAAW,GAAGsC,IAAI;IACvB,IAAIA,IAAI,KAAKC,OAAO,EAAE;MAClB,IAAI,CAACrC,kBAAkB,CAAC,CAAC;IAC7B;EACJ;;EAEA;AACJ;AACA;AACA;AACA;EACWsC,iBAAiBA,CAACF,IAAa,EAAQ;IAC1C,IAAI,CAACrC,cAAc,GAAGqC,IAAI;EAC9B;;EAEA;AACJ;AACA;AACA;AACA;EACWG,YAAYA,CAACC,GAAY,EAAQ;IACpC,IAAMC,MAAM,GAAG,IAAI,CAACpB,SAAS;IAC7B,IAAI,CAACA,SAAS,GAAGmB,GAAG;IACpB,IAAIA,GAAG,KAAKC,MAAM,EAAE;MAChB,IAAI,CAACzC,kBAAkB,CAAC,CAAC;IAC7B;EACJ;;EAEA;AACJ;AACA;EACYA,kBAAkBA,CAAA,EAAS;IAC/B,IAAI,CAAC0C,QAAQ,GAAGX,IAAI,CAACC,GAAG,CAAC,CAAC;EAC9B;;EAEA;AACJ;AACA;AACA;AACA;AACA;EACWW,mBAAmBA,CAAA,EAAW;IACjC,OAAO,IAAI,CAACD,QAAQ;EACxB;;EAEA;AACJ;AACA;AACA;AACA;EACWE,eAAeA,CAAA,EAAW;IAC7B,OAAO,IAAI,CAACd,cAAc,GAAG,IAAI,CAACF,aAAa;EACnD;AACJ","ignoreList":[]}

package/lib/oidc/authorize.d.ts

@@ -0,0 +1,90 @@
+import { IdTokenClaims } from "oidc-client-ts";
+import { BearerTokenResponse, ValidatedIssuerMetadata } from "./validate.ts";
+export type { BearerTokenResponse };
+/**
+ * Authorization parameters which are used in the authentication request of an OIDC auth code flow.
+ *
+ * See https://openid.net/specs/openid-connect-basic-1_0.html#RequestParameters.
+ */
+export type AuthorizationParams = {
+    state: string;
+    scope: string;
+    redirectUri: string;
+    codeVerifier: string;
+    nonce: string;
+};
+/**
+ * @experimental
+ * Generate the scope used in authorization request with OIDC OP
+ * @returns scope
+ */
+export declare const generateScope: (deviceId?: string) => string;
+/**
+ * Generate authorization params to pass to {@link generateAuthorizationUrl}.
+ *
+ * Used as part of an authorization code OIDC flow: see https://openid.net/specs/openid-connect-basic-1_0.html#CodeFlow.
+ *
+ * @param redirectUri - absolute url for OP to redirect to after authorization
+ * @returns AuthorizationParams
+ */
+export declare const generateAuthorizationParams: ({ redirectUri }: {
+    redirectUri: string;
+}) => AuthorizationParams;
+/**
+ * @deprecated use generateOidcAuthorizationUrl
+ * Generate a URL to attempt authorization with the OP
+ * See https://openid.net/specs/openid-connect-basic-1_0.html#CodeRequest
+ * @param authorizationUrl - endpoint to attempt authorization with the OP
+ * @param clientId - id of this client as registered with the OP
+ * @param authorizationParams - params to be used in the url
+ * @returns a Promise with the url as a string
+ */
+export declare const generateAuthorizationUrl: (authorizationUrl: string, clientId: string, { scope, redirectUri, state, nonce, codeVerifier }: AuthorizationParams) => Promise<string>;
+/**
+ * @experimental
+ * Generate a URL to attempt authorization with the OP
+ * See https://openid.net/specs/openid-connect-basic-1_0.html#CodeRequest
+ * @param metadata - validated metadata from OP discovery
+ * @param clientId - this client's id as registered with the OP
+ * @param homeserverUrl - used to establish the session on return from the OP
+ * @param identityServerUrl - used to establish the session on return from the OP
+ * @param nonce - state
+ * @param prompt - indicates to the OP which flow the user should see - eg login or registration
+ *          See https://openid.net/specs/openid-connect-prompt-create-1_0.html#name-prompt-parameter
+ * @param urlState - value to append to the opaque state identifier to uniquely identify the callback
+ * @returns a Promise with the url as a string
+ */
+export declare const generateOidcAuthorizationUrl: ({ metadata, redirectUri, clientId, homeserverUrl, identityServerUrl, nonce, prompt, urlState, }: {
+    clientId: string;
+    metadata: ValidatedIssuerMetadata;
+    homeserverUrl: string;
+    identityServerUrl?: string;
+    redirectUri: string;
+    nonce: string;
+    prompt?: string;
+    urlState?: string;
+}) => Promise<string>;
+/**
+ * @experimental
+ * Attempt to exchange authorization code for bearer token.
+ *
+ * Takes the authorization code returned by the OpenID Provider via the authorization URL, and makes a
+ * request to the Token Endpoint, to obtain the access token, refresh token, etc.
+ *
+ * @param code - authorization code as returned by OP during authorization
+ * @param storedAuthorizationParams - stored params from start of oidc login flow
+ * @returns valid bearer token response
+ * @throws An `Error` with `message` set to an entry in {@link OidcError},
+ *      when the request fails, or the returned token response is invalid.
+ */
+export declare const completeAuthorizationCodeGrant: (code: string, state: string) => Promise<{
+    oidcClientSettings: {
+        clientId: string;
+        issuer: string;
+    };
+    tokenResponse: BearerTokenResponse;
+    homeserverUrl: string;
+    idTokenClaims: IdTokenClaims;
+    identityServerUrl?: string;
+}>;
+//# sourceMappingURL=authorize.d.ts.map

package/lib/oidc/authorize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authorize.d.ts","sourceRoot":"","sources":["../../src/oidc/authorize.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,aAAa,EAAsE,MAAM,gBAAgB,CAAC;AAKnH,OAAO,EACH,mBAAmB,EAGnB,uBAAuB,EAG1B,MAAM,eAAe,CAAC;AAKvB,YAAY,EAAE,mBAAmB,EAAE,CAAC;AAEpC;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,cAAe,MAAM,KAAG,MAGjD,CAAC;AAcF;;;;;;;GAOG;AACH,eAAO,MAAM,2BAA2B,oBAAqB;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,KAAG,mBAMrF,CAAC;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,wBAAwB,qBACf,MAAM,YACd,MAAM,sDACoC,mBAAmB,KACxE,OAAO,CAAC,MAAM,CAchB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,4BAA4B,oGAStC;IACC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,uBAAuB,CAAC;IAClC,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB,KAAG,OAAO,CAAC,MAAM,CAqBjB,CAAC;AAqBF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,8BAA8B,SACjC,MAAM,SACL,MAAM,KACd,OAAO,CAAC;IACP,kBAAkB,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IACzD,aAAa,EAAE,mBAAmB,CAAC;IACnC,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,aAAa,CAAC;IAC7B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B,CA8DA,CAAC"}