@neuralinnovations/dataisland-sdk 0.0.1-dev1

package/.browserslistrc

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

package/.editorconfig

@@ -0,0 +1,22 @@
+# 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

@@ -0,0 +1,44 @@
+{
+  "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

@@ -0,0 +1,28 @@
+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

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

package/.prettierrc

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

package/.yarnrc

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

package/README.md

@@ -0,0 +1,7 @@
+# DataIsland Client SDK
+
+```typescript
+
+
+
+```

package/babel.config.js

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

package/jest.config.ts

@@ -0,0 +1,199 @@
+/**
+ * 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: [],
+
+  // 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/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@neuralinnovations/dataisland-sdk",
+  "version": "0.0.1-dev1",
+  "description": "SDK for DataIsland project",
+  "licenses": [
+    {
+      "type": "Apache-2.0",
+      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
+    }
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "jest",
+    "lint": "eslint --ext .ts,.tsx src"
+  },
+  "author": "Neural Innovations LTD",
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "@babel/core": "^7.22.11",
+    "@babel/plugin-transform-modules-commonjs": "7.22.11",
+    "@babel/preset-env": "^7.22.10",
+    "@babel/preset-typescript": "^7.23.3",
+    "@babel/register": "7.22.5",
+    "@jest/globals": "^29.7.0",
+    "@types/jest": "^29.5.11",
+    "@typescript-eslint/eslint-plugin": "^6.19.0",
+    "@typescript-eslint/parser": "^6.19.0",
+    "babel-jest": "^29.7.0",
+    "babel-loader": "8.3.0",
+    "eslint": "^8.56.0",
+    "eslint-config-semistandard": "^17.0.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-config-standard-with-typescript": "^43.0.0",
+    "eslint-config-xo": "^0.43.1",
+    "eslint-config-xo-typescript": "^1.0.1",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-n": "^15.7.0",
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-react": "^7.33.2",
+    "glob": "7.2.3",
+    "jest": "^29.7.0",
+    "prettier": "2.8.7",
+    "ts-jest": "^29.1.1",
+    "ts-loader": "8.4.0",
+    "ts-node": "10.9.1",
+    "tslib": "^2.6.2",
+    "tslint": "6.1.3",
+    "typedoc": "^0.25.7",
+    "typescript": "^5.3.3",
+    "watch": "^0.13.0",
+    "webpack": "5.76.0",
+    "yargs": "17.7.2"
+  },
+  "dependencies": {
+    "jsdom": "^23.2.0"
+  }
+}

package/src/appBuilder.ts

@@ -0,0 +1,39 @@
+import type { Middleware } from './middleware'
+import type { CredentialBase } from './credentials'
+import type { Service, ServiceContext } from './services/service'
+import type { Constructor } from './internal/registry'
+
+/**
+ * DataIsland App builder.
+ */
+export abstract class AppBuilder {
+  /**
+   * Add a middleware to the app.
+   */
+  abstract addMiddleware(middleware: Middleware): AppBuilder
+
+  /**
+   * Host of the app.
+   */
+  abstract useHost(host: string): AppBuilder
+
+  /**
+   * GDPR compliant
+   */
+  abstract useAutomaticDataCollectionEnabled(value: boolean): AppBuilder
+
+  /**
+   * Credential of the app.
+   */
+  abstract useCredential(credential: CredentialBase): AppBuilder
+
+  /**
+   * Register a service to the app.
+   * @param type
+   * @param factory
+   */
+  abstract registerService<T extends Service>(
+    type: Constructor<T>,
+    factory: (context: ServiceContext) => T
+  ): AppBuilder
+}

package/src/appSdk.ts

@@ -0,0 +1,40 @@
+import type { Lifetime } from './disposable'
+import type { CredentialBase } from './credentials'
+import type { Constructor } from './internal/registry'
+
+/**
+ * DataIsland App instance.
+ */
+export interface AppSdk {
+  /**
+   * The name of this app.
+   */
+  get name(): string
+
+  /**
+   * The host of this app.
+   */
+  get host(): string
+
+  /**
+   * The automaticDataCollectionEnabled of this app.
+   */
+  get automaticDataCollectionEnabled(): boolean
+
+  /**
+   * The lifetime of this app.
+   */
+  get lifetime(): Lifetime
+
+  /**
+   * The credential of this app.
+   */
+  get credential(): CredentialBase | undefined
+
+  set credential(value: CredentialBase)
+
+  /**
+   * Gets the service registered with the given type.
+   */
+  resolve: <T>(type: Constructor<T>) => T | undefined
+}

package/src/credentials.ts

@@ -0,0 +1,63 @@
+import { MiddlewareService } from './services/middlewareService'
+import { type Lifetime } from './disposable'
+import { type Context } from './internal/context'
+
+/**
+ * DataIsland App credential.
+ */
+export abstract class CredentialBase {
+  abstract onRegister(lifetime: Lifetime, context: Context): void
+}
+
+export class DefaultCredential extends CredentialBase {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  onRegister(lifetime: Lifetime, context: Context): void {
+    // Do nothing.
+  }
+}
+
+export class BasicCredential extends CredentialBase {
+  readonly email: string
+  readonly password: string
+
+  constructor(email: string, password: string) {
+    super()
+    this.email = email
+    this.password = password
+  }
+
+  onRegister(lifetime: Lifetime, context: Context): void {
+    const service = context.resolve(MiddlewareService)
+    if (service === undefined) {
+      throw new Error('MiddlewareService is not registered.')
+    }
+    lifetime.add(
+      service.useMiddleware(async (req, next) => {
+        req.headers.set('Authorization', `Basic ${this.email}:${this.password}`)
+        await next(req)
+      })
+    )
+  }
+}
+
+export class BearerCredential extends CredentialBase {
+  readonly token: string
+
+  constructor(token: string) {
+    super()
+    this.token = token
+  }
+
+  onRegister(lifetime: Lifetime, context: Context): void {
+    const service = context.resolve(MiddlewareService)
+    if (service === undefined) {
+      throw new Error('MiddlewareService is not registered.')
+    }
+    lifetime.add(
+      service.useMiddleware(async (req, next) => {
+        req.headers.set('Authorization', `Bearer ${this.token}`)
+        await next(req)
+      })
+    )
+  }
+}

package/src/disposable.ts

@@ -0,0 +1,151 @@
+/**
+ * Represents an object that can be disposed.
+ */
+export interface Disposable {
+  dispose: () => void
+}
+
+/**
+ * Represents a lifetime.
+ */
+export class Lifetime {
+  constructor(private readonly container: DisposableContainer) {}
+
+  /**
+   * Define a new nested disposable to this lifetime.
+   */
+  public defineNested(): DisposableContainer {
+    return this.container.defineNested()
+  }
+
+  /**
+   * Shows whether this lifetime is disposed.
+   */
+  public get isDisposed(): boolean {
+    return this.container.isDisposed
+  }
+
+  /**
+   * Adds a disposable to this lifetime.
+   */
+  public add(disposable: Disposable): this {
+    this.container.add(disposable)
+    return this
+  }
+
+  /**
+   * Adds a callback to this lifetime.
+   */
+  public addCallback(callback: () => void, target?: unknown): this {
+    this.container.addCallback(callback, target)
+    return this
+  }
+}
+
+/**
+ * A container for disposables.
+ * Last added, first disposed.
+ * @example
+ * const container = new DisposableContainer();
+ * container.add(someDisposable);
+ * container.addCallback(() => console.log('disposed'));
+ * container.dispose();
+ */
+export class DisposableContainer implements Disposable {
+  private _disposables: Disposable[] = []
+  private _isDisposed = false
+  private _lifetime?: Lifetime
+
+  /**
+   * Gets whether this container is disposed.
+   */
+  public get isDisposed(): boolean {
+    return this._isDisposed
+  }
+
+  /**
+   * Define new lifetime.
+   */
+  public get lifetime(): Lifetime {
+    return this._lifetime ?? (this._lifetime = new Lifetime(this))
+  }
+
+  /**
+   * Adds a disposable to this container.
+   * @param disposable The disposable to add.
+   * @returns The disposable container.
+   */
+  public add(disposable: Disposable): Disposable {
+    this._throwIfDisposed()
+    this._disposables.push(disposable)
+    return disposable
+  }
+
+  /**
+   * Adds a callback to be executed when this container is disposed.
+   * @param callback The callback to execute.
+   * @param target The target to bind the callback to.
+   * @returns The disposable container.
+   */
+  public addCallback(callback: () => void, target?: unknown): Disposable {
+    this._throwIfDisposed()
+    return this.add({
+      dispose() {
+        callback.call(target)
+      }
+    })
+  }
+
+  /**
+   * Defines a nested disposable container.
+   */
+  defineNested(): DisposableContainer {
+    const nested = new DisposableContainer()
+    this._disposables.push(nested)
+    nested.addCallback(() => {
+      const index = this._disposables.indexOf(nested)
+      if (index > -1) {
+        this._disposables.splice(index, 1)
+      }
+    }, this)
+    return nested
+  }
+
+  /**
+   * Disposes all disposables in this container. Last added, first disposed.
+   */
+  public dispose(): void {
+    this._throwIfDisposed()
+    this._isDisposed = true
+    this._disposables
+      .slice()
+      .reverse()
+      .forEach(it => {
+        it.dispose()
+      })
+    this._disposables = []
+  }
+
+  /**
+   * Throws an error if this container is disposed.
+   */
+  private _throwIfDisposed(): void {
+    if (this._isDisposed) {
+      throw new Error('Object disposed')
+    }
+  }
+}
+
+/**
+ * Creates a disposable.
+ * @param action The action to execute when disposed.
+ * @param target The target to bind the action to.
+ * @returns The disposable.
+ */
+export function disposable(action: () => void, target: unknown): Disposable {
+  return new DisposableContainer().addCallback(() => {
+    action.call(target)
+  })
+}
+
+export const eternalLifetime = new DisposableContainer().lifetime