diff --git a/CHANGELOG.md b/CHANGELOG.md index fd268f2..f250ade 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +# [0.5.0](https://github.com/suzuki3jp/youtubes.js/compare/v0.4.5...v0.5.0) (2025-01-22) + + +### Features + +* Support `playlistItems.delete` ([8bc6700](https://github.com/suzuki3jp/youtubes.js/commit/8bc670063b629caab5e9c63ccd08e8ee0d330ce5)) + ## [0.4.5](https://github.com/suzuki3jp/youtubes.js/compare/v0.4.4...v0.4.5) (2025-01-21) ## [0.4.4](https://github.com/suzuki3jp/youtubes.js/compare/v0.4.3...v0.4.4) (2025-01-21) diff --git a/docs/api/youtubes.js.likelybugerror.md b/docs/api/youtubes.js.likelybugerror.md index 6ba3feb..b189378 100644 --- a/docs/api/youtubes.js.likelybugerror.md +++ b/docs/api/youtubes.js.likelybugerror.md @@ -6,7 +6,7 @@ Represents an error that is likely a bug in the library. -If you encounter this error, please report the issue on \[GitHub Issue\](https://github.com/suzuki3jp/youtubes.js/issues/new). +If you encounter this error, please report the issue on [GitHub Issue](https://github.com/suzuki3jp/youtubes.js/issues/new). **Signature:** diff --git a/docs/api/youtubes.js.md b/docs/api/youtubes.js.md index 140a9c4..6c5930c 100644 --- a/docs/api/youtubes.js.md +++ b/docs/api/youtubes.js.md @@ -37,7 +37,7 @@ The main class for interacting with the YouTube Data API. Represents an error that is likely a bug in the library. -If you encounter this error, please report the issue on \[GitHub Issue\](https://github.com/suzuki3jp/youtubes.js/issues/new). +If you encounter this error, please report the issue on [GitHub Issue](https://github.com/suzuki3jp/youtubes.js/issues/new). diff --git a/docs/api/youtubes.js.pagination.all.md b/docs/api/youtubes.js.pagination.all.md index 714a1e5..2c66155 100644 --- a/docs/api/youtubes.js.pagination.all.md +++ b/docs/api/youtubes.js.pagination.all.md @@ -4,7 +4,7 @@ ## Pagination.all() method -Fetches all pages data. - \*\*NOTE\*\*: This method may consume unnecessary quotas, so be careful when using it in actual applications. - We strongly recommend fetching the next page based on user actions (e.g., scrolling). +Fetches all pages data. **Signature:** @@ -17,6 +17,10 @@ Promise<Result<T\[\], [YouTubesJsErrors](./youtubes.js.youtubesjserrors.md All pages data in an array. If several items are in a page, this method will return a 2D array. Use `flat()` to convert it to a 1D array. +## Remarks + +- This method may consume unnecessary quotas, so be careful when using it in actual applications. - We strongly recommend fetching the next page based on user actions (e.g., scrolling). + ## Example diff --git a/docs/api/youtubes.js.pagination.md b/docs/api/youtubes.js.pagination.md index 1813eb5..bb0a5b6 100644 --- a/docs/api/youtubes.js.pagination.md +++ b/docs/api/youtubes.js.pagination.md @@ -122,7 +122,7 @@ number -The total number of results in the result set. \*\*NOTE\*\*: This number may be larger than the number of actual retrievable results. The YouTube Data API may not return some playlists (for example, the "Liked videos" playlist). However, the totalResults count may include them. +The total number of results in the result set. @@ -156,7 +156,7 @@ Description -Fetches all pages data. - \*\*NOTE\*\*: This method may consume unnecessary quotas, so be careful when using it in actual applications. - We strongly recommend fetching the next page based on user actions (e.g., scrolling). +Fetches all pages data. @@ -170,7 +170,7 @@ Fetches all pages data. - \*\*NOTE\*\*: This method may consume unnecessary quot -Fetches the next page. - \*\*NOTE\*\*: This method will use the same quotas as the original request. - Normally, GET requests use a quota of 1 unit, while other methods use 50 units. - However, some heavy methods use more than 50 units. - See more details on the [YouTube Data API reference](https://developers.google.com/youtube/v3/determine_quota_cost) +Fetches the next page. @@ -184,7 +184,7 @@ Fetches the next page. - \*\*NOTE\*\*: This method will use the same quotas as t -Fetches the previous page. - \*\*NOTE\*\*: This method will use the same quotas as the original request. - Normally, GET requests use a quota of 1 unit, while other methods use 50 units. - However, some heavy methods use more than 50 units. - See more details on the [YouTube Data API reference](https://developers.google.com/youtube/v3/determine_quota_cost) +Fetches the previous page. diff --git a/docs/api/youtubes.js.pagination.next.md b/docs/api/youtubes.js.pagination.next.md index 0c26d6e..b47c559 100644 --- a/docs/api/youtubes.js.pagination.next.md +++ b/docs/api/youtubes.js.pagination.next.md @@ -4,7 +4,7 @@ ## Pagination.next() method -Fetches the next page. - \*\*NOTE\*\*: This method will use the same quotas as the original request. - Normally, GET requests use a quota of 1 unit, while other methods use 50 units. - However, some heavy methods use more than 50 units. - See more details on the [YouTube Data API reference](https://developers.google.com/youtube/v3/determine_quota_cost) +Fetches the next page. **Signature:** @@ -17,6 +17,10 @@ Promise<Result<[Pagination](./youtubes.js.pagination.md)<T>, The next page. If there is no next page, returns `null`. +## Remarks + +- This method will use the same quotas as the original request. - Normally, GET requests use a quota of 1 unit, while other methods use 50 units. - However, some heavy methods use more than 50 units. - See more details on the [YouTube Data API reference](https://developers.google.com/youtube/v3/determine_quota_cost) + ## Example diff --git a/docs/api/youtubes.js.pagination.prev.md b/docs/api/youtubes.js.pagination.prev.md index 1ef59a7..89bec5f 100644 --- a/docs/api/youtubes.js.pagination.prev.md +++ b/docs/api/youtubes.js.pagination.prev.md @@ -4,7 +4,7 @@ ## Pagination.prev() method -Fetches the previous page. - \*\*NOTE\*\*: This method will use the same quotas as the original request. - Normally, GET requests use a quota of 1 unit, while other methods use 50 units. - However, some heavy methods use more than 50 units. - See more details on the [YouTube Data API reference](https://developers.google.com/youtube/v3/determine_quota_cost) +Fetches the previous page. **Signature:** @@ -17,6 +17,10 @@ Promise<Result<[Pagination](./youtubes.js.pagination.md)<T>, The previous page. If there is no previous page, returns `null`. +## Remarks + +- This method will use the same quotas as the original request. - Normally, GET requests use a quota of 1 unit, while other methods use 50 units. - However, some heavy methods use more than 50 units. - See more details on the [YouTube Data API reference](https://developers.google.com/youtube/v3/determine_quota_cost) + ## Example diff --git a/docs/api/youtubes.js.pagination.totalresults.md b/docs/api/youtubes.js.pagination.totalresults.md index 4442021..6abccd7 100644 --- a/docs/api/youtubes.js.pagination.totalresults.md +++ b/docs/api/youtubes.js.pagination.totalresults.md @@ -4,10 +4,15 @@ ## Pagination.totalResults property -The total number of results in the result set. \*\*NOTE\*\*: This number may be larger than the number of actual retrievable results. The YouTube Data API may not return some playlists (for example, the "Liked videos" playlist). However, the totalResults count may include them. +The total number of results in the result set. **Signature:** ```typescript totalResults: number; ``` + +## Remarks + +This number may be larger than the number of actual retrievable results. The YouTube Data API may not return some playlists (for example, the "Liked videos" playlist). However, the totalResults count may include them. + diff --git a/docs/api/youtubes.js.playlistitemmanager.create.md b/docs/api/youtubes.js.playlistitemmanager.create.md index 4044e09..a58495f 100644 --- a/docs/api/youtubes.js.playlistitemmanager.create.md +++ b/docs/api/youtubes.js.playlistitemmanager.create.md @@ -6,8 +6,6 @@ Adds a item to a playlist. -- The operation uses 50 quota units. - **Signature:** ```typescript @@ -55,3 +53,7 @@ Promise<Result<[PlaylistItem](./youtubes.js.playlistitem.md), [You - The created playlist item. +## Remarks + +The operation uses 50 quota units. + diff --git a/docs/api/youtubes.js.playlistitemmanager.deletebyid.md b/docs/api/youtubes.js.playlistitemmanager.deletebyid.md new file mode 100644 index 0000000..d79e3cd --- /dev/null +++ b/docs/api/youtubes.js.playlistitemmanager.deletebyid.md @@ -0,0 +1,53 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PlaylistItemManager](./youtubes.js.playlistitemmanager.md) > [deleteById](./youtubes.js.playlistitemmanager.deletebyid.md) + +## PlaylistItemManager.deleteById() method + +Deletes a playlist item by its ID. + +**Signature:** + +```typescript +deleteById(id: string): Promise>; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +id + + + + +string + + + + +The ID of the playlist item to delete. + + +
+**Returns:** + +Promise<Result<undefined, [YouTubesJsErrors](./youtubes.js.youtubesjserrors.md)>> + diff --git a/docs/api/youtubes.js.playlistitemmanager.getbyplaylistid.md b/docs/api/youtubes.js.playlistitemmanager.getbyplaylistid.md index 1ef8656..b5b4515 100644 --- a/docs/api/youtubes.js.playlistitemmanager.getbyplaylistid.md +++ b/docs/api/youtubes.js.playlistitemmanager.getbyplaylistid.md @@ -6,10 +6,6 @@ Retrieves a list of playlist items by a playlist ID. -- The operation uses 1 quota unit. - -[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlistItems/list) - **Signature:** ```typescript @@ -72,3 +68,9 @@ _(Optional)_ The page token to use for pagination. Promise<Result<[Pagination](./youtubes.js.pagination.md)<[PlaylistItem](./youtubes.js.playlistitem.md)\[\]>, [YouTubesJsErrors](./youtubes.js.youtubesjserrors.md)>> +## Remarks + +The operation uses 1 quota unit. + +[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlistItems/list) + diff --git a/docs/api/youtubes.js.playlistitemmanager.md b/docs/api/youtubes.js.playlistitemmanager.md index 1639f34..f07cd03 100644 --- a/docs/api/youtubes.js.playlistitemmanager.md +++ b/docs/api/youtubes.js.playlistitemmanager.md @@ -78,7 +78,19 @@ Description Adds a item to a playlist. -- The operation uses 50 quota units. + + + + +[deleteById(id)](./youtubes.js.playlistitemmanager.deletebyid.md) + + + + + + + +Deletes a playlist item by its ID. @@ -94,10 +106,6 @@ Adds a item to a playlist. Retrieves a list of playlist items by a playlist ID. -- The operation uses 1 quota unit. - -[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlistItems/list) - diff --git a/docs/api/youtubes.js.playlistmanager.create.md b/docs/api/youtubes.js.playlistmanager.create.md index b6b5283..a1d1316 100644 --- a/docs/api/youtubes.js.playlistmanager.create.md +++ b/docs/api/youtubes.js.playlistmanager.create.md @@ -6,10 +6,6 @@ Creates a playlist. -- This operation uses 50 quota units. - There is a limit of approximately 10 playlists per day for creation. - For more details, see the issue: https://issuetracker.google.com/issues/255216949 - -[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/insert) - **Signature:** ```typescript @@ -55,3 +51,9 @@ Options for creating a playlist. Promise<Result<[Playlist](./youtubes.js.playlist.md), [YouTubesJsErrors](./youtubes.js.youtubesjserrors.md)>> +## Remarks + +- This operation uses 50 quota units. - There is a limit of approximately 10 playlists per day for creation. - For more details, see the issue: https://issuetracker.google.com/issues/255216949 + +[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/insert) + diff --git a/docs/api/youtubes.js.playlistmanager.deletebyid.md b/docs/api/youtubes.js.playlistmanager.deletebyid.md index fb8ec99..157bdd1 100644 --- a/docs/api/youtubes.js.playlistmanager.deletebyid.md +++ b/docs/api/youtubes.js.playlistmanager.deletebyid.md @@ -6,10 +6,6 @@ Deletes a playlist by its ID. -- This operation uses 50 quota units. - -[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/delete) - **Signature:** ```typescript @@ -55,3 +51,9 @@ The ID of the playlist. Promise<void> +## Remarks + +This operation uses 50 quota units. + +[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/delete) + diff --git a/docs/api/youtubes.js.playlistmanager.getbychannelid.md b/docs/api/youtubes.js.playlistmanager.getbychannelid.md index 05a122d..6092b50 100644 --- a/docs/api/youtubes.js.playlistmanager.getbychannelid.md +++ b/docs/api/youtubes.js.playlistmanager.getbychannelid.md @@ -6,10 +6,6 @@ Fetches the playlists of a channel by its ID. -- This operation uses 1 quota unit. - Retrieves all playlists when given an authenticated user's channel ID. Otherwise, only public playlists are accessible. - -[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/list) - **Signature:** ```typescript @@ -71,6 +67,12 @@ _(Optional)_ The token for pagination. Promise<Result<[Pagination](./youtubes.js.pagination.md)<[Playlist](./youtubes.js.playlist.md)\[\]>, [YouTubesJsErrors](./youtubes.js.youtubesjserrors.md)>> +## Remarks + +- This operation uses 1 quota unit. - Retrieves all playlists when given an authenticated user's channel ID. Otherwise, only public playlists are accessible. + +[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/list) + ## Example diff --git a/docs/api/youtubes.js.playlistmanager.getbyids.md b/docs/api/youtubes.js.playlistmanager.getbyids.md index 2ecb111..3fb1166 100644 --- a/docs/api/youtubes.js.playlistmanager.getbyids.md +++ b/docs/api/youtubes.js.playlistmanager.getbyids.md @@ -6,10 +6,6 @@ Fetches a playlist by its ID. -- This operation uses 1 quota unit. - Note: The YouTube API returns empty data instead of an error when a playlist with the specified ID is not found. - -[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/list) - **Signature:** ```typescript @@ -71,6 +67,12 @@ _(Optional)_ The token for pagination. Promise<Result<[Pagination](./youtubes.js.pagination.md)<[Playlist](./youtubes.js.playlist.md)\[\]>, [YouTubesJsErrors](./youtubes.js.youtubesjserrors.md)>> +## Remarks + +- This operation uses 1 quota unit. - Note: The YouTube API returns empty data instead of an error when a playlist with the specified ID is not found. + +[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/list) + ## Example diff --git a/docs/api/youtubes.js.playlistmanager.getmine.md b/docs/api/youtubes.js.playlistmanager.getmine.md index a7e26cc..156dc70 100644 --- a/docs/api/youtubes.js.playlistmanager.getmine.md +++ b/docs/api/youtubes.js.playlistmanager.getmine.md @@ -6,10 +6,6 @@ Fetches the playlists owned by the authenticated user. -- This operation uses 1 quota unit. - -[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/list) - **Signature:** ```typescript @@ -55,6 +51,12 @@ _(Optional)_ The token for pagination. Promise<Result<[Pagination](./youtubes.js.pagination.md)<[Playlist](./youtubes.js.playlist.md)\[\]>, [YouTubesJsErrors](./youtubes.js.youtubesjserrors.md)>> +## Remarks + +This operation uses 1 quota unit. + +[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/list) + ## Example diff --git a/docs/api/youtubes.js.playlistmanager.md b/docs/api/youtubes.js.playlistmanager.md index f4807a6..6a0588e 100644 --- a/docs/api/youtubes.js.playlistmanager.md +++ b/docs/api/youtubes.js.playlistmanager.md @@ -78,10 +78,6 @@ Description Creates a playlist. -- This operation uses 50 quota units. - There is a limit of approximately 10 playlists per day for creation. - For more details, see the issue: https://issuetracker.google.com/issues/255216949 - -[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/insert) - @@ -96,10 +92,6 @@ Creates a playlist. Deletes a playlist by its ID. -- This operation uses 50 quota units. - -[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/delete) - @@ -114,10 +106,6 @@ Deletes a playlist by its ID. Fetches the playlists of a channel by its ID. -- This operation uses 1 quota unit. - Retrieves all playlists when given an authenticated user's channel ID. Otherwise, only public playlists are accessible. - -[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/list) - @@ -132,10 +120,6 @@ Fetches the playlists of a channel by its ID. Fetches a playlist by its ID. -- This operation uses 1 quota unit. - Note: The YouTube API returns empty data instead of an error when a playlist with the specified ID is not found. - -[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/list) - @@ -150,10 +134,6 @@ Fetches a playlist by its ID. Fetches the playlists owned by the authenticated user. -- This operation uses 1 quota unit. - -[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/list) - @@ -168,10 +148,6 @@ Fetches the playlists owned by the authenticated user. Updates a playlist by its ID. -- This operation uses 50 quota units. - \[If you are submitting an update request, and your request does not specify a value for a property that already has a value, the property's existing value will be deleted.\](https://developers.google.com/youtube/v3/docs/playlists/update\#request-body) - For example, when updating a playlist that has a description set, if you don't specify the `description`, it will be set to an empty string. - However, for the `privacy` property, it seems to remain unchanged if not specified. - -[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/update) - diff --git a/docs/api/youtubes.js.playlistmanager.updatebyid.md b/docs/api/youtubes.js.playlistmanager.updatebyid.md index e8d4dd0..6cb34c8 100644 --- a/docs/api/youtubes.js.playlistmanager.updatebyid.md +++ b/docs/api/youtubes.js.playlistmanager.updatebyid.md @@ -6,10 +6,6 @@ Updates a playlist by its ID. -- This operation uses 50 quota units. - \[If you are submitting an update request, and your request does not specify a value for a property that already has a value, the property's existing value will be deleted.\](https://developers.google.com/youtube/v3/docs/playlists/update\#request-body) - For example, when updating a playlist that has a description set, if you don't specify the `description`, it will be set to an empty string. - However, for the `privacy` property, it seems to remain unchanged if not specified. - -[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/update) - **Signature:** ```typescript @@ -57,3 +53,9 @@ Promise<Result<[Playlist](./youtubes.js.playlist.md), [YouTubesJsE - The updated playlist. +## Remarks + +- This operation uses 50 quota units. - \[If you are submitting an update request, and your request does not specify a value for a property that already has a value, the property's existing value will be deleted.\](https://developers.google.com/youtube/v3/docs/playlists/update\#request-body) - For example, when updating a playlist that has a description set, if you don't specify the `description`, it will be set to an empty string. - However, for the `privacy` property, it seems to remain unchanged if not specified. + +[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/update) + diff --git a/package-lock.json b/package-lock.json index d09e0fd..e0b714e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "youtubes.js", - "version": "0.4.5", + "version": "0.5.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "youtubes.js", - "version": "0.4.5", + "version": "0.5.0", "license": "MIT", "dependencies": { "googleapis": "^144.0.0", diff --git a/package.json b/package.json index aca0cb6..4f277ff 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "youtubes.js", "description": "A JavaScript client for YouTube Data API v3.", - "version": "0.4.5", + "version": "0.5.0", "main": "dist/index.js", "types": "dist/index.d.ts", "keywords": [