@outmarket-ai/react-sdk 0.1.0-alpha.1 → 0.1.0-alpha.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,6 +3,8 @@
|
|
|
3
3
|
Embed Outmarket workflows in your React app: the workflow catalog, each workflow's form and its
|
|
4
4
|
conversation, signed in as your user.
|
|
5
5
|
|
|
6
|
+
For a minimal working app, see [Outmarket-AI/react-sdk-example](https://github.com/Outmarket-AI/react-sdk-example).
|
|
7
|
+
|
|
6
8
|
Using the SDK requires Outmarket's approval. See the `LICENSE` file in the package.
|
|
7
9
|
|
|
8
10
|
## Setup
|
|
@@ -11,9 +13,9 @@ Using the SDK requires Outmarket's approval. See the `LICENSE` file in the packa
|
|
|
11
13
|
on, for example `https://app.example.com`. Approval takes 1–2 business days. Until then the
|
|
12
14
|
browser blocks the SDK's calls to Outmarket (CORS).
|
|
13
15
|
|
|
14
|
-
2. **Create an API key.** An Outmarket Admin creates it in **Settings → API Keys** with the
|
|
15
|
-
permission and your servers' IP addresses. Keep the key on your server: it can sign in as
|
|
16
|
-
member of your workspace.
|
|
16
|
+
2. **Create an API key.** An Outmarket System Admin creates it in **Settings → API Keys** with the
|
|
17
|
+
`auth` permission and your servers' IP addresses. Keep the key on your server: it can sign in as
|
|
18
|
+
any member of your workspace.
|
|
17
19
|
|
|
18
20
|
3. **Install the SDK.** It needs React 19.
|
|
19
21
|
|
|
@@ -30,8 +32,9 @@ Using the SDK requires Outmarket's approval. See the `LICENSE` file in the packa
|
|
|
30
32
|
-d '{"email":"jane@example.com"}'
|
|
31
33
|
```
|
|
32
34
|
|
|
33
|
-
Take the email from the signed-in user's session on your server,
|
|
34
|
-
|
|
35
|
+
Take the email from the signed-in user's session on your server, and only an address your sign-in
|
|
36
|
+
has verified the user owns (a confirmed email or a verified identity-provider claim). Never take it
|
|
37
|
+
from anything the browser sends. The user must be a member of your Outmarket workspace. Return the `201` body to your page
|
|
35
38
|
unchanged, with `Cache-Control: no-store`, and keep it out of URLs and logs. Mint once per sign-in:
|
|
36
39
|
the SDK refreshes the session itself.
|
|
37
40
|
|
|
@@ -88,7 +91,6 @@ Mount it once and put the components inside it.
|
|
|
88
91
|
| `onReady` | `({ workflowsByModule }) => void` | Called once the user's workflows have loaded, grouped by module. |
|
|
89
92
|
| `colorMode` | `'light' \| 'dark' \| 'system'` | Color mode of the components. |
|
|
90
93
|
| `theme` | `{ primary?: string }` | Your brand color, as hex. |
|
|
91
|
-
| `apiUrls` | `{ api?, nexus?, gateway? }` | Optional. Paths on your own server that forward to Outmarket's APIs, for example `{ nexus: '/outmarket/nexus/api/v1' }`. |
|
|
92
94
|
|
|
93
95
|
### Components
|
|
94
96
|
|
package/package.json
CHANGED