@noy4/docserve 0.3.4 → 0.3.5
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.
- package/bin.mjs +8 -213
- package/dist/gallery/assets/index-CGV64tuk.css +1 -0
- package/dist/gallery/assets/index-Cf8Uf0vA.js +10 -0
- package/dist/gallery/assets/index-Cf8Uf0vA.js.map +1 -0
- package/dist/gallery/index.html +15 -0
- package/dist/node/cli.mjs +4095 -0
- package/dist/node/cli.mjs.map +7 -0
- package/dist/widget/index.js +730 -495
- package/package.json +14 -4
- package/src/node/cli.mjs +155 -0
- package/src/node/{files.mjs → docs/files.mjs} +1 -1
- package/src/node/{inject.mjs → docs/inject.mjs} +1 -1
- package/src/node/{meta.mjs → docs/meta.mjs} +1 -1
- package/src/node/http/app.mjs +20 -0
- package/src/node/{assets.mjs → http/assets.mjs} +3 -2
- package/src/node/http/gallery.mjs +45 -0
- package/src/node/http/response.mjs +31 -0
- package/src/node/http/routes.mjs +59 -0
- package/src/node/{serve-static.mjs → http/serve-static.mjs} +1 -1
- package/src/node/{server.mjs → http/server.mjs} +10 -10
- package/src/node/{state.mjs → instances/state.mjs} +9 -5
- package/src/node/instances/view.mjs +19 -0
- package/src/node/{watch.mjs → live/watch.mjs} +1 -1
- package/src/node/paths.mjs +10 -0
- package/src/node/rpc/files.mjs +5 -0
- package/src/node/rpc/index.mjs +39 -0
- package/src/node/rpc/route.mjs +34 -0
- package/src/node/rpc/servers.mjs +16 -0
- package/src/plugins/servers/client.js +77 -0
- package/src/plugins/servers/commands.ts +30 -0
- package/src/plugins/servers/model.ts +106 -0
- package/src/plugins/servers/servers.css +144 -0
- package/src/plugins/servers/ui/ServersPopover.tsx +71 -0
- package/src/plugins/sidebar/ui/PageList.tsx +1 -1
- package/src/plugins/sidebar/ui/RadioMenu.tsx +1 -1
- package/src/plugins/sidebar/ui/Sidebar.tsx +3 -3
- package/src/plugins/sidebar/ui/TreeList.tsx +10 -3
- package/src/{plugins/sidebar/ui → shared/client}/preview-model.ts +18 -4
- package/src/{plugins/sidebar/ui/useModel.ts → shared/client/use-model.ts} +1 -8
- package/src/shared/types.d.ts +17 -1
- package/src/widget/{pages.js → api/pages.js} +4 -7
- package/src/widget/api/rpc-client.js +25 -0
- package/src/widget/api/servers.js +46 -0
- package/src/widget/host.js +10 -8
- package/src/widget/index.js +2 -0
- package/src/widget/{docks.js → shell/docks.js} +2 -2
- package/src/widget/{palette.js → shell/palette.js} +3 -3
- package/src/widget/{placement.js → shell/placement.js} +1 -1
- package/src/widget/{ui.js → shell/ui.js} +1 -1
- package/index.html +0 -365
- package/src/node/adapter.mjs +0 -67
- package/src/node/gallery.mjs +0 -33
- package/src/node/routes.mjs +0 -105
- /package/src/node/{dates.mjs → docs/dates.mjs} +0 -0
- /package/src/node/{docs-info.mjs → docs/info.mjs} +0 -0
- /package/src/node/{scan.mjs → docs/scan.mjs} +0 -0
- /package/src/node/{websocket.mjs → live/websocket.mjs} +0 -0
- /package/src/widget/{live.js → api/live.js} +0 -0
- /package/src/widget/{rpc.js → api/rpc.js} +0 -0
- /package/src/widget/{palette.css → shell/palette.css} +0 -0
- /package/src/widget/{styles.js → shell/styles.js} +0 -0
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
import { createElement } from "react"
|
|
2
|
+
import { createRoot } from "react-dom/client"
|
|
3
|
+
import ICON_SERVERS_RAW from "~icons/lucide/server?raw&width=18&height=18"
|
|
4
|
+
import { createDisposables } from "../../widget/lib/disposables.js"
|
|
5
|
+
import { iconSvg } from "../../widget/lib/dom.js"
|
|
6
|
+
import { registerServersCommands } from "./commands.js"
|
|
7
|
+
import { ServersModel } from "./model.js"
|
|
8
|
+
import { ServersPopover } from "./ui/ServersPopover.js"
|
|
9
|
+
|
|
10
|
+
const ICON_SERVERS = iconSvg(ICON_SERVERS_RAW)
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* @returns {DocservePlugin}
|
|
14
|
+
*/
|
|
15
|
+
export function serversPlugin() {
|
|
16
|
+
return {
|
|
17
|
+
id: "servers",
|
|
18
|
+
setup(ctx) {
|
|
19
|
+
// state
|
|
20
|
+
const model = ServersModel.fromContext(ctx)
|
|
21
|
+
const cleanup = createDisposables()
|
|
22
|
+
|
|
23
|
+
// styles
|
|
24
|
+
ctx.ui.style("/__docserve/plugins/servers/servers.css")
|
|
25
|
+
|
|
26
|
+
// mount
|
|
27
|
+
const mount = ctx.ui.mountPoint()
|
|
28
|
+
const root = createRoot(mount)
|
|
29
|
+
cleanup.add(() => {
|
|
30
|
+
root.unmount()
|
|
31
|
+
mount.remove()
|
|
32
|
+
})
|
|
33
|
+
root.render(createElement(ServersPopover, { model }))
|
|
34
|
+
|
|
35
|
+
// commands
|
|
36
|
+
cleanup.add(registerServersCommands(ctx, model))
|
|
37
|
+
|
|
38
|
+
// dock
|
|
39
|
+
const dock = ctx.docks.register({
|
|
40
|
+
id: "servers",
|
|
41
|
+
title: "Toggle running servers",
|
|
42
|
+
icon: ICON_SERVERS,
|
|
43
|
+
category: "main",
|
|
44
|
+
order: 2,
|
|
45
|
+
command: "plugin:servers:toggle",
|
|
46
|
+
isActive: () => model.open.value,
|
|
47
|
+
})
|
|
48
|
+
cleanup.add(() => dock.dispose())
|
|
49
|
+
cleanup.add(model.open.subscribe(() => {
|
|
50
|
+
if (model.open.value) model.setAnchor(dock.element)
|
|
51
|
+
dock.update()
|
|
52
|
+
}))
|
|
53
|
+
model.setAnchor(dock.element)
|
|
54
|
+
|
|
55
|
+
// outside click
|
|
56
|
+
const onPointerDown = (event) => {
|
|
57
|
+
if (!model.open.value) return
|
|
58
|
+
const path = event.composedPath()
|
|
59
|
+
if (path.includes(dock.element)) return
|
|
60
|
+
if (path.some((node) => node instanceof Element && node.classList.contains("docserve-servers"))) return
|
|
61
|
+
model.close()
|
|
62
|
+
}
|
|
63
|
+
document.addEventListener("pointerdown", onPointerDown, true)
|
|
64
|
+
cleanup.add(() => document.removeEventListener("pointerdown", onPointerDown, true))
|
|
65
|
+
|
|
66
|
+
// events
|
|
67
|
+
cleanup.add(ctx.events.on("live:connected", () => {
|
|
68
|
+
model.load({ force: true })
|
|
69
|
+
}))
|
|
70
|
+
|
|
71
|
+
// teardown
|
|
72
|
+
cleanup.add(() => model.dispose())
|
|
73
|
+
|
|
74
|
+
return cleanup.dispose
|
|
75
|
+
},
|
|
76
|
+
}
|
|
77
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import ICON_SERVERS_RAW from "~icons/lucide/server?raw&width=18&height=18"
|
|
2
|
+
import { iconSvg } from "../../widget/lib/dom.js"
|
|
3
|
+
import type { ServersModel } from "./model.js"
|
|
4
|
+
|
|
5
|
+
const ICON_SERVERS = iconSvg(ICON_SERVERS_RAW)
|
|
6
|
+
|
|
7
|
+
export function registerServersCommands(ctx: DocserveContext, model: ServersModel): () => void {
|
|
8
|
+
const offToggle = ctx.commands.register({
|
|
9
|
+
id: "plugin:servers:toggle",
|
|
10
|
+
title: "Toggle running servers",
|
|
11
|
+
category: "View",
|
|
12
|
+
icon: ICON_SERVERS,
|
|
13
|
+
keys: ["s"],
|
|
14
|
+
run: () => model.toggle(),
|
|
15
|
+
})
|
|
16
|
+
|
|
17
|
+
const offClose = ctx.commands.register({
|
|
18
|
+
id: "plugin:servers:close",
|
|
19
|
+
title: "Close running servers",
|
|
20
|
+
keys: ["Escape"],
|
|
21
|
+
showInPalette: false,
|
|
22
|
+
when: () => model.open.value,
|
|
23
|
+
run: () => model.close(),
|
|
24
|
+
})
|
|
25
|
+
|
|
26
|
+
return () => {
|
|
27
|
+
offClose()
|
|
28
|
+
offToggle()
|
|
29
|
+
}
|
|
30
|
+
}
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
import { signal } from "@preact/signals-react"
|
|
2
|
+
|
|
3
|
+
export type ServersStatus = "idle" | "loading" | "ready" | "error"
|
|
4
|
+
|
|
5
|
+
export interface ServersPosition {
|
|
6
|
+
left: number
|
|
7
|
+
top: number
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
export class ServersModel {
|
|
11
|
+
readonly open = signal(false)
|
|
12
|
+
readonly servers = signal<DocServer[]>([])
|
|
13
|
+
readonly status = signal<ServersStatus>("idle")
|
|
14
|
+
readonly error = signal<string | null>(null)
|
|
15
|
+
readonly position = signal<ServersPosition | null>(null)
|
|
16
|
+
|
|
17
|
+
#rpc: RpcContext
|
|
18
|
+
#anchor: HTMLElement | null = null
|
|
19
|
+
#timer: ReturnType<typeof setInterval> | null = null
|
|
20
|
+
#request = 0
|
|
21
|
+
|
|
22
|
+
constructor(rpc: RpcContext) {
|
|
23
|
+
this.#rpc = rpc
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
static fromContext(ctx: DocserveContext): ServersModel {
|
|
27
|
+
return new ServersModel(ctx.rpc)
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
setAnchor(element: HTMLElement | null): void {
|
|
31
|
+
this.#anchor = element
|
|
32
|
+
this.layout()
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
toggle(): void {
|
|
36
|
+
this.setOpen(!this.open.value)
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
setOpen(next: boolean): void {
|
|
40
|
+
this.open.value = next
|
|
41
|
+
if (!next) {
|
|
42
|
+
this.#stopPolling()
|
|
43
|
+
return
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
this.layout()
|
|
47
|
+
requestAnimationFrame(() => {
|
|
48
|
+
if (this.open.value) this.layout()
|
|
49
|
+
})
|
|
50
|
+
this.load({ force: true })
|
|
51
|
+
this.#startPolling()
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
close(): void {
|
|
55
|
+
this.setOpen(false)
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
async load({ force = false }: { force?: boolean } = {}): Promise<void> {
|
|
59
|
+
const id = ++this.#request
|
|
60
|
+
if (!this.servers.value.length) this.status.value = "loading"
|
|
61
|
+
this.error.value = null
|
|
62
|
+
|
|
63
|
+
try {
|
|
64
|
+
const result = await this.#rpc.call("docserve:servers:list", { force })
|
|
65
|
+
if (id !== this.#request) return
|
|
66
|
+
this.servers.value = Array.isArray(result) ? (result as DocServer[]) : []
|
|
67
|
+
this.status.value = "ready"
|
|
68
|
+
} catch (err) {
|
|
69
|
+
if (id !== this.#request) return
|
|
70
|
+
this.error.value = err instanceof Error ? err.message : String(err)
|
|
71
|
+
this.status.value = "error"
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
layout(): void {
|
|
76
|
+
const anchor = this.#anchor
|
|
77
|
+
if (!anchor || !this.open.value) return
|
|
78
|
+
|
|
79
|
+
const rect = anchor.getBoundingClientRect()
|
|
80
|
+
const width = 220
|
|
81
|
+
const margin = 10
|
|
82
|
+
const maxLeft = Math.max(margin, window.innerWidth - width - margin)
|
|
83
|
+
const left = Math.min(Math.max(margin, rect.left + rect.width / 2 - width / 2), maxLeft)
|
|
84
|
+
const top = Math.max(margin, rect.top - margin)
|
|
85
|
+
this.position.value = { left, top }
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
dispose(): void {
|
|
89
|
+
this.#stopPolling()
|
|
90
|
+
this.#anchor = null
|
|
91
|
+
this.#request++
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
#startPolling(): void {
|
|
95
|
+
this.#stopPolling()
|
|
96
|
+
this.#timer = setInterval(() => {
|
|
97
|
+
this.load({ force: true })
|
|
98
|
+
}, 5000)
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
#stopPolling(): void {
|
|
102
|
+
if (!this.#timer) return
|
|
103
|
+
clearInterval(this.#timer)
|
|
104
|
+
this.#timer = null
|
|
105
|
+
}
|
|
106
|
+
}
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
.docserve-servers,
|
|
2
|
+
.docserve-servers * {
|
|
3
|
+
box-sizing: border-box;
|
|
4
|
+
}
|
|
5
|
+
|
|
6
|
+
.docserve-servers {
|
|
7
|
+
position: fixed;
|
|
8
|
+
z-index: 2;
|
|
9
|
+
display: flex;
|
|
10
|
+
flex-direction: column;
|
|
11
|
+
width: 220px;
|
|
12
|
+
max-height: min(320px, calc(100vh - 24px));
|
|
13
|
+
overflow: hidden;
|
|
14
|
+
color: var(--docserve-panel-text);
|
|
15
|
+
font-size: 0.78rem;
|
|
16
|
+
line-height: normal;
|
|
17
|
+
background: var(--docserve-panel-bg);
|
|
18
|
+
border: 1px solid var(--docserve-panel-border);
|
|
19
|
+
border-radius: 10px;
|
|
20
|
+
box-shadow: 0 4px 12px rgba(0, 0, 0, 0.12);
|
|
21
|
+
transform: translateY(-100%);
|
|
22
|
+
animation: docserve-servers-in 0.14s ease-out;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
@keyframes docserve-servers-in {
|
|
26
|
+
from {
|
|
27
|
+
opacity: 0;
|
|
28
|
+
transform: translateY(calc(-100% + 4px));
|
|
29
|
+
}
|
|
30
|
+
to {
|
|
31
|
+
opacity: 1;
|
|
32
|
+
transform: translateY(-100%);
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
.docserve-servers__head {
|
|
37
|
+
display: flex;
|
|
38
|
+
align-items: baseline;
|
|
39
|
+
gap: 6px;
|
|
40
|
+
padding: 7px 10px 6px;
|
|
41
|
+
border-bottom: 1px solid var(--docserve-panel-border);
|
|
42
|
+
color: var(--docserve-panel-text);
|
|
43
|
+
font-weight: 600;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
.docserve-servers__count {
|
|
47
|
+
color: var(--docserve-panel-muted);
|
|
48
|
+
font-variant-numeric: tabular-nums;
|
|
49
|
+
font-weight: 500;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
.docserve-servers__list {
|
|
53
|
+
display: flex;
|
|
54
|
+
flex-direction: column;
|
|
55
|
+
gap: 2px;
|
|
56
|
+
min-height: 0;
|
|
57
|
+
padding: 3px;
|
|
58
|
+
overflow: auto;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
.docserve-servers__note {
|
|
62
|
+
margin: 0;
|
|
63
|
+
padding: 12px 8px;
|
|
64
|
+
color: var(--docserve-panel-muted);
|
|
65
|
+
text-align: center;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
.docserve-servers__row {
|
|
69
|
+
display: grid;
|
|
70
|
+
grid-template-rows: auto auto;
|
|
71
|
+
grid-template-columns: 6px minmax(0, 1fr) auto auto;
|
|
72
|
+
column-gap: 6px;
|
|
73
|
+
row-gap: 2px;
|
|
74
|
+
align-items: center;
|
|
75
|
+
padding: 5px 6px;
|
|
76
|
+
border-radius: 7px;
|
|
77
|
+
color: inherit;
|
|
78
|
+
text-decoration: none;
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
a.docserve-servers__row:hover {
|
|
82
|
+
background: var(--docserve-dock-hover);
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
a.docserve-servers__row:focus-visible {
|
|
86
|
+
outline: none;
|
|
87
|
+
box-shadow: 0 0 0 2px var(--docserve-dock-accent);
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
.docserve-servers__row.is-current {
|
|
91
|
+
color: var(--docserve-panel-muted);
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
.docserve-servers__dot {
|
|
95
|
+
grid-row: 1 / span 2;
|
|
96
|
+
grid-column: 1;
|
|
97
|
+
width: 6px;
|
|
98
|
+
height: 6px;
|
|
99
|
+
border-radius: 50%;
|
|
100
|
+
background: var(--docserve-dock-border);
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
.docserve-servers__row.is-current .docserve-servers__dot {
|
|
104
|
+
background: var(--docserve-dock-accent);
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
.docserve-servers__name {
|
|
108
|
+
grid-row: 1;
|
|
109
|
+
grid-column: 2;
|
|
110
|
+
overflow: hidden;
|
|
111
|
+
font-weight: 600;
|
|
112
|
+
text-overflow: ellipsis;
|
|
113
|
+
white-space: nowrap;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
.docserve-servers__row.is-current .docserve-servers__name {
|
|
117
|
+
color: var(--docserve-panel-text);
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
.docserve-servers__path {
|
|
121
|
+
grid-row: 2;
|
|
122
|
+
grid-column: 2;
|
|
123
|
+
overflow: hidden;
|
|
124
|
+
color: var(--docserve-panel-muted);
|
|
125
|
+
font-size: 0.62rem;
|
|
126
|
+
text-overflow: ellipsis;
|
|
127
|
+
white-space: nowrap;
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
.docserve-servers__port {
|
|
131
|
+
grid-row: 2;
|
|
132
|
+
grid-column: 3;
|
|
133
|
+
color: var(--docserve-panel-muted);
|
|
134
|
+
font-size: 0.62rem;
|
|
135
|
+
font-variant-numeric: tabular-nums;
|
|
136
|
+
white-space: nowrap;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
.docserve-servers__check {
|
|
140
|
+
grid-row: 1 / span 2;
|
|
141
|
+
grid-column: 4;
|
|
142
|
+
color: var(--docserve-dock-accent);
|
|
143
|
+
font-size: 0.65rem;
|
|
144
|
+
}
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import { useEffect } from "react"
|
|
2
|
+
import type { ServersModel } from "../model.js"
|
|
3
|
+
|
|
4
|
+
export interface ServersPopoverProps {
|
|
5
|
+
model: ServersModel
|
|
6
|
+
}
|
|
7
|
+
|
|
8
|
+
export function ServersPopover({ model }: ServersPopoverProps) {
|
|
9
|
+
const open = model.open.value
|
|
10
|
+
const position = model.position.value
|
|
11
|
+
const servers = model.servers.value
|
|
12
|
+
const status = model.status.value
|
|
13
|
+
const error = model.error.value
|
|
14
|
+
|
|
15
|
+
useEffect(() => {
|
|
16
|
+
if (!open) return
|
|
17
|
+
const update = () => model.layout()
|
|
18
|
+
window.addEventListener("resize", update)
|
|
19
|
+
window.addEventListener("scroll", update, true)
|
|
20
|
+
return () => {
|
|
21
|
+
window.removeEventListener("resize", update)
|
|
22
|
+
window.removeEventListener("scroll", update, true)
|
|
23
|
+
}
|
|
24
|
+
}, [open, model])
|
|
25
|
+
|
|
26
|
+
if (!open || !position) return null
|
|
27
|
+
|
|
28
|
+
const note = status === "error"
|
|
29
|
+
? error ?? "Could not load servers"
|
|
30
|
+
: status === "loading"
|
|
31
|
+
? "Loading…"
|
|
32
|
+
: "No running servers"
|
|
33
|
+
|
|
34
|
+
return (
|
|
35
|
+
<section
|
|
36
|
+
className="docserve-servers"
|
|
37
|
+
style={{ left: `${position.left}px`, top: `${position.top}px` }}
|
|
38
|
+
role="dialog"
|
|
39
|
+
aria-label="Running servers"
|
|
40
|
+
>
|
|
41
|
+
<header className="docserve-servers__head">
|
|
42
|
+
<span>Running</span>
|
|
43
|
+
<span className="docserve-servers__count">({servers.length})</span>
|
|
44
|
+
</header>
|
|
45
|
+
<div className="docserve-servers__list">
|
|
46
|
+
{servers.length
|
|
47
|
+
? servers.map((server) => <ServerRow key={server.url} server={server} />)
|
|
48
|
+
: <p className="docserve-servers__note">{note}</p>}
|
|
49
|
+
</div>
|
|
50
|
+
</section>
|
|
51
|
+
)
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
function ServerRow({ server }: { server: DocServer }) {
|
|
55
|
+
const current = server.current
|
|
56
|
+
|
|
57
|
+
return (
|
|
58
|
+
<a
|
|
59
|
+
className={`docserve-servers__row${current ? " is-current" : ""}`}
|
|
60
|
+
href={server.url}
|
|
61
|
+
aria-current={current ? "page" : undefined}
|
|
62
|
+
title={`${server.name} — ${server.path}`}
|
|
63
|
+
>
|
|
64
|
+
<span className="docserve-servers__dot" />
|
|
65
|
+
<span className="docserve-servers__name">{server.name}</span>
|
|
66
|
+
<span className="docserve-servers__path">{server.path}</span>
|
|
67
|
+
<span className="docserve-servers__port">{server.port}</span>
|
|
68
|
+
{current ? <span className="docserve-servers__check">✓</span> : null}
|
|
69
|
+
</a>
|
|
70
|
+
)
|
|
71
|
+
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { useCallback, useState } from "react"
|
|
2
2
|
import { decoded, displayDate, pageUrl } from "../../../widget/lib/dom.js"
|
|
3
3
|
import { groupByFolder, groupByMonth } from "../grouping.js"
|
|
4
|
-
import type { PreviewModel } from "
|
|
4
|
+
import type { PreviewModel } from "#shared/client/preview-model.js"
|
|
5
5
|
import type { SidebarModel, SidebarView } from "../model.js"
|
|
6
6
|
|
|
7
7
|
export interface PageListProps {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { effect, signal } from "@preact/signals-react"
|
|
2
2
|
import { useEffect } from "react"
|
|
3
3
|
import { ICON_CHECK, ICON_CHEVRON_DOWN } from "../icons.js"
|
|
4
|
-
import { useModel } from "
|
|
4
|
+
import { useModel } from "#shared/client/use-model.js"
|
|
5
5
|
|
|
6
6
|
export interface RadioMenuOption<T extends string> {
|
|
7
7
|
id: T
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import { useEffect, useLayoutEffect } from "react"
|
|
2
2
|
import type { CSSProperties } from "react"
|
|
3
3
|
import { PageList } from "./PageList.js"
|
|
4
|
-
import { PreviewModel } from "
|
|
4
|
+
import { PreviewModel } from "#shared/client/preview-model.js"
|
|
5
5
|
import { SidebarHeader } from "./SidebarHeader.js"
|
|
6
6
|
import { TreeList } from "./TreeList.js"
|
|
7
|
-
import {
|
|
7
|
+
import { useModel } from "#shared/client/use-model.js"
|
|
8
8
|
import type { SidebarModel } from "../model.js"
|
|
9
9
|
|
|
10
10
|
export interface SidebarProps {
|
|
@@ -13,7 +13,7 @@ export interface SidebarProps {
|
|
|
13
13
|
|
|
14
14
|
export function Sidebar({ model }: SidebarProps) {
|
|
15
15
|
const docs = model.docs
|
|
16
|
-
const previews =
|
|
16
|
+
const previews = useModel(() => new PreviewModel())
|
|
17
17
|
const pages = model.pages.value
|
|
18
18
|
const status = model.status.value
|
|
19
19
|
const view = model.view.value
|
|
@@ -108,9 +108,16 @@ function TreeRow({ node, depth, collapsed, model, target, currentPage }: TreeRow
|
|
|
108
108
|
title={page.title}
|
|
109
109
|
style={style}
|
|
110
110
|
>
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
111
|
+
{page.favicon ? (
|
|
112
|
+
<span className="docserve-sidebar__tree-slot docserve-sidebar__tree-icon">
|
|
113
|
+
<Favicon src={page.favicon} />
|
|
114
|
+
</span>
|
|
115
|
+
) : (
|
|
116
|
+
<span
|
|
117
|
+
className="docserve-sidebar__tree-slot docserve-sidebar__tree-icon"
|
|
118
|
+
dangerouslySetInnerHTML={{ __html: ICON_FILE }}
|
|
119
|
+
/>
|
|
120
|
+
)}
|
|
114
121
|
<span className="docserve-sidebar__tree-label">{node.name}</span>
|
|
115
122
|
</a>
|
|
116
123
|
)
|
|
@@ -1,7 +1,12 @@
|
|
|
1
1
|
import { effect, signal } from "@preact/signals-react"
|
|
2
2
|
|
|
3
3
|
export const THUMB_W = 960
|
|
4
|
-
|
|
4
|
+
|
|
5
|
+
export interface PreviewModelOptions {
|
|
6
|
+
max?: number
|
|
7
|
+
rootMargin?: string
|
|
8
|
+
scope?: "element" | "viewport"
|
|
9
|
+
}
|
|
5
10
|
|
|
6
11
|
interface QueueItem {
|
|
7
12
|
iframe: HTMLIFrameElement
|
|
@@ -9,6 +14,9 @@ interface QueueItem {
|
|
|
9
14
|
}
|
|
10
15
|
|
|
11
16
|
export class PreviewModel {
|
|
17
|
+
readonly #max: number
|
|
18
|
+
readonly #rootMargin: string
|
|
19
|
+
readonly #scope: "element" | "viewport"
|
|
12
20
|
#root = signal<HTMLElement | null>(null)
|
|
13
21
|
|
|
14
22
|
readonly setRoot = (element: HTMLElement | null): void => {
|
|
@@ -26,10 +34,16 @@ export class PreviewModel {
|
|
|
26
34
|
#loads = new Map<HTMLIFrameElement, () => void>()
|
|
27
35
|
#active = 0
|
|
28
36
|
|
|
37
|
+
constructor(options: PreviewModelOptions = {}) {
|
|
38
|
+
this.#max = options.max ?? 2
|
|
39
|
+
this.#rootMargin = options.rootMargin ?? "150px"
|
|
40
|
+
this.#scope = options.scope ?? "element"
|
|
41
|
+
}
|
|
42
|
+
|
|
29
43
|
subscribe(): () => void {
|
|
30
44
|
const stop = effect(() => {
|
|
31
45
|
const root = this.#root.value
|
|
32
|
-
if (!root) return
|
|
46
|
+
if (!root && this.#scope === "element") return
|
|
33
47
|
|
|
34
48
|
const observer = new IntersectionObserver((entries) => {
|
|
35
49
|
for (const entry of entries) {
|
|
@@ -41,7 +55,7 @@ export class PreviewModel {
|
|
|
41
55
|
this.#queue.push({ iframe, src })
|
|
42
56
|
this.#pump()
|
|
43
57
|
}
|
|
44
|
-
}, { root, rootMargin:
|
|
58
|
+
}, { root, rootMargin: this.#rootMargin })
|
|
45
59
|
|
|
46
60
|
const resize = new ResizeObserver((entries) => {
|
|
47
61
|
for (const entry of entries) {
|
|
@@ -97,7 +111,7 @@ export class PreviewModel {
|
|
|
97
111
|
}
|
|
98
112
|
|
|
99
113
|
#pump(): void {
|
|
100
|
-
while (this.#active <
|
|
114
|
+
while (this.#active < this.#max && this.#queue.length) {
|
|
101
115
|
const item = this.#queue.shift()
|
|
102
116
|
if (!item || !item.iframe.isConnected) continue
|
|
103
117
|
this.#active++
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { useEffect,
|
|
1
|
+
import { useEffect, useState } from "react"
|
|
2
2
|
|
|
3
3
|
export interface Subscribable {
|
|
4
4
|
subscribe(): (() => void) | void
|
|
@@ -11,13 +11,6 @@ export function useModel<T extends object>(create: () => T): T {
|
|
|
11
11
|
return model
|
|
12
12
|
}
|
|
13
13
|
|
|
14
|
-
/** Create a model once and run its `subscribe()` before paint. */
|
|
15
|
-
export function useLayoutModel<T extends object>(create: () => T): T {
|
|
16
|
-
const [model] = useState(create)
|
|
17
|
-
useLayoutEffect(() => subscribe(model), [model])
|
|
18
|
-
return model
|
|
19
|
-
}
|
|
20
|
-
|
|
21
14
|
function subscribe(model: object): (() => void) | void {
|
|
22
15
|
const subscribable = model as Partial<Subscribable>
|
|
23
16
|
if (typeof subscribable.subscribe !== "function") return
|
package/src/shared/types.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
// Public contracts for the docserve widget and its plugins.
|
|
2
2
|
|
|
3
|
-
/** One HTML page
|
|
3
|
+
/** One HTML page returned by `docserve:pages:list`. */
|
|
4
4
|
interface DocPage {
|
|
5
5
|
/** Title from `<title>`, else the file name. */
|
|
6
6
|
title: string
|
|
@@ -16,6 +16,22 @@ interface DocPage {
|
|
|
16
16
|
favicon?: string
|
|
17
17
|
}
|
|
18
18
|
|
|
19
|
+
/** One live server returned by `docserve:servers:list`. */
|
|
20
|
+
interface DocServer {
|
|
21
|
+
/** Folder name. */
|
|
22
|
+
name: string
|
|
23
|
+
/** Display path with the home directory collapsed to `~`. */
|
|
24
|
+
path: string
|
|
25
|
+
/** Deterministic hue (0-359) shared with the gallery favicon. */
|
|
26
|
+
hue: number
|
|
27
|
+
/** Origin URL, e.g. `http://localhost:4242/`. */
|
|
28
|
+
url: string
|
|
29
|
+
/** Bound port. */
|
|
30
|
+
port: number
|
|
31
|
+
/** True for the server handling this request. */
|
|
32
|
+
current: boolean
|
|
33
|
+
}
|
|
34
|
+
|
|
19
35
|
/** Identity of the served folder, from the injected script's data attributes. */
|
|
20
36
|
interface DocsInfo {
|
|
21
37
|
/** Folder name, e.g. `reports`. */
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
// Page listing for the widget:
|
|
2
|
-
import { decoded, pageUrl } from "
|
|
1
|
+
// Page listing for the widget: docserve:pages:list, cached until a change arrives.
|
|
2
|
+
import { decoded, pageUrl } from "../lib/dom.js"
|
|
3
|
+
import { callServer } from "./rpc-client.js"
|
|
3
4
|
|
|
4
5
|
/**
|
|
5
6
|
* @param {{ rpc: RpcContext }} options
|
|
@@ -35,11 +36,7 @@ export function createPages({ rpc }) {
|
|
|
35
36
|
if (cache) return cache
|
|
36
37
|
if (pending) return pending
|
|
37
38
|
|
|
38
|
-
pending =
|
|
39
|
-
.then((response) => {
|
|
40
|
-
if (!response.ok) throw new Error(`/api/files: ${response.status}`)
|
|
41
|
-
return response.json()
|
|
42
|
-
})
|
|
39
|
+
pending = callServer("docserve:pages:list")
|
|
43
40
|
.then((data) => {
|
|
44
41
|
const pages = Array.isArray(data) ? data : []
|
|
45
42
|
cache = pages
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @param {string} method
|
|
3
|
+
* @param {any[]} [args]
|
|
4
|
+
* @param {{ signal?: AbortSignal }} [options]
|
|
5
|
+
* @returns {Promise<any>}
|
|
6
|
+
*/
|
|
7
|
+
export async function callServer(method, args = [], options = {}) {
|
|
8
|
+
const response = await fetch("/__docserve/rpc", {
|
|
9
|
+
method: "POST",
|
|
10
|
+
cache: "no-store",
|
|
11
|
+
headers: { "content-type": "application/json", accept: "application/json" },
|
|
12
|
+
body: JSON.stringify({ method, args }),
|
|
13
|
+
signal: options.signal,
|
|
14
|
+
})
|
|
15
|
+
|
|
16
|
+
let payload = null
|
|
17
|
+
try {
|
|
18
|
+
payload = await response.json()
|
|
19
|
+
} catch { }
|
|
20
|
+
|
|
21
|
+
const message = payload?.error?.message
|
|
22
|
+
if (!response.ok || message)
|
|
23
|
+
throw new Error(message ?? `/__docserve/rpc: ${response.status}`)
|
|
24
|
+
return payload?.result
|
|
25
|
+
}
|