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

package/docs/interfaces/Event.md

@@ -0,0 +1,58 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / Event
+
+# Interface: Event\<EventType, DataType\>
+
+## Type parameters
+
+| Name |
+| :------ |
+| `EventType` |
+| `DataType` |
+
+## Hierarchy
+
+- [`Input`](Input.md)\<`EventType`, `DataType`\>
+
+  ↳ **`Event`**
+
+## Table of contents
+
+### Properties
+
+- [data](Event.md#data)
+- [type](Event.md#type)
+- [unsubscribe](Event.md#unsubscribe)
+
+## Properties
+
+### data
+
+• **data**: `DataType`
+
+#### Inherited from
+
+[Input](Input.md).[data](Input.md#data)
+
+___
+
+### type
+
+• `Optional` **type**: `EventType`
+
+#### Inherited from
+
+[Input](Input.md).[type](Input.md#type)
+
+___
+
+### unsubscribe
+
+• **unsubscribe**: () => `void`
+
+#### Type declaration
+
+▸ (): `void`
+
+##### Returns
+
+`void`

package/docs/interfaces/EventSubscriber.md

@@ -0,0 +1,41 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / EventSubscriber
+
+# Interface: EventSubscriber\<EventType, DataType\>
+
+## Type parameters
+
+| Name |
+| :------ |
+| `EventType` |
+| `DataType` |
+
+## Implemented by
+
+- [`EventDispatcher`](../classes/EventDispatcher.md)
+
+## Table of contents
+
+### Properties
+
+- [subscribe](EventSubscriber.md#subscribe)
+
+## Properties
+
+### subscribe
+
+• **subscribe**: (`callback`: (`event`: [`Event`](Event.md)\<`EventType`, `DataType`\>) => `void`, `type?`: `EventType`) => [`Disposable`](Disposable.md)
+
+#### Type declaration
+
+▸ (`callback`, `type?`): [`Disposable`](Disposable.md)
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `callback` | (`event`: [`Event`](Event.md)\<`EventType`, `DataType`\>) => `void` |
+| `type?` | `EventType` |
+
+##### Returns
+
+[`Disposable`](Disposable.md)

package/docs/interfaces/Input.md

@@ -0,0 +1,35 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / Input
+
+# Interface: Input\<EventType, DataType\>
+
+## Type parameters
+
+| Name |
+| :------ |
+| `EventType` |
+| `DataType` |
+
+## Hierarchy
+
+- **`Input`**
+
+  ↳ [`Event`](Event.md)
+
+## Table of contents
+
+### Properties
+
+- [data](Input.md#data)
+- [type](Input.md#type)
+
+## Properties
+
+### data
+
+• **data**: `DataType`
+
+___
+
+### type
+
+• `Optional` **type**: `EventType`

package/docs/modules.md

@@ -0,0 +1,205 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../README.md) / Exports
+
+# @neuralinnovations/dataisland-sdk - v0.0.1-dev7
+
+## Table of contents
+
+### Enumerations
+
+- [ChatAnswer](enums/ChatAnswer.md)
+- [ChatsEvent](enums/ChatsEvent.md)
+- [FilesEvent](enums/FilesEvent.md)
+- [GroupEvent](enums/GroupEvent.md)
+- [OrganizationsEvent](enums/OrganizationsEvent.md)
+- [UserEvent](enums/UserEvent.md)
+- [WorkspaceEvent](enums/WorkspaceEvent.md)
+- [WorkspacesEvent](enums/WorkspacesEvent.md)
+
+### Classes
+
+- [BasicCredential](classes/BasicCredential.md)
+- [BearerCredential](classes/BearerCredential.md)
+- [Chat](classes/Chat.md)
+- [Chats](classes/Chats.md)
+- [CredentialBase](classes/CredentialBase.md)
+- [DataIslandApp](classes/DataIslandApp.md)
+- [DebugCredential](classes/DebugCredential.md)
+- [DefaultCredential](classes/DefaultCredential.md)
+- [DisposableContainer](classes/DisposableContainer.md)
+- [EventDispatcher](classes/EventDispatcher.md)
+- [File](classes/File.md)
+- [Files](classes/Files.md)
+- [FilesPage](classes/FilesPage.md)
+- [Group](classes/Group.md)
+- [Groups](classes/Groups.md)
+- [Lifetime](classes/Lifetime.md)
+- [Organization](classes/Organization.md)
+- [Organizations](classes/Organizations.md)
+- [UserProfile](classes/UserProfile.md)
+- [Workspace](classes/Workspace.md)
+- [Workspaces](classes/Workspaces.md)
+
+### Interfaces
+
+- [Disposable](interfaces/Disposable.md)
+- [Event](interfaces/Event.md)
+- [EventSubscriber](interfaces/EventSubscriber.md)
+- [Input](interfaces/Input.md)
+
+### Type Aliases
+
+- [ChatId](modules.md#chatid)
+- [FileId](modules.md#fileid)
+- [GroupId](modules.md#groupid)
+- [OrganizationId](modules.md#organizationid)
+- [UploadFile](modules.md#uploadfile)
+- [UserId](modules.md#userid)
+- [WorkspaceId](modules.md#workspaceid)
+
+### Variables
+
+- [DEFAULT\_HOST](modules.md#default_host)
+- [DEFAULT\_NAME](modules.md#default_name)
+- [SDK\_VERSION](modules.md#sdk_version)
+
+### Functions
+
+- [dataIslandApp](modules.md#dataislandapp)
+- [dataIslandInstances](modules.md#dataislandinstances)
+- [disposable](modules.md#disposable)
+
+## Type Aliases
+
+### ChatId
+
+Ƭ **ChatId**: `string`
+
+___
+
+### FileId
+
+Ƭ **FileId**: `string`
+
+___
+
+### GroupId
+
+Ƭ **GroupId**: `string`
+
+___
+
+### OrganizationId
+
+Ƭ **OrganizationId**: `string`
+
+Organization id.
+
+___
+
+### UploadFile
+
+Ƭ **UploadFile**: `globalThis.File`
+
+Upload file.
+
+___
+
+### UserId
+
+Ƭ **UserId**: `string`
+
+___
+
+### WorkspaceId
+
+Ƭ **WorkspaceId**: `string`
+
+## Variables
+
+### DEFAULT\_HOST
+
+• `Const` **DEFAULT\_HOST**: ``"https://api.dataisland.com.ua"``
+
+Default DataIsland App host.
+
+___
+
+### DEFAULT\_NAME
+
+• `Const` **DEFAULT\_NAME**: ``"[DEFAULT]"``
+
+Default DataIsland App name.
+
+___
+
+### SDK\_VERSION
+
+• `Const` **SDK\_VERSION**: `string` = `version`
+
+Current SDK version.
+
+## Functions
+
+### dataIslandApp
+
+▸ **dataIslandApp**(`name?`, `setup?`): `Promise`\<[`DataIslandApp`](classes/DataIslandApp.md)\>
+
+Returns a DataIsland App instance.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `name?` | `string` | Optional The name of the app. |
+| `setup?` | (`builder`: `AppBuilder`) => `Promise`\<`void`\> | Optional setup function. |
+
+#### Returns
+
+`Promise`\<[`DataIslandApp`](classes/DataIslandApp.md)\>
+
+A DataIsland App instance.
+
+**`Example`**
+
+```js
+import { dataIslandApp, DEFAULT_NAME } from '@neuralinnovations/dataisland-sdk'
+
+const app = await dataIslandApp(DEFAULT_NAME, builder => {
+ builder.useHost("https://dataisland.com.ua")
+ builder.useAutomaticDataCollectionEnabled(true)
+ builder.useCredential(new BasicCredential("email", "password"))
+ })
+```
+
+___
+
+### dataIslandInstances
+
+▸ **dataIslandInstances**(): [`DataIslandApp`](classes/DataIslandApp.md)[]
+
+Returns a list of DataIsland App instances.
+
+#### Returns
+
+[`DataIslandApp`](classes/DataIslandApp.md)[]
+
+___
+
+### disposable
+
+▸ **disposable**(`action`, `target`): [`Disposable`](interfaces/Disposable.md)
+
+Creates a disposable.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `action` | () => `void` | The action to execute when disposed. |
+| `target` | `unknown` | The target to bind the action to. |
+
+#### Returns
+
+[`Disposable`](interfaces/Disposable.md)
+
+The disposable.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neuralinnovations/dataisland-sdk",
-  "version": "0.0.1-dev6",
+  "version": "0.0.1-dev7",
   "description": "SDK for DataIsland project",
   "licenses": [
     {
@@ -15,7 +15,8 @@
     "build": "tsc",
     "test": "jest",
     "lint": "eslint --ext .ts,.tsx src test",
-    "lint:fix": "eslint --fix --ext .ts,.tsx src test"
+    "lint:fix": "eslint --fix --ext .ts,.tsx src test",
+    "docs": "typedoc --disableSources --includeVersion --plugin typedoc-plugin-markdown --out docs src/index.ts && node scripts/docs/index.js"
   },
   "author": "Neural Innovations LTD",
   "license": "Apache-2.0",
@@ -50,6 +51,7 @@
     "tslib": "^2.6.2",
     "tslint": "6.1.3",
     "typedoc": "^0.25.7",
+    "typedoc-plugin-markdown": "^3.17.1",
     "typescript": "^5.3.3",
     "watch": "^0.13.0",
     "webpack": "5.76.0",

package/scripts/docs/index.js

@@ -0,0 +1,15 @@
+const fs = require("fs")
+
+fs.readdirSync("docs", {
+  recursive: true
+}).forEach((file) => {
+  if (file.endsWith(".md")) {
+    const content = fs.readFileSync(`docs/${file}`, "utf8")
+    const newContent = content
+      .replaceAll("(../README.md)", "(../../README.md)")
+      .replaceAll("(README.md)", "(../README.md)")
+    fs.writeFileSync(`docs/${file}`, newContent, "utf8")
+  }
+}
+)
+fs.rmSync("docs/README.md")