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

package/docs/enums/ChatAnswerType.md

@@ -0,0 +1,22 @@
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / ChatAnswerType
+
+# Enumeration: ChatAnswerType
+
+## Table of contents
+
+### Enumeration Members
+
+- [LONG](ChatAnswerType.md#long)
+- [SHORT](ChatAnswerType.md#short)
+
+## Enumeration Members
+
+### LONG
+
+• **LONG** = ``"long"``
+
+___
+
+### SHORT
+
+• **SHORT** = ``"short"``

package/docs/enums/ChatsEvent.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / ChatsEvent
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / ChatsEvent
 
 # Enumeration: ChatsEvent
 

package/docs/enums/FilesEvent.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / FilesEvent
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / FilesEvent
 
 # Enumeration: FilesEvent
 

package/docs/enums/GroupEvent.md

@@ -1,7 +1,9 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / GroupEvent
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / GroupEvent
 
 # Enumeration: GroupEvent
 
+Group event.
+
 ## Table of contents
 
 ### Enumeration Members

package/docs/enums/OrganizationsEvent.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / OrganizationsEvent
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / OrganizationsEvent
 
 # Enumeration: OrganizationsEvent
 

package/docs/enums/UserEvent.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / UserEvent
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / UserEvent
 
 # Enumeration: UserEvent
 

package/docs/enums/WorkspaceEvent.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / WorkspaceEvent
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / WorkspaceEvent
 
 # Enumeration: WorkspaceEvent
 

package/docs/enums/WorkspacesEvent.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / WorkspacesEvent
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / WorkspacesEvent
 
 # Enumeration: WorkspacesEvent
 

package/docs/interfaces/Disposable.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Disposable
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / Disposable
 
 # Interface: Disposable
 

package/docs/interfaces/Event.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Event
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / Event
 
 # Interface: Event\<EventType, DataType\>
 

package/docs/interfaces/EventSubscriber.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / EventSubscriber
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / EventSubscriber
 
 # Interface: EventSubscriber\<EventType, DataType\>
 

package/docs/interfaces/Input.md

@@ -1,4 +1,4 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../../README.md) / [Exports](../modules.md) / Input
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../../README.md) / [Exports](../modules.md) / Input
 
 # Interface: Input\<EventType, DataType\>
 

package/docs/modules.md

@@ -1,12 +1,12 @@
-[@neuralinnovations/dataisland-sdk - v0.0.1-dev8](../README.md) / Exports
+[@neuralinnovations/dataisland-sdk - v0.0.1-dev9](../README.md) / Exports
 
-# @neuralinnovations/dataisland-sdk - v0.0.1-dev8
+# @neuralinnovations/dataisland-sdk - v0.0.1-dev9
 
 ## Table of contents
 
 ### Enumerations
 
-- [ChatAnswer](enums/ChatAnswer.md)
+- [ChatAnswerType](enums/ChatAnswerType.md)
 - [ChatsEvent](enums/ChatsEvent.md)
 - [FilesEvent](enums/FilesEvent.md)
 - [GroupEvent](enums/GroupEvent.md)
@@ -86,6 +86,8 @@ ___
 
 Ƭ **GroupId**: `string`
 
+Group id.
+
 ___
 
 ### OrganizationId

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neuralinnovations/dataisland-sdk",
-  "version": "0.0.1-dev8",
+  "version": "0.0.1-dev9",
   "description": "SDK for DataIsland project",
   "licenses": [
     {
@@ -8,12 +8,16 @@
       "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
     }
   ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/NeuralInnovations/dataisland-client-js-sdk.git"
+  },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
     "build": "tsc",
-    "test": "jest",
+    "test": "jest --runInBand",
     "lint": "eslint --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"

package/src/dataIslandApp.ts

@@ -2,8 +2,8 @@ import type { Lifetime } from "./disposable"
 import type { CredentialBase } from "./credentials"
 import { Context } from "./context"
 import type { Constructor } from "./internal/registry"
