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

package/docs/classes/Group.md

@@ -0,0 +1,191 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / Group
+
+# Class: Group
+
+## Hierarchy
+
+- [`EventDispatcher`](EventDispatcher.md)\<[`GroupEvent`](../enums/GroupEvent.md), [`Group`](Group.md)\>
+
+  ↳ **`Group`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Group.md#constructor)
+
+### Accessors
+
+- [group](Group.md#group)
+- [id](Group.md#id)
+- [members](Group.md#members)
+
+### Methods
+
+- [dispatch](Group.md#dispatch)
+- [getWorkspaces](Group.md#getworkspaces)
+- [setMembersIds](Group.md#setmembersids)
+- [setName](Group.md#setname)
+- [setPermits](Group.md#setpermits)
+- [setWorkspaces](Group.md#setworkspaces)
+- [subscribe](Group.md#subscribe)
+
+## Constructors
+
+### constructor
+
+• **new Group**(): [`Group`](Group.md)
+
+#### Returns
+
+[`Group`](Group.md)
+
+#### Inherited from
+
+[EventDispatcher](EventDispatcher.md).[constructor](EventDispatcher.md#constructor)
+
+## Accessors
+
+### group
+
+• `get` **group**(): `AccessGroupDto`
+
+#### Returns
+
+`AccessGroupDto`
+
+___
+
+### id
+
+• `get` **id**(): `string`
+
+#### Returns
+
+`string`
+
+___
+
+### members
+
+• `get` **members**(): `UserDto`[]
+
+#### Returns
+
+`UserDto`[]
+
+## Methods
+
+### dispatch
+
+▸ **dispatch**(`input`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `input` | [`Input`](../interfaces/Input.md)\<[`GroupEvent`](../enums/GroupEvent.md), [`Group`](Group.md)\> |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[EventDispatcher](EventDispatcher.md).[dispatch](EventDispatcher.md#dispatch)
+
+___
+
+### getWorkspaces
+
+▸ **getWorkspaces**(): `Promise`\<`WorkspaceDto`[]\>
+
+#### Returns
+
+`Promise`\<`WorkspaceDto`[]\>
+
+___
+
+### setMembersIds
+
+▸ **setMembersIds**(`members`): `Promise`\<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `members` | `string`[] |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+___
+
+### setName
+
+▸ **setName**(`name`): `Promise`\<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+___
+
+### setPermits
+
+▸ **setPermits**(`permits`): `Promise`\<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `permits` | `Object` |
+| `permits.isAdmin` | `boolean` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+___
+
+### setWorkspaces
+
+▸ **setWorkspaces**(`workspaces`): `Promise`\<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `workspaces` | `string`[] |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+___
+
+### subscribe
+
+▸ **subscribe**(`callback`, `type?`): [`Disposable`](../interfaces/Disposable.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `callback` | (`event`: [`Event`](../interfaces/Event.md)\<[`GroupEvent`](../enums/GroupEvent.md), [`Group`](Group.md)\>) => `void` |
+| `type?` | [`GroupEvent`](../enums/GroupEvent.md) |
+
+#### Returns
+
+[`Disposable`](../interfaces/Disposable.md)
+
+#### Inherited from
+
+[EventDispatcher](EventDispatcher.md).[subscribe](EventDispatcher.md#subscribe)

package/docs/classes/Groups.md

@@ -0,0 +1,130 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / Groups
+
+# Class: Groups
+
+## Hierarchy
+
+- [`EventDispatcher`](EventDispatcher.md)\<[`GroupEvent`](../enums/GroupEvent.md), [`Group`](Group.md)\>
+
+  ↳ **`Groups`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Groups.md#constructor)
+
+### Methods
+
+- [create](Groups.md#create)
+- [delete](Groups.md#delete)
+- [dispatch](Groups.md#dispatch)
+- [get](Groups.md#get)
+- [subscribe](Groups.md#subscribe)
+
+## Constructors
+
+### constructor
+
+• **new Groups**(): [`Groups`](Groups.md)
+
+#### Returns
+
+[`Groups`](Groups.md)
+
+#### Inherited from
+
+[EventDispatcher](EventDispatcher.md).[constructor](EventDispatcher.md#constructor)
+
+## Methods
+
+### create
+
+▸ **create**(`name`, `organizationId`, `permits`, `memberIds`): `Promise`\<[`Group`](Group.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+| `organizationId` | `string` |
+| `permits` | `Object` |
+| `permits.isAdmin` | `boolean` |
+| `memberIds` | `string`[] |
+
+#### Returns
+
+`Promise`\<[`Group`](Group.md)\>
+
+___
+
+### delete
+
+▸ **delete**(`id`): `Promise`\<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `id` | `string` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+___
+
+### dispatch
+
+▸ **dispatch**(`input`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `input` | [`Input`](../interfaces/Input.md)\<[`GroupEvent`](../enums/GroupEvent.md), [`Group`](Group.md)\> |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[EventDispatcher](EventDispatcher.md).[dispatch](EventDispatcher.md#dispatch)
+
+___
+
+### get
+
+▸ **get**(`id`): `Promise`\<`undefined` \| [`Group`](Group.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `id` | `string` |
+
+#### Returns
+
+`Promise`\<`undefined` \| [`Group`](Group.md)\>
+
+___
+
+### subscribe
+
+▸ **subscribe**(`callback`, `type?`): [`Disposable`](../interfaces/Disposable.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `callback` | (`event`: [`Event`](../interfaces/Event.md)\<[`GroupEvent`](../enums/GroupEvent.md), [`Group`](Group.md)\>) => `void` |
+| `type?` | [`GroupEvent`](../enums/GroupEvent.md) |
+
+#### Returns
+
+[`Disposable`](../interfaces/Disposable.md)
+
+#### Inherited from
+
+[EventDispatcher](EventDispatcher.md).[subscribe](EventDispatcher.md#subscribe)

package/docs/classes/Lifetime.md

@@ -0,0 +1,108 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../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-dev7](../../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-dev7](../../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)