@quranjs/api 3.2.1 → 3.4.0

package/dist/{verses-CFFeqPDX.d.mts → verses-C_LN5-Sn.d.mts}

@@ -1,4 +1,4 @@
-import { e as QuranFetchClient, B as BaseApiParams, b as VerseRecitationField, d as SearchParams, P as PaginationParams, W as WordField, T as TranslationField, V as VerseField } from './index-BZgqOfA4.mjs';
+import { A as ApiParams, e as QuranFetchClient, B as BaseApiParams, b as VerseRecitationField, d as SearchParams, P as PaginationParams, W as WordField, T as TranslationField, V as VerseField } from './index-BgoJducH.mjs';
 
 /**
  * Maps chapter number to verse count
@@ -197,6 +197,36 @@ interface SearchResponse {
     };
 }
 
+interface Answer {
+    id: string | number;
+    body: string;
+    answeredBy?: string;
+    status: string;
+    language?: string;
+}
+interface AnswerQuestion {
+    id: string | number;
+    body: string;
+    type: string;
+    ranges: VerseKey[];
+    surah: number;
+    theme?: string[];
+    summary?: string;
+    references?: string[];
+    language?: string;
+    status: string;
+    answers: Answer[];
+}
+interface AnswersByAyahResponse {
+    questions: AnswerQuestion[];
+    totalCount?: number;
+}
+interface AnswerCount {
+    types?: Record<string, number>;
+    total: number;
+}
+type AnswerCountWithinRangeResponse = Record<string, AnswerCount>;
+
 /**
  * Segment structure is [wordFrom, wordTo, timeFrom, timeTo] time is in ms
  */
@@ -320,6 +350,52 @@ interface ChapterReciterResource {
     format?: string;
     filesSize?: number;
 }
