@fedify/debugger 2.0.0-dev.0 → 2.0.0-dev.360

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +63 -0
  2. package/package.json +2 -2
package/README.md ADDED
@@ -0,0 +1,63 @@
1
+ <!-- deno-fmt-ignore-file -->
2
+
3
+ @fedify/debugger: Embedded ActivityPub debug dashboard for Fedify
4
+ =================================================================
5
+
6
+ [![JSR][JSR badge]][JSR]
7
+ [![npm][npm badge]][npm]
8
+ [![Follow @fedify@hollo.social][@fedify@hollo.social badge]][@fedify@hollo.social]
9
+
10
+ *This package is available since Fedify 2.0.0.*
11
+
12
+ This package provides an embedded real-time debug dashboard for inspecting
13
+ ActivityPub traces and activities in your federated server app. It works as
14
+ a proxy that wraps your existing `Federation` object, intercepting HTTP requests
15
+ matching a configurable path prefix and serving the debug dashboard, while
16
+ delegating everything else to the inner federation.
17
+
18
+ ~~~~ typescript
19
+ import { createFederation, MemoryKvStore } from "@fedify/fedify";
20
+ import { createFederationDebugger } from "@fedify/debugger";
21
+
22
+ const innerFederation = createFederation<void>({
23
+ kv: new MemoryKvStore(),
24
+ // ... other federation options
25
+ });
26
+
27
+ const federation = createFederationDebugger(innerFederation);
28
+ ~~~~
29
+
30
+ The `federation` object returned by `createFederationDebugger()` is a drop-in
31
+ replacement for the original. You can use it everywhere you would normally use
32
+ the inner federation object, including with framework integrations such as
33
+ [`@fedify/hono`] and [`@fedify/express`].
34
+
35
+ > [!WARNING]
36
+ > The debug dashboard is intended for development use only. It is strongly
37
+ > recommended to enable authentication if the dashboard is accessible over
38
+ > a network, as it exposes internal trace data.
39
+
40
+ For more details on configuration, authentication, dashboard pages, and
41
+ advanced setup, see the [Debugging section] of the Fedify manual.
42
+
43
+ [JSR badge]: https://jsr.io/badges/@fedify/debugger
44
+ [JSR]: https://jsr.io/@fedify/debugger
45
+ [npm badge]: https://img.shields.io/npm/v/@fedify/debugger?logo=npm
46
+ [npm]: https://www.npmjs.com/package/@fedify/debugger
47
+ [@fedify@hollo.social badge]: https://fedi-badge.deno.dev/@fedify@hollo.social/followers.svg
48
+ [@fedify@hollo.social]: https://hollo.social/@fedify
49
+ [`@fedify/hono`]: https://jsr.io/@fedify/hono
50
+ [`@fedify/express`]: https://www.npmjs.com/package/@fedify/express
51
+ [Debugging section]: https://fedify.dev/manual/debug
52
+
53
+
54
+ Installation
55
+ ------------
56
+
57
+ ~~~~ sh
58
+ deno add jsr:@fedify/debugger # Deno
59
+ npm add @fedify/debugger # npm
60
+ pnpm add @fedify/debugger # pnpm
61
+ yarn add @fedify/debugger # Yarn
62
+ bun add @fedify/debugger # Bun
63
+ ~~~~
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fedify/debugger",
3
- "version": "2.0.0-dev.0",
3
+ "version": "2.0.0-dev.360+9618cc01",
4
4
  "description": "Embedded ActivityPub debug dashboard for Fedify",
5
5
  "type": "module",
6
6
  "main": "./dist/mod.cjs",
@@ -29,7 +29,7 @@
29
29
  "directory": "packages/debugger"
30
30
  },
31
31
  "peerDependencies": {
32
- "@fedify/fedify": "^2.0.0"
32
+ "@fedify/fedify": "^2.0.0-dev.360+9618cc01"
33
33
  },
34
34
  "dependencies": {
35
35
  "@js-temporal/polyfill": "^0.5.1",