1 Commits

Author SHA1 Message Date
Blake Joynes
eb4e707ff9 add test actions 2023-04-15 14:32:11 -04:00
14 changed files with 107 additions and 96 deletions

View File

@@ -0,0 +1,18 @@
name: GitHub Actions Demo
run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
on: [push]
jobs:
Explore-GitHub-Actions:
runs-on: ubuntu-latest
steps:
- run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
- run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
- run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
- name: Check out repository code
uses: actions/checkout@v3
- run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
- run: echo "🖥️ The workflow is now ready to test your code on the runner."
- name: List files in the repository
run: |
ls ${{ github.workspace }}
- run: echo "🍏 This job's status is ${{ job.status }}."

View File

@@ -1,33 +0,0 @@
# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
name: Node.js Package
on:
release:
types: [created]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 16
- run: npm ci
- run: npm test
publish-npm:
needs: build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 16
registry-url: https://registry.npmjs.org/
- run: npm ci
- run: npm publish
env:
NODE_AUTH_TOKEN: ${{secrets.npm_token}}

View File

@@ -1,6 +1,6 @@
{ {
"name": "tmdb-ts", "name": "tmdb-ts",
"version": "0.2.0", "version": "0.1.9",
"description": "TMDB v3 library wrapper", "description": "TMDB v3 library wrapper",
"main": "dist/index.js", "main": "dist/index.js",
"types": "dist/index.d.ts", "types": "dist/index.d.ts",

View File

@@ -1,5 +1,4 @@
import fetch from 'cross-fetch'; import fetch from 'cross-fetch';
import { parseOptions } from './utils';
const BASE_URL_V3 = 'https://api.themoviedb.org/3'; const BASE_URL_V3 = 'https://api.themoviedb.org/3';
@@ -8,9 +7,8 @@ export default class Api {
this.accessToken = accessToken; this.accessToken = accessToken;
} }
async get<T>(path: string, options?: Record<string, any>): Promise<T> { async get<T>(path: string): Promise<T> {
const params = parseOptions(options); const response = await fetch(`${BASE_URL_V3}${path}`, {
const response = await fetch(`${BASE_URL_V3}${path}?${params}`, {
method: 'GET', method: 'GET',
headers: { headers: {
Authorization: `Bearer ${this.accessToken}`, Authorization: `Bearer ${this.accessToken}`,

View File

@@ -1,5 +1,6 @@
import { BaseEndpoint } from './base'; import { BaseEndpoint } from './base';
import { ChangeOptions, Changes } from '../types/changes'; import { ChangeOptions, Changes } from '../types/changes';
import { parseOptions } from '../utils';
export class ChangeEndpoint extends BaseEndpoint { export class ChangeEndpoint extends BaseEndpoint {
constructor(protected readonly accessToken: string) { constructor(protected readonly accessToken: string) {
@@ -7,14 +8,17 @@ export class ChangeEndpoint extends BaseEndpoint {
} }
async movies(options?: ChangeOptions): Promise<Changes> { async movies(options?: ChangeOptions): Promise<Changes> {
return await this.api.get<Changes>(`/movie/changes`, options); const params = parseOptions(options);
return await this.api.get<Changes>(`/movie/changes?${params}`);
} }
async tvShows(options?: ChangeOptions): Promise<Changes> { async tvShows(options?: ChangeOptions): Promise<Changes> {
return await this.api.get<Changes>(`/tv/changes`, options); const params = parseOptions(options);
return await this.api.get<Changes>(`/tv/changes?${params}`);
} }
async person(options?: ChangeOptions): Promise<Changes> { async person(options?: ChangeOptions): Promise<Changes> {
return await this.api.get<Changes>(`/person/change`, options); const params = parseOptions(options);
return await this.api.get<Changes>(`/person/changes${params}`);
} }
} }

View File

@@ -4,6 +4,7 @@ import {
LanguageOption, LanguageOption,
Translations, Translations,
} from '../types'; } from '../types';
import { parseOptions } from '../utils';
import { BaseEndpoint } from './base'; import { BaseEndpoint } from './base';
const BASE_COLLECTION = '/collection'; const BASE_COLLECTION = '/collection';
@@ -17,16 +18,16 @@ export class CollectionsEndpoint extends BaseEndpoint {
id: number, id: number,
options?: LanguageOption options?: LanguageOption
): Promise<DetailedCollection> { ): Promise<DetailedCollection> {
const params = parseOptions(options);
return await this.api.get<DetailedCollection>( return await this.api.get<DetailedCollection>(
`${BASE_COLLECTION}/${id}`, `${BASE_COLLECTION}/${id}?${params}`
options
); );
} }
async images(id: number, options?: LanguageOption): Promise<ImageCollection> { async images(id: number, options?: LanguageOption): Promise<ImageCollection> {
const params = parseOptions(options);
return await this.api.get<ImageCollection>( return await this.api.get<ImageCollection>(
`${BASE_COLLECTION}/${id}/images`, `${BASE_COLLECTION}/${id}/images?${params}`
options
); );
} }
@@ -34,9 +35,9 @@ export class CollectionsEndpoint extends BaseEndpoint {
id: number, id: number,
options?: LanguageOption options?: LanguageOption
): Promise<Translations> { ): Promise<Translations> {
const params = parseOptions(options);
return await this.api.get<Translations>( return await this.api.get<Translations>(
`${BASE_COLLECTION}/${id}/translations`, `${BASE_COLLECTION}/${id}/translations?${params}`
options
); );
} }
} }

View File

@@ -3,6 +3,7 @@ import {
SortOption, SortOption,
TvShowDiscoverResult, TvShowDiscoverResult,
} from '../types'; } from '../types';
import { parseOptions } from '../utils';
import { BaseEndpoint } from './base'; import { BaseEndpoint } from './base';
const BASE_DISCOVER = '/discover'; const BASE_DISCOVER = '/discover';
@@ -69,16 +70,16 @@ export class DiscoverEndpoint extends BaseEndpoint {
} }
async movie(options?: MovieQueryOptions): Promise<MovieDiscoverResult> { async movie(options?: MovieQueryOptions): Promise<MovieDiscoverResult> {
const params = parseOptions(options);
return await this.api.get<MovieDiscoverResult>( return await this.api.get<MovieDiscoverResult>(
`${BASE_DISCOVER}/movie`, `${BASE_DISCOVER}/movie?${params}`
options
); );
} }
async tvShow(options?: TvShowQueryOptions): Promise<TvShowDiscoverResult> { async tvShow(options?: TvShowQueryOptions): Promise<TvShowDiscoverResult> {
const params = parseOptions(options);
return await this.api.get<TvShowDiscoverResult>( return await this.api.get<TvShowDiscoverResult>(
`${BASE_DISCOVER}/tv`, `${BASE_DISCOVER}/tv?${params}`
options
); );
} }
} }

View File

@@ -1,5 +1,6 @@
import { BaseEndpoint } from './base'; import { BaseEndpoint } from './base';
import { ExternalIdOptions, FindResult } from '../types'; import { ExternalIdOptions, FindResult } from '../types';
import { parseOptions } from '../utils';
export class FindEndpoint extends BaseEndpoint { export class FindEndpoint extends BaseEndpoint {
constructor(accessToken: string) { constructor(accessToken: string) {
@@ -10,6 +11,7 @@ export class FindEndpoint extends BaseEndpoint {
externalId: string, externalId: string,
options: ExternalIdOptions options: ExternalIdOptions
): Promise<FindResult> { ): Promise<FindResult> {
return await this.api.get<FindResult>(`/find/${externalId}`, options); const params = parseOptions(options);
return await this.api.get<FindResult>(`/find/${externalId}?${params}`);
} }
} }

View File

@@ -1,5 +1,6 @@
import { BaseEndpoint } from './base'; import { BaseEndpoint } from './base';
import { BelongingMovies, Keyword, KeywordsOptions } from '../types'; import { BelongingMovies, Keyword, KeywordsOptions } from '../types';
import { parseOptions } from '../utils';
const BASE_Keyword = '/keyword'; const BASE_Keyword = '/keyword';
@@ -16,9 +17,9 @@ export class KeywordsEndpoint extends BaseEndpoint {
keywordId: number, keywordId: number,
options?: KeywordsOptions options?: KeywordsOptions
): Promise<BelongingMovies> { ): Promise<BelongingMovies> {
const params = parseOptions(options);
return await this.api.get<BelongingMovies>( return await this.api.get<BelongingMovies>(
`${BASE_Keyword}/${keywordId}/movies`, `${BASE_Keyword}/${keywordId}/movies?${params}`
options
); );
} }
} }

