@neuralinnovations/dataisland-sdk 0.0.1-dev5 → 0.0.1-dev7

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.
Files changed (39) hide show
  1. package/.github/workflows/publish-npm.yml +15 -2
  2. package/README.md +83 -34
  3. package/docs/.nojekyll +1 -0
  4. package/docs/classes/BasicCredential.md +80 -0
  5. package/docs/classes/BearerCredential.md +72 -0
  6. package/docs/classes/Chat.md +69 -0
  7. package/docs/classes/Chats.md +90 -0
  8. package/docs/classes/CredentialBase.md +54 -0
  9. package/docs/classes/DataIslandApp.md +168 -0
  10. package/docs/classes/DebugCredential.md +72 -0
  11. package/docs/classes/DefaultCredential.md +56 -0
  12. package/docs/classes/DisposableContainer.md +177 -0
  13. package/docs/classes/EventDispatcher.md +109 -0
  14. package/docs/classes/File.md +79 -0
  15. package/docs/classes/Files.md +136 -0
  16. package/docs/classes/FilesPage.md +76 -0
  17. package/docs/classes/Group.md +191 -0
  18. package/docs/classes/Groups.md +130 -0
  19. package/docs/classes/Lifetime.md +108 -0
  20. package/docs/classes/Organization.md +89 -0
  21. package/docs/classes/Organizations.md +195 -0
  22. package/docs/classes/UserProfile.md +156 -0
  23. package/docs/classes/Workspace.md +165 -0
  24. package/docs/classes/Workspaces.md +189 -0
  25. package/docs/enums/ChatAnswer.md +22 -0
  26. package/docs/enums/ChatsEvent.md +22 -0
  27. package/docs/enums/FilesEvent.md +24 -0
  28. package/docs/enums/GroupEvent.md +29 -0
  29. package/docs/enums/OrganizationsEvent.md +31 -0
  30. package/docs/enums/UserEvent.md +15 -0
  31. package/docs/enums/WorkspaceEvent.md +17 -0
  32. package/docs/enums/WorkspacesEvent.md +24 -0
  33. package/docs/interfaces/Disposable.md +25 -0
  34. package/docs/interfaces/Event.md +58 -0
  35. package/docs/interfaces/EventSubscriber.md +41 -0
  36. package/docs/interfaces/Input.md +35 -0
  37. package/docs/modules.md +205 -0
  38. package/package.json +4 -2
  39. package/scripts/docs/index.js +15 -0
