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

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

package/src/index.ts

@@ -1,26 +1,48 @@
 import { version } from "../package.json"
 import { _createApp } from "./internal/createApp.impl"
 import { type AppBuilder } from "./appBuilder"
-import { type AppSdk } from "./appSdk"
+import { type DataIslandApp } from "./dataIslandApp"
 
 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"
+export * from "./dataIslandApp"
+export * from "./appBuilder"
+export * from "./context"
+export * from "./middleware"
+export * from "./dto/chatResponse"
+export * from "./dto/accessGroupResponse"
+export * from "./dto/userInfoResponse"
+export * from "./dto/workspacesResponse"
+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"
+export * from "./storages/chats/answer"
 
-const _appsNotReady = new Map<string, Promise<AppSdk>>()
-const _appsReady = new Map<string, AppSdk>()
+export {
+  OrganizationId, Organizations, OrganizationsEvent
+} from "./storages/organizations/organizations"
+export {
+  WorkspaceId, Workspaces, WorkspacesEvent
+} from "./storages/workspaces/workspaces"
+export { FileId, File, FileStatus } from "./storages/files/file"
+export { UploadFile, Files, FilesEvent } from "./storages/files/files"
+export { Group, GroupEvent, GroupId } from "./storages/groups/group"
+export { AnswerId, Answer, StepId, AnswerEvent } from "./storages/chats/answer"
+export { isNullOrUndefined, isEmptyNullOrUndefined } from "./utils/utils"
+
+// map of apps that are not ready to be used
+const _appsNotReady = new Map<string, Promise<DataIslandApp>>()
+// map of apps that are ready to be used
+const _appsReady = new Map<string, DataIslandApp>()
 
 /**
  * Current SDK version.
@@ -37,7 +59,10 @@ export const DEFAULT_NAME = "[DEFAULT]"
  */
 export const DEFAULT_HOST = "https://api.dataisland.com.ua"
 
