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

package/src/storages/organizations.ts

@@ -1,46 +1,26 @@
-import { EventDispatcher } from '../events'
+import { EventDispatcher } from "../events"
+import { Organization } from "./organization"
 
 /**
  * Organization id.
  */
 export type OrganizationId = string
 
-/**
- * Organization.
- */
-export abstract class Organization {
-  /**
-   * Organization id.
-   */
-  abstract get id(): OrganizationId
-
-  /**
-   * Organization name.
-   */
-  abstract get name(): string
-
-  /**
-   * Organization description.
-   */
-  abstract get description(): string
-}
-
 /**
  * Organization event.
  */
-export enum OrganizationEvent {
-  ADDED = 'added',
-  REMOVED = 'removed',
-  CHANGED = 'changed',
-  CURRENT_CHANGED = 'currentChanged'
+export enum OrganizationsEvent {
+  ADDED = "added",
+  REMOVED = "removed",
+  CURRENT_CHANGED = "currentChanged"
 }
 
 /**
  * Organizations storage.
  */
 export abstract class Organizations extends EventDispatcher<
-  OrganizationEvent,
-  Organization | Organizations
+  OrganizationsEvent,
+  Organization
 > {
   /**
    * User's organizations.

package/src/storages/userProfile.impl.ts

@@ -0,0 +1,56 @@
+import { UserEvent, UserProfile } from "./userProfile"
+import { UserInfoResponse } from "../dto/userInfoResponse"
+
+export class UserProfileImpl extends UserProfile {
+  private content?: UserInfoResponse
+
+  get id(): string {
+    if (this.content) {
+      return this.content.user.id
+    }
+    throw new Error("The profile is not loaded.")
+  }
+
+  get name(): string {
+    if (this.content) {
+      return this.content.user.profile.name
+    }
+    throw new Error("The profile is not loaded.")
+  }
+
+  get email(): string {
+    if (this.content) {
+      return this.content.user.profile.email
+    }
+    throw new Error("The profile is not loaded.")
+  }
+
+  get isDeleted(): boolean {
+    if (this.content) {
+      return this.content.user.isDeleted
+    }
+    throw new Error("The profile is not loaded.")
+  }
+
+  get createdAt(): Date {
+    if (this.content) {
+      return new Date(this.content.user.created_at)
+    }
+    throw new Error("The profile is not loaded.")
+  }
+
+  get modifiedAt(): Date {
+    if (this.content) {
+      return new Date(this.content.user.modified_at)
+    }
+    throw new Error("The profile is not loaded.")
+  }
+
+  initFrom(content: UserInfoResponse) {
+    this.content = content
+    this.dispatch({
+      type: UserEvent.CHANGED,
+      data: this
+    })
+  }
+}

package/src/storages/userProfile.ts

@@ -1,9 +1,9 @@
-import { EventDispatcher } from '../events'
+import { EventDispatcher } from "../events"
 
 export type UserId = string
 
 export enum UserEvent {
-  CHANGED = 'changed'
+  CHANGED = "changed"
 }
 
 export abstract class UserProfile extends EventDispatcher<

package/src/storages/workspace.impl.ts

@@ -0,0 +1,109 @@
+import { Context } from "../context"
+import { Files } from "./files"
+import { Workspace, WorkspaceEvent } from "./workspace"
+import { OrganizationImpl } from "./organization.impl"
+import { WorkspaceDto } from "../dto/workspacesResponse"
+import { RpcService } from "../services/rpcService"
+import { FilesImpl } from "./files.impl"
+import { ResponseUtils } from "../services/responseUtils"
+
+export class WorkspaceImpl extends Workspace {
+  private _isMarkAsDeleted: boolean = false
+  private _workspace?: WorkspaceDto
+
+  private readonly _files: FilesImpl
+
+  constructor(
+    public readonly organization: OrganizationImpl,
+    public readonly context: Context
+  ) {
+    super()
+    this._files = new FilesImpl(this, context)
+  }
+
+  get id(): string {
+    if (this._workspace) {
+      return this._workspace.id
+    }
+    throw new Error("Workspace is not loaded.")
+  }
+
+  get name(): string {
+    if (this._workspace) {
+      return this._workspace.profile.name
+    }
+    throw new Error("Workspace is not loaded.")
+  }
+
+  get description(): string {
+    if (this._workspace) {
+      return this._workspace.profile.description
+    }
+    throw new Error("Workspace is not loaded.")
+  }
+
+  get files(): Files {
+    return this._files
+  }
+
+  async change(name: string, description: string): Promise<void> {
+    if (!this._workspace) {
+      throw new Error("Workspace is not loaded.")
+    }
+    if (this._isMarkAsDeleted) {
+      throw new Error("Workspace is marked as deleted.")
+    }
+    if (name === this.name && description === this.description) {
+      return Promise.resolve()
+    }
+    if (name === undefined || name === null || name.trim() === "") {
+      throw new Error("Name is required. Please provide a valid name.")
+    }
+    if (
+      description === undefined ||
+      description === null ||
+      description.trim() === ""
+    ) {
+      throw new Error(
+        "Description is required. Please provide a valid description."
+      )
+    }
+
+    const response = await this.context
+      .resolve(RpcService)
+      ?.requestBuilder("api/v1/Workspaces")
+      .sendPutJson({
+        workspaceId: this.id,
+        profile: {
+          name,
+          description
+        }
+      })
+
+    if (ResponseUtils.isFail(response)) {
+      await ResponseUtils.throwError("Failed to change workspace", response)
+    }
+
+    if (this._workspace) {
+      this._workspace.profile.name = name
+      this._workspace.profile.description = description
+    }
+
+    this.dispatch({
+      type: WorkspaceEvent.CHANGED,
+      data: this
+    })
+  }
+
+  async initFrom(workspace: WorkspaceDto) {
+    this._workspace = workspace
+  }
+
+  get isMarkAsDeleted(): boolean {
+    return this._isMarkAsDeleted
+  }
+
+  markToDelete(): void {
+    this._isMarkAsDeleted = true
+  }
+}

package/src/storages/workspace.ts

@@ -0,0 +1,49 @@
+import { EventDispatcher } from "../events"
+import { Files } from "./files"
+import { WorkspaceId } from "./workspaces"
+import { Organization } from "./organization"
+
+/**
+ * Workspace event.
+ */
+export enum WorkspaceEvent {
+  CHANGED = "changed"
+}
+
+/**
+ * Workspace.
+ */
+export abstract class Workspace extends EventDispatcher<
+  WorkspaceEvent,
+  Workspace
+> {
+  /**
+   * Organization.
+   */
+  abstract get organization(): Organization
+
+  /**
+   * Workspace id.
+   */
+  abstract get id(): WorkspaceId
+
+  /**
+   * Workspace name.
+   */
+  abstract get name(): string
+
+  /**
+   * Workspace description.
+   */
+  abstract get description(): string
+
+  /**
+   * Workspace files.
+   */
+  abstract get files(): Files
+
+  /**
+   * Change workspace name and description.
+   */
+  abstract change(name: string, description: string): Promise<void>
+}

package/src/storages/workspaces.impl.ts

@@ -0,0 +1,212 @@
+import { WorkspaceId, Workspaces, WorkspacesEvent } from "./workspaces"
+import { OrganizationImpl } from "./organization.impl"
+import { Context } from "../context"
+import { Workspace } from "./workspace"
+import { WorkspaceImpl } from "./workspace.impl"
+import { OrganizationId } from "./organizations"
+import { RpcService } from "../services/rpcService"
+import { OrganizationWorkspaces } from "../dto/userInfoResponse"
+import { WorkspaceDto } from "../dto/workspacesResponse"
+import { ResponseUtils } from "../services/responseUtils"
+
+export class WorkspacesImpl extends Workspaces {
+  private readonly _workspaces: WorkspaceImpl[] = []
+
+  constructor(
+    private readonly organization: OrganizationImpl,
+    private readonly context: Context
+  ) {
+    super()
+  }
+
+  get collection(): readonly Workspace[] {
+    return this._workspaces
+  }
+
+  get(id: string): Workspace {
+    return <Workspace>this.tryGet(id)
+  }
+
+  tryGet(id: string): Workspace | undefined {
+    return this._workspaces.find(workspace => workspace.id === id)
+  }
+
+  contains(id: string): boolean {
+    return this._workspaces.find(workspace => workspace.id === id) !== undefined
+  }
+
+  /**
+   * Create workspace.
+   * @param name
+   * @param description
+   * @param regulation
+   */
+  async create(
+    name: string,
+    description: string,
+    regulation?: {
+      isCreateNewGroup: boolean
+      newGroupName: string
+      groupIds: string[]
+    }
+  ): Promise<Workspace> {
+    if (name === undefined || name === null || name.trim() === "") {
+      throw new Error("Name is required, must be not empty")
+    }
+    if (
+      description === undefined ||
+      description === null ||
+      description.trim() === ""
+    ) {
+      throw new Error("Description is required, must be not empty")
+    }
+    if (regulation) {
+      if (
+        regulation.isCreateNewGroup === undefined ||
+        regulation.isCreateNewGroup === null
+      ) {
+        throw new Error("isCreateNewGroup is required, must be not empty")
+      }
+      if (
+        regulation.newGroupName === undefined ||
+        regulation.newGroupName === null ||
+        regulation.newGroupName.trim() === ""
+      ) {
+        throw new Error("newGroupName is required, must be not empty")
+      }
+      if (
+        regulation.groupIds === undefined ||
+        regulation.groupIds === null ||
+        regulation.groupIds.length === 0
+      ) {
+        throw new Error("groupIds is required, must be not empty")
+      }
+    }
+
+    // send create request to the server
+    const response = await this.context
+      .resolve(RpcService)
+      ?.requestBuilder("api/v1/Workspaces")
+      .sendPostJson({
+        organizationId: this.organization.id,
+        profile: {
+          name: name,
+          description: description
+        },
+        regulation: {
+          isCreateNewGroup: regulation?.isCreateNewGroup ?? false,
+          newGroupName: regulation?.newGroupName ?? "",
+          groupIds: regulation?.groupIds ?? []
+        }
+      })
+
+    // check response status
+    if (ResponseUtils.isFail(response)) {
+      await ResponseUtils.throwError("Failed to create workspace", response)
+    }
+
+    // parse workspace from the server's response
+    const content = (await response!.json()).workspace as WorkspaceDto
+
+    // create workspace implementation
+    const workspace = new WorkspaceImpl(this.organization, this.context)
+    await workspace.initFrom(content)
+
+    // add workspace to the collection
+    this._workspaces.push(workspace)
+
+    // dispatch event
+    this.dispatch({
+      type: WorkspacesEvent.ADDED,
+      data: workspace
+    })
+
+    return workspace
+  }
+
+  /**
+   * Delete workspace.
+   * @param id
+   */
+  async delete(id: WorkspaceId): Promise<void> {
+    // get workspace by id
+    const workspace = <WorkspaceImpl>this.tryGet(id)
+
+    // check if workspace is found
+    if (!workspace) {
+      throw new Error(`Workspace ${id} is not found`)
+    }
+
+    // check if workspace is already marked as deleted
+    if (workspace.isMarkAsDeleted) {
+      throw new Error(`Workspace ${id} is already marked as deleted`)
+    }
+
+    // mark workspace as deleted
+    workspace.markToDelete()
+
+    // send delete request to the server
+    const response = await this.context
+      .resolve(RpcService)
+      ?.requestBuilder("api/v1/Workspaces")
+      .searchParam("id", id)
+      .sendDelete()
+
+    // check response status
+    if (ResponseUtils.isFail(response)) {
+      await ResponseUtils.throwError(
+        `Failed to delete workspace: ${workspace.organization.name}/${workspace.name}:${id}`,
+        response
+      )
+    }
+
+    // remove workspace from the collection
+    const index = this._workspaces.indexOf(<WorkspaceImpl>workspace)
+    if (index < 0) {
+      throw new Error(`Workspace ${id} is not found`)
+    }
+    this._workspaces.splice(index, 1)
+
+    // dispatch event
+    this.dispatch({
+      type: WorkspacesEvent.REMOVED,
+      data: workspace
+    })
+  }
+
+  async initFrom(organizationId: OrganizationId): Promise<void> {
+    // init workspaces from the server's response
+    const response = await this.context
+      .resolve(RpcService)
+      ?.requestBuilder("api/v1/Organizations")
+      .searchParam("id", organizationId)
+      .sendGet()
+
+    // check response status
+    if (ResponseUtils.isFail(response)) {
+      await ResponseUtils.throwError("Failed to fetch workspaces.", response)
+    }
+
+    // parse workspaces from the server's response
+    const workspaces = ((await response!.json()) as OrganizationWorkspaces)
+      .workspaces
+
+    // init workspaces from the server's response
+    for (const workspace of workspaces) {
+      // create workspace implementation
+      const workspaceImpl = new WorkspaceImpl(this.organization, this.context)
+
+      // init workspace from the server's response
+      await workspaceImpl.initFrom(workspace)
+
+      // add workspace to the collection
+      this._workspaces.push(workspaceImpl)
+
+      // dispatch event
+      this.dispatch({
+        type: WorkspacesEvent.ADDED,
+        data: workspaceImpl
+      })
+    }
+  }
+}

package/src/storages/workspaces.ts

@@ -0,0 +1,53 @@
+import { EventDispatcher } from "../events"
+import { Workspace } from "./workspace"
+
+export type WorkspaceId = string
+
+/**
+ * Workspaces event.
+ */
+export enum WorkspacesEvent {
+  ADDED = "added",
+  REMOVED = "removed"
+}
+
+/**
+ * Organization's workspaces.
+ */
+export abstract class Workspaces extends EventDispatcher<
+  WorkspacesEvent,
+  Workspace
+> {
+  /**
+   * Workspaces.
+   */
+  abstract get collection(): ReadonlyArray<Workspace>
+
+  /**
+   * Get workspace by id.
+   * @param id
+   */
+  abstract get(id: WorkspaceId): Workspace
+
+  /**
+   * Try to get workspace by id.
+   * @param id
+   */
+  abstract tryGet(id: WorkspaceId): Workspace | undefined
+
+  /**
+   * Check if workspace exists.
+   * @param id
+   */
+  abstract contains(id: WorkspaceId): boolean
+
+  /**
+   * Create workspace.
+   */
+  abstract create(name: string, description: string): Promise<Workspace>
+
+  /**
+   * Delete workspace.
+   */
+  abstract delete(id: WorkspaceId): Promise<void>
+}

package/test/commands.test.ts

@@ -1,24 +1,24 @@
-import { Command, CommandHandler } from '../src/services/commandService'
-import { appSdk } from '../src'
-import { UnitTest, AppSdkUnitTest } from '../src/unitTest'
+import { Command, CommandHandler } from "../src/services/commandService"
+import { appSdk } from "../src"
+import { UnitTest, AppSdkUnitTest } from "../src/unitTest"
 
 class Cmd extends Command {
-  constructor(public readonly name: string = 'test') {
+  constructor(public readonly name: string = "test") {
     super()
   }
 }
 
 class CmdHandler extends CommandHandler<Cmd> {
   async execute(message: Cmd): Promise<void> {
-    expect(message.name).toBe('test-command')
+    expect(message.name).toBe("test-command")
   }
 }
 
-test('Commands test', async () => {
+test("Commands test", async () => {
   await AppSdkUnitTest.test(UnitTest.DEFAULT, async () => {
-    const app = await appSdk('test-commands', async builder => {
+    const app = await appSdk("test-commands", async builder => {
       builder.registerCommand(Cmd, context => new CmdHandler(context))
     })
-    expect(app.context.execute(new Cmd('test-command'))).toBeDefined()
+    expect(app.context.execute(new Cmd("test-command"))).toBeDefined()
   })
 })

package/test/disposable.test.ts

@@ -1,6 +1,6 @@
-import { DisposableContainer } from '../src'
+import { DisposableContainer } from "../src"
 
-test('DisposableContainer', () => {
+test("DisposableContainer", () => {
   const disposable = new DisposableContainer()
   expect(disposable.isDisposed).toBe(false)
   expect(disposable.lifetime.isDisposed).toBe(false)
@@ -9,7 +9,7 @@ test('DisposableContainer', () => {
   expect(disposable.lifetime.isDisposed).toBe(true)
 })
 
-test('DisposableContainer, dispose order', () => {
+test("DisposableContainer, dispose order", () => {
   const indexes: number[] = []
   const disposable = new DisposableContainer()
   disposable.addCallback(() => {

package/test/events.test.ts

@@ -1,6 +1,6 @@
-import { EventDispatcher } from '../src'
+import { EventDispatcher } from "../src"
 
-test('Events, test general', () => {
+test("Events, test general", () => {
   enum ET {
     A,
     B
@@ -78,7 +78,7 @@ test('Events, test general', () => {
   expect(b2).toBe(3)
 })
 
-test('Events, test this', () => {
+test("Events, test this", () => {
   enum ET {
     A,
     B
@@ -128,7 +128,7 @@ test('Events, test this', () => {
   expect(b.value).toBe(2)
 })
 
-test('Events, test unsubscribe', () => {
+test("Events, test unsubscribe", () => {
   const dispatch = new EventDispatcher<unknown, number>()
 
   let index = 0

package/test/files.test.ts

@@ -0,0 +1,52 @@
+import fs from "fs"
+import { testInWorkspace } from "./setup"
+
+test("Files", async () => {
+  await testInWorkspace(async (app, org, ws) => {
+
+    expect(app).not.toBeUndefined()
+    expect(org).not.toBeUndefined()
+
+    const buffer = fs.readFileSync("test/data/test_file.pdf")
+    const file_obj = new File([new Uint8Array(buffer)], "test_file.pdf", {
+      type: "application/pdf"
+    })
+
+    const filePromise = ws.files.upload(file_obj)
+    await expect(filePromise).resolves.not.toThrow()
+    const file = await filePromise
+
+    expect(file).not.toBeUndefined()
+    expect(file).not.toBeNull()
+    expect(file.name).toBe("test_file.pdf")
+
+    let status = await file.status()
+
+    expect(status).not.toBeUndefined()
+    expect(status).not.toBeNull()
+    if (!status.success && status.error) {
+      console.error(status.error)
+    }
+    expect(status.success).toBe(true)
+    expect(status.file_id).toBe(file.id)
+    expect(status.file_parts_count).toBeGreaterThanOrEqual(status.completed_parts_count)
+
+    while (
+      status.success &&
+      status.completed_parts_count !== status.file_parts_count
+    ) {
+      await new Promise(r => setTimeout(r, 1000))
+      status = await file.status()
+    }
+
+    const queryPromise = ws.files.query("", 0, 20)
+    await expect(queryPromise).resolves.not.toThrow()
+    const filePage = await queryPromise
+    expect(filePage).not.toBeUndefined()
+    expect(filePage).not.toBeNull()
+    expect(filePage.files.length).toBe(1)
+    expect(filePage.pages).toBe(1)
+
+    await expect(ws.files.delete(file.id)).resolves.not.toThrow()
+  })
+})