rights: add rights retrieval and listing queries by Kzoeps · Pull Request #17 · hypercerts-org/api

Kzoeps · 2026-10-05T18:07:10Z

Scope

Adds public org.hypercerts.claim.getRights and org.hypercerts.claim.listRights endpoints, with repeated-author filtering, stable cursor pagination, publisher sidecars, Lexicons, manifests, and coverage.

Validation

Offline pnpm test:unit: 110/110 tests passed; pnpm check and pnpm build passed locally.
Local pnpm test:http was not run. Unit tests use local fixtures/fake adapters and do not install handlers, seed PostgreSQL, or contact HappyView. CI HTTP coverage exercises real XRPC over HTTP against the installed HappyView + PostgreSQL test environment; its result is pending from PR creation.

Summary by CodeRabbit

New Features
- Added public endpoints to retrieve an individual rights record or list rights records.
- Listing supports publisher filters, ascending or descending sorting, and cursor-based pagination.
- Rights results include publisher details when available and preserve nullable indexing timestamps.
Documentation
- Updated endpoint and HTTP test documentation to cover rights retrieval, filtering, errors, and pagination.

…rights

changeset-bot · 2026-10-05T18:07:15Z

⚠️ No Changeset found

Latest commit: 9207d24

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel · 2026-10-05T18:07:17Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated
api-endpoints	Ready	Preview	Oct 6, 2026 3:42pm UTC

coderabbitai · 2026-10-05T18:07:19Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults
Review profile: CHILL
Plan: Advanced
Run ID: 5eff1325-fae1-4a38-9c94-4637f9f1e246

📥 Commits

Reviewing files that changed from the base of the PR and between 06606f8 and 9207d24.

📒 Files selected for processing (20)

CONTRIBUTING.md
README.md
api/README.md
api/lexicons/org.hypercerts.claim.getRights.json
api/lexicons/org.hypercerts.claim.listRights.json
api/lua/endpoints/getRights.lua
api/lua/endpoints/listRights.lua
api/lua/shared/rightsIdentifier.lua
api/lua/shared/rightsView.lua
api/lua/src/getRights.lua
api/lua/src/listRights.lua
api/manifest.json
api/modules/rights/manifest.json
api/modules/shared/manifest.json
api/tests/http/fixtures/rights.fixture.js
api/tests/http/getRights.http.test.js
api/tests/http/listRights.http.test.js
api/tests/unit/endpoints/rights-edge-lua.test.js
api/tests/unit/endpoints/rights-lua.test.js
api/tests/unit/tooling/lexicons.test.js

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Walkthrough

Walkthrough

This change adds public rights retrieval and listing endpoints. Retrieval returns an indexed rights record and publisher sidecars. Listing supports author filters, timestamp-based ordering, and cursor pagination. Lexicons, manifests, documentation, and tests cover the endpoints.

Changes

Rights Queries

Layer / File(s)	Summary
Query contracts and module registration `api/lexicons/Rights.json`, `api/manifest.json`, `api/modules/{rights,shared}/manifest.json`, `api/lua/shared/rights.lua`, `api/tests/unit/tooling/lexicons.test.js`, `api/README.md`	Adds the retrieval and listing Lexicons, registers the rights module and shared rights Lexicon, and adds shared rights URI validation and view helpers.
Exact rights retrieval `api/lua/endpoints/getRights.lua`, `api/lua/src/getRights.lua`, `api/tests/http/getRights.http.test.js`, `api/tests/unit/endpoints/rights-edge-lua.test.js`, `api/tests/unit/endpoints/rights-lua.test.js`	Adds exact-URI retrieval, PostgreSQL query handling, record view construction, and publisher sidecar hydration. Tests cover successful responses, invalid URIs, missing records, and nullable values.
Filtered listing and cursor pagination `api/lua/endpoints/listRights.lua`, `api/lua/src/listRights.lua`, `api/tests/http/fixtures/rights.fixture.js`, `api/tests/http/listRights.http.test.js`, `api/tests/unit/endpoints/rights-edge-lua.test.js`, `api/tests/unit/endpoints/rights-lua.test.js`, `README.md`, `CONTRIBUTING.md`, `api/README.md`	Adds author filtering, timestamp fallback, URI tie-breaking, direction-bound cursors, and hydrated list results. Tests and documentation cover filters, pagination, validation, nullable sidecars, and errors.

