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

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'
-  ]
-}

package/jest.config.ts

@@ -1,199 +0,0 @@
-/**
- * For a detailed explanation regarding each configuration property, visit:
- * https://jestjs.io/docs/configuration
- */
-
-import type { Config } from 'jest'
-
-const config: Config = {
-  // All imported modules in your tests should be mocked automatically
-  // automock: false,
-
-  // Stop running tests after `n` failures
-  // bail: 0,
-
-  // The directory where Jest should store its cached dependency information
-  // cacheDirectory: "/private/var/folders/nn/flsl70711r1cpd4m58p0wzgc0000gn/T/jest_dx",
-
-  // Automatically clear mock calls, instances, contexts and results before every test
-  clearMocks: true,
-
-  // Indicates whether the coverage information should be collected while executing the test
-  collectCoverage: true,
-
-  // An array of glob patterns indicating a set of files for which coverage information should be collected
-  // collectCoverageFrom: undefined,
-
-  // The directory where Jest should output its coverage files
-  coverageDirectory: 'coverage',
-
-  // An array of regexp pattern strings used to skip coverage collection
-  // coveragePathIgnorePatterns: [
-  //   "/node_modules/"
-  // ],
-
-  // Indicates which provider should be used to instrument code for coverage
-  // coverageProvider: "babel",
-
-  // A list of reporter names that Jest uses when writing coverage reports
-  // coverageReporters: [
-  //   "json",
-  //   "text",
-  //   "lcov",
-  //   "clover"
-  // ],
-
-  // An object that configures minimum threshold enforcement for coverage results
-  // coverageThreshold: undefined,
-
-  // A path to a custom dependency extractor
-  // dependencyExtractor: undefined,
-
-  // Make calling deprecated APIs throw helpful error messages
-  // errorOnDeprecated: false,
-
-  // The default configuration for fake timers
-  // fakeTimers: {
-  //   "enableGlobally": false
-  // },
-
-  // Force coverage collection from ignored files using an array of glob patterns
-  // forceCoverageMatch: [],
-
-  // A path to a module which exports an async function that is triggered once before all test suites
-  // globalSetup: undefined,
-
-  // A path to a module which exports an async function that is triggered once after all test suites
-  // globalTeardown: undefined,
-
-  // A set of global variables that need to be available in all test environments
-  // globals: {},
-
-  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
-  // maxWorkers: "50%",
-
-  // An array of directory names to be searched recursively up from the requiring module's location
-  // moduleDirectories: [
-  //   "node_modules"
-  // ],
-
-  // An array of file extensions your modules use
-  // moduleFileExtensions: [
-  //   "js",
-  //   "mjs",
-  //   "cjs",
-  //   "jsx",
-  //   "ts",
-  //   "tsx",
-  //   "json",
-  //   "node"
-  // ],
-
-  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
-  // moduleNameMapper: {},
-
-  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
-  // modulePathIgnorePatterns: [],
-
-  // Activates notifications for test results
-  // notify: false,
-
-  // An enum that specifies notification mode. Requires { notify: true }
-  // notifyMode: "failure-change",
-
-  // A preset that is used as a base for Jest's configuration
-  // preset: undefined,
-
-  // Run tests from one or more projects
-  // projects: undefined,
-
-  // Use this configuration option to add custom reporters to Jest
-  // reporters: undefined,
-
-  // Automatically reset mock state before every test
-  // resetMocks: false,
-
-  // Reset the module registry before running each individual test
-  // resetModules: false,
-
-  // A path to a custom resolver
-  // resolver: undefined,
-
-  // Automatically restore mock state and implementation before every test
-  // restoreMocks: false,
-
-  // The root directory that Jest should scan for tests and modules within
-  // rootDir: undefined,
-
-  // A list of paths to directories that Jest should use to search for files in
-  // roots: [
-  //   "<rootDir>"
-  // ],
-
-  // Allows you to use a custom runner instead of Jest's default test runner
-  // runner: "jest-runner",
-
-  // The paths to modules that run some code to configure or set up the testing environment before each test
-  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: [],
-
-  // The number of seconds after which a test is considered as slow and reported as such in the results.
-  // slowTestThreshold: 5,
-
-  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
-  // snapshotSerializers: [],
-
-  // The test environment that will be used for testing
-  // testEnvironment: "jest-environment-node",
-
-  // Options that will be passed to the testEnvironment
-  // testEnvironmentOptions: {},
-
-  // Adds a location field to test results
-  // testLocationInResults: false,
-
-  // The glob patterns Jest uses to detect test files
-  // testMatch: [
-  //   "**/__tests__/**/*.[jt]s?(x)",
-  //   "**/?(*.)+(spec|test).[tj]s?(x)"
-  // ],
-
-  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
-  // testPathIgnorePatterns: [
-  //   "/node_modules/"
-  // ],
-
-  // The regexp pattern or array of patterns that Jest uses to detect test files
-  // testRegex: [],
-
-  // This option allows the use of a custom results processor
-  // testResultsProcessor: undefined,
-
-  // This option allows use of a custom test runner
-  // testRunner: "jest-circus/runner",
-
-  // A map from regular expressions to paths to transformers
-  // transform: undefined,
-
-  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
-  // transformIgnorePatterns: [
-  //   "/node_modules/",
-  //   "\\.pnp\\.[^\\/]+$"
-  // ],
-
-  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
-  // unmockedModulePathPatterns: undefined,
-
-  // Indicates whether each individual test should be reported during the run
-  // verbose: undefined,
-
-  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
-  // watchPathIgnorePatterns: [],
-
-  // Whether to use watchman for file crawling
-  // watchman: true,
-}
-
-export default config

package/jest.setup.ts

@@ -1,2 +0,0 @@
-import * as dotenv from 'dotenv'
-dotenv.config({ path: '.env.test' })

package/src/services/organizationImpl.ts

@@ -1,51 +0,0 @@
-import { Organization, OrganizationId } from '../storages/organizations'
-import { Disposable } from '../disposable'
-import { OrganizationDto } from '../dto/userInfoResponse'
-import { OrganizationService } from './organizationService'
-import { OrganizationsImpl } from './organizationsImpl'
-
-export class OrganizationImpl extends Organization implements Disposable {
-  private _isDisposed: boolean = false
-  private _isAdmin: boolean = false
-  private _content?: OrganizationDto
-
-  constructor(
-    private readonly service: OrganizationService,
-    private readonly organizations: OrganizationsImpl
-  ) {
-    super()
-  }
-
-  get isAdmin(): boolean {
-    return this._isAdmin
-  }
-
-  get isDisposed(): boolean {
-    return this._isDisposed
-  }
-
-  dispose(): void {
-    this._isDisposed = true
-  }
-
-  public initFrom(
-    content: OrganizationDto,
-    isAdmin: boolean
-  ): OrganizationImpl {
-    this._content = content
-    this._isAdmin = isAdmin
-    return this
-  }
-
-  get id(): OrganizationId {
-    return <OrganizationId>this._content?.id
-  }
-
-  get name(): string {
-    return <OrganizationId>this._content?.profile.name
-  }
-
-  get description(): string {
-    return <OrganizationId>this._content?.profile.description
-  }
-}