+type ContentSyncResourceGroup = "articles" | "recitations" | "tafsirs" | "translations";
+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:*;translations:1,6`. */
+    resources?: string;
+    /** Set to true for the initial sync. */
+    bootstrap?: boolean;
+    /** Token returned by the final bootstrap or incremental page. */
+    syncToken?: string;
+    /** Pagination cursor from `nextPageUrl`. */
+    cursor?: string;
+    /** Page size, up to the API maximum. */
+    perPage?: number;
+}
+type ContentResourceSnapshotOptions = ApiParams;
+interface ContentSyncMutation<TData extends Record<string, unknown> = Record<string, unknown>> {
+    sequence: number;
+    type: ContentSyncMutationType;
+    resourceGroup: ContentSyncResourceGroup;
+    resourceId: number;
+    resourceContentId: number | null;
+    recordType: string | null;
+    recordKey: string | null;
+    sourceRecordId: number | null;
+    changedAt: string;
+    data: TData | null;
+    snapshotUrl: string | null;
+    unavailableReason: string | null;
+}
+interface ContentSyncResponse<TData extends Record<string, unknown> = Record<string, unknown>> {
+    sync: {
+        syncUntilSequence: number;
+        hasMore: boolean;
+        nextPageUrl: string | null;
+        nextSyncToken: string | null;
+        mutations: ContentSyncMutation<TData>[];
+    };
+}
+interface ContentResourceSnapshot<TRecord extends Record<string, unknown> = Record<string, unknown>> {
+    resourceGroup: ContentSyncResourceGroup;
+    resourceId: number;
+    resourceContentId: number | null;
+    schemaVersion: number;
+    syncSequence: number;
+    records: TRecord[];
+}
 
 interface ChapterInfo {
     id: number;
@@ -494,6 +570,43 @@ interface Pagination {
     totalRecords: number;
 }
 
+type GetAnswersByAyahOptions = BaseApiParams & {
+    page?: number;
+    pageSize?: number;
+};
+type CountAnswersWithinRangeOptions = BaseApiParams;
+/**
+ * Quran answers API methods.
+ */
+declare class QuranAnswers {
+    private fetcher;
+    constructor(fetcher: QuranFetchClient);
+    /**
+     * Get published answer questions linked to a specific ayah.
+     * @param {VerseKey} key verse key in format "chapter:verse" (e.g., "2:255")
+     * @param {GetAnswersByAyahOptions} options
+     * @example
+     * client.answers.findByAyah("2:255", { page: 1, pageSize: 2 })
+     */
+    findByAyah(key: VerseKey, options?: GetAnswersByAyahOptions): Promise<AnswersByAyahResponse>;
+    /**
+     * Get a published answer question by id.
+     * @param {string | number} questionId question id
+     * @example
+     * client.answers.findByQuestionId("988")
+     */
+    findByQuestionId(questionId: string | number): Promise<AnswerQuestion>;
+    /**
+     * Get a verse-key to answer-count map within an inclusive ayah range.
+     * @param {VerseKey} from start verse key in format "chapter:verse"
+     * @param {VerseKey} to end verse key in format "chapter:verse"
+     * @param {CountAnswersWithinRangeOptions} options
+     * @example
+     * client.answers.countWithinRange("2:255", "2:256")
+     */
+    countWithinRange(from: VerseKey, to: VerseKey, options?: CountAnswersWithinRangeOptions): Promise<AnswerCountWithinRangeResponse>;
+}
+
 type GetChapterRecitationOptions = BaseApiParams;
 type GetVerseRecitationOptions = BaseApiParams & {
     fields?: Partial<Record<VerseRecitationField, boolean>>;
@@ -739,6 +852,22 @@ declare class QuranResources {
      * client.resources.findVerseMedia()
      */
     findVerseMedia(options?: GetResourceOptions): Promise<VerseMediaResource>;
+    /**
+     * Bootstrap or incrementally sync public content resources.
+     * @param {ContentSyncOptions} options
+     * @example
+     * client.resources.sync({ bootstrap: true, resources: "translations:19" })
+     */
+    sync<TData extends Record<string, unknown> = Record<string, unknown>>(options?: ContentSyncOptions): Promise<ContentSyncResponse<TData>>;
+    /**
+     * Fetch the current full snapshot for a syncable public content resource.
+     * @param {ContentSyncResourceGroup} resourceGroup
+     * @param {string | number} id
+     * @param {ContentResourceSnapshotOptions} options
+     * @example
+     * client.resources.findSnapshot("translations", 19)
+     */
+    findSnapshot<TRecord extends Record<string, unknown> = Record<string, unknown>>(resourceGroup: ContentSyncResourceGroup, id: string | number, options?: ContentResourceSnapshotOptions): Promise<ContentResourceSnapshot<TRecord>>;
 }
 
 type SearchOptions = Omit<SearchParams, "query">;
@@ -844,4 +973,4 @@ declare class QuranVerses {
     findRandom(options?: GetVerseOptions): Promise<Verse>;
 }
 
-export { type AudioResponse as A, type RecitationResource as B, type ChapterId as C, type RecitationInfoResource as D, type TranslationResource as E, type TranslationInfoResource as F, type TafsirResource as G, type HizbNumber as H, type TafsirInfoResource as I, type JuzNumber as J, type RecitationStylesResource as K, type LanguageResource as L, type ChapterInfoResource as M, type NormalizedVerseRecitation as N, type VerseMediaResource as O, type PageNumber as P, QuranChapters as Q, type RubNumber as R, type SearchResponse as S, type TranslatedName as T, type ChapterReciterResource as U, type VerseKey as V, type Word as W, SearchNavigationType as X, type SearchResult as Y, QuranVerses as a, QuranJuzs as b, QuranAudio as c, QuranHadithReferences as d, QuranResources as e, QuranSearch as f, type ChapterRecitation as g, type VerseRecitation as h, type Chapter as i, type ChapterInfo as j, type ChapterInfoResponse as k, type HadithReference as l, type HadithReferencesByAyahResponse as m, type HadithGrade as n, type HadithContent as o, type Hadith as p, type HadithsByAyahResponse as q, type HadithCountWithinRangeResponse as r, type Segment as s, type Tafsir as t, type Translation as u, type Transliteration as v, type Verse as w, CharType as x, type Juz as y, type Pagination 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 ContentSyncMutationType as a2, type ContentSyncOptions as a3, type ContentResourceSnapshotOptions as a4, type ContentSyncMutation as a5, type ContentSyncResponse as a6, type ContentResourceSnapshot as a7, SearchNavigationType as a8, type SearchResult as a9, 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-B5K9Egsa.d.ts → verses-Dw2mFuje.d.ts}

@@ -1,4 +1,4 @@
-import { e as QuranFetchClient, B as BaseApiParams, b as VerseRecitationField, d as SearchParams, P as PaginationParams, W as WordField, T as TranslationField, V as VerseField } from './index-BZgqOfA4.js';
+import { A as ApiParams, e as QuranFetchClient, B as BaseApiParams, b as VerseRecitationField, d as SearchParams, P as PaginationParams, W as WordField, T as TranslationField, V as VerseField } from './index-BgoJducH.js';
 
 /**
  * Maps chapter number to verse count
@@ -197,6 +197,36 @@ interface SearchResponse {
     };
 }
 
+interface Answer {
+    id: string | number;
+    body: string;
+    answeredBy?: string;
+    status: string;
+    language?: string;
+}
+interface AnswerQuestion {
+    id: string | number;
+    body: string;
+    type: string;
+    ranges: VerseKey[];
+    surah: number;
+    theme?: string[];
+    summary?: string;
+    references?: string[];
+    language?: string;
+    status: string;
+    answers: Answer[];
+}
+interface AnswersByAyahResponse {
+    questions: AnswerQuestion[];
+    totalCount?: number;
+}
+interface AnswerCount {
+    types?: Record<string, number>;
+    total: number;
+}
+type AnswerCountWithinRangeResponse = Record<string, AnswerCount>;
+
 /**
  * Segment structure is [wordFrom, wordTo, timeFrom, timeTo] time is in ms
  */
@@ -320,6 +350,52 @@ interface ChapterReciterResource {
     format?: string;
     filesSize?: number;
 }
+type ContentSyncResourceGroup = "articles" | "recitations" | "tafsirs" | "translations";
+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:*;translations:1,6`. */
+    resources?: string;
+    /** Set to true for the initial sync. */
+    bootstrap?: boolean;
+    /** Token returned by the final bootstrap or incremental page. */
+    syncToken?: string;
+    /** Pagination cursor from `nextPageUrl`. */
+    cursor?: string;
+    /** Page size, up to the API maximum. */
+    perPage?: number;
+}
+type ContentResourceSnapshotOptions = ApiParams;
+interface ContentSyncMutation<TData extends Record<string, unknown> = Record<string, unknown>> {
+    sequence: number;
+    type: ContentSyncMutationType;
+    resourceGroup: ContentSyncResourceGroup;
+    resourceId: number;
+    resourceContentId: number | null;
+    recordType: string | null;
+    recordKey: string | null;
+    sourceRecordId: number | null;
+    changedAt: string;
+    data: TData | null;
+    snapshotUrl: string | null;
+    unavailableReason: string | null;
+}
+interface ContentSyncResponse<TData extends Record<string, unknown> = Record<string, unknown>> {
+    sync: {
+        syncUntilSequence: number;
+        hasMore: boolean;
+        nextPageUrl: string | null;
+        nextSyncToken: string | null;
+        mutations: ContentSyncMutation<TData>[];
+    };
+}
+interface ContentResourceSnapshot<TRecord extends Record<string, unknown> = Record<string, unknown>> {
+    resourceGroup: ContentSyncResourceGroup;
+    resourceId: number;
+    resourceContentId: number | null;
+    schemaVersion: number;
+    syncSequence: number;
+    records: TRecord[];
+}
 
 interface ChapterInfo {
     id: number;
@@ -494,6 +570,43 @@ interface Pagination {
     totalRecords: number;
 }
 
+type GetAnswersByAyahOptions = BaseApiParams & {
+    page?: number;
+    pageSize?: number;
+};
+type CountAnswersWithinRangeOptions = BaseApiParams;
+/**
+ * Quran answers API methods.
+ */
+declare class QuranAnswers {
+    private fetcher;
+    constructor(fetcher: QuranFetchClient);
+    /**
+     * Get published answer questions linked to a specific ayah.
+     * @param {VerseKey} key verse key in format "chapter:verse" (e.g., "2:255")
+     * @param {GetAnswersByAyahOptions} options
+     * @example
+     * client.answers.findByAyah("2:255", { page: 1, pageSize: 2 })
+     */
+    findByAyah(key: VerseKey, options?: GetAnswersByAyahOptions): Promise<AnswersByAyahResponse>;
+    /**
+     * Get a published answer question by id.
+     * @param {string | number} questionId question id
+     * @example
+     * client.answers.findByQuestionId("988")
+     */
+    findByQuestionId(questionId: string | number): Promise<AnswerQuestion>;
+    /**
+     * Get a verse-key to answer-count map within an inclusive ayah range.
+     * @param {VerseKey} from start verse key in format "chapter:verse"
+     * @param {VerseKey} to end verse key in format "chapter:verse"
+     * @param {CountAnswersWithinRangeOptions} options
+     * @example
+     * client.answers.countWithinRange("2:255", "2:256")
+     */
+    countWithinRange(from: VerseKey, to: VerseKey, options?: CountAnswersWithinRangeOptions): Promise<AnswerCountWithinRangeResponse>;
+}
+
 type GetChapterRecitationOptions = BaseApiParams;
 type GetVerseRecitationOptions = BaseApiParams & {
     fields?: Partial<Record<VerseRecitationField, boolean>>;
@@ -739,6 +852,22 @@ declare class QuranResources {
      * client.resources.findVerseMedia()
      */
     findVerseMedia(options?: GetResourceOptions): Promise<VerseMediaResource>;
+    /**
+     * Bootstrap or incrementally sync public content resources.
+     * @param {ContentSyncOptions} options
+     * @example
+     * client.resources.sync({ bootstrap: true, resources: "translations:19" })
+     */
+    sync<TData extends Record<string, unknown> = Record<string, unknown>>(options?: ContentSyncOptions): Promise<ContentSyncResponse<TData>>;
+    /**
+     * Fetch the current full snapshot for a syncable public content resource.
+     * @param {ContentSyncResourceGroup} resourceGroup
+     * @param {string | number} id
+     * @param {ContentResourceSnapshotOptions} options
+     * @example
+     * client.resources.findSnapshot("translations", 19)
+     */
+    findSnapshot<TRecord extends Record<string, unknown> = Record<string, unknown>>(resourceGroup: ContentSyncResourceGroup, id: string | number, options?: ContentResourceSnapshotOptions): Promise<ContentResourceSnapshot<TRecord>>;
 }
 
 type SearchOptions = Omit<SearchParams, "query">;
@@ -844,4 +973,4 @@ declare class QuranVerses {
     findRandom(options?: GetVerseOptions): Promise<Verse>;
 }
 
-export { type AudioResponse as A, type RecitationResource as B, type ChapterId as C, type RecitationInfoResource as D, type TranslationResource as E, type TranslationInfoResource as F, type TafsirResource as G, type HizbNumber as H, type TafsirInfoResource as I, type JuzNumber as J, type RecitationStylesResource as K, type LanguageResource as L, type ChapterInfoResource as M, type NormalizedVerseRecitation as N, type VerseMediaResource as O, type PageNumber as P, QuranChapters as Q, type RubNumber as R, type SearchResponse as S, type TranslatedName as T, type ChapterReciterResource as U, type VerseKey as V, type Word as W, SearchNavigationType as X, type SearchResult as Y, QuranVerses as a, QuranJuzs as b, QuranAudio as c, QuranHadithReferences as d, QuranResources as e, QuranSearch as f, type ChapterRecitation as g, type VerseRecitation as h, type Chapter as i, type ChapterInfo as j, type ChapterInfoResponse as k, type HadithReference as l, type HadithReferencesByAyahResponse as m, type HadithGrade as n, type HadithContent as o, type Hadith as p, type HadithsByAyahResponse as q, type HadithCountWithinRangeResponse as r, type Segment as s, type Tafsir as t, type Translation as u, type Transliteration as v, type Verse as w, CharType as x, type Juz as y, type Pagination 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 ContentSyncMutationType as a2, type ContentSyncOptions as a3, type ContentResourceSnapshotOptions as a4, type ContentSyncMutation as a5, type ContentSyncResponse as a6, type ContentResourceSnapshot as a7, SearchNavigationType as a8, type SearchResult as a9, 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.2.1",
+  "version": "3.4.0",
   "main": "dist/index.min.js",
   "module": "dist/index.min.mjs",
   "types": "dist/index.d.ts",

package/dist/runtime-utils-CxjOQDsB.d.mts

@@ -1,3 +0,0 @@
-type RawOperation = (request?: unknown) => Promise<unknown>;
-
-export type { RawOperation as R };

package/dist/runtime-utils-CxjOQDsB.d.ts

@@ -1,3 +0,0 @@
-type RawOperation = (request?: unknown) => Promise<unknown>;
-
-export type { RawOperation as R };