Skip to content

Revert argument order in v4 SDK #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 3, 2025
Merged

Revert argument order in v4 SDK #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions src/sdk/v4/audio.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ const findAllChapterRecitations = async (
reciterId: string,
options?: GetChapterRecitationOptions
) => {
const params = mergeApiOptions(defaultChapterRecitationsOptions, options);
const params = mergeApiOptions(options, defaultChapterRecitationsOptions);
const { audioFiles } = await fetcher<{ audioFiles: ChapterRecitation[] }>(
`/chapter_recitations/${reciterId}`,
params,
Expand All @@ -68,7 +68,7 @@ const findChapterRecitationById = async (
) => {
if (!Utils.isValidChapterId(chapterId)) throw new Error('Invalid chapter id');

const params = mergeApiOptions(defaultChapterRecitationsOptions, options);
const params = mergeApiOptions(options, defaultChapterRecitationsOptions);
const { audioFile } = await fetcher<{ audioFile: ChapterRecitation }>(
`/chapter_recitations/${reciterId}/${chapterId}`,
params,
Expand All @@ -94,7 +94,7 @@ const findVerseRecitationsByChapter = async (
) => {
if (!Utils.isValidChapterId(chapterId)) throw new Error('Invalid chapter id');

const params = mergeApiOptions(defaultVerseRecitationsOptions, options);
const params = mergeApiOptions(options, defaultVerseRecitationsOptions);
const data = await fetcher<{
audioFiles: VerseRecitation[];
pagination: Pagination;
Expand Down Expand Up @@ -123,7 +123,7 @@ const findVerseRecitationsByJuz = async (
) => {
if (!Utils.isValidJuz(juz)) throw new Error('Invalid juz');

const params = mergeApiOptions(defaultVerseRecitationsOptions, options);
const params = mergeApiOptions(options, defaultVerseRecitationsOptions);
const data = await fetcher<{
audioFiles: VerseRecitation[];
pagination: Pagination;
Expand All @@ -148,7 +148,7 @@ const findVerseRecitationsByPage = async (
) => {
if (!Utils.isValidQuranPage(page)) throw new Error('Invalid page');

const params = mergeApiOptions(defaultVerseRecitationsOptions, options);
const params = mergeApiOptions(options, defaultVerseRecitationsOptions);
const data = await fetcher<{
audioFiles: VerseRecitation[];
pagination: Pagination;
Expand All @@ -173,7 +173,7 @@ const findVerseRecitationsByRub = async (
) => {
if (!Utils.isValidRub(rub)) throw new Error('Invalid rub');

const params = mergeApiOptions(defaultVerseRecitationsOptions, options);
const params = mergeApiOptions(options, defaultVerseRecitationsOptions);
const data = await fetcher<{
audioFiles: VerseRecitation[];
pagination: Pagination;
Expand All @@ -198,7 +198,7 @@ const findVerseRecitationsByHizb = async (
) => {
if (!Utils.isValidHizb(hizb)) throw new Error('Invalid hizb');

const params = mergeApiOptions(defaultVerseRecitationsOptions, options);
const params = mergeApiOptions(options, defaultVerseRecitationsOptions);
const data = await fetcher<{
audioFiles: VerseRecitation[];
pagination: Pagination;
Expand All @@ -223,7 +223,7 @@ const findVerseRecitationsByKey = async (
) => {
if (!Utils.isValidVerseKey(key)) throw new Error('Invalid verse key');

const params = mergeApiOptions(defaultVerseRecitationsOptions, options);
const params = mergeApiOptions(options, defaultVerseRecitationsOptions);
const data = await fetcher<{
audioFiles: VerseRecitation[];
pagination: Pagination;
Expand Down
6 changes: 3 additions & 3 deletions src/sdk/v4/chapters.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const defaultOptions: GetChapterOptions = {
* quran.v4.chapters.findAll()
*/
const findAll = async (options?: GetChapterOptions) => {
const params = mergeApiOptions(defaultOptions, options);
const params = mergeApiOptions(options, defaultOptions);
const { chapters } = await fetcher<{ chapters: Chapter[] }>(
'/chapters',
params,
Expand All @@ -39,7 +39,7 @@ const findAll = async (options?: GetChapterOptions) => {
const findById = async (id: ChapterId, options?: GetChapterOptions) => {
if (!Utils.isValidChapterId(id)) throw new Error('Invalid chapter id');

const params = mergeApiOptions(defaultOptions, options);
const params = mergeApiOptions(options, defaultOptions);
const { chapter } = await fetcher<{ chapter: Chapter }>(
`/chapters/${id}`,
params,
Expand All @@ -61,7 +61,7 @@ const findById = async (id: ChapterId, options?: GetChapterOptions) => {
const findInfoById = async (id: ChapterId, options?: GetChapterOptions) => {
if (!Utils.isValidChapterId(id)) throw new Error('Invalid chapter id');

const params = mergeApiOptions(defaultOptions, options);
const params = mergeApiOptions(options, defaultOptions);
const { chapterInfo } = await fetcher<{ chapterInfo: ChapterInfo }>(
`/chapters/${id}/info`,
params,
Expand Down
18 changes: 9 additions & 9 deletions src/sdk/v4/resources.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ const findAllRecitations = async (options?: GetResourceOptions) => {
* quran.v4.resources.findRecitationInfo('1')
*/
const findRecitationInfo = async (id: string, options?: GetResourceOptions) => {
const params = mergeApiOptions(defaultOptions, options);
const params = mergeApiOptions(options, defaultOptions);
const { info } = await fetcher<{
info: RecitationInfoResource;
}>(`/resources/recitations/${id}/info`, params, options?.fetchFn);
Expand All @@ -62,7 +62,7 @@ const findRecitationInfo = async (id: string, options?: GetResourceOptions) => {
* quran.v4.resources.findAllTranslations()
*/
const findAllTranslations = async (options?: GetResourceOptions) => {
const params = mergeApiOptions(defaultOptions, options);
const params = mergeApiOptions(options, defaultOptions);
const { translations } = await fetcher<{
translations: TranslationResource[];
}>('/resources/translations', params, options?.fetchFn);
Expand All @@ -82,7 +82,7 @@ const findTranslationInfo = async (
id: string,
options?: GetResourceOptions
) => {
const params = mergeApiOptions(defaultOptions, options);
const params = mergeApiOptions(options, defaultOptions);
const { info } = await fetcher<{
info: TranslationInfoResource;
}>(`/resources/translations/${id}/info`, params, options?.fetchFn);
Expand All @@ -98,7 +98,7 @@ const findTranslationInfo = async (
* quran.v4.resources.findAllTafsirs()
*/
const findAllTafsirs = async (options?: GetResourceOptions) => {
const params = mergeApiOptions(defaultOptions, options);
const params = mergeApiOptions(options, defaultOptions);
const { tafsirs } = await fetcher<{
tafsirs: TafsirResource[];
}>('/resources/tafsirs', params, options?.fetchFn);
Expand All @@ -115,7 +115,7 @@ const findAllTafsirs = async (options?: GetResourceOptions) => {
* quran.v4.resources.findTafsirInfo('1')
*/
const findTafsirInfo = async (id: string, options?: GetResourceOptions) => {
const params = mergeApiOptions(defaultOptions, options);
const params = mergeApiOptions(options, defaultOptions);
const { info } = await fetcher<{
info: TafsirInfoResource;
}>(`/resources/tafsirs/${id}/info`, params, options?.fetchFn);
Expand Down Expand Up @@ -147,7 +147,7 @@ const findAllRecitationStyles = async (
* quran.v4.resources.findAllLanguages()
*/
const findAllLanguages = async (options?: GetResourceOptions) => {
const params = mergeApiOptions(defaultOptions, options);
const params = mergeApiOptions(options, defaultOptions);
const { languages } = await fetcher<{
languages: LanguageResource[];
}>('/resources/languages', params, options?.fetchFn);
Expand All @@ -163,7 +163,7 @@ const findAllLanguages = async (options?: GetResourceOptions) => {
* quran.v4.resources.findAllChapterInfos()
*/
const findAllChapterInfos = async (options?: GetResourceOptions) => {
const params = mergeApiOptions(defaultOptions, options);
const params = mergeApiOptions(options, defaultOptions);
const { chapterInfos } = await fetcher<{
chapterInfos: ChapterInfoResource[];
}>('/resources/chapter_infos', params, options?.fetchFn);
Expand All @@ -179,7 +179,7 @@ const findAllChapterInfos = async (options?: GetResourceOptions) => {
* quran.v4.resources.findVerseMedia()
*/
const findVerseMedia = async (options?: GetResourceOptions) => {
const params = mergeApiOptions(defaultOptions, options);
const params = mergeApiOptions(options, defaultOptions);
const { verseMedia } = await fetcher<{
verseMedia: VerseMediaResource;
}>(`/resources/verse_media`, params, options?.fetchFn);
Expand All @@ -195,7 +195,7 @@ const findVerseMedia = async (options?: GetResourceOptions) => {
* quran.v4.resources.findAllChapterReciters()
*/
const findAllChapterReciters = async (options?: GetResourceOptions) => {
const params = mergeApiOptions(defaultOptions, options);
const params = mergeApiOptions(options, defaultOptions);
const { reciters } = await fetcher<{
reciters: ChapterReciterResource[];
}>(`/resources/chapter_reciters`, params, options?.fetchFn);
Expand Down
2 changes: 1 addition & 1 deletion src/sdk/v4/search.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ const defaultSearchOptions: SearchOptions = {
* quran.v4.search.search('نور', { language: Language.ENGLISH, page: 2 })
*/
const search = async (q: string, options?: SearchOptions) => {
const params = mergeApiOptions(defaultSearchOptions, { q, ...options });
const params = mergeApiOptions({ q, ...options }, defaultSearchOptions);
const { search } = await fetcher<SearchResponse>(
'/search',
params,
Expand Down
2 changes: 1 addition & 1 deletion src/sdk/v4/verses.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ const defaultOptions: GetVerseOptions = {
};

const mergeVerseOptions = (options: GetVerseOptions = {}) => {
const result = mergeApiOptions(defaultOptions, options);
const result = mergeApiOptions(options, defaultOptions);

// @ts-expect-error - we accept an array of strings, however, the API expects a comma separated string
if (result.translations) result.translations = result.translations.join(',');
Expand Down