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

package/.github/workflows/publish-npm.yml

@@ -31,3 +31,14 @@ jobs:
         run: npm publish --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Read Version
+        id: package_version
+        run: echo "::set-output name=VERSION::$(node -p "require('./package.json').version")"
+  
+      - name: Tag Release
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git tag v${{ steps.package_version.outputs.VERSION }}
+          git push origin v${{ steps.package_version.outputs.VERSION }}

package/.github/workflows/tests.yml

@@ -2,6 +2,7 @@ name: Tests
 
 on:
   push:
+  workflow_dispatch:
   pull_request:
     branches:
       - master
@@ -14,6 +15,9 @@ on:
 jobs:
   tests:
     runs-on: ubuntu-latest
+    concurrency:
+      group: unitTests
+      cancel-in-progress: false
     steps:
       - uses: actions/checkout@v4
 

package/.github/workflows/version.yml

@@ -29,10 +29,14 @@ jobs:
 
       - name: Compare versions
         run: |
+          echo "BASE_VERSION=${{ env.BASE_VERSION }}"
+          echo "HEAD_VERSION=${{ env.HEAD_VERSION }}"
+          
+          SORTED_VERSIONS=$(echo -e "${{ env.BASE_VERSION }}\n${{ env.HEAD_VERSION }}" | sort -Vr | head -n 1)
           if [ "${{ env.HEAD_VERSION }}" = "${{ env.BASE_VERSION }}" ]; then
             echo "Error: Version in PR is the same as the base branch. It must be strictly higher."
             exit 1
-          elif [ "$(echo ${{ env.BASE_VERSION }} ${{ env.HEAD_VERSION }} | sort -Vr | head -n 1)" != "${{ env.HEAD_VERSION }}" ]; then
+          elif [ "$SORTED_VERSIONS" != "${{ env.HEAD_VERSION }}" ]; then
             echo "Error: Version in PR must be strictly higher than the base branch."
             exit 1
           else

package/README.md

@@ -1,6 +1,7 @@
 @neuralinnovations/dataisland-sdk/[Exports](./docs/modules.md)
 
