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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neuralinnovations/dataisland-sdk",
-  "version": "0.0.1-dev4",
+  "version": "0.0.1-dev40",
   "description": "SDK for DataIsland project",
   "licenses": [
     {
@@ -8,17 +8,54 @@
       "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
     }
   ],
-  "publishConfig": {
-    "access": "public"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/NeuralInnovations/dataisland-client-js-sdk.git"
   },
   "scripts": {
     "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",
+    "version-up-dev": "node scripts/version/up-dev.js && rm package-lock.json && npm install && npm run build && npm run lint:fix && npm run docs",
+    "release": "rm package-lock.json && npm install && npm run build && npm run lint:fix && npm run docs"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": "./dist/index.js"
   },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "browser": "dist/index.js",
+  "directories": {
+    "test": "test"
+  },
+  "files": [
+    "dist",
+    "src",
+    "index.js",
+    "index.d.ts"
+  ],
+  "engines": {
+    "node": ">=16"
+  },
+  "keywords": [
+    "dataisland",
+    "sdk",
+    "neuralinnovations",
+    "neural innovations",
+    "neural-innovations",
+    "neural"
+  ],
   "author": "Neural Innovations LTD",
   "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/NeuralInnovations/dataisland-client-js-sdk/issues"
+  },
+  "homepage": "https://github.com/NeuralInnovations/dataisland-client-js-sdk#readme",
   "devDependencies": {
     "@babel/core": "^7.22.11",
     "@babel/plugin-transform-modules-commonjs": "7.22.11",
@@ -27,6 +64,8 @@
     "@babel/register": "7.22.5",
     "@jest/globals": "^29.7.0",
     "@types/jest": "^29.5.11",
+    "@types/node": "^20.11.27",
+    "@types/node-fetch": "^2.6.11",
     "@typescript-eslint/eslint-plugin": "^6.19.0",
     "@typescript-eslint/parser": "^6.19.0",
     "babel-jest": "^29.7.0",
@@ -43,6 +82,7 @@
     "eslint-plugin-react": "^7.33.2",
     "glob": "7.2.3",
     "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
     "prettier": "2.8.7",
     "ts-jest": "^29.1.1",
     "ts-loader": "8.4.0",
@@ -50,6 +90,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",
@@ -59,4 +100,4 @@
     "dotenv": "^16.3.2",
     "jsdom": "^23.2.0"
   }
-}
+}

package/src/commands/deleteUserFullCommandHandler.ts

@@ -0,0 +1,19 @@
+import { Command, CommandHandler } from "../services/commandService"
+import { RpcService } from "../services/rpcService"
+import { ResponseUtils } from "../services/responseUtils"
+
+export class DeleteUserFullCommand extends Command {
+
+}
+
+export class DeleteUserFullCommandHandler extends CommandHandler<DeleteUserFullCommand> {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  async execute(message: DeleteUserFullCommand): Promise<void> {
+    const response = await this.resolve(RpcService)?.requestBuilder("/api/v1/Users/self/full")
+      .sendDelete()
+
+    if (ResponseUtils.isFail(response)) {
+      await ResponseUtils.throwError("Failed to delete user", response)
+    }
+  }
+}

package/src/commands/startCommandHandler.ts

@@ -1,14 +1,25 @@
 import { CommandHandler, Command } from "../services/commandService"
 import { UserProfileService } from "../services/userProfileService"
+import { CookieService } from "../services/cookieService"
+import { AnonymousCredential } from "../credentials"
 
-export class StartCommand extends Command {}
+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()
+    const userService = this.resolve(UserProfileService)!
+
+    // Merge anonymous user if needed
+    if (!(this.context.app.credential instanceof AnonymousCredential)) {
+      const cookie = this.resolve(CookieService)!
+      if (cookie.anonymousTokenIsValid) {
+        await userService.merge(cookie.anonymousToken!)
+        cookie.anonymousToken = undefined
+      }
+    }
+
+    await userService.fetch()
   }
 }

package/src/context.ts

@@ -1,6 +1,7 @@
 import { type Constructor, type Registry } from "./internal/registry"
 import { type Lifetime } from "./disposable"
 import { Command, CommandService } from "./services/commandService"
