open-index/open-npm huggingface dataset:
npm package: @imperium/auth
Description: Basic Auth Imperium package
Author: Mike Kornelson
Latest version: 3.2.0
Deprecated: Restructured Imperium. This package has been deprecated.

---
id: auth
title: @imperium/auth
sidebar_label: auth
---

[![Coverage_badge](../../docs/assets/coverage/auth/coverage.svg)](assets/coverage/auth/index.html) [![Greenkeeper badge](https://badges.greenkeeper.io/darkadept/imperium.svg)](https://greenkeeper.io/)
npm package: @imperium/auth-client
Description: Imperium Auth client package
Author: MYMC
Latest version: 14.3.4

# @imperium/auth-client

[![Coverage_badge](../../docs/assets/coverage/auth-client/coverage.svg)](assets/coverage/auth-client/index.html)
[![GitHub tag](https://img.shields.io/github/tag/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/tags/)
[![GitHub issues](https://img.shields.io/github/issues/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/issues/)
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/pull/)

[![GitHub license](https://img.shields.io/github/license/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/blob/master/LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/graphs/contributors/)

# About
This is an Imperium client module providing authentication and authorization support for a web client.

The major parts of this package are:
  * Imperium client module

The Imperium feature module tracks if a user is logged in. It also creates a cache for authorization information. The user
information is persisted in Local Storage. The authorization cache is persisted in an IndexedDB.

# Environment Variables
These can be specified in an `env.js` file. These are not secret or protected!

| Variable                     | Default                 | Description                                                    |
|------------------------------|-------------------------|----------------------------------------------------------------|
| IMP_PERMISSION_CACHE_EXPIRES | 3600                    | Number of seconds to expire the client side permissions cache. |
| IMP_API_URL                  | 'http://localhost:4001' | The URL of the api endpoint.                                   |
| authAccessTokenKey           | 'access'                | The local storage key that the access token is stored at.      |
| authIdKey                    | 'id'                    | The local storage key that the id is stored at.                |
| authRefreshUrl               | '/api/refresh'          | What the refresh endpoint is accessible at.                    |
| authLoginUrl                 | '/api/login'            | What the login endpoint is accessible at.                      |
| authForgotPasswordUrl        | '/api/forgot-password'  | What the forgot password endpoint is accessible at.            |
| authPermissionUrl            | '/api/auth              | What the permission endpoint is accessible at.                 |
npm package: @imperium/auth-graphql-client
Description: Imperium Auth Graphql client package
Author: MYMC
Latest version: 14.4.1

# @imperium/auth-graphql-client

[![Coverage_badge](../../docs/assets/coverage/auth-graphql-client/coverage.svg)](assets/coverage/auth-client/index.html)
[![GitHub tag](https://img.shields.io/github/tag/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/tags/)
[![GitHub issues](https://img.shields.io/github/issues/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/issues/)
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/pull/)

[![GitHub license](https://img.shields.io/github/license/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/blob/master/LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/graphs/contributors/)

# Environment Variables
These can be specified in an `env.js` file. These are not secret or protected!

| Variable                     | Default                 | Description                                                    |
|------------------------------|-------------------------|----------------------------------------------------------------|
| authAccessTokenKey           | 'access'                | The local storage key that the access token is stored at.      |
| authIdKey                    | 'id'                    | The local storage key that the id is stored at.                |
npm package: @imperium/auth-server
Description: Imperium Auth server package
Author: MYMC
Latest version: 14.4.1

# @imperium/auth-server

[![Coverage_badge](../../docs/assets/coverage/auth-server/coverage.svg)](assets/coverage/auth-server/index.html)
[![GitHub tag](https://img.shields.io/github/tag/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/tags/)
[![GitHub issues](https://img.shields.io/github/issues/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/issues/)
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/pull/)

[![GitHub license](https://img.shields.io/github/license/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/blob/master/LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/graphs/contributors/)

## Environment Variables
These can be specified in a `.env` file in the server package. These variables are secret and not shared with the client.

| Variable                        | Default                | Description                                                   |
|---------------------------------|------------------------|---------------------------------------------------------------|
| IMP_AUTH_DOMAIN                 | 'localhost'            | Which domain is the auth server running on. Used for cookies. |
| IMP_LOGIN_URL                   | '/api/login'           | URL for REST login.                                           |
| IMP_REFRESH_URL                 | '/api/refresh'         | URL for REST refresh access token.                            |
| IMP_RESET_URL                   | '/api/forgot-password' | URL to request password reset.                                |
| IMP_PERMISSION_URL              | '/api/auth'            | URL for REST permissions.                                     |
| IMP_ACCESS_TOKEN_SECRET         | 'notsecure'            | Secret for access tokens.                                     |
| IMP_TOKEN_ALGORITHMS            | 'HS256'                | CSV list of valid access/refresh token algorithms             |
| IMP_REFRESH_TOKEN_SECRET        | 'notsecure'            | Secret for refresh tokens.                                    |
| IMP_ACCESS_TOKEN_EXPIRES        | '5m'                   | How often an access token expires.                            |
| IMP_REFRESH_TOKEN_EXPIRES_SHORT | '1d'                   | How often a refresh token expires.                            |
| IMP_REFRESH_TOKEN_EXPIRES_LONG  | '7d'                   | How often a refresh token expires.                            |
| IMP_LOGIN_MAX_FAIL              | 5                      | How many failed login attempts allowed.                       |
| IMP_LOGIN_MAX_COOLDOWN          | 300                    | How many seconds to lock failed login attempts out.           |
| IMP_REFRESH_COOKIE_NAME         | 'refresh'              | What cookie name is the refresh token stored as?              |
npm package: @imperium/authorization
Description: Imperium Authorization package
Author: MYMC
Latest version: 14.0.0

# @imperium/authorization

[![Coverage_badge](../../docs/assets/coverage/authorization/coverage.svg)](assets/coverage/authorization/index.html)
[![GitHub tag](https://img.shields.io/github/tag/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/tags/)
[![GitHub issues](https://img.shields.io/github/issues/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/issues/)
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/pull/)

[![GitHub license](https://img.shields.io/github/license/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/blob/master/LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/graphs/contributors/)

# Environment Variables

| Variable                             | Default | Description                                           |
|--------------------------------------|---------|-------------------------------------------------------|
| IMP_PERMISSION_CACHE_EXPIRES         | 3600    | How long does the permission caching last in seconds. |
| IMP_PERMISSION_DATALOADER_LRU_MAX    | 500     | Max number of items in permission dataloader cache    |
| IMP_PERMISSION_DATALOADER_LRU_MAXAGE | 60      | Number of seconds when permission cache items expire. |
npm package: @imperium/babel-preset-imperium
Description: Babel preset used by Imperium.
Latest version: 9.0.0

# @imperium/babel-preset-imperium

[![Coverage_badge](../../docs/assets/coverage/babel-preset-imperium/coverage.svg)](assets/coverage/babel-preset-imperium/index.html)
[![GitHub tag](https://img.shields.io/github/tag/darkadept/imperium.svg)](https://github.com/darkadept/imperium/tags/)
[![GitHub issues](https://img.shields.io/github/issues/darkadept/imperium.svg)](https://github.com/darkadept/imperium/issues/)
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/darkadept/imperium.svg)](https://GitHub.com/darkadept/imperium/pull/)

[![GitHub license](https://img.shields.io/github/license/darkadept/imperium.svg)](https://github.com/darkadept/imperium/blob/master/LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/darkadept/imperium.svg)](https://github.com/darkadept/imperium/graphs/contributors/)

This package includes the Babel preset used by [Imperium Framework](https://github.com/darkadept/imperium).

## Usage

Install the preset.

```bash
yarn add @imperium/babel-preset-imperium -D
```

## Options

#### `client`

`boolean`, defaults to `false`.

If `true` uses Babel options for create javascript code that runs in a browser. If `false` creates
code that runs in Node.

#### `debug`

`boolean`, defaults to `false`,

See [babel-preset-env](https://babeljs.io/docs/en/babel-preset-env/#debug)'s debug option.

#### `forceModules`

`boolean`, defaults to `false`.

Normally module transformations are on (commonjs) for `client` mode and off for `server` mode.
This can force modules to be transformed.

#### `react`

`boolean`, defaults to `false`.

Enables the React preset, even on the server.

#### `typescript`

`boolean`, defaults to `false`.

Enables the Typescript preset.

#### `graphqls`

`boolean`, defaults to `false`.

Enables including `*.graphqls` files using Babel.

#### `decorators`

`boolean`, defaults to `true`.

Enables support for decorators.
npm package: @imperium/client
Description: Imperium client core
Author: MYMC
Latest version: 14.0.0

# @imperium/client

[![Coverage_badge](../../docs/assets/coverage/client/coverage.svg)](assets/coverage/client/index.html)
[![GitHub tag](https://img.shields.io/github/tag/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/tags/)
[![GitHub issues](https://img.shields.io/github/issues/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/issues/)
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/pull/)

[![GitHub license](https://img.shields.io/github/license/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/blob/master/LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/graphs/contributors/)
npm package: @imperium/cluster
Description: Imperium cluster wrapper
Author: MYMC
Latest version: 14.0.0

## Environment Variables
These can be specified in a `.env` file in the server package. These variables are secret and not shared with the client.

| Variable               | Default | Description                                                                                    |
|------------------------|---------|------------------------------------------------------------------------------------------------|
| IMP_PROCESSES          | 1       | The number of worker processes to start. 0 means autodetect.                                   |
| IMP_WORKER_CRASH_DELAY | 4000    | Milliseconds to wait before restarting a worker process instead of counting towards crash max. |
| IMP_WORKER_CRASH_MAX   | 5       | Number of times a worker is allowed to crash before killing the server.                        |
npm package: @imperium/connector
Description: Imperium Connector package
Author: MYMC
Latest version: 14.0.0

# @imperium/connector

[![Coverage_badge](../../docs/assets/coverage/connector/coverage.svg)](assets/coverage/connector/index.html)
[![GitHub tag](https://img.shields.io/github/tag/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/tags/)
[![GitHub issues](https://img.shields.io/github/issues/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/issues/)
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/pull/)

[![GitHub license](https://img.shields.io/github/license/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/blob/master/LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/graphs/contributors/)
npm package: @imperium/context
Description: Imperium context package
Author: Mike Kornelson
Latest version: 2.1.1
Deprecated: Restructured Imperium. This package has been deprecated.

---
id: context
title: @imperium/context
sidebar_label: context
---

[![Coverage_badge](../../docs/assets/coverage/context/coverage.svg)](assets/coverage/context/index.html) [![Greenkeeper badge](https://badges.greenkeeper.io/darkadept/imperium.svg)](https://greenkeeper.io/)
npm package: @imperium/context-manager
Description: Imperium Context Manager package
Author: Mike Kornelson
Latest version: 4.2.0

# @imperium/context-manager

[![Coverage_badge](../../docs/assets/coverage/graphql-server/coverage.svg)](assets/coverage/graphql-server/index.html)
[![GitHub tag](https://img.shields.io/github/tag/darkadept/imperium.svg)](https://github.com/darkadept/imperium/tags/)
[![GitHub issues](https://img.shields.io/github/issues/darkadept/imperium.svg)](https://github.com/darkadept/imperium/issues/)
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/darkadept/imperium.svg)](https://GitHub.com/darkadept/imperium/pull/)

[![GitHub license](https://img.shields.io/github/license/darkadept/imperium.svg)](https://github.com/darkadept/imperium/blob/master/LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/darkadept/imperium.svg)](https://github.com/darkadept/imperium/graphs/contributors/)
npm package: @imperium/core
Description: Core Imperium package
Author: Mike Kornelson
Latest version: 3.2.0
Deprecated: Restructured Imperium. This package has been deprecated.

---
id: core
title: @imperium/core
sidebar_label: core
---

[![Coverage_badge](../../docs/assets/coverage/core/coverage.svg)](assets/coverage/core/index.html) [![Greenkeeper badge](https://badges.greenkeeper.io/darkadept/imperium.svg)](https://greenkeeper.io/)
npm package: @imperium/dev
Description: Imperium Development package
Author: Mike Kornelson
Latest version: 9.0.0

# @imperium/dev

[![GitHub tag](https://img.shields.io/github/tag/darkadept/imperium.svg)](https://github.com/darkadept/imperium/tags/)
[![GitHub issues](https://img.shields.io/github/issues/darkadept/imperium.svg)](https://github.com/darkadept/imperium/issues/)
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/darkadept/imperium.svg)](https://GitHub.com/darkadept/imperium/pull/)

[![GitHub license](https://img.shields.io/github/license/darkadept/imperium.svg)](https://github.com/darkadept/imperium/blob/master/LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/darkadept/imperium.svg)](https://github.com/darkadept/imperium/graphs/contributors/)

## Environment Variables
These can be specified in a `.env` file.

|Variable|Default|Description|
|---|---|---|
|PROCESSES|Number of CPU's|How many processes should the server instance fork into. In development it's always 1.|
|SERVER_PORT|4001|What port the server is accessible at. (Used for display only when developing your server code.)|
|DEBUG| |Specify debug namespaces to view.|
npm package: @imperium/dev-deps
Description: Imperium development dependencies
Latest version: 3.0.0
Deprecated: Restructured Imperium. This package has been deprecated.

---
id: devdeps
title: @imperium/dev-deps
sidebar_label: dev-deps
---

This simple package depends on all the dependencies needed for developing applications.

This package doesn't satfisy `peerDependencies` unfortunately but it does cut down on the
number of packages in `package.json` files.
npm package: @imperium/domaindriven
Description: Imperium Domain Driven Design package
Author: MYMC
Latest version: 14.4.0

# @imperium/connector

[![Coverage_badge](../../docs/assets/coverage/connector/coverage.svg)](assets/coverage/connector/index.html)
[![GitHub tag](https://img.shields.io/github/tag/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/tags/)
[![GitHub issues](https://img.shields.io/github/issues/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/issues/)
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/pull/)

[![GitHub license](https://img.shields.io/github/license/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/blob/master/LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/graphs/contributors/)
npm package: @imperium/email
Description: Email Imperium package
Latest version: 3.1.5
Deprecated: Restructured Imperium. This package has been deprecated.

---
id: email
title: Imperium @imperium/email
sidebar_label: email
---

[![Coverage_badge](../../docs/assets/coverage/email/coverage.svg)](assets/coverage/email/index.html) [![Greenkeeper badge](https://badges.greenkeeper.io/darkadept/imperium.svg)](https://greenkeeper.io/)

This package adds email support to Imperium.
npm package: @imperium/eslint-config-imperium
Description: ESLint dependencies
Latest version: 9.0.0

# @imperium/eslint-config-imperium

[![Coverage_badge](../../docs/assets/coverage/client/coverage.svg)](assets/coverage/client/index.html)
[![GitHub tag](https://img.shields.io/github/tag/darkadept/imperium.svg)](https://github.com/darkadept/imperium/tags/)
[![GitHub issues](https://img.shields.io/github/issues/darkadept/imperium.svg)](https://github.com/darkadept/imperium/issues/)
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/darkadept/imperium.svg)](https://GitHub.com/darkadept/imperium/pull/)

[![GitHub license](https://img.shields.io/github/license/darkadept/imperium.svg)](https://github.com/darkadept/imperium/blob/master/LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/darkadept/imperium.svg)](https://github.com/darkadept/imperium/graphs/contributors/)

You can use Imperium's specialized Eslint configuration in your own projects.

## Usage

Install the preset.

```bash
# yarn add eslint @imperium/eslint-config-imperium -D
```

Create a `.eslintrc.js` file with the following:

```js
module.exports = {extends: ['@imperium/eslint-config-imperium']};
```

In your `package.json` file you can run the script:

```json
{
	"scripts": {
		"lint": "eslint --cache --ext js,ts,tsx src"
	}
}
```
npm package: @imperium/graphql
Description: Graphql Imperium package
Latest version: 3.2.0
Deprecated: Restructured Imperium. This package has been deprecated.

---
id: graphql
title: Imperium @imperium/graphql
sidebar_label: graphql
---

[![Coverage_badge](../../docs/assets/coverage/graphql/coverage.svg)](assets/coverage/graphql/index.html) [![Greenkeeper badge](https://badges.greenkeeper.io/darkadept/imperium.svg)](https://greenkeeper.io/)

This package adds Apollo graphql support to Imperium.
npm package: @imperium/graphql-client
Description: Imperium Graphql client package
Author: MYMC
Latest version: 14.4.1

# @imperium/graphql-client

[![Coverage_badge](../../docs/assets/coverage/graphql-client/coverage.svg)](assets/coverage/graphql-client/index.html)
[![GitHub tag](https://img.shields.io/github/tag/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/tags/)
[![GitHub issues](https://img.shields.io/github/issues/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/issues/)
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/pull/)

[![GitHub license](https://img.shields.io/github/license/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/blob/master/LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/graphs/contributors/)

## Environment Variables
These can be specified in a `.env` file in the client package. These are also not secret as they are included in the client build and available on the client.

| Variable       | Default                  | Description                                                                                   |
|----------------|--------------------------|-----------------------------------------------------------------------------------------------|
| IMP_API_URL    | 'http://localhost:4001'  | The URL of the api endpoint.                                                                  |
| graphql        | '/api/graphql'           | What endpoint the graphql server is accessible at.                                            |
| graphqlws      | ''                       | What endpoint the graphql subscriptions server is accessible at. Should be a ws:// websocket. |
| apolloDefaults | *see `defaults.ts` file* | The defaults options loaded into Apollo client.                                               |
npm package: @imperium/graphql-server
Description: Imperium Graphql server package
Author: MYMC
Latest version: 14.2.1

# @imperium/graphql-server

[![Coverage_badge](../../docs/assets/coverage/graphql-server/coverage.svg)](assets/coverage/graphql-server/index.html)
[![GitHub tag](https://img.shields.io/github/tag/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/tags/)
[![GitHub issues](https://img.shields.io/github/issues/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/issues/)
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/pull/)

[![GitHub license](https://img.shields.io/github/license/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/blob/master/LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/graphs/contributors/)

## Environment Variables

These can be specified in a `.env` file in the server package. These variables are secret and not shared with the client.

| Variable                         | Default        | Description                                   |
|----------------------------------|----------------|-----------------------------------------------|
| IMP_GRAPHQL_URL                  | '/api/graphql' | What the graphql endpoint URL is.             |
| IMP_GRAPHQL_ENABLE_SUBSCRIPTIONS | false          | Enable graphql subscriptions via a websocket. |
| IMP_GRAPHQL_BODY_LIMIT           | '1mb'          | The size allowed in a graphql body.           |
npm package: @imperium/layout
Description: Imperium Layout package
Author: MYMC
Latest version: 14.3.4

# @imperium/layout

[![Coverage_badge](../../docs/assets/coverage/layout/coverage.svg)](assets/coverage/layout/index.html)
[![GitHub tag](https://img.shields.io/github/tag/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/tags/)
[![GitHub issues](https://img.shields.io/github/issues/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/issues/)
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/pull/)

[![GitHub license](https://img.shields.io/github/license/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/blob/master/LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/graphs/contributors/)

# About
This is an Imperium client module providing an abstraction for page layout, menu items, and content.

The major parts of this package are:
  * Imperium client module
  * Main layout type: `LayoutData`
  * `createPages()` function
npm package: @imperium/noauth
Description: Auth Imperium package that does no authentication
Latest version: 0.3.0
Deprecated: Restructured Imperium. This package has been deprecated.

---
id: noauth
title: @imperium/noauth
sidebar_label: noauth
---

[![Greenkeeper badge](https://badges.greenkeeper.io/darkadept/imperium.svg)](https://greenkeeper.io/)

This implements the required authentication configuration and allows every request with NO authentication.
npm package: @imperium/prettier-config-imperium
Description: Prettier config
Latest version: 9.0.0

# @imperium/prettier-config-imperium

[![GitHub tag](https://img.shields.io/github/tag/darkadept/imperium.svg)](https://github.com/darkadept/imperium/tags/)
[![GitHub issues](https://img.shields.io/github/issues/darkadept/imperium.svg)](https://github.com/darkadept/imperium/issues/)
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/darkadept/imperium.svg)](https://GitHub.com/darkadept/imperium/pull/)

[![GitHub license](https://img.shields.io/github/license/darkadept/imperium.svg)](https://github.com/darkadept/imperium/blob/master/LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/darkadept/imperium.svg)](https://github.com/darkadept/imperium/graphs/contributors/)
npm package: @imperium/router
Description: Imperium Router package
Author: MYMC
Latest version: 14.0.0

# @imperium/router

[![Coverage_badge](../../docs/assets/coverage/router/coverage.svg)](assets/coverage/router/index.html)
[![GitHub tag](https://img.shields.io/github/tag/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/tags/)
[![GitHub issues](https://img.shields.io/github/issues/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/issues/)
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/pull/)

[![GitHub license](https://img.shields.io/github/license/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/blob/master/LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/graphs/contributors/)

# About
This is an Imperium client module for defining and using routes.

The major parts of this package are:
  * Imperium client module
  * `defineRoutes()` function
  * `<ContentRouter>` component
npm package: @imperium/server
Description: Imperium core server
Author: MYMC
Latest version: 14.1.0

# @imperium/server

[![Coverage_badge](../../docs/assets/coverage/server/coverage.svg)](assets/coverage/server/index.html)
[![GitHub tag](https://img.shields.io/github/tag/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/tags/)
[![GitHub issues](https://img.shields.io/github/issues/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/issues/)
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/pull/)

[![GitHub license](https://img.shields.io/github/license/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/blob/master/LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/graphs/contributors/)

## Environment Variables
These can be specified in a `.env` file in the server package. These variables are secret and not shared with the client.

|Variable|Default|Description|
|---|---|---|
|SERVER_PORT|4001|What port the server is accessible at.|
npm package: @imperium/state
Description: Imperium State package
Author: MYMC
Latest version: 14.0.0

# @imperium/state

[![Coverage_badge](../../docs/assets/coverage/state/coverage.svg)](assets/coverage/state/index.html)
[![GitHub tag](https://img.shields.io/github/tag/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/tags/)
[![GitHub issues](https://img.shields.io/github/issues/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/issues/)
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/pull/)

[![GitHub license](https://img.shields.io/github/license/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/blob/master/LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/darkadept/imperium.svg)](https://github.com/thr-consulting/imperium/graphs/contributors/)

# About
This is an Imperium client module providing an abstraction for global state, based on Redux.
npm package: @imperium/util
Description: Imperium Util package
Author: Mike Kornelson
Latest version: 4.6.1

# @imperium/util

[![Coverage_badge](../../docs/assets/coverage/util/coverage.svg)](assets/coverage/util/index.html)
[![GitHub tag](https://img.shields.io/github/tag/darkadept/imperium.svg)](https://github.com/darkadept/imperium/tags/)
[![GitHub issues](https://img.shields.io/github/issues/darkadept/imperium.svg)](https://github.com/darkadept/imperium/issues/)
[![GitHub pull-requests](https://img.shields.io/github/issues-pr/darkadept/imperium.svg)](https://GitHub.com/darkadept/imperium/pull/)

[![GitHub license](https://img.shields.io/github/license/darkadept/imperium.svg)](https://github.com/darkadept/imperium/blob/master/LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/darkadept/imperium.svg)](https://github.com/darkadept/imperium/graphs/contributors/)
npm package: @impermeable/waterproof-editor
Description: Waterproof Editor 
Author: impermeable
Latest version: 0.13.0

# WaterproofEditor

This repository contains the source required to construct the editor as is used in the [waterproof-vscode](https://www.github.com/impermeable/waterproof-vscode) extension.

## Mixed documents

WaterproofEditor supports and is designed to be used with mixed documents, containing code as well as rich text in the form of Markdown or LaTeX.

#### Example (adapted from [waterproof-vscode](https://www.github.com/impermeable/waterproof-vscode))
![Example showing Waterproof Editor in use (taken from waterproof-vscode)](documentation/README/WaterproofExample.png)

As WaterproofEditor was designed to be used in an educational setting it supports two additional types of 'cells':
- **Input areas**: Specific regions of a document meant to be edited.
- **Hints**: Collapsible regions of a document that can be used to hide parts of a document from a user. This can be used to give hints to students or to simply hide the import of packages/libraries.
npm package: @impersonator/provider
Description: Web3 Provider with the ability to impersonate as any Address
Author: Apoorv Lathey
Latest version: 0.1.1

# @impersonator/provider

Web3 Provider with the ability to impersonate as any Address via read-only mode.

<b>Note:</b> This package is built to be used in Web applications.

## Usage

```js
import ImpersonatorProvider from "@impersonator/provider";

const rpc = "https://mainnet.infura.io/v3/<INFURA_ID>";
const provider = new ImpersonatorProvider(rpc);
await provider.init(); // Pops up Modal where the user can enter which address/ENS they want to impersonate
```

<img src="https://raw.githubusercontent.com/apoorvlathey/impersonator-monorepo/master/packages/provider/.github/ss.png" />
npm package: @impersonator/web3modal
Description: Add Impersonator as Custom provider to web3modal
Author: Apoorv Lathey
Latest version: 0.1.1

# @impersonator/web3modal

Add Impersonator as Custom provider to web3modal

## Usage

```typescript
import Web3Modal from "web3modal";
import { getImpersonatorProvider } from "@impersonator/web3modal";

const web3Modal = new Web3Modal({
  network: "mainnet", // optional
  cacheProvider: false, // optional
  providerOptions: {
    ...getImpersonatorProvider("<INSERT_RPC_URL>"),
  },
});
```

<img src="https://raw.githubusercontent.com/apoorvlathey/impersonator-monorepo/master/packages/web3modal/.github/ss1.png">
<img src="https://raw.githubusercontent.com/apoorvlathey/impersonator-monorepo/master/packages/web3modal/.github/ss2.png">