@evaro/consultation-sdk 0.0.0-stage → 0.2.0-next.0

package/README.md

@@ -1,3 +1,52 @@
-# Temporary Holding Version
+# @evaro/consultation-sdk
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The Evaro consultation as one React component: one question at a time, a progress bar, follow-up questions, jumps, the knockout screen and a Back button. It loads the consultation and the vendor theme itself, and it can save the answers to a target.
+
+It renders in a shadow root with its own CSS, so the host CSS does not change it and it does not change the host.
+
+## Install
+
+```bash
+pnpm add @evaro/consultation-sdk
+```
+
+React 19 and React DOM 19 are peer dependencies. Install an exact version.
+
+## Use
+
+```tsx
+import { Consultation } from '@evaro/consultation-sdk'
+
+<Consultation
+  consultation='<consultation hash>'
+  vendor='<vendor hash>'
+  environment='staging'
+  target={{ type: 'diagnosis-request', id: '<diagnosis request id>' }}
+  getToken={getToken}
+  onDone={closePanel}
+  onEvent={event => track(event.name, event.data)}
+/>
+```
+
+With no `target`, the component runs as a preview and saves nothing. With `readOnly`, it shows the saved answers of the target. With `nodeApiUrl`, the target's calls go to that URL, for example a local stub server, in place of the environment's NodeAPI host. It must use https, except for localhost. When `consultation`, `vendor`, `environment`, `preview`, `target`, `readOnly` or `layout` changes, or `nodeApiUrl` sends the target's calls to another server, the component sends the last unsaved answers to the old target and loads again, so a host does not have to remount it.
+
+The props, the target endpoints and the events are described in [docs/consultation-sdk.md](https://github.com/TotalAccessHealth/consultation/blob/main/docs/consultation-sdk.md).
+
+## Develop
+
+The package lives in the `sdk/` folder of the CB repo. Run these commands from the repo root:
+
+| Command | What it does |
+|---------|--------------|
+| `pnpm build:sdk` | Builds `sdk/dist`: the bundle and the type declarations. |
+| `pnpm test:sdk` | Runs the tests. |
+| `pnpm typecheck:sdk` | Checks the types. |
+
+`pnpm dev` and `pnpm build` build the package first, because the CB preview uses it. `pnpm dev` builds it only once, so when you change the package while CB runs, also run `pnpm dev:sdk` to rebuild on each change.
+
+`src/flow/questionnaire.ts` and its test are copies of Connect's `utils/questionnaire.ts` and its test at commit `53135f37` on Connect `main`. Until Connect uses this package, a change to the flow goes to both repos, with its tests. When you copy a newer version, change the commit here and in the design doc.
+
+## Publish
+
+1. Change `version` in `sdk/package.json`.
+2. Run `npm publish` from `sdk/`. It builds and tests the package first, and it asks for your npm 2FA code.