@neuralinnovations/dataisland-sdk 0.0.1-dev6 → 0.0.1-dev8

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 (44) hide show
  1. package/.github/workflows/docs.yml +32 -0
  2. package/.github/workflows/format.yml +42 -0
  3. package/.github/workflows/publish-npm.yml +10 -5
  4. package/.github/workflows/tests.yml +34 -0
  5. package/.github/workflows/version.yml +40 -0
  6. package/LICENSE +201 -0
  7. package/README.md +33 -0
  8. package/docs/.nojekyll +1 -0
  9. package/docs/classes/BasicCredential.md +80 -0
  10. package/docs/classes/BearerCredential.md +72 -0
  11. package/docs/classes/Chat.md +69 -0
  12. package/docs/classes/Chats.md +90 -0
  13. package/docs/classes/CredentialBase.md +54 -0
  14. package/docs/classes/DataIslandApp.md +168 -0
  15. package/docs/classes/DebugCredential.md +72 -0
  16. package/docs/classes/DefaultCredential.md +56 -0
  17. package/docs/classes/DisposableContainer.md +177 -0
  18. package/docs/classes/EventDispatcher.md +109 -0
  19. package/docs/classes/File.md +79 -0
  20. package/docs/classes/Files.md +136 -0
  21. package/docs/classes/FilesPage.md +76 -0
  22. package/docs/classes/Group.md +191 -0
  23. package/docs/classes/Groups.md +130 -0
  24. package/docs/classes/Lifetime.md +108 -0
  25. package/docs/classes/Organization.md +89 -0
  26. package/docs/classes/Organizations.md +195 -0
  27. package/docs/classes/UserProfile.md +156 -0
  28. package/docs/classes/Workspace.md +165 -0
  29. package/docs/classes/Workspaces.md +189 -0
  30. package/docs/enums/ChatAnswer.md +22 -0
  31. package/docs/enums/ChatsEvent.md +22 -0
  32. package/docs/enums/FilesEvent.md +24 -0
  33. package/docs/enums/GroupEvent.md +29 -0
  34. package/docs/enums/OrganizationsEvent.md +31 -0
  35. package/docs/enums/UserEvent.md +15 -0
  36. package/docs/enums/WorkspaceEvent.md +17 -0
  37. package/docs/enums/WorkspacesEvent.md +24 -0
  38. package/docs/interfaces/Disposable.md +25 -0
  39. package/docs/interfaces/Event.md +58 -0
  40. package/docs/interfaces/EventSubscriber.md +41 -0
  41. package/docs/interfaces/Input.md +35 -0
  42. package/docs/modules.md +205 -0
  43. package/package.json +4 -2
  44. package/scripts/docs/index.js +15 -0