View File

@@ -25,6 +25,7 @@ import {
Videos, Videos,
WatchProviders, WatchProviders,
} from '../types'; } from '../types';
import { parseOptions } from '../utils';
const BASE_MOVIE = '/movie'; const BASE_MOVIE = '/movie';
@@ -44,9 +45,9 @@ export class MoviesEndpoint extends BaseEndpoint {
} }
async changes(id: number, options?: ChangeOptions): Promise<MovieChanges> { async changes(id: number, options?: ChangeOptions): Promise<MovieChanges> {
const params = parseOptions(options);
return await this.api.get<MovieChanges>( return await this.api.get<MovieChanges>(
`${BASE_MOVIE}/${id}/changes`, `${BASE_MOVIE}/${id}/changes?${params}`
options
); );
} }
@@ -70,16 +71,19 @@ export class MoviesEndpoint extends BaseEndpoint {
id: number, id: number,
options?: LanguageOption | PageOption options?: LanguageOption | PageOption
): Promise<MovieLists> { ): Promise<MovieLists> {
return await this.api.get<MovieLists>(`${BASE_MOVIE}/${id}/lists`, options); const params = parseOptions(options);
return await this.api.get<MovieLists>(
`${BASE_MOVIE}/${id}/lists?${params}`
);
} }
async recommendations( async recommendations(
id: number, id: number,
options?: PageOption options?: PageOption
): Promise<Recommendations> { ): Promise<Recommendations> {
const params = parseOptions(options);
return await this.api.get<Recommendations>( return await this.api.get<Recommendations>(
`${BASE_MOVIE}/${id}/recommendations`, `${BASE_MOVIE}/${id}/recommendations?${params}`
options
); );
} }
@@ -90,13 +94,14 @@ export class MoviesEndpoint extends BaseEndpoint {
} }
async reviews(id: number, options?: PageOption): Promise<Reviews> { async reviews(id: number, options?: PageOption): Promise<Reviews> {
return await this.api.get<Reviews>(`${BASE_MOVIE}/${id}/reviews`, options); const params = parseOptions(options);
return await this.api.get<Reviews>(`${BASE_MOVIE}/${id}/reviews?${params}`);
} }
async similar(id: number, options?: PageOption): Promise<SimilarMovies> { async similar(id: number, options?: PageOption): Promise<SimilarMovies> {
const params = parseOptions(options);
return await this.api.get<SimilarMovies>( return await this.api.get<SimilarMovies>(
`${BASE_MOVIE}/${id}/similar`, `${BASE_MOVIE}/${id}/similar?${params}`
options
); );
} }
@@ -125,31 +130,32 @@ export class MoviesEndpoint extends BaseEndpoint {
async nowPlaying( async nowPlaying(
options?: PageOption & LanguageOption & RegionOption options?: PageOption & LanguageOption & RegionOption
): Promise<MoviesPlayingNow> { ): Promise<MoviesPlayingNow> {
const params = parseOptions(options);
return await this.api.get<MoviesPlayingNow>( return await this.api.get<MoviesPlayingNow>(
`${BASE_MOVIE}/now_playing`, `${BASE_MOVIE}/now_playing?${params}`
options
); );
} }
async popular(options?: PageOption): Promise<PopularMovies> { async popular(options?: PageOption): Promise<PopularMovies> {
return await this.api.get<PopularMovies>(`${BASE_MOVIE}/popular`, options); const params = parseOptions(options);
return await this.api.get<PopularMovies>(`${BASE_MOVIE}/popular?${params}`);
} }
async topRated( async topRated(
options?: PageOption & LanguageOption & RegionOption options?: PageOption & LanguageOption & RegionOption
): Promise<TopRatedMovies> { ): Promise<TopRatedMovies> {
const params = parseOptions(options);
return await this.api.get<TopRatedMovies>( return await this.api.get<TopRatedMovies>(
`${BASE_MOVIE}/top_rated`, `${BASE_MOVIE}/top_rated?${params}`
options
); );
} }
async upcoming( async upcoming(
options?: PageOption & LanguageOption & RegionOption options?: PageOption & LanguageOption & RegionOption
): Promise<UpcomingMovies> { ): Promise<UpcomingMovies> {
const params = parseOptions(options);
return await this.api.get<UpcomingMovies>( return await this.api.get<UpcomingMovies>(
`${BASE_MOVIE}/upcoming`, `${BASE_MOVIE}/upcoming?${params}`
options
); );
} }
} }

