open-index/open-npm huggingface dataset:
npm package: @nimiq/browser-warning
Description: Browser Warning for unsupported browsers
Author: Nimiq
Latest version: 1.1.1

# Nimiq Browser Warnings

Javascipt, CSS and a html snippet to display a warning in case of unsupported browsers, private mode or disabled Javascript.

## Installation

```
yarn add @nimiq/browser-warning
```

## Usage

This is no modular package you can import. Instead:
* Use e.g. CopyWebpackPlugin to copy files from dist folder to your app's root folder
* Use e.g. HtmlWebpackPlugin to inject the HTML snippet into your app's index.html
* In your index.html head section, place `<script type="text/javascript" src="browser-warning.js" defer></script>` in
  front of all other scripts which may execute, especially your app's main entry point. If your other scripts are not
  deferred, also remove the `defer` attribute on `browser-warning.js`.
* In your app's main entry point logic, check for `window.hasBrowserWarning === true` and stop execution in that case.
* If you're using typescript, add `@nimiq/browser-warning` to
  [`compilerOptions.types`](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html#types-typeroots-and-types)
  in your `tsconfig.json`.
* It is recommended to serve your app via https as otherwise in-app web-views might not be correctly detected.

## Configuration

You can define a callback `window.onBrowserWarning` that gets called in case of a browser warning with the warning type
and a config object:

|Parameter|Type|
|---------|----|
|warningType|'web-view' / 'browser-outdated' / 'no-local-storage' / 'private-mode'|
|warningConfig.headline|string|
|warningConfig.message|string|
|warningConfig.hasShareButton|boolean|
|warningConfig.shareUrl|string|
|warningConfig.useNativeShare|boolean|
|warningConfig.shareInstructions|string|

It can then optionally return a configuration object that overwrites a subset or all of the configuration properties.

Note that `window.onBrowserWarning` needs to be defined before `browser-warning.js` is executed. This is therefore an
exception to the rule stated in the previous section.

Note that the script that defines `window.onBrowserWarning` **must be written in old-fashioned Javascript** to not fail
with syntax errors in old browsers which would prevent us from being able to display a warning in old browsers.

## Contributing

Contributions are welcome! To build the code yourself run
```
yarn build
```
which minifies the code with Google's closure compiler. We are compiling with the compiler's `SIMPLE` compilation level
as the `ADVANCED` level does not result in significantly smaller files for this lib, especially when comparing gzipped
size. You therefore do not need to mind the special precautions that are required for the `ADVANCED` level.

Code does however need to be written in old-fashioned javascript to be compatible with old browsers. The closure
compiler will warn you if your code is not valid ES3.
npm package: @nimiq/core-types
Description: Typescript typings for the Nimiq core library
Author: Nimiq
Latest version: 1.4.2

# @nimiq/core-types

> ## Deprecation Warning
> Release v1.4.2 of this package is the last release of @nimiq/core-types,
> because the types are now included in the
> [@nimiq/core](https://www.npmjs.com/package/@nimiq/core) package.

This package provides Typescript types for the Nimiq core library.

A global namespace 'Nimiq' is declared.

## Installation

```bash
npm install --save-dev @nimiq/core-types
```

or

```bash
yarn add --dev @nimiq/core-types
```

## Usage

Add a .d.ts file to your project folder, e.g. `Nimiq.d.ts`, and make sure it is
included in your `.tsconfig`. That file should contain:

```typescript
// tslint:disable-next-line no-reference
/// <reference path="./node_modules/@nimiq/core-types/Nimiq.d.ts" />
```
npm package: @nimiq/hub-api
Description: The Nimiq Hub provides a unified interface for all Nimiq accounts, addresses, and contracts. It is the primary UI for Nimiq users to manage their accounts and provides websites and apps with a concise API to interact with their users’ Nimiq addresses.
Author: Nimiq Network Ltd.
Latest version: 1.13.0

# Nimiq Hub API

The Nimiq Hub provides a unified interface for all Nimiq accounts, addresses, and
contracts. It is the primary UI for Nimiq users to manage their accounts and provides
websites and apps with a concise API to interact with their users’ Nimiq addresses.

## Installation

Install the package with `npm` or `yarn`:

```bash
npm install --save @nimiq/hub-api
# or with yarn
yarn add @nimiq/hub-api
```

Then import or require it in your code:

```javascript
import HubApi from '@nimiq/hub-api';
// or
const HubApi = require('@nimiq/hub-api');
```

## Documentation

The documentation for the Hub API is at https://nimiq.github.io/hub.
npm package: @nimiq/keyguard-client
Description: Nimiq Keyguard client library
Author: Nimiq
Latest version: 1.10.0

# Nimiq Keyguard Client

This is the client library for Nimiq Keyguard. It is primarily built for internal
use with [Nimiq Hub](https://github.com/nimiq/hub).

## Install

```sh
yarn add --dev @nimiq/keyguard-client
```