npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@xmtp/browser-sdk

v0.0.2

Published

XMTP client SDK for browsers written in TypeScript

Downloads

67

Readme

XMTP client SDK for browsers

This package provides the XMTP client SDK for browsers.

To keep up with the latest SDK developments, see the Issues tab in this repo.

To learn more about XMTP and get answers to frequently asked questions, see the XMTP documentation.

[!CAUTION] This SDK is currently in alpha. The API is subject to change and it is not yet recommended for production use.

Requirements

Response headers

Server response headers must be set to the following values:

  • Cross-Origin-Embedder-Policy: require-corp
  • Cross-Origin-Opener-Policy: same-origin

Bundlers

This SDK uses a WebAssembly (WASM) module and bundlers must be configured properly to handle it.

Vite

Add the following to vite.config.ts:

import { defineConfig } from "vite";

// https://vitejs.dev/config/
export default defineConfig({
  optimizeDeps: {
    exclude: ["@xmtp/wasm-bindings"],
  },
});

Next.js

Add the following to next.config.mjs:

const nextConfig = {
  serverComponentsExternalPackages: ["@xmtp/wasm-bindings"],
};

export default nextConfig;

Install

NPM

npm install @xmtp/browser-sdk

PNPM

pnpm install @xmtp/browser-sdk

Yarn

yarn add @xmtp/browser-sdk

Reference docs

Access the XMTP client browser SDK reference documentation.

Usage

Check out our official documentation to get started developing with XMTP.

XMTP network environments

XMTP provides production, dev, and local network environments to support the development phases of your project. To learn more about these environments, see our official documentation.

Important
When you create a client, it connects to the XMTP dev environment by default. To learn how to use the env parameter to set your client's network environment, see Configure the client.

Breaking revisions

Because this SDK is in active development, you should expect breaking revisions that might require you to adopt the latest SDK release to enable your app to continue working as expected.

XMTP communicates about breaking revisions in the XMTP Discord community, providing as much advance notice as possible. Additionally, breaking revisions in a release are described on the Releases page.

Deprecation

Older versions of the SDK will eventually be deprecated, which means:

  1. The network will not support and eventually actively reject connections from clients using deprecated versions.
  2. Bugs will not be fixed in deprecated versions.

The following table provides the deprecation schedule.

| Announced | Effective | Minimum Version | Rationale | | -------------------------------------------------------------- | --------- | --------------- | --------- | | There are no deprecations scheduled for this SDK at this time. | | | |

Bug reports, feature requests, and PRs are welcome in accordance with these contribution guidelines.

Developing

Run yarn dev to build the SDK and watch for changes, which will trigger a rebuild.

Useful commands

  • yarn build: Builds the SDK
  • yarn clean: Removes node_modulesdist, and .turbo folders
  • yarn dev: Builds the SDK and watches for changes, which will trigger a rebuild
  • yarn test: Runs all tests
  • yarn typecheck: Runs tsc