@smarter.sh/ui-chat 0.36.0-alpha.3 → 0.36.0-alpha.5

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 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
- [![GitHub](https://img.shields.io/badge/github-smarter--sh%2Fsmarter--chat-181717?logo=github)](https://github.com/smarter-sh/smarter-chat)
7
+ [![GitHub](https://img.shields.io/badge/github-smarter--sh%2Fsmarter-181717?logo=github)](https://github.com/smarter-sh/smarter/tree/main/smarter/react/packages/smarter.sh-chat)
8
8
  [![npm version](https://img.shields.io/npm/v/@smarter.sh/ui-chat?logo=npm)](https://www.npmjs.com/package/@smarter.sh/ui-chat)
9
9
  [![npm downloads](https://img.shields.io/npm/dm/@smarter.sh/ui-chat)](https://www.npmjs.com/package/@smarter.sh/ui-chat)
10
- [![Test Status](https://github.com/smarter-sh/smarter-chat/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/smarter-sh/smarter-chat/actions/workflows/test.yml)
10
+ [![Release](https://github.com/smarter-sh/smarter/actions/workflows/uiChatRelease.yml/badge.svg)](https://github.com/smarter-sh/smarter/actions/workflows/uiChatRelease.yml)
11
11
  [![Docs](https://img.shields.io/badge/Read%20the%20Docs-smarter.sh-blue?logo=readthedocs)](https://docs.smarter.sh/smarter-framework/smarter-chat.html)
12
- [![Coverage](https://img.shields.io/codecov/c/github/smarter-sh/smarter-chat/main?label=coverage&logo=codecov)](https://app.codecov.io/gh/smarter-sh/smarter-chat)
12
+ [![Coverage](https://img.shields.io/codecov/c/github/smarter-sh/smarter/main?flag=react&label=coverage&logo=codecov)](https://app.codecov.io/gh/smarter-sh/smarter)
13
13
  [![TypeScript](https://img.shields.io/badge/types-included-blue?logo=typescript&logoColor=white)](#typescript)
14
14
  [![React 19](https://img.shields.io/badge/react-19-61dafb?logo=react&logoColor=white)](https://react.dev)
15
- [![License: AGPL-3.0-or-later](https://img.shields.io/npm/l/@smarter.sh/ui-chat)](https://github.com/smarter-sh/smarter-chat/blob/main/LICENSE)
15
+ [![License: AGPL-3.0-or-later](https://img.shields.io/npm/l/@smarter.sh/ui-chat)](https://github.com/smarter-sh/smarter/blob/main/LICENSE)
16
16
 
17
17
  ![Smarter Chat](https://cdn.smarter.sh/images/smarter-chat-ui-example.png)
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-chat/blob/main/CHANGELOG.md)** ·
26
- **[Issues](https://github.com/smarter-sh/smarter-chat/issues)**
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-chat.git
533
- cd smarter-chat
534
- make init # npm install
535
- make serve # Storybook at http://localhost:6006, with the Smarter api mocked
536
- make test # Vitest; every story is also rendered as a test
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
- [CONTRIBUTING.md](https://github.com/smarter-sh/smarter-chat/blob/main/.github/CONTRIBUTING.md) for the rest of the
542
- workflow (every `make` target, working inside the Smarter repository, commits and releases), and the
543
- [developer guide](https://docs.smarter.sh/smarter-framework/smarter-chat/development.html) for the
544
- architecture.
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-chat/blob/main/LICENSE), as Smarter is. Copyright © Lawrence
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-chat/blob/main/.github/CONTRIBUTING.md), or contact
556
+ [CONTRIBUTING.md](https://github.com/smarter-sh/smarter/blob/main/CONTRIBUTING.md), or contact
553
557
  [Lawrence McDaniel](https://lawrencemcdaniel.com/contact).