Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/content/8.references/6.hub-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@ What `DevframeHubContext` adds to `DevframeNodeContext`: [Hub](/guide/hub).
|---|---|---|
| `ctx.docks` | `register / update / values / activate` | Dock entries (iframes, launchers, custom-render) and groups; `activate(dockId, params?)` sets the active dock ([Cross-iframe dock activation](/guide/hub#cross-iframe-dock-activation)). |
| `ctx.terminals` | `register / startChildProcess / startPtySession` | Aggregate terminal sessions, streaming output ([Terminals](/add-ons/devframes/terminals#hub-aggregation)). |
| `ctx.messages` | `add / update / remove / clear` | Server-side toast/notification queue (FIFO, capped at 1000). |
| `ctx.messages` | `add / update / remove / clear / listSince` | Server-side toast/notification queue (FIFO, capped at 1000). |
| `ctx.commands` | `register / execute / list` | Hierarchical command palette with keybindings and `when` clauses. |

For incremental message reads, call `ctx.messages.listSince(version, instanceId)` with both values from the previous result. A missing or foreign `instanceId` returns a full snapshot, as does an expired version. When `full` is true, replace the cached list. Otherwise, apply `removedIds` before adding or updating `entries`. Numeric-only callers remain supported through full snapshots.

## Launcher fields

The optional `launcher` fields that make a `type: 'launcher'` dock entry a live process controller: [Process-control launchers](/guide/hub#process-control-launchers).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type { Meta, StoryObj } from '@storybook/vue3-vite'
import { h, onMounted } from 'vue'
import { MESSAGES_DOCK_ID } from '../../constants'
import { addToast } from '../../state/toasts'
import { createToastStore } from '../../state/toasts'
import { message } from '../../stories/fixtures'
import ToastOverlay from './ToastOverlay.vue'

Expand All @@ -28,28 +28,29 @@ type Story = StoryObj<typeof meta>
export const Stack: Story = {
render: () => ({
setup() {
const toastStore = createToastStore()
onMounted(() => {
addToast(message({
toastStore.add(message({
level: 'error',
message: 'Build failed',
description: '2 errors in 1 file',
notify: true,
autoDismiss: 10 ** 7,
}))
addToast(message({
toastStore.add(message({
level: 'warn',
message: 'Slow HMR update (820ms)',
notify: true,
autoDismiss: 10 ** 7,
}))
addToast(message({
toastStore.add(message({
level: 'success',
message: 'Server ready on :5173',
notify: true,
autoDismiss: 10 ** 7,
}))
})
return () => h(ToastOverlay)
return () => h(ToastOverlay, { toastStore })
},
}),
}
Expand All @@ -58,8 +59,9 @@ export const Stack: Story = {
export const WithAction: Story = {
render: () => ({
setup() {
const toastStore = createToastStore()
onMounted(() => {
addToast(message({
toastStore.add(message({
level: 'warn',
message: 'New a11y violation detected',
notify: true,
Expand All @@ -74,7 +76,7 @@ export const WithAction: Story = {
],
}))
})
return () => h(ToastOverlay)
return () => h(ToastOverlay, { toastStore })
},
}),
}
25 changes: 12 additions & 13 deletions packages/hub-ui/src/client/components/display/ToastOverlay.vue
Original file line number Diff line number Diff line change
@@ -1,25 +1,24 @@
<script setup lang="ts">
import type { DevframeMessageAction } from '@devframes/hub'
import type { DocksContext } from '@devframes/hub/client'
import type { createToastStore } from '../../state/toasts'
import { computed } from 'vue'
import { MESSAGES_DOCK_ID } from '../../constants'
import { selectMessage, useMessages } from '../../state/messages'
import { dismissToast, useToasts } from '../../state/toasts'
import { useMessages } from '../../state/messages'
import MessageItem from '../message/MessageItem.vue'

const props = defineProps<{
context?: DocksContext
toastStore?: ReturnType<typeof createToastStore>
}>()

// Initialize messages state early so the RPC handler is registered
// and toasts are triggered even before the messages panel is opened
if (props.context)
useMessages(props.context)

const toasts = useToasts()
const messages = computed(() => props.context && useMessages(props.context))
const toasts = computed(() => messages.value?.toasts ?? props.toastStore)

function openMessages(toastId: string) {
dismissToast(toastId)
selectMessage(toastId)
toasts.value?.dismiss(toastId)
if (messages.value)
messages.value.pendingSelectId = toastId
// Open the messages panel provided by `@devframes/plugin-messages`
// (its dock id is the plugin's devframe id).
props.context?.docks.switchEntry(MESSAGES_DOCK_ID)
Expand All @@ -42,7 +41,7 @@ function dispatchAction(action: DevframeMessageAction) {

<template>
<div
v-if="toasts.length > 0"
v-if="toasts?.items.length"
class="fixed bottom-4 right-4 z-dock-toast flex flex-col gap-2 pointer-events-auto w-72"
>
<TransitionGroup
Expand All @@ -52,7 +51,7 @@ function dispatchAction(action: DevframeMessageAction) {
leave-to-class="opacity-0 translate-x-4"
>
<div
v-for="toast of toasts"
v-for="toast of toasts.items"
:key="toast.id"
class="bg-toast-glass border color-base border-base shadow-xl cursor-pointer transition-colors rounded"
@click="openMessages(toast.id)"
Expand All @@ -69,7 +68,7 @@ function dispatchAction(action: DevframeMessageAction) {
</button>
<button
class="flex-none op30 hover:op100 p-0.5 rounded hover:bg-active transition"
@click.stop="dismissToast(toast.id)"
@click.stop="toasts.dismiss(toast.id)"
>
<div class="i-ph-x w-3 h-3" />
</button>
Expand Down
108 changes: 7 additions & 101 deletions packages/hub-ui/src/client/components/dock/DockStandalone.vue
Original file line number Diff line number Diff line change
@@ -1,109 +1,15 @@
<script setup lang="ts">
import type { DocksContext } from '@devframes/hub/client'
import { computed, useTemplateRef, watch } from 'vue'
import { t } from '../../i18n'
import { getEntryGroup } from '../../state/dock-settings'
import { getEntryPaneKey, useIframePanes } from '../../utils/useIframePanes'
import { useIsRpcTrusted } from '../../utils/useIsRpcTrusted'
import CommandPalette from '../command-palette/CommandPalette.vue'
import Confirm from '../display/Confirm.vue'
import ToastOverlay from '../display/ToastOverlay.vue'
import FloatingElements from '../floating/FloatingElements.vue'
import BrandMark from '../icons/BrandMark.vue'
import ViewBuiltinClientAuthNotice from '../views-builtin/ViewBuiltinClientAuthNotice.vue'
import ViewEntry from '../views/ViewEntry.vue'
import ColorSchemeRoot from './ColorSchemeRoot.vue'
import DockEntriesWithCategories from './DockEntriesWithCategories.vue'
import DockGroupSidebar from './DockGroupSidebar.vue'
import { ref, watch } from 'vue'
import DockStandaloneShell from './DockStandaloneShell.vue'

const props = defineProps<{
context: DocksContext
}>()
const props = defineProps<{ context: DocksContext }>()

const context = props.context
const viewsContainer = useTemplateRef<HTMLElement>('viewsContainer')
const panes = useIframePanes(viewsContainer, context.panel, () => getEntryPaneKey(context.docks.selected))

const isRpcTrusted = useIsRpcTrusted(context, (isTrusted) => {
if (!isTrusted) {
context.docks.switchEntry(null)
}
})

/** Select from the visible dock rail through normal activation, including client scripts and group routing. */
watch(
[
() => context.docks.groupedEntries,
isRpcTrusted,
],
([groups, trusted]) => {
if (!trusted || context.docks.selectedId)
return
const entry = groups.flatMap(([, entries]) => entries)
.find(entry => entry.type !== 'action' && entry.type !== '~builtin')
if (entry)
void context.docks.switchEntry(entry.id)
},
{ immediate: true },
)

const groupedEntries = computed(() => context.docks.groupedEntries)
const activeGroup = computed(() => getEntryGroup(context.docks.entries, context.docks.selected))

function switchEntry(id: string | undefined) {
if (id) {
context.docks.switchEntry(id)
}
}
// Panes and trust subscriptions belong to the context that created them.
const shellKey = ref(0)
watch(() => props.context, () => shellKey.value++)
</script>

<template>
<ColorSchemeRoot>
<main v-if="!isRpcTrusted" class="h-screen w-screen of-hidden">
<ViewBuiltinClientAuthNotice :context="context" />
</main>
<div v-else class="h-screen w-screen of-clip grid cols-[max-content_1fr]">
<nav :aria-label="t('settings.docks')" class="border-r border-base flex flex-col min-h-0">
<div class="p2 border-b border-base flex">
<BrandMark class="w-7 h-7 ma" />
</div>
<div class="transition duration-200 p2 of-y-auto">
<DockEntriesWithCategories
:context="context"
:groups="groupedEntries"
:is-vertical="false"
:selected="context.docks.selected"
:dim-inactive="false"
@select="(e) => switchEntry(e?.id)"
>
<template #separator>
<div class="border-base border-b w-full my-2" />
</template>
</DockEntriesWithCategories>
</div>
</nav>
<main class="min-h-0 flex">
<DockGroupSidebar
v-if="activeGroup"
:context
:group="activeGroup"
:selected-id="context.docks.selected?.id ?? null"
/>
<div class="relative flex-1 min-w-0 min-h-0 of-clip">
<ViewEntry
v-if="context.docks.selected && panes"
:key="context.docks.selected.id"
:entry="context.docks.selected"
:context
:panes="panes"
/>
<div id="devframes-views-container" ref="viewsContainer" class="pointer-events-auto" />
</div>
</main>
</div>
<FloatingElements />
<CommandPalette :context />
<ToastOverlay :context />
<Confirm />
</ColorSchemeRoot>
<DockStandaloneShell :key="shellKey" :context />
</template>
109 changes: 109 additions & 0 deletions packages/hub-ui/src/client/components/dock/DockStandaloneShell.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
<script setup lang="ts">
import type { DocksContext } from '@devframes/hub/client'
import { computed, useTemplateRef, watch } from 'vue'
import { t } from '../../i18n'
import { getEntryGroup } from '../../state/dock-settings'
import { getEntryPaneKey, useIframePanes } from '../../utils/useIframePanes'
import { useIsRpcTrusted } from '../../utils/useIsRpcTrusted'
import CommandPalette from '../command-palette/CommandPalette.vue'
import Confirm from '../display/Confirm.vue'
import ToastOverlay from '../display/ToastOverlay.vue'
import FloatingElements from '../floating/FloatingElements.vue'
import BrandMark from '../icons/BrandMark.vue'
import ViewBuiltinClientAuthNotice from '../views-builtin/ViewBuiltinClientAuthNotice.vue'
import ViewEntry from '../views/ViewEntry.vue'
import ColorSchemeRoot from './ColorSchemeRoot.vue'
import DockEntriesWithCategories from './DockEntriesWithCategories.vue'
import DockGroupSidebar from './DockGroupSidebar.vue'

const props = defineProps<{
context: DocksContext
}>()

const context = props.context
const viewsContainer = useTemplateRef<HTMLElement>('viewsContainer')
const panes = useIframePanes(viewsContainer, context.panel, () => getEntryPaneKey(context.docks.selected))

const isRpcTrusted = useIsRpcTrusted(context, (isTrusted) => {
if (!isTrusted) {
context.docks.switchEntry(null)
}
})

/** Select from the visible dock rail through normal activation, including client scripts and group routing. */
watch(
[
() => context.docks.groupedEntries,
isRpcTrusted,
],
([groups, trusted]) => {
if (!trusted || context.docks.selectedId)
return
const entry = groups.flatMap(([, entries]) => entries)
.find(entry => entry.type !== 'action' && entry.type !== '~builtin')
if (entry)
void context.docks.switchEntry(entry.id)
},
{ immediate: true },
)

const groupedEntries = computed(() => context.docks.groupedEntries)
const activeGroup = computed(() => getEntryGroup(context.docks.entries, context.docks.selected))

function switchEntry(id: string | undefined) {
if (id) {
context.docks.switchEntry(id)
}
}
</script>

<template>
<ColorSchemeRoot>
<main v-if="!isRpcTrusted" class="h-screen w-screen of-hidden">
<ViewBuiltinClientAuthNotice :context="context" />
</main>
<div v-else class="h-screen w-screen of-clip grid cols-[max-content_1fr]">
<nav :aria-label="t('settings.docks')" class="border-r border-base flex flex-col min-h-0">
<div class="p2 border-b border-base flex">
<BrandMark class="w-7 h-7 ma" />
</div>
<div class="transition duration-200 p2 of-y-auto">
<DockEntriesWithCategories
:context="context"
:groups="groupedEntries"
:is-vertical="false"
:selected="context.docks.selected"
:dim-inactive="false"
@select="(e) => switchEntry(e?.id)"
>
<template #separator>
<div class="border-base border-b w-full my-2" />
</template>
</DockEntriesWithCategories>
</div>
</nav>
<main class="min-h-0 flex">
<DockGroupSidebar
v-if="activeGroup"
:context
:group="activeGroup"
:selected-id="context.docks.selected?.id ?? null"
/>
<div class="relative flex-1 min-w-0 min-h-0 of-clip">
<ViewEntry
v-if="context.docks.selected && panes"
:key="context.docks.selected.id"
:entry="context.docks.selected"
:context
:panes="panes"
/>
<div id="devframes-views-container" ref="viewsContainer" class="pointer-events-auto" />
</div>
</main>
</div>
<FloatingElements />
<CommandPalette :context />
<ToastOverlay :context />
<Confirm />
</ColorSchemeRoot>
</template>
Loading
Loading