Skip to content

Commit ce97cd3

Browse files
authored
Merge pull request #60 from falsepopsky/changeset-release/main
chore(release): new @untidy/thetvdb version
2 parents 27e21e2 + ea721a0 commit ce97cd3

File tree

3 files changed

+49
-48
lines changed

3 files changed

+49
-48
lines changed

.changeset/big-dodos-confess.md

Lines changed: 0 additions & 47 deletions
This file was deleted.

packages/api/CHANGELOG.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,53 @@
11
# @untidy/thetvdb
22

3+
## 1.0.0
4+
5+
### Major Changes
6+
7+
- 68f97ff: We strongly recommend visiting the new [website](https://untidy-thetvdb.netlify.app) for guidance on
8+
updating your code to the latest stable major version, 1.0.0. In this version, we have addressed
9+
almost all return types and missing properties, and added previously undocumented queries that were
10+
not included in the original API documentation.
11+
12+
We have also enhanced the methods to specifically handle a particular endpoint along with their
13+
paths or queries. For instance, in the previous version, if a user wanted to request a specific
14+
movie's extended record, they would write something like this:
15+
16+
```js
17+
import { TheTVDB } from "@untidy/thetvdb";
18+
19+
const client = new TheTVDB("access token");
20+
await client.getMovie({ id: "3646", extended: true });
21+
```
22+
23+
Now, with the new rewrite, there's no need to specify the `extended` argument or even the `id`.
24+
25+
```js
26+
import { TheTVDB } from "@untidy/thetvdb";
27+
28+
const client = new TheTVDB("access token");
29+
await client.movieByIdExtended("12586");
30+
```
31+
32+
These changes streamline the code and provide a more intuitive and concise syntax for accessing
33+
movie extended records.
34+
35+
BREAKING CHANGES
36+
37+
- major: Single class only (previously TheTVDB & TheTVDBExtended).
38+
- major: Rewrite return, entity and other types and export them.
39+
- major: Rewrite methods for better handling of requests depending on the specific endpoint.
40+
- major: support to update your token.
41+
- major: bump minimum version of `Node.js` required `18.17.0`.
42+
- major: Only throw `Errors` if the response is not `ok` or the `token` validation fails (previously
43+
strictly throws an error if you miss an specific argument, now this is handle by the consumers of
44+
this package).
45+
- feat: add `jsdoc` for better documentation and examples of usage with the new
46+
[site](https://untidy-thetvdb.netlify.app).
47+
- feat: support more endpoints
48+
[reference](https://untidy-thetvdb.netlify.app/guides/supported-endpoints).
49+
- feat: support to update your token.
50+
351
## 0.5.0
452

553
### Minor Changes

packages/api/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@untidy/thetvdb",
33
"description": "Client library for TheTVDB API in Node.js",
4-
"version": "0.5.0",
4+
"version": "1.0.0",
55
"type": "module",
66
"exports": {
77
".": {

0 commit comments

Comments
 (0)