guideai-app 0.2.5 → 0.2.6
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/GuideAI.js +1 -1
- package/GuideAI.js.map +1 -1
- package/README.md +39 -1
- package/dist/GuideAI.js +1 -1
- package/dist/GuideAI.js.map +1 -1
- package/dist/components/TextInput.d.ts +8 -0
- package/dist/components/TranscriptBox.d.ts +17 -0
- package/dist/index.d.ts +2 -0
- package/dist/metric/event-listner.d.ts +113 -0
- package/dist/metric/index.d.ts +4 -0
- package/dist/metric/metadata-tracker.d.ts +33 -0
- package/dist/styles/GuideAI.styles.d.ts +1 -1
- package/dist/types/GuideAI.types.d.ts +18 -0
- package/dist/types/metadata.types.d.ts +46 -0
- package/dist/utils/api.d.ts +4 -0
- package/dist/utils/messageStorage.d.ts +1 -1
- package/metadata-tracking-example.md +324 -0
- package/package.json +1 -1
- package/text-input-usage.md +321 -0
- package/transcript-toggle-usage.md +267 -0
- package/dist/GuideAI.js.LICENSE.txt +0 -16
- package/dist/components/Styles.d.ts +0 -3
- package/dist/components/Styles.js +0 -6
- package/dist/components/Styles.js.map +0 -1
- package/dist/hooks/useConversation.d.ts +0 -11
- package/dist/hooks/useConversation.js +0 -286
- package/dist/hooks/useConversation.js.map +0 -1
- package/dist/hooks/useRecording.d.ts +0 -12
- package/dist/hooks/useRecording.js +0 -362
- package/dist/hooks/useRecording.js.map +0 -1
- package/dist/index.esm.js +0 -1
- package/dist/index.esm.js.map +0 -1
- package/dist/index.js +0 -1
- package/dist/index.js.map +0 -1
- package/dist/messageStorageUtils.d.ts +0 -26
- package/dist/types/index.d.ts +0 -20
- package/dist/types/index.js +0 -2
- package/dist/types/index.js.map +0 -1
- package/dist/types/workflow.d.ts +0 -24
- package/dist/types.d.ts +0 -1
- package/dist/types.js +0 -2
- package/dist/types.js.map +0 -1
- package/dist/utils/api-services.d.ts +0 -5
- package/dist/utils/api-services.js +0 -203
- package/dist/utils/api-services.js.map +0 -1
- package/dist/utils/dom-interaction.d.ts +0 -2
- package/dist/utils/dom-interaction.js +0 -195
- package/dist/utils/dom-interaction.js.map +0 -1
- package/dist/utils/dom.d.ts +0 -1
- package/dist/utils/messageStorageUtils.d.ts +0 -26
- package/dist/utils/react-hooks.d.ts +0 -9
- package/dist/utils/react-hooks.js +0 -19
- package/dist/utils/react-hooks.js.map +0 -1
- package/dist/utils/storage.d.ts +0 -14
- package/dist/utils/storage.js +0 -27
- package/dist/utils/storage.js.map +0 -1
- package/dist/utils/webrtc.d.ts +0 -3
- package/dist/utils/webrtc.js +0 -135
- package/dist/utils/webrtc.js.map +0 -1
- package/dist/utils/workflowUtils.d.ts +0 -17
- package/dist/utils/workflowValidator.d.ts +0 -17
- package/dist/workflows/certificateWorkflow.d.ts +0 -7
- package/dist/workflows/index.d.ts +0 -6
- package/todo.md +0 -2
package/README.md
CHANGED
|
@@ -70,4 +70,42 @@ position?: {
|
|
|
70
70
|
organizationKey="your-org-key"
|
|
71
71
|
position={{ top: '20px', right: '20px' }}
|
|
72
72
|
/>
|
|
73
|
-
```
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Transcript Feature
|
|
76
|
+
|
|
77
|
+
GuideAI now includes a beautiful transcript interface that displays conversations between users and the AI in a transparent Apple-style box.
|
|
78
|
+
|
|
79
|
+
### Features
|
|
80
|
+
|
|
81
|
+
- **Glassmorphism Design**: Transparent background with backdrop blur effects
|
|
82
|
+
- **Apple-style Interface**: Clean, modern design inspired by Apple's UI principles
|
|
83
|
+
- **Real-time Updates**: Messages appear as they're exchanged
|
|
84
|
+
- **Timestamps**: Each message shows when it was sent
|
|
85
|
+
- **Auto-scroll**: Automatically scrolls to the latest messages
|
|
86
|
+
- **Responsive**: Works perfectly on all device sizes
|
|
87
|
+
|
|
88
|
+
### How to Use
|
|
89
|
+
|
|
90
|
+
1. Start a conversation with GuideAI by clicking the microphone button
|
|
91
|
+
2. The transcript automatically appears as an overlay when the conversation begins
|
|
92
|
+
3. The transcript shows all messages with clear visual distinction between user and AI messages
|
|
93
|
+
4. Messages appear in real-time as the conversation progresses
|
|
94
|
+
5. Click the "×" button or click outside the transcript to close it
|
|
95
|
+
6. The transcript automatically closes when the conversation ends
|
|
96
|
+
|
|
97
|
+
### Transcript Interface
|
|
98
|
+
|
|
99
|
+
The transcript interface includes:
|
|
100
|
+
- **Header**: Shows "Conversation Transcript" with a close button
|
|
101
|
+
- **Messages**: Chat-like interface with different styles for user and AI messages
|
|
102
|
+
- **Timestamps**: Each message displays the time it was sent
|
|
103
|
+
- **Footer**: Shows the total number of messages in the conversation
|
|
104
|
+
|
|
105
|
+
### Styling
|
|
106
|
+
|
|
107
|
+
The transcript uses modern CSS features including:
|
|
108
|
+
- `backdrop-filter: blur()` for the glassmorphism effect
|
|
109
|
+
- CSS animations for smooth transitions
|
|
110
|
+
- Responsive design that adapts to different screen sizes
|
|
111
|
+
- Custom scrollbar styling for a polished look
|