Graffiti API

The Graffiti API makes it possible to build many different types of social applications that naturally interoperate each other, all using only standard client-side tools. This folder contains the abstract API, its documentation, and conformonce tests.

To build with the API: see the API Documentation

Implementing the API

To implement the API, create a class that extends the abstract Graffiti class and implement its methods and sessionEvents contract:

import { Graffiti } from "@graffiti-garden/api";

class MyGraffitiImplementation extends Graffiti {
  // Implement the abstract members documented in the API reference.
}
Copy

See the implementations folder for examples of how to implement the API.

Conformance Tests

The @graffiti-garden/api/tests export provides Vitest suites that can be reused by implementations. For example:

import { graffitiCRUDTests } from "@graffiti-garden/api/tests";

const useGraffiti = () => new MyGraffitiImplementation();
const useSession1 = () => ({ actor: "https://example.com/alice" });
const useSession2 = () => ({ actor: "https://example.com/bob" });

graffitiCRUDTests(useGraffiti, useSession1, useSession2);
Copy

Add equivalent discover and media suites as appropriate.

Building the Documentation

To build the TypeDoc documentation, run:

npm run build:docs
Copy

Then run a local server to view the documentation:

cd docs
npx http-server
Copy