View File

@@ -12,6 +12,7 @@ import {
PopularPersons, PopularPersons,
TaggedImages, TaggedImages,
} from '../types'; } from '../types';
import { parseOptions } from '../utils';
import { BaseEndpoint } from './base'; import { BaseEndpoint } from './base';
const BASE_PERSON = '/person'; const BASE_PERSON = '/person';
@@ -26,9 +27,9 @@ export class PeopleEndpoint extends BaseEndpoint {
} }
async changes(id: number, options?: ChangeOptions): Promise<PersonChanges> { async changes(id: number, options?: ChangeOptions): Promise<PersonChanges> {
const params = parseOptions(options);
return await this.api.get<PersonChanges>( return await this.api.get<PersonChanges>(
`${BASE_PERSON}/${id}/changes`, `${BASE_PERSON}/${id}/changes?${params}`
options
); );
} }
@@ -61,9 +62,9 @@ export class PeopleEndpoint extends BaseEndpoint {
} }
async taggedImages(id: number, options?: PageOption): Promise<TaggedImages> { async taggedImages(id: number, options?: PageOption): Promise<TaggedImages> {
const params = parseOptions(options);
return await this.api.get<TaggedImages>( return await this.api.get<TaggedImages>(
`${BASE_PERSON}/${id}/tagged_images`, `${BASE_PERSON}/${id}/tagged_images?${params}`
options
); );
} }
@@ -78,9 +79,9 @@ export class PeopleEndpoint extends BaseEndpoint {
} }
async popular(options?: PageOption): Promise<PopularPersons> { async popular(options?: PageOption): Promise<PopularPersons> {
const params = parseOptions(options);
return await this.api.get<PopularPersons>( return await this.api.get<PopularPersons>(
`${BASE_PERSON}/popular`, `${BASE_PERSON}/popular?${params}`
options
); );
} }
} }

