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

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

@@ -16,12 +16,25 @@ jobs:
       - name: ⏩ CI Install ⏩
         run: npm ci
 
-      - name: 🧪 Test 🧪
-        run: npm test >> $GITHUB_STEP_SUMMARY | cat
+      - name: 🌈 Lint 🌈
+        run: npm run lint:fix
 
       - name: 🧱 Build 🧱
         run: npm run build
 
+      - name: 🧪 Test 🧪
+        run: npm test >> $GITHUB_STEP_SUMMARY | cat
+
+      - name: 📝 Docs 📝
+        run: npm run docs
+
+      - name: 📋 Check changes 📋
+        run: |
+          git diff --exit-code --quiet || {
+            echo "There are changes to commit"
+            exit 1
+          }
+
       - name: 📢 Publish to npm 📢
         run: npm publish --access public
         env:

package/README.md

@@ -1,3 +1,5 @@
+@neuralinnovations/dataisland-sdk/[Exports](./docs/modules.md)
+
 # DataIsland Client SDK
 
 The DataIsland Client SDK is a TypeScript library designed to seamlessly integrate DataIsland web services into websites.
@@ -12,6 +14,9 @@ The DataIsland Client SDK is a TypeScript library designed to seamlessly integra
 6. [Use files](#use-files)
 7. [Use access groups](#use-access-groups)
 8. [Use invites](#use-invites)
+9. [References](docs/modules.md)
+
+---
 
 ### Install
 
@@ -21,12 +26,15 @@ For connecting this library to your website project simply install it using npm
 npm i @neuralinnovations/dataisland-sdk
 ```
 
+---
+
 ### Create app
 
 You can initialize default app sdk instance using this code example.
 
 ```typescript
 // default production app sdk instance
+// it is an instance of DataIslandApp
 const dataIslandSdk = await dataIslandApp()
 
 // specific app sdk instance 
@@ -38,6 +46,8 @@ const yourAppNameSdk = await dataIslandApp('your-app-name', async (builder: AppB
 })
 ```
 
+[DataIslandApp](docs/classes/DataIslandApp.md) is a application instance. It contains of user profile, organizations and context.
+
 _It is immpossible to create more than one app sdk intance with same name._
 
 **HOST** is a DataIsland API url which can be passed using environment file.
@@ -47,6 +57,7 @@ Second required parameter for builder is Credentials. It is recomended to use Be
 You can also add requests middlewares with builder options.
 
 ```typescript
+// The app is an instance of DataIslandApp
 const app = await dataIslandApp('your-app-name', async (builder: AppBuilder) => {
   builder.useHost(YOUR_HOST)
   builder.useAutomaticDataCollectionEnabled(false)
@@ -58,6 +69,10 @@ const app = await dataIslandApp('your-app-name', async (builder: AppBuilder) =>
 })
 ```
 
+[DataIslandApp](docs/classes/DataIslandApp.md) is a application instance. It contains of user profile, organizations and context.
+
+---
+
 ### Use organizations
 
 Organization is a top data structure object, which represents a company or some group of people using our services.
@@ -71,11 +86,18 @@ Default organization creation code example:
 
 ```typescript
 // create organization
+// app is an instance of DataIslandApp
+// app.organizations is an instance of Organizations (collection of organizations)
+// return value is an instance of Organization
 const org = await app.organizations.create(
   'your-organization-name',
   '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.
+
+---
 
 ### Use workspaces
 
@@ -85,6 +107,10 @@ Default workspace creation example:
 
 ```typescript
 // create workspace
+// org is an instance of Organization
+// org.workspaces is an instance of Workspaces (collection of workspaces)
+// return value is an instance of Workspace
+//
 // isCreateNewGroup: boolean - "Bool option for new group creation"
 // newGroupName: string - "New group name"
 // groupIds: string[] - "Array of selected accessed groups IDs"
@@ -104,6 +130,11 @@ 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.
+
+2. [Worskpaces](docs/classes/Workspaces.md) is a collection of workspaces.
+
+---
 
 ### Use files
 

package/docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/docs/classes/BasicCredential.md

@@ -0,0 +1,80 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / BasicCredential
+
+# Class: BasicCredential
+
+DataIsland App credential.
+
+## Hierarchy
+
+- [`CredentialBase`](CredentialBase.md)
+
+  ↳ **`BasicCredential`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](BasicCredential.md#constructor)
+
+### Properties
+
+- [email](BasicCredential.md#email)
+- [password](BasicCredential.md#password)
+
+### Methods
+
+- [onRegister](BasicCredential.md#onregister)
+
+## Constructors
+
+### constructor
+
+• **new BasicCredential**(`email`, `password`): [`BasicCredential`](BasicCredential.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `email` | `string` |
+| `password` | `string` |
+
+#### Returns
+
+[`BasicCredential`](BasicCredential.md)
+
+#### Overrides
+
+[CredentialBase](CredentialBase.md).[constructor](CredentialBase.md#constructor)
+
+## Properties
+
+### email
+
+• `Readonly` **email**: `string`
+
+___
+
+### password
+
+• `Readonly` **password**: `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/BearerCredential.md

@@ -0,0 +1,72 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / BearerCredential
+
+# Class: BearerCredential
+
+DataIsland App credential.
+
+## Hierarchy
+
+- [`CredentialBase`](CredentialBase.md)
+
+  ↳ **`BearerCredential`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](BearerCredential.md#constructor)
+
+### Properties
+
+- [token](BearerCredential.md#token)
+
+### Methods
+
+- [onRegister](BearerCredential.md#onregister)
+
+## Constructors
+
+### constructor
+
+• **new BearerCredential**(`token`): [`BearerCredential`](BearerCredential.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `token` | `string` |
+
+#### Returns
+
+[`BearerCredential`](BearerCredential.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/Chat.md

@@ -0,0 +1,69 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / Chat
+
+# Class: Chat
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Chat.md#constructor)
+
+### Accessors
+
+- [id](Chat.md#id)
+- [name](Chat.md#name)
+
+### Methods
+
+- [question](Chat.md#question)
+
+## Constructors
+
+### constructor
+
+• **new Chat**(): [`Chat`](Chat.md)
+
+#### Returns
+
+[`Chat`](Chat.md)
+
+## Accessors
+
+### id
+
+• `get` **id**(): `string`
+
+Chat id.
+
+#### Returns
+
+`string`
+
+___
+
+### name
+
+• `get` **name**(): `string`
+
+Chat name.
+
+#### Returns
+
+`string`
+
+## Methods
+
+### question
+
+▸ **question**(`message`, `answer?`): `Promise`\<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `message` | `string` |
+| `answer?` | [`ChatAnswer`](../enums/ChatAnswer.md) |
+
+#### Returns
+
+`Promise`\<`void`\>

package/docs/classes/Chats.md

@@ -0,0 +1,90 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev7](../../README.md) / [Exports](../modules.md) / Chats
+
+# Class: Chats
+
+Chats storage.
+
+## Hierarchy
+
+- [`EventDispatcher`](EventDispatcher.md)\<[`ChatsEvent`](../enums/ChatsEvent.md), [`Chat`](Chat.md)\>
+
+  ↳ **`Chats`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Chats.md#constructor)
+
+### Methods
+
+- [create](Chats.md#create)
+- [dispatch](Chats.md#dispatch)
+- [subscribe](Chats.md#subscribe)
+
+## Constructors
+
+### constructor
+
+• **new Chats**(): [`Chats`](Chats.md)
+
+#### Returns
+
+[`Chats`](Chats.md)
+
+#### Inherited from
+
+[EventDispatcher](EventDispatcher.md).[constructor](EventDispatcher.md#constructor)
+
+## Methods
+
+### create
+
+▸ **create**(): `Promise`\<[`Chat`](Chat.md)\>
+
+Create new chat.
+
+#### Returns
+
+`Promise`\<[`Chat`](Chat.md)\>
+
+___
+
+### dispatch
+
+▸ **dispatch**(`input`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `input` | [`Input`](../interfaces/Input.md)\<[`ChatsEvent`](../enums/ChatsEvent.md), [`Chat`](Chat.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)\<[`ChatsEvent`](../enums/ChatsEvent.md), [`Chat`](Chat.md)\>) => `void` |
+| `type?` | [`ChatsEvent`](../enums/ChatsEvent.md) |
+
+#### Returns
+
+[`Disposable`](../interfaces/Disposable.md)
+
+#### Inherited from
+
+[EventDispatcher](EventDispatcher.md).[subscribe](EventDispatcher.md#subscribe)

package/docs/classes/CredentialBase.md

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

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`