@capsulajs/capsulahub-workspace

Workspace

The main core service of Capsulahub, it is responsible for:

• Loading services and components according to its configuration;
• Allowing services to register themselves;
• Letting services and components communicate together;
• Exposing to the services their configuration.

Install

NPM

To install the package from NPM registry you should run

yarn add @capsulajs/capsulahub-workspace

or

npm install @capsulajs/capsulahub-workspace

CDN

You can get the default export from the link

https://capsulajs.s3.amazonaws.com/develop/capsulahub-workspace/index.js

Exports

Default

WorkspaceFactory class.

Named (API)

The public API of Workspace.

Usage

Then you can create a Workspace as following:

import WorkspaceFactory, { API } from '@capsulajs/capsulahub-workspace';

const workspaceFactory = new WorkspaceFactory();

let workspace: API.Workspace;
workspaceFactory.createWorkspace({ 
  token: 'http://localhost:3000/configuration/workspace.json',
  configProvider: 'httpFile'
})
    .then((response) => {
      workspace = response;
      console.log('The workspace has been created', workspace)
    })
     .catch((error) => {
       console.log('an error has occurred while creating a workspace', error)
     });

API

CDN

The documentation about public API.

Local

Run

yarn doc

And open doc/index.html in browser.

Configuration

An example of WorkspaceConfiguration:

{
  "name": "baseWorkspace",
  "services": [
    {
      "serviceName": "ServiceA",
      "path": "http://localhost:3000/services/serviceA.js",
      "definition": {
        "serviceName": "ServiceA",
        "methods": {
          "greet": { "asyncModel": "requestResponse" }
        }
      },
      "config": { "serviceName": "serviceA", "message": "what pill would you choose: red or blue?" }
    },
    {
      "serviceName": "ServiceB",
      "path": "http://localhost:3000/services/serviceB.js",
      "definition": {
        "serviceName": "ServiceB",
        "methods": {
          "getRandomNumbers": { "asyncModel": "requestStream" }
        }
      },
      "config": { "serviceName": "serviceB" }
    }
  ],
  "components": {
    "layouts": {
      "capsulahub-root": {
        "componentName": "web-grid",
        "path": "http://localhost:3000/widgets/Grid.js",
        "config": { "title": "Base Grid" }
      }
    },
    "items": {
      "request-form": {
        "componentName": "web-request-form",
        "path": "http://localhost:3000/widgets/RequestForm.js",
        "config": { "title": "Base Request Form" }
      }
    }
  }
}

Configuration can be changed in cdn-emulator package in "./src/configuration". The name of json file should always be workspace.json.

The extensions also can be changed in cdn-emulator package (don't forget to update configuration file after creating new extensions).

Build

yarn build

Builds es-modules version (in lib folder) for NPM and bundle version (in dist folder) for CDN.

Example

In order to open a simple example you should run localhost:3000 with extensions included there.

In order to do it you should go to cdn-emulator package:

cd ../cdn-emulator

And run:

yarn start

In a different terminal you should go to workspace package:

cd packages/workspace

And run:

yarn start

You will be able to open an example on localhost:1234.

This example is also being used for running Cypress tests on it.

Extensions

If an error has happened while importing or bootstrapping of the extension, corresponding console.error will be shown.

Keep in mind, that if an error has happened before the registration of an extension, the promise of this this extension in ServicesMap or ComponentsMap will always stay in pending state.

Licence

CapsulaHub and related services are released under MIT Licence.

Back to the Main Page