View File

@@ -1,6 +1,7 @@
import { BaseEndpoint } from './base'; import { BaseEndpoint } from './base';
import { Search } from '../types/search'; import { Search } from '../types/search';
import { Collection, Company, Movie, Person, TV } from '../types'; import { Collection, Company, Movie, Person, TV } from '../types';
import { parseOptions } from '../utils';
const BASE_SEARCH = '/search'; const BASE_SEARCH = '/search';
@@ -30,39 +31,44 @@ export class SearchEndpoint extends BaseEndpoint {
} }
async companies(options: SearchOptions): Promise<Search<Company>> { async companies(options: SearchOptions): Promise<Search<Company>> {
const params = parseOptions(options);
return await this.api.get<Search<Company>>( return await this.api.get<Search<Company>>(
`${BASE_SEARCH}/company`, `${BASE_SEARCH}/company?${params}`
options
); );
} }
async collections(options: SearchOptions): Promise<Search<Collection>> { async collections(options: SearchOptions): Promise<Search<Collection>> {
const params = parseOptions(options);
return await this.api.get<Search<Collection>>( return await this.api.get<Search<Collection>>(
`${BASE_SEARCH}/collection`, `${BASE_SEARCH}/collection?${params}`
options
); );
} }
async keywords( async keywords(
options: SearchOptions options: SearchOptions
): Promise<Search<{ id: string; name: string }>> { ): Promise<Search<{ id: string; name: string }>> {
const params = parseOptions(options);
return await this.api.get<Search<{ id: string; name: string }>>( return await this.api.get<Search<{ id: string; name: string }>>(
`${BASE_SEARCH}/keyword`, `${BASE_SEARCH}/keyword?${params}`
options
); );
} }
async movies(options: MovieSearchOptions): Promise<Search<Movie>> { async movies(options: MovieSearchOptions): Promise<Search<Movie>> {
return await this.api.get<Search<Movie>>(`${BASE_SEARCH}/movie`, options); const params = parseOptions(options);
return await this.api.get<Search<Movie>>(`${BASE_SEARCH}/movie?${params}`);
} }
async people(options: PeopleSearchOptions): Promise<Search<Person>> { async people(options: PeopleSearchOptions): Promise<Search<Person>> {
return await this.api.get<Search<Person>>(`${BASE_SEARCH}/person`, options); const params = parseOptions(options);
return await this.api.get<Search<Person>>(
`${BASE_SEARCH}/person?${params}`
);
} }
// TODO: Multi search // TODO: Multi search
async tvShows(options: TvSearchOptions): Promise<Search<TV>> { async tvShows(options: TvSearchOptions): Promise<Search<TV>> {
return await this.api.get<Search<TV>>(`${BASE_SEARCH}/tv`, options); const params = parseOptions(options);
return await this.api.get<Search<TV>>(`${BASE_SEARCH}/tv?${params}`);
} }
} }

