feat(client): publish typed API client package and consume in frontend and agent - #912
Open
xtep103 wants to merge 1 commit into
Open
feat(client): publish typed API client package and consume in frontend and agent#912xtep103 wants to merge 1 commit into
xtep103 wants to merge 1 commit into
Conversation
…d and agent - Add OpenAPI 3.0 spec in packages/client/openapi.json - Add TypeScript types in packages/client/index.d.ts - Implement LodestarClient in packages/client/index.js - Add unit test suite with 28 tests in packages/client/client.test.js - Refactor frontend/lib/contract.ts to consume LodestarClient - Refactor agent/agent.js to consume LodestarClient - Fixes Stellar-Ecosystem#832
|
@xtep103 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! 🚀 |
Contributor
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 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. Comment |
Author
|
@Stellar-Ecosystem Hi! This PR is open and ready for review — happy to address any feedback. Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves #832
Summary of Changes
Created
@lodestar/clientPackage (packages/client/):openapi.json): Formal specification covering all backend system, registry, reputation, agent scoring/policy, and activity endpoints.index.d.ts): Typed interfaces for data models, request/response payloads, and theLodestarClientinstance.index.js): ESM client handling JSON serialization, query formatting, custom timeouts, error wrapping (LodestarApiError), and customfetchsupport.client.test.js): 28 tests verifying all client methods, options, headers, and error handling.README.md): Usage examples and reference for JavaScript/TypeScript integrators.Frontend Refactoring (
frontend/lib/contract.ts):LodestarClientto manage all backend API calls with strong types.frontend/lib/types.ts.Agent Refactoring (
agent/agent.js):fetchWithTimeoutcalls inensureRegistered,checkSpend,recordOutcome,fetchServices, andsubmitReputationwith typedapiClientmethods.Verification
npx vitest run).npx vitest run).npm test), and production bundle built successfully (npm run build).