Skip to content

DEV-749 Migration to separate shimmer-web-sdk#40

Open
marknolan with Copilot wants to merge 78 commits into
mainfrom
copilot/restructure-repo-for-api-support
Open

DEV-749 Migration to separate shimmer-web-sdk#40
marknolan with Copilot wants to merge 78 commits into
mainfrom
copilot/restructure-repo-for-api-support

Conversation

Copilot AI commented May 20, 2026

Copy link
Copy Markdown
Contributor

The SDK has been extracted to ShimmerResearch/shimmer-web-sdk and published as @shimmerresearch/shimmer-web-sdk. This PR updates the demos repo to consume the published package rather than a local copy, and restores the original root-level GitHub Pages URLs.

Changes

  • Demo directories — moved from demos/<name>/ back to repo root, restoring https://shimmerresearch.github.io/webBLEDemos/<name>/ URLs
  • SDK imports — all demo index.html files now load the SDK from jsDelivr's GitHub CDN using @latest:
    import { Shimmer3RClient } from 'https://cdn.jsdelivr.net/gh/ShimmerResearch/shimmer-web-sdk@latest/dist/shimmer-ble.esm.js';
    @latest resolves to the newest git tag automatically — no demo changes needed on future SDK releases
  • shimmer-ble-sdk/ removed — local SDK source deleted; shimmer-web-sdk is the source of truth
  • shimmer-extension/ — import path updated to ../shimmer-web-sdk/dist/shimmer-ble.esm.js; README updated to instruct cloning shimmer-web-sdk as a sibling directory
  • Package name — all remaining references to @shimmerresearch/web-ble renamed to @shimmerresearch/shimmer-web-sdk
  • README — layout, live demo URLs, and SDK section updated throughout

Prerequisite in shimmer-web-sdk

The jsDelivr GitHub CDN can only serve files that are committed in the tag. The dist/ directory is currently gitignored. Add this step to cut-release.yml after the build step:

- name: Stage dist for release commit
  run: git add -f dist/

Without this, the CDN URL will 404 until the next release is cut with dist committed.

@marknolan

Copy link
Copy Markdown
Member

@JongChern a further step we could take here is to have two repos

  1. shimmer-web-ble
  • new repo
  • contains SDK
  • publishable as an NPM to npmjs.com or GitHub Packages
  1. webBLEDemos
  • existing repo with demo URL paths restored
  • references either the NPM (more applicable to end users) or shimmer-web-ble as a submodule.

Copilot AI added 2 commits May 25, 2026 20:30
…cal SDK

- Move all demo folders from demos/<name>/ back to root <name>/
- Replace local ../../shimmer-ble-sdk/dist/shimmer-ble.esm.js imports with
  https://cdn.jsdelivr.net/npm/@shimmerresearch/web-ble/dist/shimmer-ble.esm.js
- Remove shimmer-ble-sdk/ (SDK now lives at ShimmerResearch/shimmer-web-sdk)
- Remove demos/ directory and its README
- Update main README: layout, live demo URLs, SDK section
- Update ShimmerCapture/README.md and Verisense/README.md live demo URLs
The SDK has moved to ShimmerResearch/shimmer-web-sdk. Update the import
path in shimmercompanion.js from ../shimmer-ble-sdk/ to ../shimmer-web-sdk/
and update the README instructions accordingly.
Copilot AI changed the title feat: implement @shimmerresearch/web-ble TypeScript SDK restructuring Move demos to root, swap local SDK for npm CDN, remove shimmer-ble-sdk May 25, 2026
@marknolan marknolan changed the title refactor: DEV-749 move demos to root, switch SDK to npm CDN, remove local SDK copy DEV-749 Migration to separate shimmer-web-sdk May 29, 2026
@marknolan

Copy link
Copy Markdown
Member

@copilot resolve the merge conflicts in this pull request. A note was added to the readme on main regarding the code changes within this PR. I think we can update the note to point any potential users using main to reference the latest release tag if they need to before migrating.

Copilot AI commented May 29, 2026

Copy link
Copy Markdown
Contributor Author

@copilot resolve the merge conflicts in this pull request. A note was added to the readme on main regarding the code changes within this PR. I think we can update the note to point any potential users...

Done in b4d7ec0. Merged main into this branch — the only conflict was README.md. The migration notice from main has been incorporated as an updated blockquote at the top of our README:

Migration note — this branch replaces the local shimmer3r.js / verisense.js files with the published shimmer-web-sdk package. If you need the pre-migration setup, check out the v0.0.1 release tag.

This points users on main to the v0.0.1 release tag for the last stable pre-migration state before they migrate.

marknolan and others added 13 commits June 2, 2026 11:59
Sync the Verisense and shimmer-extension vendor copies of shimmer-web-sdk to
the updated operational-config field definitions (DEV-824). Generated
artifacts only; no source changes.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
… #54)

Syncs both Verisense/vendor and shimmer-extension/vendor with the
current shimmer-web-sdk main build, picking up the Verisense DFU flow
module (DEV-845) and the domain helpers promoted from the device console.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Picks up shimmer-web-sdk PR #63 (GEN_CFG_2 bit 3 low-power auto-stop
disable field).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants