useSetupStatus

Composable that reports an app's first-time-setup status (ADR-042). Backs CnAppRoot's setup phase (gate on required-unmet) and drives CnSetupWizard.

Signature

import { useSetupStatus } from '@conduction/nextcloud-vue'

const { requiredUnmet, optionalUnmet, completed, loading, refresh } = useSetupStatus(appId, manifest)

Argument	Type	Description
appId	string	Nextcloud app id (e.g. 'procest').
manifest	object	The app manifest; reads manifest.setup.steps[].required.

It fetches GET /apps/{appId}/api/setup/status → { version, completed, steps: { <id>: { done, detail } } }, caches the result per appId for the page lifetime, and cross-references the manifest's required flags. On error it falls back to "nothing done" so a failed lookup never crashes the shell.

Return value

Key	Type	Description
steps	ComputedRef<object[]>	The manifest steps merged with their server done/detail.
status	Ref<object>	The raw server status payload.
requiredUnmet	ComputedRef<object[]>	Required steps that are not yet done — non-empty ⇒ gate the app.
optionalUnmet	ComputedRef<object[]>	Optional steps not yet done — auto-open the wizard once (dismissible).
completed	ComputedRef<boolean>	Server completion flag, never true while a required step is unmet.
enabled	boolean	Whether the manifest declares an active setup block.
loading	Ref<boolean>	true while the status fetch is in flight.
error	Ref<Error|null>	The last fetch error, if any.
refresh	() => Promise<void>	Re-fetch the status (call after a step completes).

Notes

• Mirrors useAppStatus: one shared fetch + reactive state per appId.
• Gating uses requiredUnmet; the optional auto-open uses optionalUnmet + completed.