@neuralinnovations/dataisland-sdk 0.0.1-dev1 → 0.0.1-dev3

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/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
@@ -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: [],
+  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: [],
@@ -194,6 +194,6 @@ const config: Config = {
 
   // Whether to use watchman for file crawling
   // watchman: true,
-};
+}
 
-export default config;
+export default config

package/jest.setup.ts

@@ -0,0 +1,2 @@
+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-dev1",
+  "version": "0.0.1-dev3",
   "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",
@@ -55,6 +56,7 @@
     "yargs": "17.7.2"
   },
   "dependencies": {
+    "dotenv": "^16.3.2",
     "jsdom": "^23.2.0"
   }
 }

package/src/appBuilder.ts

@@ -1,16 +1,23 @@
-import type { Middleware } from './middleware'
-import type { CredentialBase } from './credentials'
-import type { Service, ServiceContext } from './services/service'
-import type { Constructor } from './internal/registry'
+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.
  */
 export abstract class AppBuilder {
+  /**
+   * Set custom data.
+   */
+  abstract get env(): Record<string, any>
+
   /**
    * Add a middleware to the app.
    */
-  abstract addMiddleware(middleware: Middleware): AppBuilder
+  abstract registerMiddleware(middleware: Middleware): AppBuilder
 
   /**
    * Host of the app.
@@ -36,4 +43,16 @@ export abstract class AppBuilder {
     type: Constructor<T>,
     factory: (context: ServiceContext) => T
   ): AppBuilder
+
+  /**
+   * Register a command to the app.
+   * @param messageType
+   * @param commandFactory
+   */
+  abstract registerCommand<T extends Command>(
+    messageType: Constructor<T>,
+    commandFactory:
+      | ((context: Context) => CommandHandler<T>)
+      | ((context: Context) => (context: Context) => Promise<void>)
+  ): AppBuilder
 }

package/src/appSdk.ts

@@ -1,40 +1,59 @@
-import type { Lifetime } from './disposable'
-import type { CredentialBase } from './credentials'
-import type { Constructor } from './internal/registry'
+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.
  */
-export interface AppSdk {
+export abstract class AppSdk {
   /**
    * The name of this app.
    */
-  get name(): string
+  abstract get name(): string
 
   /**
    * The host of this app.
    */
-  get host(): string
+  abstract get host(): string
 
   /**
    * The automaticDataCollectionEnabled of this app.
    */
-  get automaticDataCollectionEnabled(): boolean
+  abstract get automaticDataCollectionEnabled(): boolean
 
   /**
    * The lifetime of this app.
    */
-  get lifetime(): Lifetime
+  abstract get lifetime(): Lifetime
 
   /**
    * The credential of this app.
    */
-  get credential(): CredentialBase | undefined
+  abstract get credential(): CredentialBase | undefined
 
-  set credential(value: CredentialBase)
+  abstract set credential(value: CredentialBase)
 
   /**
-   * Gets the service registered with the given type.
+   * The context of this app.
    */
-  resolve: <T>(type: Constructor<T>) => T | undefined
+  abstract get context(): Context
+
+  /**
+   * User's organizations.
+   */
+  abstract get organizations(): Organizations
+
+  /**
+   * User's profile.
+   */
+  abstract get userProfile(): UserProfile
+
+  /**
+   * Resolve a service from the app.
+   * @param type
+   */
+  abstract resolve<T>(type: Constructor<T>): T | undefined
 }

package/src/commands/startCommandHandler.ts

@@ -0,0 +1,14 @@
+import { CommandHandler, Command } from "../services/commandService"
+import { UserProfileService } from "../services/userProfileService"
+
+export class StartCommand extends Command {}
+
+export class StartCommandHandler extends CommandHandler<StartCommand> {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  async execute(message: StartCommand): Promise<void> {
+    const service = this.context.resolve(
+      UserProfileService
+    ) as UserProfileService
+    await service.fetch()
+  }
+}

package/src/context.ts

@@ -0,0 +1,31 @@
+import { type Constructor, type Registry } from "./internal/registry"
+import { type Lifetime } from "./disposable"
+import { Command, CommandService } from "./services/commandService"
+
+/**
+ * DataIsland App context.
+ */
+export class Context {
+  constructor(
+    private readonly registry: Registry,
+    public readonly lifetime: Lifetime,
+    public readonly appName: string
+  ) {}
+
+  /**
+   * Resolve a service from the context.
+   * @param type of the service
+   */
+  resolve<T>(type: Constructor<T>): T | undefined {
+    return this.registry.get(type)
+  }
+
+  /**
+   * Execute a command.
+   * @param command to execute
+   */
+  async execute<T extends Command>(command: T): Promise<void> {
+    const service = this.resolve(CommandService) as CommandService
+    await service.execute(command)
+  }
+}

package/src/credentials.ts

@@ -1,6 +1,6 @@
-import { MiddlewareService } from './services/middlewareService'
-import { type Lifetime } from './disposable'
-import { type Context } from './internal/context'
+import { MiddlewareService } from "./services/middlewareService"
+import { type Lifetime } from "./disposable"
+import { type Context } from "./context"
 
 /**
  * DataIsland App credential.
@@ -29,12 +29,34 @@ 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}`)
-        await next(req)
+        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,12 +73,12 @@ 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}`)
-        await next(req)
+        req.headers.set("Authorization", `Bearer ${this.token}`)
+        return await next(req)
       })
     )
   }

package/src/disposable.ts

@@ -2,7 +2,7 @@
  * Represents an object that can be disposed.
  */
 export interface Disposable {
-  dispose: () => void
+  dispose(): void
 }
 
 /**
@@ -131,7 +131,7 @@ export class DisposableContainer implements Disposable {
    */
   private _throwIfDisposed(): void {
     if (this._isDisposed) {
-      throw new Error('Object disposed')
+      throw new Error("Object disposed")
     }
   }
 }

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

