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

package/src/storages/workspaces/workspace.impl.ts

@@ -0,0 +1,129 @@
+import { Context } from "../../context"
+import { Files } from "../files/files"
+import { Workspace, WorkspaceEvent } from "./workspace"
+import { OrganizationImpl } from "../organizations/organization.impl"
+import { WorkspaceDto } from "../../dto/workspacesResponse"
+import { RpcService } from "../../services/rpcService"
+import { FilesImpl } from "../files/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 filesCount(): Promise<number> {
+    // send request to the server
+    const response = await this.context
+      .resolve(RpcService)
+      ?.requestBuilder("api/v1/Workspaces/files/count")
+      .searchParam("workspaceId", this.id)
+      .searchParam("organizationId", this.organization.id)
+      .sendGet()
+
+    // check response status
+    if (ResponseUtils.isFail(response)) {
+      await ResponseUtils.throwError(
+        `Failed during get workspace total files count for ${this.id} of ${this.organization.id}`,
+        response
+      )
+    }
+
+    return (await response!.json()).count
+  }
+
+  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/workspaces/workspace.ts

@@ -0,0 +1,54 @@
+import { EventDispatcher } from "../../events"
+import { Files } from "../files/files"
+import { WorkspaceId } from "./workspaces"
+import { Organization } from "../organizations/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
+
+  /**
+   * Workspace files count.
+   */
+  abstract filesCount(): Promise<number>
+
+  /**
+   * Change workspace name and description.
+   */
+  abstract change(name: string, description: string): Promise<void>
+}

package/src/storages/workspaces/workspaces.impl.ts

@@ -0,0 +1,212 @@
+import { WorkspaceId, Workspaces, WorkspacesEvent } from "./workspaces"
+import { OrganizationImpl } from "../organizations/organization.impl"
+import { Context } from "../../context"
+import { Workspace } from "./workspace"
+import { WorkspaceImpl } from "./workspace.impl"
+import { OrganizationId } from "../organizations/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, in organization: ${this.organization.id}`, 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, in organization: ${this.organization.id}`)
+    }
+
+    // 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}, in organization: ${this.organization.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 in organization: ${organizationId}`, 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/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, regulation?: { isCreateNewGroup: boolean, newGroupName: string, groupIds: string[]}): Promise<Workspace>
+
+  /**
+   * Delete workspace.
+   */
+  abstract delete(id: WorkspaceId): Promise<void>
+}

package/src/unitTest.ts

@@ -9,7 +9,7 @@ export enum UnitTest {
 export type UnitTestProfileSyncAction = () => void
 export type UnitTestProfileAsyncAction = () => Promise<void>
 
-export class AppSdkUnitTest {
+class AppSdkUnitTest {
   private static _stack: UnitTest[] = [UnitTest.DO_NOTHING]
 
   public static get current(): UnitTest {
@@ -37,6 +37,17 @@ export class AppSdkUnitTest {
   }
 }
 
+export const appTest = async (
+  unitTest: UnitTest = UnitTest.DEFAULT,
+  func: UnitTestProfileSyncAction | UnitTestProfileAsyncAction
+): Promise<void> => {
+  await AppSdkUnitTest.test(unitTest, func)
+}
+
+export const appTestCurrent = (): UnitTest => {
+  return AppSdkUnitTest.current
+}
+
 export const isUnitTest = (mask: UnitTest): boolean => {
   return (AppSdkUnitTest.current & mask) == mask
 }

package/.browserslistrc

@@ -1,5 +0,0 @@
-last 2 chrome version
-last 2 firefox version
-last 2 safari version
-last 2 edge version
-last 2 ie version

package/.editorconfig

@@ -1,22 +0,0 @@
-# Shared editor configurations that track the way prettier formats source.
-#
-# To use this in vscode:
-#
-#   ext install EditorConfig
-
-root = true
-
-# Source files look unixy by default
-[*]
-end_of_line = lf
-insert_final_newline = true
-
-# Javascript and Typescript look like Google-style
-[*.{js,json,ts}]
-charset = utf-8
-indent_style = space
-indent_size = 2
-ij_javascript_use_semicolon_after_statement = false
-ij_typescript_use_semicolon_after_statement = false
-# Not currently supported by vscode, but is supported others, e.g. vim.
-max_line_length = 80

package/.eslintrc.json

@@ -1,44 +0,0 @@
-{
-  "env": {
-    "browser": true,
-    "es2021": true
-  },
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended"
-  ],
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaVersion": "latest",
-    "sourceType": "module"
-  },
-  "plugins": [
-    "@typescript-eslint"
-  ],
-  "ignorePatterns": [
-    "node_modules/",
-    "dist/"
-  ],
-  "rules": {
-    "@typescript-eslint/space-before-function-paren": "off",
-    "@typescript-eslint/semi": "off",
-    "@typescript-eslint/member-delimiter-style": "off",
-    "@typescript-eslint/no-explicit-any": "off",
-    "indent": [
-      "error",
-      2
-    ],
-    "linebreak-style": [
-      "error",
-      "unix"
-    ],
-    "quotes": [
-      "error",
-      "single"
-    ],
-    "semi": [
-      "error",
-      "never"
-    ]
-  }
-}

package/.github/workflows/publish-npm.yml

@@ -1,28 +0,0 @@
-name: Publish package to npmjs
-on:
-  workflow_dispatch:
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/setup-node@v3
-        with:
-          node-version: '20.x'
-          registry-url: 'https://registry.npmjs.org'
-
-      - name: ⏩ CI Install ⏩
-        run: npm ci
-
-      - name: 🧪 Test 🧪
-        run: npm test >> $GITHUB_STEP_SUMMARY | cat
-
-      - name: 🧱 Build 🧱
-        run: npm run build
-
-      - name: 📢 Publish to npm 📢
-        run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.prettierignore

@@ -1 +0,0 @@
-dist

package/.prettierrc

@@ -1,11 +0,0 @@
-{
-  "singleQuote": true,
-  "printWidth": 80,
-  "quoteProps": "preserve",
-  "trailingComma": "none",
-  "arrowParens": "avoid",
-  "semi": false,
-  "tabWidth": 2,
-  "useTabs": false,
-  "spaceBeforeFunctionParen": false
-}

package/.yarnrc

@@ -1,2 +0,0 @@
-registry "https://registry.npmjs.org/"
-save-prefix ""

package/babel.config.js

@@ -1,6 +0,0 @@
-module.exports = {
-  presets: [
-    ['@babel/preset-env', { targets: { node: 'current' } }],
-    '@babel/preset-typescript'
-  ]
-}