Skip to content

docs(ack-pay): align receipt API examples#89

Open
EfeDurmaz16 wants to merge 1 commit into
agentcommercekit:mainfrom
EfeDurmaz16:efe/ack-pay-doc-api-alignment
Open

docs(ack-pay): align receipt API examples#89
EfeDurmaz16 wants to merge 1 commit into
agentcommercekit:mainfrom
EfeDurmaz16:efe/ack-pay-doc-api-alignment

Conversation

@EfeDurmaz16
Copy link
Copy Markdown

@EfeDurmaz16 EfeDurmaz16 commented May 15, 2026

Summary

  • update the ACK-Pay README receipt verification example to use trustedReceiptIssuers, matching the exported verifyPaymentReceipt options
  • remove the README reference to unexported isPaymentReceiptClaim and import the exported receipt credential guard
  • align the receipt verification docs example with the SDK credential type PaymentReceiptCredential

Why

The README currently shows trustedIssuers, but verifyPaymentReceipt accepts trustedReceiptIssuers. It also references isPaymentReceiptClaim, which is internal to receipt-claim-verifier.ts and is not exported from @agentcommercekit/ack-pay.

Verification

  • corepack pnpm install --frozen-lockfile
  • corepack pnpm check:format
  • git diff --check
  • corepack pnpm --filter @agentcommercekit/ack-pay check:types initially failed because workspace package exports resolve from built dist outputs
  • corepack pnpm --filter @agentcommercekit/ack-pay... build
  • corepack pnpm --filter @agentcommercekit/ack-pay check:types

Notes

This is docs-only and avoids the receipt verification logic changed in #88.

Summary by CodeRabbit

Documentation

  • Updated payment receipt verification examples to reflect current credential taxonomy (PaymentReceiptCredential) and trust configuration patterns with trustedReceiptIssuers
  • Refreshed type guard validation examples to showcase the latest utilities for validating payment receipts and requests

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 15, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 24b46c5b-46b9-4a1a-bc44-60a70afe87bc

📥 Commits

Reviewing files that changed from the base of the PR and between 6f65936 and 58c5aa4.

📒 Files selected for processing (2)
  • docs/ack-pay/receipt-verification.mdx
  • packages/ack-pay/README.md

Walkthrough

This pull request updates documentation for the ACK receipt payment verification feature. The credential type example is changed from ACKPaymentReceipt to PaymentReceiptCredential, and the README's verification examples are updated to show the correct issuer trust configuration and type guard imports.

Changes

ACK Receipt Verification Documentation

Layer / File(s) Summary
Updated credential type and API documentation
docs/ack-pay/receipt-verification.mdx, packages/ack-pay/README.md
Receipt verification credential type updated from ACKPaymentReceipt to PaymentReceiptCredential. README verifyPaymentReceipt example switched from trustedIssuers to trustedReceiptIssuers, and type guards documentation now imports and demonstrates isPaymentRequest and isPaymentReceiptCredential.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs(ack-pay): align receipt API examples' directly corresponds to the main changes: updating receipt verification examples in documentation to align with the current ACK-Pay API.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


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 and usage tips.

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