open-index/open-npm huggingface dataset:
npm package: @formant/ai-sdk
Description: A library for accessing realtime connections your Formant devices/fleet.
Latest version: 0.0.5

# Formant Realtime SDK

A library for accessing realtime connections your Formant devices/fleet.

## Get Started

```bash
$ npm install --save @formant/realtime-sdk@latest

# or with

$ yarn add @formant/realtime-sdk@latest
```

## License

Distributed under the MIT License. See LICENSE.txt for more information.

## Changelog

### **1.3.0** - 2024-09-09

#### Fixed

-   Redact sensitive ICE credentials.

### **1.2.0** - 2023-08-18

#### Added

-   Exporting `IRtcPeer` and `RtcStreamType`.

### **1.1.0** - 2023-08-18

#### Fixed

-   Fixed debug logging level output.

### **1.0.0** - 2023-07-19

#### Added

-   Odometry over teleop
-   Add support for eventing on all event trigger types

#### Changed

-   Reduce ICE gathering timeout to 3s

#### Fixed

-   Workaround for lack of getConfiguration method on RTCPeerConnection
-   Project de-cycling
-   Fix Odom
-   Use previously implemented util for detecting STUN vs TURN
-   Partition connections in a single step…
-   Immediately eject a disconnected connection from the connection set
-   More cleanup on rtcClient shutdown
-   Record RTC connection type metric (host, relay, etc)
-   Make best-effort to _release_ the RtcPeerConnection on close
-   `isConnectionInitiator` never gets cleared, keeping RtcConnections alive
-   Add prettier plugin to deterministically sort import ordering
-   Dependency updates
-   Resolve realtime-sdk build warnings about re-exporting types
npm package: @formant/ava-react
Description: React components of AVA.
Author: formant
Latest version: 3.3.33-formant

<img src="https://gw.alipayobjects.com/zos/antfincdn/R8sN%24GNdh6/language.svg" width="18" alt="language icon" /> English | [简体中文](./zh-CN/README.zh-CN.md)


<h1 align="center">
<b>@antv/ava-react</b>
</h1>

<div align="center">

React components of AVA.

