Built and signed on GitHub ActionsBuilt and signed on GitHub Actions
An ActivityPub/fediverse server framework
default
Fedify: a fediverse server framework
Indicates that the actor accepts the object. The target property can beused in certain circumstances to indicate the context into which the objecthas been accepted.
An Activity is a subtype of Object that describes some form of actionthat may happen, is currently happening, or has already happened.The Activity type itself serves as an abstract base type for all typesof activities. It is important to note that the Activity type itselfdoes not carry any specific semantics about the kind of action being taken.
Additional settings for the actor dispatcher.
A callback that dispatches an Actor object.
A pair of a public key and a private key in various formats.
A callback that dispatches key pairs for an actor.
A string representation of an actor type name.
Indicates that the actor has added the object to the target.If the target property is not explicitly specified, the target would needto be determined implicitly by context. The origin can be used to identifythe context from which the object originated.
Indicates that the actor is calling the target's attention the object.
Describes a software application.
An IntransitiveActivity that indicates that the actor has arrived at the location.The origin can be used to identify the context from which the actor originated.The target typically has no defined meaning.
Represents any kind of multi-paragraph written work.
Represents an audio document of any kind.
A factory function that creates an authenticated DocumentLoader fora given identity. This is used for fetching documents that requireauthentication.
Indicates that the actor is blocking the object. Blocking is a strongerform of Ignore. The typical use is to support social systems thatallow one user to block activities or content of other users. The targetand origin typically have no defined meaning.
Builds Collection-Synchronization header content.
ChatMessages are the messages sent in 1-on-1 chats. They are similar toNotes, but the addressing is done by having a single AP actor inthe to field. Addressing multiple actors is not allowed. These messagesare always private, there is no public version of them. They are created witha Create activity.
Additional settings for a collection dispatcher.
A callback that counts the number of items in a collection.
A callback that returns a cursor for a collection.
A callback that dispatches a collection.
Used to represent distinct subsets of items from a Collection.Refer to the Activity Streams 2.0 Core for a complete description ofthe CollectionPage object.
A context.
Indicates that the actor has created the object.
Creates an exponential backoff retry policy. The delay between retriesstarts at the initialDelay and is multiplied by the factor for eachsubsequent retry, up to the maxDelay. The policy will give up aftermaxAttempts attempts. The actual delay is randomized to avoidsynchronization (jitter).
Options for createExponentialBackoffPolicy function.
Create a new Federation instance.
Options for createFederation function.
Creates a proof for the given object.
Options for createProof.
A key owned by an actor.
A proof that can be added to any activity or object, allowing recipients toverify the identity of the actor and the integrity of the data.
Indicates that the actor has deleted the object. If specified,the origin indicates the context from which the object was deleted.
Calculates the partial follower collection digest.
Indicates that the actor dislikes the object.
Represents a document of any kind.
A JSON-LD document loader that fetches documents from the Web.
Checks if the actor of the given activity owns the specified key.
Options for doesActorOwnKey.
Represents a custom emoji.
Contents of Actor's endpoints.
Represents any kind of event.
Exports a key in JWK format.
Exports a public key in Multibase format.
Exports a public key in PEM-SPKI format.
An object that registers federation-related business logic and dispatchesrequests to the appropriate handlers.
Parameters of Federation.fetch method.
Prefixes for namespacing keys in the Deno KV store.
A JSON-LD document loader that utilizes the browser's fetch API.
Error thrown when fetching a JSON-LD document failed.
Indicates that the actor is "flagging" the object. Flagging is definedin the sense common to many social platforms as reporting content as beinginappropriate for any number of reasons.
Indicates that the actor is "following" the object. Following is definedin the sense typically used within Social systems in which the actor isinterested in any activity performed by or on the object. The target andorigin typically have no defined meaning.
Generates a key pair which is appropriate for Fedify.
Gets the actor class by the given type name.
Gets the actor handle, of the form @username@domain, from the given actoror an actor URI.
Gets the type name of the given actor.
Gets an authenticated DocumentLoader for the given identity.Note that an authenticated document loader intentionally does not cachethe fetched documents.
Gets the actor that owns the specified key. Returns null if the key has noknown owner.
Options for getKeyOwner.
Represents a formal or informal collective of Actors.
A specialized Link that represents an #hashtag.
Indicates that the actor is ignoring the object. The target andorigin typically have no defined meaning.
An image document of any kind.
Imports a key from JWK format.
Imports a Multibase-encoded public key.
Imports a PEM-SPKI formatted public key.
The third party sites this server can retrieve messages from for combineddisplay with regular traffic.
A callback that handles errors in an inbox.
A callback that listens for activities in an inbox.
Registry for inbox listeners for different activity types.
A message queue that processes messages in the same process.Do not use this in production as it does not persist messages.
Instances of IntransitiveActivity are a subtype of Activityrepresenting intransitive actions. The object property is thereforeinappropriate for these activities.
A specialization of Offer in which the actor is extending an invitationfor the object to the target.
Checks if the given object is an Actor.
Indicates that the actor has joined the object.The target and origin typically have no defined meaning.
The type of the result of parsing JSON.
A cache for storing cryptographic keys.
The parameters for kvCache function.
A key for a key-value store. An array of one or more strings.
An abstract interface for a key-value store.
Additional options for setting a value in a key-value store.
A language-tagged string which corresponds to the rdf:langString type.
Indicates that the actor has left the object.The target and origin typically have no meaning.
Indicates that the actor likes, recommends or endorses the object.The target and origin typically have no defined meaning.
A Link is an indirect, qualified reference to a resource identified by a URL.The fundamental model for links is established by RFC 5988. Many of theproperties defined by the Activity Vocabulary allow values that are eitherinstances of Object or Link. When a Link is used,it establishes a qualified relation connecting the subject (the containingobject) to the resource identified by the href. Properties ofthe Link are properties of the reference as opposed to properties ofthe resource.
Indicates that the actor has listened to the object.
Looks up an ActivityStreams object by its URI (including acct: URIs)or a fediverse handle (e.g., @user@server or user@server).
Options for the lookupObject function.
Looks up a WebFinger resource.
A key-value store that stores values in memory.Do not use this in production as it does not persist values.
A specialized Link that represents an @mention.
An abstract interface for a message queue.
Additional options for enqueuing a message in a queue.
Indicates that the actor has moved object from origin to target.If the origin or target are not specified,either can be determined by context.
Represents a key owned by an actor according to FEP-521a: Representingactor's public keys.
A NodeInfo object as defined in the NodeInfo 2.1 schema.
A callback that dispatches a NodeInfo object.
Converts a NodeInfo object to a JSON value.
Normalizes the given actor handle.
Options for normalizeActorHandle.
Represents a short written work typically less than a single paragraph inlength.
Describes an object of any kind. The Object type serves as the base type formost of the other kinds of objects defined in the Activity Vocabulary,including other Core types such as Activity,IntransitiveActivity, Collection andOrderedCollection.
Additional settings for an object dispatcher.
A callback that dispatches an object.
Indicates that the actor is offering the object.If specified, the target indicates the entity to whichthe object is being offered.
A subtype of Collection in which members of the logical collectionare assumed to always be strictly ordered.
Used to represent ordered subsets of items from an OrderedCollection.Refer to the Activity Streams 2.0 Core for a complete description ofthe OrderedCollectionPage object.
Represents an organization.
The third party sites this server can publish messages to on the behalfof a user.
A callback that handles errors during outbox processing.
Represents a Web Page.
A page of items.
A result of parsing an URI.
Represents an individual person.
Represents a logical or physical location. See 5.3 RepresentingPlacesfor additional information.
A pair of property name and value.
The protocols supported on this server.
The special public collection for public addressing. Do not mutate thisobject.
Represents a question being asked. Question objects are an extension ofIntransitiveActivity. That is, the Question object is an Activity,but the direct object is the question itself and therefore it would notcontain an object property.
Indicates that the actor has read the object.
The object that can be a recipient of an activity.
Indicates that the actor is rejecting the object. The target andorigin typically have no defined meaning.
Describes a relationship between two individuals.The Relationship.subject and Relationship.object propertiesare used to identify the connected individuals.
A remote JSON-LD document and its context fetched bya DocumentLoader.
Indicates that the actor is removing the object. If specified,the origin indicates the context from which the object is being removed.
A context for a request.
Describes a resource. See alsoRFC 7033 section 4.4.
Responds with the given object in JSON-LD format.
Responds with the given object in JSON-LD format if the request acceptsJSON-LD.
Options for the respondWithObject andrespondWithObjectIfAcceptable functions.
The context passed to a RetryPolicy callback.
A policy that determines the delay before the next retry.
An error thrown by the Router.
Options for the Router.
Options for Context.sendActivity method andFederation.sendActivity method.
A key pair for an actor who sends an activity.
Represents a service of any kind.
The third party sites this server can connect to via their application API.
Signs the given object with the private key and returns the signed object.
Options for signObject.
Signs a request using the given private key.
Metadata about server software in use.
A specialization of Accept indicating thatthe acceptance is tentative.
A specialization of Reject in whichthe rejection is considered tentative.
A Tombstone represents a content object that has been deleted.It can be used in Collections to signify that there used to bean object at this position, but it has been deleted.
Indicates that the actor is traveling to target from origin.Travel is an IntransitiveObject whose actor specifies the direct object.If the target or origin are not specified,either can be determined by context.
Indicates that the actor is undoing the object. In most cases,the object will be an Activity describing some previously performedaction (for instance, a person may have previously "liked" an article but,for whatever reason, might choose to undo that like at some later point intime).
Indicates that the actor has updated the object. Note, however,that this vocabulary does not define a mechanism for describing the actualset of modifications made to object.
Usage statistics for this server.
Verifies the given object. It will verify all the proofs in the object,and succeed only if all the proofs are valid and all attributions andactors are authenticated by the proofs.
Options for verifyObject.
Verifies the given proof for the object.
Options for verifyProof.
Verifies the signature of a request.
Options for verifyRequest.
Represents a video document of any kind.
Indicates that the actor has viewed the object.
federation
The federated server framework.
Additional settings for the actor dispatcher.
A callback that dispatches an Actor object.
A pair of a public key and a private key in various formats.
A callback that dispatches key pairs for an actor.
Builds Collection-Synchronization header content.
Additional settings for a collection dispatcher.
A callback that counts the number of items in a collection.
A callback that returns a cursor for a collection.
A callback that dispatches a collection.
A context.
Creates an exponential backoff retry policy. The delay between retriesstarts at the initialDelay and is multiplied by the factor for eachsubsequent retry, up to the maxDelay. The policy will give up aftermaxAttempts attempts. The actual delay is randomized to avoidsynchronization (jitter).
Options for createExponentialBackoffPolicy function.
Create a new Federation instance.
Options for createFederation function.
Calculates the partial follower collection digest.
An object that registers federation-related business logic and dispatchesrequests to the appropriate handlers.
Parameters of Federation.fetch method.
Prefixes for namespacing keys in the Deno KV store.
A callback that handles errors in an inbox.
A callback that listens for activities in an inbox.
Registry for inbox listeners for different activity types.
A message queue that processes messages in the same process.Do not use this in production as it does not persist messages.
A key for a key-value store. An array of one or more strings.
An abstract interface for a key-value store.
Additional options for setting a value in a key-value store.
A key-value store that stores values in memory.Do not use this in production as it does not persist values.
An abstract interface for a message queue.
Additional options for enqueuing a message in a queue.
A callback that dispatches a NodeInfo object.
Additional settings for an object dispatcher.
A callback that dispatches an object.
A callback that handles errors during outbox processing.
A page of items.
A result of parsing an URI.
A context for a request.
Responds with the given object in JSON-LD format.
Responds with the given object in JSON-LD format if the request acceptsJSON-LD.
Options for the respondWithObject andrespondWithObjectIfAcceptable functions.
The context passed to a RetryPolicy callback.
A policy that determines the delay before the next retry.
An error thrown by the Router.
Options for the Router.
Options for Context.sendActivity method andFederation.sendActivity method.
A key pair for an actor who sends an activity.
The third party sites this server can retrieve messages from for combineddisplay with regular traffic.
The type of the result of parsing JSON.
A NodeInfo object as defined in the NodeInfo 2.1 schema.
Converts a NodeInfo object to a JSON value.
The third party sites this server can publish messages to on the behalfof a user.
The protocols supported on this server.
The third party sites this server can connect to via their application API.
Metadata about server software in use.
Usage statistics for this server.
runtime
This module contains the runtime facilities for working with ActivityVocabulary objects, which are auto-generated from the IDL.
A factory function that creates an authenticated DocumentLoader fora given identity. This is used for fetching documents that requireauthentication.
A JSON-LD document loader that fetches documents from the Web.
Exports a public key in Multibase format.
Exports a public key in PEM-SPKI format.
A JSON-LD document loader that utilizes the browser's fetch API.
Error thrown when fetching a JSON-LD document failed.
Gets an authenticated DocumentLoader for the given identity.Note that an authenticated document loader intentionally does not cachethe fetched documents.
Imports a Multibase-encoded public key.
Imports a PEM-SPKI formatted public key.
The parameters for kvCache function.
A language-tagged string which corresponds to the rdf:langString type.
A remote JSON-LD document and its context fetched bya DocumentLoader.
sig
HTTP Signatures implementation.
Creates a proof for the given object.
Options for createProof.
Checks if the actor of the given activity owns the specified key.
Options for doesActorOwnKey.
Exports a key in JWK format.
Generates a key pair which is appropriate for Fedify.
Gets the actor that owns the specified key. Returns null if the key has noknown owner.
Options for getKeyOwner.
Imports a key from JWK format.
A cache for storing cryptographic keys.
Signs the given object with the private key and returns the signed object.
Options for signObject.
Signs a request using the given private key.
Verifies the given object. It will verify all the proofs in the object,and succeed only if all the proofs are valid and all attributions andactors are authenticated by the proofs.
Options for verifyObject.
Verifies the given proof for the object.
Options for verifyProof.
Verifies the signature of a request.
Options for verifyRequest.
vocab
A set of type-safe object mappings for the ActivityVocabulary.
Indicates that the actor accepts the object. The target property can beused in certain circumstances to indicate the context into which the objecthas been accepted.
An Activity is a subtype of Object that describes some form of actionthat may happen, is currently happening, or has already happened.The Activity type itself serves as an abstract base type for all typesof activities. It is important to note that the Activity type itselfdoes not carry any specific semantics about the kind of action being taken.
A string representation of an actor type name.
Indicates that the actor has added the object to the target.If the target property is not explicitly specified, the target would needto be determined implicitly by context. The origin can be used to identifythe context from which the object originated.
Indicates that the actor is calling the target's attention the object.
Describes a software application.
An IntransitiveActivity that indicates that the actor has arrived at the location.The origin can be used to identify the context from which the actor originated.The target typically has no defined meaning.
Represents any kind of multi-paragraph written work.
Represents an audio document of any kind.
Indicates that the actor is blocking the object. Blocking is a strongerform of Ignore. The typical use is to support social systems thatallow one user to block activities or content of other users. The targetand origin typically have no defined meaning.
ChatMessages are the messages sent in 1-on-1 chats. They are similar toNotes, but the addressing is done by having a single AP actor inthe to field. Addressing multiple actors is not allowed. These messagesare always private, there is no public version of them. They are created witha Create activity.
Used to represent distinct subsets of items from a Collection.Refer to the Activity Streams 2.0 Core for a complete description ofthe CollectionPage object.
Indicates that the actor has created the object.
A key owned by an actor.
A proof that can be added to any activity or object, allowing recipients toverify the identity of the actor and the integrity of the data.
Indicates that the actor has deleted the object. If specified,the origin indicates the context from which the object was deleted.
Indicates that the actor dislikes the object.
Represents a document of any kind.
Represents a custom emoji.
Contents of Actor's endpoints.
Represents any kind of event.
Indicates that the actor is "flagging" the object. Flagging is definedin the sense common to many social platforms as reporting content as beinginappropriate for any number of reasons.
Indicates that the actor is "following" the object. Following is definedin the sense typically used within Social systems in which the actor isinterested in any activity performed by or on the object. The target andorigin typically have no defined meaning.
Gets the actor class by the given type name.
Gets the actor handle, of the form @username@domain, from the given actoror an actor URI.
Gets the type name of the given actor.
Represents a formal or informal collective of Actors.
A specialized Link that represents an #hashtag.
Indicates that the actor is ignoring the object. The target andorigin typically have no defined meaning.
An image document of any kind.
Instances of IntransitiveActivity are a subtype of Activityrepresenting intransitive actions. The object property is thereforeinappropriate for these activities.
A specialization of Offer in which the actor is extending an invitationfor the object to the target.
Checks if the given object is an Actor.
Indicates that the actor has joined the object.The target and origin typically have no defined meaning.
Indicates that the actor has left the object.The target and origin typically have no meaning.
Indicates that the actor likes, recommends or endorses the object.The target and origin typically have no defined meaning.
A Link is an indirect, qualified reference to a resource identified by a URL.The fundamental model for links is established by RFC 5988. Many of theproperties defined by the Activity Vocabulary allow values that are eitherinstances of Object or Link. When a Link is used,it establishes a qualified relation connecting the subject (the containingobject) to the resource identified by the href. Properties ofthe Link are properties of the reference as opposed to properties ofthe resource.
Indicates that the actor has listened to the object.
Looks up an ActivityStreams object by its URI (including acct: URIs)or a fediverse handle (e.g., @user@server or user@server).
Options for the lookupObject function.
A specialized Link that represents an @mention.
Indicates that the actor has moved object from origin to target.If the origin or target are not specified,either can be determined by context.
Represents a key owned by an actor according to FEP-521a: Representingactor's public keys.
Normalizes the given actor handle.
Options for normalizeActorHandle.
Represents a short written work typically less than a single paragraph inlength.
Describes an object of any kind. The Object type serves as the base type formost of the other kinds of objects defined in the Activity Vocabulary,including other Core types such as Activity,IntransitiveActivity, Collection andOrderedCollection.
Indicates that the actor is offering the object.If specified, the target indicates the entity to whichthe object is being offered.
A subtype of Collection in which members of the logical collectionare assumed to always be strictly ordered.
Used to represent ordered subsets of items from an OrderedCollection.Refer to the Activity Streams 2.0 Core for a complete description ofthe OrderedCollectionPage object.
Represents an organization.
Represents a Web Page.
Represents an individual person.
Represents a logical or physical location. See 5.3 RepresentingPlacesfor additional information.
A pair of property name and value.
The special public collection for public addressing. Do not mutate thisobject.
Represents a question being asked. Question objects are an extension ofIntransitiveActivity. That is, the Question object is an Activity,but the direct object is the question itself and therefore it would notcontain an object property.
Indicates that the actor has read the object.
The object that can be a recipient of an activity.
Indicates that the actor is rejecting the object. The target andorigin typically have no defined meaning.
Describes a relationship between two individuals.The Relationship.subject and Relationship.object propertiesare used to identify the connected individuals.
Indicates that the actor is removing the object. If specified,the origin indicates the context from which the object is being removed.
Represents a service of any kind.
A specialization of Accept indicating thatthe acceptance is tentative.
A specialization of Reject in whichthe rejection is considered tentative.
A Tombstone represents a content object that has been deleted.It can be used in Collections to signify that there used to bean object at this position, but it has been deleted.
Indicates that the actor is traveling to target from origin.Travel is an IntransitiveObject whose actor specifies the direct object.If the target or origin are not specified,either can be determined by context.
Indicates that the actor is undoing the object. In most cases,the object will be an Activity describing some previously performedaction (for instance, a person may have previously "liked" an article but,for whatever reason, might choose to undo that like at some later point intime).
Indicates that the actor has updated the object. Note, however,that this vocabulary does not define a mechanism for describing the actualset of modifications made to object.
Represents a video document of any kind.
Indicates that the actor has viewed the object.
webfinger
Exports WebFinger-related types and functions.
Represents a link. See alsoRFC 7033 section 4.4.4.
Looks up a WebFinger resource.
Describes a resource. See alsoRFC 7033 section 4.4.
x/denokv
KvStore & MessageQueue adapters for Deno's KV store
Represents a message queue adapter that uses Deno KV store.
Represents a key-value store implementation using Deno's KV store.
x/fresh
Fedify with Fresh
Create options for the Federation.fetch method to integrate withFresh.
Create a Fresh middleware handler to integrate with the Federationobject.
x/hono
Fedify with Hono
A factory function to create a context data for the Federationobject.
Create a Hono middleware to integrate with the Federation object.