@doshi/sdk
v0.3.3
Published
Doshi's Learn surface for a client's own page: mount() renders it into a shadow root. One ESM file with React inside; everything it bundles is a devDependency, so installing it installs nothing else.
Readme
@doshi/sdk
Doshi's Learn surface for your own page. Call mount, and the SDK renders into a shadow root
on the element you give it. It is one JavaScript file with its declarations, and it installs
no other package.
npm install @doshi/sdkHow to sign a member in, mount the SDK and handle its events is developers.doshi.app/sdk.
Versions
The SDK follows semver over its public API: mount, its options and its
events. Prereleases are published under the next tag. What you are promised about versions,
cadence and support is
developers.doshi.app/releases.
Verifying a release
Each release comes with its checksums, a CycloneDX SBOM and a Sigstore build attestation. developers.doshi.app/releases serves them, and gives the commands that check the tarball npm installs against them.
Runtime dependencies
Every third-party package whose code reaches your page. All of them are bundled into
dist/index.js, and the package declares no dependencies, so installing it installs nothing
else.
| Package | Why |
| --- | --- |
| react | Renders the screens. Bundled rather than shared with the host, so the SDK always runs the React it was tested with. |
| react-dom | React's renderer for the browser, which draws into the SDK's shadow root. |
| scheduler | React DOM's work queue. React DOM does not run without it. |
| @supabase/postgrest-js | Reads the member's courses, lessons and progress from Doshi's data API. |
Licence
Proprietary: see LICENSE.