DX sweep: rename to @widgrensit/asobi, point at sdk_demo_backend on :8084, publish on release#4
Merged
Merged
Conversation
…, npm publish on release Cross-SDK DX sweep — asobi-js: - package.json: rename @asobi/client -> @widgrensit/asobi (the @asobi scope is unowned), bump 0.1.0 -> 0.2.0, engines >=22.0.0 (the SDK uses the global WebSocket which is only stable in Node 22+). - Add full package metadata: repository, homepage, bugs, keywords, exports field, sideEffects: false, publishConfig. - Add prepare script so 'npm install <git-url>' produces a built dist/. - README: bump install command to @widgrensit/asobi, add 'Run a backend first' pointing at widgrensit/sdk_demo_backend on :8084, replace the arena-mode quickstart with a demo-mode one that subscribes to match.matched before queueing and chains it explicitly. Document match.matched vs match.joined for SDK consumers, and that on() returns an unsubscribe function. - CHANGELOG.md added. - Release workflow: install + build + npm publish --provenance after tag/release. Requires NPM_TOKEN secret on the repo.
Taure
added a commit
that referenced
this pull request
May 2, 2026
Rewrites the README so it reflects what asobi-js actually is — a thin transport client for the asobi protocol — and drops the broad feature-table claims (worlds, terrain, voting, economy, leaderboards, etc.) that overstated coverage. Changes: - Add Scope and Status sections; mark typed REST helpers as deprecated for v1.0 - Replace REST-heavy quickstart with a WebSocket-only example using `AsobiWebSocket` - Add API reference block for `AsobiWebSocket` - Move engine/framework integrations (Phaser/Three/Pixi) to opt-in `examples/` rather than bundled exports - Remove the Features matrix that promised full coverage of unstable subsystems Rebase note: this PR was rebased onto main after #4/#5/#7/#8 landed. The README conflict was resolved by keeping the PR's narrowed-scope structure (Scope/Status/API/adapters sections, no Features table) while preserving main's factual updates that don't conflict with the narrowing: the Node 22+ header, the @widgrensit/asobi package name, the "Run a backend first" section pointing at sdk_demo_backend on :8084, the Browser usage section, and the canonical link to the WebSocket protocol guide. The PR's deletion of the Features matrix and REST-flavoured quickstart was preserved — that deletion is the whole point of the PR. No code change. Code refactor follows in a separate PR.
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
Cross-SDK DX sweep — asobi-js subset. Gets the package npm-publishable and pointed at the canonical demo backend.
@asobi/client→@widgrensit/asobi(the@asobiscope is unowned;@widgrensitmatches the rest of the org). Bump0.1.0→0.2.0.engines.node>=18.0.0→>=22.0.0because the SDK relies on the globalWebSocketwhich is only stable in Node 22+. Earlier Node versions can polyfill viawsand assigning toglobalThis.WebSocket— documented in the README.repository,homepage,bugs,keywords,exportsfield,sideEffects: false,publishConfig.access: public.preparescript runstscsonpm install <git-url>produces a builtdist/(currently the package onmainships nodist/, so even the git-URL fallback wouldn't import).@widgrensit/asobi. New "Run a backend first" section pointing at widgrensit/sdk_demo_backend on:8084. Quickstart now subscribes tomatch.matchedbefore queueing and documentsmatch.matchedvsmatch.joinedfor SDK consumers (matchmaker push vs reply to a client-initiatedmatch.join). Added a note thaton()returns an unsubscribe function.CHANGELOG.mdadded.npm ci,npm run build, andnpm publish --provenance --access public. Requires anNPM_TOKENrepo secret.Surfaced by the
asobi-dx-jsagent during the cross-SDK pre-release sweep.Manual step before merge
Create an
NPM_TOKENrepo secret (a publish-scope npm token for the@widgrensitorg) so the release workflow can publish.After merge, the existing release job will tag
v0.2.0, create the GitHub release, build, andnpm publishautomatically. If you want to dry-run first, comment out thePublish to npmstep.Test plan
npm ci— clean installnpm run build— producesdist/npm pack --dry-run— 25 kB tarball, 98 files, manifest looks rightNPM_TOKENand merge to verify publish worksDeferred
on<T>(event)andsend<TReq, TRes>(...).examples/.@deprecatedJSDoc._parse_error,_reconnectedevents, null-channel guards).