Skip to main content
Home
Browse packagesDocsSign in
This release is a pre-release — the latest non-prerelease version of @fedify/fedify is 1.0.2. Jump to this version

@fedify/fedify@1.1.0-dev.423+a30ce6dc
Built and signed on GitHub Actions

dahlia/fedify

An ActivityPub/fediverse server framework

This package works with Node.js, Deno, Bun
This package works with Node.js
This package works with Deno
This package works with Bun
JSR Score
100%
Published
3 weeks ago (1.1.0-dev.423+a30ce6dc)
interface Context

A context.

Type Parameters

TContextData

Properties

readonly
origin: string

The origin of the federated server, including the scheme (http:// or https://) and the host (e.g., example.com:8080).

readonly
host: string

The host of the federated server, including the hostname (e.g., example.com) and the port following a colon (e.g., :8080) if it is not the default port for the scheme.

readonly
hostname: string

The hostname of the federated server (e.g., example.com). This is the same as the host without the port.

The user-defined data associated with the context.

readonly
documentLoader: DocumentLoader

The document loader for loading remote JSON-LD documents.

readonly
contextLoader: DocumentLoader

The context loader for loading remote JSON-LD contexts.

Methods

Builds the URI of the NodeInfo document.

getActorUri(identifier: string): URL

Builds the URI of an actor with the given identifier.

getObjectUri<TObject extends Object>(
cls: (new (...args: any[]) => TObject) & { typeId: URL; },
values: Record<string, string>,
): URL

Builds the URI of an object with the given class and values.

getOutboxUri(identifier: string): URL

Builds the URI of an actor's outbox with the given identifier.

Builds the URI of the shared inbox.

getInboxUri(identifier: string): URL

Builds the URI of an actor's inbox with the given identifier.

getFollowingUri(identifier: string): URL

Builds the URI of an actor's following collection with the given identifier.

getFollowersUri(identifier: string): URL

Builds the URI of an actor's followers collection with the given identifier.

getLikedUri(identifier: string): URL

Builds the URI of an actor's liked collection with the given identifier.

getFeaturedUri(identifier: string): URL

Builds the URI of an actor's featured collection with the given identifier.

Builds the URI of an actor's featured tags collection with the given identifier.

parseUri(uri: URL | null): ParseUriResult | null

Determines the type of the URI and extracts the associated data.

Gets the key pairs for an actor.

getDocumentLoader(identity:
{ identifier: string; }
| { username: string; }
| { handle: string; }
): Promise<DocumentLoader>

Gets an authenticated DocumentLoader for the given identity. Note that an authenticated document loader intentionally does not cache the fetched documents.

getDocumentLoader(identity: { keyId: URL; privateKey: CryptoKey; }): DocumentLoader

Gets an authenticated DocumentLoader for the given identity. Note that an authenticated document loader intentionally does not cache the fetched documents.

lookupObject(
identifier: string | URL,
options?: LookupObjectOptions,
): Promise<Object | null>

Looks up an ActivityStreams object by its URI (including acct: URIs) or a fediverse handle (e.g., @user@server or user@server).

sendActivity(
sender:
SenderKeyPair
| SenderKeyPair[]
| { identifier: string; }
| { username: string; }
| { handle: string; }
,
recipients: Recipient | Recipient[],
activity: Activity,
): Promise<void>

Sends an activity to recipients' inboxes.

sendActivity(
sender:
{ identifier: string; }
| { username: string; }
| { handle: string; }
,
recipients: "followers",
activity: Activity,
): Promise<void>

Sends an activity to the outboxes of the sender's followers.

Add Package

deno add jsr:@fedify/fedify

Import symbol

import { type Context } from "@fedify/fedify/federation";

---- OR ----

Import directly with a jsr specifier

import { type Context } from "jsr:@fedify/fedify/federation";

Add Package

npx jsr add @fedify/fedify

Import symbol

import { type Context } from "@fedify/fedify/federation";

Add Package

yarn dlx jsr add @fedify/fedify

Import symbol

import { type Context } from "@fedify/fedify/federation";

Add Package

pnpm dlx jsr add @fedify/fedify

Import symbol

import { type Context } from "@fedify/fedify/federation";

Add Package

bunx jsr add @fedify/fedify

Import symbol

import { type Context } from "@fedify/fedify/federation";