@jackdbd/fastify-media-endpoint


Fastify plugin that adds a Micropub Media endpoint to a Fastify server.

- Installation
- Fastify plugin media\-endpoint options
- Dependencies
- References
- License

Installation

``sh
npm install @jackdbd/fastify-media-endpoint
`

Fastify plugin media\-endpoint options

Options for the Fastify media-endpoint plugin

Properties

|Name|Type|Description|Required|
|----|----|-----------|--------|
|ajv||Instance of Ajv
|no|
|deleteMedia
(Delete post)|Function|Deletes a post published at a URL.
|yes|
|includeErrorDescription|boolean|Whether to include an error_description property in all error responses. This is meant to assist the client developer in understanding the error. This is NOT meant to be shown to the end user.
Default: false
|no|
|isAccessTokenRevoked|Function|Predicate function that returns true if a jti (JSON Web Token ID) is revoked.
|yes|
|logPrefix|string|Default: "[media-endpoint] "
|no|
|me|||yes|
|multipartFormDataMaxFileSize
(multipart/form\-data max file size)|number|Max file size (in bytes) for multipart/form-data requests.
Default: 10000000
Minimum: 0
|no|
|reportAllAjvErrors
(report all AJV errors)|boolean|Whether to report all AJV validation errors.
Default: false
|no|
|uploadMedia
(Upload file)|Function|Uploads a file to the Micropub server.
|yes|

Example

`json
{
"includeErrorDescription": false,
"logPrefix": "[media-endpoint] ",
"multipartFormDataMaxFileSize": 10000000,
"reportAllAjvErrors": false
}
`

Dependencies

| Package | Version |
|---|---|
| @fastify/multipart | ^9.0.3 |
| @fastify/response-validation | ^3.0.3 |
| @jackdbd/canonical-url | 0.2.0-canary.8 |
| @jackdbd/fastify-hooks | 0.2.0-canary.16 |
| @jackdbd/fastify-utils | 0.2.0-canary.10 |
| @jackdbd/indieauth | 0.2.0-canary.14 |
| @jackdbd/micropub | 0.2.0-canary.13 |
| @jackdbd/oauth2-error-responses | 0.2.0-canary.9 |
| @jackdbd/schema-validators | 0.2.0-canary.12 |
| @sinclair/typebox | ^0.34.14 |
| ajv | ^8.17.1 |
| ajv-formats | ^3.0.1 |
| fastify-plugin | ^5.0.1 |

> [!WARNING]
> This package defines 2 peer dependencies.

| Peer | Version range |
|---|---|
| @fastify/request-context | >=6.0.0 |
| fastify | >=5.0.0` |

References

- Micropub media endpoint (indieweb.org)

License

© 2024 - 2025 Giacomo Debidda // MIT License