feat: @discordjs/structures #8417

ckohen · 2022-08-03T08:53:26Z

Please describe the changes this PR makes and why it should be merged:

Introduces a generic structure implementation for the main lib (and others) to build on.

⚠️ This is currently in a very early proof of concept stage published as a PR to formulate ideas and solidify the intended structure (ha) of the module.

TODO:

vercel · 2022-08-03T08:53:31Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Ignored Deployments

Name	Status	Preview	Comments	Updated (UTC)
discord-js	⬜️ Ignored (Inspect)	Visit Preview		Mar 13, 2024 0:32am
discord-js-guide	⬜️ Ignored (Inspect)	Visit Preview		Mar 13, 2024 0:32am

github-actions · 2023-09-02T11:42:14Z

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🟠 Performance	81
🟠 Accessibility	87
🟢 Best practices	100
🟠 SEO	58
🔴 PWA	33

Lighthouse ran on https://discord-js-git-fork-ckohen-feat-structures-discordjs.vercel.app/

vladfrangu · 2023-12-05T10:38:17Z

packages/structures/src/users/User.ts

+	 * The user's id
+	 */
+	public get id() {
+		return this[kData].id as 'id' extends Omitted ? never : APIUser['id'];


If we'll have to add this return type for each getter

let's add it as the return type, if we can, else keep it as a cast

Let's make a utility type for this (NeverIfOmitted<Omitted, 'id', APIUser['id']>)

Definitely utility type. I wish it didn't have to cast, but [value of thing] is not assignable to never (or undefined). Maybe we can add | never to all the types in Structure[kData] though and then it works? I'll try that, cause it'd make it a lot easier if it were a merged type.

Edit: still doesn't work :( (obviously not with never, but also not with partial)

Can't there be a get method?

get<Key extends keyof Omit<Data, Omitted>>(property: Key) { return this.data[property] as Key extends Omitted ? never : Data[Key]; }

Unfortunately not no. One, it's not as nice of an interface for consumers. Two, this doesn't allow us to convert from snake_case to camelCase.

I would love to do it this way, since it's a lot easier to maintain for us, but I think prioritizing the consumer interface is more important here. These base structures are a lot to implement at first, but shouldn't need to be touched super often once implemented.

Think I got something better than all of this thanks to starting to write the utility type, fd45e9c implements this.

packages/structures/src/users/User.ts

Syjalo · 2023-12-07T10:43:46Z

packages/structures/src/invites/Invite.ts

+	}
+
+	public override _patch(data: Partial<APIExtendedInvite>) {
+		super._patch(data, { template: Invite.DataTemplate });


Can't Structure class implement DataTemplate static property so that you don't need to pass it in super?

static properties are a bit weird, especially in TS.
TS has no idea what this.constructor is, other than a function. This is technically correct, since this.constructor refers to whatever was constructed, not the current class.

I would love to write this as an abstract static property, but typescript really doesn't do that (yet).
I'm also not sure what the behavior in js would be if it were implemented on the base class and a consumer changed the value in a subclass like Message.DataTemplate = {}, and I'm not inclined to trust that even once I test it

packages/structures/src/invites/Invite.ts

packages/structures/src/users/User.ts

refactor(Structure): patch to _patch

Co-authored-by: Synbulat Biishev <signin@syjalo.dev>

Co-authored-by: Qjuh <76154676+Qjuh@users.noreply.github.com>

codecov · 2024-02-12T15:26:29Z

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (597340f) 58.55% compared to head (c8b1f33) 58.54%.
Report is 5 commits behind head on main.

Files	Patch %	Lines
apps/website/src/util/constants.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8417      +/-   ##
==========================================
- Coverage   58.55%   58.54%   -0.01%     
==========================================
  Files         244      245       +1     
  Lines       17315    17338      +23     
  Branches     1250     1250              
==========================================
+ Hits        10138    10150      +12     
- Misses       7132     7143      +11     
  Partials       45       45

Flag	Coverage Δ
brokers	`63.49% <ø> (ø)`
builders	`95.56% <ø> (ø)`
collection	`99.32% <ø> (ø)`
formatters	`99.31% <ø> (ø)`
guide	`0.00% <ø> (ø)`
next	`∅ <ø> (∅)`
proxy	`75.00% <ø> (ø)`
rest	`92.58% <ø> (ø)`
util	`68.86% <ø> (-1.84%)`	⬇️
utilities	`100.00% <ø> (ø)`
voice	`63.64% <ø> (ø)`
website	`0.00% <0.00%> (ø)`
ws	`52.52% <ø> (+0.08%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Syjalo · 2024-02-16T07:32:40Z

packages/structures/src/channels/Channel.ts

+	 *
+	 * @privateRemarks Overriden to `true` on `TextChannelMixin`
+	 */
+	public iSTextBased() {


Suggested change

public iSTextBased() {

public isTextBased() {

github-actions bot requested review from iCrawl, kyranet, SpaceEEC and vladfrangu August 3, 2022 08:53

vercel bot temporarily deployed to Preview August 3, 2022 08:56 Inactive

ckohen force-pushed the feat/structures branch from fe017dd to 88f1614 Compare August 3, 2022 09:21

vercel bot temporarily deployed to Preview August 3, 2022 09:24 Inactive

monbrey mentioned this pull request Aug 8, 2022

Serialization (preferably through json) #8451

Closed

iCrawl added the blocked label Aug 15, 2022

ckohen force-pushed the feat/structures branch from 88f1614 to 0e58825 Compare August 29, 2022 09:55

ckohen force-pushed the feat/structures branch from 0e58825 to 3ea68e7 Compare September 7, 2022 11:07

ckohen force-pushed the feat/structures branch from 3ea68e7 to 29d67bf Compare September 2, 2023 11:41

ckohen force-pushed the feat/structures branch 2 times, most recently from e4cc324 to 98b83f1 Compare December 5, 2023 10:15

vladfrangu requested changes Dec 5, 2023

View reviewed changes

Syjalo suggested changes Dec 7, 2023

View reviewed changes

Qjuh reviewed Dec 7, 2023

View reviewed changes

packages/structures/src/users/User.ts Outdated Show resolved Hide resolved

ckohen force-pushed the feat/structures branch 2 times, most recently from 6a953a7 to 1e9cf03 Compare February 8, 2024 05:55

ckohen and others added 9 commits February 10, 2024 05:52

chore: init /structures

d3f0dc6

feat: base structure

a208316

feat: initial structures design attempt

b800336

refactor(Structure): use unknown to store in kData

b5d3854

feat(Structure): add Invite

cd20898

refactor(Structure): patch to _patch

refactor: symbol names and override location

3a759e1

fix: don't possibly return 0 if discord borks

964ca69

Co-authored-by: Synbulat Biishev <signin@syjalo.dev>

refactor: use getter value instead of api

ba37cfe

Co-authored-by: Synbulat Biishev <signin@syjalo.dev>

refactor: cache createdTimestamp value

06cfb1d

Co-authored-by: Qjuh <76154676+Qjuh@users.noreply.github.com>

docs: better docs for what's done so far

37ac617

ckohen force-pushed the feat/structures branch from 1e9cf03 to 37ac617 Compare February 10, 2024 13:52

feat: add Mixin

7d8827e

github-actions bot added the apps:website label Feb 12, 2024

vercel bot deployed to Preview – discord-js February 12, 2024 15:14 View deployment

ckohen added 3 commits February 15, 2024 01:13

refactor(User): remove bitfield getters and add displayName

bd66168

feat(structures): add Connection

78ae22d

feat(structures): add Channel base

c8b1f33

Syjalo suggested changes Feb 16, 2024

View reviewed changes

refactor(Mixin): trace prototype chain, allow construction

9620153

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: @discordjs/structures #8417

feat: @discordjs/structures #8417

ckohen commented Aug 3, 2022 •

edited

Loading

vercel bot commented Aug 3, 2022 •

edited

Loading

github-actions bot commented Sep 2, 2023 •

edited

Loading

vladfrangu Dec 5, 2023

ckohen Dec 5, 2023 •

edited

Loading

Syjalo Dec 5, 2023

ckohen Dec 6, 2023

ckohen Dec 6, 2023

Syjalo Dec 7, 2023

ckohen Dec 8, 2023

codecov bot commented Feb 12, 2024 •

edited

Loading

Syjalo Feb 16, 2024

feat: @discordjs/structures #8417

Are you sure you want to change the base?

feat: @discordjs/structures #8417

Conversation

ckohen commented Aug 3, 2022 • edited Loading

vercel bot commented Aug 3, 2022 • edited Loading

github-actions bot commented Sep 2, 2023 • edited Loading

vladfrangu Dec 5, 2023

Choose a reason for hiding this comment

ckohen Dec 5, 2023 • edited Loading

Choose a reason for hiding this comment

Syjalo Dec 5, 2023

Choose a reason for hiding this comment

ckohen Dec 6, 2023

Choose a reason for hiding this comment

ckohen Dec 6, 2023

Choose a reason for hiding this comment

Syjalo Dec 7, 2023

Choose a reason for hiding this comment

ckohen Dec 8, 2023

Choose a reason for hiding this comment

codecov bot commented Feb 12, 2024 • edited Loading

Codecov Report

Syjalo Feb 16, 2024

Choose a reason for hiding this comment

ckohen commented Aug 3, 2022 •

edited

Loading

vercel bot commented Aug 3, 2022 •

edited

Loading

github-actions bot commented Sep 2, 2023 •

edited

Loading

ckohen Dec 5, 2023 •

edited

Loading

codecov bot commented Feb 12, 2024 •

edited

Loading