docs: add JSDoc comments to recurring, address-book, error-messages, and use-streams Issues/772 773 774 776

[kossyomma-beep]

Summary

This PR adds JSDoc doc comments to all previously undocumented exported functions across four frontend utility files, completing a documentation pass requested in the linked issues.

Changes

lib/recurring.ts — added doc comments to 5 exports:

• getRecurringRules — describes SSR safety and return shape
• saveRecurringRule — documents the 25-entry cap and deduplication behaviour
• removeRecurringRule — documents the streamId-based removal
• getUpcomingRenewals — explains the future-only filter and sort order
• createRenewalPreset — documents parameters, side-effect (auto-saves), and return value

lib/address-book.ts — added doc comments to 5 exports:

• getAddressBookEntries — describes sort order and SSR safety
• addAddressBookEntry — documents ID/timestamp generation, trimming, deduplication, and 50-entry cap
• updateAddressBookEntry — documents partial-patch semantics and null return on miss
• deleteAddressBookEntry — documents silent no-op on missing ID
• touchAddressBookEntry — documents the upsert logic (update vs. create), field fallback rules, and blank-address guard

lib/error-messages.ts — added doc comments to 3 exports:

• mapError — explains the pattern-matching strategy (RegExp vs. string, first-match-wins, declaration order), the Soroban error-code mapping, and the known accuracy limitation tracked in bug: error message mapper never matches real on-chain Soroban contract error codes #231/bug: error message mapper never matches real on-chain Soroban contract error codes #287
• categoryLabel — documents display purpose and return values
• categoryColor — documents Tailwind class format and light/dark mode pair

hooks/use-streams.ts — added doc comments to 3 exports:

• invalidateStreams — explains the listener-bus mechanism and when to call it
• useStreams — fully documents all return fields including the non-obvious stale (offline cache fallback) and isRefreshingAfterHidden (tab-focus refresh indicator) fields, plus polling behaviour and options
• useStream — documents single-stream fetch semantics, absence of polling, and return shape

Issues

Closes #772
Closes #773
Closes #774
Closes #776

[drips-wave]

@kossyomma-beep Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits