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

package/docs/classes/DataIslandApp.md

@@ -0,0 +1,168 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / DataIslandApp
+
+# Class: DataIslandApp
+
+DataIsland App instance.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](DataIslandApp.md#constructor)
+
+### Accessors
+
+- [automaticDataCollectionEnabled](DataIslandApp.md#automaticdatacollectionenabled)
+- [context](DataIslandApp.md#context)
+- [credential](DataIslandApp.md#credential)
+- [host](DataIslandApp.md#host)
+- [lifetime](DataIslandApp.md#lifetime)
+- [name](DataIslandApp.md#name)
+- [organizations](DataIslandApp.md#organizations)
+- [userProfile](DataIslandApp.md#userprofile)
+
+### Methods
+
+- [resolve](DataIslandApp.md#resolve)
+
+## Constructors
+
+### constructor
+
+• **new DataIslandApp**(): [`DataIslandApp`](DataIslandApp.md)
+
+#### Returns
+
+[`DataIslandApp`](DataIslandApp.md)
+
+## Accessors
+
+### automaticDataCollectionEnabled
+
+• `get` **automaticDataCollectionEnabled**(): `boolean`
+
+The automaticDataCollectionEnabled of this app.
+
+#### Returns
+
+`boolean`
+
+___
+
+### context
+
+• `get` **context**(): `Context`
+
+The context of this app.
+
+#### Returns
+
+`Context`
+
+___
+
+### credential
+
+• `get` **credential**(): `undefined` \| [`CredentialBase`](CredentialBase.md)
+
+The credential of this app.
+
+#### Returns
+
+`undefined` \| [`CredentialBase`](CredentialBase.md)
+
+• `set` **credential**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | [`CredentialBase`](CredentialBase.md) |
+
+#### Returns
+
+`void`
+
+___
+
+### host
+
+• `get` **host**(): `string`
+
+The host of this app.
+
+#### Returns
+
+`string`
+
+___
+
+### lifetime
+
+• `get` **lifetime**(): [`Lifetime`](Lifetime.md)
+
+The lifetime of this app.
+
+#### Returns
+
+[`Lifetime`](Lifetime.md)
+
+___
+
+### name
+
+• `get` **name**(): `string`
+
+The name of this app.
+
+#### Returns
+
+`string`
+
+___
+
+### organizations
+
+• `get` **organizations**(): [`Organizations`](Organizations.md)
+
+User's organizations.
+
+#### Returns
+
+[`Organizations`](Organizations.md)
+
+___
+
+### userProfile
+
+• `get` **userProfile**(): [`UserProfile`](UserProfile.md)
+
+User's profile.
+
+#### Returns
+
+[`UserProfile`](UserProfile.md)
+
+## Methods
+
+### resolve
+
+▸ **resolve**\<`T`\>(`type`): `undefined` \| `T`
+
+Resolve a service from the app.
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `type` | `Constructor`\<`T`\> |
+
+#### Returns
+
+`undefined` \| `T`

package/docs/classes/DebugCredential.md

@@ -0,0 +1,72 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / DebugCredential
+
+# Class: DebugCredential
+
+DataIsland App credential.
+
+## Hierarchy
+
+- [`CredentialBase`](CredentialBase.md)
+
+  ↳ **`DebugCredential`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](DebugCredential.md#constructor)
+
+### Properties
+
+- [token](DebugCredential.md#token)
+
+### Methods
+
+- [onRegister](DebugCredential.md#onregister)
+
+## Constructors
+
+### constructor
+
+• **new DebugCredential**(`token`): [`DebugCredential`](DebugCredential.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `token` | `string` |
+
+#### Returns
+
+[`DebugCredential`](DebugCredential.md)
+
+#### Overrides
+
+[CredentialBase](CredentialBase.md).[constructor](CredentialBase.md#constructor)
+
+## Properties
+
+### token
+
+• `Readonly` **token**: `string`
+
+## Methods
+
+### onRegister
+
+▸ **onRegister**(`lifetime`, `context`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `lifetime` | [`Lifetime`](Lifetime.md) |
+| `context` | `Context` |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[CredentialBase](CredentialBase.md).[onRegister](CredentialBase.md#onregister)

package/docs/classes/DefaultCredential.md

@@ -0,0 +1,56 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / DefaultCredential
+
+# Class: DefaultCredential
+
+DataIsland App credential.
+
+## Hierarchy
+
+- [`CredentialBase`](CredentialBase.md)
+
+  ↳ **`DefaultCredential`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](DefaultCredential.md#constructor)
+
+### Methods
+
+- [onRegister](DefaultCredential.md#onregister)
+
+## Constructors
+
+### constructor
+
+• **new DefaultCredential**(): [`DefaultCredential`](DefaultCredential.md)
+
+#### Returns
+
+[`DefaultCredential`](DefaultCredential.md)
+
+#### Inherited from
+
+[CredentialBase](CredentialBase.md).[constructor](CredentialBase.md#constructor)
+
+## Methods
+
+### onRegister
+
+▸ **onRegister**(`lifetime`, `context`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `lifetime` | [`Lifetime`](Lifetime.md) |
+| `context` | `Context` |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[CredentialBase](CredentialBase.md).[onRegister](CredentialBase.md#onregister)

package/docs/classes/DisposableContainer.md

@@ -0,0 +1,177 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / DisposableContainer
+
+# Class: DisposableContainer
+
+A container for disposables.
+Last added, first disposed.
+
+**`Example`**
+
+```ts
+const container = new DisposableContainer();
+container.add(someDisposable);
+container.addCallback(() => console.log('disposed'));
+container.dispose();
+```
+
+## Implements
+
+- [`Disposable`](../interfaces/Disposable.md)
+
+## Table of contents
+
+### Constructors
+
+- [constructor](DisposableContainer.md#constructor)
+
+### Properties
+
+- [\_disposables](DisposableContainer.md#_disposables)
+- [\_isDisposed](DisposableContainer.md#_isdisposed)
+- [\_lifetime](DisposableContainer.md#_lifetime)
+
+### Accessors
+
+- [isDisposed](DisposableContainer.md#isdisposed)
+- [lifetime](DisposableContainer.md#lifetime)
+
+### Methods
+
+- [\_throwIfDisposed](DisposableContainer.md#_throwifdisposed)
+- [add](DisposableContainer.md#add)
+- [addCallback](DisposableContainer.md#addcallback)
+- [defineNested](DisposableContainer.md#definenested)
+- [dispose](DisposableContainer.md#dispose)
+
+## Constructors
+
+### constructor
+
+• **new DisposableContainer**(): [`DisposableContainer`](DisposableContainer.md)
+
+#### Returns
+
+[`DisposableContainer`](DisposableContainer.md)
+
+## Properties
+
+### \_disposables
+
+• `Private` **\_disposables**: [`Disposable`](../interfaces/Disposable.md)[] = `[]`
+
+___
+
+### \_isDisposed
+
+• `Private` **\_isDisposed**: `boolean` = `false`
+
+___
+
+### \_lifetime
+
+• `Private` `Optional` **\_lifetime**: [`Lifetime`](Lifetime.md)
+
+## Accessors
+
+### isDisposed
+
+• `get` **isDisposed**(): `boolean`
+
+Gets whether this container is disposed.
+
+#### Returns
+
+`boolean`
+
+___
+
+### lifetime
+
+• `get` **lifetime**(): [`Lifetime`](Lifetime.md)
+
+Define new lifetime.
+
+#### Returns
+
+[`Lifetime`](Lifetime.md)
+
+## Methods
+
+### \_throwIfDisposed
+
+▸ **_throwIfDisposed**(): `void`
+
+Throws an error if this container is disposed.
+
+#### Returns
+
+`void`
+
+___
+
+### add
+
+▸ **add**(`disposable`): [`Disposable`](../interfaces/Disposable.md)
+
+Adds a disposable to this container.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `disposable` | [`Disposable`](../interfaces/Disposable.md) | The disposable to add. |
+
+#### Returns
+
+[`Disposable`](../interfaces/Disposable.md)
+
+The disposable container.
+
+___
+
+### addCallback
+
+▸ **addCallback**(`callback`, `target?`): [`Disposable`](../interfaces/Disposable.md)
+
+Adds a callback to be executed when this container is disposed.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `callback` | () => `void` | The callback to execute. |
+| `target?` | `unknown` | The target to bind the callback to. |
+
+#### Returns
+
+[`Disposable`](../interfaces/Disposable.md)
+
+The disposable container.
+
+___
+
+### defineNested
+
+▸ **defineNested**(): [`DisposableContainer`](DisposableContainer.md)
+
+Defines a nested disposable container.
+
+#### Returns
+
+[`DisposableContainer`](DisposableContainer.md)
+
+___
+
+### dispose
+
+▸ **dispose**(): `void`
+
+Disposes all disposables in this container. Last added, first disposed.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[Disposable](../interfaces/Disposable.md).[dispose](../interfaces/Disposable.md#dispose)

package/docs/classes/EventDispatcher.md

@@ -0,0 +1,109 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / EventDispatcher
+
+# Class: EventDispatcher\<EventType, DataType\>
+
+## Type parameters
+
+| Name |
+| :------ |
+| `EventType` |
+| `DataType` |
+
+## Hierarchy
+
+- **`EventDispatcher`**
+
+  ↳ [`Organizations`](Organizations.md)
+
+  ↳ [`Workspaces`](Workspaces.md)
+
+  ↳ [`Workspace`](Workspace.md)
+
+  ↳ [`Group`](Group.md)
+
+  ↳ [`Groups`](Groups.md)
+
+  ↳ [`UserProfile`](UserProfile.md)
+
+  ↳ [`Files`](Files.md)
+
+  ↳ [`Chats`](Chats.md)
+
+## Implements
+
+- [`EventSubscriber`](../interfaces/EventSubscriber.md)\<`EventType`, `DataType`\>
+
+## Table of contents
+
+### Constructors
+
+- [constructor](EventDispatcher.md#constructor)
+
+### Properties
+
+- [\_listeners](EventDispatcher.md#_listeners)
+
+### Methods
+
+- [dispatch](EventDispatcher.md#dispatch)
+- [subscribe](EventDispatcher.md#subscribe)
+
+## Constructors
+
+### constructor
+
+• **new EventDispatcher**\<`EventType`, `DataType`\>(): [`EventDispatcher`](EventDispatcher.md)\<`EventType`, `DataType`\>
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `EventType` |
+| `DataType` |
+
+#### Returns
+
+[`EventDispatcher`](EventDispatcher.md)\<`EventType`, `DataType`\>
+
+## Properties
+
+### \_listeners
+
+• `Private` **\_listeners**: \{ `callback`: (`value`: [`Event`](../interfaces/Event.md)\<`EventType`, `DataType`\>) => `void` ; `disposable`: [`Disposable`](../interfaces/Disposable.md)  }[] = `[]`
+
+## Methods
+
+### dispatch
+
+▸ **dispatch**(`input`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `input` | [`Input`](../interfaces/Input.md)\<`EventType`, `DataType`\> |
+
+#### Returns
+
+`void`
+
+___
+
+### subscribe
+
+▸ **subscribe**(`callback`, `type?`): [`Disposable`](../interfaces/Disposable.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `callback` | (`event`: [`Event`](../interfaces/Event.md)\<`EventType`, `DataType`\>) => `void` |
+| `type?` | `EventType` |
+
+#### Returns
+
+[`Disposable`](../interfaces/Disposable.md)
+
+#### Implementation of
+
+[EventSubscriber](../interfaces/EventSubscriber.md).[subscribe](../interfaces/EventSubscriber.md#subscribe)

package/docs/classes/File.md

@@ -0,0 +1,79 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / File
+
+# Class: File
+
+File.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](File.md#constructor)
+
+### Accessors
+
+- [id](File.md#id)
+- [name](File.md#name)
+
+### Methods
+
+- [status](File.md#status)
+- [url](File.md#url)
+
+## Constructors
+
+### constructor
+
+• **new File**(): [`File`](File.md)
+
+#### Returns
+
+[`File`](File.md)
+
+## Accessors
+
+### id
+
+• `get` **id**(): `string`
+
+File id.
+
+#### Returns
+
+`string`
+
+___
+
+### name
+
+• `get` **name**(): `string`
+
+File name.
+
+#### Returns
+
+`string`
+
+## Methods
+
+### status
+
+▸ **status**(): `Promise`\<`FileProgressDto`\>
+
+Get file status.
+
+#### Returns
+
+`Promise`\<`FileProgressDto`\>
+
+___
+
+### url
+
+▸ **url**(): `Promise`\<`string`\>
+
+Get temporary url.
+
+#### Returns
+
+`Promise`\<`string`\>