chore: add explicit returns to meed jsr publish criteria

MellKam · Feb 19, 2024 · 59fbcea · 59fbcea
1 parent ea2a7ed
commit 59fbcea
Show file tree

Hide file tree

Showing 19 changed files with 250 additions and 171 deletions.
diff --git a/client.ts b/client.ts
@@ -23,11 +23,11 @@ export class SpotifyError extends Error {
 		super(message, options);
 	}
 
-	get url() {
+	get url(): string {
 		return this.response.url;
 	}
 
-	get status() {
+	get status(): number {
 		return this.response.status;
 	}
 }
@@ -142,7 +142,7 @@ export class SpotifyClient implements HTTPClient {
 			: "https://api.spotify.com/";
 	}
 
-	fetch(path: string, opts: FetchLikeOptions = {}) {
+	fetch(path: string, opts: FetchLikeOptions = {}): Promise<Response> {
 		const url = new URL(path, this.baseUrl);
 		if (opts.query) {
 			for (const key in opts.query) {

diff --git a/endpoints/album/album.endpoints.ts b/endpoints/album/album.endpoints.ts
@@ -15,7 +15,7 @@ export const getAlbum = async (
 	client: HTTPClient,
 	albumId: string,
 	market?: string,
-) => {
+): Promise<Album> => {
 	const res = await client.fetch("/v1/albums/" + albumId, {
 		query: { market },
 	});
@@ -33,7 +33,7 @@ export const getAlbums = async (
 	client: HTTPClient,
 	albumIds: string[],
 	market?: string,
-) => {
+): Promise<Album[]> => {
 	const res = await client.fetch("/v1/albums", {
 		query: { market, ids: albumIds },
 	});
@@ -62,7 +62,7 @@ export const getAlbumTracks = async (
 	client: HTTPClient,
 	albumId: string,
 	options?: GetAlbumTrackOpts,
-) => {
+): Promise<PagingObject<SimplifiedTrack>> => {
 	const res = await client.fetch(`/v1/albums/${albumId}/tracks`, {
 		query: options,
 	});
@@ -88,7 +88,7 @@ export type GetSavedAlbumsOpts = Prettify<
 export const getSavedAlbums = async (
 	client: HTTPClient,
 	options?: GetSavedAlbumsOpts,
-) => {
+): Promise<PagingObject<SavedAlbum>> => {
 	const res = await client.fetch("/v1/me/albums", { query: options });
 	return res.json() as Promise<PagingObject<SavedAlbum>>;
 };
@@ -99,7 +99,10 @@ export const getSavedAlbums = async (
  * @param client Spotify HTTPClient
  * @param albumIds List of the Spotify IDs for the albums. Maximum: 20 IDs
  */
-export const saveAlbums = (client: HTTPClient, albumIds: string[]) => {
+export const saveAlbums = (
+	client: HTTPClient,
+	albumIds: string[],
+): Promise<Response> => {
 	return client.fetch("/v1/me/albums", {
 		method: "PUT",
 		query: { ids: albumIds },
@@ -112,7 +115,10 @@ export const saveAlbums = (client: HTTPClient, albumIds: string[]) => {
  * @param client Spotify HTTPClient
  * @param albums_id The Spotify ID of the album
  */
-export const saveAlbum = (client: HTTPClient, albumId: string) => {
+export const saveAlbum = (
+	client: HTTPClient,
+	albumId: string,
+): Promise<Response> => {
 	return saveAlbums(client, [albumId]);
 };
 
@@ -122,7 +128,10 @@ export const saveAlbum = (client: HTTPClient, albumId: string) => {
  * @param client Spotify HTTPClient
  * @param albumIds List of the Spotify IDs for the albums. Maximum: 20 IDs
  */
-export const removeSavedAlbums = (client: HTTPClient, albumIds: string[]) => {
+export const removeSavedAlbums = (
+	client: HTTPClient,
+	albumIds: string[],
+): Promise<Response> => {
 	return client.fetch("/v1/me/albums", {
 		method: "DELETE",
 		query: { ids: albumIds },
@@ -135,7 +144,10 @@ export const removeSavedAlbums = (client: HTTPClient, albumIds: string[]) => {
  * @param client Spotify HTTPClient
  * @param albumId The Spotify ID of the album
  */
-export const removeSavedAlbum = (client: HTTPClient, albumId: string) => {
+export const removeSavedAlbum = (
+	client: HTTPClient,
+	albumId: string,
+): Promise<Response> => {
 	return removeSavedAlbums(client, [albumId]);
 };
 
@@ -148,7 +160,7 @@ export const removeSavedAlbum = (client: HTTPClient, albumId: string) => {
 export const checkIfAlbumsSaved = async (
 	client: HTTPClient,
 	albumIds: string[],
-) => {
+): Promise<boolean[]> => {
 	const res = await client.fetch("/v1/me/albums/contains", {
 		query: { ids: albumIds },
 	});
@@ -164,7 +176,7 @@ export const checkIfAlbumsSaved = async (
 export const checkIfAlbumSaved = async (
 	client: HTTPClient,
 	albumId: string,
-) => {
+): Promise<boolean> => {
 	return (await checkIfAlbumsSaved(client, [albumId]))[0]!;
 };
 
@@ -188,7 +200,7 @@ export type GetNewReleasesOpts = Prettify<
 export const getNewReleases = async (
 	client: HTTPClient,
 	options?: GetNewReleasesOpts,
-) => {
+): Promise<PagingObject<SimplifiedAlbum>> => {
 	const res = await client.fetch("/v1/browse/new-releases", { query: options });
 	return ((await res.json()) as { albums: PagingObject<SimplifiedAlbum> })
 		.albums;

diff --git a/endpoints/artist/artist.endpoints.ts b/endpoints/artist/artist.endpoints.ts
@@ -11,7 +11,10 @@ import type { Artist } from "./artist.types.ts";
  * @param client Spotify HTTPClient
  * @param artistId Spotify artist ID
  */
-export const getArtist = async (client: HTTPClient, artistId: string) => {
+export const getArtist = async (
+	client: HTTPClient,
+	artistId: string,
+): Promise<Artist> => {
 	const res = await client.fetch("/v1/artists/" + artistId);
 	return res.json() as Promise<Artist>;
 };
@@ -25,7 +28,7 @@ export const getArtist = async (client: HTTPClient, artistId: string) => {
 export const getArtists = async (
 	client: HTTPClient,
 	artistIds: string[],
-) => {
+): Promise<Artist[]> => {
 	const res = await client.fetch("/v1/artists", { query: { ids: artistIds } });
 	return ((await res.json()) as { artists: Artist[] }).artists;
 };
@@ -55,7 +58,7 @@ export const getArtistAlbums = async (
 	client: HTTPClient,
 	artistId: string,
 	options?: GetArtistAlbumsOpts,
-) => {
+): Promise<PagingObject<SimplifiedAlbum>> => {
 	const res = await client.fetch(`/v1/artists/${artistId}/albums`, {
 		query: options,
 	});
@@ -73,7 +76,7 @@ export const getArtistTopTracks = async (
 	client: HTTPClient,
 	artistId: string,
 	market?: string,
-) => {
+): Promise<Track[]> => {
 	const res = await client.fetch(`/v1/artists/${artistId}/top-tracks`, {
 		query: { market },
 	});
@@ -90,7 +93,7 @@ export const getArtistTopTracks = async (
 export const getArtistRelatedArtists = async (
 	client: HTTPClient,
 	artistId: string,
-) => {
+): Promise<Artist[]> => {
 	const res = await client.fetch(`/v1/artists/${artistId}/related-artists`);
 	return ((await res.json()) as { artists: Artist[] }).artists;
 };
diff --git a/endpoints/audiobook/audiobook.endpoints.ts b/endpoints/audiobook/audiobook.endpoints.ts
@@ -2,7 +2,7 @@ import type { SimplifiedChapter } from "../chapter/chapter.types.ts";
 import type { HTTPClient } from "../../client.ts";
 import type { Prettify } from "../../shared.ts";
 import type { PagingObject, PagingOptions } from "../general.types.ts";
-import type { Audiobook, SimplifiedAudiobook } from "./audiobook.types.ts";
+import type { Audiobook, SavedAudiobook } from "./audiobook.types.ts";
 
 /**
  * Get Spotify catalog information for a single Audiobook.
@@ -15,7 +15,7 @@ export const getAudiobook = async (
 	client: HTTPClient,
 	audiobookId: string,
 	market?: string,
-) => {
+): Promise<Audiobook> => {
 	const res = await client.fetch("/v1/audiobooks/" + audiobookId, {
 		query: { market },
 	});
@@ -33,7 +33,7 @@ export const getAudiobooks = async (
 	client: HTTPClient,
 	audiobookIds: string[],
 	market?: string,
-) => {
+): Promise<Audiobook[]> => {
 	const res = await client.fetch("/v1/audiobooks", {
 		query: { market, ids: audiobookIds },
 	});
@@ -62,7 +62,7 @@ export const getAudiobookChapters = async (
 	client: HTTPClient,
 	audiobookId: string,
 	options?: GetAudiobookChapterOpts,
-) => {
+): Promise<PagingObject<SimplifiedChapter>> => {
 	const res = await client.fetch(`/v1/audiobooks/${audiobookId}/chapters`, {
 		query: options,
 	});
@@ -88,20 +88,9 @@ export type GetSavedAudiobooksOpts = Prettify<
 export const getSavedAudiobooks = async (
 	client: HTTPClient,
 	options?: GetSavedAudiobooksOpts,
-) => {
+): Promise<PagingObject<SavedAudiobook>> => {
 	const res = await client.fetch("/v1/me/audiobooks", { query: options });
-	return res.json() as Promise<
-		PagingObject<{
-			/**
-			 * The date and time the audiobook was saved Timestamps are returned in ISO 8601 format as Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ.
-			 */
-			added_at: string;
-			/**
-			 * Information about the audiobook.
-			 */
-			audiobook: SimplifiedAudiobook;
-		}>
-	>;
+	return res.json() as Promise<PagingObject<SavedAudiobook>>;
 };
 
 /**
@@ -113,7 +102,7 @@ export const getSavedAudiobooks = async (
 export const saveAudiobooks = (
 	client: HTTPClient,
 	audiobookIds: string[],
-) => {
+): Promise<Response> => {
 	return client.fetch("/v1/me/audiobooks", {
 		method: "PUT",
 		query: { ids: audiobookIds },
@@ -129,7 +118,7 @@ export const saveAudiobooks = (
 export const saveAudiobook = (
 	client: HTTPClient,
 	audiobookId: string,
-) => {
+): Promise<Response> => {
 	return saveAudiobooks(client, [audiobookId]);
 };
 
@@ -142,7 +131,7 @@ export const saveAudiobook = (
 export const removeSavedAudiobooks = (
 	client: HTTPClient,
 	audiobookIds: string[],
-) => {
+): Promise<Response> => {
 	return client.fetch("/v1/me/audiobooks", {
 		method: "DELETE",
 		query: { ids: audiobookIds },
@@ -158,7 +147,7 @@ export const removeSavedAudiobooks = (
 export const removeSavedAudiobook = (
 	client: HTTPClient,
 	audiobookId: string,
-) => {
+): Promise<Response> => {
 	return removeSavedAudiobooks(client, [audiobookId]);
 };
 
@@ -171,7 +160,7 @@ export const removeSavedAudiobook = (
 export const checkIfAudiobooksSaved = async (
 	client: HTTPClient,
 	audiobookIds: string[],
-) => {
+): Promise<boolean[]> => {
 	const res = await client.fetch("/v1/me/audiobooks/contains", {
 		query: { ids: audiobookIds },
 	});
@@ -187,6 +176,6 @@ export const checkIfAudiobooksSaved = async (
 export const checkIfAudiobookSaved = async (
 	client: HTTPClient,
 	audiobookId: string,
-) => {
+): Promise<boolean> => {
 	return (await checkIfAudiobooksSaved(client, [audiobookId]))[0]!;
 };
diff --git a/endpoints/audiobook/audiobook.types.ts b/endpoints/audiobook/audiobook.types.ts
@@ -90,3 +90,14 @@ export interface Audiobook extends SimplifiedAudiobook {
 	 */
 	chapters: PagingObject<SimplifiedChapter>;
 }
+
+export type SavedAudiobook = {
+	/**
+	 * The date and time the audiobook was saved Timestamps are returned in ISO 8601 format as Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ.
+	 */
+	added_at: string;
+	/**
+	 * Information about the audiobook.
+	 */
+	audiobook: SimplifiedAudiobook;
+};
diff --git a/endpoints/category/category.endpoints.ts b/endpoints/category/category.endpoints.ts
@@ -40,7 +40,7 @@ export type GetBrowseCategoriesOpts = {
 export const getBrowseCategories = async (
 	client: HTTPClient,
 	options?: GetBrowseCategoriesOpts,
-) => {
+): Promise<PagingObject<Category>> => {
 	const res = await client.fetch("/v1/browse/categories", {
 		query: options,
 	});
@@ -73,7 +73,7 @@ export const getBrowseCategory = async (
 	client: HTTPClient,
 	categoryId: string,
 	options?: GetBrowseCategoryOpts,
-) => {
+): Promise<Category> => {
 	const res = await client.fetch("/v1/browse/categories/" + categoryId, {
 		query: options,
 	});

diff --git a/endpoints/chapter/chapter.endpoints.ts b/endpoints/chapter/chapter.endpoints.ts
@@ -10,7 +10,7 @@ export const getChapter = async (
 	client: HTTPClient,
 	chapterId: string,
 	market?: string,
-) => {
+): Promise<Chapter> => {
 	const res = await client.fetch("/v1/chapters/" + chapterId, {
 		query: { market },
 	});
@@ -27,7 +27,7 @@ export const getChapters = async (
 	client: HTTPClient,
 	chapterIds: string[],
 	market?: string,
-) => {
+): Promise<Chapter[]> => {
 	const res = await client.fetch("/v1/chapters", {
 		query: { market, ids: chapterIds },
 	});