@irisidea/kalrav-ai 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 +21 -21
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Kalrav AI is a cross-framework chatbot widget that seamlessly integrates into your web applications. Install once, use everywhere.
|
|
6
6
|
|
|
7
|
-
[](https://www.npmjs.com/package/kalrav-ai)
|
|
7
|
+
[](https://www.npmjs.com/package/@irisidea/kalrav-ai)
|
|
8
8
|
[](https://opensource.org/licenses/MIT)
|
|
9
9
|
|
|
10
10
|
## ✨ Features
|
|
@@ -20,11 +20,11 @@ Kalrav AI is a cross-framework chatbot widget that seamlessly integrates into yo
|
|
|
20
20
|
## 📦 Installation
|
|
21
21
|
|
|
22
22
|
```bash
|
|
23
|
-
npm install kalrav-ai
|
|
23
|
+
npm install @irisidea/kalrav-ai
|
|
24
24
|
# or
|
|
25
|
-
yarn add kalrav-ai
|
|
25
|
+
yarn add @irisidea/kalrav-ai
|
|
26
26
|
# or
|
|
27
|
-
pnpm add kalrav-ai
|
|
27
|
+
pnpm add @irisidea/kalrav-ai
|
|
28
28
|
```
|
|
29
29
|
|
|
30
30
|
> **Works with both JavaScript and TypeScript!** All examples below work in `.js`, `.jsx`, `.ts`, and `.tsx` files.
|
|
@@ -52,7 +52,7 @@ https://kalrav-central-system-api.kalrav.ai/api/agent-ui/{agentId}
|
|
|
52
52
|
|
|
53
53
|
**TypeScript:**
|
|
54
54
|
```tsx
|
|
55
|
-
import { KalravWidget } from 'kalrav-ai/react';
|
|
55
|
+
import { KalravWidget } from '@irisidea/kalrav-ai/react';
|
|
56
56
|
|
|
57
57
|
function App() {
|
|
58
58
|
return (
|
|
@@ -69,7 +69,7 @@ function App() {
|
|
|
69
69
|
|
|
70
70
|
**JavaScript:**
|
|
71
71
|
```jsx
|
|
72
|
-
import { KalravWidget } from 'kalrav-ai/react';
|
|
72
|
+
import { KalravWidget } from '@irisidea/kalrav-ai/react';
|
|
73
73
|
|
|
74
74
|
function App() {
|
|
75
75
|
return (
|
|
@@ -87,7 +87,7 @@ function App() {
|
|
|
87
87
|
**Programmatic Control:**
|
|
88
88
|
|
|
89
89
|
```jsx
|
|
90
|
-
import { useKalrav } from 'kalrav-ai/react';
|
|
90
|
+
import { useKalrav } from '@irisidea/kalrav-ai/react';
|
|
91
91
|
|
|
92
92
|
function ChatButton() {
|
|
93
93
|
const kalrav = useKalrav({
|
|
@@ -110,7 +110,7 @@ function ChatButton() {
|
|
|
110
110
|
**App Router** (`app/layout.js` or `app/layout.tsx`):
|
|
111
111
|
|
|
112
112
|
```javascript
|
|
113
|
-
import { KalravWidget } from 'kalrav-ai/nextjs';
|
|
113
|
+
import { KalravWidget } from '@irisidea/kalrav-ai/nextjs';
|
|
114
114
|
|
|
115
115
|
export default function RootLayout({ children }) {
|
|
116
116
|
return (
|
|
@@ -130,7 +130,7 @@ export default function RootLayout({ children }) {
|
|
|
130
130
|
**Pages Router** (`pages/_app.js` or `pages/_app.tsx`):
|
|
131
131
|
|
|
132
132
|
```tsx
|
|
133
|
-
import { KalravWidget } from 'kalrav-ai/nextjs';
|
|
133
|
+
import { KalravWidget } from '@irisidea/kalrav-ai/nextjs';
|
|
134
134
|
|
|
135
135
|
function MyApp({ Component, pageProps }) {
|
|
136
136
|
return (
|
|
@@ -150,7 +150,7 @@ function MyApp({ Component, pageProps }) {
|
|
|
150
150
|
```tsx
|
|
151
151
|
'use client';
|
|
152
152
|
|
|
153
|
-
import { useKalrav } from 'kalrav-ai/nextjs';
|
|
153
|
+
import { useKalrav } from '@irisidea/kalrav-ai/nextjs';
|
|
154
154
|
|
|
155
155
|
function ChatButton() {
|
|
156
156
|
const kalrav = useKalrav({
|
|
@@ -183,7 +183,7 @@ function ChatButton() {
|
|
|
183
183
|
</template>
|
|
184
184
|
|
|
185
185
|
<script setup>
|
|
186
|
-
import { KalravWidget } from 'kalrav-ai/vue';
|
|
186
|
+
import { KalravWidget } from '@irisidea/kalrav-ai/vue';
|
|
187
187
|
</script>
|
|
188
188
|
```
|
|
189
189
|
|
|
@@ -197,7 +197,7 @@ import { KalravWidget } from 'kalrav-ai/vue';
|
|
|
197
197
|
</template>
|
|
198
198
|
|
|
199
199
|
<script setup>
|
|
200
|
-
import { useKalrav } from 'kalrav-ai/vue';
|
|
200
|
+
import { useKalrav } from '@irisidea/kalrav-ai/vue';
|
|
201
201
|
|
|
202
202
|
const kalrav = useKalrav({
|
|
203
203
|
apiKey: 'your-api-key',
|
|
@@ -215,7 +215,7 @@ const kalrav = useKalrav({
|
|
|
215
215
|
```typescript
|
|
216
216
|
import { NgModule } from '@angular/core';
|
|
217
217
|
import { BrowserModule } from '@angular/platform-browser';
|
|
218
|
-
import { KalravModule } from 'kalrav-ai/angular';
|
|
218
|
+
import { KalravModule } from '@irisidea/kalrav-ai/angular';
|
|
219
219
|
import { AppComponent } from './app.component';
|
|
220
220
|
|
|
221
221
|
@NgModule({
|
|
@@ -252,7 +252,7 @@ export class AppComponent {}
|
|
|
252
252
|
|
|
253
253
|
```typescript
|
|
254
254
|
import { Component } from '@angular/core';
|
|
255
|
-
import { KalravService } from 'kalrav-ai/angular';
|
|
255
|
+
import { KalravService } from '@irisidea/kalrav-ai/angular';
|
|
256
256
|
|
|
257
257
|
@Component({
|
|
258
258
|
selector: 'app-chat-button',
|
|
@@ -290,7 +290,7 @@ export class ChatButtonComponent {
|
|
|
290
290
|
<button id="chatBtn">Chat with us</button>
|
|
291
291
|
|
|
292
292
|
<script type="module">
|
|
293
|
-
import { createKalrav } from 'https://cdn.jsdelivr.net/npm/kalrav-ai@latest/dist/index.mjs';
|
|
293
|
+
import { createKalrav } from 'https://cdn.jsdelivr.net/npm/@irisidea/kalrav-ai@latest/dist/index.mjs';
|
|
294
294
|
|
|
295
295
|
const kalrav = createKalrav({
|
|
296
296
|
apiKey: 'your-api-key',
|
|
@@ -305,7 +305,7 @@ export class ChatButtonComponent {
|
|
|
305
305
|
|
|
306
306
|
**With npm/bundler:**
|
|
307
307
|
```javascript
|
|
308
|
-
import { createKalrav } from 'kalrav-ai';
|
|
308
|
+
import { createKalrav } from '@irisidea/kalrav-ai';
|
|
309
309
|
|
|
310
310
|
const kalrav = createKalrav({
|
|
311
311
|
apiKey: 'your-api-key',
|
|
@@ -390,7 +390,7 @@ You can also use the core library without any framework. Perfect for static site
|
|
|
390
390
|
|
|
391
391
|
**JavaScript:**
|
|
392
392
|
```javascript
|
|
393
|
-
import { createKalrav } from 'kalrav-ai';
|
|
393
|
+
import { createKalrav } from '@irisidea/kalrav-ai';
|
|
394
394
|
|
|
395
395
|
const kalrav = createKalrav({
|
|
396
396
|
apiKey: 'your-api-key',
|
|
@@ -406,8 +406,8 @@ kalrav.close();
|
|
|
406
406
|
|
|
407
407
|
**TypeScript:**
|
|
408
408
|
```typescript
|
|
409
|
-
import { createKalrav } from 'kalrav-ai';
|
|
410
|
-
import type { KalravConfig } from 'kalrav-ai';
|
|
409
|
+
import { createKalrav } from '@irisidea/kalrav-ai';
|
|
410
|
+
import type { KalravConfig } from '@irisidea/kalrav-ai';
|
|
411
411
|
|
|
412
412
|
const config: KalravConfig = {
|
|
413
413
|
apiKey: 'your-api-key',
|
|
@@ -495,7 +495,7 @@ VITE_KALRAV_AGENT_ID=your-agent-id
|
|
|
495
495
|
Kalrav AI is written in TypeScript and provides full type definitions out of the box.
|
|
496
496
|
|
|
497
497
|
```typescript
|
|
498
|
-
import type { KalravConfig, KalravWidget } from 'kalrav-ai/react';
|
|
498
|
+
import type { KalravConfig, KalravWidget } from '@irisidea/kalrav-ai/react';
|
|
499
499
|
|
|
500
500
|
const config: KalravConfig = {
|
|
501
501
|
apiKey: 'your-api-key',
|
|
@@ -531,7 +531,7 @@ npm link
|
|
|
531
531
|
2. **Link in your test project:**
|
|
532
532
|
```bash
|
|
533
533
|
cd your-test-app
|
|
534
|
-
npm link kalrav-ai
|
|
534
|
+
npm link @irisidea/kalrav-ai
|
|
535
535
|
```
|
|
536
536
|
|
|
537
537
|
3. **Use local Docker widget URL:**
|
package/package.json
CHANGED