@smarter.sh/ui-chat 0.16.2 → 0.36.0-alpha.4
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 +22 -18
- package/dist/embed.js +57 -57
- package/dist/embed.js.map +1 -1
- package/dist/smarter-chat-library.es.js +2352 -2321
- package/dist/smarter-chat-library.es.js.map +1 -1
- package/dist/smarter-chat-library.umd.js +51 -51
- package/dist/smarter-chat-library.umd.js.map +1 -1
- package/package.json +7 -3
- package/LICENSE +0 -671
package/README.md
CHANGED
|
@@ -4,15 +4,15 @@
|
|
|
4
4
|
> WordPress, Django, Flask, Node.js or plain HTML, and it gets its behavior and its look from the LLMClient's YAML
|
|
5
5
|
> manifest.
|
|
6
6
|
|
|
7
|
-
[](https://github.com/smarter-sh/smarter/tree/main/smarter/react/packages/smarter.sh-chat)
|
|
8
8
|
[](https://www.npmjs.com/package/@smarter.sh/ui-chat)
|
|
9
9
|
[](https://www.npmjs.com/package/@smarter.sh/ui-chat)
|
|
10
|
-
[](https://github.com/smarter-sh/smarter/actions/workflows/uiChatRelease.yml)
|
|
11
11
|
[](https://docs.smarter.sh/smarter-framework/smarter-chat.html)
|
|
12
|
-
[](https://app.codecov.io/gh/smarter-sh/smarter)
|
|
13
13
|
[](#typescript)
|
|
14
14
|
[](https://react.dev)
|
|
15
|
-
[](https://github.com/smarter-sh/smarter
|
|
15
|
+
[](https://github.com/smarter-sh/smarter/blob/main/LICENSE)
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
|
|
@@ -22,8 +22,8 @@ You build and run the chatbot on Smarter, and this package displays it on your p
|
|
|
22
22
|
[docs.smarter.sh](https://docs.smarter.sh/smarter-framework/smarter-chat.html).
|
|
23
23
|
|
|
24
24
|
**[Documentation](https://docs.smarter.sh/smarter-framework/smarter-chat.html)** ·
|
|
25
|
-
**[Storybook](#development)** · **[Changelog](https://github.com/smarter-sh/smarter
|
|
26
|
-
**[Issues](https://github.com/smarter-sh/smarter
|
|
25
|
+
**[Storybook](#development)** · **[Changelog](https://github.com/smarter-sh/smarter/blob/main/changelogs/CHANGELOG.md)** ·
|
|
26
|
+
**[Issues](https://github.com/smarter-sh/smarter/issues)**
|
|
27
27
|
|
|
28
28
|
## Contents
|
|
29
29
|
|
|
@@ -528,26 +528,30 @@ Smarter Chat supports current versions of Chrome, Edge, Firefox and Safari. It u
|
|
|
528
528
|
|
|
529
529
|
## Development
|
|
530
530
|
|
|
531
|
+
Smarter Chat is developed in the [Smarter repository](https://github.com/smarter-sh/smarter/tree/main/smarter/react/packages/smarter.sh-chat), as a package of its React workspace, and is
|
|
532
|
+
released with each Smarter release, at the platform's version:
|
|
533
|
+
|
|
531
534
|
```console
|
|
532
|
-
git clone https://github.com/smarter-sh/smarter
|
|
533
|
-
cd smarter
|
|
534
|
-
make
|
|
535
|
-
make
|
|
536
|
-
|
|
535
|
+
git clone https://github.com/smarter-sh/smarter.git
|
|
536
|
+
cd smarter
|
|
537
|
+
make react-install # npm install, for the whole React workspace
|
|
538
|
+
make react-storybook APP=smarter.sh-chat # Storybook at http://localhost:6006, with the Smarter api mocked
|
|
539
|
+
cd smarter/react
|
|
540
|
+
npx vitest run --project smarter.sh-chat # Vitest; every story is also rendered as a test
|
|
537
541
|
```
|
|
538
542
|
|
|
539
543
|
You don't need a Smarter backend: the stories mock the api with [MSW](https://mswjs.io/), using fixtures that are
|
|
540
|
-
validated against the contract's schema. See
|
|
541
|
-
[
|
|
542
|
-
workflow
|
|
543
|
-
[
|
|
544
|
-
|
|
544
|
+
validated against the contract's schema. See the
|
|
545
|
+
[developer guide](https://docs.smarter.sh/smarter-framework/smarter-chat/development.html) for the architecture, the
|
|
546
|
+
rest of the workflow and releases. The package's history before it moved into the Smarter repository, up to version
|
|
547
|
+
0.16.2, is in [CHANGELOG.md](https://github.com/smarter-sh/smarter/tree/main/smarter/react/packages/smarter.sh-chat/CHANGELOG.md) and the archived
|
|
548
|
+
[smarter-sh/smarter-chat](https://github.com/smarter-sh/smarter-chat) repository.
|
|
545
549
|
|
|
546
550
|
## License
|
|
547
551
|
|
|
548
|
-
[AGPL-3.0-or-later](https://github.com/smarter-sh/smarter
|
|
552
|
+
[AGPL-3.0-or-later](https://github.com/smarter-sh/smarter/blob/main/LICENSE), as Smarter is. Copyright © Lawrence
|
|
549
553
|
McDaniel.
|
|
550
554
|
|
|
551
555
|
Contributions are welcome: code, documentation, how-to videos, testing and community help. See
|
|
552
|
-
[CONTRIBUTING.md](https://github.com/smarter-sh/smarter
|
|
556
|
+
[CONTRIBUTING.md](https://github.com/smarter-sh/smarter/blob/main/CONTRIBUTING.md), or contact
|
|
553
557
|
[Lawrence McDaniel](https://lawrencemcdaniel.com/contact).
|