Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(Teams): backport support for teams (#3357)
* feat(Teams): backport support for teams PR #3350 Commit: a22aabf * fix(TeamMember): fix name of client property * refactor(OAuth2Application): make team nullable instead of optional * typings(OAuth2Application): make team nullable instable of optional * docs(OAuth2Application): deprecate and add an info to team property
- Loading branch information
Showing
5 changed files
with
231 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
const Snowflake = require('../util/Snowflake'); | ||
const Collection = require('../util/Collection'); | ||
const TeamMember = require('./TeamMember'); | ||
const Constants = require('../util/Constants'); | ||
|
||
/** | ||
* Represents a Client OAuth2 Application Team. | ||
*/ | ||
class Team { | ||
constructor(client, data) { | ||
/** | ||
* The client that instantiated the team | ||
* @name Team#client | ||
* @type {Client} | ||
* @readonly | ||
*/ | ||
Object.defineProperty(this, 'client', { value: client }); | ||
|
||
this._patch(data); | ||
} | ||
|
||
_patch(data) { | ||
/** | ||
* The ID of the Team | ||
* @type {Snowflake} | ||
*/ | ||
this.id = data.id; | ||
|
||
/** | ||
* The name of the Team | ||
* @type {string} | ||
*/ | ||
this.name = data.name; | ||
|
||
/** | ||
* The Team's icon hash | ||
* @type {?string} | ||
*/ | ||
this.icon = data.icon || null; | ||
|
||
/** | ||
* The Team's owner id | ||
* @type {?string} | ||
*/ | ||
this.ownerID = data.owner_user_id || null; | ||
|
||
/** | ||
* The Team's members | ||
* @type {Collection<Snowflake, TeamMember>} | ||
*/ | ||
this.members = new Collection(); | ||
|
||
for (const memberData of data.members) { | ||
const member = new TeamMember(this.client, this, memberData); | ||
this.members.set(member.id, member); | ||
} | ||
} | ||
|
||
/** | ||
* The owner of the team | ||
* @type {?TeamMember} | ||
* @readonly | ||
*/ | ||
get owner() { | ||
return this.members.get(this.ownerID) || null; | ||
} | ||
|
||
/** | ||
* The timestamp the team was created at | ||
* @type {number} | ||
* @readonly | ||
*/ | ||
get createdTimestamp() { | ||
return Snowflake.deconstruct(this.id).timestamp; | ||
} | ||
|
||
/** | ||
* The time the team was created at | ||
* @type {Date} | ||
* @readonly | ||
*/ | ||
get createdAt() { | ||
return new Date(this.createdTimestamp); | ||
} | ||
|
||
/** | ||
* A link to the teams's icon. | ||
* @type {?string} | ||
* @readonly | ||
*/ | ||
get iconURL() { | ||
if (!this.icon) return null; | ||
return Constants.Endpoints.CDN(this.client.options.http.cdn).TeamIcon(this.id, this.icon); | ||
} | ||
|
||
/** | ||
* When concatenated with a string, this automatically returns the Team's name instead of the | ||
* Team object. | ||
* @returns {string} | ||
* @example | ||
* // Logs: Team name: My Team | ||
* console.log(`Team name: ${team}`); | ||
*/ | ||
toString() { | ||
return this.name; | ||
} | ||
} | ||
|
||
module.exports = Team; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
const { MembershipStates } = require('../util/Constants'); | ||
|
||
/** | ||
* Represents a Client OAuth2 Application Team Member. | ||
*/ | ||
class TeamMember { | ||
constructor(client, team, data) { | ||
/** | ||
* The client that instantiated the Team Member | ||
* @name TeamMember#client | ||
* @type {Client} | ||
* @readonly | ||
*/ | ||
Object.defineProperty(this, 'client', { value: client }); | ||
|
||
/** | ||
* The Team this member is part of | ||
* @type {Team} | ||
*/ | ||
this.team = team; | ||
|
||
this._patch(data); | ||
} | ||
|
||
_patch(data) { | ||
/** | ||
* The permissions this Team Member has with regard to the team | ||
* @type {string[]} | ||
*/ | ||
this.permissions = data.permissions; | ||
|
||
/** | ||
* The membership state this Team Member has with regard to the team | ||
* @type {MembershipStates} | ||
*/ | ||
this.membershipState = MembershipStates[data.membership_state]; | ||
|
||
/** | ||
* The user for this Team Member | ||
* @type {User} | ||
*/ | ||
this.user = this.client.dataManager.newUser(data.user); | ||
} | ||
|
||
/** | ||
* The ID of the Team Member | ||
* @type {Snowflake} | ||
* @readonly | ||
*/ | ||
get id() { | ||
return this.user.id; | ||
} | ||
|
||
/** | ||
* When concatenated with a string, this automatically returns the team members's mention instead of the | ||
* TeamMember object. | ||
* @returns {string} | ||
* @example | ||
* // Logs: Team Member's mention: <@123456789> | ||
* console.log(`Team Member's mention: ${teamMember}`); | ||
*/ | ||
toString() { | ||
return this.user.toString(); | ||
} | ||
} | ||
|
||
module.exports = TeamMember; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters