Support $raw method to allow access to response headers

[neet]

Closes #684

---

• Handle paginators

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/neet/masto.js/masto@1352

commit: d343d06

[github-actions]

size-limit report 📦

Path	Size
rest	3.86 KB (+0.36% 🔺)
streaming	3.87 KB (+0.72% 🔺)
oauth	3.85 KB (+0.28% 🔺)

[Copilot]

Pull Request Overview

This PR refactors API method definitions to use a new Endpoint type utility instead of explicit method signatures. The change standardizes how API endpoints are typed across the accounts resource by introducing a generic type that handles optional parameters more elegantly and adds experimental $raw method support.

Key Changes

• Introduced a new Endpoint<Params, Meta, Response> utility type that provides both standard and raw response methods
• Converted all method signatures in accounts.ts to use the Endpoint type
• Added JSDoc comments and fixed indentation for some existing documentation

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
src/mastodon/endpoint.ts	New file defining the Endpoint utility type with conditional typing for optional vs required parameters
src/mastodon/rest/v1/accounts.ts	Refactored all method signatures to use the new Endpoint type instead of explicit function signatures

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Using any defeats TypeScript's type safety. Consider using unknown instead, or if you need any indexable object, use [key: string]: unknown.

Suggested change

	[key in string]?: any;
	[key in string]?: unknown;

[Copilot]

The FollowAccountParams interface contains only optional properties, which should make params optional in the resulting Endpoint signature. However, the Endpoint type's conditional logic requires Params extends OptionalRecord | undefined to make params optional. Since FollowAccountParams is not explicitly undefined, params will be required even though all properties are optional. Consider using Endpoint<FollowAccountParams | undefined, ...> or updating the Endpoint type to better handle interfaces with all-optional properties.

[Copilot]

Same issue as follow: FollowAccountParams has all optional properties but will result in required params parameter. The original signature had params?: making it optional. Consider using Endpoint<FollowAccountParams | undefined, ...> to maintain the original API behavior.

Suggested change

	unfollow: Endpoint<FollowAccountParams, HttpMetaParams<"json">, Relationship>;
	unfollow: Endpoint<FollowAccountParams | undefined, HttpMetaParams<"json">, Relationship>;

[Copilot]

The MuteAccountParams interface contains only optional properties, but will result in a required params parameter. The original signature had params?: making it optional. Consider using Endpoint<MuteAccountParams | undefined, ...> to maintain backward compatibility.

Suggested change

	mute: Endpoint<MuteAccountParams, HttpMetaParams<"json">, Relationship>;
	mute: Endpoint<MuteAccountParams | undefined, HttpMetaParams<"json">, Relationship>;