feat(entry)!: add `useEntry` hook and `entryApi` with tests #35

ishaan000 · 2025-01-20T19:45:20Z

Summary

Introduced the entryApi layer to define and manage the main API interface.
Developed the useEntry hook to streamline dynamic URL building using journalId.
Refactored existing logic to enhance modularity by moving RequestBundle from useAccess to apiRequest.

Details

New API Methods:
- Added methods to handle entry, entryAnalysis, and entryConversation requests within the entryApi layer.
Dynamic Hook:
- Created the useEntry hook to simplify API interactions and support dynamic paths.
Code Refactoring:
- Extracted shared logic for API requests from useAccess to apiRequest.
- Adjusted imports and dependencies to reflect the refactored structure.
Testing:
- Unit Tests:
  - Validated the functionality of entryApi and useEntry with mock data.
- Integration Tests ( can keep it only for testing this PR ) :
  - Verified the end-to-end functionality of entryApi methods and useEntry within the full application flow.
  - Tested dynamic URL construction with varying journalId values, including edge cases for empty and special characters.

- Define the main API interface with methods in the `entryApi` layer. - Create useEntry hook for dynamic url building using `journalId`. - Move RequestBundle from `useAccess` to `apiRequest` and modify existing logic.

hiyaryan

Looks really good @ishaan000 🙌 You've really went to the next level with TypeDoc. I have a few additional doc tips to share and just some general doc findings. Otherwise, the code this great! Please have a look.

package.json

tests/hooks/api/entryApi.test.tsx

src/hooks/useEntry.ts

src/hooks/api/entryApi.ts

src/hooks/apiRequest.ts

src/hooks/api/accessApi.ts

src/hooks/api/entryApi.ts

Co-authored-by: Ryan James Meneses <[email protected]>

- move `cross-fetch` to `devDependencies`. - remove extra line on 137 in `access.Api.ts`. - add typedocs for interface api in `entryApi.ts`. - add eslint rule for disabled test suite for entry.

hiyaryan

Great work Ishaan!! That wraps up the initial implementation of the hooks 🥳

feat(entry)!: add useEntry hook and entryApi with tests

548be91

- Define the main API interface with methods in the `entryApi` layer. - Create useEntry hook for dynamic url building using `journalId`. - Move RequestBundle from `useAccess` to `apiRequest` and modify existing logic.

ishaan000 added feature Related to new feature api Related to APIs labels Jan 20, 2025

ishaan000 requested a review from hiyaryan January 20, 2025 19:45

ishaan000 self-assigned this Jan 20, 2025

docs: add Typedocs for useEntry hook and entryApi

ed86b34

hiyaryan requested changes Jan 24, 2025

View reviewed changes