api/README.md

Lysand API

Set of NPM packages written in TypeScript to interact with Lysand-compatible services.

Packages

• @lysand-org/federation: Federation types, validators and cryptography for Lysand server implementations.
• @lysand-org/client: Client for the reference Lysand Server implementation.

Efficiency

The built output of each package is not even 200 KB in size, making it a lightweight and efficient solution for your Lysand needs. Installing the package adds around 5 MB to your node_modules folder, but this does not affect the final bundle size.

Compilation (bundling/minifying) time is a few seconds, almost all of which is spent on type-checking. The actual compilation time is less than a tenth of a second.

Usage

Federation

Roadmap

• Zod objects
• Signing code
• Advanced validator

Validation

Zod is used to validate and parse the objects. All Lysand objects are already written for you.

You may use the InferType<T> export to get a direct type from the object.

// Note is a Zod object
import { Note, type InferType } from "@lysand-org/federation";

const badObject = {
    IamBad: "Note",
};

// Will throw an error
const parsed = await Note.parseAsync(badObject);

// Infer the TypeScript type from the object
type NoteType = InferType<typeof Note>;

For more information about Note's methods, see the Zod documentation.

Your editor's IntelliSense should provide you with every method and property available, which all match the Lysand specification names.

Client

Roadmap

• Parity with megalodon's Mastodon client
• Lysand-specific features

Warning

Not yet published or started work on.

Getting Started

Prerequisites

For Usage

See the Compatibility section for the supported environments. Any package manager can be used to install the packages.

For Development

• Bun version 1.1.8 or higher.
• Either the Linux or macOS operating systems. (Windows will work, but is not officially supported.)

Compatibility

This library is built for JavaScript runtimes with the support for:

• ES Modules
• ECMAScript 2020

Runtimes

• Node.js: 14.0+ is the minimum, but only Node.js 20.0+ (LTS) is officially supported.
• Deno: Support is unknown. 1.0+ is expected to work.
• Bun: Bun 1.1.8 is the minimum-supported version. As Bun is rapidly evolving, this may change. Previous versions may also work.

Browsers

Consequently, this library is compatible without any bundling in the following browser versions:

• Chrome: 80+
• Edge: 80+
• Firefox: 74+
• Safari: 13.1+
• Opera: 67+
• Internet Explorer: None

If you are targeting older browsers, please don't, you are doing yourself a disservice.

Transpilation to non-ES Module environments is not officially supported, but should be simple with the use of a bundler like Parcel or Rollup.

Installation

Both packages are distributed as a scoped package on the NPM registry.

npm install @lysand-org/federation @lysand-org/client # For NPM
yarn add @lysand-org/federation @lysand-org/client # For Yarn
pnpm add @lysand-org/federation @lysand-org/client # For PNPM
bun add @lysand-org/federation @lysand-org/client # For Bun

From Source

If you want to install from source, you can clone this repository and run the following commands:

bun install # Install dependencies

bun run build # Build the packages

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

Projects

• Bun: Thanks to the Bun team for creating an amazing JavaScript runtime.
• TypeScript: TypeScript is the backbone of this project.
• Node.js: Node.js created the idea of JavaScript on the server.

People

• April John: Creator and maintainer of the Lysand Server ActivityPub bridge.