@@ -0,0 +1,189 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../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-dev8](../../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"``
@@ -0,0 +1,22 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / ChatsEvent
2
+
3
+ # Enumeration: ChatsEvent
4
+
5
+ ## Table of contents
6
+
7
+ ### Enumeration Members
8
+
9
+ - [ADDED](ChatsEvent.md#added)
10
+ - [REMOVED](ChatsEvent.md#removed)
11
+
12
+ ## Enumeration Members
13
+
14
+ ### ADDED
15
+
16
+ • **ADDED** = ``"added"``
17
+
18
+ ___
19
+
20
+ ### REMOVED
21
+
22
+ • **REMOVED** = ``"removed"``
@@ -0,0 +1,24 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / FilesEvent
2
+
3
+ # Enumeration: FilesEvent
4
+
5
+ Files event.
6
+
7
+ ## Table of contents
8
+
9
+ ### Enumeration Members
10
+
11
+ - [ADDED](FilesEvent.md#added)
12
+ - [REMOVED](FilesEvent.md#removed)
13
+
14
+ ## Enumeration Members
15
+
16
+ ### ADDED
17
+
18
+ • **ADDED** = ``"added"``
19
+
20
+ ___
21
+
22
+ ### REMOVED
23
+
24
+ • **REMOVED** = ``"removed"``
@@ -0,0 +1,29 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / GroupEvent
2
+
3
+ # Enumeration: GroupEvent
4
+
5
+ ## Table of contents
6
+
7
+ ### Enumeration Members
8
+
9
+ - [ADDED](GroupEvent.md#added)
10
+ - [REMOVED](GroupEvent.md#removed)
11
+ - [UPDATED](GroupEvent.md#updated)
12
+
13
+ ## Enumeration Members
14
+
15
+ ### ADDED
16
+
17
+ • **ADDED** = ``"added"``
18
+
19
+ ___
20
+
21
+ ### REMOVED
22
+
23
+ • **REMOVED** = ``"removed"``
24
+
25
+ ___
26
+
27
+ ### UPDATED
28
+
29
+ • **UPDATED** = ``"updated"``
@@ -0,0 +1,31 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / OrganizationsEvent
2
+
3
+ # Enumeration: OrganizationsEvent
4
+
5
+ Organization event.
6
+
7
+ ## Table of contents
8
+
9
+ ### Enumeration Members
10
+
11
+ - [ADDED](OrganizationsEvent.md#added)
12
+ - [CURRENT\_CHANGED](OrganizationsEvent.md#current_changed)
13
+ - [REMOVED](OrganizationsEvent.md#removed)
14
+
15
+ ## Enumeration Members
16
+
17
+ ### ADDED
18
+
19
+ • **ADDED** = ``"added"``
20
+
21
+ ___
22
+
23
+ ### CURRENT\_CHANGED
24
+
25
+ • **CURRENT\_CHANGED** = ``"currentChanged"``
26
+
27
+ ___
28
+
29
+ ### REMOVED
30
+
31
+ • **REMOVED** = ``"removed"``
@@ -0,0 +1,15 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / UserEvent
2
+
3
+ # Enumeration: UserEvent
4
+
5
+ ## Table of contents
6
+
7
+ ### Enumeration Members
8
+
9
+ - [CHANGED](UserEvent.md#changed)
10
+
11
+ ## Enumeration Members
12
+
13
+ ### CHANGED
14
+
15
+ • **CHANGED** = ``"changed"``
@@ -0,0 +1,17 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / WorkspaceEvent
2
+
3
+ # Enumeration: WorkspaceEvent
4
+
5
+ Workspace event.
6
+
7
+ ## Table of contents
8
+
9
+ ### Enumeration Members
10
+
11
+ - [CHANGED](WorkspaceEvent.md#changed)
12
+
13
+ ## Enumeration Members
14
+
15
+ ### CHANGED
16
+
17
+ • **CHANGED** = ``"changed"``
@@ -0,0 +1,24 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / WorkspacesEvent
2
+
3
+ # Enumeration: WorkspacesEvent
4
+
5
+ Workspaces event.
6
+
7
+ ## Table of contents
8
+
9
+ ### Enumeration Members
10
+
11
+ - [ADDED](WorkspacesEvent.md#added)
12
+ - [REMOVED](WorkspacesEvent.md#removed)
13
+
14
+ ## Enumeration Members
15
+
16
+ ### ADDED
17
+
18
+ • **ADDED** = ``"added"``
19
+
20
+ ___
21
+
22
+ ### REMOVED
23
+
24
+ • **REMOVED** = ``"removed"``
@@ -0,0 +1,25 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Disposable
2
+
3
+ # Interface: Disposable
4
+
5
+ Represents an object that can be disposed.
6
+
7
+ ## Implemented by
8
+
9
+ - [`DisposableContainer`](../classes/DisposableContainer.md)
10
+
11
+ ## Table of contents
12
+
13
+ ### Methods
14
+
15
+ - [dispose](Disposable.md#dispose)
16
+
17
+ ## Methods
18
+
19
+ ### dispose
20
+
21
+ ▸ **dispose**(): `void`
22
+
23
+ #### Returns
24
+
25
+ `void`
@@ -0,0 +1,58 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Event
2
+
3
+ # Interface: Event\<EventType, DataType\>
4
+
5
+ ## Type parameters
6
+
7
+ | Name |
8
+ | :------ |
9
+ | `EventType` |
10
+ | `DataType` |
11
+
12
+ ## Hierarchy
13
+
14
+ - [`Input`](Input.md)\<`EventType`, `DataType`\>
15
+
16
+ ↳ **`Event`**
17
+
18
+ ## Table of contents
19
+
20
+ ### Properties
21
+
22
+ - [data](Event.md#data)
23
+ - [type](Event.md#type)
24
+ - [unsubscribe](Event.md#unsubscribe)
25
+
26
+ ## Properties
27
+
28
+ ### data
29
+
30
+ • **data**: `DataType`
31
+
32
+ #### Inherited from
33
+
34
+ [Input](Input.md).[data](Input.md#data)
35
+
36
+ ___
37
+
38
+ ### type
39
+
40
+ • `Optional` **type**: `EventType`
41
+
42
+ #### Inherited from
43
+
44
+ [Input](Input.md).[type](Input.md#type)
45
+
46
+ ___
47
+
48
+ ### unsubscribe
49
+
50
+ • **unsubscribe**: () => `void`
51
+
52
+ #### Type declaration
53
+
54
+ ▸ (): `void`
55
+
56
+ ##### Returns
57
+
58
+ `void`
@@ -0,0 +1,41 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / EventSubscriber
2
+
3
+ # Interface: EventSubscriber\<EventType, DataType\>
4
+
5
+ ## Type parameters
6
+
7
+ | Name |
8
+ | :------ |
9
+ | `EventType` |
10
+ | `DataType` |
11
+
12
+ ## Implemented by
13
+
14
+ - [`EventDispatcher`](../classes/EventDispatcher.md)
15
+
16
+ ## Table of contents
17
+
18
+ ### Properties
19
+
20
+ - [subscribe](EventSubscriber.md#subscribe)
21
+
22
+ ## Properties
23
+
24
+ ### subscribe
25
+
26
+ • **subscribe**: (`callback`: (`event`: [`Event`](Event.md)\<`EventType`, `DataType`\>) => `void`, `type?`: `EventType`) => [`Disposable`](Disposable.md)
27
+
28
+ #### Type declaration
29
+
30
+ ▸ (`callback`, `type?`): [`Disposable`](Disposable.md)
31
+
32
+ ##### Parameters
33
+
34
+ | Name | Type |
35
+ | :------ | :------ |
36
+ | `callback` | (`event`: [`Event`](Event.md)\<`EventType`, `DataType`\>) => `void` |
37
+ | `type?` | `EventType` |
38
+
39
+ ##### Returns
40
+
41
+ [`Disposable`](Disposable.md)
@@ -0,0 +1,35 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Input
2
+
3
+ # Interface: Input\<EventType, DataType\>
4
+
5
+ ## Type parameters
6
+
7
+ | Name |
8
+ | :------ |
9
+ | `EventType` |
10
+ | `DataType` |
11
+
12
+ ## Hierarchy
13
+
14
+ - **`Input`**
15
+
16
+ ↳ [`Event`](Event.md)
17
+
18
+ ## Table of contents
19
+
20
+ ### Properties
21
+
22
+ - [data](Input.md#data)
23
+ - [type](Input.md#type)
24
+
25
+ ## Properties
26
+
27
+ ### data
28
+
29
+ • **data**: `DataType`
30
+
31
+ ___
32
+
33
+ ### type
34
+
35
+ • `Optional` **type**: `EventType`