@interopio/io-assist-ng 0.0.1
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 +218 -0
- package/dist/README.md +218 -0
- package/dist/fesm2022/interopio-io-assist-ng.mjs +5345 -0
- package/dist/fesm2022/interopio-io-assist-ng.mjs.map +1 -0
- package/dist/index.d.ts +39 -0
- package/dist/styles.css +2 -0
- package/package.json +70 -0
package/README.md
ADDED
|
@@ -0,0 +1,218 @@
|
|
|
1
|
+
# @interopio/io-assist-ng
|
|
2
|
+
|
|
3
|
+
Angular library for integrating io.Intelligence AI assistance capabilities into Angular applications (Angular 20.3+).
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @interopio/io-assist-ng
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Prerequisites
|
|
12
|
+
|
|
13
|
+
- Angular 20.3 or higher
|
|
14
|
+
- Node.js 20.19+ (< 22)
|
|
15
|
+
- npm 10.0.0 or higher
|
|
16
|
+
|
|
17
|
+
## Setup
|
|
18
|
+
|
|
19
|
+
### 1. Import Styles
|
|
20
|
+
|
|
21
|
+
Add the library styles to your Angular application:
|
|
22
|
+
|
|
23
|
+
**Option A: In `angular.json`**
|
|
24
|
+
```json
|
|
25
|
+
{
|
|
26
|
+
"projects": {
|
|
27
|
+
"your-app": {
|
|
28
|
+
"architect": {
|
|
29
|
+
"build": {
|
|
30
|
+
"options": {
|
|
31
|
+
"styles": [
|
|
32
|
+
"node_modules/@interopio/io-assist-ng/styles.css",
|
|
33
|
+
"src/styles.css"
|
|
34
|
+
]
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
**Option B: In `styles.css`/`styles.scss`**
|
|
44
|
+
```css
|
|
45
|
+
@import '@interopio/io-assist-ng/styles.css';
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### 2. Import Components
|
|
49
|
+
|
|
50
|
+
Import the components you need in your Angular component:
|
|
51
|
+
|
|
52
|
+
```typescript
|
|
53
|
+
import { Component } from '@angular/core';
|
|
54
|
+
import { IoAssist } from '@interopio/io-assist-ng';
|
|
55
|
+
|
|
56
|
+
@Component({
|
|
57
|
+
selector: 'app-root',
|
|
58
|
+
standalone: true,
|
|
59
|
+
imports: [IoAssist],
|
|
60
|
+
template: `
|
|
61
|
+
<io-assist [config]="assistConfig"></io-assist>
|
|
62
|
+
`
|
|
63
|
+
})
|
|
64
|
+
export class AppComponent {
|
|
65
|
+
assistConfig = {
|
|
66
|
+
// Your configuration here
|
|
67
|
+
};
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Configuration
|
|
72
|
+
|
|
73
|
+
The `IoAssist` component accepts a configuration object via the `[config]` input:
|
|
74
|
+
|
|
75
|
+
```typescript
|
|
76
|
+
import { IoAssistTempConfig } from '@interopio/io-assist-ng';
|
|
77
|
+
|
|
78
|
+
const assistConfig: IoAssistTempConfig = {
|
|
79
|
+
// Configuration options
|
|
80
|
+
apiEndpoint: 'https://your-api-endpoint.com',
|
|
81
|
+
theme: 'light', // or 'dark'
|
|
82
|
+
// Add other configuration options as needed
|
|
83
|
+
};
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## Components
|
|
87
|
+
|
|
88
|
+
### IoAssist
|
|
89
|
+
|
|
90
|
+
Main component for AI assistance functionality.
|
|
91
|
+
|
|
92
|
+
**Usage:**
|
|
93
|
+
```html
|
|
94
|
+
<io-assist
|
|
95
|
+
[config]="assistConfig"
|
|
96
|
+
></io-assist>
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
**Inputs:**
|
|
100
|
+
- `config: IoAssistTempConfig` - Configuration object for the assistant
|
|
101
|
+
|
|
102
|
+
## Styling
|
|
103
|
+
|
|
104
|
+
The library uses TailwindCSS for styling. The styles are pre-compiled and included in the distribution.
|
|
105
|
+
|
|
106
|
+
### Custom Theming
|
|
107
|
+
|
|
108
|
+
To customize the appearance, override CSS variables in your application:
|
|
109
|
+
|
|
110
|
+
```css
|
|
111
|
+
:root {
|
|
112
|
+
--io-assist-primary-color: #your-color;
|
|
113
|
+
--io-assist-background: #your-background;
|
|
114
|
+
/* Add other custom variables */
|
|
115
|
+
}
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## Examples
|
|
119
|
+
|
|
120
|
+
### Basic Integration
|
|
121
|
+
|
|
122
|
+
```typescript
|
|
123
|
+
import { Component } from '@angular/core';
|
|
124
|
+
import { IoAssist, IoAssistTempConfig } from '@interopio/io-assist-ng';
|
|
125
|
+
|
|
126
|
+
@Component({
|
|
127
|
+
selector: 'app-dashboard',
|
|
128
|
+
standalone: true,
|
|
129
|
+
imports: [IoAssist],
|
|
130
|
+
template: `
|
|
131
|
+
<div class="dashboard">
|
|
132
|
+
<h1>My Dashboard</h1>
|
|
133
|
+
<io-assist [config]="config"></io-assist>
|
|
134
|
+
</div>
|
|
135
|
+
`
|
|
136
|
+
})
|
|
137
|
+
export class DashboardComponent {
|
|
138
|
+
config: IoAssistTempConfig = {
|
|
139
|
+
apiEndpoint: 'https://api.example.com/assist',
|
|
140
|
+
theme: 'light'
|
|
141
|
+
};
|
|
142
|
+
}
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
## Browser Support
|
|
146
|
+
|
|
147
|
+
- Chrome/Edge (latest 2 versions)
|
|
148
|
+
- Firefox (latest 2 versions)
|
|
149
|
+
- Safari (latest 2 versions)
|
|
150
|
+
|
|
151
|
+
## Dependencies
|
|
152
|
+
|
|
153
|
+
This library has peer dependencies on:
|
|
154
|
+
- `@angular/core`: ^20.3.0
|
|
155
|
+
- `@angular/common`: ^20.3.0
|
|
156
|
+
- `@interopio/intel-web`: Latest
|
|
157
|
+
|
|
158
|
+
These will be automatically installed with npm 7+.
|
|
159
|
+
|
|
160
|
+
## TypeScript Support
|
|
161
|
+
|
|
162
|
+
Full TypeScript support with type definitions included.
|
|
163
|
+
|
|
164
|
+
```typescript
|
|
165
|
+
import type { IoAssistTempConfig, IoAssistResponse } from '@interopio/io-assist-ng';
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
## Troubleshooting
|
|
169
|
+
|
|
170
|
+
### Styles Not Loading
|
|
171
|
+
|
|
172
|
+
Ensure you've imported the styles in `angular.json` or your main stylesheet:
|
|
173
|
+
```json
|
|
174
|
+
"styles": [
|
|
175
|
+
"node_modules/@interopio/io-assist-ng/styles.css"
|
|
176
|
+
]
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
### Component Not Found
|
|
180
|
+
|
|
181
|
+
Make sure you've imported the component in your standalone component or module:
|
|
182
|
+
```typescript
|
|
183
|
+
imports: [IoAssist]
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
### Type Errors
|
|
187
|
+
|
|
188
|
+
Ensure your TypeScript version is 5.0 or higher and `strict` mode is enabled in `tsconfig.json`.
|
|
189
|
+
|
|
190
|
+
## Development
|
|
191
|
+
|
|
192
|
+
This library is built with:
|
|
193
|
+
- Angular 20.3
|
|
194
|
+
- TailwindCSS 4.1
|
|
195
|
+
- TypeScript 5.x
|
|
196
|
+
|
|
197
|
+
## Support
|
|
198
|
+
|
|
199
|
+
For issues, questions, or contributions, please visit:
|
|
200
|
+
- GitHub: [io.Intelligence JS Repository]
|
|
201
|
+
- Documentation: [Coming Soon]
|
|
202
|
+
- Issues: [GitHub Issues]
|
|
203
|
+
|
|
204
|
+
## License
|
|
205
|
+
|
|
206
|
+
ISC License
|
|
207
|
+
|
|
208
|
+
## Changelog
|
|
209
|
+
|
|
210
|
+
### 0.0.0 (Initial Release)
|
|
211
|
+
- Initial release with core `IoAssist` component
|
|
212
|
+
- TailwindCSS styling support
|
|
213
|
+
- TypeScript type definitions
|
|
214
|
+
- Angular 20.3 compatibility
|
|
215
|
+
|
|
216
|
+
---
|
|
217
|
+
|
|
218
|
+
**Note:** This library is currently in development. API and features may change before the stable 1.0.0 release.
|
package/dist/README.md
ADDED
|
@@ -0,0 +1,218 @@
|
|
|
1
|
+
# @interopio/io-assist-ng
|
|
2
|
+
|
|
3
|
+
Angular library for integrating io.Intelligence AI assistance capabilities into Angular applications (Angular 20.3+).
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @interopio/io-assist-ng
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Prerequisites
|
|
12
|
+
|
|
13
|
+
- Angular 20.3 or higher
|
|
14
|
+
- Node.js 20.19+ (< 22)
|
|
15
|
+
- npm 10.0.0 or higher
|
|
16
|
+
|
|
17
|
+
## Setup
|
|
18
|
+
|
|
19
|
+
### 1. Import Styles
|
|
20
|
+
|
|
21
|
+
Add the library styles to your Angular application:
|
|
22
|
+
|
|
23
|
+
**Option A: In `angular.json`**
|
|
24
|
+
```json
|
|
25
|
+
{
|
|
26
|
+
"projects": {
|
|
27
|
+
"your-app": {
|
|
28
|
+
"architect": {
|
|
29
|
+
"build": {
|
|
30
|
+
"options": {
|
|
31
|
+
"styles": [
|
|
32
|
+
"node_modules/@interopio/io-assist-ng/styles.css",
|
|
33
|
+
"src/styles.css"
|
|
34
|
+
]
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
**Option B: In `styles.css`/`styles.scss`**
|
|
44
|
+
```css
|
|
45
|
+
@import '@interopio/io-assist-ng/styles.css';
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### 2. Import Components
|
|
49
|
+
|
|
50
|
+
Import the components you need in your Angular component:
|
|
51
|
+
|
|
52
|
+
```typescript
|
|
53
|
+
import { Component } from '@angular/core';
|
|
54
|
+
import { IoAssist } from '@interopio/io-assist-ng';
|
|
55
|
+
|
|
56
|
+
@Component({
|
|
57
|
+
selector: 'app-root',
|
|
58
|
+
standalone: true,
|
|
59
|
+
imports: [IoAssist],
|
|
60
|
+
template: `
|
|
61
|
+
<io-assist [config]="assistConfig"></io-assist>
|
|
62
|
+
`
|
|
63
|
+
})
|
|
64
|
+
export class AppComponent {
|
|
65
|
+
assistConfig = {
|
|
66
|
+
// Your configuration here
|
|
67
|
+
};
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Configuration
|
|
72
|
+
|
|
73
|
+
The `IoAssist` component accepts a configuration object via the `[config]` input:
|
|
74
|
+
|
|
75
|
+
```typescript
|
|
76
|
+
import { IoAssistTempConfig } from '@interopio/io-assist-ng';
|
|
77
|
+
|
|
78
|
+
const assistConfig: IoAssistTempConfig = {
|
|
79
|
+
// Configuration options
|
|
80
|
+
apiEndpoint: 'https://your-api-endpoint.com',
|
|
81
|
+
theme: 'light', // or 'dark'
|
|
82
|
+
// Add other configuration options as needed
|
|
83
|
+
};
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## Components
|
|
87
|
+
|
|
88
|
+
### IoAssist
|
|
89
|
+
|
|
90
|
+
Main component for AI assistance functionality.
|
|
91
|
+
|
|
92
|
+
**Usage:**
|
|
93
|
+
```html
|
|
94
|
+
<io-assist
|
|
95
|
+
[config]="assistConfig"
|
|
96
|
+
></io-assist>
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
**Inputs:**
|
|
100
|
+
- `config: IoAssistTempConfig` - Configuration object for the assistant
|
|
101
|
+
|
|
102
|
+
## Styling
|
|
103
|
+
|
|
104
|
+
The library uses TailwindCSS for styling. The styles are pre-compiled and included in the distribution.
|
|
105
|
+
|
|
106
|
+
### Custom Theming
|
|
107
|
+
|
|
108
|
+
To customize the appearance, override CSS variables in your application:
|
|
109
|
+
|
|
110
|
+
```css
|
|
111
|
+
:root {
|
|
112
|
+
--io-assist-primary-color: #your-color;
|
|
113
|
+
--io-assist-background: #your-background;
|
|
114
|
+
/* Add other custom variables */
|
|
115
|
+
}
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## Examples
|
|
119
|
+
|
|
120
|
+
### Basic Integration
|
|
121
|
+
|
|
122
|
+
```typescript
|
|
123
|
+
import { Component } from '@angular/core';
|
|
124
|
+
import { IoAssist, IoAssistTempConfig } from '@interopio/io-assist-ng';
|
|
125
|
+
|
|
126
|
+
@Component({
|
|
127
|
+
selector: 'app-dashboard',
|
|
128
|
+
standalone: true,
|
|
129
|
+
imports: [IoAssist],
|
|
130
|
+
template: `
|
|
131
|
+
<div class="dashboard">
|
|
132
|
+
<h1>My Dashboard</h1>
|
|
133
|
+
<io-assist [config]="config"></io-assist>
|
|
134
|
+
</div>
|
|
135
|
+
`
|
|
136
|
+
})
|
|
137
|
+
export class DashboardComponent {
|
|
138
|
+
config: IoAssistTempConfig = {
|
|
139
|
+
apiEndpoint: 'https://api.example.com/assist',
|
|
140
|
+
theme: 'light'
|
|
141
|
+
};
|
|
142
|
+
}
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
## Browser Support
|
|
146
|
+
|
|
147
|
+
- Chrome/Edge (latest 2 versions)
|
|
148
|
+
- Firefox (latest 2 versions)
|
|
149
|
+
- Safari (latest 2 versions)
|
|
150
|
+
|
|
151
|
+
## Dependencies
|
|
152
|
+
|
|
153
|
+
This library has peer dependencies on:
|
|
154
|
+
- `@angular/core`: ^20.3.0
|
|
155
|
+
- `@angular/common`: ^20.3.0
|
|
156
|
+
- `@interopio/intel-web`: Latest
|
|
157
|
+
|
|
158
|
+
These will be automatically installed with npm 7+.
|
|
159
|
+
|
|
160
|
+
## TypeScript Support
|
|
161
|
+
|
|
162
|
+
Full TypeScript support with type definitions included.
|
|
163
|
+
|
|
164
|
+
```typescript
|
|
165
|
+
import type { IoAssistTempConfig, IoAssistResponse } from '@interopio/io-assist-ng';
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
## Troubleshooting
|
|
169
|
+
|
|
170
|
+
### Styles Not Loading
|
|
171
|
+
|
|
172
|
+
Ensure you've imported the styles in `angular.json` or your main stylesheet:
|
|
173
|
+
```json
|
|
174
|
+
"styles": [
|
|
175
|
+
"node_modules/@interopio/io-assist-ng/styles.css"
|
|
176
|
+
]
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
### Component Not Found
|
|
180
|
+
|
|
181
|
+
Make sure you've imported the component in your standalone component or module:
|
|
182
|
+
```typescript
|
|
183
|
+
imports: [IoAssist]
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
### Type Errors
|
|
187
|
+
|
|
188
|
+
Ensure your TypeScript version is 5.0 or higher and `strict` mode is enabled in `tsconfig.json`.
|
|
189
|
+
|
|
190
|
+
## Development
|
|
191
|
+
|
|
192
|
+
This library is built with:
|
|
193
|
+
- Angular 20.3
|
|
194
|
+
- TailwindCSS 4.1
|
|
195
|
+
- TypeScript 5.x
|
|
196
|
+
|
|
197
|
+
## Support
|
|
198
|
+
|
|
199
|
+
For issues, questions, or contributions, please visit:
|
|
200
|
+
- GitHub: [io.Intelligence JS Repository]
|
|
201
|
+
- Documentation: [Coming Soon]
|
|
202
|
+
- Issues: [GitHub Issues]
|
|
203
|
+
|
|
204
|
+
## License
|
|
205
|
+
|
|
206
|
+
ISC License
|
|
207
|
+
|
|
208
|
+
## Changelog
|
|
209
|
+
|
|
210
|
+
### 0.0.0 (Initial Release)
|
|
211
|
+
- Initial release with core `IoAssist` component
|
|
212
|
+
- TailwindCSS styling support
|
|
213
|
+
- TypeScript type definitions
|
|
214
|
+
- Angular 20.3 compatibility
|
|
215
|
+
|
|
216
|
+
---
|
|
217
|
+
|
|
218
|
+
**Note:** This library is currently in development. API and features may change before the stable 1.0.0 release.
|