feat: onboarding flows simplified

Author: elibosley

@tailwind-shared/css-variables.css

@@ -94,7 +94,7 @@
     --ui-text-toned: var(--ui-color-neutral-300);
     --ui-text: var(--ui-color-neutral-200);
     --ui-text-highlighted: white;
-    --ui-text-inverted: var(--ui-color-neutral-900);
+    --ui-text-inverted: var(--ui-color-neutral-300);
 
     /* Nuxt UI Design Tokens - Background (Dark) */
     --ui-bg: var(--ui-color-neutral-900);

api/generated-schema.graphql

@@ -708,6 +708,108 @@ enum Role {
   VIEWER
 }
 
+type PublicPartnerInfo {
+  partnerName: String
+
+  """Indicates if a partner logo exists"""
+  hasPartnerLogo: Boolean!
+  partnerUrl: String
+
+  """
+  The path to the partner logo image on the flash drive, relative to the activation code file
+  """
+  partnerLogoUrl: String
+}
+
+type ActivationCode {
+  code: String
+  partnerName: String
+  partnerUrl: String
+  serverName: String
+  sysModel: String
+  comment: String
+  header: String
+  headermetacolor: String
+  background: String
+  showBannerGradient: Boolean
+  theme: String
+}
+
+type Customization {
+  activationCode: ActivationCode
+  partnerInfo: PublicPartnerInfo
+  theme: Theme!
+}
+
+type ActivationOnboardingStep {
+  """Identifier of the activation onboarding step"""
+  id: ActivationOnboardingStepId!
+
+  """Indicates whether the step is required"""
+  required: Boolean!
+
+  """Indicates whether the step has been completed for the current version"""
+  completed: Boolean!
+
+  """Version of Unraid when this step was introduced"""
+  introducedIn: String
+}
+
+enum ActivationOnboardingStepId {
+  WELCOME
+  TIMEZONE
+  PLUGINS
+  ACTIVATION
+}
+
+type ActivationOnboarding {
+  """Indicates whether the system is currently in an upgrade state"""
+  isUpgrade: Boolean!
+
+  """Previous OS version prior to the current upgrade"""
+  previousVersion: String
+
+  """Current OS version detected by the system"""
+  currentVersion: String
+
+  """Whether there are any remaining activation onboarding steps"""
+  hasPendingSteps: Boolean!
+
+  """Activation onboarding steps relevant to the current system state"""
+  steps: [ActivationOnboardingStep!]!
+}
+
+type Theme {
+  """The theme name"""
+  name: ThemeName!
+
+  """Whether to show the header banner image"""
+  showBannerImage: Boolean!
+
+  """Whether to show the banner gradient"""
+  showBannerGradient: Boolean!
+
+  """Whether to show the description in the header"""
+  showHeaderDescription: Boolean!
+
+  """The background color of the header"""
+  headerBackgroundColor: String
+
+  """The text color of the header"""
+  headerPrimaryTextColor: String
+
+  """The secondary text color of the header"""
+  headerSecondaryTextColor: String
+}
+
+"""The theme name"""
+enum ThemeName {
+  azure
+  black
+  gray
+  white
+}
+
 type SsoSettings implements Node {
   id: PrefixedID!
 
@@ -818,6 +920,26 @@ type PackageVersions {
   docker: String
 }
 
+type UpgradeStep {
+  """Identifier of the onboarding step"""
+  id: String!
+
+  """Whether the step is required to continue"""
+  required: Boolean!
+
+  """Version of Unraid when this step was introduced"""
+  introducedIn: String
+
+  """Display title for the onboarding step"""
+  title: String!
+
+  """Display description for the onboarding step"""
+  description: String!
+
+  """Icon identifier for the onboarding step"""
+  icon: String
+}
+
 type UpgradeInfo {
   """Whether the OS version has changed since last boot"""
   isUpgrade: Boolean!
@@ -830,6 +952,9 @@ type UpgradeInfo {
 
   """Onboarding step identifiers completed for the current OS version"""
   completedSteps: [String!]!
+
+  """Onboarding step definitions applicable to the current upgrade path"""
+  steps: [UpgradeStep!]!
 }
 
 type InfoVersions implements Node {
@@ -1055,7 +1180,7 @@ type OnboardingMutations {
 """Input for marking an upgrade onboarding step as completed"""
 input CompleteUpgradeStepInput {
   """Identifier of the onboarding step to mark completed"""
-  stepId: String!
+  stepId: ActivationOnboardingStepId!
 }
 
 type Config implements Node {
@@ -1064,70 +1189,6 @@ type Config implements Node {
   error: String
 }
 
-type PublicPartnerInfo {
-  partnerName: String
-
-  """Indicates if a partner logo exists"""
-  hasPartnerLogo: Boolean!
-  partnerUrl: String
-
-  """
-  The path to the partner logo image on the flash drive, relative to the activation code file
-  """
-  partnerLogoUrl: String
-}
-
-type ActivationCode {
-  code: String
-  partnerName: String
-  partnerUrl: String
-  serverName: String
-  sysModel: String
-  comment: String
-  header: String
-  headermetacolor: String
-  background: String
-  showBannerGradient: Boolean
-  theme: String
-}
-
-type Customization {
-  activationCode: ActivationCode
-  partnerInfo: PublicPartnerInfo
-  theme: Theme!
-}
-
-type Theme {
-  """The theme name"""
-  name: ThemeName!
-
-  """Whether to show the header banner image"""
-  showBannerImage: Boolean!
-
-  """Whether to show the banner gradient"""
-  showBannerGradient: Boolean!
-
-  """Whether to show the description in the header"""
-  showHeaderDescription: Boolean!
-
-  """The background color of the header"""
-  headerBackgroundColor: String
-
-  """The text color of the header"""
-  headerPrimaryTextColor: String
-
-  """The secondary text color of the header"""
-  headerSecondaryTextColor: String
-}
-
-"""The theme name"""
-enum ThemeName {
-  azure
-  black
-  gray
-  white
-}
-
 type ExplicitStatusItem {
   name: String!
   updateStatus: UpdateStatus!
@@ -1878,7 +1939,6 @@ type ApiConfig {
   sandbox: Boolean
   ssoSubIds: [String!]!
   plugins: [String!]!
-  lastSeenOsVersion: String
 }
 
 type OidcAuthorizationRule {
@@ -2415,6 +2475,9 @@ type Query {
   customization: Customization
   publicPartnerInfo: PublicPartnerInfo
   publicTheme: Theme!
+
+  """Activation onboarding steps derived from current system state"""
+  activationOnboarding: ActivationOnboarding!
   docker: Docker!
   disks: [Disk!]!
   disk(id: PrefixedID!): Disk!

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

@@ -119,6 +119,38 @@ export type ActivationCode = {
   theme?: Maybe<Scalars['String']['output']>;
 };
 
+export type ActivationOnboarding = {
+  __typename?: 'ActivationOnboarding';
+  /** Current OS version detected by the system */
+  currentVersion?: Maybe<Scalars['String']['output']>;
+  /** Whether there are any remaining activation onboarding steps */
+  hasPendingSteps: Scalars['Boolean']['output'];
+  /** Indicates whether the system is currently in an upgrade state */
+  isUpgrade: Scalars['Boolean']['output'];
+  /** Previous OS version prior to the current upgrade */
+  previousVersion?: Maybe<Scalars['String']['output']>;
+  /** Activation onboarding steps relevant to the current system state */
+  steps: Array<ActivationOnboardingStep>;
+};
+
+export type ActivationOnboardingStep = {
+  __typename?: 'ActivationOnboardingStep';
+  /** Indicates whether the step has been completed for the current version */
+  completed: Scalars['Boolean']['output'];
+  /** Identifier of the activation onboarding step */
+  id: ActivationOnboardingStepId;
+  /** Version of Unraid when this step was introduced */
+  introducedIn?: Maybe<Scalars['String']['output']>;
+  /** Indicates whether the step is required */
+  required: Scalars['Boolean']['output'];
+};
+
+export enum ActivationOnboardingStepId {
+  ACTIVATION = 'ACTIVATION',
+  PLUGINS = 'PLUGINS',
+  TIMEZONE = 'TIMEZONE'
+}
+
 export type AddPermissionInput = {
   actions: Array<AuthAction>;
   resource: Resource;
@@ -132,7 +164,6 @@ export type AddRoleForApiKeyInput = {
 export type ApiConfig = {
   __typename?: 'ApiConfig';
   extraOrigins: Array<Scalars['String']['output']>;
-  lastSeenOsVersion?: Maybe<Scalars['String']['output']>;
   plugins: Array<Scalars['String']['output']>;
   sandbox?: Maybe<Scalars['Boolean']['output']>;
   ssoSubIds: Array<Scalars['String']['output']>;
@@ -438,7 +469,7 @@ export type CloudResponse = {
 /** Input for marking an upgrade onboarding step as completed */
 export type CompleteUpgradeStepInput = {
   /** Identifier of the onboarding step to mark completed */
-  stepId: Scalars['String']['input'];
+  stepId: ActivationOnboardingStepId;
 };
 
 export type Config = Node & {
@@ -1679,6 +1710,8 @@ export type PublicPartnerInfo = {
 
 export type Query = {
   __typename?: 'Query';
+  /** Activation onboarding steps derived from current system state */
+  activationOnboarding: ActivationOnboarding;
   apiKey?: Maybe<ApiKey>;
   /** All possible permissions for API keys */
   apiKeyPossiblePermissions: Array<Permission>;
@@ -2348,6 +2381,24 @@ export type UpgradeInfo = {
   isUpgrade: Scalars['Boolean']['output'];
   /** Previous OS version before upgrade */
   previousVersion?: Maybe<Scalars['String']['output']>;
+  /** Onboarding step definitions applicable to the current upgrade path */
+  steps: Array<UpgradeStep>;
+};
+
+export type UpgradeStep = {
+  __typename?: 'UpgradeStep';
+  /** Display description for the onboarding step */
+  description: Scalars['String']['output'];
+  /** Icon identifier for the onboarding step */
+  icon?: Maybe<Scalars['String']['output']>;
+  /** Identifier of the onboarding step */
+  id: Scalars['String']['output'];
+  /** Version of Unraid when this step was introduced */
+  introducedIn?: Maybe<Scalars['String']['output']>;
+  /** Whether the step is required to continue */
+  required: Scalars['Boolean']['output'];
+  /** Display title for the onboarding step */
+  title: Scalars['String']['output'];
 };
 
 export type Uptime = {

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

@@ -17,7 +17,6 @@ const createDefaultConfig = (): ApiConfig => ({
     sandbox: false,
     ssoSubIds: [],
     plugins: [],
-    lastSeenOsVersion: undefined,
 });
 
 /**