@arbor-education/ask-arbor-chat-panel 1.0.0 → 1.0.2
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 +50 -3
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -77,9 +77,21 @@ AskArbor.destroy() // unmount and clean up
|
|
|
77
77
|
|
|
78
78
|
## React component (NPM package)
|
|
79
79
|
|
|
80
|
+
### Installation
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
yarn add @arbor-education/ask-arbor-chat-panel
|
|
84
|
+
# or
|
|
85
|
+
npm install @arbor-education/ask-arbor-chat-panel
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Peer dependencies: `react ≥18`, `react-dom ≥18`, `@arbor-education/design-system.components ≥0.21`.
|
|
89
|
+
|
|
90
|
+
### Usage
|
|
91
|
+
|
|
80
92
|
```tsx
|
|
81
|
-
import {ChatPanel} from 'ask-arbor-chat-panel';
|
|
82
|
-
import 'ask-arbor-chat-panel/style.css';
|
|
93
|
+
import {ChatPanel} from '@arbor-education/ask-arbor-chat-panel';
|
|
94
|
+
import '@arbor-education/ask-arbor-chat-panel/style.css';
|
|
83
95
|
|
|
84
96
|
<ChatPanel
|
|
85
97
|
chatUrl="https://your-api.example.com/chat"
|
|
@@ -88,7 +100,42 @@ import 'ask-arbor-chat-panel/style.css';
|
|
|
88
100
|
/>
|
|
89
101
|
```
|
|
90
102
|
|
|
91
|
-
|
|
103
|
+
### Published package contents
|
|
104
|
+
|
|
105
|
+
```
|
|
106
|
+
dist/
|
|
107
|
+
index.js # ESM bundle
|
|
108
|
+
index.cjs # CommonJS bundle
|
|
109
|
+
index.d.ts # TypeScript declarations
|
|
110
|
+
style.css # Component styles (must be imported separately)
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
## Releasing
|
|
116
|
+
|
|
117
|
+
Releases are managed via [Changesets](https://github.com/changesets/changesets).
|
|
118
|
+
|
|
119
|
+
### Creating a changeset
|
|
120
|
+
|
|
121
|
+
When your change is ready, run:
|
|
122
|
+
|
|
123
|
+
```bash
|
|
124
|
+
yarn changeset
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
Select the bump type (patch / minor / major) and write a short summary. This creates a file in `.changeset/` - commit it with your branch.
|
|
128
|
+
|
|
129
|
+
### Automated publishing
|
|
130
|
+
|
|
131
|
+
`.github/workflows/release.yml` runs at 07:00 UTC Monday-Friday. It:
|
|
132
|
+
|
|
133
|
+
1. Runs `npx changeset version` to apply any pending changesets and bump the package version
|
|
134
|
+
2. Publishes the updated package to npm (only if the version changed)
|
|
135
|
+
3. Creates a GitHub release with a `.tgz` tarball attached
|
|
136
|
+
4. Posts a success/failure notification to Slack
|
|
137
|
+
|
|
138
|
+
Only the `dist/` directory is included in the published npm package.
|
|
92
139
|
|
|
93
140
|
---
|
|
94
141
|
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@arbor-education/ask-arbor-chat-panel",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "Standalone ChatPanel component — Arbor AI chat interface with no arbor-fe ecosystem dependencies",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
7
|
-
"url": "git+ssh://git@github.com
|
|
7
|
+
"url": "git+ssh://git@github.com/arbor-education/ai.ask-arbor-standalone.git"
|
|
8
8
|
},
|
|
9
9
|
"author": "Rick Bairstow <rick.bairstow@arbor-education.com>",
|
|
10
10
|
"license": "UNLICENSED",
|