@@ -0,0 +1,195 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / Organizations
2
+
3
+ # Class: Organizations
4
+
5
+ Organizations storage.
6
+
7
+ ## Hierarchy
8
+
9
+ - [`EventDispatcher`](EventDispatcher.md)\<[`OrganizationsEvent`](../enums/OrganizationsEvent.md), [`Organization`](Organization.md)\>
10
+
11
+ ↳ **`Organizations`**
12
+
13
+ ## Table of contents
14
+
15
+ ### Constructors
16
+
17
+ - [constructor](Organizations.md#constructor)
18
+
19
+ ### Accessors
20
+
21
+ - [collection](Organizations.md#collection)
22
+ - [current](Organizations.md#current)
23
+
24
+ ### Methods
25
+
26
+ - [create](Organizations.md#create)
27
+ - [delete](Organizations.md#delete)
28
+ - [dispatch](Organizations.md#dispatch)
29
+ - [get](Organizations.md#get)
30
+ - [subscribe](Organizations.md#subscribe)
31
+ - [tryGet](Organizations.md#tryget)
32
+
33
+ ## Constructors
34
+
35
+ ### constructor
36
+
37
+ • **new Organizations**(): [`Organizations`](Organizations.md)
38
+
39
+ #### Returns
40
+
41
+ [`Organizations`](Organizations.md)
42
+
43
+ #### Inherited from
44
+
45
+ [EventDispatcher](EventDispatcher.md).[constructor](EventDispatcher.md#constructor)
46
+
47
+ ## Accessors
48
+
49
+ ### collection
50
+
51
+ • `get` **collection**(): readonly [`Organization`](Organization.md)[]
52
+
53
+ User's organizations.
54
+
55
+ #### Returns
56
+
57
+ readonly [`Organization`](Organization.md)[]
58
+
59
+ ___
60
+
61
+ ### current
62
+
63
+ • `get` **current**(): `string`
64
+
65
+ Current organization.
66
+
67
+ #### Returns
68
+
69
+ `string`
70
+
71
+ • `set` **current**(`value`): `void`
72
+
73
+ #### Parameters
74
+
75
+ | Name | Type |
76
+ | :------ | :------ |
77
+ | `value` | `string` |
78
+
79
+ #### Returns
80
+
81
+ `void`
82
+
83
+ ## Methods
84
+
85
+ ### create
86
+
87
+ ▸ **create**(`name`, `description`): `Promise`\<[`Organization`](Organization.md)\>
88
+
89
+ Create new organization.
90
+
91
+ #### Parameters
92
+
93
+ | Name | Type |
94
+ | :------ | :------ |
95
+ | `name` | `string` |
96
+ | `description` | `string` |
97
+
98
+ #### Returns
99
+
100
+ `Promise`\<[`Organization`](Organization.md)\>
101
+
102
+ ___
103
+
104
+ ### delete
105
+
106
+ ▸ **delete**(`id`): `Promise`\<`void`\>
107
+
108
+ Delete organization.
109
+
110
+ #### Parameters
111
+
112
+ | Name | Type |
113
+ | :------ | :------ |
114
+ | `id` | `string` |
115
+
116
+ #### Returns
117
+
118
+ `Promise`\<`void`\>
119
+
120
+ ___
121
+
122
+ ### dispatch
123
+
124
+ ▸ **dispatch**(`input`): `void`
125
+
126
+ #### Parameters
127
+
128
+ | Name | Type |
129
+ | :------ | :------ |
130
+ | `input` | [`Input`](../interfaces/Input.md)\<[`OrganizationsEvent`](../enums/OrganizationsEvent.md), [`Organization`](Organization.md)\> |
131
+
132
+ #### Returns
133
+
134
+ `void`
135
+
136
+ #### Inherited from
137
+
138
+ [EventDispatcher](EventDispatcher.md).[dispatch](EventDispatcher.md#dispatch)
139
+
140
+ ___
141
+
142
+ ### get
143
+
144
+ ▸ **get**(`id`): [`Organization`](Organization.md)
145
+
146
+ Get organization by id.
147
+
148
+ #### Parameters
149
+
150
+ | Name | Type |
151
+ | :------ | :------ |
152
+ | `id` | `string` |
153
+
154
+ #### Returns
155
+
156
+ [`Organization`](Organization.md)
157
+
158
+ ___
159
+
160
+ ### subscribe
161
+
162
+ ▸ **subscribe**(`callback`, `type?`): [`Disposable`](../interfaces/Disposable.md)
163
+
164
+ #### Parameters
165
+
166
+ | Name | Type |
167
+ | :------ | :------ |
168
+ | `callback` | (`event`: [`Event`](../interfaces/Event.md)\<[`OrganizationsEvent`](../enums/OrganizationsEvent.md), [`Organization`](Organization.md)\>) => `void` |
169
+ | `type?` | [`OrganizationsEvent`](../enums/OrganizationsEvent.md) |
170
+
171
+ #### Returns
172
+
173
+ [`Disposable`](../interfaces/Disposable.md)
174
+
175
+ #### Inherited from
176
+
177
+ [EventDispatcher](EventDispatcher.md).[subscribe](EventDispatcher.md#subscribe)
178
+
179
+ ___
180
+
181
+ ### tryGet
182
+
183
+ ▸ **tryGet**(`id`): `undefined` \| [`Organization`](Organization.md)
184
+
185
+ Try to get organization by id.
186
+
187
+ #### Parameters
188
+
189
+ | Name | Type |
190
+ | :------ | :------ |
191
+ | `id` | `string` |
192
+
193
+ #### Returns
194
+
195
+ `undefined` \| [`Organization`](Organization.md)
@@ -0,0 +1,156 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / UserProfile
2
+
3
+ # Class: UserProfile
4
+
5
+ ## Hierarchy
6
+
7
+ - [`EventDispatcher`](EventDispatcher.md)\<[`UserEvent`](../enums/UserEvent.md), [`UserProfile`](UserProfile.md)\>
8
+
9
+ ↳ **`UserProfile`**
10
+
11
+ ## Table of contents
12
+
13
+ ### Constructors
14
+
15
+ - [constructor](UserProfile.md#constructor)
16
+
17
+ ### Accessors
18
+
19
+ - [createdAt](UserProfile.md#createdat)
20
+ - [email](UserProfile.md#email)
21
+ - [id](UserProfile.md#id)
22
+ - [isDeleted](UserProfile.md#isdeleted)
23
+ - [modifiedAt](UserProfile.md#modifiedat)
24
+ - [name](UserProfile.md#name)
25
+
26
+ ### Methods
27
+
28
+ - [dispatch](UserProfile.md#dispatch)
29
+ - [subscribe](UserProfile.md#subscribe)
30
+
31
+ ## Constructors
32
+
33
+ ### constructor
34
+
35
+ • **new UserProfile**(): [`UserProfile`](UserProfile.md)
36
+
37
+ #### Returns
38
+
39
+ [`UserProfile`](UserProfile.md)
40
+
41
+ #### Inherited from
42
+
43
+ [EventDispatcher](EventDispatcher.md).[constructor](EventDispatcher.md#constructor)
44
+
45
+ ## Accessors
46
+
47
+ ### createdAt
48
+
49
+ • `get` **createdAt**(): `Date`
50
+
51
+ Created at.
52
+
53
+ #### Returns
54
+
55
+ `Date`
56
+
57
+ ___
58
+
59
+ ### email
60
+
61
+ • `get` **email**(): `string`
62
+
63
+ User email.
64
+
65
+ #### Returns
66
+
67
+ `string`
68
+
69
+ ___
70
+
71
+ ### id
72
+
73
+ • `get` **id**(): `string`
74
+
75
+ User id.
76
+
77
+ #### Returns
78
+
79
+ `string`
80
+
81
+ ___
82
+
83
+ ### isDeleted
84
+
85
+ • `get` **isDeleted**(): `boolean`
86
+
87
+ Is user deleted.
88
+
89
+ #### Returns
90
+
91
+ `boolean`
92
+
93
+ ___
94
+
95
+ ### modifiedAt
96
+
97
+ • `get` **modifiedAt**(): `Date`
98
+
99
+ Modified at.
100
+
101
+ #### Returns
102
+
103
+ `Date`
104
+
105
+ ___
106
+
107
+ ### name
108
+
109
+ • `get` **name**(): `string`
110
+
111
+ User name.
112
+
113
+ #### Returns
114
+
115
+ `string`
116
+
117
+ ## Methods
118
+
119
+ ### dispatch
120
+
121
+ ▸ **dispatch**(`input`): `void`
122
+
123
+ #### Parameters
124
+
125
+ | Name | Type |
126
+ | :------ | :------ |
127
+ | `input` | [`Input`](../interfaces/Input.md)\<[`CHANGED`](../enums/UserEvent.md#changed), [`UserProfile`](UserProfile.md)\> |
128
+
129
+ #### Returns
130
+
131
+ `void`
132
+
133
+ #### Inherited from
134
+
135
+ [EventDispatcher](EventDispatcher.md).[dispatch](EventDispatcher.md#dispatch)
136
+
137
+ ___
138
+
139
+ ### subscribe
140
+
141
+ ▸ **subscribe**(`callback`, `type?`): [`Disposable`](../interfaces/Disposable.md)
142
+
143
+ #### Parameters
144
+
145
+ | Name | Type |
146
+ | :------ | :------ |
147
+ | `callback` | (`event`: [`Event`](../interfaces/Event.md)\<[`CHANGED`](../enums/UserEvent.md#changed), [`UserProfile`](UserProfile.md)\>) => `void` |
148
+ | `type?` | [`CHANGED`](../enums/UserEvent.md#changed) |
149
+
150
+ #### Returns
151
+
152
+ [`Disposable`](../interfaces/Disposable.md)
153
+
154
+ #### Inherited from
155
+
156
+ [EventDispatcher](EventDispatcher.md).[subscribe](EventDispatcher.md#subscribe)
@@ -0,0 +1,165 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / Workspace
2
+
3
+ # Class: Workspace
4
+
5
+ Workspace.
6
+
7
+ ## Hierarchy
8
+
9
+ - [`EventDispatcher`](EventDispatcher.md)\<[`WorkspaceEvent`](../enums/WorkspaceEvent.md), [`Workspace`](Workspace.md)\>
10
+
11
+ ↳ **`Workspace`**
12
+
13
+ ## Table of contents
14
+
15
+ ### Constructors
16
+
17
+ - [constructor](Workspace.md#constructor)
18
+
19
+ ### Accessors
20
+
21
+ - [description](Workspace.md#description)
22
+ - [files](Workspace.md#files)
23
+ - [id](Workspace.md#id)
24
+ - [name](Workspace.md#name)
25
+ - [organization](Workspace.md#organization)
26
+
27
+ ### Methods
28
+
29
+ - [change](Workspace.md#change)
30
+ - [dispatch](Workspace.md#dispatch)
31
+ - [subscribe](Workspace.md#subscribe)
32
+
33
+ ## Constructors
34
+
35
+ ### constructor
36
+
37
+ • **new Workspace**(): [`Workspace`](Workspace.md)
38
+
39
+ #### Returns
40
+
41
+ [`Workspace`](Workspace.md)
42
+
43
+ #### Inherited from
44
+
45
+ [EventDispatcher](EventDispatcher.md).[constructor](EventDispatcher.md#constructor)
46
+
47
+ ## Accessors
48
+
49
+ ### description
50
+
51
+ • `get` **description**(): `string`
52
+
53
+ Workspace description.
54
+
55
+ #### Returns
56
+
57
+ `string`
58
+
59
+ ___
60
+
61
+ ### files
62
+
63
+ • `get` **files**(): [`Files`](Files.md)
64
+
65
+ Workspace files.
66
+
67
+ #### Returns
68
+
69
+ [`Files`](Files.md)
70
+
71
+ ___
72
+
73
+ ### id
74
+
75
+ • `get` **id**(): `string`
76
+
77
+ Workspace id.
78
+
79
+ #### Returns
80
+
81
+ `string`
82
+
83
+ ___
84
+
85
+ ### name
86
+
87
+ • `get` **name**(): `string`
88
+
89
+ Workspace name.
90
+
91
+ #### Returns
92
+
93
+ `string`
94
+
95
+ ___
96
+
97
+ ### organization
98
+
99
+ • `get` **organization**(): [`Organization`](Organization.md)
100
+
101
+ Organization.
102
+
103
+ #### Returns
104
+
105
+ [`Organization`](Organization.md)
106
+
107
+ ## Methods
108
+
109
+ ### change
110
+
111
+ ▸ **change**(`name`, `description`): `Promise`\<`void`\>
112
+
113
+ Change workspace name and description.
114
+
115
+ #### Parameters
116
+
117
+ | Name | Type |
118
+ | :------ | :------ |
119
+ | `name` | `string` |
120
+ | `description` | `string` |
121
+
122
+ #### Returns
123
+
124
+ `Promise`\<`void`\>
125
+
126
+ ___
127
+
128
+ ### dispatch
129
+
130
+ ▸ **dispatch**(`input`): `void`
131
+
132
+ #### Parameters
133
+
134
+ | Name | Type |
135
+ | :------ | :------ |
136
+ | `input` | [`Input`](../interfaces/Input.md)\<[`CHANGED`](../enums/WorkspaceEvent.md#changed), [`Workspace`](Workspace.md)\> |
137
+
138
+ #### Returns
139
+
140
+ `void`
141
+
142
+ #### Inherited from
143
+
144
+ [EventDispatcher](EventDispatcher.md).[dispatch](EventDispatcher.md#dispatch)
145
+
146
+ ___
147
+
148
+ ### subscribe
149
+
150
+ ▸ **subscribe**(`callback`, `type?`): [`Disposable`](../interfaces/Disposable.md)
151
+
152
+ #### Parameters
153
+
154
+ | Name | Type |
155
+ | :------ | :------ |
156
+ | `callback` | (`event`: [`Event`](../interfaces/Event.md)\<[`CHANGED`](../enums/WorkspaceEvent.md#changed), [`Workspace`](Workspace.md)\>) => `void` |
157
+ | `type?` | [`CHANGED`](../enums/WorkspaceEvent.md#changed) |
158
+
159
+ #### Returns
160
+
161
+ [`Disposable`](../interfaces/Disposable.md)
162
+
163
+ #### Inherited from
164
+
165
+ [EventDispatcher](EventDispatcher.md).[subscribe](EventDispatcher.md#subscribe)
@@ -0,0 +1,189 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / Workspaces
2
+
3
+ # Class: Workspaces
4
+
5
+ Organization's workspaces.
6
+
7
+ ## Hierarchy
8
+
9
+ - [`EventDispatcher`](EventDispatcher.md)\<[`WorkspacesEvent`](../enums/WorkspacesEvent.md), [`Workspace`](Workspace.md)\>
10
+
11
+ ↳ **`Workspaces`**
12
+
13
+ ## Table of contents
14
+
15
+ ### Constructors
16
+
17
+ - [constructor](Workspaces.md#constructor)
18
+
19
+ ### Accessors
20
+
21
+ - [collection](Workspaces.md#collection)
22
+
23
+ ### Methods
24
+
25
+ - [contains](Workspaces.md#contains)
26
+ - [create](Workspaces.md#create)
27
+ - [delete](Workspaces.md#delete)
28
+ - [dispatch](Workspaces.md#dispatch)
29
+ - [get](Workspaces.md#get)
30
+ - [subscribe](Workspaces.md#subscribe)
31
+ - [tryGet](Workspaces.md#tryget)
32
+
33
+ ## Constructors
34
+
35
+ ### constructor
36
+
37
+ • **new Workspaces**(): [`Workspaces`](Workspaces.md)
38
+
39
+ #### Returns
40
+
41
+ [`Workspaces`](Workspaces.md)
42
+
43
+ #### Inherited from
44
+
45
+ [EventDispatcher](EventDispatcher.md).[constructor](EventDispatcher.md#constructor)
46
+
47
+ ## Accessors
48
+
49
+ ### collection
50
+
51
+ • `get` **collection**(): readonly [`Workspace`](Workspace.md)[]
52
+
53
+ Workspaces.
54
+
55
+ #### Returns
56
+
57
+ readonly [`Workspace`](Workspace.md)[]
58
+
59
+ ## Methods
60
+
61
+ ### contains
62
+
63
+ ▸ **contains**(`id`): `boolean`
64
+
65
+ Check if workspace exists.
66
+
67
+ #### Parameters
68
+
69
+ | Name | Type |
70
+ | :------ | :------ |
71
+ | `id` | `string` |
72
+
73
+ #### Returns
74
+
75
+ `boolean`
76
+
77
+ ___
78
+
79
+ ### create
80
+
81
+ ▸ **create**(`name`, `description`): `Promise`\<[`Workspace`](Workspace.md)\>
82
+
83
+ Create workspace.
84
+
85
+ #### Parameters
86
+
87
+ | Name | Type |
88
+ | :------ | :------ |
89
+ | `name` | `string` |
90
+ | `description` | `string` |
91
+
92
+ #### Returns
93
+
94
+ `Promise`\<[`Workspace`](Workspace.md)\>
95
+
96
+ ___
97
+
98
+ ### delete
99
+
100
+ ▸ **delete**(`id`): `Promise`\<`void`\>
101
+
102
+ Delete workspace.
103
+
104
+ #### Parameters
105
+
106
+ | Name | Type |
107
+ | :------ | :------ |
108
+ | `id` | `string` |
109
+
110
+ #### Returns
111
+
112
+ `Promise`\<`void`\>
113
+
114
+ ___
115
+
116
+ ### dispatch
117
+
118
+ ▸ **dispatch**(`input`): `void`
119
+
120
+ #### Parameters
121
+
122
+ | Name | Type |
123
+ | :------ | :------ |
124
+ | `input` | [`Input`](../interfaces/Input.md)\<[`WorkspacesEvent`](../enums/WorkspacesEvent.md), [`Workspace`](Workspace.md)\> |
125
+
126
+ #### Returns
127
+
128
+ `void`
129
+
130
+ #### Inherited from
131
+
132
+ [EventDispatcher](EventDispatcher.md).[dispatch](EventDispatcher.md#dispatch)
133
+
134
+ ___
135
+
136
+ ### get
137
+
138
+ ▸ **get**(`id`): [`Workspace`](Workspace.md)
139
+
140
+ Get workspace by id.
141
+
142
+ #### Parameters
143
+
144
+ | Name | Type |
145
+ | :------ | :------ |
146
+ | `id` | `string` |
147
+
148
+ #### Returns
149
+
150
+ [`Workspace`](Workspace.md)
151
+
152
+ ___
153
+
154
+ ### subscribe
155
+
156
+ ▸ **subscribe**(`callback`, `type?`): [`Disposable`](../interfaces/Disposable.md)
157
+
158
+ #### Parameters
159
+
160
+ | Name | Type |
161
+ | :------ | :------ |
162
+ | `callback` | (`event`: [`Event`](../interfaces/Event.md)\<[`WorkspacesEvent`](../enums/WorkspacesEvent.md), [`Workspace`](Workspace.md)\>) => `void` |
163
+ | `type?` | [`WorkspacesEvent`](../enums/WorkspacesEvent.md) |
164
+
165
+ #### Returns
166
+
167
+ [`Disposable`](../interfaces/Disposable.md)
168
+
169
+ #### Inherited from
170
+
171
+ [EventDispatcher](EventDispatcher.md).[subscribe](EventDispatcher.md#subscribe)
172
+
173
+ ___
174
+
175
+ ### tryGet
176
+
177
+ ▸ **tryGet**(`id`): `undefined` \| [`Workspace`](Workspace.md)
178
+
179
+ Try to get workspace by id.
180
+
181
+ #### Parameters
182
+
183
+ | Name | Type |
184
+ | :------ | :------ |
185
+ | `id` | `string` |
186
+
187
+ #### Returns
188
+
189
+ `undefined` \| [`Workspace`](Workspace.md)
@@ -0,0 +1,22 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / ChatAnswer
2
+
3
+ # Enumeration: ChatAnswer
4
+
5
+ ## Table of contents
6
+
7
+ ### Enumeration Members
8
+
9
+ - [LONG](ChatAnswer.md#long)
10
+ - [SHORT](ChatAnswer.md#short)
11
+
12
+ ## Enumeration Members
13
+
14
+ ### LONG
15
+
16
+ • **LONG** = ``"long"``
17
+
18
+ ___
19
+
20
+ ### SHORT
21
+
22
+ • **SHORT** = ``"short"``