Priority: ➖ Normal

Estimated code review effort: 4 (Complex) | ~45 minutes

Change: Feature

Sequence Diagram(s)

sequenceDiagram
  participant Client as HTTP client
  participant List as listRights.handle
  participant DB as PostgreSQL
  participant Hydration as rights_hydrate_actor_views
  Client->>List: Send author and pagination parameters
  List->>DB: Query filtered rights rows in cursor order
  DB-->>List: Return limit plus one rows
  List->>Hydration: Hydrate publisher sidecars
  Hydration->>DB: Load publisher profile and organization records
  DB-->>Hydration: Return sidecar records
  Hydration-->>List: Return hydrated rights views
  List-->>Client: Return rights and optional next cursor

Merge Risk: ⚪ Minimal · up to 9207d

No identified rights-query issue remains that should prevent merge after normal checks.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 57 functions across 12 files. (8 skipped: …	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the main change: adding rights retrieval and listing queries.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 57 functions across 12 files. (8 skipped: 8 unsupported.)

Fix all pre-merge checks with AI

✨ Finishing Touches 💡 1

📝 Generate docstrings 💡

Commit to this branch
Create a new PR

🧪 Generate unit tests (beta)

Commit to this branch
Create a new PR

Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

…rights

sonarqubecloud · 2026-10-06T15:42:54Z

❌ The last analysis has failed.

See analysis details on SonarQube Cloud

Kzoeps added 5 commits October 5, 2026 01:33

rights: add public lookup and listing queries

9ce9742

Merge commit '7f06513d71a5ca9a6d0767e8284602ad556199c3' into queries/…

975ff13

…rights

rights: cover installed queries and relocate offline suites

09e8eb1

api-tests: merge pinned main into rights

1963975

api-tests: isolate funding publisher fixtures

861e90b

api: merge main location support into queries/rights

5ed55f8

vercel Bot deployed to Preview October 6, 2026 08:34 View deployment

Kzoeps added 2 commits October 6, 2026 18:29

Merge commit '73954ea71fc6c1c712c78e8ba42b3dad010911a7' into queries/…

d380457

…rights

rights: reuse Lua validators and relocate rights view

fe0572c

vercel Bot deployed to Preview October 6, 2026 13:09 View deployment

Kzoeps marked this pull request as ready for review October 6, 2026 13:19

rights: merge pinned main into rights queries

d7cd561

vercel Bot deployed to Preview October 6, 2026 13:37 View deployment

Kzoeps added 4 commits October 6, 2026 20:11

rights: merge origin/main

87de844

rights: merge origin/main

6007614

rights: merge origin/main

59351c9

rights: merge origin/main

5d79615

vercel Bot deployed to Preview October 6, 2026 14:33 View deployment

rights: merge origin/main and preserve query registration

9207d24

vercel Bot deployed to Preview October 6, 2026 15:42 View deployment

Kzoeps merged commit 13827ee into main Oct 6, 2026
7 of 8 checks passed

Kzoeps deleted the queries/rights branch October 6, 2026 15:48

Navigation Menu

Repository navigation

rights: add rights retrieval and listing queries - #17

rights: add rights retrieval and listing queries#17
Kzoeps merged 14 commits into
mainfrom
queries/rights

Kzoeps commented Oct 5, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

changeset-bot Bot commented Oct 5, 2026 •

edited

Loading

Uh oh!

vercel Bot commented Oct 5, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Oct 5, 2026 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

❌ Failed checks (1 warning)

Uh oh!

sonarqubecloud Bot commented Oct 6, 2026

Uh oh!

Uh oh!

This branch was successfully deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

Kzoeps commented Oct 5, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Scope

Validation

Summary by CodeRabbit

Uh oh!

changeset-bot Bot commented Oct 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

vercel Bot commented Oct 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Oct 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

❌ Failed checks (1 warning)

Uh oh!

sonarqubecloud Bot commented Oct 6, 2026

Uh oh!

Uh oh!

This branch was successfully deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Kzoeps commented Oct 5, 2026 •

edited by coderabbitai Bot

Loading

changeset-bot Bot commented Oct 5, 2026 •

edited

Loading

vercel Bot commented Oct 5, 2026 •

edited

Loading

coderabbitai Bot commented Oct 5, 2026 •

edited

Loading