@quranjs/api 3.4.1 → 3.6.0

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

@@ -1,4 +1,4 @@
-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';
+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-BJ5hWalX.js';
 
 /**
  * Maps chapter number to verse count
@@ -350,7 +350,73 @@ interface ChapterReciterResource {
     format?: string;
     filesSize?: number;
 }
-type ContentSyncResourceGroup = "articles" | "recitations" | "tafsirs" | "translations" | "word_by_word_translations";
+type ContentSyncResourceGroup = "articles" | "mushafs" | "recitations" | "tafsirs" | "translations" | "word_by_word_translations";
+interface MushafMetadataSnapshotRecord extends Record<string, unknown> {
+    recordType: "mushaf";
+    id: number;
+    resourceContentId: number;
+    name: string;
+    description: string | null;
+    pagesCount: number;
+    linesPerPage: number;
+    defaultFontName: string;
+    mappingMode: string;
+    qirat: {
+        id: number;
+        name: string;
+    } | null;
+}
+interface MushafPageSnapshotRecord extends Record<string, unknown> {
+    recordType: "mushaf_page";
+    id: number;
+    mushafId: number;
+    pageNumber: number;
+    firstVerseId: number | null;
+    lastVerseId: number | null;
+    firstWordId: number | null;
+    lastWordId: number | null;
+    versesCount: number | null;
+    verseMapping: Record<string, unknown> | null;
+    updatedAt: string;
+}
+interface MushafFontAssetSnapshotRecord extends Record<string, unknown> {
+    recordType: "font_asset";
+    id: number;
+    assetKey: string;
+    mushafId: number;
+    pageNumber: number | null;
+    fontFamily: string;
+    format: string;
+    mimeType: string;
+    url: string;
+    sha256: string;
+    byteSize: number;
+    version: string;
+    provider: string;
+    licenseName: string;
+    licenseUrl: string | null;
+    attribution: string | null;
+    updatedAt: string;
+}
+interface MushafWordSnapshotRecord extends Record<string, unknown> {
+    recordType: "mushaf_word";
+    id: number;
+    mushafId: number;
+    wordId: number;
+    verseId: number;
+    sourceVerseId: number | null;
+    text: string | null;
+    charTypeId: number | null;
+    charTypeName: string | null;
+    pageNumber: number | null;
+    lineNumber: number | null;
+    positionInVerse: number | null;
+    positionInLine: number | null;
+    positionInPage: number | null;
+    cssClass: string | null;
+    cssStyle: string | null;
+}
+type MushafSnapshotRecord = MushafMetadataSnapshotRecord | MushafPageSnapshotRecord | MushafFontAssetSnapshotRecord | MushafWordSnapshotRecord;
 interface WordByWordTranslationSnapshotRecord extends Record<string, unknown> {
     id: number;
     resourceContentId: number;
@@ -364,7 +430,7 @@ interface WordByWordTranslationSnapshotRecord extends Record<string, unknown> {
 }
 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;word_by_word_translations:85`. */
+    /** Resource filter, e.g. `articles:*;mushafs:1;translations:1,6;word_by_word_translations:85`. */
     resources?: string;
     /** Set to true for the initial sync. */
     bootstrap?: boolean;
@@ -581,6 +647,43 @@ interface Pagination {
     totalRecords: number;
 }
 
