Plugin system

Table of contents

• Folder structure
• Commands
• Build plugin
• Build product
  • Commands
• Development
• Static assets
• Localization
• How to add custom plugin

Folder structure

Plugin structure can be found on Frontend development guidelines

Commands

Execute from cloudbeaver/webapp
yarn run bootstrap

Load all dependencies and init workspaces
yarn run build

Build all packages (plugins and the application) and the result will be placed in the packages/{package-name}/lib folder
yarn run lint

Lint all code
yarn run lint-fix

Lint all code and fix

Build plugin

To build a single plugin execute

yarn lerna run build --stream --scope=@cloudbeaver/plugin-name

Build product

Product folder structure can be found on Frontend development guidelines
The only difference in the build command is:
"build": "core-cli-build --mode=production --config ../core-cli/configs/webpack.product.config.js",
it uses product config, also contains dev command for starting development local build
"dev": "core-cli-build serve --mode=development --progress --config=../core-cli/configs/webpack.product.dev.config.js",

The application package simple defines the list of plugins that should be included in the build

Commands

Execute the command to build only the application without rebuilding the plugins
yarn lerna run build --stream --scope=@cloudbeaver/product-name

Development

1. To run a development build that watches file changes and rebuilds, you can use the dev command:
   yarn lerna run dev --stream --scope=@cloudbeaver/product-default -- -- --env server=http://backend.server:8095
   It starts the dev server for product-default. It also proxies backend requests to http://backend.server:8095

2. Navigate localhost:8080 to open the application

Static assets

You can keep static assets like images, favicon, etc in the public folder in the plugin packages or app package.

Assets such as these will be copied to the application distributive. Assets with the same name will overwrite one another, but the Application public assets have higher priority over them all.

Localization

See the example in the core-administration AdministrationLocaleService.ts and locales folder

Custom plugin

If you want to add a custom plugin and extend the app's functionality, follow these steps:

1. Create a folder named as desired, for example, [plugin-custom], inside /webapp/packages.
2. Copy the .gitignore, package.json, and tsconfig.json files from any existing package.
3. Update the name field in package.json to your plugin's name, for example, @cloudbeaver/plugin-custom. Remove the dependencies and devDependencies sections.
4. Delete the references section from tsconfig.json.
5. Create a src folder. Inside this folder, create index.ts and manifest.ts. Export manifest.ts from index.ts.
6. Create an entry service for your plugin. This must be an injectable class that extends the Bootstrap class. Implement the register method to add buttons, panels and etc to different parts of the app, depending on your requirements.
7. Add this service to manifest.ts.
8. Navigate to packages/product-default/src/index.ts (Community Edition) and register your plugin by importing it and adding it to the plugins array.
9. Run yarn run update-ts-references in your console from the /webapp folder.
10. Start the development server. You should see the new functionality in the app.