@qualified-salesforce/web 0.1.0 → 0.1.1

package/CAPABILITY-REFERENCE.md

@@ -1,12 +1,10 @@
 <!-- Generated file — do not edit by hand. -->
 # Capability reference — Qualified text-only npm/ESM package
 
-Every optional feature the self-hosted `@qualified-salesforce/web` package can be permitted to
-run, and what enrolling each one lets it do.
+Every optional feature in `@qualified-salesforce/web`, and what enrolling each one lets it do.
 
-**Default-deny: every capability below is OFF unless the consumer lists it in**
-**`setup({ capabilities: [...] })`, and Qualified cannot turn one on.** Voice is intentionally
-absent — this build ships text-only and cannot activate a call.
+**Every capability below is off unless you enroll it in `setup({ capabilities: [...] })`.**
+This is the text-only build: it ships no voice/video call code.
 
 ```ts
 import { setup, CAPABILITY_KEYS, type Capability } from "@qualified-salesforce/web";
@@ -15,9 +13,8 @@ import { setup, CAPABILITY_KEYS, type Capability } from "@qualified-salesforce/w
 await setup({ token, apiHost, capabilities: ["analytics", "formCapture"] });
 ```
 
-`await` is optional — the widget boots as soon as `setup()` is called and finishes on its own, so
-it starts and renders whether or not you await. Await it (or use `.then()`) only when you need the
-returned `q(...)` command function (for `identify`, `teardown`, etc.) or want to handle a boot failure.
+`setup()` boots the widget and resolves to the `q(...)` command function (`identify`, `teardown`,
+and the rest). Await it only if you need that function or want to catch a boot failure.
 
 | Capability | Feature unlocked | Data egress / third-party origin | Default |
 | -- | -- | -- | -- |

package/CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to `@qualified-salesforce/web` are recorded here. The format
 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/); the package aims to follow
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.1]
+
+### Added
+
+- **Package README.** The npm package now ships a consumer-facing `README.md` — install, a
+  minimal `setup()` example, the stylesheet/assets note, and a pointer to the capability
+  reference — so it renders on the npm package page. No runtime or API change.
+
 ## [0.1.0]
 
 ### Added
@@ -72,4 +80,5 @@ All notable changes to `@qualified-salesforce/web` are recorded here. The format
   reviewed package is equivalent to absence for what runs in the browser — while letting you enable
   a feature later by changing one `setup()` option, with no separate build.
 
+[0.1.1]: https://github.com/FatbearLabs/fireball/tree/master/npm-package/package-esm
 [0.1.0]: https://github.com/FatbearLabs/fireball/tree/master/npm-package/package-esm

package/README.md

@@ -0,0 +1,65 @@
+# @qualified-salesforce/web
+
+The embeddable Qualified messenger widget, distributed as an unbundled ESM package. You import it
+into your own app and boot it with your team token.
+
+This is the **text-only** build: it ships the chat runtime, its stylesheet, and its fonts, and no
+voice/video call code.
+
+## Install
+
+```bash
+npm install @qualified-salesforce/web
+```
+
+## Quick start
+
+```js
+import { setup } from "@qualified-salesforce/web";
+
+const qualified = await setup({
+  token: "<team-token>",
+  apiHost: "https://app.qualified.com",
+  // Off by default: list only the capabilities you want. See "Capabilities".
+  capabilities: ["formCapture"],
+});
+
+qualified("identify", { email: "visitor@example.com" });
+```
+
+`setup()` boots the widget and resolves to the `q(...)` command function (`identify`, `teardown`,
+and the rest). Await it only if you need that function or want to catch a boot failure.
+
+## Styling
+
+Don't import the stylesheet yourself — `setup()` loads it. Importing it through your own bundler
+renders the widget unstyled.
+
+## Capabilities
+
+Every optional feature is **off unless you enroll it** in the `capabilities` option. Omitting
+`capabilities` (or passing `[]`) leaves them all off.
+
+See [`CAPABILITY-REFERENCE.md`](./CAPABILITY-REFERENCE.md) for the full list — what each capability
+does, the data it sends, whether it needs a CSP change, and its default.
+
+## TypeScript
+
+The package ships its own type declarations. `Capability` is a literal union, so a mistyped key is
+a compile error, and `CAPABILITY_KEYS` exposes the same set as a runtime value:
+
+```ts
+import { setup, CAPABILITY_KEYS, type Capability } from "@qualified-salesforce/web";
+
+const permitted: Capability[] = ["analytics", "formCapture"];
+
+const qualified = await setup({
+  token: "<team-token>",
+  apiHost: "https://app.qualified.com",
+  capabilities: permitted,
+});
+```
+
+## License
+
+Proprietary. See [`LICENSE.txt`](./LICENSE.txt).

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@qualified-salesforce/web",
-  "version": "0.1.0",
-  "description": "Embeddable Qualified messenger widget for self-hosted deployments.",
+  "version": "0.1.1",
+  "description": "Embeddable Qualified messenger widget (text-only ESM build).",
   "license": "SEE LICENSE IN LICENSE.txt",
   "private": false,
   "type": "module",