-import { Organizations } from "./storages/organizations"
-import { UserProfile } from "./storages/userProfile"
+import { Organizations } from "./storages/organizations/organizations"
+import { UserProfile } from "./storages/user/userProfile"
 
 /**
  * DataIsland App instance.

package/src/dto/chatResponse.ts

@@ -1,88 +1,87 @@
-
 export interface SourceDto {
-    id: string;
-    name: string;
-    url: string;
-    content: string;
-    page: number;
+  id: string;
+  name: string;
+  url: string;
+  content: string;
+  page: number;
 }
 
 export interface AnswerDto {
-    id: string;
-    chatId: string;
-    question: string;
-    context: string;
-    sources: SourceDto[];
-    timestamp: number;
+  id: string;
+  chatId: string;
+  question: string;
+  context: string;
+  sources: SourceDto[];
+  timestamp: number;
 }
 
 export interface ChatDto {
-    id: string;
-    name: string;
-    createdAt: number;
-    modifiedAt: number;
-    userId: string;
-    organizationId: string;
-    workspaceId: string;
-    answers: AnswerDto[];
+  id: string;
+  name: string;
+  createdAt: number;
+  modifiedAt: number;
+  userId: string;
+  organizationId: string;
+  workspaceId: string;
+  answers: AnswerDto[];
 }
 
 export interface ChatListResponse {
-    chats: ChatDto[]
+  chats: ChatDto[]
 }
 
 export enum AnswerStatus {
-    RUNNING = 0,
-    SUCCESS = 1,
-    CANCELED = 2,
-    FAIL = 3,
+  RUNNING = 0,
+  SUCCESS = 1,
+  CANCELED = 2,
+  FAIL = 3,
 }
 
-export interface AnswerStepDto{
-    id: string;
-    type: StepType;
-    status: StepStatus;
-    start_at: string;
-    end_at: string;
-    tokens: string[];
-    sources: SourceDto[];
+export interface AnswerStepDto {
+  id: string;
+  type: StepType;
+  status: StepStatus;
+  start_at: string;
+  end_at: string;
+  tokens: string[];
+  sources: SourceDto[];
 }
 
 export interface FetchAnswerResponse {
-    id: string;
-    status: AnswerStatus;
-    steps: AnswerStepDto[];
+  id: string;
+  status: AnswerStatus;
+  steps: AnswerStepDto[];
 }
 
 export interface FetchTokensResponse {
-    id: string;
-    step_id: string;
-    step_status: number;
-    step_tokens: string[];
+  id: string;
+  step_id: string;
+  step_status: number;
+  step_tokens: string[];
 }
 
 export interface AnswerSourcesResponse {
-    chat_uid: string;
-    uid: string;
-    step_id: string;
-    sources: SourceDto[];
+  chat_uid: string;
+  uid: string;
+  step_id: string;
+  sources: SourceDto[];
 }
 
 export enum StepStatus {
-    RUNNING = 0,
-    SUCCESS = 1,
-    FAIL = 2,
-    CANCELED = 3,
+  RUNNING = 0,
+  SUCCESS = 1,
+  FAIL = 2,
+  CANCELED = 3,
 }
 
 export enum StepType {
-    PREPARE = 0,
-    SOURCES = 1,
-    GENERATE_ANSWER = 6,
-    FINALIZE_RESULT = 9,
-    DONE = 10,
+  PREPARE = 0,
+  SOURCES = 1,
+  GENERATE_ANSWER = 6,
+  FINALIZE_RESULT = 9,
+  DONE = 10,
 }
-  
+
 export class StepTypeInfo {
   public static hasTokens(type: StepType): boolean {
     switch (type) {
@@ -101,4 +100,4 @@ export class StepTypeInfo {
     }
     return false
   }
-}
+}

package/src/dto/workspacesResponse.ts

@@ -1,5 +1,5 @@
-import { WorkspaceId } from "../storages/workspaces"
-import { FileId } from "../storages/file"
+import { WorkspaceId } from "../storages/workspaces/workspaces"
+import { FileId } from "../storages/files/file"
 
 export interface WorkspaceProfileDto {
   name: string

package/src/index.ts

@@ -7,17 +7,17 @@ export * from "./events"
 export * from "./disposable"
 export * from "./credentials"
 export * from "./dataIslandApp"
-export * from "./storages/organizations"
-export * from "./storages/organization"
-export * from "./storages/workspaces"
-export * from "./storages/workspace"
-export * from "./storages/groups"
-export * from "./storages/userProfile"
-export * from "./storages/files"
-export * from "./storages/file"
-export * from "./storages/filesPage"
-export * from "./storages/chats"
-export * from "./storages/chat"
+export * from "./storages/organizations/organizations"
+export * from "./storages/organizations/organization"
+export * from "./storages/workspaces/workspaces"
+export * from "./storages/workspaces/workspace"
+export * from "./storages/groups/groups"
+export * from "./storages/user/userProfile"
+export * from "./storages/files/files"
+export * from "./storages/files/file"
+export * from "./storages/files/filesPage"
+export * from "./storages/chats/chats"
+export * from "./storages/chats/chat"
 
 const _appsNotReady = new Map<string, Promise<DataIslandApp>>()
 const _appsReady = new Map<string, DataIslandApp>()
@@ -88,5 +88,5 @@ export async function dataIslandApp(
   return await appPromise
 }
 
-export { File } from "./storages/file"
-export { FilesPage } from "./storages/filesPage"
+export { File } from "./storages/files/file"
+export { FilesPage } from "./storages/files/filesPage"

package/src/internal/app.impl.ts

@@ -17,8 +17,8 @@ import {
 } from "../commands/startCommandHandler"
 import { UserProfileService } from "../services/userProfileService"
 import { OrganizationService } from "../services/organizationService"
-import { Organizations } from "../storages/organizations"
-import { UserProfile } from "../storages/userProfile"
+import { Organizations } from "../storages/organizations/organizations"
+import { UserProfile } from "../storages/user/userProfile"
 import { isUnitTest, UnitTest } from "../unitTest"
 
 export class DataIslandAppImpl extends DataIslandApp {

package/src/services/organizationService.ts

@@ -1,7 +1,7 @@
 import { Service } from "./service"
-import { Organizations } from "../storages/organizations"
+import { Organizations } from "../storages/organizations/organizations"
 import { OrganizationDto, UserSettings } from "../dto/userInfoResponse"
-import { OrganizationsImpl } from "../storages/organizations.impl"
+import { OrganizationsImpl } from "../storages/organizations/organizations.impl"
 
 export class OrganizationService extends Service {
   private _impl?: OrganizationsImpl

package/src/services/userProfileService.ts

@@ -1,9 +1,9 @@
 import { Service } from "./service"
 import { RpcService } from "./rpcService"
-import { UserProfile } from "../storages/userProfile"
+import { UserProfile } from "../storages/user/userProfile"
 import { UserInfoResponse } from "../dto/userInfoResponse"
 import { OrganizationService } from "./organizationService"
-import { UserProfileImpl } from "../storages/userProfile.impl"
+import { UserProfileImpl } from "../storages/user/userProfile.impl"
 import { ResponseUtils } from "./responseUtils"
 
 export class UserProfileService extends Service {

package/src/storages/chats/answer.impl.ts

@@ -0,0 +1,163 @@
+import { Context } from "../../context"
+import {
+  AnswerDto,
+  AnswerStatus,
+  AnswerStepDto,
+  FetchAnswerResponse,
+  FetchTokensResponse,
+  SourceDto,
+  StepType
+} from "../../dto/chatResponse"
+import { ResponseUtils } from "../../services/responseUtils"
+import { RpcService } from "../../services/rpcService"
+import { Answer, AnswerId } from "./answer"
+import { Chat } from "./chat"
+
+export class AnswerImpl extends Answer {
+  private _content?: AnswerDto
+
+  private _steps?: AnswerStepDto[]
+  private _status?: AnswerStatus
+  private _id?: AnswerId
+
+  constructor(
+    private readonly chat: Chat,
+    private readonly context: Context) {
+    super()
+  }
+
+  async initFromData(answer: AnswerDto): Promise<AnswerImpl> {
+    this._content = answer
+    this._id = answer.id
+
+    // fetch answer
+    await this.fetch()
+
+    return this
+  }
+
+  async initFromId(id: AnswerId): Promise<AnswerImpl> {
+    this._id = id
+
+    // fetch answer
+    await this.fetch()
+
+    return this
+  }
+
+  get id(): string {
+    return <string>this._id
+  }
+
+  get status(): AnswerStatus {
+    return <AnswerStatus>this._status
+  }
+
+  private getStep(type: StepType): AnswerStepDto | undefined {
+    return this._steps?.find(step => step.type === type)
+  }
+
+  async sources(type: StepType): Promise<SourceDto[]> {
+    // fetch answer
+    await this.fetch()
+    // get step
+    const step = this.getStep(type)
+
+    // check step
+    if (!step) {
+      throw new Error(`Step with type ${type.toString()} is not found, answer: ${this.id}, organization: ${this.chat.organization.id}`)
+    }
+
+    // get sources
+    const response = await this.context
+      .resolve(RpcService)
+      ?.requestBuilder("api/v1/Chats/answer/sources")
+      .searchParam("chat_uid", this.chat.id)
+      .searchParam("uid", this.id)
+      .searchParam("step_id", step.id)
+      .sendGet()
+
+    // check response status
+    if (ResponseUtils.isFail(response)) {
+      await ResponseUtils.throwError(`Failed to get sources for ${type.toString()}, answer: ${this.id}, organization: ${this.chat.organization.id}`, response)
+    }
+
+    // parse sources from the server's response
+    const sources = (await response!.json()).sources as SourceDto[]
+
+    return sources
+  }
+
+  async fetch(): Promise<void> {
+    // fetch answer from position 0
+    const position = 0
+    // fetch answer
+    const response = await this.context
+      .resolve(RpcService)
+      ?.requestBuilder("api/v1/Chats/answer/fetch")
+      .searchParam("chatId", this.chat.id)
+      .searchParam("questionId", this.id)
+      .searchParam("position", position.toString())
+      .sendGet()
+
+    // check response status
+    if (ResponseUtils.isFail(response)) {
+      await ResponseUtils.throwError(`Failed to fetch answer ${this.id}`, response)
+    }
+
+    // parse answer from the server's response
+    const answer = (await response!.json()) as FetchAnswerResponse
+
+    // update answer
+    this._status = <AnswerStatus>answer.status
+    this._steps = <AnswerStepDto[]>answer.steps
+  }
+
+  async fetchTokens(type: StepType, token_start_at: number): Promise<FetchTokensResponse> {
+    // fetch answer
+    await this.fetch()
+    // get step
+    const step = this.getStep(type)
+
+    // check step
+    if (!step) {
+      throw new Error(`Step with type ${type.toString()} is not found`)
+    }
+
+    // get tokens
+    const response = await this.context
+      .resolve(RpcService)
+      ?.requestBuilder("api/v1/Chats/answer/fetch/tokens")
+      .searchParam("chat_uid", this.chat.id)
+      .searchParam("uid", this.id)
+      .searchParam("step_id", step.id)
+      .searchParam("token_start_at", token_start_at.toString())
+      .sendGet()
+
+    // check response status
+    if (ResponseUtils.isFail(response)) {
+      await ResponseUtils.throwError(`Failed to get sources for ${type.toString()}`, response)
+    }
+
+    // parse tokens from the server's response
+    const tokens = (await response!.json()) as FetchTokensResponse
+
+    return tokens
+  }
+
+  async cancel(): Promise<void> {
+    // send request to the server
+    const response = await this.context
+      .resolve(RpcService)
+      ?.requestBuilder("api/v1/Chats/answer/cancel")
+      .sendPutJson({
+        chat_id: this.chat.id,
+        uid: this.id
+      })
+
+    // check response status
+    if (ResponseUtils.isFail(response)) {
+      await ResponseUtils.throwError("Failed to cancel a question", response)
+    }
+  }
+}

package/src/storages/chats/answer.ts

@@ -0,0 +1,42 @@
+import {
+  AnswerStatus,
+  FetchTokensResponse,
+  SourceDto,
+  StepType
+} from "../../dto/chatResponse"
+
+export type AnswerId = string
+export type StepId = string
+
+export abstract class Answer {
+
+  /**
+   * Answer id.
+   */
+  abstract get id(): AnswerId
+
+  /**
+   * Answer status.
+   */
+  abstract get status(): AnswerStatus
+
+  /**
+   * Answer sources.
+   */
+  abstract sources(type: StepType): Promise<SourceDto[]>
+
+  /**
+   * Fetch answer.
+   */
+  abstract fetch(): Promise<void>
+
+  /**
+   * Fetch answer.
+   */
+  abstract fetchTokens(type: StepType, tokenStartAt: number): Promise<FetchTokensResponse>
+
+  /**
+   * Cancel answer
+   */
+  abstract cancel(): Promise<void>
+}