Skip to content

Add textIndopakNastaleeq to Quran core word records - #89

Merged
basit3407 merged 3 commits into
mainfrom
content-sync/quran-core-indopak-nastaleeq
Oct 13, 2026
Merged

basit3407 merged 3 commits into
mainfrom
content-sync/quran-core-indopak-nastaleeq

Conversation

@basit3407

@basit3407 basit3407 commented Oct 13, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Adds optional textIndopakNastaleeq?: string | null to QuranCoreWordSnapshotRecord (Content Sync quran_core:1 word records), alongside textIndopak. It is optional because snapshots generated before the server-side backfill do not include it.
  • Marks textIndopak as @deprecated (use textIndopakNastaleeq). The old field is retained, so this is additive and non-breaking.
  • README example reads record.textIndopakNastaleeq ?? record.textIndopak and notes the deprecation and that the new field may be absent.
  • Tests: the public-types fixtures cover a word record with the new field and a legacy one without it; the findSnapshot() quran_core test asserts text_indopak_nastaleeq is camel-cased to textIndopakNastaleeq (existing humps conversion, no code change needed) and that a legacy word record has no such property.
  • Changeset (minor) for @quranjs/api.
  • Also: chore: regenerate operation catalogs. The "📚 Operation Catalogs" CI check compares against live qf-api-docs OpenAPI, which gained reading-bookmarks, share-verse image and post reaction operations since the last refresh. Regenerated in a separate commit; no changeset, following prior catalog refresh commits (e.g. ee7414b, 43204f5).

Dependency

Depends on the server-side quran_core word field text_indopak_nastaleeq being deployed (parallel tools.quran.com / quran.com-api changes). Until then the value is absent at runtime (hence optional); textIndopak is still served.

Verification

  • pnpm lint: pass
  • pnpm --filter @quranjs/api check:operation-catalogs: up to date
  • vitest: 25 files / 222 tests pass
  • tsc --noEmit on touched files: no errors (repo has no typecheck script for this package; the full-project run has pre-existing errors unrelated to this change)
  • Prettier check reports Resources.ts and resources.test.ts as unformatted on origin/main too (pre-existing)

🤖 Generated with Claude Code

Type the new nullable `text_indopak_nastaleeq` Content Sync field on
`QuranCoreWordSnapshotRecord` and deprecate `textIndopak`, which is
retained for backwards compatibility.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-13T04:09:11.949902Z 0edfd7a New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@github-actions

github-actions Bot commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
dist/index.min.js 7.85 KB (0%)
dist/index.min.mjs 7.85 KB (0%)
dist/server.min.js 15.05 KB (+0.61% 🔺)
dist/public.min.js 10.04 KB (+0.9% 🔺)

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 2523c8f6cb

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread packages/api/src/types/api/Resources.ts Outdated
basit3407 and others added 2 commits October 13, 2026 09:04
Snapshots generated before the server-side backfill omit the field, so
declaring it required overstated the runtime contract and broke
consumers that construct QuranCoreWordSnapshotRecord values.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refresh from the current qf-api-docs OpenAPI specs, which added
reading-bookmarks, share-verse image, and post reaction operations.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@basit3407
basit3407 merged commit 21d8975 into main Oct 13, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant