diff --git a/CHANGELOG.md b/CHANGELOG.md index f531dc9..c0b2792 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,16 @@ +## [0.4.3](https://github.com/suzuki3jp/youtubes.js/compare/v0.4.2...v0.4.3) (2025-01-20) + + +### Bug Fixes + +* **PlaylistItemManager:** Prevent `tsdoc-param-tag-missing-hyphen` error in `api-extractor` CI job ([bb64f89](https://github.com/suzuki3jp/youtubes.js/commit/bb64f896415e129d726df2d306c4d232267a834a)) +* Prevent `ErrorEXError [JSONError]: JSON Error in /home/runner/work/youtubes.js/youtubes.js/.releaserc.json` in CD ([0cd2870](https://github.com/suzuki3jp/youtubes.js/commit/0cd2870d56ff2b5115f5c900a3480ed6e02e77e6)) + + +### Features + +* **PlaylistItemManager:** Support `playlistItems.list` by playlistId ([005ec48](https://github.com/suzuki3jp/youtubes.js/commit/005ec483632ff278b08eb9319ad6fe0c45976ecc)) + ## [0.4.2](https://github.com/suzuki3jp/youtubes.js/compare/v0.4.1...v0.4.2) (2025-01-20) ## [0.4.1](https://github.com/suzuki3jp/youtubes.js/compare/v0.4.0...v0.4.1) (2025-01-19) diff --git a/docs/api/youtubes.js.apiclient.md b/docs/api/youtubes.js.apiclient.md index 29aebec..635d267 100644 --- a/docs/api/youtubes.js.apiclient.md +++ b/docs/api/youtubes.js.apiclient.md @@ -71,6 +71,25 @@ Description +[playlistItems](./youtubes.js.apiclient.playlistitems.md) + + + + + + + +[PlaylistItemManager](./youtubes.js.playlistitemmanager.md) + + + + +A manager for playlist items. Provides methods for fetching and manipulating playlist items. + + + + + [playlists](./youtubes.js.apiclient.playlists.md) diff --git a/docs/api/youtubes.js.apiclient.playlistitems.md b/docs/api/youtubes.js.apiclient.playlistitems.md new file mode 100644 index 0000000..5ef5068 --- /dev/null +++ b/docs/api/youtubes.js.apiclient.playlistitems.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [ApiClient](./youtubes.js.apiclient.md) > [playlistItems](./youtubes.js.apiclient.playlistitems.md) + +## ApiClient.playlistItems property + +A manager for playlist items. Provides methods for fetching and manipulating playlist items. + +**Signature:** + +```typescript +playlistItems: PlaylistItemManager; +``` diff --git a/docs/api/youtubes.js.md b/docs/api/youtubes.js.md index 13483cd..f328234 100644 --- a/docs/api/youtubes.js.md +++ b/docs/api/youtubes.js.md @@ -64,6 +64,19 @@ Represents a YouTube playlist resource. \[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/playlists\#resource) + + + +[PlaylistItemManager](./youtubes.js.playlistitemmanager.md) + + + + +A manager of playlist items belonging to a client. Provides methods for `/youtube/v3/playlistItems` + +\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/playlistItems) + + @@ -218,6 +231,15 @@ Description + + + +[PlaylistItem](./youtubes.js.playlistitem.md) + + + + + diff --git a/docs/api/youtubes.js.playlistitem.md b/docs/api/youtubes.js.playlistitem.md new file mode 100644 index 0000000..5b87409 --- /dev/null +++ b/docs/api/youtubes.js.playlistitem.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PlaylistItem](./youtubes.js.playlistitem.md) + +## PlaylistItem type + +**Signature:** + +```typescript +export type PlaylistItem = AvailablePlaylistItem | UnavailablePlaylistItem; +``` diff --git a/docs/api/youtubes.js.playlistitemmanager._constructor_.md b/docs/api/youtubes.js.playlistitemmanager._constructor_.md new file mode 100644 index 0000000..0bcccd6 --- /dev/null +++ b/docs/api/youtubes.js.playlistitemmanager._constructor_.md @@ -0,0 +1,47 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PlaylistItemManager](./youtubes.js.playlistitemmanager.md) > [(constructor)](./youtubes.js.playlistitemmanager._constructor_.md) + +## PlaylistItemManager.(constructor) + +Constructs a new instance of the `PlaylistItemManager` class + +**Signature:** + +```typescript +constructor({ oauth, logger }: PlaylistItemManagerOptions); +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +{ oauth, logger } + + + + +PlaylistItemManagerOptions + + + + + +
diff --git a/docs/api/youtubes.js.playlistitemmanager.getbyplaylistid.md b/docs/api/youtubes.js.playlistitemmanager.getbyplaylistid.md new file mode 100644 index 0000000..d34e307 --- /dev/null +++ b/docs/api/youtubes.js.playlistitemmanager.getbyplaylistid.md @@ -0,0 +1,74 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PlaylistItemManager](./youtubes.js.playlistitemmanager.md) > [getByPlaylistId](./youtubes.js.playlistitemmanager.getbyplaylistid.md) + +## PlaylistItemManager.getByPlaylistId() method + +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 +getByPlaylistId(playlistId: string, pageToken?: string): Promise, YouTubesJsErrors>>; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +playlistId + + + + +string + + + + +The ID of the playlist to retrieve items from. + + +
+ +pageToken + + + + +string + + + + +_(Optional)_ The page token to use for pagination. + + +
+**Returns:** + +Promise<Result<[Pagination](./youtubes.js.pagination.md)<[PlaylistItem](./youtubes.js.playlistitem.md)\[\]>, [YouTubesJsErrors](./youtubes.js.youtubesjserrors.md)>> + + diff --git a/docs/api/youtubes.js.playlistitemmanager.md b/docs/api/youtubes.js.playlistitemmanager.md new file mode 100644 index 0000000..0d2bb5b --- /dev/null +++ b/docs/api/youtubes.js.playlistitemmanager.md @@ -0,0 +1,87 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PlaylistItemManager](./youtubes.js.playlistitemmanager.md) + +## PlaylistItemManager class + +A manager of playlist items belonging to a client. Provides methods for `/youtube/v3/playlistItems` + +\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/playlistItems) + +**Signature:** + +```typescript +export declare class PlaylistItemManager +``` + +## Constructors + + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)({ oauth, logger })](./youtubes.js.playlistitemmanager._constructor_.md) + + + + + + + +Constructs a new instance of the `PlaylistItemManager` class + + +
+ +## Methods + + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +[getByPlaylistId(playlistId, pageToken)](./youtubes.js.playlistitemmanager.getbyplaylistid.md) + + + + + + + +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/package-lock.json b/package-lock.json index 28f4523..a24762b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "youtubes.js", - "version": "0.4.2", + "version": "0.4.3", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "youtubes.js", - "version": "0.4.2", + "version": "0.4.3", "license": "MIT", "dependencies": { "googleapis": "^144.0.0", diff --git a/package.json b/package.json index 46b4c4a..b0044a4 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.2", + "version": "0.4.3", "main": "dist/index.js", "types": "dist/index.d.ts", "keywords": [