74 lines
2.2 KiB
TypeScript
74 lines
2.2 KiB
TypeScript
|
/*
|
||
|
|
Copyright 2020 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 {Room} from "matrix-js-sdk/src/models/room";
|
||
|
|
import {Event} from "matrix-js-sdk/src/models/event";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Approximation of a membership status for a given room.
|
||
|
|
*/
|
||
|
|
export enum EffectiveMembership {
|
||
|
|
/**
|
||
|
|
* The user is effectively joined to the room. For example, actually joined
|
||
|
|
* or knocking on the room (when that becomes possible).
|
||
|
|
*/
|
||
|
|
Join = "JOIN",
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The user is effectively invited to the room. Currently this is a direct map
|
||
|
|
* to the invite membership as no other membership states are effectively
|
||
|
|
* invites.
|
||
|
|
*/
|
||
|
|
Invite = "INVITE",
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The user is effectively no longer in the room. For example, kicked,
|
||
|
|
* banned, or voluntarily left.
|
||
|
|
*/
|
||
|
|
Leave = "LEAVE",
|
||
|
|
}
|
||
|
|
|
||
|
|
export interface MembershipSplit {
|
||
|
|
// @ts-ignore - TS wants this to be a string key, but we know better.
|
||
|
|
[state: EffectiveMembership]: Room[];
|
||
|
|
}
|
||
|
|
|
||
|
|
export function splitRoomsByMembership(rooms: Room[]): MembershipSplit {
|
||
|
|
const split: MembershipSplit = {
|
||
|
|
[EffectiveMembership.Invite]: [],
|
||
|
|
[EffectiveMembership.Join]: [],
|
||
|
|
[EffectiveMembership.Leave]: [],
|
||
|
|
};
|
||
|
|
|
||
|
|
for (const room of rooms) {
|
||
|
|
split[getEffectiveMembership(room.getMyMembership())].push(room);
|
||
|
|
}
|
||
|
|
|
||
|
|
return split;
|
||
|
|
}
|
||
|
|
|
||
|
|
export function getEffectiveMembership(membership: string): EffectiveMembership {
|
||
|
|
if (membership === 'invite') {
|
||
|
|
return EffectiveMembership.Invite;
|
||
|
|
} else if (membership === 'join') {
|
||
|
|
// TODO: Do the same for knock? Update docs as needed in the enum.
|
||
|
|
return EffectiveMembership.Join;
|
||
|
|
} else {
|
||
|
|
// Probably a leave, kick, or ban
|
||
|
|
return EffectiveMembership.Leave;
|
||
|
|
}
|
||
|
|
}
|