snowtransfer 0.17.7 → 0.18.0

package/CHANGELOG.md

@@ -0,0 +1,31 @@
+# 0.18.0
+First entry in this changelog. This is a major one - possibly the biggest one save for the js -> ts rewrite. We'll start with the most interesting/impactful.
+
+- Consistency changes across the board. This includes method names, code formatting, etc. (I finally updated eslint to v10)
+	- This is quite a few breaking changes and makes up a good chunk of this update. The original method names didn't get a redirect to the new ones. Sorry in advance for the migration struggle.
+	- I had to struggle migrating Discord.js a few times, don't think this library is safe from the same struggles >:D jk. I think this will be the only time this kinda thing happens.
+	- PATCH methods have been changed from a mix of update/edit/??? prefixes to just edit* preferably. Some methods are special snowflakes.
+	- DELETE methods have been changed to prefix with delete*
+	- Bulk methods like channel bulk delete messages was simplified to deleteMessages. There were more though.
+	- SkuMethods#getSkus was SkuMethods#GetSkus (PascalCase instead of camelCase like literally every other method)
+- Found and fixed some actual bugs.
+	- GuildScheduledEventMethods#getGuildScheduledEvent and UserMethods#getGuild was accidentally passing the query string params to the JSON body param for the request.
+	- IntervalCounter#take would continue to decrement remaining past 0 into the negatives. It would still return false regardless, but this could probably have been problematic in external use cases outside of this lib.
+	- request retry logic would go indefinitely instead of decrementing the remaining amount.
+- Removed some types being exported from the package.
+	- These types were actually just straight up deleted as discord-api-types added them.
+- Added a generateWaveform function to Constants.
+	- This function is supposed to be used for ChannelMethods#createVoiceMessage, but it doesn't do the whole thing for you. Please read the JSDoc for it!
+	- Huge thank you to @Lulalaby for her original C# implementation.
+- Removed any lingering references to removeEveryone.
+- Fixed some errors with docs.
+	- Some of it was spelling related.
+	- Some docs entries had invalid JS in it, so anyone who copy pasted and saw an error... Oops! My bad.
+- Changed some method return types to be from discord-api-types.
+	- Previously for HTTP 204 routes, the return type was never, which was incorrect and made some design patterns, specifically mock test writing annoying as you cannot naturally return the type never in JS without unconditionally throwing an Error or calling process.exit()
+	- A PR from yours truly changed it to undefined. I had changed them to void locally for a bit and commented out the types from dapi types, but now that's fixed so they're back.
+- VSCode settings deprecated the setting originally used to specify the TS version in editor, so the path was changed.
+- Deleted the old travis.yml
+- Updated the examples.
+- Added a build script that runs both build:src and build:docs.
+- Added a lint script.

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 DasWolke
+Copyright (c) 2026 DasWolke
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -26,6 +26,8 @@ I've written a general whitepaper on the idea of microservice bots, which you ca
 ### Documentation:
 You can find the docs at [https://daswolke.github.io/SnowTransfer/](https://daswolke.github.io/SnowTransfer/)
 
+For a changelog, read here: [Changelog](./CHANGELOG.md)
+
 ### Installation:
 To install SnowTransfer, make sure that you have node 22.0.0 or higher and npm installed on your computer.
 
@@ -35,11 +37,8 @@ Then run the following command in a terminal `npm install snowtransfer`
 ```js
 const { SnowTransfer } = require('snowtransfer');
 const client = new SnowTransfer('DISCORD BOT TOKEN');
-const request = async () => {
-	const message = await client.channel.createMessage('channel id', 'hi there');
-	console.log(message);
-};
-request().then(() => {
+
+client.channel.createMessage('channel id', 'hi there').then(() => {
 	// message was sent to discord
 }).catch(e => {
 	// an error occurred