-export function sdks(): AppSdk[] {
+/**
+ * Returns a list of DataIsland App instances.
+ */
+export function dataIslandInstances(): DataIslandApp[] {
   return Array.from(_appsReady.values())
 }
 
@@ -48,19 +73,19 @@ export function sdks(): AppSdk[] {
  * @returns A DataIsland App instance.
  * @example
  * ```js
- * import { appSdk } from 'data-island'
+ * import { dataIslandApp, DEFAULT_NAME } from '@neuralinnovations/dataisland-sdk'
  *
- * const app = await appSdk("my-app", builder => {
+ * const app = await dataIslandApp(DEFAULT_NAME, builder => {
  *  builder.useHost("https://dataisland.com.ua")
  *  builder.useAutomaticDataCollectionEnabled(true)
  *  builder.useCredential(new BasicCredential("email", "password"))
  *  })
  * ```
  */
-export async function appSdk(
+export async function dataIslandApp(
   name?: string,
   setup?: (builder: AppBuilder) => Promise<void>
-): Promise<AppSdk> {
+): Promise<DataIslandApp> {
   name = name ?? DEFAULT_NAME
 
   let appPromise = _appsNotReady.get(name)
@@ -78,12 +103,9 @@ export async function appSdk(
   } else {
     if (setup !== undefined) {
       throw new Error(
-        `App ${name} is initializing. You can't setup the same again.`
+        `DataIsland ${name} is initializing. You can't setup the same again.`
       )
     }
   }
   return await appPromise
 }
-
-export { File } from "./storages/file"
-export { FilesPage } from "./storages/filesPage"

package/src/internal/app.impl.ts

@@ -7,8 +7,12 @@ import { DisposableContainer, type Lifetime } from "../disposable"
 import { type Service, ServiceContext } from "../services/service"
 import { CredentialService } from "../services/credentialService"
 import { MiddlewareService } from "../services/middlewareService"
-import { type CredentialBase } from "../credentials"
-import { AppSdk } from "../appSdk"
+import {
+  DefaultCredential,
+  type CredentialBase,
+  AnonymousCredential
+} from "../credentials"
+import { DataIslandApp } from "../dataIslandApp"
 import { RpcService } from "../services/rpcService"
 import { CommandService } from "../services/commandService"
 import {
@@ -17,11 +21,18 @@ 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 AppImplementation extends AppSdk {
+import {
+  DeleteUserFullCommand,
+  DeleteUserFullCommandHandler
+} from "../commands/deleteUserFullCommandHandler"
+import { CookieService } from "../services/cookieService"
+import { AnonymousService } from "../services/anonymousService"
+import { AcquiringService } from "../services/acquiringService"
+
+export class DataIslandAppImpl extends DataIslandApp {
   readonly name: string
   private _host: string = DEFAULT_HOST
   private _automaticDataCollectionEnabled: boolean = true
@@ -34,7 +45,7 @@ export class AppImplementation extends AppSdk {
     this.name = name
     this._registry = new Registry()
     this._disposable = new DisposableContainer()
-    this._context = new Context(this._registry, this._disposable.lifetime, name)
+    this._context = new Context(this._registry, this._disposable.lifetime, this)
 
     this._registry.map(Context).asValue(this._context)
   }
@@ -73,6 +84,10 @@ export class AppImplementation extends AppSdk {
     return this.resolve(UserProfileService)?.userProfile as UserProfile
   }
 
+  get acquiring(): AcquiringService {
+    return this.resolve(AcquiringService) as AcquiringService
+  }
+
   async initialize(
     setup: ((builder: AppBuilder) => Promise<void>) | undefined
   ): Promise<void> {
@@ -83,8 +98,14 @@ export class AppImplementation extends AppSdk {
     builder.registerCommand(StartCommand, (context: Context) => {
       return new StartCommandHandler(context)
     })
+    builder.registerCommand(DeleteUserFullCommand, (context: Context) => {
+      return new DeleteUserFullCommandHandler(context)
+    })
 
     // register services
+    builder.registerService(CookieService, (context: ServiceContext) => {
+      return new CookieService(context)
+    })
     builder.registerService(CredentialService, (context: ServiceContext) => {
       return new CredentialService(context)
     })
@@ -103,6 +124,13 @@ export class AppImplementation extends AppSdk {
     builder.registerService(OrganizationService, (context: ServiceContext) => {
       return new OrganizationService(context)
     })
+    builder.registerService(AnonymousService, (context: ServiceContext) => {
+      return new AnonymousService(context)
+    })
+    builder.registerService(AcquiringService, (context: ServiceContext) => {
+      return new AcquiringService(context)
+    })
+
 
     // call customer setup
     if (setup !== undefined) {
@@ -139,8 +167,6 @@ export class AppImplementation extends AppSdk {
       this.resolve(CommandService)?.register(command[0], command[1])
     })
 
-    this.credential = builder.credential
-
     //-------------------------------------------------------------------------
     // register services
     //-------------------------------------------------------------------------
@@ -171,6 +197,22 @@ export class AppImplementation extends AppSdk {
     await Promise.all(waitList)
     //-------------------------------------------------------------------------
 
+    // set credential
+    this.credential = builder.credential
+
+    // Check anonymous authorization
+    if (!isUnitTest(UnitTest.DO_NOT_START) && builder.credential instanceof DefaultCredential) {
+      const anonymous = this.resolve(AnonymousService)!
+      const {
+        token,
+        isValid
+      } = await anonymous.getToken()
+
+      if (isValid) {
+        this.credential = new AnonymousCredential(token)
+      }
+    }
+
     // start app, execute start command
     if (!isUnitTest(UnitTest.DO_NOT_START)) {
       await this.context.execute(new StartCommand())
@@ -178,7 +220,7 @@ export class AppImplementation extends AppSdk {
 
     // log app initialized
     if (!isUnitTest(UnitTest.DO_NOT_PRINT_INITIALIZED_LOG)) {
-      console.log(`AppSDK ${this.name} initialized`)
+      console.log(`DataIsland ${this.name} initialized`)
     }
   }
 }

package/src/internal/createApp.impl.ts

@@ -1,12 +1,12 @@
-import { AppImplementation } from "./app.impl"
+import { DataIslandAppImpl } from "./app.impl"
 import { type AppBuilder } from "../appBuilder"
-import { AppSdk } from "../appSdk"
+import { DataIslandApp } from "../dataIslandApp"
 
 export async function _createApp(
   name: string,
   setup?: (builder: AppBuilder) => Promise<void>
-): Promise<AppSdk> {
-  const app = new AppImplementation(name)
+): Promise<DataIslandApp> {
+  const app = new DataIslandAppImpl(name)
   await app.initialize(setup)
   return app
 }

package/src/internal/registry.ts

@@ -1,9 +1,21 @@
+/**
+ * Constructor type.
+ */
 export type Constructor<T> = new (...args: any[]) => T
 
+/**
+ * Provider interface.
+ */
 abstract class Provider {
+  /**
+   * Provide method.
+   */
   abstract provide(): any | undefined
 }
 
+/**
+ * MethodProvider class.
+ */
 class MethodProvider<T> extends Provider {
   private instance?: T
   private provided: boolean = false
@@ -25,6 +37,9 @@ class MethodProvider<T> extends Provider {
   }
 }
 
+/**
+ * ValueProvider class.
+ */
 class ValueProvider<T> extends Provider {
   constructor(private readonly value: T | undefined) {
     super()
@@ -35,44 +50,77 @@ class ValueProvider<T> extends Provider {
   }
 }
 
+/**
+ * RegistryItem class.
+ */
 export class RegistryItem<T> {
   constructor(
     private readonly registry: Map<Constructor<any>, Provider>,
     private readonly type: Constructor<T>
-  ) {}
+  ) {
+  }
 
+  /**
+   * As value method.
+   * @param value
+   */
   asValue(value: T): void {
     this.registry.set(this.type, new ValueProvider<T>(value))
   }
 
+  /**
+   * As provider method.
+   * @param provider
+   * @param oneTime
+   */
   asProvider<T>(provider: () => T, oneTime: boolean = false): void {
     this.registry.set(this.type, new MethodProvider<T>(provider, oneTime))
   }
 
+  /**
+   * As factory method.
+   * @param provider
+   */
   asFactory<T>(provider: () => T): void {
     this.registry.set(this.type, new MethodProvider<T>(provider, false))
   }
 
+  /**
+   * As singleton method.
+   * @param provider
+   */
   asSingleton<T>(provider: () => T): void {
     this.registry.set(this.type, new MethodProvider<T>(provider, true))
   }
 }
 
+/**
+ * Registry class.
+ */
 export class Registry {
-  private readonly services: Map<Constructor<any>, Provider>
-
-  constructor() {
-    this.services = new Map()
-  }
+  private readonly services: Map<Constructor<any>, Provider> = new Map()
 
+  /**
+   * Map method.
+   * @param type
+   */
   map<T>(type: Constructor<T>): RegistryItem<T> {
     return new RegistryItem<T>(this.services, type)
   }
 
+  /**
+   * Set method.
+   * @param type
+   * @param provider
+   */
   set<T>(type: Constructor<T>, provider: Provider): void {
     this.services.set(type, provider)
   }
 
+  /**
+   * Get method.
+   * @param type
+   */
   get<T>(type: Constructor<T>): T | undefined {
     const provider = this.services.get(type)
     if (provider === undefined) {