PrivMX Web Endpoint SDK

Overview

PrivMX Web Endpoint SDK is a set of TypeScript/JavaScript tools that simplify working with PrivMX Bridge in Web
environments.
It consists of:

- high-level wrappers for native WASM assets, to accelerate the development of end-to-end encrypted apps even more;
- types for powerful autocompletion in your IDE;
- CLI for straightforward project initialization.

Initial Requirements

To start developing end-to-end encrypted applications using PrivMX Endpoint you need:

- A PrivMX Bridge Instance. Go to Bridge CLI repo to find scripts to
create and initialize one on your local machine.

- A server for managing users. It can be new or existing, depending on the specific requirements.
For more information about how PrivMX Endpoint integrates into your stack check
our getting started guide.

Installation

First, install this package using your package manager of choice.

- npm:

``
npm install @simplito/privmx-webendpoint-sdk@latest
`

- pnpm:

`
pnpm add @simplito/privmx-webendpoint-sdk@latest
`

- yarn:

`
yarn add @simplito/privmx-webendpoint-sdk@latest
`

The wrappers need access to the core lib in order to work properly. To do this, follow these steps:

1. Host core WASM assets from your static assets folder (e.g. /public). Then import them using