refactor: use DI for instance page + subpages (#6987)

* refactor: use DI for instance page + subpages

* fix: qa

* refactor: layout.vue bring up a layer

* refactor: rename folders

* import order

* refactor: move settings into instance page

* fix: lint

---------

Co-authored-by: tdgao <mr.trumgao@gmail.com>

apps/app-frontend/src/pages/instance/components/admonitions/index.vue

@@ -0,0 +1,141 @@
+<template>
+	<StackedAdmonitions v-bind="$attrs" :items="stackItems" class="w-full">
+		<template #item="{ item, dismissible }">
+			<InstanceAdmonitionsSharedInstanceStale
+				v-if="item.kind === 'shared-instance-stale'"
+				:instance="instance"
+				@published="emit('published')"
+			/>
+			<InstanceAdmonitionsSharedInstanceUpdateAvailable
+				v-else-if="item.kind === 'shared-instance-update-available'"
+				:instance-name="instance.name"
+				@review="emit('review-update', $event)"
+			/>
+			<InstanceAdmonitionsSharedInstanceWrongAccount
+				v-else-if="item.kind === 'shared-instance-wrong-account'"
+				:expected-user-id="sharedInstanceExpectedUserId"
+				:role="sharedInstanceRole"
+				:signed-out="sharedInstanceSignedOut"
+			/>
+			<InstanceAdmonitionsSharedInstanceUnavailable
+				v-else-if="item.kind === 'shared-instance-unavailable'"
+				:reason="displayedSharedInstanceUnavailableReason"
+				:manager="sharedInstanceUnavailableManager"
+				:dismissible="dismissible"
+				@dismiss="sharedInstanceUnavailableDismissed = true"
+				@delete="emit('delete')"
+			/>
+		</template>
+	</StackedAdmonitions>
+</template>
+
+<script setup lang="ts">
+import { StackedAdmonitions } from '@modrinth/ui'
+import { computed, ref, watch } from 'vue'
+
+import type { SharedInstanceUnavailableReason } from '@/helpers/install'
+import type { GameInstance } from '@/helpers/types'
+
+import InstanceAdmonitionsSharedInstanceStale from './shared-instance-stale.vue'
+import InstanceAdmonitionsSharedInstanceUnavailable from './shared-instance-unavailable.vue'
+import InstanceAdmonitionsSharedInstanceUpdateAvailable from './shared-instance-update-available.vue'
+import InstanceAdmonitionsSharedInstanceWrongAccount from './shared-instance-wrong-account.vue'
+import type { InstanceAdmonitionItem, SharedInstanceRole } from './types.ts'
+
+defineOptions({
+	inheritAttrs: false,
+})
+
+const props = defineProps<{
+	instance: GameInstance
+	sharedInstanceUnavailableReason?: SharedInstanceUnavailableReason | null
+	sharedInstanceUnavailableManager?: string | null
+	sharedInstanceWrongAccount?: boolean
+	sharedInstanceExpectedUserId?: string | null
+	sharedInstanceRole?: SharedInstanceRole | null
+	sharedInstanceSignedOut?: boolean
+	sharedInstanceUpdateAvailable?: boolean
+}>()
+
+const emit = defineEmits<{
+	published: []
+	delete: []
+	'review-update': [event: MouseEvent]
+}>()
+
+const sharedInstanceWrongAccount = computed(() => props.sharedInstanceWrongAccount ?? false)
+const displayedSharedInstanceUnavailableReason = computed<SharedInstanceUnavailableReason | null>(
+	() =>
+		props.instance.quarantined ? 'quarantined' : (props.sharedInstanceUnavailableReason ?? null),
+)
+const sharedInstanceUnavailableDismissed = ref(false)
+const showSharedInstancePublishAdmonition = computed(
+	() =>
+		!sharedInstanceWrongAccount.value &&
+		props.instance.install_stage === 'installed' &&
+		props.instance.shared_instance?.role === 'owner' &&
+		props.instance.shared_instance.status === 'stale',
+)
+const showSharedInstanceUpdateAdmonition = computed(
+	() =>
+		!sharedInstanceWrongAccount.value &&
+		!displayedSharedInstanceUnavailableReason.value &&
+		props.instance.install_stage === 'installed' &&
+		props.sharedInstanceRole === 'member' &&
+		props.sharedInstanceUpdateAvailable === true,
+)
+
+const stackItems = computed<InstanceAdmonitionItem[]>(() => {
+	const items: InstanceAdmonitionItem[] = []
+
+	if (sharedInstanceWrongAccount.value) {
+		items.push({
+			id: 'shared-instance-wrong-account',
+			type: 'warning',
+			dismissible: false,
+			kind: 'shared-instance-wrong-account',
+		})
+	}
+
+	const unavailableReason = displayedSharedInstanceUnavailableReason.value
+	const sharedInstanceQuarantined = unavailableReason === 'quarantined'
+	if (
+		unavailableReason &&
+		(sharedInstanceQuarantined || !sharedInstanceUnavailableDismissed.value)
+	) {
+		items.push({
+			id: 'shared-instance-unavailable',
+			type: 'warning',
+			dismissible: !sharedInstanceQuarantined,
+			kind: 'shared-instance-unavailable',
+		})
+	}
+
+	if (showSharedInstancePublishAdmonition.value) {
+		items.push({
+			id: 'shared-instance-stale',
+			type: 'warning',
+			dismissible: false,
+			kind: 'shared-instance-stale',
+		})
+	}
+
+	if (showSharedInstanceUpdateAdmonition.value) {
+		items.push({
+			id: 'shared-instance-update-available',
+			type: 'info',
+			dismissible: false,
+			kind: 'shared-instance-update-available',
+		})
+	}
+
+	return items
+})
+
+watch(
+	() => [props.instance.id, displayedSharedInstanceUnavailableReason.value],
+	() => {
+		sharedInstanceUnavailableDismissed.value = false
+	},
+)
+</script>

apps/app-frontend/src/pages/instance/components/admonitions/messages.ts

@@ -0,0 +1,82 @@
+import { defineMessages } from '@modrinth/ui'
+
+export const instanceAdmonitionsMessages = defineMessages({
+	sharedInstanceChangesHeader: {
+		id: 'app.instance.admonitions.shared-instance.changes-header',
+		defaultMessage: "Your changes haven't been shared yet",
+	},
+	sharedInstanceChangesBody: {
+		id: 'app.instance.admonitions.shared-instance.changes-body',
+		defaultMessage: "Your local instance is ahead of the users you've shared it with.",
+	},
+	sharedInstancePublishButton: {
+		id: 'app.instance.admonitions.shared-instance.publish-button',
+		defaultMessage: 'Push update',
+	},
+	sharedInstancePublishingButton: {
+		id: 'app.instance.admonitions.shared-instance.publishing-button',
+		defaultMessage: 'Pushing...',
+	},
+	sharedInstanceReviewingButton: {
+		id: 'app.instance.admonitions.shared-instance.reviewing-button',
+		defaultMessage: 'Reviewing...',
+	},
+	sharedInstanceUpdateAvailableHeader: {
+		id: 'app.instance.admonitions.shared-instance.update-available-header',
+		defaultMessage: 'An update is available',
+	},
+	sharedInstanceUpdateAvailableBody: {
+		id: 'app.instance.admonitions.shared-instance.update-available-body',
+		defaultMessage:
+			'An update is required to play {name}. Please update to latest version to launch the game.',
+	},
+	sharedInstanceReviewUpdateButton: {
+		id: 'app.instance.admonitions.shared-instance.review-update-button',
+		defaultMessage: 'Review update',
+	},
+	sharedInstanceReviewHeader: {
+		id: 'app.instance.admonitions.shared-instance.review-header',
+		defaultMessage: 'Review changes',
+	},
+	sharedInstanceReviewAdmonitionHeader: {
+		id: 'app.instance.admonitions.shared-instance.review-admonition-header',
+		defaultMessage: 'Push update',
+	},
+	sharedInstanceReviewDescription: {
+		id: 'app.instance.admonitions.shared-instance.review-description',
+		defaultMessage:
+			'Review the content changes that will be shared with everyone using this instance.',
+	},
+	sharedInstanceAddedLabel: {
+		id: 'app.instance.admonitions.shared-instance.added-label',
+		defaultMessage: 'Added',
+	},
+	sharedInstanceRemovedLabel: {
+		id: 'app.instance.admonitions.shared-instance.removed-label',
+		defaultMessage: 'Removed',
+	},
+	sharedInstanceWrongAccountHeader: {
+		id: 'app.instance.shared-instance-wrong-account.warning-header',
+		defaultMessage: 'You are using the wrong Modrinth account',
+	},
+	sharedInstanceSignedOutHeader: {
+		id: 'app.instance.shared-instance-wrong-account.signed-out-header',
+		defaultMessage: 'You need to sign in to Modrinth',
+	},
+	sharedInstanceWrongAccountSignInAs: {
+		id: 'app.instance.shared-instance-wrong-account.sign-in-as-label',
+		defaultMessage: 'Sign in as',
+	},
+	sharedInstanceWrongAccountUserBody: {
+		id: 'app.instance.shared-instance-wrong-account.user-admonition-body-v2',
+		defaultMessage: 'to receive updates for this shared instance.',
+	},
+	sharedInstanceWrongAccountOwnerBody: {
+		id: 'app.instance.shared-instance-wrong-account.owner-admonition-body-v2',
+		defaultMessage: "to manage this shared instance. You won't be able to push updates to users.",
+	},
+	sharedInstanceWrongAccountFallbackUsername: {
+		id: 'app.instance.shared-instance-wrong-account.fallback-username',
+		defaultMessage: 'the linked account',
+	},
+})

apps/app-frontend/src/pages/instance/components/admonitions/shared-instance-stale.vue

@@ -0,0 +1,66 @@
+<template>
+	<Admonition
+		type="info"
+		inline-actions
+		:header="formatMessage(messages.sharedInstanceChangesHeader)"
+	>
+		{{ formatMessage(messages.sharedInstanceChangesBody) }}
+		<template #actions>
+			<ButtonStyled color="blue">
+				<button class="!h-10" :disabled="isPublishButtonDisabled" @click="reviewChanges">
+					<SpinnerIcon
+						v-if="isReviewingPublish || isPublishing"
+						class="animate-spin"
+						aria-hidden="true"
+					/>
+					<UploadIcon v-else aria-hidden="true" />
+					{{
+						isPublishing
+							? formatMessage(messages.sharedInstancePublishingButton)
+							: isReviewingPublish
+								? formatMessage(messages.sharedInstanceReviewingButton)
+								: formatMessage(messages.sharedInstancePublishButton)
+					}}
+				</button>
+			</ButtonStyled>
+		</template>
+	</Admonition>
+
+	<SharedInstancePublishModal
+		ref="publishModal"
+		:instance="instance"
+		@published="emit('published')"
+		@state-change="publishState = $event"
+	/>
+</template>
+
+<script setup lang="ts">
+import { SpinnerIcon, UploadIcon } from '@modrinth/assets'
+import { Admonition, ButtonStyled, useVIntl } from '@modrinth/ui'
+import { computed, ref } from 'vue'
+
+import SharedInstancePublishModal from '@/components/ui/shared-instances/SharedInstancePublishModal.vue'
+import type { GameInstance } from '@/helpers/types'
+
+import { instanceAdmonitionsMessages as messages } from './messages'
+
+defineProps<{
+	instance: GameInstance
+}>()
+
+const emit = defineEmits<{
+	published: []
+}>()
+
+const { formatMessage } = useVIntl()
+const publishModal = ref<InstanceType<typeof SharedInstancePublishModal>>()
+const publishState = ref<'idle' | 'reviewing' | 'publishing'>('idle')
+const isPublishing = computed(() => publishState.value === 'publishing')
+const isReviewingPublish = computed(() => publishState.value === 'reviewing')
+
+const isPublishButtonDisabled = computed(() => isPublishing.value || isReviewingPublish.value)
+
+function reviewChanges(e?: MouseEvent) {
+	publishModal.value?.show(e)
+}
+</script>

apps/app-frontend/src/pages/instance/components/admonitions/shared-instance-unavailable.vue

@@ -0,0 +1,51 @@
+<template>
+	<Admonition
+		type="warning"
+		:inline-actions="reason === 'quarantined'"
+		:header="formatMessage(sharedInstanceUnavailableTitleMessage(reason ?? null))"
+		:dismissible="dismissible"
+		@dismiss="emit('dismiss')"
+	>
+		{{ formatSharedInstanceUnavailable(reason ?? null, manager) }}
+		<template v-if="reason === 'quarantined'" #actions>
+			<ButtonStyled color="orange">
+				<button class="!h-10" @click="emit('delete')">
+					<TrashIcon aria-hidden="true" />
+					{{ formatMessage(messages.deleteInstance) }}
+				</button>
+			</ButtonStyled>
+		</template>
+	</Admonition>
+</template>
+
+<script setup lang="ts">
+import { TrashIcon } from '@modrinth/assets'
+import { Admonition, ButtonStyled, defineMessages, useVIntl } from '@modrinth/ui'
+
+import type { SharedInstanceUnavailableReason } from '@/helpers/install'
+import {
+	sharedInstanceUnavailableTitleMessage,
+	useSharedInstanceErrors,
+} from '@/helpers/shared-instance-errors'
+
+defineProps<{
+	reason?: SharedInstanceUnavailableReason | null
+	manager?: string | null
+	dismissible?: boolean
+}>()
+
+const emit = defineEmits<{
+	dismiss: []
+	delete: []
+}>()
+
+const { formatMessage } = useVIntl()
+const { formatSharedInstanceUnavailable } = useSharedInstanceErrors()
+
+const messages = defineMessages({
+	deleteInstance: {
+		id: 'instance.locked.delete-button',
+		defaultMessage: 'Delete instance',
+	},
+})
+</script>

apps/app-frontend/src/pages/instance/components/admonitions/shared-instance-update-available.vue

@@ -0,0 +1,34 @@
+<template>
+	<Admonition
+		type="info"
+		inline-actions
+		:header="formatMessage(messages.sharedInstanceUpdateAvailableHeader)"
+	>
+		{{ formatMessage(messages.sharedInstanceUpdateAvailableBody, { name: instanceName }) }}
+		<template #actions>
+			<ButtonStyled color="blue">
+				<button class="!h-10" @click="emit('review', $event)">
+					<DownloadIcon aria-hidden="true" />
+					{{ formatMessage(messages.sharedInstanceReviewUpdateButton) }}
+				</button>
+			</ButtonStyled>
+		</template>
+	</Admonition>
+</template>
+
+<script setup lang="ts">
+import { DownloadIcon } from '@modrinth/assets'
+import { Admonition, ButtonStyled, useVIntl } from '@modrinth/ui'
+
+import { instanceAdmonitionsMessages as messages } from './messages'
+
+defineProps<{
+	instanceName: string
+}>()
+
+const emit = defineEmits<{
+	review: [event: MouseEvent]
+}>()
+
+const { formatMessage } = useVIntl()
+</script>

apps/app-frontend/src/pages/instance/components/admonitions/shared-instance-wrong-account.vue

@@ -0,0 +1,78 @@
+<template>
+	<Admonition type="warning" :header="formatMessage(headerMessage)">
+		<span class="flex flex-wrap items-center gap-x-1.5 gap-y-1">
+			<span>{{ formatMessage(messages.sharedInstanceWrongAccountSignInAs) }}</span>
+			<span
+				v-if="sharedInstanceExpectedUser"
+				class="inline-flex max-w-full min-w-0 items-center gap-1.5 align-middle font-semibold text-contrast"
+			>
+				<Avatar
+					:src="sharedInstanceExpectedUser.avatarUrl"
+					:alt="sharedInstanceExpectedUsername"
+					:tint-by="sharedInstanceExpectedUser.tintBy"
+					size="20px"
+					circle
+					no-shadow
+				/>
+				<span class="min-w-0 truncate">{{ sharedInstanceExpectedUsername }}</span>
+			</span>
+			<span v-else class="font-semibold">{{ sharedInstanceExpectedUsername }}</span>
+			<span>{{ formatMessage(bodyMessage) }}</span>
+		</span>
+	</Admonition>
+</template>
+
+<script setup lang="ts">
+import { Admonition, Avatar, useVIntl } from '@modrinth/ui'
+import { useQuery } from '@tanstack/vue-query'
+import { computed } from 'vue'
+
+import { get_user } from '@/helpers/cache'
+
+import { instanceAdmonitionsMessages as messages } from './messages'
+import type { SharedInstanceRole } from './types'
+
+const props = defineProps<{
+	expectedUserId?: string | null
+	role?: SharedInstanceRole | null
+	signedOut?: boolean
+}>()
+
+const { formatMessage } = useVIntl()
+const expectedUserId = computed(() => props.expectedUserId ?? null)
+const expectedUserQuery = useQuery({
+	queryKey: computed(() => ['user', expectedUserId.value]),
+	queryFn: async () => {
+		if (!expectedUserId.value) return null
+
+		return await get_user(expectedUserId.value, 'bypass').catch(() => null)
+	},
+	enabled: () => !!expectedUserId.value,
+	staleTime: 30_000,
+})
+const sharedInstanceExpectedUser = computed(() => {
+	const user = expectedUserQuery.data.value
+	if (!user) return null
+
+	return {
+		username: user.username,
+		avatarUrl: user.avatar_url ?? undefined,
+		tintBy: user.id,
+	}
+})
+const sharedInstanceExpectedUsername = computed(
+	() =>
+		sharedInstanceExpectedUser.value?.username ||
+		formatMessage(messages.sharedInstanceWrongAccountFallbackUsername),
+)
+const headerMessage = computed(() =>
+	props.signedOut
+		? messages.sharedInstanceSignedOutHeader
+		: messages.sharedInstanceWrongAccountHeader,
+)
+const bodyMessage = computed(() =>
+	props.role === 'owner'
+		? messages.sharedInstanceWrongAccountOwnerBody
+		: messages.sharedInstanceWrongAccountUserBody,
+)
+</script>

apps/app-frontend/src/pages/instance/components/admonitions/types.ts

@@ -0,0 +1,13 @@
+import type { StackedAdmonitionItem } from '@modrinth/ui'
+
+export type InstanceAdmonitionKind =
+	| 'shared-instance-stale'
+	| 'shared-instance-update-available'
+	| 'shared-instance-unavailable'
+	| 'shared-instance-wrong-account'
+
+export type InstanceAdmonitionItem = StackedAdmonitionItem & {
+	kind: InstanceAdmonitionKind
+}
+
+export type SharedInstanceRole = 'owner' | 'member'