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

package/docs/classes/Lifetime.md

@@ -0,0 +1,108 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Lifetime
+
+# Class: Lifetime
+
+Represents a lifetime.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Lifetime.md#constructor)
+
+### Properties
+
+- [container](Lifetime.md#container)
+
+### Accessors
+
+- [isDisposed](Lifetime.md#isdisposed)
+
+### Methods
+
+- [add](Lifetime.md#add)
+- [addCallback](Lifetime.md#addcallback)
+- [defineNested](Lifetime.md#definenested)
+
+## Constructors
+
+### constructor
+
+• **new Lifetime**(`container`): [`Lifetime`](Lifetime.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `container` | [`DisposableContainer`](DisposableContainer.md) |
+
+#### Returns
+
+[`Lifetime`](Lifetime.md)
+
+## Properties
+
+### container
+
+• `Private` `Readonly` **container**: [`DisposableContainer`](DisposableContainer.md)
+
+## Accessors
+
+### isDisposed
+
+• `get` **isDisposed**(): `boolean`
+
+Shows whether this lifetime is disposed.
+
+#### Returns
+
+`boolean`
+
+## Methods
+
+### add
+
+▸ **add**(`disposable`): `this`
+
+Adds a disposable to this lifetime.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `disposable` | [`Disposable`](../interfaces/Disposable.md) |
+
+#### Returns
+
+`this`
+
+___
+
+### addCallback
+
+▸ **addCallback**(`callback`, `target?`): `this`
+
+Adds a callback to this lifetime.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `callback` | () => `void` |
+| `target?` | `unknown` |
+
+#### Returns
+
+`this`
+
+___
+
+### defineNested
+
+▸ **defineNested**(): [`DisposableContainer`](DisposableContainer.md)
+
+Define a new nested disposable to this lifetime.
+
+#### Returns
+
+[`DisposableContainer`](DisposableContainer.md)

package/docs/classes/Organization.md

@@ -0,0 +1,89 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Organization
+
+# Class: Organization
+
+Organization.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Organization.md#constructor)
+
+### Accessors
+
+- [accessGroups](Organization.md#accessgroups)
+- [description](Organization.md#description)
+- [id](Organization.md#id)
+- [name](Organization.md#name)
+- [workspaces](Organization.md#workspaces)
+
+## Constructors
+
+### constructor
+
+• **new Organization**(): [`Organization`](Organization.md)
+
+#### Returns
+
+[`Organization`](Organization.md)
+
+## Accessors
+
+### accessGroups
+
+• `get` **accessGroups**(): [`Groups`](Groups.md)
+
+Groups.
+
+#### Returns
+
+[`Groups`](Groups.md)
+
+___
+
+### description
+
+• `get` **description**(): `string`
+
+Organization description.
+
+#### Returns
+
+`string`
+
+___
+
+### id
+
+• `get` **id**(): `string`
+
+Organization id.
+
+#### Returns
+
+`string`
+
+___
+
+### name
+
+• `get` **name**(): `string`
+
+Organization name.
+
+#### Returns
+
+`string`
+
+___
+
+### workspaces
+
+• `get` **workspaces**(): [`Workspaces`](Workspaces.md)
+
+Workspaces.
+
+#### Returns
+
+[`Workspaces`](Workspaces.md)

package/docs/classes/Organizations.md

@@ -0,0 +1,195 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Organizations
+
+# Class: Organizations
+
+Organizations storage.
+
+## Hierarchy
+
+- [`EventDispatcher`](EventDispatcher.md)\<[`OrganizationsEvent`](../enums/OrganizationsEvent.md), [`Organization`](Organization.md)\>
+
+  ↳ **`Organizations`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Organizations.md#constructor)
+
+### Accessors
+
+- [collection](Organizations.md#collection)
+- [current](Organizations.md#current)
+
+### Methods
+
+- [create](Organizations.md#create)
+- [delete](Organizations.md#delete)
+- [dispatch](Organizations.md#dispatch)
+- [get](Organizations.md#get)
+- [subscribe](Organizations.md#subscribe)
+- [tryGet](Organizations.md#tryget)
+
+## Constructors
+
+### constructor
+
+• **new Organizations**(): [`Organizations`](Organizations.md)
+
+#### Returns
+
+[`Organizations`](Organizations.md)
+
+#### Inherited from
+
+[EventDispatcher](EventDispatcher.md).[constructor](EventDispatcher.md#constructor)
+
+## Accessors
+
+### collection
+
+• `get` **collection**(): readonly [`Organization`](Organization.md)[]
+
+User's organizations.
+
+#### Returns
+
+readonly [`Organization`](Organization.md)[]
+
+___
+
+### current
+
+• `get` **current**(): `string`
+
+Current organization.
+
+#### Returns
+
+`string`
+
+• `set` **current**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `string` |
+
+#### Returns
+
+`void`
+
+## Methods
+
+### create
+
+▸ **create**(`name`, `description`): `Promise`\<[`Organization`](Organization.md)\>
+
+Create new organization.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+| `description` | `string` |
+
+#### Returns
+
+`Promise`\<[`Organization`](Organization.md)\>
+
+___
+
+### delete
+
+▸ **delete**(`id`): `Promise`\<`void`\>
+
+Delete organization.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `id` | `string` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+___
+
+### dispatch
+
+▸ **dispatch**(`input`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `input` | [`Input`](../interfaces/Input.md)\<[`OrganizationsEvent`](../enums/OrganizationsEvent.md), [`Organization`](Organization.md)\> |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[EventDispatcher](EventDispatcher.md).[dispatch](EventDispatcher.md#dispatch)
+
+___
+
+### get
+
+▸ **get**(`id`): [`Organization`](Organization.md)
+
+Get organization by id.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `id` | `string` |
+
+#### Returns
+
+[`Organization`](Organization.md)
+
+___
+
+### subscribe
+
+▸ **subscribe**(`callback`, `type?`): [`Disposable`](../interfaces/Disposable.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `callback` | (`event`: [`Event`](../interfaces/Event.md)\<[`OrganizationsEvent`](../enums/OrganizationsEvent.md), [`Organization`](Organization.md)\>) => `void` |
+| `type?` | [`OrganizationsEvent`](../enums/OrganizationsEvent.md) |
+
+#### Returns
+
+[`Disposable`](../interfaces/Disposable.md)
+
+#### Inherited from
+
+[EventDispatcher](EventDispatcher.md).[subscribe](EventDispatcher.md#subscribe)
+
+___
+
+### tryGet
+
+▸ **tryGet**(`id`): `undefined` \| [`Organization`](Organization.md)
+
+Try to get organization by id.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `id` | `string` |
+
+#### Returns
+
+`undefined` \| [`Organization`](Organization.md)

package/docs/classes/UserProfile.md

@@ -0,0 +1,156 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / UserProfile
+
+# Class: UserProfile
+
+## Hierarchy
+
+- [`EventDispatcher`](EventDispatcher.md)\<[`UserEvent`](../enums/UserEvent.md), [`UserProfile`](UserProfile.md)\>
+
+  ↳ **`UserProfile`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](UserProfile.md#constructor)
+
+### Accessors
+
+- [createdAt](UserProfile.md#createdat)
+- [email](UserProfile.md#email)
+- [id](UserProfile.md#id)
+- [isDeleted](UserProfile.md#isdeleted)
+- [modifiedAt](UserProfile.md#modifiedat)
+- [name](UserProfile.md#name)
+
+### Methods
+
+- [dispatch](UserProfile.md#dispatch)
+- [subscribe](UserProfile.md#subscribe)
+
+## Constructors
+
+### constructor
+
+• **new UserProfile**(): [`UserProfile`](UserProfile.md)
+
+#### Returns
+
+[`UserProfile`](UserProfile.md)
+
+#### Inherited from
+
+[EventDispatcher](EventDispatcher.md).[constructor](EventDispatcher.md#constructor)
+
+## Accessors
+
+### createdAt
+
+• `get` **createdAt**(): `Date`
+
+Created at.
+
+#### Returns
+
+`Date`
+
+___
+
+### email
+
+• `get` **email**(): `string`
+
+User email.
+
+#### Returns
+
+`string`
+
+___
+
+### id
+
+• `get` **id**(): `string`
+
+User id.
+
+#### Returns
+
+`string`
+
+___
+
+### isDeleted
+
+• `get` **isDeleted**(): `boolean`
+
+Is user deleted.
+
+#### Returns
+
+`boolean`
+
+___
+
+### modifiedAt
+
+• `get` **modifiedAt**(): `Date`
+
+Modified at.
+
+#### Returns
+
+`Date`
+
+___
+
+### name
+
+• `get` **name**(): `string`
+
+User name.
+
+#### Returns
+
+`string`
+
+## Methods
+
+### dispatch
+
+▸ **dispatch**(`input`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `input` | [`Input`](../interfaces/Input.md)\<[`CHANGED`](../enums/UserEvent.md#changed), [`UserProfile`](UserProfile.md)\> |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[EventDispatcher](EventDispatcher.md).[dispatch](EventDispatcher.md#dispatch)
+
+___
+
+### subscribe
+
+▸ **subscribe**(`callback`, `type?`): [`Disposable`](../interfaces/Disposable.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `callback` | (`event`: [`Event`](../interfaces/Event.md)\<[`CHANGED`](../enums/UserEvent.md#changed), [`UserProfile`](UserProfile.md)\>) => `void` |
+| `type?` | [`CHANGED`](../enums/UserEvent.md#changed) |
+
+#### Returns
+
+[`Disposable`](../interfaces/Disposable.md)
+
+#### Inherited from
+
+[EventDispatcher](EventDispatcher.md).[subscribe](EventDispatcher.md#subscribe)

package/docs/classes/Workspace.md

@@ -0,0 +1,165 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Workspace
+
+# Class: Workspace
+
+Workspace.
+
+## Hierarchy
+
+- [`EventDispatcher`](EventDispatcher.md)\<[`WorkspaceEvent`](../enums/WorkspaceEvent.md), [`Workspace`](Workspace.md)\>
+
+  ↳ **`Workspace`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Workspace.md#constructor)
+
+### Accessors
+
+- [description](Workspace.md#description)
+- [files](Workspace.md#files)
+- [id](Workspace.md#id)
+- [name](Workspace.md#name)
+- [organization](Workspace.md#organization)
+
+### Methods
+
+- [change](Workspace.md#change)
+- [dispatch](Workspace.md#dispatch)
+- [subscribe](Workspace.md#subscribe)
+
+## Constructors
+
+### constructor
+
+• **new Workspace**(): [`Workspace`](Workspace.md)
+
+#### Returns
+
+[`Workspace`](Workspace.md)
+
+#### Inherited from
+
+[EventDispatcher](EventDispatcher.md).[constructor](EventDispatcher.md#constructor)
+
+## Accessors
+
+### description
+
+• `get` **description**(): `string`
+
+Workspace description.
+
+#### Returns
+
+`string`
+
+___
+
+### files
+
+• `get` **files**(): [`Files`](Files.md)
+
+Workspace files.
+
+#### Returns
+
+[`Files`](Files.md)
+
+___
+
+### id
+
+• `get` **id**(): `string`
+
+Workspace id.
+
+#### Returns
+
+`string`
+
+___
+
+### name
+
+• `get` **name**(): `string`
+
+Workspace name.
+
+#### Returns
+
+`string`
+
+___
+
+### organization
+
+• `get` **organization**(): [`Organization`](Organization.md)
+
+Organization.
+
+#### Returns
+
+[`Organization`](Organization.md)
+
+## Methods
+
+### change
+
+▸ **change**(`name`, `description`): `Promise`\<`void`\>
+
+Change workspace name and description.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+| `description` | `string` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+___
+
+### dispatch
+
+▸ **dispatch**(`input`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `input` | [`Input`](../interfaces/Input.md)\<[`CHANGED`](../enums/WorkspaceEvent.md#changed), [`Workspace`](Workspace.md)\> |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[EventDispatcher](EventDispatcher.md).[dispatch](EventDispatcher.md#dispatch)
+
+___
+
+### subscribe
+
+▸ **subscribe**(`callback`, `type?`): [`Disposable`](../interfaces/Disposable.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `callback` | (`event`: [`Event`](../interfaces/Event.md)\<[`CHANGED`](../enums/WorkspaceEvent.md#changed), [`Workspace`](Workspace.md)\>) => `void` |
+| `type?` | [`CHANGED`](../enums/WorkspaceEvent.md#changed) |
+
+#### Returns
+
+[`Disposable`](../interfaces/Disposable.md)
+
+#### Inherited from
+
+[EventDispatcher](EventDispatcher.md).[subscribe](EventDispatcher.md#subscribe)