+/** A JSON value accepted in an analytics event's properties object. */
+type AnalyticsJsonValue = boolean | null | number | string | AnalyticsJsonValue[] | {
+    [key: string]: AnalyticsJsonValue;
+};
+interface AnalyticsEvent {
+    /** Stable caller-generated ID. Reuse it when retrying this event. */
+    eventId: string;
+    /** Namespaced event name, for example `quran.reader.verse_viewed`. */
+    name: string;
+    /** When the event happened. Date values are serialized as RFC 3339. */
+    occurredAt: Date | string;
+    /** Version of this event's property structure, starting at 1. */
+    version: number;
+    /** Optional ID linking the event to a specific action. */
+    actionId?: null | string;
+    /** Application-generated ID for a person who is not signed in. */
+    anonymousId?: null | string;
+    /** Event-specific JSON. Caller-defined property names are preserved. */
+    properties?: {
+        [key: string]: AnalyticsJsonValue;
+    };
+    /** Application-generated ID grouping events from one usage session. */
+    sessionId?: null | string;
+    /** Quran Foundation OAuth user ID. Do not send an application-local ID. */
+    userId?: null | string;
+}
+interface AnalyticsBatchRequest {
+    /** The API accepts between 1 and 100 events as one all-or-nothing batch. */
+    events: AnalyticsEvent[];
+}
+interface AnalyticsBatchAccepted {
+    /** Number of accepted events; this equals the submitted count on HTTP 202. */
+    accepted: number;
+    /** Server-generated identifier shared by all events in this batch. */
+    batchId: string;
+}
+
 type GetAnswersByAyahOptions = BaseApiParams & {
     page?: number;
     pageSize?: number;
@@ -869,7 +972,7 @@ declare class QuranResources {
      * @example
      * client.resources.sync({
      *   bootstrap: true,
-     *   resources: "translations:19;word_by_word_translations:85"
+     *   resources: "mushafs:1;translations:19;word_by_word_translations:85"
      * })
      */
     sync<TData extends Record<string, unknown> = Record<string, unknown>>(options?: ContentSyncOptions): Promise<ContentSyncResponse<TData>>;
@@ -879,7 +982,7 @@ declare class QuranResources {
      * @param {string | number} id
      * @param {ContentResourceSnapshotOptions} options
      * @example
-     * client.resources.findSnapshot("word_by_word_translations", 85)
+     * client.resources.findSnapshot("mushafs", 1)
      */
     findSnapshot<TRecord extends Record<string, unknown> = Record<string, unknown>>(resourceGroup: ContentSyncResourceGroup, id: string | number, options?: ContentResourceSnapshotOptions): Promise<ContentResourceSnapshot<TRecord>>;
 }
@@ -987,4 +1090,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 WordByWordTranslationSnapshotRecord as a2, type ContentSyncMutationType as a3, type ContentSyncOptions as a4, type ContentResourceSnapshotOptions as a5, type ContentSyncMutation as a6, type ContentSyncResponse as a7, type ContentResourceSnapshot as a8, SearchNavigationType as a9, type SearchResult as aa, 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 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 };

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

@@ -1,4 +1,4 @@
-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';
+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-BJ5hWalX.mjs';
 
 /**
  * Maps chapter number to verse count
@@ -350,7 +350,73 @@ interface ChapterReciterResource {
     format?: string;
     filesSize?: number;
 }
-type ContentSyncResourceGroup = "articles" | "recitations" | "tafsirs" | "translations" | "word_by_word_translations";
+type ContentSyncResourceGroup = "articles" | "mushafs" | "recitations" | "tafsirs" | "translations" | "word_by_word_translations";
+interface MushafMetadataSnapshotRecord extends Record<string, unknown> {
+    recordType: "mushaf";
+    id: number;
+    resourceContentId: number;
+    name: string;
+    description: string | null;
+    pagesCount: number;
+    linesPerPage: number;
+    defaultFontName: string;
+    mappingMode: string;
+    qirat: {
+        id: number;
+        name: string;
+    } | null;
+}
+interface MushafPageSnapshotRecord extends Record<string, unknown> {
+    recordType: "mushaf_page";
+    id: number;
+    mushafId: number;
+    pageNumber: number;
+    firstVerseId: number | null;
+    lastVerseId: number | null;
+    firstWordId: number | null;
+    lastWordId: number | null;
+    versesCount: number | null;
+    verseMapping: Record<string, unknown> | null;
+    updatedAt: string;
+}
+interface MushafFontAssetSnapshotRecord extends Record<string, unknown> {
+    recordType: "font_asset";
+    id: number;
+    assetKey: string;
+    mushafId: number;
+    pageNumber: number | null;
+    fontFamily: string;
+    format: string;
+    mimeType: string;
+    url: string;
+    sha256: string;
+    byteSize: number;
+    version: string;
+    provider: string;
+    licenseName: string;
+    licenseUrl: string | null;
+    attribution: string | null;
+    updatedAt: string;
+}
+interface MushafWordSnapshotRecord extends Record<string, unknown> {
+    recordType: "mushaf_word";
+    id: number;
+    mushafId: number;
+    wordId: number;
+    verseId: number;
+    sourceVerseId: number | null;
+    text: string | null;
+    charTypeId: number | null;
+    charTypeName: string | null;
+    pageNumber: number | null;
+    lineNumber: number | null;
+    positionInVerse: number | null;
+    positionInLine: number | null;
+    positionInPage: number | null;
+    cssClass: string | null;
+    cssStyle: string | null;
+}
+type MushafSnapshotRecord = MushafMetadataSnapshotRecord | MushafPageSnapshotRecord | MushafFontAssetSnapshotRecord | MushafWordSnapshotRecord;
 interface WordByWordTranslationSnapshotRecord extends Record<string, unknown> {
     id: number;
     resourceContentId: number;
@@ -364,7 +430,7 @@ interface WordByWordTranslationSnapshotRecord extends Record<string, unknown> {
 }
 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;word_by_word_translations:85`. */
+    /** Resource filter, e.g. `articles:*;mushafs:1;translations:1,6;word_by_word_translations:85`. */
     resources?: string;
     /** Set to true for the initial sync. */
     bootstrap?: boolean;
@@ -581,6 +647,43 @@ interface Pagination {
     totalRecords: number;
 }
 
+/** A JSON value accepted in an analytics event's properties object. */
+type AnalyticsJsonValue = boolean | null | number | string | AnalyticsJsonValue[] | {
+    [key: string]: AnalyticsJsonValue;
+};
+interface AnalyticsEvent {
+    /** Stable caller-generated ID. Reuse it when retrying this event. */
+    eventId: string;
+    /** Namespaced event name, for example `quran.reader.verse_viewed`. */
+    name: string;
+    /** When the event happened. Date values are serialized as RFC 3339. */
+    occurredAt: Date | string;
+    /** Version of this event's property structure, starting at 1. */
+    version: number;
+    /** Optional ID linking the event to a specific action. */
+    actionId?: null | string;
+    /** Application-generated ID for a person who is not signed in. */
+    anonymousId?: null | string;
+    /** Event-specific JSON. Caller-defined property names are preserved. */
+    properties?: {
+        [key: string]: AnalyticsJsonValue;
+    };
+    /** Application-generated ID grouping events from one usage session. */
+    sessionId?: null | string;
+    /** Quran Foundation OAuth user ID. Do not send an application-local ID. */
+    userId?: null | string;
+}
+interface AnalyticsBatchRequest {
+    /** The API accepts between 1 and 100 events as one all-or-nothing batch. */
+    events: AnalyticsEvent[];
+}
+interface AnalyticsBatchAccepted {
+    /** Number of accepted events; this equals the submitted count on HTTP 202. */
+    accepted: number;
+    /** Server-generated identifier shared by all events in this batch. */
+    batchId: string;
+}
+
 type GetAnswersByAyahOptions = BaseApiParams & {
     page?: number;
     pageSize?: number;
@@ -869,7 +972,7 @@ declare class QuranResources {
      * @example
      * client.resources.sync({
      *   bootstrap: true,
-     *   resources: "translations:19;word_by_word_translations:85"
+     *   resources: "mushafs:1;translations:19;word_by_word_translations:85"
      * })
      */
     sync<TData extends Record<string, unknown> = Record<string, unknown>>(options?: ContentSyncOptions): Promise<ContentSyncResponse<TData>>;
@@ -879,7 +982,7 @@ declare class QuranResources {
      * @param {string | number} id
      * @param {ContentResourceSnapshotOptions} options
      * @example
-     * client.resources.findSnapshot("word_by_word_translations", 85)
+     * client.resources.findSnapshot("mushafs", 1)
      */
     findSnapshot<TRecord extends Record<string, unknown> = Record<string, unknown>>(resourceGroup: ContentSyncResourceGroup, id: string | number, options?: ContentResourceSnapshotOptions): Promise<ContentResourceSnapshot<TRecord>>;
 }
@@ -987,4 +1090,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 WordByWordTranslationSnapshotRecord as a2, type ContentSyncMutationType as a3, type ContentSyncOptions as a4, type ContentResourceSnapshotOptions as a5, type ContentSyncMutation as a6, type ContentSyncResponse as a7, type ContentResourceSnapshot as a8, SearchNavigationType as a9, type SearchResult as aa, 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 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 };

package/package.json

@@ -11,7 +11,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "3.4.1",
+  "version": "3.6.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/prettier-config": "0.1.0",
+    "@quranjs/tsconfig": "0.1.0",
     "@quranjs/eslint-config": "0.3.0",
-    "@quranjs/tsconfig": "0.1.0"
+    "@quranjs/prettier-config": "0.1.0"
   },
   "prettier": "@quranjs/prettier-config",
   "size-limit": [