@quranjs/api 1.5.0 → 1.6.0

package/dist/sdk/index.d.ts

@@ -60,6 +60,18 @@ declare const quran: {
                 page: number;
                 perPage: number;
             }> | undefined) => Promise<import("..").Verse[]>;
+            findByHizb: (hizb: import("..").HizbNumber, options?: Partial<{
+                language: import("..").Language;
+                reciter: string | number;
+                words: boolean;
+                translations: string[] | number[];
+                tafsirs: string[] | number[];
+                wordFields: Partial<Record<import("..").WordField, boolean>>;
+                translationFields: Partial<Record<import("..").TranslationField, boolean>>;
+                fields: Partial<Record<import("..").VerseField, boolean>>;
+                page: number;
+                perPage: number;
+            }> | undefined) => Promise<import("..").Verse[]>;
             findRandom: (options?: Partial<{
                 language: import("..").Language;
                 reciter: string | number;

package/dist/sdk/utils.d.ts

@@ -1,4 +1,4 @@
-export declare const versesMaping: {
+export declare const versesMapping: {
     '1': number;
     '2': number;
     '3': number;

package/dist/sdk/v4/index.d.ts

@@ -59,6 +59,18 @@ declare const v4: {
             page: number;
             perPage: number;
         }> | undefined) => Promise<import("../..").Verse[]>;
+        findByHizb: (hizb: import("../..").HizbNumber, options?: Partial<{
+            language: import("../..").Language;
+            reciter: string | number;
+            words: boolean;
+            translations: string[] | number[];
+            tafsirs: string[] | number[];
+            wordFields: Partial<Record<import("../..").WordField, boolean>>;
+            translationFields: Partial<Record<import("../..").TranslationField, boolean>>;
+            fields: Partial<Record<import("../..").VerseField, boolean>>;
+            page: number;
+            perPage: number;
+        }> | undefined) => Promise<import("../..").Verse[]>;
         findRandom: (options?: Partial<{
             language: import("../..").Language;
             reciter: string | number;

package/dist/sdk/v4/verses.d.ts

@@ -1,4 +1,4 @@
-import { ChapterId, JuzNumber, Language, PageNumber, TranslationField, Verse, VerseField, VerseKey, WordField } from '../../types';
+import { ChapterId, HizbNumber, JuzNumber, Language, PageNumber, TranslationField, Verse, VerseField, VerseKey, WordField } from '../../types';
 declare const verses: {
     findByKey: (key: VerseKey, options?: Partial<{
         language: Language;
@@ -48,6 +48,18 @@ declare const verses: {
         page: number;
         perPage: number;
     }> | undefined) => Promise<Verse[]>;
+    findByHizb: (hizb: HizbNumber, options?: Partial<{
+        language: Language;
+        reciter: string | number;
+        words: boolean;
+        translations: string[] | number[];
+        tafsirs: string[] | number[];
+        wordFields: Partial<Record<WordField, boolean>>;
+        translationFields: Partial<Record<TranslationField, boolean>>;
+        fields: Partial<Record<VerseField, boolean>>;
+        page: number;
+        perPage: number;
+    }> | undefined) => Promise<Verse[]>;
     findRandom: (options?: Partial<{
         language: Language;
         reciter: string | number;

package/package.json

@@ -5,7 +5,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.5.0",
+  "version": "1.6.0",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -28,6 +28,7 @@
     "@size-limit/preset-small-lib": "^7.0.8",
     "@types/humps": "^2.0.1",
     "dts-cli": "^1.4.0",
+    "fast-check": "^3.3.0",
     "husky": "^7.0.4",
     "msw": "^0.39.2",
     "rollup-plugin-analyzer": "^4.0.0",

package/src/sdk/utils.ts

@@ -1,5 +1,5 @@
 // this maps chapterNumber to verseCount
-export const versesMaping = {
+export const versesMapping = {
   '1': 7,
   '2': 286,
   '3': 200,
@@ -211,7 +211,7 @@ const isValidVerseKey = (key: string) => {
   if (!chapterId || !verseId || !isValidChapterId(chapterId)) return false;
 
   const parsedVerse = Number(verseId);
-  const verseCount = (versesMaping as any)[chapterId];
+  const verseCount = (versesMapping as any)[chapterId];
   if (!parsedVerse || parsedVerse <= 0 || parsedVerse > verseCount)
     return false;
 

package/src/sdk/v4/verses.ts

@@ -1,6 +1,6 @@
 import {
   ChapterId,
-  // HizbNumber,
+  HizbNumber,
   JuzNumber,
   Language,
   PageNumber,
@@ -146,7 +146,6 @@ const findByJuz = async (juz: JuzNumber, options?: GetVerseOptions) => {
   return verses;
 };
 
-// TODO: uncomment when API is fixed
 /**
  * Get all ayahs for a Hizb.
  * @description https://quran.api-docs.io/v4/verses/by-hizb-number
@@ -156,15 +155,15 @@ const findByJuz = async (juz: JuzNumber, options?: GetVerseOptions) => {
  * quran.v4.verses.findByHizb('1')
  * quran.v4.verses.findByHizb('29')
  */
-// const findByHizb = async (hizb: HizbNumber, options?: GetVerseOptions) => {
-//   if (!Utils.isValidHizb(hizb)) throw new Error('Invalid hizb');
+const findByHizb = async (hizb: HizbNumber, options?: GetVerseOptions) => {
+  if (!Utils.isValidHizb(hizb)) throw new Error('Invalid hizb');
 
-//   const params = getVerseOptions(options);
-//   const url = `/verses/by_hizb/${hizb}`;
-//   const { verses } = await fetcher<{ verses: Verse[] }>(url, params);
+  const params = getVerseOptions(options);
+  const url = `/verses/by_hizb/${hizb}`;
+  const { verses } = await fetcher<{ verses: Verse[] }>(url, params);
 
-//   return verses;
-// };
+  return verses;
+};
 
 // TODO: uncomment when API is fixed
 /**
@@ -205,7 +204,7 @@ const verses = {
   findByChapter,
   findByPage,
   findByJuz,
-  // findByHizb,
+  findByHizb,
   // findByRub,
   findRandom,
 };