@neuralinnovations/dataisland-sdk 0.0.1-dev3 → 0.0.1-dev5

package/README.md

@@ -1,7 +1,96 @@
 # DataIsland Client SDK
 
-```typescript
+The DataIsland Client SDK is a TypeScript library designed to seamlessly integrate DataIsland web services into websites.
 
+## Table of contents
 
+1. [Connect](#connect)
+2. [Create app](#create-app)
+3. [Use organizations](#use-organizations)
+4. [Use chat](#use-chat)
+5. [Use workspaces](#use-workspaces)
+6. [Use files](#use-files)
+7. [Use access groups](#use-access-groups)
+8. [Use invites](#use-invites)
 
-```
+### Connect
+
+For connecting this library to your website project simply install it using npm package manager.
+
+`npm i @neuralinnovations/dataisland-sdk`
+
+### Create app
+
+You can initialize default app sdk instance using this code example.
+
+```
+const app = await dataIslandApp("your-app-name", async (builder: AppBuilder) => {
+    builder.useHost(HOST)
+    builder.useCredential(new BearerCredential(TOKEN))
+  })
+```
+
+It is immpossible to create more than one app sdk intance with same name.
+
+**HOST** is a DataIsland API url which can be passed using environment file.
+
+Second required parameter for builder is Credentials. It is recomended to use Bearer credentials instance and pass your user Auth0 **TOKEN** in order to get access to API.
+
+You can also add requests middlewares with builder options.
+
+```
+const app = await dataIslandApp("your-app-name", async (builder: AppBuilder) => {
+      builder.useHost(YOUR_HOST)
+      builder.useAutomaticDataCollectionEnabled(false)
+      builder.useCredential(new BasicCredential("email", "password"))
+      builder.registerMiddleware(async (req, next) => {
+        req.headers.set("Your-header-name", "value")
+        return await next(req)
+      })
+    })
+```
+
+### Use organizations
+
+Organization is a top data structure object, which represents a company or some group of people using our services.
+It contains of users ( admin or regular ), workspaces with files ( folders with access control features ) and chats.
+
+By default all user organizations are fetched with user profile during app sdk start. But if there are no organizations linked to the user, you should run Create organization flow. This flow requires organization name and description data, and also first workspace name and description data provided by user.
+
+**NOTE** There are two types of DataIsland web api servers, public and private. On public servers users can create their own organization after first registration, on private servers you must register using invite links.
+
+Default organization creation code example:
+
+```
+// create organization
+  const org = await app.organizations.create(
+    "your-organization-name",
+    "your-organization-description"
+  )
+```
+
+### Use workspaces
+
+Workspaces are folder-like objects used to store files and controll access to it using acces groups. During creation you must pass organization Id, name and description of new workspace and regulation options. You can pass existing group ID or ask to create new group for this workspace in regulation section. 
+
+Default workspace creation example:
+
+```
+const workspace = await org.workspaces.create(
+      "your-workspace-name",
+      "your-workspace-description",
+      regulation: {
+        isCreateNewGroup: boolean - "Bool option for new group creation"
+        newGroupName: string - "New group name"
+        groupIds: string[] - "Array of selected accessed groups IDs"
+      }
+    )
+```
+
+### Use files
+
+### Use chat
+
+### Use access groups
+
+### Use Invites

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neuralinnovations/dataisland-sdk",
-  "version": "0.0.1-dev3",
+  "version": "0.0.1-dev5",
   "description": "SDK for DataIsland project",
   "licenses": [
     {

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

@@ -8,7 +8,7 @@ import { UserProfile } from "./storages/userProfile"
 /**
  * DataIsland App instance.
  */
-export abstract class AppSdk {
+export abstract class DataIslandApp {
   /**
    * The name of this app.
    */

package/src/disposable.ts

@@ -9,7 +9,8 @@ export interface Disposable {
  * Represents a lifetime.
  */
 export class Lifetime {
-  constructor(private readonly container: DisposableContainer) {}
+  constructor(private readonly container: DisposableContainer) {
+  }
 
   /**
    * Define a new nested disposable to this lifetime.
@@ -147,5 +148,3 @@ export function disposable(action: () => void, target: unknown): Disposable {
     action.call(target)
   })
 }
-
-export const eternalLifetime = new DisposableContainer().lifetime

package/src/dto/workspacesResponse.ts

@@ -1,5 +1,5 @@
 import { WorkspaceId } from "../storages/workspaces"
-import { FileId } from "../storages/files"
+import { FileId } from "../storages/file"
 
 export interface WorkspaceProfileDto {
   name: string
@@ -26,7 +26,7 @@ export interface FileProgressDto {
   file_parts_count: number
   completed_parts_count: number
   success: boolean
-  error: string
+  error?: string
 }
 
 export interface FileDto {

package/src/events.ts

@@ -1,25 +1,25 @@
 import { type Disposable, DisposableContainer } from "./disposable"
 
-export interface Input<ET, DT> {
-  type?: ET
-  data: DT
+export interface Input<EventType, DataType> {
+  type?: EventType
+  data: DataType
 }
 
-export interface Event<ET, DT> extends Input<ET, DT> {
+export interface Event<EventType, DataType> extends Input<EventType, DataType> {
   unsubscribe: () => void
 }
 
-export interface EventSubscriber<ET, DT> {
-  subscribe: (callback: (event: Event<ET, DT>) => void, type?: ET) => Disposable
+export interface EventSubscriber<EventType, DataType> {
+  subscribe: (callback: (event: Event<EventType, DataType>) => void, type?: EventType) => Disposable
 }
 
-export class EventDispatcher<ET, DT> implements EventSubscriber<ET, DT> {
+export class EventDispatcher<EventType, DataType> implements EventSubscriber<EventType, DataType> {
   private _listeners: Array<{
-    callback: (value: Event<ET, DT>) => void
+    callback: (value: Event<EventType, DataType>) => void
     disposable: Disposable
   }> = []
 
-  dispatch(input: Input<ET, DT>): void {
+  dispatch(input: Input<EventType, DataType>): void {
     this._listeners.slice().forEach(it => {
       const value = {
         type: input.type,
@@ -27,16 +27,16 @@ export class EventDispatcher<ET, DT> implements EventSubscriber<ET, DT> {
         unsubscribe: () => {
           it.disposable.dispose()
         }
-      } satisfies Event<ET, DT>
+      } satisfies Event<EventType, DataType>
       it.callback(value)
     })
   }
 
-  subscribe(callback: (event: Event<ET, DT>) => void, type?: ET): Disposable {
+  subscribe(callback: (event: Event<EventType, DataType>) => void, type?: EventType): Disposable {
     const container = new DisposableContainer()
     if (type !== undefined) {
       const cb = callback
-      const listener = (evt: Event<ET, DT>): void => {
+      const listener = (evt: Event<EventType, DataType>): void => {
         if (evt.type === type) {
           cb(evt)
         }

package/src/index.ts

@@ -1,15 +1,26 @@
 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 "./dataIslandApp"
+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"
 
-const _appsNotReady = new Map<string, Promise<AppSdk>>()
-const _appsReady = new Map<string, AppSdk>()
+const _appsNotReady = new Map<string, Promise<DataIslandApp>>()
+const _appsReady = new Map<string, DataIslandApp>()
 
 /**
  * Current SDK version.
@@ -26,7 +37,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())
 }
 
@@ -37,19 +51,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)
@@ -67,9 +81,12 @@ 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

@@ -8,7 +8,7 @@ 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 { DataIslandApp } from "../dataIslandApp"
 import { RpcService } from "../services/rpcService"
 import { CommandService } from "../services/commandService"
 import {
@@ -21,7 +21,7 @@ import { Organizations } from "../storages/organizations"
 import { UserProfile } from "../storages/userProfile"
 import { isUnitTest, UnitTest } from "../unitTest"
 
-export class AppImplementation extends AppSdk {
+export class DataIslandAppImpl extends DataIslandApp {
   readonly name: string
   private _host: string = DEFAULT_HOST
   private _automaticDataCollectionEnabled: boolean = true
@@ -104,13 +104,6 @@ export class AppImplementation extends AppSdk {
       return new OrganizationService(context)
     })
 
-    // register middlewares
-    builder.registerMiddleware(async (req, next) => {
-      req.headers.set("accept", "text/plain")
-      req.headers.set("content-type", "application/json")
-      return await next(req)
-    })
-
     // call customer setup
     if (setup !== undefined) {
       await setup(builder)
@@ -154,7 +147,9 @@ export class AppImplementation extends AppSdk {
     const waitList: Array<Promise<void>> = []
     // call onRegister service's callback
     services.forEach(([serviceContext]) => {
-      waitList.push(serviceContext.onRegister())
+      if (typeof serviceContext.onRegister === "function") {
+        waitList.push(serviceContext.onRegister())
+      }
     })
 
     // wait for all services to register
@@ -167,7 +162,9 @@ export class AppImplementation extends AppSdk {
     waitList.length = 0
     // call onStart service's callback
     services.forEach(([serviceContext]) => {
-      waitList.push(serviceContext.onStart())
+      if (typeof serviceContext.onStart === "function") {
+        waitList.push(serviceContext.onStart())
+      }
     })
 
     // wait for all services to start
@@ -181,7 +178,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/services/middlewareService.ts

@@ -3,7 +3,7 @@ import { type Middleware } from "../middleware"
 import { type Disposable } from "../disposable"
 
 export class MiddlewareService extends Service {
-  _middlewares: Middleware[] = []
+  private _middlewares: Middleware[] = []
 
   public useMiddleware(middleware: Middleware): Disposable {
     this._middlewares.push(middleware)

package/src/services/requestBuilder.ts

@@ -48,18 +48,42 @@ export class RequestBuilder {
     return this
   }
 
-  public async sendPost(body?: BodyInit | null | object): Promise<Response> {
+  public async sendPostFormData(body: FormData): Promise<Response> {
     const url = this._url
+
+    // set search params
     url.search = this._searchParams.toString()
+
+    // create request
+    const req = new Request(url, {
+      method: "POST",
+      headers: this._headers,
+      body
+    })
+
+    // discard content type
+    const reqAny = req as any
+    reqAny.discardContentType = true
+
+    return await this._request(
+      req
+    )
+  }
+
+  public async sendPostJson(body: object | null | undefined): Promise<Response> {
+    const url = this._url
+    url.search = this._searchParams.toString()
+    let json: string | null | undefined = null
     if (body !== undefined && body !== null && typeof body === "object") {
-      body = JSON.stringify(body)
+      json = JSON.stringify(body)
     }
+    const request = new Request(url, {
+      method: "POST",
+      headers: this._headers,
+      body: json
+    })
     return await this._request(
-      new Request(url, {
-        method: "POST",
-        headers: this._headers,
-        body
-      })
+      request
     )
   }
 
@@ -85,17 +109,18 @@ export class RequestBuilder {
     )
   }
 
-  public async sendPut(body?: BodyInit | null | object): Promise<Response> {
+  public async sendPutJson(body: object | null | undefined): Promise<Response> {
     const url = this._url
     url.search = this._searchParams.toString()
+    let json: string | null | undefined = null
     if (body !== undefined && body !== null && typeof body === "object") {
-      body = JSON.stringify(body)
+      json = JSON.stringify(body)
     }
     return await this._request(
       new Request(url, {
         method: "PUT",
         headers: this._headers,
-        body
+        body: json
       })
     )
   }

package/src/services/rpcService.ts

@@ -14,6 +14,7 @@ export interface RequestOptions {
  * RPC service.
  */
 export class RpcService extends Service {
+
   constructor(
     serviceContext: ServiceContext,
     /**
@@ -32,6 +33,22 @@ export class RpcService extends Service {
     }
   ) {
     super(serviceContext)
+
+    serviceContext.onRegister = async () => {
+      serviceContext.resolve(MiddlewareService)?.useMiddleware((req, next) => {
+        if (!req.headers.has("accept")) {
+          req.headers.set("accept", "text/plain")
+        }
+
+        if ((req as any).discardContentType) {
+          delete (req as any).discardContentType
+        } else {
+          req.headers.set("content-type", "application/json")
+        }
+
+        return next(req)
+      })
+    }
   }
 
   /**
@@ -87,35 +104,35 @@ export class RpcService extends Service {
   /**
    * Send a POST request.
    * @param path
-   * @param body
+   * @param body JSON object
    * @param options
    */
   async post(
     path: string,
-    body?: BodyInit | null,
+    body: object | null | undefined,
     options?: RequestOptions
   ): Promise<Response> {
     return this.requestBuilder(path)
       .searchParams(options?.searchParams)
       .headers(options?.headers)
-      .sendPost(body)
+      .sendPostJson(body)
   }
 
   /**
    * Send a PUT request.
    * @param path
-   * @param body
+   * @param body JSON object
    * @param options
    */
   async put(
     path: string,
-    body?: BodyInit | null,
+    body: object | null | undefined,
     options?: RequestOptions
   ): Promise<Response> {
     return this.requestBuilder(path)
       .searchParams(options?.searchParams)
       .headers(options?.headers)
-      .sendPut(body)
+      .sendPutJson(body)
   }
 
   /**

package/src/services/service.ts

@@ -6,7 +6,8 @@ export class ServiceContext {
   constructor(
     public readonly context: Context,
     private readonly disposableContainer: DisposableContainer
-  ) {}
+  ) {
+  }
 
   public get lifetime(): Lifetime {
     return this.disposableContainer.lifetime
@@ -16,15 +17,15 @@ export class ServiceContext {
     return this.context.resolve(type)
   }
 
-  public async onRegister(): Promise<void> {
+  public onRegister: () => Promise<void> = async (): Promise<void> => {
     await Promise.resolve()
   }
 
-  public async onStart(): Promise<void> {
+  public onStart: () => Promise<void> = async (): Promise<void> => {
     await Promise.resolve()
   }
 
-  public onUnregister(): void {
+  public onUnregister: () => void = (): void => {
     // do nothing
   }
 }
@@ -42,5 +43,6 @@ export abstract class Service {
     return this.serviceContext.context
   }
 
-  public constructor(private readonly serviceContext: ServiceContext) {}
+  public constructor(private readonly serviceContext: ServiceContext) {
+  }
 }

package/src/storages/chat.ts

@@ -1,12 +1,5 @@
-import { EventDispatcher } from "../events"
-
 export type ChatId = string
 
-export enum ChatsEvent {
-  ADDED = "added",
-  REMOVED = "removed"
-}
-
 export enum ChatAnswer {
   SHORT = "short",
   LONG = "long"
@@ -26,12 +19,3 @@ export abstract class Chat {
   abstract question(message: string, answer?: ChatAnswer): Promise<void>
 }
 
-/**
- * Chats storage.
- */
-export abstract class Chats extends EventDispatcher<ChatsEvent, Chat> {
-  /**
-   * Create new chat.
-   */
-  abstract create(): Promise<Chat>
-}

package/src/storages/chats.ts

@@ -0,0 +1,17 @@
+import { EventDispatcher } from "../events"
+import { Chat } from "./chat"
+
+export enum ChatsEvent {
+  ADDED = "added",
+  REMOVED = "removed"
+}
+
+/**
+ * Chats storage.
+ */
+export abstract class Chats extends EventDispatcher<ChatsEvent, Chat> {
+  /**
+   * Create new chat.
+   */
+  abstract create(): Promise<Chat>
+}

package/src/storages/file.impl.ts

@@ -2,8 +2,8 @@ import { Context } from "../context"
 import { Disposable } from "../disposable"
 import { FileDto, FileProgressDto } from "../dto/workspacesResponse"
 import { RpcService } from "../services/rpcService"
-import { File } from "./files"
 import { ResponseUtils } from "../services/responseUtils"
+import { File } from "./file"
 
 export class FileImpl extends File implements Disposable {
   private _isDisposed: boolean = false
@@ -32,7 +32,7 @@ export class FileImpl extends File implements Disposable {
   }
 
   get name(): string {
-    return <string>this._content?.id
+    return <string>this._content?.name
   }
 
   async url(): Promise<string> {
@@ -55,7 +55,7 @@ export class FileImpl extends File implements Disposable {
   async status(): Promise<FileProgressDto> {
     const response = await this.context
       .resolve(RpcService)
-      ?.requestBuilder("api/v1/Files/url")
+      ?.requestBuilder("api/v1/Files/fetch")
       .searchParam("id", this.id)
       .sendGet()
 
@@ -63,6 +63,7 @@ export class FileImpl extends File implements Disposable {
       await ResponseUtils.throwError(`Failed to get file ${this.id}`, response)
     }
 
-    return (await response!.json()).progress as FileProgressDto
+    const content = await response!.json()
+    return content.progress as FileProgressDto
   }
 }

package/src/storages/file.ts

@@ -0,0 +1,28 @@
+import { FileProgressDto } from "../dto/workspacesResponse"
+
+export type FileId = string
+
+/**
+ * File.
+ */
+export abstract class File {
+  /**
+   * File id.
+   */
+  abstract get id(): FileId
+
+  /**
+   * File name.
+   */
+  abstract get name(): string
+
+  /**
+   * Get temporary url.
+   */
+  abstract url(): Promise<string>
+
+  /**
+   * Get file status.
+   */
+  abstract status(): Promise<FileProgressDto>
+}