feat: move onboarding wizard persistence server-side

api/dev/configs/api.json

@@ -1,9 +1,9 @@
 {
-  "version": "4.29.2",
+  "version": "4.32.0",
   "extraOrigins": [],
   "sandbox": false,
   "ssoSubIds": [],
   "plugins": [
     "unraid-api-plugin-connect"
   ]
-}
+}

api/generated-schema.graphql

@@ -1027,6 +1027,29 @@ type OnboardingState {
   activationRequired: Boolean!
 }
 
+type OnboardingWizardInternalBootState {
+  applyAttempted: Boolean!
+  applySucceeded: Boolean!
+}
+
+type OnboardingWizard {
+  currentStepId: OnboardingWizardStepId
+  visibleStepIds: [OnboardingWizardStepId!]!
+  draft: JSON!
+  internalBootState: OnboardingWizardInternalBootState!
+}
+
+"""Server-provided onboarding wizard step identifiers"""
+enum OnboardingWizardStepId {
+  OVERVIEW
+  CONFIGURE_SETTINGS
+  CONFIGURE_BOOT
+  ADD_PLUGINS
+  ACTIVATE_LICENSE
+  SUMMARY
+  NEXT_STEPS
+}
+
 """Onboarding completion state and context"""
 type Onboarding {
   """
@@ -1051,6 +1074,9 @@ type Onboarding {
 
   """Runtime onboarding state values used by the onboarding flow"""
   onboardingState: OnboardingState!
+
+  """Server-owned onboarding wizard state used by the web onboarding modal"""
+  wizard: OnboardingWizard!
 }
 
 """
@@ -1210,6 +1236,16 @@ type ArrayMutations {
 input ArrayStateInput {
   """Array state"""
   desiredState: ArrayStateInputState!
+
+  """
+  Optional password used to unlock encrypted array disks when starting the array
+  """
+  decryptionPassword: String
+
+  """
+  Optional keyfile contents used to unlock encrypted array disks when starting the array. Accepts a data URL or raw base64 payload.
+  """
+  decryptionKeyfile: String
 }
 
 enum ArrayStateInputState {
@@ -1407,9 +1443,6 @@ type OnboardingMutations {
   """Force the onboarding modal open"""
   openOnboarding: Onboarding!
 
-  """Close the onboarding modal"""
-  closeOnboarding: Onboarding!
-
   """Temporarily bypass onboarding in API memory"""
   bypassOnboarding: Onboarding!
 
@@ -1422,6 +1455,9 @@ type OnboardingMutations {
   """Clear onboarding override state and reload from disk"""
   clearOnboardingOverride: Onboarding!
 
+  """Persist server-owned onboarding wizard draft state"""
+  saveOnboardingDraft(input: SaveOnboardingDraftInput!): Boolean!
+
   """Create and configure internal boot pool via emcmd operations"""
   createInternalBootPool(input: CreateInternalBootPoolInput!): OnboardingInternalBootResult!
 
@@ -1505,6 +1541,21 @@ input PartnerInfoOverrideInput {
   branding: BrandingConfigInput
 }
 
+input SaveOnboardingDraftInput {
+  draft: JSON
+  navigation: OnboardingWizardNavigationInput
+  internalBootState: OnboardingWizardInternalBootStateInput
+}
+
+input OnboardingWizardNavigationInput {
+  currentStepId: OnboardingWizardStepId
+}
+
+input OnboardingWizardInternalBootStateInput {
+  applyAttempted: Boolean
+  applySucceeded: Boolean
+}
+
 """Input for creating an internal boot pool during onboarding"""
 input CreateInternalBootPoolInput {
   poolName: String!

api/src/unraid-api/cli/generated/graphql.ts

@@ -366,6 +366,10 @@ export enum ArrayState {
 }
 
 export type ArrayStateInput = {
+  /** Optional keyfile contents used to unlock encrypted array disks when starting the array. Accepts a data URL or raw base64 payload. */
+  decryptionKeyfile?: InputMaybe<Scalars['String']['input']>;
+  /** Optional password used to unlock encrypted array disks when starting the array */
+  decryptionPassword?: InputMaybe<Scalars['String']['input']>;
   /** Array state */
   desiredState: ArrayStateInputState;
 };
@@ -1976,6 +1980,8 @@ export type Onboarding = {
   shouldOpen: Scalars['Boolean']['output'];
   /** The current onboarding status (INCOMPLETE, UPGRADE, DOWNGRADE, or COMPLETED) */
   status: OnboardingStatus;
+  /** Server-owned onboarding wizard state used by the web onboarding modal */
+  wizard: OnboardingWizard;
 };
 
 /** Current onboarding context for configuring internal boot */
@@ -1985,12 +1991,21 @@ export type OnboardingInternalBootContext = {
   assignableDisks: Array<Disk>;
   bootEligible?: Maybe<Scalars['Boolean']['output']>;
   bootedFromFlashWithInternalBootSetup: Scalars['Boolean']['output'];
+  driveWarnings: Array<OnboardingInternalBootDriveWarning>;
   enableBootTransfer?: Maybe<Scalars['String']['output']>;
   poolNames: Array<Scalars['String']['output']>;
   reservedNames: Array<Scalars['String']['output']>;
   shareNames: Array<Scalars['String']['output']>;
 };
 
+/** Warning metadata for an assignable internal boot drive */
+export type OnboardingInternalBootDriveWarning = {
+  __typename?: 'OnboardingInternalBootDriveWarning';
+  device: Scalars['String']['output'];
+  diskId: Scalars['String']['output'];
+  warnings: Array<Scalars['String']['output']>;
+};
+
 /** Result of attempting internal boot pool setup */
 export type OnboardingInternalBootResult = {
   __typename?: 'OnboardingInternalBootResult';
@@ -2006,8 +2021,6 @@ export type OnboardingMutations = {
   bypassOnboarding: Onboarding;
   /** Clear onboarding override state and reload from disk */
   clearOnboardingOverride: Onboarding;
-  /** Close the onboarding modal */
-  closeOnboarding: Onboarding;
   /** Mark onboarding as completed */
   completeOnboarding: Onboarding;
   /** Create and configure internal boot pool via emcmd operations */
@@ -2020,6 +2033,8 @@ export type OnboardingMutations = {
   resetOnboarding: Onboarding;
   /** Clear the temporary onboarding bypass */
   resumeOnboarding: Onboarding;
+  /** Persist server-owned onboarding wizard draft state */
+  saveOnboardingDraft: Scalars['Boolean']['output'];
   /** Override onboarding state for testing (in-memory only) */
   setOnboardingOverride: Onboarding;
 };
@@ -2031,6 +2046,12 @@ export type OnboardingMutationsCreateInternalBootPoolArgs = {
 };
 
 
+/** Onboarding related mutations */
+export type OnboardingMutationsSaveOnboardingDraftArgs = {
+  input: SaveOnboardingDraftInput;
+};
+
+
 /** Onboarding related mutations */
 export type OnboardingMutationsSetOnboardingOverrideArgs = {
   input: OnboardingOverrideInput;
@@ -2072,6 +2093,40 @@ export enum OnboardingStatus {
   UPGRADE = 'UPGRADE'
 }
 
+export type OnboardingWizard = {
+  __typename?: 'OnboardingWizard';
+  currentStepId?: Maybe<OnboardingWizardStepId>;
+  draft: Scalars['JSON']['output'];
+  internalBootState: OnboardingWizardInternalBootState;
+  visibleStepIds: Array<OnboardingWizardStepId>;
+};
+
+export type OnboardingWizardInternalBootState = {
+  __typename?: 'OnboardingWizardInternalBootState';
+  applyAttempted: Scalars['Boolean']['output'];
+  applySucceeded: Scalars['Boolean']['output'];
+};
+
+export type OnboardingWizardInternalBootStateInput = {
+  applyAttempted?: InputMaybe<Scalars['Boolean']['input']>;
+  applySucceeded?: InputMaybe<Scalars['Boolean']['input']>;
+};
+
+export type OnboardingWizardNavigationInput = {
+  currentStepId?: InputMaybe<OnboardingWizardStepId>;
+};
+
+/** Server-provided onboarding wizard step identifiers */
+export enum OnboardingWizardStepId {
+  ACTIVATE_LICENSE = 'ACTIVATE_LICENSE',
+  ADD_PLUGINS = 'ADD_PLUGINS',
+  CONFIGURE_BOOT = 'CONFIGURE_BOOT',
+  CONFIGURE_SETTINGS = 'CONFIGURE_SETTINGS',
+  NEXT_STEPS = 'NEXT_STEPS',
+  OVERVIEW = 'OVERVIEW',
+  SUMMARY = 'SUMMARY'
+}
+
 export type Owner = {
   __typename?: 'Owner';
   avatar: Scalars['String']['output'];
@@ -2594,6 +2649,12 @@ export enum Role {
   VIEWER = 'VIEWER'
 }
 
+export type SaveOnboardingDraftInput = {
+  draft?: InputMaybe<Scalars['JSON']['input']>;
+  internalBootState?: InputMaybe<OnboardingWizardInternalBootStateInput>;
+  navigation?: InputMaybe<OnboardingWizardNavigationInput>;
+};
+
 export type SensorConfig = {
   __typename?: 'SensorConfig';
   enabled?: Maybe<Scalars['Boolean']['output']>;

api/src/unraid-api/config/api-config.test.ts

@@ -169,6 +169,12 @@ describe('OnboardingTracker', () => {
                 completed: false,
                 completedAtVersion: undefined,
                 forceOpen: false,
+                draft: {},
+                navigation: {},
+                internalBootState: {
+                    applyAttempted: false,
+                    applySucceeded: false,
+                },
             },
         });
     });
@@ -196,6 +202,12 @@ describe('OnboardingTracker', () => {
                 completed: true,
                 completedAtVersion: '7.1.0',
                 forceOpen: false,
+                draft: {},
+                navigation: {},
+                internalBootState: {
+                    applyAttempted: false,
+                    applySucceeded: false,
+                },
             },
         });
     });
@@ -288,6 +300,12 @@ describe('OnboardingTracker', () => {
                 completed: true,
                 completedAtVersion: '6.12.0',
                 forceOpen: false,
+                draft: {},
+                navigation: {},
+                internalBootState: {
+                    applyAttempted: false,
+                    applySucceeded: false,
+                },
             },
         });
     });

api/src/unraid-api/config/onboarding-tracker.model.ts

@@ -1,6 +1,72 @@
+export const ONBOARDING_STEP_IDS = [
+    'OVERVIEW',
+    'CONFIGURE_SETTINGS',
+    'CONFIGURE_BOOT',
+    'ADD_PLUGINS',
+    'ACTIVATE_LICENSE',
+    'SUMMARY',
+    'NEXT_STEPS',
+] as const;
+
+export type OnboardingStepId = (typeof ONBOARDING_STEP_IDS)[number];
+
+export type OnboardingPoolMode = 'dedicated' | 'hybrid';
+
+export type OnboardingBootMode = 'usb' | 'storage';
+
+export type OnboardingInternalBootDevice = {
+    id: string;
+    sizeBytes: number;
+    deviceName: string;
+};
+
+export type OnboardingInternalBootSelection = {
+    poolName?: string;
+    slotCount?: number;
+    devices?: OnboardingInternalBootDevice[];
+    bootSizeMiB?: number;
+    updateBios?: boolean;
+    poolMode?: OnboardingPoolMode;
+};
+
+export type OnboardingCoreSettingsDraft = {
+    serverName?: string;
+    serverDescription?: string;
+    timeZone?: string;
+    theme?: string;
+    language?: string;
+    useSsh?: boolean;
+};
+
+export type OnboardingPluginsDraft = {
+    selectedIds?: string[];
+};
+
+export type OnboardingInternalBootDraft = {
+    bootMode?: OnboardingBootMode;
+    skipped?: boolean;
+    selection?: OnboardingInternalBootSelection | null;
+};
+
+export type OnboardingDraft = {
+    activationStepIncluded?: boolean;
+    coreSettings?: OnboardingCoreSettingsDraft;
+    plugins?: OnboardingPluginsDraft;
+    internalBoot?: OnboardingInternalBootDraft;
+};
+
+export type OnboardingNavigationState = {
+    currentStepId?: OnboardingStepId;
+};
+
+export type OnboardingInternalBootState = {
+    applyAttempted?: boolean;
+    applySucceeded?: boolean;
+};
+
 /**
- * Simplified onboarding tracker state.
- * Tracks whether onboarding has been completed and at which version.
+ * Durable onboarding tracker state.
+ * Tracks onboarding completion plus the server-owned wizard draft.
  */
 export type TrackerState = {
     /** Whether the onboarding flow has been completed */
@@ -9,4 +75,10 @@ export type TrackerState = {
     completedAtVersion?: string;
     /** Whether onboarding has been explicitly forced open */
     forceOpen?: boolean;
+    /** Durable server-owned wizard draft */
+    draft?: OnboardingDraft;
+    /** Durable navigation state for onboarding resume */
+    navigation?: OnboardingNavigationState;
+    /** Operational internal boot state that is not user-entered draft data */
+    internalBootState?: OnboardingInternalBootState;
 };