+import { DataIslandApp } from "./dataIslandApp"
 
 /**
  * DataIsland App context.
@@ -9,8 +10,9 @@ export class Context {
   constructor(
     private readonly registry: Registry,
     public readonly lifetime: Lifetime,
-    public readonly appName: string
-  ) {}
+    public readonly app: DataIslandApp
+  ) {
+  }
 
   /**
    * Resolve a service from the context.

package/src/credentials.ts

@@ -83,3 +83,25 @@ export class BearerCredential extends CredentialBase {
     )
   }
 }
+
+export class AnonymousCredential 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", `InternalJWT ${this.token}`)
+        return await next(req)
+      })
+    )
+  }
+}

package/src/{appSdk.ts → dataIslandApp.ts}

@@ -2,13 +2,13 @@ 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.
  */
-export abstract class AppSdk {
+export abstract class DataIslandApp {
   /**
    * The name of this app.
    */

package/src/disposable.ts

@@ -77,7 +77,8 @@ export class DisposableContainer implements Disposable {
    * @returns The disposable container.
    */
   public add(disposable: Disposable): Disposable {
-    this._throwIfDisposed()
+    this._throwIfDisposed("Cannot add disposable to disposed container.")
+
     this._disposables.push(disposable)
     return disposable
   }
@@ -89,7 +90,8 @@ export class DisposableContainer implements Disposable {
    * @returns The disposable container.
    */
   public addCallback(callback: () => void, target?: unknown): Disposable {
-    this._throwIfDisposed()
+    this._throwIfDisposed("Cannot add callback to disposed container.")
+
     return this.add({
       dispose() {
         callback.call(target)
@@ -101,6 +103,8 @@ export class DisposableContainer implements Disposable {
    * Defines a nested disposable container.
    */
   defineNested(): DisposableContainer {
+    this._throwIfDisposed("Cannot define nested disposable for disposed container.")
+
     const nested = new DisposableContainer()
     this._disposables.push(nested)
     nested.addCallback(() => {
@@ -116,23 +120,32 @@ export class DisposableContainer implements Disposable {
    * Disposes all disposables in this container. Last added, first disposed.
    */
   public dispose(): void {
-    this._throwIfDisposed()
+    // return if already disposed
+    if (this._isDisposed) {
+      return
+    }
+
+    // mark as disposed
     this._isDisposed = true
+
+    // dispose all disposables
     this._disposables
       .slice()
       .reverse()
       .forEach(it => {
         it.dispose()
       })
+
+    // clear disposables
     this._disposables = []
   }
 
   /**
    * Throws an error if this container is disposed.
    */
-  private _throwIfDisposed(): void {
+  private _throwIfDisposed(message: string): void {
     if (this._isDisposed) {
-      throw new Error("Object disposed")
+      throw new Error("Object disposed, but you try to use it: " + message)
     }
   }
 }

package/src/dto/accessGroupResponse.ts

@@ -1,34 +1,37 @@
 import { UserDto } from "./userInfoResponse"
 
-
 export interface PermitsDto {
-    isAdmin: boolean;
+  isAdmin: boolean;
 }
 
 export interface RegulationDto {
-    isRegulateOrganization: boolean;
-    regulateWorkspaceIds: string[];
+  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;
+  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[];
+  group: AccessGroupDto;
+  members: UserDto[];
 }
 
 export interface AccessGroupsResponse {
-    groups: AccessGroupDto[];
+  groups: AccessGroupDto[];
+}
+
+export interface InviteCodeResponse {
+  code: string
 }
 
 

package/src/dto/badRequestResponse.ts

@@ -0,0 +1,6 @@
+
+export interface BadRequest {
+    code: number
+    name: string
+    desc?: string
+}

package/src/dto/chatResponse.ts

@@ -1,88 +1,93 @@
+import { AnswerId, StepId } from "../storages/chats/answer"
+import { ChatId } from "../storages/chats/chat"
+import { UserId } from "../storages/user/userProfile"
 
 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: AnswerId;
+  chatId: ChatId;
+  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: ChatId;
+  name: string;
+  createdAt: number;
+  modifiedAt: number;
+  userId: UserId;
+  organizationId: string;
+  workspaceId: string;
+  fileId: string;
+  model: 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: StepId;
+  type: StepType;
+  status: StepStatus;
+  start_at: string;
+  end_at: string;
+  tokens: string[];
+  sources: SourceDto[];
 }
 
 export interface FetchAnswerResponse {
-    id: string;
-    status: AnswerStatus;
-    steps: AnswerStepDto[];
+  id: AnswerId;
+  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 +106,4 @@ export class StepTypeInfo {
     }
     return false
   }
-}
+}

package/src/dto/limitsResponse.ts

@@ -0,0 +1,33 @@
+
+export interface SegmentsData {
+    segments: SegmentData[]
+}
+
+export interface SegmentData {
+    key: string
+    isRegisteredDefault: boolean
+    isAnonymousDefault: boolean
+    isAnonymous: boolean
+    isRegistered: boolean
+    dayItems: SegmentItemData[]
+}
+
+export interface SegmentItemData{ 
+    daysCount: number
+    actionItems: SegmentActionData[]
+}
+
+export interface SegmentActionData {
+    type: LimitActionType
+    countLimit: number
+    tokenLimit?: number
+}
+
+export enum LimitActionType {
+    UploadFile = 0,
+    CreateChat = 1,
+    AskQuestion = 2,
+    CreateWorkspace = 3,
+    CreateOrganization = 4,
+    FileSizeKb = 5
+}

package/src/dto/statisticsResponse.ts

@@ -0,0 +1,12 @@
+export interface StatisticsResponse {
+    dateFrom: number
+    dateTo: number
+    data: StatisticsData[]
+}
+
+export interface StatisticsData {
+    date: number
+    promptUsage: number
+    completionUsage: number
+}
+

package/src/dto/userInfoResponse.ts

@@ -1,4 +1,8 @@
 import { WorkspaceDto } from "./workspacesResponse"
+import { UserId } from "../storages/user/userProfile"
+import { OrganizationId } from "../storages/organizations/organizations"
+import { StatisticsData } from "./statisticsResponse"
+import { LimitActionType, SegmentData } from "./limitsResponse"
 
 export interface UserInfoResponse {
   adminInOrganization: string[]
@@ -7,8 +11,9 @@ export interface UserInfoResponse {
 }
 
 export interface UserDto {
-  id: string
+  id: UserId
   isDeleted: boolean
+  isAnonymousMode: boolean
   created_at: number
   modified_at: number
   profile: ProfileDto
@@ -18,11 +23,14 @@ export interface UserDto {
 export interface ProfileDto {
   name: string
   email: string
+  binanceId: string
+  educationalInstitution: string
 }
 
 export interface UserSettings {
   activeOrganizationId: string
   activeWorkspaceId: string
+  limitSegmentKey: string
 }
 
 export interface OrganizationProfileDto {
@@ -31,7 +39,7 @@ export interface OrganizationProfileDto {
 }
 
 export interface OrganizationDto {
-  id: string
+  id: OrganizationId
   createdAt: number
   modifiedAt: number
   membersCount: number
@@ -45,3 +53,52 @@ export interface OrganizationWorkspaces extends OrganizationDto {
 export interface MembersResponse {
   members: UserDto
 }
+
+export interface UsersStatisticsResponse {
+  dateFrom: number
+  dateTo: number
+  membersData: UsetStatisticsData[]
+}
+
+export interface UsetStatisticsData {
+    userId: UserId
+    data: StatisticsData[]
+}
+
+export interface OrganizationSegmentData {
+  segment: SegmentData
+}
+
+export interface UserLimitsData {
+  userSegment: SegmentData
+  userLimits: UserLimitData[]
+}
+
+export interface UserLimitData {
+  action: LimitActionType
+  records: UserLimitRecordData[]
+}
+
+export interface UserLimitRecordData {
+  daysCount: number
+  countLimit: number
+  tokenLimit?: number
+  activeTill: number
+}
+
+export interface CurrentLimitsData {
+  segment: string
+  limits: CurrentLimitItem[]
+}
+
+export interface CurrentLimitItem {
+  action: LimitActionType
+  records: CurrentLimitRecordData[]
+}
+
+export interface CurrentLimitRecordData  {
+  daysCount: number
+  used: number
+  all: number
+  activeTill: number
+}

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
@@ -18,7 +18,8 @@ export interface WorkspacesResponse {
 }
 
 export interface FileUrlDto {
-  url: string
+  url: string,
+  previewUrl: string
 }
 
 export interface FileProgressDto {
@@ -36,6 +37,7 @@ export interface FileDto {
   name: string
   description: string
   url: string
+  previewUrl: string
   hash: string
   organizationId: string
   workspaceId: string