@quranjs/api 3.6.0 → 3.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (17) hide show
  1. package/dist/index.d.mts +2 -2
  2. package/dist/index.d.ts +2 -2
  3. package/dist/index.min.js.map +1 -1
  4. package/dist/index.min.mjs.map +1 -1
  5. package/dist/public.min.js +1 -1
  6. package/dist/public.min.js.map +1 -1
  7. package/dist/public.min.mjs +1 -1
  8. package/dist/public.min.mjs.map +1 -1
  9. package/dist/server.d.mts +1 -1
  10. package/dist/server.d.ts +1 -1
  11. package/dist/server.min.js +1 -1
  12. package/dist/server.min.js.map +1 -1
  13. package/dist/server.min.mjs +1 -1
  14. package/dist/server.min.mjs.map +1 -1
  15. package/dist/{verses-DTgS2dgL.d.mts → verses-CWixKr_f.d.mts} +4 -4
  16. package/dist/{verses-BHef2eGb.d.ts → verses-gs60vEyE.d.ts} +4 -4
  17. package/package.json +2 -2
package/dist/{verses-DTgS2dgL.d.mts → verses-CWixKr_f.d.mts} RENAMED
@@ -350,7 +350,7 @@ interface ChapterReciterResource {
350
350
  format?: string;
351
351
  filesSize?: number;
352
352
  }
353
- type ContentSyncResourceGroup = "articles" | "mushafs" | "recitations" | "tafsirs" | "translations" | "word_by_word_translations";
353
+ type ContentSyncResourceGroup = "articles" | "chapter_recitations" | "mushafs" | "recitations" | "tafsirs" | "translations" | "word_by_word_translations";
354
354
  interface MushafMetadataSnapshotRecord extends Record<string, unknown> {
355
355
  recordType: "mushaf";
356
356
  id: number;
@@ -430,7 +430,7 @@ interface WordByWordTranslationSnapshotRecord extends Record<string, unknown> {
430
430
  }
431
431
  type ContentSyncMutationType = "RESOURCE_CREATE" | "RESOURCE_UPDATE" | "RESOURCE_DELETE" | "ROW_CREATE" | "ROW_UPDATE" | "ROW_DELETE" | "RESOURCE_INVALIDATE";
432
432
  interface ContentSyncOptions extends ApiParams {
433
- /** Resource filter, e.g. `articles:*;mushafs:1;translations:1,6;word_by_word_translations:85`. */
433
+ /** Resource filter, e.g. `articles:*;chapter_recitations:159;mushafs:1;translations:1,6`. */
434
434
  resources?: string;
435
435
  /** Set to true for the initial sync. */
436
436
  bootstrap?: boolean;
@@ -972,7 +972,7 @@ declare class QuranResources {
972
972
  * @example
973
973
  * client.resources.sync({
974
974
  * bootstrap: true,
975
- * resources: "mushafs:1;translations:19;word_by_word_translations:85"
975
+ * resources: "chapter_recitations:159;mushafs:1;translations:19"
976
976
  * })
977
977
  */
978
978
  sync<TData extends Record<string, unknown> = Record<string, unknown>>(options?: ContentSyncOptions): Promise<ContentSyncResponse<TData>>;
@@ -982,7 +982,7 @@ declare class QuranResources {
982
982
  * @param {string | number} id
983
983
  * @param {ContentResourceSnapshotOptions} options
984
984
  * @example
985
- * client.resources.findSnapshot("mushafs", 1)
985
+ * client.resources.findSnapshot("chapter_recitations", 159)
986
986
  */
987
987
  findSnapshot<TRecord extends Record<string, unknown> = Record<string, unknown>>(resourceGroup: ContentSyncResourceGroup, id: string | number, options?: ContentResourceSnapshotOptions): Promise<ContentResourceSnapshot<TRecord>>;
988
988
  }
package/dist/{verses-BHef2eGb.d.ts → verses-gs60vEyE.d.ts} RENAMED
@@ -350,7 +350,7 @@ interface ChapterReciterResource {
350
350
  format?: string;
351
351
  filesSize?: number;
352
352
  }
353
- type ContentSyncResourceGroup = "articles" | "mushafs" | "recitations" | "tafsirs" | "translations" | "word_by_word_translations";
353
+ type ContentSyncResourceGroup = "articles" | "chapter_recitations" | "mushafs" | "recitations" | "tafsirs" | "translations" | "word_by_word_translations";
354
354
  interface MushafMetadataSnapshotRecord extends Record<string, unknown> {
355
355
  recordType: "mushaf";
356
356
  id: number;
@@ -430,7 +430,7 @@ interface WordByWordTranslationSnapshotRecord extends Record<string, unknown> {
430
430
  }
431
431
  type ContentSyncMutationType = "RESOURCE_CREATE" | "RESOURCE_UPDATE" | "RESOURCE_DELETE" | "ROW_CREATE" | "ROW_UPDATE" | "ROW_DELETE" | "RESOURCE_INVALIDATE";
432
432
  interface ContentSyncOptions extends ApiParams {
433
- /** Resource filter, e.g. `articles:*;mushafs:1;translations:1,6;word_by_word_translations:85`. */
433
+ /** Resource filter, e.g. `articles:*;chapter_recitations:159;mushafs:1;translations:1,6`. */
434
434
  resources?: string;
435
435
  /** Set to true for the initial sync. */
436
436
  bootstrap?: boolean;
@@ -972,7 +972,7 @@ declare class QuranResources {
972
972
  * @example
973
973
  * client.resources.sync({
974
974
  * bootstrap: true,
975
- * resources: "mushafs:1;translations:19;word_by_word_translations:85"
975
+ * resources: "chapter_recitations:159;mushafs:1;translations:19"
976
976
  * })
977
977
  */
978
978
  sync<TData extends Record<string, unknown> = Record<string, unknown>>(options?: ContentSyncOptions): Promise<ContentSyncResponse<TData>>;
@@ -982,7 +982,7 @@ declare class QuranResources {
982
982
  * @param {string | number} id
983
983
  * @param {ContentResourceSnapshotOptions} options
984
984
  * @example
985
- * client.resources.findSnapshot("mushafs", 1)
985
+ * client.resources.findSnapshot("chapter_recitations", 159)
986
986
  */
987
987
  findSnapshot<TRecord extends Record<string, unknown> = Record<string, unknown>>(resourceGroup: ContentSyncResourceGroup, id: string | number, options?: ContentResourceSnapshotOptions): Promise<ContentResourceSnapshot<TRecord>>;
988
988
  }
package/package.json CHANGED
@@ -11,7 +11,7 @@
11
11
  "publishConfig": {
12
12
  "access": "public"
13
13
  },
14
- "version": "3.6.0",
14
+ "version": "3.7.0",
15
15
  "main": "dist/index.min.js",
16
16
  "module": "dist/index.min.mjs",
17
17
  "types": "dist/index.d.ts",
@@ -57,8 +57,8 @@
57
57
  "tsup": "^8.5.0",
58
58
  "typescript": "^5.9.2",
59
59
  "vitest": "^3.2.4",
60
- "@quranjs/tsconfig": "0.1.0",
61
60
  "@quranjs/eslint-config": "0.3.0",
61
+ "@quranjs/tsconfig": "0.1.0",
62
62
  "@quranjs/prettier-config": "0.1.0"
63
63
  },
64
64
  "prettier": "@quranjs/prettier-config",