open-index/open-npm huggingface dataset:
npm package: @hawtio/backend-middleware
Description: An Express middleware that implements Hawtio backend
Author: Hawtio developer team
Latest version: 1.0.8

# Hawtio Backend Middleware for Express

[![Test](https://github.com/hawtio/hawtio-backend-middleware/actions/workflows/test.yml/badge.svg)](https://github.com/hawtio/hawtio-backend-middleware/actions/workflows/test.yml)

An Express middleware that implements Hawtio backend.

## Installation

### NPM

```console
npm install --save-dev @hawtio/backend-middleware
```

### Yarn

```console
yarn add --dev @hawtio/backend-middleware
```

## Usage

You can use this backend with Express as follows:

```javascript
const express = require('express')
const { hawtioBackend } = require('@hawtio/backend-middleware')

const app = express()
app.get('/', (req, res) => {
  res.send('hello!')
})
app.use(
  '/proxy',
  hawtioBackend({
    // Uncomment it if you want to see debug log for Hawtio backend
    logLevel: 'debug',
  }),
)
app.listen(3333, () => {
  console.log('started')
})
```

To use it with Webpack, set up dev server's middlewares as follows:

```javascript
const { hawtioBackend } = require('@hawtio/backend-middleware')

module.exports = {
  devServer: {
    setupMiddlewares: middlewares => {
      middlewares.unshift({
        name: 'hawtio-backend',
        path: '/proxy',
        middleware: hawtioBackend({
          // Uncomment it if you want to see debug log for Hawtio backend
          logLevel: 'debug',
        }),
      })

      return middlewares
    },
  },
}
```
npm package: @hawtio/extension-service
Description: A plugin that provides an extension registration service and rendering directive.  Extension points are named locations in a UI that other plugins can register callbacks which will add to the DOM.
Latest version: 3.0.4
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

# hawtio-extension-service

A plugin that provides an extension registration service and rendering directive.  Extension points are named locations in a UI that other plugins can register callbacks which will add to the DOM.

## Installation

```
yarn add @hawtio/extension-service
```

## Usage

### Register an extension point callback

In your hawtio plugin you can register an extension point callback like:

```javascript
  var module = angular.module("MyAwesomePlugin", []);

  module.config(['HawtioExtension', function(HawtioExtension) {
    // Register an extension point callback that returns a string.
    // When a string is returned it will NOT be converted to HTML
    // but will be added as a text node.
    HawtioExtension.add("someExtensionPoint", function(scope){
      return "Some important text!";
    });

    // Register an extension point callback that returns a DOM element
    // When a DOM element is returned it will be appended to the containing
    // <div> of the extension point
    HawtioExtension.add("someExtensionPoint", function(scope){
      var div = document.createElement("div");
      div.className = "awesome";
      div.appendChild(document.createTextNode("I can add stuff!"));

      return div;
    });

    // Register an extension point callback that returns null.
    // Use this if you do not need to append something directly to the extension
    // point but want to make sure some javascript is run when that extension point
    // is rendered.
    HawtioExtension.add("someExtensionPoint", function(scope){
      // some javascript here that does whatever you want
      return null;
    });
  }]);

  hawtioPluginLoader.addModule("MyAwesomePlugin");
```

It is important to note that currently callbacks are rendered in the order they were registered.  In the future we may extend the registration API to include a priority.

### Render an extension point

Any plugin can choose to render all the registered callbacks for an extension point.

#### Using the directive in an angular template (recommended)

```html
<div>
  <h1>Some HTML template for my module</h1>
  <hawtio-extension name="someExtensionPoint"></hawtio-extension>
</div>
```

#### Using the render API

Using the directive method above is recommended in most cases, but does pass down whatever
the current scope is into the callbacks so that they have the same data available to them.
If you want to restrict the data passed down to the callbacks then you can call the service's
render API directly.

```javascript
// Where element is the DOM node that the results of all the callbacks
// will be appended to, and scope is whatever data you want to make available
// to the callbacks.
HawtioExtension.render(extensionPointName, element, scope);
```
npm package: @hawtio/help
Description: This plugin provides help documentation for hawtio by enabling other plugins to register their associated help documentation.
Latest version: 3.0.3
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

# hawtio-help

This plugin provides help documentation for hawtio by enabling other plugins to register their associated help documentation.

## Installation

```
yarn add @hawtio/help
```

## Set up development environment

### Clone the repository

```
git clone https://github.com/hawtio/hawtio-help
cd hawtio-help
```

### Install development tools

* [Node.js](http://nodejs.org)
* [Yarn](https://yarnpkg.com)
* [gulp](http://gulpjs.com/)

### Install project dependencies

```
yarn install
```

### Run the demo web application

```
yarn start
```

### Change the default proxy port

To proxy to a local JVM running on a different port than `8282` specify the `--port` CLI argument:
```
yarn start -- --port=8181
```
### Turn on source maps generation for debugging TypeScript

If you want to debug `.ts` using a browser developer tool such as Chrome DevTools, pass the `--sourcemap` flag:
```
yarn start -- --sourcemap
```

Do not use this flag when you are committing the compiled `.js` file, as it embeds source maps to the output file. Use this flag only during development.
npm package: @hawtio/integration
Description: [![Test](https://github.com/hawtio/hawtio-integration/actions/workflows/test.yml/badge.svg)](https://github.com/hawtio/hawtio-integration/blob/main/.github/workflows/test.yml)
Latest version: 4.16.14

# hawtio-integration

[![Test](https://github.com/hawtio/hawtio-integration/actions/workflows/test.yml/badge.svg)](https://github.com/hawtio/hawtio-integration/blob/main/.github/workflows/test.yml)

This project provides ActiveMQ, Camel, Karaf and Spring Boot plugins for hawtio.

## Installation

```
yarn add @hawtio/integration
```

## Set up development environment

### Clone the repository

```
git clone https://github.com/hawtio/hawtio-integration
cd hawtio-integration
```

### Install development tools

* [Node.js](http://nodejs.org)
* [Yarn](https://yarnpkg.com)
* [gulp](http://gulpjs.com/)

### Install project dependencies

```
yarn install
```

## Developing

### Run the web application

```
yarn start
```

### Change the default proxy port

To proxy to a local JVM running on a different port than `8282` specify the `--port` CLI arguement to gulp:
```
yarn start -- --port=8181
```

### Output build to a different directory

When developing this plugin in a dependent console you can change the output directory where the compiled `.js` and `.css` go.  Just use the `--out` flag to set a different output directory, for example:
```
gulp watch --out=../fabric8-console/libs/hawtio-integration/dist/
```

Whenever the build completes the compiled `.js` file will be put into the target directory.  Don't forget to first do a `gulp build` without this flag before committing changes!

### Turn on source maps generation for debugging TypeScript

If you want to debug `.ts` using a browser developer tool such as Chrome DevTools, pass the `--sourcemap` flag to gulp:

```
gulp --sourcemap
```

Do not use this flag when you are committing the compiled `.js` file, as it embeds source maps to the output file. Use this flag only during development.

### Upgrade Apache Camel

In order to support the latest Camel meta model in Camel plugin, you need to update the [camelModel.js](vendor/apache-camel/camelModel.js) with the latest `camel-catalog`. To do so, first update the Camel version in the `camel-model-generator` [pom.xml](vendor/apache-camel/pom.xml):

```
    <version.org.apache.camel>2.23.0</version.org.apache.camel>
```
then run the following yarn script:
```
yarn update-camel-model
```
npm package: @hawtio/jmx
Description: [![CircleCI](https://circleci.com/gh/hawtio/hawtio-jmx.svg?style=svg)](https://circleci.com/gh/hawtio/hawtio-jmx)
Latest version: 4.5.0
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

# hawtio-jmx

[![CircleCI](https://circleci.com/gh/hawtio/hawtio-jmx.svg?style=svg)](https://circleci.com/gh/hawtio/hawtio-jmx)

This plugin provides JMX for Hawtio.

## Installation

```
yarn add @hawtio/jmx
```

## Set up development environment

### Clone the repository

```
git clone https://github.com/hawtio/hawtio-jmx
cd hawtio-jmx
```

### Install development tools

* [Node.js](http://nodejs.org)
* [Yarn](https://yarnpkg.com)
* [gulp](http://gulpjs.com/)

### Install project dependencies

```
yarn install
```

### Run the web application

```
yarn start
```

### Turn on source maps generation for debugging TypeScript

If you want to debug `.ts` using a browser developer tool such as Chrome DevTools, pass the `--sourcemap` flag:

```
yarn start --sourcemap
```

Do not use this flag when you are committing the compiled `.js` file, as it embeds source maps to the output file. Use this flag only during development.
npm package: @hawtio/log
Description: This plugin shows log information from the managed services.
Latest version: 3.3.1
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

# hawtio-log

This plugin shows log information from the managed services.

## Installation

```
yarn add @hawtio/log
```

## Set up development environment

### Clone the repository

```
git clone https://github.com/hawtio/hawtio-log
cd hawtio-log
```

### Install development tools

* [Node.js](http://nodejs.org)
* [Yarn](https://yarnpkg.com)
* [gulp](http://gulpjs.com/)

### Install project dependencies

```
yarn install
```

### Run the web application

```
yarn start
```

### Change the default proxy port

To proxy to a local JVM running on a different port than `8282` specify the `--port` CLI argument:
```
yarn start -- --port=8181
```

### Turn on source maps generation for debugging TypeScript

If you want to debug `.ts` using a browser developer tool such as Chrome DevTools, pass the `--sourcemap` flag:

```
yarn start -- --sourcemap
```

Do not use this flag when you are committing the compiled `.js` file, as it embeds source maps to the output file. Use this flag only during development.
npm package: @hawtio/node-backend
Description: Backend services for hawtio v3
Latest version: 4.1.4
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

## hawtio-node-backend

A simple node backend for hawtio 2.x that can either be run from a gulpfile or as an independent server.  The server can serve out static assets, has a dynamic proxy and also supports configuring static proxies to backend services.

### Configuration

The backend can be configured either via a config.js file:

```
// default config values
var config = {
  // server listen port
  port: 2772,
  // log level
  logLevel: logger.DEBUG,
  // path to mount the dyamic proxy
  proxy: '/proxy',
  // paths to connect to external services, an example config:
  // {
  //   proto: 'http',
  //   hostname: 'localhost',
  //   port: 8282,
  //   path: '/hawtio/jolokia',
  //   targetPath: '/hawtio/jolokia'
  // }
  //
  staticProxies: [],
  // directories to search for static assets
  staticAssets: [
    '/assets'
  ],
  liveReload: {
    enabled: false,
    port: 35729
  }
}
module.exports = config;
```

Or if using from a gulp file you can do:

```
var HawtioBackend = require('hawtio-node-backend');
HawtioBackend.setConfig({
  port: 2332,
  staticProxies: [{
    port: 8282,
    path: '/jolokia',
    targetPath: '/hawtio/jolokia'
  }],
  staticAssets: [{
    path: '/',
    dir: '.'
  }],
  liveReload: {
    enabled: true
  }
});
```

### Full live reload gulpfile set up

It's very similar to gulp-connect:

```
var HawtioBackend = require('hawtio-node-backend');

gulp.task('watch', function() {
  plugins.watch(['assets/*'], function() {
    gulp.start(['reload']);
  });
});

gulp.task('reload', function() {
  gulp.src('.')
    .pipe(HawtioBackend.reload());
});

gulp.task('server', function() {
  HawtioBackend.setConfig({
    logLevel: require('js-logger').DEBUG,
    port: 8080,
    staticProxies: [{
      port: 8282,
      path: '/hawtio/jolokia',
      targetPath: '/hawtio/jolokia'
    }],
    staticAssets: [{
      path: '/',
      dir: '.'
    }],
    liveReload: {
      enabled: true
    }
  });
  HawtioBackend.listen(function(server) {
    var host = server.address().address;
    var port = server.address().port;
    console.log("started from gulp file at ", host, ":", port);
  });
});

```
npm package: @hawtio/preferences
Description: [![CircleCI](https://circleci.com/gh/hawtio/hawtio-preferences.svg?style=svg)](https://circleci.com/gh/hawtio/hawtio-preferences)
Latest version: 3.0.13
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

# hawtio-preferences

[![CircleCI](https://circleci.com/gh/hawtio/hawtio-preferences.svg?style=svg)](https://circleci.com/gh/hawtio/hawtio-preferences)

This plugin provides preferences functionality for hawtio, allowing custom plugins to register their own preference, which are then shown from the user preference menu.

## Installation

```
yarn add @hawtio/preferences
```

## Set up development environment

### Clone the repository

```
git clone https://github.com/hawtio/hawtio-preferences
cd hawtio-preferences
```

### Install development tools

* [Node.js](http://nodejs.org)
* [Yarn](https://yarnpkg.com)
* [gulp](http://gulpjs.com/)

### Install project dependencies

```
yarn install
```

### Run the demo web application

```
yarn start
```

### Turn on source maps generation for debugging TypeScript

If you want to debug `.ts` using a browser developer tool such as Chrome DevTools, pass the `--sourcemap` flag:
```
yarn start -- --sourcemap
```
Do not use this flag when you are committing the compiled `.js` file, as it embeds source maps to the output file. Use this flag only during development.
npm package: @hawtio/template-cache
Description: A module that wraps/extends the existing $templateCache and $templateRequest services from angular.  Use this module when you embed all of your templates into the $templateCache service, then use this plugin to ensure that $templateRequest doesn't try and
Latest version: 3.0.5
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

## hawtio-template-cache

A module that wraps/extends the existing $templateCache and $templateRequest services from angular.  Use this module when you embed all of your templates into the $templateCache service, then use this plugin to ensure that $templateRequest doesn't try and fetch templates from your server, especially when you've a lot of plugins and templates.
npm package: @hawtio/ui
Description: [![CircleCI](https://circleci.com/gh/hawtio/hawtio-ui.svg?style=svg)](https://circleci.com/gh/hawtio/hawtio-ui)
Latest version: 4.5.0
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

## hawtio-ui

[![CircleCI](https://circleci.com/gh/hawtio/hawtio-ui.svg?style=svg)](https://circleci.com/gh/hawtio/hawtio-ui)

This plugin contains a number of UI widgets and dependencies for hawtio 2.x projects.

For more information please take a look at the [live demo website](http://ui.hawt.io).

## Installation

```
yarn add @hawtio/ui
```

## Set up development environment

### Clone the repository

```
git clone https://github.com/hawtio/hawtio-ui
cd hawtio-ui
```

### Install development tools

* [Node.js](http://nodejs.org)
* [Yarn](https://yarnpkg.com)
* [gulp](http://gulpjs.com/)

### Install project dependencies

```
yarn install
```

### Run the web application

```
yarn start
```

### Working on the code

Have a look at the hawtio 2.x [overview document](https://github.com/hawtio/hawtio/blob/master/docs/Overview2dotX.md) under "Getting Started" specifically.
npm package: @hawtio/utilities
Description: This module contains various helper functions and some classes that can be used by hawtio plugins.
Latest version: 3.2.3
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

## hawtio-utilities

This module contains various helper functions and some classes that can be used by hawtio plugins.

## Installation

```
yarn add @hawtio/utilities
```

## Set up development environment

### Clone the repository

```
git clone https://github.com/hawtio/hawtio-utilities
cd hawtio-utilities
```

### Install development tools

* [Node.js](http://nodejs.org)
* [Yarn](https://yarnpkg.com)
* [gulp](http://gulpjs.com/)

### Install project dependencies

```
yarn install
```

### Run the demo web application

```
yarn start
```

### Change the default proxy port

To proxy to a local JVM running on a different port than `8282` specify the `--port` CLI arguement:
```
yarn start --port=8181
```