@quranjs/api 3.6.0 → 3.8.0

package/dist/{verses-BHef2eGb.d.ts → verses-BntMzz-0.d.ts}

@@ -350,7 +350,7 @@ interface ChapterReciterResource {
     format?: string;
     filesSize?: number;
 }
-type ContentSyncResourceGroup = "articles" | "mushafs" | "recitations" | "tafsirs" | "translations" | "word_by_word_translations";
+type ContentSyncResourceGroup = "articles" | "chapter_recitations" | "mushafs" | "recitations" | "tafsirs" | "translations" | "word_by_word_transliterations" | "word_by_word_translations";
 interface MushafMetadataSnapshotRecord extends Record<string, unknown> {
     recordType: "mushaf";
     id: number;
@@ -428,9 +428,19 @@ interface WordByWordTranslationSnapshotRecord extends Record<string, unknown> {
     priority: number | null;
     updatedAt: string;
 }
+interface WordByWordTransliterationSnapshotRecord extends Record<string, unknown> {
+    id: number;
+    resourceContentId: number;
+    resourceId: number;
+    wordId: number;
+    languageId: number;
+    languageName: string | null;
+    text: string | null;
+    updatedAt: string;
+}
 type ContentSyncMutationType = "RESOURCE_CREATE" | "RESOURCE_UPDATE" | "RESOURCE_DELETE" | "ROW_CREATE" | "ROW_UPDATE" | "ROW_DELETE" | "RESOURCE_INVALIDATE";
 interface ContentSyncOptions extends ApiParams {
-    /** Resource filter, e.g. `articles:*;mushafs:1;translations:1,6;word_by_word_translations:85`. */
+    /** Resource filter, e.g. `articles:*;mushafs:1;translations:1,6;word_by_word_transliterations:60`. */
     resources?: string;
     /** Set to true for the initial sync. */
     bootstrap?: boolean;
@@ -972,7 +982,7 @@ declare class QuranResources {
      * @example
      * client.resources.sync({
      *   bootstrap: true,
-     *   resources: "mushafs:1;translations:19;word_by_word_translations:85"
+     *   resources: "mushafs:1;translations:19;word_by_word_transliterations:60"
      * })
      */
     sync<TData extends Record<string, unknown> = Record<string, unknown>>(options?: ContentSyncOptions): Promise<ContentSyncResponse<TData>>;
@@ -982,7 +992,7 @@ declare class QuranResources {
      * @param {string | number} id
      * @param {ContentResourceSnapshotOptions} options
      * @example
-     * client.resources.findSnapshot("mushafs", 1)
+     * client.resources.findSnapshot("word_by_word_transliterations", 60)
      */
     findSnapshot<TRecord extends Record<string, unknown> = Record<string, unknown>>(resourceGroup: ContentSyncResourceGroup, id: string | number, options?: ContentResourceSnapshotOptions): Promise<ContentResourceSnapshot<TRecord>>;
 }
@@ -1090,4 +1100,4 @@ declare class QuranVerses {
     findRandom(options?: GetVerseOptions): Promise<Verse>;
 }
 
-export { type VerseMediaResource as $, type Answer as A, type Translation as B, type ChapterId as C, type Transliteration as D, type Verse as E, CharType as F, type Juz as G, type HizbNumber as H, type Pagination as I, type JuzNumber as J, type RecitationResource as K, type RecitationInfoResource as L, type TranslationResource as M, type NormalizedVerseRecitation as N, type TranslationInfoResource as O, type PageNumber as P, QuranChapters as Q, type RubNumber as R, type SearchResponse as S, type TranslatedName as T, type TafsirResource as U, type VerseKey as V, type Word as W, type TafsirInfoResource as X, type RecitationStylesResource as Y, type LanguageResource as Z, type ChapterInfoResource as _, QuranAnswers as a, type ChapterReciterResource as a0, type ContentSyncResourceGroup as a1, type MushafMetadataSnapshotRecord as a2, type MushafPageSnapshotRecord as a3, type MushafFontAssetSnapshotRecord as a4, type MushafWordSnapshotRecord as a5, type MushafSnapshotRecord as a6, type WordByWordTranslationSnapshotRecord as a7, type ContentSyncMutationType as a8, type ContentSyncOptions as a9, type ContentResourceSnapshotOptions as aa, type ContentSyncMutation as ab, type ContentSyncResponse as ac, type ContentResourceSnapshot as ad, SearchNavigationType as ae, type SearchResult as af, type AnalyticsJsonValue as ag, type AnalyticsEvent as ah, type AnalyticsBatchRequest as ai, type AnalyticsBatchAccepted as aj, QuranVerses as b, QuranJuzs as c, QuranAudio as d, QuranHadithReferences as e, QuranResources as f, QuranSearch as g, type AnswerQuestion as h, type AnswersByAyahResponse as i, type AnswerCount as j, type AnswerCountWithinRangeResponse as k, type ChapterRecitation as l, type VerseRecitation as m, type AudioResponse as n, type Chapter as o, type ChapterInfo as p, type ChapterInfoResponse as q, type HadithReference as r, type HadithReferencesByAyahResponse as s, type HadithGrade as t, type HadithContent as u, type Hadith as v, type HadithsByAyahResponse as w, type HadithCountWithinRangeResponse as x, type Segment as y, type Tafsir as z };
+export { type VerseMediaResource as $, type Answer as A, type Translation as B, type ChapterId as C, type Transliteration as D, type Verse as E, CharType as F, type Juz as G, type HizbNumber as H, type Pagination as I, type JuzNumber as J, type RecitationResource as K, type RecitationInfoResource as L, type TranslationResource as M, type NormalizedVerseRecitation as N, type TranslationInfoResource as O, type PageNumber as P, QuranChapters as Q, type RubNumber as R, type SearchResponse as S, type TranslatedName as T, type TafsirResource as U, type VerseKey as V, type Word as W, type TafsirInfoResource as X, type RecitationStylesResource as Y, type LanguageResource as Z, type ChapterInfoResource as _, QuranAnswers as a, type ChapterReciterResource as a0, type ContentSyncResourceGroup as a1, type MushafMetadataSnapshotRecord as a2, type MushafPageSnapshotRecord as a3, type MushafFontAssetSnapshotRecord as a4, type MushafWordSnapshotRecord as a5, type MushafSnapshotRecord as a6, type WordByWordTranslationSnapshotRecord as a7, type WordByWordTransliterationSnapshotRecord as a8, type ContentSyncMutationType as a9, type ContentSyncOptions as aa, type ContentResourceSnapshotOptions as ab, type ContentSyncMutation as ac, type ContentSyncResponse as ad, type ContentResourceSnapshot as ae, SearchNavigationType as af, type SearchResult as ag, type AnalyticsJsonValue as ah, type AnalyticsEvent as ai, type AnalyticsBatchRequest as aj, type AnalyticsBatchAccepted as ak, QuranVerses as b, QuranJuzs as c, QuranAudio as d, QuranHadithReferences as e, QuranResources as f, QuranSearch as g, type AnswerQuestion as h, type AnswersByAyahResponse as i, type AnswerCount as j, type AnswerCountWithinRangeResponse as k, type ChapterRecitation as l, type VerseRecitation as m, type AudioResponse as n, type Chapter as o, type ChapterInfo as p, type ChapterInfoResponse as q, type HadithReference as r, type HadithReferencesByAyahResponse as s, type HadithGrade as t, type HadithContent as u, type Hadith as v, type HadithsByAyahResponse as w, type HadithCountWithinRangeResponse as x, type Segment as y, type Tafsir as z };

package/dist/{verses-DTgS2dgL.d.mts → verses-C6_rZ3t8.d.mts}

@@ -350,7 +350,7 @@ interface ChapterReciterResource {
     format?: string;
     filesSize?: number;
 }
-type ContentSyncResourceGroup = "articles" | "mushafs" | "recitations" | "tafsirs" | "translations" | "word_by_word_translations";
+type ContentSyncResourceGroup = "articles" | "chapter_recitations" | "mushafs" | "recitations" | "tafsirs" | "translations" | "word_by_word_transliterations" | "word_by_word_translations";
 interface MushafMetadataSnapshotRecord extends Record<string, unknown> {
     recordType: "mushaf";
     id: number;
@@ -428,9 +428,19 @@ interface WordByWordTranslationSnapshotRecord extends Record<string, unknown> {
     priority: number | null;
     updatedAt: string;
 }
+interface WordByWordTransliterationSnapshotRecord extends Record<string, unknown> {
+    id: number;
+    resourceContentId: number;
+    resourceId: number;
+    wordId: number;
+    languageId: number;
+    languageName: string | null;
+    text: string | null;
+    updatedAt: string;
+}
 type ContentSyncMutationType = "RESOURCE_CREATE" | "RESOURCE_UPDATE" | "RESOURCE_DELETE" | "ROW_CREATE" | "ROW_UPDATE" | "ROW_DELETE" | "RESOURCE_INVALIDATE";
 interface ContentSyncOptions extends ApiParams {
-    /** Resource filter, e.g. `articles:*;mushafs:1;translations:1,6;word_by_word_translations:85`. */
+    /** Resource filter, e.g. `articles:*;mushafs:1;translations:1,6;word_by_word_transliterations:60`. */
     resources?: string;
     /** Set to true for the initial sync. */
     bootstrap?: boolean;
@@ -972,7 +982,7 @@ declare class QuranResources {
      * @example
      * client.resources.sync({
      *   bootstrap: true,
-     *   resources: "mushafs:1;translations:19;word_by_word_translations:85"
+     *   resources: "mushafs:1;translations:19;word_by_word_transliterations:60"
      * })
      */
     sync<TData extends Record<string, unknown> = Record<string, unknown>>(options?: ContentSyncOptions): Promise<ContentSyncResponse<TData>>;
@@ -982,7 +992,7 @@ declare class QuranResources {
      * @param {string | number} id
      * @param {ContentResourceSnapshotOptions} options
      * @example
-     * client.resources.findSnapshot("mushafs", 1)
+     * client.resources.findSnapshot("word_by_word_transliterations", 60)
      */
     findSnapshot<TRecord extends Record<string, unknown> = Record<string, unknown>>(resourceGroup: ContentSyncResourceGroup, id: string | number, options?: ContentResourceSnapshotOptions): Promise<ContentResourceSnapshot<TRecord>>;
 }
@@ -1090,4 +1100,4 @@ declare class QuranVerses {
     findRandom(options?: GetVerseOptions): Promise<Verse>;
 }
 
-export { type VerseMediaResource as $, type Answer as A, type Translation as B, type ChapterId as C, type Transliteration as D, type Verse as E, CharType as F, type Juz as G, type HizbNumber as H, type Pagination as I, type JuzNumber as J, type RecitationResource as K, type RecitationInfoResource as L, type TranslationResource as M, type NormalizedVerseRecitation as N, type TranslationInfoResource as O, type PageNumber as P, QuranChapters as Q, type RubNumber as R, type SearchResponse as S, type TranslatedName as T, type TafsirResource as U, type VerseKey as V, type Word as W, type TafsirInfoResource as X, type RecitationStylesResource as Y, type LanguageResource as Z, type ChapterInfoResource as _, QuranAnswers as a, type ChapterReciterResource as a0, type ContentSyncResourceGroup as a1, type MushafMetadataSnapshotRecord as a2, type MushafPageSnapshotRecord as a3, type MushafFontAssetSnapshotRecord as a4, type MushafWordSnapshotRecord as a5, type MushafSnapshotRecord as a6, type WordByWordTranslationSnapshotRecord as a7, type ContentSyncMutationType as a8, type ContentSyncOptions as a9, type ContentResourceSnapshotOptions as aa, type ContentSyncMutation as ab, type ContentSyncResponse as ac, type ContentResourceSnapshot as ad, SearchNavigationType as ae, type SearchResult as af, type AnalyticsJsonValue as ag, type AnalyticsEvent as ah, type AnalyticsBatchRequest as ai, type AnalyticsBatchAccepted as aj, QuranVerses as b, QuranJuzs as c, QuranAudio as d, QuranHadithReferences as e, QuranResources as f, QuranSearch as g, type AnswerQuestion as h, type AnswersByAyahResponse as i, type AnswerCount as j, type AnswerCountWithinRangeResponse as k, type ChapterRecitation as l, type VerseRecitation as m, type AudioResponse as n, type Chapter as o, type ChapterInfo as p, type ChapterInfoResponse as q, type HadithReference as r, type HadithReferencesByAyahResponse as s, type HadithGrade as t, type HadithContent as u, type Hadith as v, type HadithsByAyahResponse as w, type HadithCountWithinRangeResponse as x, type Segment as y, type Tafsir as z };
+export { type VerseMediaResource as $, type Answer as A, type Translation as B, type ChapterId as C, type Transliteration as D, type Verse as E, CharType as F, type Juz as G, type HizbNumber as H, type Pagination as I, type JuzNumber as J, type RecitationResource as K, type RecitationInfoResource as L, type TranslationResource as M, type NormalizedVerseRecitation as N, type TranslationInfoResource as O, type PageNumber as P, QuranChapters as Q, type RubNumber as R, type SearchResponse as S, type TranslatedName as T, type TafsirResource as U, type VerseKey as V, type Word as W, type TafsirInfoResource as X, type RecitationStylesResource as Y, type LanguageResource as Z, type ChapterInfoResource as _, QuranAnswers as a, type ChapterReciterResource as a0, type ContentSyncResourceGroup as a1, type MushafMetadataSnapshotRecord as a2, type MushafPageSnapshotRecord as a3, type MushafFontAssetSnapshotRecord as a4, type MushafWordSnapshotRecord as a5, type MushafSnapshotRecord as a6, type WordByWordTranslationSnapshotRecord as a7, type WordByWordTransliterationSnapshotRecord as a8, type ContentSyncMutationType as a9, type ContentSyncOptions as aa, type ContentResourceSnapshotOptions as ab, type ContentSyncMutation as ac, type ContentSyncResponse as ad, type ContentResourceSnapshot as ae, SearchNavigationType as af, type SearchResult as ag, type AnalyticsJsonValue as ah, type AnalyticsEvent as ai, type AnalyticsBatchRequest as aj, type AnalyticsBatchAccepted as ak, QuranVerses as b, QuranJuzs as c, QuranAudio as d, QuranHadithReferences as e, QuranResources as f, QuranSearch as g, type AnswerQuestion as h, type AnswersByAyahResponse as i, type AnswerCount as j, type AnswerCountWithinRangeResponse as k, type ChapterRecitation as l, type VerseRecitation as m, type AudioResponse as n, type Chapter as o, type ChapterInfo as p, type ChapterInfoResponse as q, type HadithReference as r, type HadithReferencesByAyahResponse as s, type HadithGrade as t, type HadithContent as u, type Hadith as v, type HadithsByAyahResponse as w, type HadithCountWithinRangeResponse as x, type Segment as y, type Tafsir as z };

package/package.json

@@ -11,7 +11,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "3.6.0",
+  "version": "3.8.0",
   "main": "dist/index.min.js",
   "module": "dist/index.min.mjs",
   "types": "dist/index.d.ts",
@@ -57,9 +57,9 @@
     "tsup": "^8.5.0",
     "typescript": "^5.9.2",
     "vitest": "^3.2.4",
-    "@quranjs/tsconfig": "0.1.0",
     "@quranjs/eslint-config": "0.3.0",
-    "@quranjs/prettier-config": "0.1.0"
+    "@quranjs/prettier-config": "0.1.0",
+    "@quranjs/tsconfig": "0.1.0"
   },
   "prettier": "@quranjs/prettier-config",
   "size-limit": [