@@ -0,0 +1,47 @@
+import { WorkspaceDto } from "./workspacesResponse"
+
+export interface UserInfoResponse {
+  adminInOrganization: string[]
+  organizations: OrganizationDto[]
+  user: UserDto
+}
+
+export interface UserDto {
+  id: string
+  isDeleted: boolean
+  created_at: number
+  modified_at: number
+  profile: ProfileDto
+  settings?: UserSettings | null
+}
+
+export interface ProfileDto {
+  name: string
+  email: string
+}
+
+export interface UserSettings {
+  activeOrganizationId: string
+  activeWorkspaceId: string
+}
+
+export interface OrganizationProfileDto {
+  name: string
+  description: string
+}
+
+export interface OrganizationDto {
+  id: string
+  createdAt: number
+  modifiedAt: number
+  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/files"
+
+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,8 +1,4 @@
-import { type Disposable, DisposableContainer } from './disposable'
-
-export interface Events<TE, TD> {
-  get events(): EventDispatcher<TE, TD>
-}
+import { type Disposable, DisposableContainer } from "./disposable"
 
 export interface Input<ET, DT> {
   type?: ET

package/src/index.ts

@@ -1,13 +1,12 @@
-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 "./events"
+export * from "./disposable"
+export * from "./credentials"
+export * from "./appSdk"
 
 const _appsNotReady = new Map<string, Promise<AppSdk>>()
 const _appsReady = new Map<string, AppSdk>()
@@ -20,12 +19,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://dataisland.com.ua'
+export const DEFAULT_HOST = "https://api.dataisland.com.ua"
 
 export function sdks(): AppSdk[] {
   return Array.from(_appsReady.values())
@@ -62,8 +61,15 @@ export async function appSdk(
       })
       .catch(reason => {
         console.error(`Error: ${reason}`)
+        _appsNotReady.delete(name ?? DEFAULT_NAME)
       })
     _appsNotReady.set(name, appPromise)
+  } else {
+    if (setup !== undefined) {
+      throw new Error(
+        `App ${name} is initializing. You can't setup the same again.`
+      )
+    }
   }
   return await appPromise
 }