@neuralinnovations/dataisland-sdk 0.0.1-dev6 → 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 +31 -0
  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,72 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / DebugCredential
2
+
3
+ # Class: DebugCredential
4
+
5
+ DataIsland App credential.
6
+
7
+ ## Hierarchy
8
+
9
+ - [`CredentialBase`](CredentialBase.md)
10
+
11
+ ↳ **`DebugCredential`**
12
+
13
+ ## Table of contents
14
+
15
+ ### Constructors
16
+
17
+ - [constructor](DebugCredential.md#constructor)
18
+
19
+ ### Properties
20
+
21
+ - [token](DebugCredential.md#token)
22
+
23
+ ### Methods
24
+
25
+ - [onRegister](DebugCredential.md#onregister)
26
+
27
+ ## Constructors
28
+
29
+ ### constructor
30
+
31
+ • **new DebugCredential**(`token`): [`DebugCredential`](DebugCredential.md)
32
+
33
+ #### Parameters
34
+
35
+ | Name | Type |
36
+ | :------ | :------ |
37
+ | `token` | `string` |
38
+
39
+ #### Returns
40
+
41
+ [`DebugCredential`](DebugCredential.md)
42
+
43
+ #### Overrides
44
+
45
+ [CredentialBase](CredentialBase.md).[constructor](CredentialBase.md#constructor)
46
+
47
+ ## Properties
48
+
49
+ ### token
50
+
51
+ • `Readonly` **token**: `string`
52
+
53
+ ## Methods
54
+
55
+ ### onRegister
56
+
57
+ ▸ **onRegister**(`lifetime`, `context`): `void`
58
+
59
+ #### Parameters
60
+
61
+ | Name | Type |
62
+ | :------ | :------ |
63
+ | `lifetime` | [`Lifetime`](Lifetime.md) |
64
+ | `context` | `Context` |
65
+
66
+ #### Returns
67
+
68
+ `void`
69
+
70
+ #### Overrides
71
+
72
+ [CredentialBase](CredentialBase.md).[onRegister](CredentialBase.md#onregister)
@@ -0,0 +1,56 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / DefaultCredential
2
+
3
+ # Class: DefaultCredential
4
+
5
+ DataIsland App credential.
6
+
7
+ ## Hierarchy
8
+
9
+ - [`CredentialBase`](CredentialBase.md)
10
+
11
+ ↳ **`DefaultCredential`**
12
+
13
+ ## Table of contents
14
+
15
+ ### Constructors
16
+
17
+ - [constructor](DefaultCredential.md#constructor)
18
+
19
+ ### Methods
20
+
21
+ - [onRegister](DefaultCredential.md#onregister)
22
+
23
+ ## Constructors
24
+
25
+ ### constructor
26
+
27
+ • **new DefaultCredential**(): [`DefaultCredential`](DefaultCredential.md)
28
+
29
+ #### Returns
30
+
31
+ [`DefaultCredential`](DefaultCredential.md)
32
+
33
+ #### Inherited from
34
+
35
+ [CredentialBase](CredentialBase.md).[constructor](CredentialBase.md#constructor)
36
+
37
+ ## Methods
38
+
39
+ ### onRegister
40
+
41
+ ▸ **onRegister**(`lifetime`, `context`): `void`
42
+
43
+ #### Parameters
44
+
45
+ | Name | Type |
46
+ | :------ | :------ |
47
+ | `lifetime` | [`Lifetime`](Lifetime.md) |
48
+ | `context` | `Context` |
49
+
50
+ #### Returns
51
+
52
+ `void`
53
+
54
+ #### Overrides
55
+
56
+ [CredentialBase](CredentialBase.md).[onRegister](CredentialBase.md#onregister)
@@ -0,0 +1,177 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / DisposableContainer
2
+
3
+ # Class: DisposableContainer
4
+
5
+ A container for disposables.
6
+ Last added, first disposed.
7
+
8
+ **`Example`**
9
+
10
+ ```ts
11
+ const container = new DisposableContainer();
12
+ container.add(someDisposable);
13
+ container.addCallback(() => console.log('disposed'));
14
+ container.dispose();
15
+ ```
16
+
17
+ ## Implements
18
+
19
+ - [`Disposable`](../interfaces/Disposable.md)
20
+
21
+ ## Table of contents
22
+
23
+ ### Constructors
24
+
25
+ - [constructor](DisposableContainer.md#constructor)
26
+
27
+ ### Properties
28
+
29
+ - [\_disposables](DisposableContainer.md#_disposables)
30
+ - [\_isDisposed](DisposableContainer.md#_isdisposed)
31
+ - [\_lifetime](DisposableContainer.md#_lifetime)
32
+
33
+ ### Accessors
34
+
35
+ - [isDisposed](DisposableContainer.md#isdisposed)
36
+ - [lifetime](DisposableContainer.md#lifetime)
37
+
38
+ ### Methods
39
+
40
+ - [\_throwIfDisposed](DisposableContainer.md#_throwifdisposed)
41
+ - [add](DisposableContainer.md#add)
42
+ - [addCallback](DisposableContainer.md#addcallback)
43
+ - [defineNested](DisposableContainer.md#definenested)
44
+ - [dispose](DisposableContainer.md#dispose)
45
+
46
+ ## Constructors
47
+
48
+ ### constructor
49
+
50
+ • **new DisposableContainer**(): [`DisposableContainer`](DisposableContainer.md)
51
+
52
+ #### Returns
53
+
54
+ [`DisposableContainer`](DisposableContainer.md)
55
+
56
+ ## Properties
57
+
58
+ ### \_disposables
59
+
60
+ • `Private` **\_disposables**: [`Disposable`](../interfaces/Disposable.md)[] = `[]`
61
+
62
+ ___
63
+
64
+ ### \_isDisposed
65
+
66
+ • `Private` **\_isDisposed**: `boolean` = `false`
67
+
68
+ ___
69
+
70
+ ### \_lifetime
71
+
72
+ • `Private` `Optional` **\_lifetime**: [`Lifetime`](Lifetime.md)
73
+
74
+ ## Accessors
75
+
76
+ ### isDisposed
77
+
78
+ • `get` **isDisposed**(): `boolean`
79
+
80
+ Gets whether this container is disposed.
81
+
82
+ #### Returns
83
+
84
+ `boolean`
85
+
86
+ ___
87
+
88
+ ### lifetime
89
+
90
+ • `get` **lifetime**(): [`Lifetime`](Lifetime.md)
91
+
92
+ Define new lifetime.
93
+
94
+ #### Returns
95
+
96
+ [`Lifetime`](Lifetime.md)
97
+
98
+ ## Methods
99
+
100
+ ### \_throwIfDisposed
101
+
102
+ ▸ **_throwIfDisposed**(): `void`
103
+
104
+ Throws an error if this container is disposed.
105
+
106
+ #### Returns
107
+
108
+ `void`
109
+
110
+ ___
111
+
112
+ ### add
113
+
114
+ ▸ **add**(`disposable`): [`Disposable`](../interfaces/Disposable.md)
115
+
116
+ Adds a disposable to this container.
117
+
118
+ #### Parameters
119
+
120
+ | Name | Type | Description |
121
+ | :------ | :------ | :------ |
122
+ | `disposable` | [`Disposable`](../interfaces/Disposable.md) | The disposable to add. |
123
+
124
+ #### Returns
125
+
126
+ [`Disposable`](../interfaces/Disposable.md)
127
+
128
+ The disposable container.
129
+
130
+ ___
131
+
132
+ ### addCallback
133
+
134
+ ▸ **addCallback**(`callback`, `target?`): [`Disposable`](../interfaces/Disposable.md)
135
+
136
+ Adds a callback to be executed when this container is disposed.
137
+
138
+ #### Parameters
139
+
140
+ | Name | Type | Description |
141
+ | :------ | :------ | :------ |
142
+ | `callback` | () => `void` | The callback to execute. |
143
+ | `target?` | `unknown` | The target to bind the callback to. |
144
+
145
+ #### Returns
146
+
147
+ [`Disposable`](../interfaces/Disposable.md)
148
+
149
+ The disposable container.
150
+
151
+ ___
152
+
153
+ ### defineNested
154
+
155
+ ▸ **defineNested**(): [`DisposableContainer`](DisposableContainer.md)
156
+
157
+ Defines a nested disposable container.
158
+
159
+ #### Returns
160
+
161
+ [`DisposableContainer`](DisposableContainer.md)
162
+
163
+ ___
164
+
165
+ ### dispose
166
+
167
+ ▸ **dispose**(): `void`
168
+
169
+ Disposes all disposables in this container. Last added, first disposed.
170
+
171
+ #### Returns
172
+
173
+ `void`
174
+
175
+ #### Implementation of
176
+
177
+ [Disposable](../interfaces/Disposable.md).[dispose](../interfaces/Disposable.md#dispose)
@@ -0,0 +1,109 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / EventDispatcher
2
+
3
+ # Class: EventDispatcher\<EventType, DataType\>
4
+
5
+ ## Type parameters
6
+
7
+ | Name |
8
+ | :------ |
9
+ | `EventType` |
10
+ | `DataType` |
11
+
12
+ ## Hierarchy
13
+
14
+ - **`EventDispatcher`**
15
+
16
+ ↳ [`Organizations`](Organizations.md)
17
+
18
+ ↳ [`Workspaces`](Workspaces.md)
19
+
20
+ ↳ [`Workspace`](Workspace.md)
21
+
22
+ ↳ [`Group`](Group.md)
23
+
24
+ ↳ [`Groups`](Groups.md)
25
+
26
+ ↳ [`UserProfile`](UserProfile.md)
27
+
28
+ ↳ [`Files`](Files.md)
29
+
30
+ ↳ [`Chats`](Chats.md)
31
+
32
+ ## Implements
33
+
34
+ - [`EventSubscriber`](../interfaces/EventSubscriber.md)\<`EventType`, `DataType`\>
35
+
36
+ ## Table of contents
37
+
38
+ ### Constructors
39
+
40
+ - [constructor](EventDispatcher.md#constructor)
41
+
42
+ ### Properties
43
+
44
+ - [\_listeners](EventDispatcher.md#_listeners)
45
+
46
+ ### Methods
47
+
48
+ - [dispatch](EventDispatcher.md#dispatch)
49
+ - [subscribe](EventDispatcher.md#subscribe)
50
+
51
+ ## Constructors
52
+
53
+ ### constructor
54
+
55
+ • **new EventDispatcher**\<`EventType`, `DataType`\>(): [`EventDispatcher`](EventDispatcher.md)\<`EventType`, `DataType`\>
56
+
57
+ #### Type parameters
58
+
59
+ | Name |
60
+ | :------ |
61
+ | `EventType` |
62
+ | `DataType` |
63
+
64
+ #### Returns
65
+
66
+ [`EventDispatcher`](EventDispatcher.md)\<`EventType`, `DataType`\>
67
+
68
+ ## Properties
69
+
70
+ ### \_listeners
71
+
72
+ • `Private` **\_listeners**: \{ `callback`: (`value`: [`Event`](../interfaces/Event.md)\<`EventType`, `DataType`\>) => `void` ; `disposable`: [`Disposable`](../interfaces/Disposable.md) }[] = `[]`
73
+
74
+ ## Methods
75
+
76
+ ### dispatch
77
+
78
+ ▸ **dispatch**(`input`): `void`
79
+
80
+ #### Parameters
81
+
82
+ | Name | Type |
83
+ | :------ | :------ |
84
+ | `input` | [`Input`](../interfaces/Input.md)\<`EventType`, `DataType`\> |
85
+
86
+ #### Returns
87
+
88
+ `void`
89
+
90
+ ___
91
+
92
+ ### subscribe
93
+
94
+ ▸ **subscribe**(`callback`, `type?`): [`Disposable`](../interfaces/Disposable.md)
95
+
96
+ #### Parameters
97
+
98
+ | Name | Type |
99
+ | :------ | :------ |
100
+ | `callback` | (`event`: [`Event`](../interfaces/Event.md)\<`EventType`, `DataType`\>) => `void` |
101
+ | `type?` | `EventType` |
102
+
103
+ #### Returns
104
+
105
+ [`Disposable`](../interfaces/Disposable.md)
106
+
107
+ #### Implementation of
108
+
109
+ [EventSubscriber](../interfaces/EventSubscriber.md).[subscribe](../interfaces/EventSubscriber.md#subscribe)
@@ -0,0 +1,79 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / File
2
+
3
+ # Class: File
4
+
5
+ File.
6
+
7
+ ## Table of contents
8
+
9
+ ### Constructors
10
+
11
+ - [constructor](File.md#constructor)
12
+
13
+ ### Accessors
14
+
15
+ - [id](File.md#id)
16
+ - [name](File.md#name)
17
+
18
+ ### Methods
19
+
20
+ - [status](File.md#status)
21
+ - [url](File.md#url)
22
+
23
+ ## Constructors
24
+
25
+ ### constructor
26
+
27
+ • **new File**(): [`File`](File.md)
28
+
29
+ #### Returns
30
+
31
+ [`File`](File.md)
32
+
33
+ ## Accessors
34
+
35
+ ### id
36
+
37
+ • `get` **id**(): `string`
38
+
39
+ File id.
40
+
41
+ #### Returns
42
+
43
+ `string`
44
+
45
+ ___
46
+
47
+ ### name
48
+
49
+ • `get` **name**(): `string`
50
+
51
+ File name.
52
+
53
+ #### Returns
54
+
55
+ `string`
56
+
57
+ ## Methods
58
+
59
+ ### status
60
+
61
+ ▸ **status**(): `Promise`\<`FileProgressDto`\>
62
+
63
+ Get file status.
64
+
65
+ #### Returns
66
+
67
+ `Promise`\<`FileProgressDto`\>
68
+
69
+ ___
70
+
71
+ ### url
72
+
73
+ ▸ **url**(): `Promise`\<`string`\>
74
+
75
+ Get temporary url.
76
+
77
+ #### Returns
78
+
79
+ `Promise`\<`string`\>
@@ -0,0 +1,136 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / Files
2
+
3
+ # Class: Files
4
+
5
+ Files storage.
6
+
7
+ ## Hierarchy
8
+
9
+ - [`EventDispatcher`](EventDispatcher.md)\<[`FilesEvent`](../enums/FilesEvent.md), [`File`](File.md)\>
10
+
11
+ ↳ **`Files`**
12
+
13
+ ## Table of contents
14
+
15
+ ### Constructors
16
+
17
+ - [constructor](Files.md#constructor)
18
+
19
+ ### Methods
20
+
21
+ - [delete](Files.md#delete)
22
+ - [dispatch](Files.md#dispatch)
23
+ - [query](Files.md#query)
24
+ - [subscribe](Files.md#subscribe)
25
+ - [upload](Files.md#upload)
26
+
27
+ ## Constructors
28
+
29
+ ### constructor
30
+
31
+ • **new Files**(): [`Files`](Files.md)
32
+
33
+ #### Returns
34
+
35
+ [`Files`](Files.md)
36
+
37
+ #### Inherited from
38
+
39
+ [EventDispatcher](EventDispatcher.md).[constructor](EventDispatcher.md#constructor)
40
+
41
+ ## Methods
42
+
43
+ ### delete
44
+
45
+ ▸ **delete**(`id`): `Promise`\<`void`\>
46
+
47
+ Delete file.
48
+
49
+ #### Parameters
50
+
51
+ | Name | Type |
52
+ | :------ | :------ |
53
+ | `id` | `string` |
54
+
55
+ #### Returns
56
+
57
+ `Promise`\<`void`\>
58
+
59
+ ___
60
+
61
+ ### dispatch
62
+
63
+ ▸ **dispatch**(`input`): `void`
64
+
65
+ #### Parameters
66
+
67
+ | Name | Type |
68
+ | :------ | :------ |
69
+ | `input` | [`Input`](../interfaces/Input.md)\<[`FilesEvent`](../enums/FilesEvent.md), [`File`](File.md)\> |
70
+
71
+ #### Returns
72
+
73
+ `void`
74
+
75
+ #### Inherited from
76
+
77
+ [EventDispatcher](EventDispatcher.md).[dispatch](EventDispatcher.md#dispatch)
78
+
79
+ ___
80
+
81
+ ### query
82
+
83
+ ▸ **query**(`query`, `page`, `limit`): `Promise`\<[`FilesPage`](FilesPage.md)\>
84
+
85
+ Query files.
86
+
87
+ #### Parameters
88
+
89
+ | Name | Type |
90
+ | :------ | :------ |
91
+ | `query` | `string` |
92
+ | `page` | `number` |
93
+ | `limit` | `number` |
94
+
95
+ #### Returns
96
+
97
+ `Promise`\<[`FilesPage`](FilesPage.md)\>
98
+
99
+ ___
100
+
101
+ ### subscribe
102
+
103
+ ▸ **subscribe**(`callback`, `type?`): [`Disposable`](../interfaces/Disposable.md)
104
+
105
+ #### Parameters
106
+
107
+ | Name | Type |
108
+ | :------ | :------ |
109
+ | `callback` | (`event`: [`Event`](../interfaces/Event.md)\<[`FilesEvent`](../enums/FilesEvent.md), [`File`](File.md)\>) => `void` |
110
+ | `type?` | [`FilesEvent`](../enums/FilesEvent.md) |
111
+
112
+ #### Returns
113
+
114
+ [`Disposable`](../interfaces/Disposable.md)
115
+
116
+ #### Inherited from
117
+
118
+ [EventDispatcher](EventDispatcher.md).[subscribe](EventDispatcher.md#subscribe)
119
+
120
+ ___
121
+
122
+ ### upload
123
+
124
+ ▸ **upload**(`file`): `Promise`\<[`File`](File.md)\>
125
+
126
+ Get file by id.
127
+
128
+ #### Parameters
129
+
130
+ | Name | Type |
131
+ | :------ | :------ |
132
+ | `file` | `File` |
133
+
134
+ #### Returns
135
+
136
+ `Promise`\<[`File`](File.md)\>
@@ -0,0 +1,76 @@
1
+ [@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / FilesPage
2
+
3
+ # Class: FilesPage
4
+
5
+ Files page.
6
+
7
+ ## Table of contents
8
+
9
+ ### Constructors
10
+
11
+ - [constructor](FilesPage.md#constructor)
12
+
13
+ ### Accessors
14
+
15
+ - [files](FilesPage.md#files)
16
+ - [page](FilesPage.md#page)
17
+ - [pages](FilesPage.md#pages)
18
+ - [total](FilesPage.md#total)
19
+
20
+ ## Constructors
21
+
22
+ ### constructor
23
+
24
+ • **new FilesPage**(): [`FilesPage`](FilesPage.md)
25
+
26
+ #### Returns
27
+
28
+ [`FilesPage`](FilesPage.md)
29
+
30
+ ## Accessors
31
+
32
+ ### files
33
+
34
+ • `get` **files**(): [`File`](File.md)[]
35
+
36
+ Get files.
37
+
38
+ #### Returns
39
+
40
+ [`File`](File.md)[]
41
+
42
+ ___
43
+
44
+ ### page
45
+
46
+ • `get` **page**(): `number`
47
+
48
+ Get current page.
49
+
50
+ #### Returns
51
+
52
+ `number`
53
+
54
+ ___
55
+
56
+ ### pages
57
+
58
+ • `get` **pages**(): `number`
59
+
60
+ Get pages count.
61
+
62
+ #### Returns
63
+
64
+ `number`
65
+
66
+ ___
67
+
68
+ ### total
69
+
70
+ • `get` **total**(): `number`
71
+
72
+ Get total count.
73
+
74
+ #### Returns
75
+
76
+ `number`