[![MIT License](https://img.shields.io/github/license/antvis/ava)](/LICENSE) [![Language](https://img.shields.io/badge/language-typescript-blue.svg)](https://www.typescriptlang.org) [![NPM Package](https://img.shields.io/npm/v/@antv/ava-react.svg)](https://www.npmjs.com/package/@antv/ava-react) [![NPM Downloads](http://img.shields.io/npm/dm/@antv/ava-react.svg)](https://www.npmjs.com/package/@antv/ava-react) 

</div>

## Introduction

[@antv/ava-react](https://www.npmjs.com/package/@antv/ava-react) is a plug-and-play React component library based on the integration of AVA capabilities, which contains three core components:

* `<NarrativeTextVis/>`: Demonstrate data insight interpretation text. In a full-flow presentation of data analysis, using text to describe data phenomena is as critical as giving insightful conclusions.
* `<InsightCard/>`: Present data insights in a combination of graphics and text. It is possible to either receive data directly and perform insights automatically, or to visualize and interpret only the insight result data for presentation.
* `<AutoChart/>`: Automatically recommends and renders the appropriate chart based on the data. It provides users with the ability to implement intelligent visualizations in one line of code, and the component is currently undergoing further upgrades.

## Installation and Usage

Installation can be done via npm or the yarn package manager.

```shell
# npm
$ npm install @antv/ava-react --save

# yarn
$ yarn add @antv/ava-react
```

The following is a practical example of how the three main components of [@antv/ava-react](https://www.npmjs.com/package/@antv/ava-react) can be used:

1. Examples of `<NarrativeTextVis/>`:

    ```ts
    import { NarrativeTextVis } from '@antv/ava-react';
    export default () => {
    // where textSpec is of type NarrativeTextSpec
    return <NarrativeTextVis spec={textSpec} />
    }
    ```

2. Examples of `<InsightCard/>`:

    ```ts
    import { InsightCard } from '@antv/ava-react';
    export default () => {
    // where the insightInfo type refers to the data insight output by the insight module
    return <InsightCard insightInfo={insightInfo} />
    }
    ```

3. `<AutoChart/>` is being further upgraded, so stay tuned.

```ts
import { NarrativeTextVis } from '@antv/ava-react';
```

## Contribution [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

We welcome all contributions. Please read our [Contributing Guide](./CONTRIBUTING.md) first. You can submit any ideas as [pull requests](https://github.com/antvis/AVA/pulls) or as [GitHub issues](https://github.com/antvis/AVA/issues). Let's build a better AVA together.

More at [Wiki: Development](https://github.com/antvis/AVA/wiki/Development).
npm package: @formant/data-sdk
Description: A library for getting data from Formant
Latest version: 1.83.1

# Formant Data SDK

A library for accessing the devices in your Formant fleet.

Check out the [project website](https://github.com/FormantIO/toolkit) for more information!

## Get Started

Install using `npm` or `yarn`:

```sh
$ npm install --save @formant/data-sdk@latest @formant/realtime-sdk@latest

# or with

$ yarn add @formant/data-sdk@latest @formant/realtime-sdk@latest
```

## License

Distributed under the MIT License. See LICENSE.txt for more information.

---

## Deploying a new version

```bash
# build the project
npm install && npm run build && npm run types

# update the CHANGELOG with the changes since the previous version
vim CHANGELOG.md

# use npm to bump the version number
npm version X.Y.Z

# add all the changed files from the preversion/postversion tasks
git add .

# commit all the changes with a uniform commit message
git commit -m data-sdk@$(node -p "require('./package.json').version")

# add a unified annotated tag for this version
git tag -a release/data-sdk/$(node -p "require('./package.json').version") -m data-sdk@$(node -p "require('./package.json').version")

# publish this version to npm; use "--tag=next" for future releases
npm publish --tag=latest

# push everything to remote vcs with the tags
git push --follow-tags
```
npm package: @formant/realtime-sdk
Description: A library for accessing realtime connections your Formant devices/fleet.
Latest version: 1.4.11

# Formant Realtime SDK

A library for accessing realtime connections your Formant devices/fleet.

## Get Started

```bash
$ npm install --save @formant/realtime-sdk@latest

# or with

$ yarn add @formant/realtime-sdk@latest
```

## License

Distributed under the MIT License. See LICENSE.txt for more information.

## Changelog

### **1.3.0** - 2024-09-09

#### Fixed

-   Redact sensitive ICE credentials.

### **1.2.0** - 2023-08-18

#### Added

-   Exporting `IRtcPeer` and `RtcStreamType`.

### **1.1.0** - 2023-08-18

#### Fixed

-   Fixed debug logging level output.

### **1.0.0** - 2023-07-19

#### Added

-   Odometry over teleop
-   Add support for eventing on all event trigger types

#### Changed

-   Reduce ICE gathering timeout to 3s

#### Fixed

-   Workaround for lack of getConfiguration method on RTCPeerConnection
-   Project de-cycling
-   Fix Odom
-   Use previously implemented util for detecting STUN vs TURN
-   Partition connections in a single step…
-   Immediately eject a disconnected connection from the connection set
-   More cleanup on rtcClient shutdown
-   Record RTC connection type metric (host, relay, etc)
-   Make best-effort to _release_ the RtcPeerConnection on close
-   `isConnectionInitiator` never gets cleared, keeping RtcConnections alive
-   Add prettier plugin to deterministically sort import ordering
-   Dependency updates
-   Resolve realtime-sdk build warnings about re-exporting types
npm package: @formant/ui-sdk
Description: A library for getting UI from Formant
Latest version: 0.0.65

# UI SDK

A library of UI components from Formant. These components are re-exported subset of [`mui`](https://mui.com). You get the best of all worlds:

- components that look beautiful and fit in within a custom view/module.
- high quality industry standard component system for React (i.e. your knowledge is re-usable for other projects that aren't Formant related).
- unique formant specific components not offered by `mui`

[demo](https://formantio.github.io/toolkit/examples/ui-sdk/dist/index.html)

# Unique Formant components

- Timeline scrubber - COMING SOON

# Other MUI components

You can use the whole suite of components from [`mui`](https://mui.com) that will inherent our styles. The components that are explicitly tested from this packages have styling that is known to be of high quality.

# Setting up in your own project

```
yarn add @formant/ui-sdk
```

or check out our [ViteJS example](https://github.com/FormantIO/toolkit/tree/master/examples/ui-sdk)

# Font

Formant UI Sdk uses the [Inter](https://fonts.google.com/specimen/Inter) open source font, add this to your project

```html
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<link
  href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;700&display=swap"
  rel="stylesheet"
/>
```

# Formant React hooks

Within this project are a number of hooks that make access informationa about your fleet easy to do.

# Developing on `ui-sdk`

```
yarn
yarn dev
```

# Running storybook

```
yarn storybook
```

# Building for production

Weirdly, typescript requires npm layout package in order to generate its types


## Deploying a new version

```bash
# use npm to bump the version number
npm version X.Y.Z 

# add all the changed files from the preversion/postversion tasks
git add .

# commit all the changes with a uniform commit message
git commit -m ui-sdk@$(node -p "require('./package.json').version")

# add a unified annotated tag for this version
git tag -a release/ui-sdk/$(node -p "require('./package.json').version") -m ui-sdk@$(node -p "require('./package.json').version")

# publish this version to npm; use "--tag=next" for future releases
npm publish

# push everything to remote vcs with the tags
git push --follow-tags
```


should run all that's necessary for creating a build
npm package: @formant/universe
Description: A library visualizing 3D universes on Formant
Latest version: 0.0.242

# Formant Universe

A toolkit for building 3D worlds with Formant.  Fleets of data are brimming with spatial data.  This is a library and editor that can help you put together 3D visualizations of robots on mobile, desktop, and VR.  It's meant to be an easy way for you to connect layers of information to data sources behind a single interface.

![image](https://user-images.githubusercontent.com/66638393/172955268-0fbc4fd4-1c4b-45d3-ae1e-bf28e470dd42.png)

# Mental model of this library

## What is universe?

A universe is a collection of layers

## What is a layer?

A layer is a collection of 3D element that can be driven by a data source and configured with fields.

## What is a layer field?

A layer field is a named property of a layer with a text, number, or boolean variable.  They can be configured with meta data to describe themselves in the UI dynamically.

## What is a layer part?

A layer part is a 3D element that a layer wants the world outside of itself to be aware of.  The might be important components other layers may want to test intersection interactions with for instance.

## What is a data source?

A data source is a representation of a specific source of information that might be present within a robot (example: A ROS message stream, a realtime hardware video source, a stream of JSON telemetry).

# Built-in Layers

## Data Layer
## Transform Tree Layer
## URDF Layer
## Geometry Layer
## Gltf Layer
## Ground Layer
## Image Layer
## Label Layer
## Point Cloud Layer
## Teleport Layer
## Video Layer
npm package: @formant/universe-core
Description: A core library for universe
Latest version: 0.0.17

# Formant Universe

A toolkit for building 3D worlds with Formant.  Fleets of data are brimming with spatial data.  This is a library and editor that can help you put together 3D visualizations of robots on mobile, desktop, and VR.  It's meant to be an easy way for you to connect layers of information to data sources behind a single interface.

![image](https://user-images.githubusercontent.com/66638393/172955268-0fbc4fd4-1c4b-45d3-ae1e-bf28e470dd42.png)

# Mental model of this library

## What is universe?

A universe is a collection of layers

## What is a layer?

A layer is a collection of 3D element that can be driven by a data source and configured with fields.

## What is a layer field?

A layer field is a named property of a layer with a text, number, or boolean variable.  They can be configured with meta data to describe themselves in the UI dynamically.

## What is a layer part?

A layer part is a 3D element that a layer wants the world outside of itself to be aware of.  The might be important components other layers may want to test intersection interactions with for instance.

## What is a data source?

A data source is a representation of a specific source of information that might be present within a robot (example: A ROS message stream, a realtime hardware video source, a stream of JSON telemetry).

# Built-in Layers

## Data Layer
## Transform Tree Layer
## URDF Layer
## Geometry Layer
## Gltf Layer
## Ground Layer
## Image Layer
## Label Layer
## Point Cloud Layer
## Teleport Layer
## Video Layer
npm package: @formanta/build-task.archive
Description: Make filtered copy of source directory and pack it in the end, wrapping [@insulo/archiver](https://www.npmjs.com/package/@insulo/archiver).
Latest version: 0.2.0

# Formanta Build Task: Archive

Make filtered copy of source directory and pack it in the end, wrapping [@insulo/archiver](https://www.npmjs.com/package/@insulo/archiver).

```js
const archive = require('@formanta/build-task.archive');

archive(
    // src folder, when dist inside src don't forget to exclude it
    __dirname + '/src',
    [
        // exclude folders
        '.idea',
        '.git',
        '.gitkeep',
        'tmp',
        '/archive',
        'node_modules',
    ],
    // dist: folder name; will be used as folder name to copy files first, then as name of archive
    __dirname + '/dist',
    {
        // option
        pack: 'zip', // use zip or targz [targz to be implemented]
        delete_auto: true, // delete copy after packing
        debug: false
    }
)().then(res => {});
```

## Licence

This project is free software distributed under the terms of two licences, the CeCILL-C and the GNU Lesser General Public License. You can use, modify and/ or redistribute the software under the terms of CeCILL-C (v1) for Europe or GNU LGPL (v3) for the rest of the world.

This file and the LICENCE.* files need to be distributed and not changed when distributing.
For more informations on the licences which are applied read: [LICENCE.md](LICENCE.md)


# Copyright

    2018 | bemit UG (haftungsbeschränkt) - project@bemit.codes
    Author: Michael Becker - michael@bemit.codes
npm package: @formanta/build-task.sass
Description: Sass to CSS with intelligent file watcher, integrated postcss autoprefixer.
Latest version: 0.1.6
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

# Formanta Build Task: Sass

Transpile Sass (.sass and .scss) to CSS and optimize it with postcss.

```js
const {run} = require('@formanta/build-task.sass');

let entry = __dirname + '/main.scss';
let output = __dirname + '/style.css';

// or multiple
entry = [
    __dirname + '/main.scss',
    __dirname + '/slider.scss',
];
output = [
    __dirname + '/style.css',
    __dirname + '/slider.css',
];

run(entry, output, watch = true, outputStyle = 'nested', root_dir = '', includePaths = [])
    .then(res => {})
    .catch(e => {});
```

- watch enabled a FileWatcher (build upon Chokidar) starts, checks imported files and when changing any, it rebuilds `entry`. It tracks import changes.
- outputStyle: `nested`, `expanded`, `compact`, `compressed`
- root_dir: for building a prettier output, removing the root_dir from log. e.g. `__dirname`.
- includePaths: array with paths for resolving `@imports`

Builds upon those other open-source projects: 
- [LibSass](https://github.com/sass/libsass)
- [node-sass](https://github.com/sass/node-sass)
- [Autoprefixer](https://www.npmjs.com/package/autoprefixer)
- [PostCSS](https://www.npmjs.com/package/postcss)
- [@insulo/runner](https://www.npmjs.com/package/@insulo/runner)
- [@insulo/watcher](https://www.npmjs.com/package/@insulo/watcher)

## Licence

This project is free software distributed under the terms of two licences, the CeCILL-C and the GNU Lesser General Public License. You can use, modify and/ or redistribute the software under the terms of CeCILL-C (v1) for Europe or GNU LGPL (v3) for the rest of the world.

This file and the LICENCE.* files need to be distributed and not changed when distributing.
For more informations on the licences which are applied read: [LICENCE.md](LICENCE.md)


# Copyright

2018 - 2019 | [bemit UG](https://bemit.eu) (haftungsbeschränkt)

Author: [Michael Becker](mlbr.xyz)
npm package: @formanta/sass-doctheme
Description: Modified Theme for SassDoc based on SassDoc's default theme
Latest version: 0.1.2

# SassDoc Default Theme

This is [SassDoc](https://github.com/SassDoc/sassdoc)'s default theme which means this is the theme that will be used when running SassDoc without a custom theme.

This theme uses [Themeleon](https://github.com/themeleon/themeleon) as a theme engine, and [themeleon-swig](https://github.com/themeleon/themeleon-swig) as a template engine, directly plugged into Themeleon.

Because this is likely to be the most used theme of all, it is not as simple as a theme can get. For instance, there is quite a bit of logic in both `index.js` and the Swig templates. Fortunately, you don't have to deal with that at all.

## Customising the view

There are some possibilites to customise the theme's view. Essentially what's being displayed, what's not, and what are the project informations to be displayed in the header and footer.

To learn how to customise the theme's view, please read [the documentation on SassDoc's site](http://sassdoc.com/customising-the-view/). Fear not! It's all about creating a configuration file. No big deal.
npm package: @formara/plugin-sdk
Description: SDK para desarrollo de plugins de Formara
Author: Formara
Latest version: 1.0.13

# @formara/plugin-sdk

SDK para desarrollo de plugins de Formara. Proporciona interfaces/contratos y herramientas de sandbox para desarrollo y testing de plugins.

## 📦 Instalación

Instala el SDK desde npm:

```bash
npm install @formara/plugin-sdk --save-dev
```

¡Eso es todo! No necesitas configuración adicional.

## 📚 Uso

### Importar interfaces

```typescript
// Frontend
import { FieldTypeDefinition } from '@formara/plugin-sdk/contracts/frontend';

// Backend
import { ActionDefinition, HookDefinition } from '@formara/plugin-sdk/contracts/backend';
```

### Usar componentes UI

```typescript
import { Button, Input, Dialog } from '@formara/plugin-sdk/ui';
```

### Usar sandbox tools

```typescript
// Backend dev server
import { createDevServer } from '@formara/plugin-sdk/sandbox/backend/dev-server';
import { createPrismaAdapter } from '@formara/plugin-sdk/sandbox/backend/prisma-adapter';

// Frontend adapters
import { createApiAdapter } from '@formara/plugin-sdk/sandbox/frontend/api-adapter';
import { createAuthAdapter } from '@formara/plugin-sdk/sandbox/frontend/auth-adapter';
```

### Configurar Vite

```typescript
import { getPluginViteConfig } from '@formara/plugin-sdk/utils/vite-config';
import { defineConfig } from 'vite';

export default defineConfig({
  ...getPluginViteConfig(__dirname),
  // tu configuración adicional
});
```

## 🔧 Desarrollo

Este SDK se desarrolla en el repositorio `formara-plugin-sdk` y se publica a npmjs.com.

### Publicar manualmente

```bash
npm run build
npm publish
```

## 📝 Versiones

El SDK usa versionado semántico. Para actualizar en tus plugins:

```bash
npm install @formara/plugin-sdk@latest
```

O especifica una versión:

```bash
npm install @formara/plugin-sdk@^1.0.0
```

## 🔗 Links

- [Repositorio](https://github.com/rmcamps/formara-plugin-sdk)
- [Documentación completa](./PLUGIN_SDK_GUIDE.md)