View File

@@ -27,6 +27,7 @@ import {
Videos, Videos,
WatchProviders, WatchProviders,
} from '../types'; } from '../types';
import { parseOptions } from '../utils';
const BASE_TV = '/tv'; const BASE_TV = '/tv';
@@ -46,9 +47,9 @@ export class TvShowsEndpoint extends BaseEndpoint {
} }
async changes(id: number, options?: ChangeOptions): Promise<TvShowChanges> { async changes(id: number, options?: ChangeOptions): Promise<TvShowChanges> {
const params = parseOptions(options);
return await this.api.get<TvShowChanges>( return await this.api.get<TvShowChanges>(
`${BASE_TV}/${id}/changes`, `${BASE_TV}/${id}/changes?${params}`
options
); );
} }
@@ -88,14 +89,15 @@ export class TvShowsEndpoint extends BaseEndpoint {
id: number, id: number,
options?: PageOption options?: PageOption
): Promise<Recommendations> { ): Promise<Recommendations> {
const params = parseOptions(options);
return await this.api.get<Recommendations>( return await this.api.get<Recommendations>(
`${BASE_TV}/${id}/recommendations`, `${BASE_TV}/${id}/recommendations?${params}`
options
); );
} }
async reviews(id: number, options?: PageOption): Promise<Reviews> { async reviews(id: number, options?: PageOption): Promise<Reviews> {
return await this.api.get<Reviews>(`${BASE_TV}/${id}/reviews`, options); const params = parseOptions(options);
return await this.api.get<Reviews>(`${BASE_TV}/${id}/reviews?${params}`);
} }
async screenedTheatrically(id: number): Promise<ScreenedTheatrically> { async screenedTheatrically(id: number): Promise<ScreenedTheatrically> {
@@ -105,9 +107,9 @@ export class TvShowsEndpoint extends BaseEndpoint {
} }
async similar(id: number, options?: PageOption): Promise<SimilarTvShows> { async similar(id: number, options?: PageOption): Promise<SimilarTvShows> {
const params = parseOptions(options);
return await this.api.get<SimilarTvShows>( return await this.api.get<SimilarTvShows>(
`${BASE_TV}/${id}/similar`, `${BASE_TV}/${id}/similar?${params}`
options
); );
} }
@@ -140,21 +142,25 @@ export class TvShowsEndpoint extends BaseEndpoint {
async airingToday( async airingToday(
options?: PageOption & LanguageOption & RegionOption options?: PageOption & LanguageOption & RegionOption
): Promise<TvShowsAiringToday> { ): Promise<TvShowsAiringToday> {
const params = parseOptions(options);
return await this.api.get<TvShowsAiringToday>( return await this.api.get<TvShowsAiringToday>(
`${BASE_TV}/airing_today`, `${BASE_TV}/airing_today?${params}`
options
); );
} }
async popular( async popular(
options?: PageOption & LanguageOption & RegionOption options?: PageOption & LanguageOption & RegionOption
): Promise<PopularTvShows> { ): Promise<PopularTvShows> {
return await this.api.get<PopularTvShows>(`${BASE_TV}/popular`, options); const params = parseOptions(options);
return await this.api.get<PopularTvShows>(`${BASE_TV}/popular?${params}`);
} }
async topRated( async topRated(
options?: PageOption & LanguageOption & RegionOption options?: PageOption & LanguageOption & RegionOption
): Promise<TopRatedTvShows> { ): Promise<TopRatedTvShows> {
return await this.api.get<TopRatedTvShows>(`${BASE_TV}/top_rated`, options); const params = parseOptions(options);
return await this.api.get<TopRatedTvShows>(
`${BASE_TV}/top_rated?${params}`
);
} }
} }

View File

@@ -1,4 +1,4 @@
export function parseOptions(options?: Record<string, any>): string {
/* eslint-disable @typescript-eslint/no-explicit-any */ /* eslint-disable @typescript-eslint/no-explicit-any */
export function parseOptions(options?: { [s: string]: any }): string {
return options ? new URLSearchParams(Object.entries(options)).toString() : ''; return options ? new URLSearchParams(Object.entries(options)).toString() : '';
} }