-![Tests](https://github.com/NeuralInnovations/dataisland-client-js-sdk/actions/workflows/tests.yml/badge.svg?branch=main)
+![master](https://github.com/NeuralInnovations/dataisland-client-js-sdk/actions/workflows/tests.yml/badge.svg?branch=master)
+![develop](https://github.com/NeuralInnovations/dataisland-client-js-sdk/actions/workflows/tests.yml/badge.svg?branch=develop)
 
 # DataIsland Client SDK
 
@@ -96,6 +97,7 @@ const org = await app.organizations.create(
   'your-organization-description'
 )
 ```
+
 1. [Organization](docs/classes/Organization.md) is a main object for user data management. It contains of users, workspaces and chats.
 2. [Organizations](docs/classes/Organizations.md) is a collection of organizations.
 
@@ -103,7 +105,7 @@ const org = await app.organizations.create(
 
 ### Use workspaces
 
-Workspaces are folder-like objects used to store files and controll access to it using acces groups. During creation you must pass organization Id, name and description of new workspace and regulation options. You can pass existing group ID or ask to create new group for this workspace in regulation section. 
+Workspaces are folder-like objects used to store files and controll access to it using acces groups. During creation you must pass organization Id, name and description of new workspace and regulation options. You can pass existing group ID or ask to create new group for this workspace in regulation section.
 
 Default workspace creation example:
 
@@ -132,14 +134,45 @@ const workspace = await org.workspaces.create(
   }
 )
 ```
-1. [Workspace](docs/classes/Workspace.md) is a main object for files management. It contains of files, chats and access groups.
 
+1. [Workspace](docs/classes/Workspace.md) is a main object for files management. It contains of files, chats and access groups.
 2. [Worskpaces](docs/classes/Workspaces.md) is a collection of workspaces.
 
 ---
 
 ### Use files
 
+Files are part of workspaces and can be managed through workspace interface. You can upload, preview and delete files.
+
+Default file upload example:
+
+```
+const file = await workspace.files.upload(file)
+```
+
+The file uploading process always takes some time, so you can track its uploading status using the "status" method. The status result object includes a success indicator, the total count of file parts, the count of uploaded file parts, and an error field. The success indicator represents whether the last file part was uploaded successfully or not. If one of the parts fails, the uploading process is stopped, and the "error" field contains the text of the failure reason.
+
+```
+let status = await file.status()
+```
+
+Delete file example:
+
+```
+await workspace.files.delete(file.id)
+```
+
+You can retrieve a list of files from a workspace using the "query" method. It involves several straightforward parameters: a search query for filtering files based on user input (if empty, no filter is applied), page number, and the number of files per page. The method returns an object containing the file list, selected page number, total page count, and other relevant information.
+
+Here is an example:
+
+```
+const filesPage = await workspace.files.query(
+            "you-user-search-input", 
+            0 - page number,
+            20 - files limit per page )
+```
+
 ### Use chat
 
 ### Use access groups

package/docs/classes/BasicCredential.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / BasicCredential
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / BasicCredential
 
 # Class: BasicCredential
 

package/docs/classes/BearerCredential.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / BearerCredential
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / BearerCredential
 
 # Class: BearerCredential
 

package/docs/classes/Chat.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Chat
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / Chat
 
 # Class: Chat
 
@@ -10,12 +10,14 @@
 
 ### Accessors
 
+- [collection](Chat.md#collection)
 - [id](Chat.md#id)
 - [name](Chat.md#name)
+- [organization](Chat.md#organization)
 
 ### Methods
 
-- [question](Chat.md#question)
+- [ask](Chat.md#ask)
 
 ## Constructors
 
@@ -29,6 +31,18 @@
 
 ## Accessors
 
+### collection
+
+• `get` **collection**(): readonly `Answer`[]
+
+Answers list.
+
+#### Returns
+
+readonly `Answer`[]
+
+___
+
 ### id
 
 • `get` **id**(): `string`
@@ -51,19 +65,33 @@ Chat name.
 
 `string`
 
+___
+
+### organization
+
+• `get` **organization**(): [`Organization`](Organization.md)
+
+Organization.
+
+#### Returns
+
+[`Organization`](Organization.md)
+
 ## Methods
 
-### question
+### ask
+
+▸ **ask**(`message`, `answerType`): `Promise`\<`Answer`\>
 
-▸ **question**(`message`, `answer?`): `Promise`\<`void`\>
+Ask new question in chat.
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `message` | `string` |
-| `answer?` | [`ChatAnswer`](../enums/ChatAnswer.md) |
+| `answerType` | [`ChatAnswerType`](../enums/ChatAnswerType.md) |
 
 #### Returns
 
-`Promise`\<`void`\>
+`Promise`\<`Answer`\>

package/docs/classes/Chats.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Chats
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / Chats
 
 # Class: Chats
 
@@ -16,11 +16,19 @@ Chats storage.
 
 - [constructor](Chats.md#constructor)
 
+### Accessors
+
+- [collection](Chats.md#collection)
+- [organization](Chats.md#organization)
+
 ### Methods
 
 - [create](Chats.md#create)
+- [delete](Chats.md#delete)
 - [dispatch](Chats.md#dispatch)
+- [get](Chats.md#get)
 - [subscribe](Chats.md#subscribe)
+- [tryGet](Chats.md#tryget)
 
 ## Constructors
 
@@ -36,6 +44,30 @@ Chats storage.
 
 [EventDispatcher](EventDispatcher.md).[constructor](EventDispatcher.md#constructor)
 
+## Accessors
+
+### collection
+
+• `get` **collection**(): readonly [`Chat`](Chat.md)[]
+
+Chats list.
+
+#### Returns
+
+readonly [`Chat`](Chat.md)[]
+
+___
+
+### organization
+
+• `get` **organization**(): [`Organization`](Organization.md)
+
+Organization.
+
+#### Returns
+
+[`Organization`](Organization.md)
+
 ## Methods
 
 ### create
@@ -50,6 +82,24 @@ Create new chat.
 
 ___
 
+### delete
+
+▸ **delete**(`id`): `Promise`\<`void`\>
+
+Delete chat.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `id` | `string` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+___
+
 ### dispatch
 
 ▸ **dispatch**(`input`): `void`
@@ -70,6 +120,24 @@ ___
 
 ___
 
+### get
+
+▸ **get**(`id`): [`Chat`](Chat.md)
+
+Get chat by id.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `id` | `string` |
+
+#### Returns
+
+[`Chat`](Chat.md)
+
+___
+
 ### subscribe
 
 ▸ **subscribe**(`callback`, `type?`): [`Disposable`](../interfaces/Disposable.md)
@@ -88,3 +156,21 @@ ___
 #### Inherited from
 
 [EventDispatcher](EventDispatcher.md).[subscribe](EventDispatcher.md#subscribe)
+
+___
+
+### tryGet
+
+▸ **tryGet**(`id`): `undefined` \| [`Chat`](Chat.md)
+
+Try to get chat by id.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `id` | `string` |
+
+#### Returns
+
+`undefined` \| [`Chat`](Chat.md)

package/docs/classes/CredentialBase.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / CredentialBase
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / CredentialBase
 
 # Class: CredentialBase
 

package/docs/classes/DataIslandApp.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / DataIslandApp
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / DataIslandApp
 
 # Class: DataIslandApp
 

package/docs/classes/DebugCredential.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / DebugCredential
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / DebugCredential
 
 # Class: DebugCredential
 

package/docs/classes/DefaultCredential.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / DefaultCredential
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / DefaultCredential
 
 # Class: DefaultCredential
 

package/docs/classes/DisposableContainer.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / DisposableContainer
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / DisposableContainer
 
 # Class: DisposableContainer
 

package/docs/classes/EventDispatcher.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / EventDispatcher
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / EventDispatcher
 
 # Class: EventDispatcher\<EventType, DataType\>
 

package/docs/classes/File.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / File
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / File
 
 # Class: File
 

package/docs/classes/Files.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Files
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / Files
 
 # Class: Files
 
@@ -123,7 +123,7 @@ ___
 
 ▸ **upload**(`file`): `Promise`\<[`File`](File.md)\>
 
-Get file by id.
+Upload file.
 
 #### Parameters
 

package/docs/classes/FilesPage.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / FilesPage
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / FilesPage
 
 # Class: FilesPage
 

package/docs/classes/Group.md

@@ -1,7 +1,9 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Group
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / Group
 
 # Class: Group
 
+Group.
+
 ## Hierarchy
 
 - [`EventDispatcher`](EventDispatcher.md)\<[`GroupEvent`](../enums/GroupEvent.md), [`Group`](Group.md)\>
@@ -50,6 +52,8 @@
 
 • `get` **group**(): `AccessGroupDto`
 
+Group information.
+
 #### Returns
 
 `AccessGroupDto`
@@ -60,6 +64,8 @@ ___
 
 • `get` **id**(): `string`
 
+Group id.
+
 #### Returns
 
 `string`
@@ -70,6 +76,8 @@ ___
 
 • `get` **members**(): `UserDto`[]
 
+Group members.
+
 #### Returns
 
 `UserDto`[]
@@ -100,6 +108,8 @@ ___
 
 ▸ **getWorkspaces**(): `Promise`\<`WorkspaceDto`[]\>
 
+Group workspaces.
+
 #### Returns
 
 `Promise`\<`WorkspaceDto`[]\>
@@ -110,6 +120,8 @@ ___
 
 ▸ **setMembersIds**(`members`): `Promise`\<`void`\>
 
+Set members.
+
 #### Parameters
 
 | Name | Type |
@@ -126,6 +138,8 @@ ___
 
 ▸ **setName**(`name`): `Promise`\<`void`\>
 
+Set name.
+
 #### Parameters
 
 | Name | Type |
@@ -142,6 +156,8 @@ ___
 
 ▸ **setPermits**(`permits`): `Promise`\<`void`\>
 
+Set permits.
+
 #### Parameters
 
 | Name | Type |
@@ -159,6 +175,8 @@ ___
 
 ▸ **setWorkspaces**(`workspaces`): `Promise`\<`void`\>
 
+Set workspaces.
+
 #### Parameters
 
 | Name | Type |

package/docs/classes/Groups.md

@@ -1,7 +1,9 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Groups
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / Groups
 
 # Class: Groups
 
+Groups storage.
+
 ## Hierarchy
 
 - [`EventDispatcher`](EventDispatcher.md)\<[`GroupEvent`](../enums/GroupEvent.md), [`Group`](Group.md)\>
@@ -14,6 +16,10 @@
 
 - [constructor](Groups.md#constructor)
 
+### Accessors
+
+- [organization](Groups.md#organization)
+
 ### Methods
 
 - [create](Groups.md#create)
@@ -36,12 +42,26 @@
 
 [EventDispatcher](EventDispatcher.md).[constructor](EventDispatcher.md#constructor)
 
+## Accessors
+
+### organization
+
+• `get` **organization**(): [`Organization`](Organization.md)
+
+Organization.
+
+#### Returns
+
+[`Organization`](Organization.md)
+
 ## Methods
 
 ### create
 
 ▸ **create**(`name`, `organizationId`, `permits`, `memberIds`): `Promise`\<[`Group`](Group.md)\>
 
+Create new group.
+
 #### Parameters
 
 | Name | Type |
@@ -62,6 +82,8 @@ ___
 
 ▸ **delete**(`id`): `Promise`\<`void`\>
 
+delete group by id.
+
 #### Parameters
 
 | Name | Type |
@@ -96,7 +118,9 @@ ___
 
 ### get
 
-▸ **get**(`id`): `Promise`\<`undefined` \| [`Group`](Group.md)\>
+▸ **get**(`id`): `undefined` \| [`Group`](Group.md)
+
+Get group by id.
 
 #### Parameters
 
@@ -106,7 +130,7 @@ ___
 
 #### Returns
 
-`Promise`\<`undefined` \| [`Group`](Group.md)\>
+`undefined` \| [`Group`](Group.md)
 
 ___
 

package/docs/classes/Lifetime.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Lifetime
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / Lifetime
 
 # Class: Lifetime
 

package/docs/classes/Organization.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Organization
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / Organization
 
 # Class: Organization
 
@@ -13,11 +13,16 @@ Organization.
 ### Accessors
 
 - [accessGroups](Organization.md#accessgroups)
+- [chats](Organization.md#chats)
 - [description](Organization.md#description)
 - [id](Organization.md#id)
 - [name](Organization.md#name)
 - [workspaces](Organization.md#workspaces)
 
+### Methods
+
+- [createInviteLink](Organization.md#createinvitelink)
+
 ## Constructors
 
 ### constructor
@@ -42,6 +47,18 @@ Groups.
 
 ___
 
+### chats
+
+• `get` **chats**(): [`Chats`](Chats.md)
+
+Chats.
+
+#### Returns
+
+[`Chats`](Chats.md)
+
+___
+
 ### description
 
 • `get` **description**(): `string`
@@ -87,3 +104,22 @@ Workspaces.
 #### Returns
 
 [`Workspaces`](Workspaces.md)
+
+## Methods
+
+### createInviteLink
+
+▸ **createInviteLink**(`emails`, `accessGroups`): `Promise`\<`void`\>
+
+Create invite link
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `emails` | `string`[] |
+| `accessGroups` | `string`[] |
+
+#### Returns
+
+`Promise`\<`void`\>

package/docs/classes/Organizations.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Organizations
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / Organizations
 
 # Class: Organizations
 

package/docs/classes/UserProfile.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / UserProfile
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / UserProfile
 
 # Class: UserProfile
 

package/docs/classes/Workspace.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Workspace
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / Workspace
 
 # Class: Workspace
 

package/docs/classes/Workspaces.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Workspaces
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / Workspaces
 
 # Class: Workspaces
 
@@ -78,7 +78,7 @@ ___
 
 ### create
 
-▸ **create**(`name`, `description`): `Promise`\<[`Workspace`](Workspace.md)\>
+▸ **create**(`name`, `description`, `regulation?`): `Promise`\<[`Workspace`](Workspace.md)\>
 
 Create workspace.
 
@@ -88,6 +88,10 @@ Create workspace.
 | :------ | :------ |
 | `name` | `string` |
 | `description` | `string` |
+| `regulation?` | `Object` |
+| `regulation.groupIds` | `string`[] |
+| `regulation.isCreateNewGroup` | `boolean` |
+| `regulation.newGroupName` | `string` |
 
 #### Returns