feat(sdk): add Nodejs and JavaScript SDK packages#145
Open
aaanh wants to merge 4 commits into
Open
Conversation
0522c11 to
ffaec95
Compare
Contributor
|
Related Knowledge 2 documents with suggested updates are ready for review. beava shared
|
Ship the browser package in the pnpm workspace, expand beava-js gitignore for local tool caches, add missing eslint deps, and align check.sh plus GitHub workflows and SOURCE-OF-TRUTH with the JS monorepo.
Expand the package READMEs and add a local Node example so npm users can install, connect, handle errors, and smoke-test the client against a Beava server.
Avoid local admin sidecar port collisions when the HTTP integration tests spawn temporary Beava servers.
fce5573 to
bf0b051
Compare
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
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.
Summary
This PR introduces the Beava JavaScript workspace under
beava-js/with two npm packages:@beava/node: TypeScript HTTP client for Node.js services and scripts.@beava/client: browser-oriented package name that re-exports the same fetch-based API for frontend bundles.These packages support structured machine-to-machine interaction with a running Beava server through the HTTP data plane:
ping,register,push,get,batchGet, andreset.This PR also includes package documentation, a local Node smoke-test example, and Vitest coverage for unit and HTTP integration behavior.
Deployment Instructions
No application deployment required.
For npm release:
beava-js/packages/beava-node/package.jsonandbeava-js/packages/beava-client/package.json.@beava/clientdependency on@beava/nodealigned to the same version.beava-js/, run:pnpm install pnpm run build pnpm run test@beava/nodefirst, then@beava/client:Linked Issues
None.
Local Checks
Paste this into your PR description under "Verification":
Verification:
Pre-flight Checklist
@beava/nodebuild passes.@beava/nodeunit and HTTP integration tests pass.bash .github/scripts/check.shrun, if required before merge.Notes for the Reviewer
The integration helper now sets
BEAVA_ADMIN_ADDR=127.0.0.1:0so temporary Beava subprocesses do not collide on the default admin port127.0.0.1:8090during local test runs.