@neuralinnovations/dataisland-sdk 0.0.1-dev2 → 0.0.1-dev4

package/.editorconfig

@@ -18,5 +18,8 @@ indent_style = space
 indent_size = 2
 ij_javascript_use_semicolon_after_statement = false
 ij_typescript_use_semicolon_after_statement = false
+ij_typescript_use_double_quotes = true
+ij_javascript_use_double_quotes = true
+
 # Not currently supported by vscode, but is supported others, e.g. vim.
-max_line_length = 80
+max_line_length = 80

package/.eslintrc.json

@@ -34,7 +34,7 @@
     ],
     "quotes": [
       "error",
-      "single"
+      "double"
     ],
     "semi": [
       "error",

package/README.md

@@ -1,7 +1,96 @@
 # DataIsland Client SDK
 
-```typescript
+The DataIsland Client SDK is a TypeScript library designed to seamlessly integrate DataIsland web services into websites.
 
+## Table of contents
 
+1. [Connect](#connect)
+2. [Create app](#create-app)
+3. [Use organizations](#use-organizations)
+4. [Use chat](#use-chat)
+5. [Use workspaces](#use-workspaces)
+6. [Use files](#use-files)
+7. [Use access groups](#use-access-groups)
+8. [Use invites](#use-invites)
 
-```
+### Connect
+
+For connecting this library to your website project simply install it using npm package manager.
+
+`npm i @neuralinnovations/dataisland-sdk`
+
+### Create app
+
+You can initialize default app sdk instance using this code example.
+
+```
+const app = await appSdk("your-app-name", async (builder: AppBuilder) => {
+    builder.useHost(HOST)
+    builder.useCredential(new BearerCredential(TOKEN))
+  })
+```
+
+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.
+
+Second required parameter for builder is Credentials. It is recomended to use Bearer credentials instance and pass your user Auth0 **TOKEN** in order to get access to API.
+
+You can also add requests middlewares with builder options.
+
+```
+const app = await appSdk("your-app-name", async (builder: AppBuilder) => {
+      builder.useHost(YOUR_HOST)
+      builder.useAutomaticDataCollectionEnabled(false)
+      builder.useCredential(new BasicCredential("email", "password"))
+      builder.registerMiddleware(async (req, next) => {
+        req.headers.set("Your-header-name", "value")
+        return await next(req)
+      })
+    })
+```
+
+### Use organizations
+
+Organization is a top data structure object, which represents a company or some group of people using our services.
+It contains of users ( admin or regular ), workspaces with files ( folders with access control features ) and chats.
+
+By default all user organizations are fetched with user profile during app sdk start. But if there are no organizations linked to the user, you should run Create organization flow. This flow requires organization name and description data, and also first workspace name and description data provided by user.
+
+**NOTE** There are two types of DataIsland web api servers, public and private. On public servers users can create their own organization after first registration, on private servers you must register using invite links.
+
+Default organization creation code example:
+
+```
+// create organization
+  const org = await app.organizations.create(
+    "your-organization-name",
+    "your-organization-description"
+  )
+```
+
+### Use workspaces
+
+Workspaces are folder-like objects used to store files and controll access to it using acces groups. During creation you must pass organization Id, name and description of new workspace and regulation options. You can pass existing group ID or ask to create new group for this workspace in regulation section. 
+
+Default workspace creation example:
+
+```
+const wsPromise = org.workspaces.create(
+      "your-workspace-name",
+      "your-workspace-description",
+      regulation: {
+        isCreateNewGroup: boolean - "Bool option for new group creation"
+        newGroupName: string - "New group name"
+        groupIds: string[] - "Array of selected accessed groups IDs"
+      }
+    )
+```
+
+### Use files
+
+### Use chat
+
+### Use access groups
+
+### Use Invites

package/jest.config.ts

@@ -3,7 +3,7 @@
  * https://jestjs.io/docs/configuration
  */
 
-import type { Config } from 'jest'
+import type { Config } from "jest"
 
 const config: Config = {
   // All imported modules in your tests should be mocked automatically
@@ -25,7 +25,7 @@ const config: Config = {
   // collectCoverageFrom: undefined,
 
   // The directory where Jest should output its coverage files
-  coverageDirectory: 'coverage',
+  coverageDirectory: "coverage",
 
   // An array of regexp pattern strings used to skip coverage collection
   // coveragePathIgnorePatterns: [
@@ -134,7 +134,7 @@ const config: Config = {
   // runner: "jest-runner",
 
   // The paths to modules that run some code to configure or set up the testing environment before each test
-  setupFiles: ['./jest.setup.ts']
+  setupFiles: ["./jest.setup.ts"]
 
   // A list of paths to modules that run some code to configure or set up the testing framework before each test
   // setupFilesAfterEnv: [],

package/jest.setup.ts

@@ -1,2 +1,2 @@
-import * as dotenv from 'dotenv'
-dotenv.config({ path: '.env.test' })
+import * as dotenv from "dotenv"
+dotenv.config({ path: ".env.test" })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neuralinnovations/dataisland-sdk",
-  "version": "0.0.1-dev2",
+  "version": "0.0.1-dev4",
   "description": "SDK for DataIsland project",
   "licenses": [
     {
@@ -14,7 +14,8 @@
   "scripts": {
     "build": "tsc",
     "test": "jest",
-    "lint": "eslint --ext .ts,.tsx src"
+    "lint": "eslint --ext .ts,.tsx src test",
+    "lint:fix": "eslint --fix --ext .ts,.tsx src test"
   },
   "author": "Neural Innovations LTD",
   "license": "Apache-2.0",

package/src/appBuilder.ts

@@ -1,9 +1,9 @@
-import type { Middleware } from './middleware'
-import type { CredentialBase } from './credentials'
-import type { Service, ServiceContext } from './services/service'
-import type { Constructor } from './internal/registry'
-import { CommandHandler, Command } from './services/commandService'
-import { Context } from './context'
+import type { Middleware } from "./middleware"
+import type { CredentialBase } from "./credentials"
+import type { Service, ServiceContext } from "./services/service"
+import type { Constructor } from "./internal/registry"
+import { CommandHandler, Command } from "./services/commandService"
+import { Context } from "./context"
 
 /**
  * DataIsland App builder.

package/src/appSdk.ts

@@ -1,9 +1,9 @@
-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 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"
 
 /**
  * DataIsland App instance.

package/src/commands/startCommandHandler.ts

@@ -1,5 +1,5 @@
-import { CommandHandler, Command } from '../services/commandService'
-import { UserProfileService } from '../services/userProfileService'
+import { CommandHandler, Command } from "../services/commandService"
+import { UserProfileService } from "../services/userProfileService"
 
 export class StartCommand extends Command {}
 

package/src/context.ts

@@ -1,6 +1,6 @@
-import { type Constructor, type Registry } from './internal/registry'
-import { type Lifetime } from './disposable'
-import { Command, CommandService } from './services/commandService'
+import { type Constructor, type Registry } from "./internal/registry"
+import { type Lifetime } from "./disposable"
+import { Command, CommandService } from "./services/commandService"
 
 /**
  * DataIsland App context.

package/src/credentials.ts

@@ -1,6 +1,6 @@
-import { MiddlewareService } from './services/middlewareService'
-import { type Lifetime } from './disposable'
-import { type Context } from './context'
+import { MiddlewareService } from "./services/middlewareService"
+import { type Lifetime } from "./disposable"
+import { type Context } from "./context"
 
 /**
  * DataIsland App credential.
@@ -29,11 +29,33 @@ export class BasicCredential extends CredentialBase {
   onRegister(lifetime: Lifetime, context: Context): void {
     const service = context.resolve(MiddlewareService)
     if (service === undefined) {
-      throw new Error('MiddlewareService is not registered.')
+      throw new Error("MiddlewareService is not registered.")
     }
     lifetime.add(
       service.useMiddleware(async (req, next) => {
-        req.headers.set('Authorization', `Basic ${this.email}:${this.password}`)
+        req.headers.set("Authorization", `Basic ${this.email}:${this.password}`)
+        return await next(req)
+      })
+    )
+  }
+}
+
+export class DebugCredential extends CredentialBase {
+  readonly token: string
+
+  constructor(token: string) {
+    super()
+    this.token = token
+  }
+
+  onRegister(lifetime: Lifetime, context: Context): void {
+    const service = context.resolve(MiddlewareService)
+    if (service === undefined) {
+      throw new Error("MiddlewareService is not registered.")
+    }
+    lifetime.add(
+      service.useMiddleware(async (req, next) => {
+        req.headers.set("Authorization", `Debug ${this.token}`)
         return await next(req)
       })
     )
@@ -51,11 +73,11 @@ export class BearerCredential extends CredentialBase {
   onRegister(lifetime: Lifetime, context: Context): void {
     const service = context.resolve(MiddlewareService)
     if (service === undefined) {
-      throw new Error('MiddlewareService is not registered.')
+      throw new Error("MiddlewareService is not registered.")
     }
     lifetime.add(
       service.useMiddleware(async (req, next) => {
-        req.headers.set('Authorization', `Bearer ${this.token}`)
+        req.headers.set("Authorization", `Bearer ${this.token}`)
         return await next(req)
       })
     )

package/src/disposable.ts

@@ -9,7 +9,8 @@ export interface Disposable {
  * Represents a lifetime.
  */
 export class Lifetime {
-  constructor(private readonly container: DisposableContainer) {}
+  constructor(private readonly container: DisposableContainer) {
+  }
 
   /**
    * Define a new nested disposable to this lifetime.
@@ -131,7 +132,7 @@ export class DisposableContainer implements Disposable {
    */
   private _throwIfDisposed(): void {
     if (this._isDisposed) {
-      throw new Error('Object disposed')
+      throw new Error("Object disposed")
     }
   }
 }
@@ -147,5 +148,3 @@ export function disposable(action: () => void, target: unknown): Disposable {
     action.call(target)
   })
 }
-
-export const eternalLifetime = new DisposableContainer().lifetime

package/src/dto/accessGroupResponse.ts

@@ -0,0 +1,35 @@
+import { UserDto } from "./userInfoResponse"
+
+
+export interface PermitsDto {
+    isAdmin: boolean;
+}
+
+export interface RegulationDto {
+    isRegulateOrganization: boolean;
+    regulateWorkspaceIds: string[];
+}
+
+export interface AccessGroupDto {
+    id: string;
+    name: string;
+    type: number;
+    createdAt: number;
+    modifiedAt: number;
+    organizationId: string;
+    permits: PermitsDto;
+    regulation: RegulationDto;
+    membersCount: number;
+}
+
+export interface AccessGroupResponse {
+    group: AccessGroupDto;
+    members: UserDto[];
+}
+
+export interface AccessGroupsResponse {
+    groups: AccessGroupDto[];
+}
+
+
+

package/src/dto/chatResponse.ts

@@ -0,0 +1,104 @@
+
+export interface SourceDto {
+    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;
+}
+
+export interface ChatDto {
+    id: string;
+    name: string;
+    createdAt: number;
+    modifiedAt: number;
+    userId: string;
+    organizationId: string;
+    workspaceId: string;
+    answers: AnswerDto[];
+}
+
+export interface ChatListResponse {
+    chats: ChatDto[]
+}
+
+export enum AnswerStatus {
+    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 FetchAnswerResponse {
+    id: string;
+    status: AnswerStatus;
+    steps: AnswerStepDto[];
+}
+
+export interface FetchTokensResponse {
+    id: string;
+    step_id: string;
+    step_status: number;
+    step_tokens: string[];
+}
+
+export interface AnswerSourcesResponse {
+    chat_uid: string;
+    uid: string;
+    step_id: string;
+    sources: SourceDto[];
+}
+
+export enum StepStatus {
+    RUNNING = 0,
+    SUCCESS = 1,
+    FAIL = 2,
+    CANCELED = 3,
+}
+
+export enum StepType {
+    PREPARE = 0,
+    SOURCES = 1,
+    GENERATE_ANSWER = 6,
+    FINALIZE_RESULT = 9,
+    DONE = 10,
+}
+  
+export class StepTypeInfo {
+  public static hasTokens(type: StepType): boolean {
+    switch (type) {
+    case StepType.GENERATE_ANSWER:
+    case StepType.DONE:
+    case StepType.FINALIZE_RESULT:
+      return true
+    }
+    return false
+  }
+
+  public static hasSources(type: StepType): boolean {
+    switch (type) {
+    case StepType.SOURCES:
+      return true
+    }
+    return false
+  }
+}

package/src/dto/userInfoResponse.ts

@@ -1,3 +1,5 @@
+import { WorkspaceDto } from "./workspacesResponse"
+
 export interface UserInfoResponse {
   adminInOrganization: string[]
   organizations: OrganizationDto[]
@@ -10,7 +12,7 @@ export interface UserDto {
   created_at: number
   modified_at: number
   profile: ProfileDto
-  settings: UserSettings
+  settings?: UserSettings | null
 }
 
 export interface ProfileDto {
@@ -35,3 +37,11 @@ export interface OrganizationDto {
   membersCount: number
   profile: OrganizationProfileDto
 }
+
+export interface OrganizationWorkspaces extends OrganizationDto {
+  workspaces: WorkspaceDto[]
+}
+
+export interface MembersResponse {
+  members: UserDto
+}

package/src/dto/workspacesResponse.ts

@@ -0,0 +1,49 @@
+import { WorkspaceId } from "../storages/workspaces"
+import { FileId } from "../storages/file"
+
+export interface WorkspaceProfileDto {
+  name: string
+  description: string
+}
+
+export interface WorkspaceDto {
+  id: WorkspaceId
+  createdAt: number
+  modifiedAt: number
+  profile: WorkspaceProfileDto
+}
+
+export interface WorkspacesResponse {
+  workspaces: WorkspaceDto[]
+}
+
+export interface FileUrlDto {
+  url: string
+}
+
+export interface FileProgressDto {
+  file_id: FileId
+  file_parts_count: number
+  completed_parts_count: number
+  success: boolean
+  error?: string
+}
+
+export interface FileDto {
+  id: string
+  createdAt: number
+  modifiedAt: number
+  name: string
+  description: string
+  url: string
+  hash: string
+  organizationId: string
+  workspaceId: string
+  isProcessedSuccessfully: boolean
+}
+
+export interface FileListResponse {
+  files: FileDto[]
+  totalFilesCount: number
+  filesPerPage: number
+}

package/src/events.ts

@@ -1,25 +1,25 @@
-import { type Disposable, DisposableContainer } from './disposable'
+import { type Disposable, DisposableContainer } from "./disposable"
 
-export interface Input<ET, DT> {
-  type?: ET
-  data: DT
+export interface Input<EventType, DataType> {
+  type?: EventType
+  data: DataType
 }
 
-export interface Event<ET, DT> extends Input<ET, DT> {
+export interface Event<EventType, DataType> extends Input<EventType, DataType> {
   unsubscribe: () => void
 }
 
-export interface EventSubscriber<ET, DT> {
-  subscribe: (callback: (event: Event<ET, DT>) => void, type?: ET) => Disposable
+export interface EventSubscriber<EventType, DataType> {
+  subscribe: (callback: (event: Event<EventType, DataType>) => void, type?: EventType) => Disposable
 }
 
-export class EventDispatcher<ET, DT> implements EventSubscriber<ET, DT> {
+export class EventDispatcher<EventType, DataType> implements EventSubscriber<EventType, DataType> {
   private _listeners: Array<{
-    callback: (value: Event<ET, DT>) => void
+    callback: (value: Event<EventType, DataType>) => void
     disposable: Disposable
   }> = []
 
-  dispatch(input: Input<ET, DT>): void {
+  dispatch(input: Input<EventType, DataType>): void {
     this._listeners.slice().forEach(it => {
       const value = {
         type: input.type,
@@ -27,16 +27,16 @@ export class EventDispatcher<ET, DT> implements EventSubscriber<ET, DT> {
         unsubscribe: () => {
           it.disposable.dispose()
         }
-      } satisfies Event<ET, DT>
+      } satisfies Event<EventType, DataType>
       it.callback(value)
     })
   }
 
-  subscribe(callback: (event: Event<ET, DT>) => void, type?: ET): Disposable {
+  subscribe(callback: (event: Event<EventType, DataType>) => void, type?: EventType): Disposable {
     const container = new DisposableContainer()
     if (type !== undefined) {
       const cb = callback
-      const listener = (evt: Event<ET, DT>): void => {
+      const listener = (evt: Event<EventType, DataType>): void => {
         if (evt.type === type) {
           cb(evt)
         }

package/src/index.ts

@@ -1,14 +1,23 @@
-import { version } from '../package.json'
-import { _createApp } from './internal/createApp.impl'
-import { type AppBuilder } from './appBuilder'
-import { type AppSdk } from './appSdk'
+import { version } from "../package.json"
+import { _createApp } from "./internal/createApp.impl"
+import { type AppBuilder } from "./appBuilder"
+import { type AppSdk } from "./appSdk"
 
-export * from './events'
-export * from './types'
-export * from './disposable'
-export * from './types'
-export * from './credentials'
-export * from './appSdk'
+export * from "./events"
+export * from "./disposable"
+export * from "./credentials"
+export * from "./appSdk"
+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"
 
 const _appsNotReady = new Map<string, Promise<AppSdk>>()
 const _appsReady = new Map<string, AppSdk>()
@@ -21,12 +30,12 @@ export const SDK_VERSION = version
 /**
  * Default DataIsland App name.
  */
-export const DEFAULT_NAME = '[DEFAULT]'
+export const DEFAULT_NAME = "[DEFAULT]"
 
 /**
  * Default DataIsland App host.
  */
-export const DEFAULT_HOST = 'https://api.dataisland.com.ua'
+export const DEFAULT_HOST = "https://api.dataisland.com.ua"
 
 export function sdks(): AppSdk[] {
   return Array.from(_appsReady.values())
@@ -75,3 +84,6 @@ export async function appSdk(
   }
   return await appPromise
 }
+
+export { File } from "./storages/file"
+export { FilesPage } from "./storages/filesPage"