@umituz/web-dashboard 4.6.4 → 4.7.0

package/src/domains/onboarding/types/onboarding.ts

@@ -1,254 +0,0 @@
-/**
- * Onboarding Types
- *
- * Type definitions for onboarding system
- */
-
-import type { LucideIcon } from "lucide-react";
-import type { ComponentType, ReactElement } from "react";
-
-/**
- * Onboarding error — the message is an i18n key.
- */
-export interface OnboardingError {
-  /** Step where the error occurred */
-  step: number;
-  /** i18n key for the localized error message */
-  message: string;
-}
-
-/**
- * User type option for first step.
- * Either supply `label`/`description` directly (already translated) or
- * supply `labelKey`/`descriptionKey` to be resolved by the consumer's i18n.
- */
-export interface UserTypeOption {
-  /** Unique identifier */
-  id: string;
-  /** Display label (already-translated string) */
-  label?: string;
-  /** Description text (already-translated) */
-  description?: string;
-  /** i18n key for the label */
-  labelKey?: string;
-  /** i18n key for the description */
-  descriptionKey?: string;
-  /** Icon component (Lucide) */
-  icon?: LucideIcon;
-  /** Badge text */
-  badge?: string;
-}
-
-/**
- * Platform connection option.
- * Icons must be Lucide components — emoji is not allowed.
- */
-export interface PlatformOption {
-  /** Unique identifier */
-  id: string;
-  /** Display name */
-  name: string;
-  /** Lucide icon component */
-  icon: LucideIcon;
-  /** Brand color as a plain CSS color string (e.g. "#c026d3") */
-  color?: string;
-  /** Connection status */
-  connected?: boolean;
-}
-
-/**
- * App type option for the AppFocusStep.
- * Same shape as PlatformOption (icon as component, not emoji).
- */
-export interface AppTypeOption {
-  id: string;
-  name: string;
-  description: string;
-  icon: LucideIcon;
-  /**
-   * State field toggled by this option. When omitted, the field is
-   * derived from the id ("mobile" → hasMobileApp, "web" → hasWebApp);
-   * options that resolve to neither render inert.
-   */
-  stateField?: "hasMobileApp" | "hasWebApp";
-}
-
-/**
- * Plan option for billing step
- */
-export interface PlanOption {
-  /** Unique identifier */
-  id: string;
-  /** Plan name (already translated) */
-  name: string;
-  /** Badge text (already translated) — preferred for static labels */
-  badge?: string;
-  /** i18n key for the badge — resolved via `translate` in the consumer */
-  badgeKey?: string;
-  /** Semantic badge tone rendered by the stylesheet */
-  badgeTone?: "muted" | "primary" | "accent";
-  /** Description text */
-  description: string;
-  /** Monthly price */
-  price: number;
-  /** Features list */
-  features: (string | { text: string; bold?: boolean })[];
-  /** Highlight style */
-  highlight?: boolean;
-}
-
-/**
- * Props for onboarding step components
- */
-export interface OnboardingStepContentProps {
-  /** Current onboarding state */
-  state: OnboardingState;
-  /** Update state function */
-  updateState: (updates: Partial<OnboardingState>) => void;
-  /** Go to next step */
-  goToNext: () => void;
-  /** Go to previous step */
-  goToPrev: () => void;
-  /** Go to specific step */
-  goToStep: (step: number) => void;
-  /** Onboarding configuration */
-  config: OnboardingConfig;
-}
-
-/**
- * Onboarding step configuration
- */
-export interface OnboardingStep {
-  /** Step identifier */
-  id: string;
-  /** Step number */
-  order: number;
-  /** Step title */
-  title: string;
-  /** Step description */
-  description?: string;
-  /** Custom component - either a function component with props or a direct React node */
-  component?: ComponentType<OnboardingStepContentProps> | ReactElement;
-  /** Whether this step can be skipped */
-  skippable?: boolean;
-  /** Validation function */
-  validate?: (data: OnboardingState) => boolean;
-}
-
-/**
- * Onboarding configuration
- */
-export interface OnboardingConfig {
-  /** Brand/application name */
-  brandName: string;
-  /** Brand tagline */
-  brandTagline?: string;
-  /** Onboarding steps */
-  steps: OnboardingStep[];
-  /** Route to navigate after completion */
-  completeRoute: string;
-  /** Route to navigate on cancel */
-  cancelRoute?: string;
-  /** Allow skipping steps */
-  allowSkip?: boolean;
-  /** Allow canceling the wizard from the header */
-  allowCancel?: boolean;
-  /** Show progress indicator */
-  showProgress?: boolean;
-  /** Enable user menu in header */
-  showUserMenu?: boolean;
-}
-
-/**
- * Onboarding state
- */
-export interface OnboardingState extends Record<string, unknown> {
-  /** Current step number */
-  currentStep: number;
-  /** Selected user type */
-  selectedUserType?: string;
-  /** Has mobile app */
-  hasMobileApp?: boolean;
-  /** Has web app */
-  hasWebApp?: boolean;
-  /** Connected platform IDs */
-  connectedPlatforms: string[];
-  /** Selected plan ID */
-  selectedPlan?: string;
-  /** Billing cycle */
-  billingCycle: "monthly" | "yearly";
-  /** Additional step data */
-  stepData: Record<string, unknown>;
-}
-
-/**
- * Onboarding actions
- */
-export interface OnboardingActions {
-  /** Go to next step */
-  goToNext: () => void;
-  /** Go to previous step */
-  goToPrev: () => void;
-  /** Go to specific step */
-  goToStep: (step: number) => void;
-  /** Update state */
-  updateState: (updates: Partial<OnboardingState>) => void;
-  /** Complete onboarding */
-  complete: () => Promise<void>;
-  /** Cancel onboarding */
-  cancel: () => void;
-}
-
-/**
- * Onboarding wizard props
- */
-export interface OnboardingWizardProps {
-  /** Onboarding configuration */
-  config: OnboardingConfig;
-  /** Initial state */
-  initialState?: Partial<OnboardingState>;
-  /** Completion callback */
-  onComplete?: (data: OnboardingState) => Promise<void>;
-  /** Cancel callback */
-  onCancel?: () => void;
-}
-
-/**
- * Step progress props
- */
-export interface StepProgressProps {
-  /** Current step number */
-  currentStep: number;
-  /** Total number of steps */
-  totalSteps: number;
-  /** Completed steps */
-  completedSteps?: number[];
-}
-
-/**
- * Step navigation props
- */
-export interface StepNavigationProps {
-  /** Current step number */
-  currentStep: number;
-  /** Total number of steps */
-  totalSteps: number;
-  /** Can proceed to next step */
-  canGoNext: boolean;
-  /** Is saving/completing */
-  isSaving?: boolean;
-  /** Next button label (overrides the i18n key) */
-  nextLabel?: string;
-  /** Previous button label (overrides the i18n key) */
-  prevLabel?: string;
-  /** On next */
-  onNext: () => void;
-  /** On previous */
-  onPrev: () => void;
-  /** Allow skipping */
-  allowSkip?: boolean;
-  /** On skip */
-  onSkip?: () => void;
-  /** Translation function */
-  translate: (key: string) => string;
-}

package/src/domains/onboarding/utils/i18nKeys.ts

@@ -1,72 +0,0 @@
-/**
- * Onboarding Domain i18n Keys
- */
-
-export const ONBOARDING_KEYS = {
-  // Wizard
-  wizard: {
-    cancel: 'onboarding.buttons.cancel',
-    stepNotConfigured: 'onboarding.errors.stepNotConfigured',
-    errors: {
-      completionFailed: 'onboarding.errors.completionFailed',
-    },
-  },
-
-  // User type step
-  userType: {
-    title: 'onboarding.userType.title',
-    description: 'onboarding.userType.description',
-  },
-
-  // App focus step
-  appFocus: {
-    title: 'onboarding.appFocus.title',
-    description: 'onboarding.appFocus.description',
-    success: 'onboarding.appFocus.success',
-  },
-
-  // Platforms step
-  platforms: {
-    title: 'onboarding.platforms.title',
-    description: 'onboarding.platforms.description',
-    connect: 'onboarding.platforms.connect',
-    connected: 'onboarding.platforms.connected',
-    selected: 'onboarding.platforms.selected',
-  },
-
-  // Plan step
-  plan: {
-    title: 'onboarding.plan.title',
-    description: 'onboarding.plan.description',
-    monthly: 'onboarding.plan.monthly',
-    yearly: 'onboarding.plan.yearly',
-    monthlyShort: 'onboarding.plan.monthlyShort',
-    yearlyShort: 'onboarding.plan.yearlyShort',
-    save: 'onboarding.plan.save',
-    recommended: 'onboarding.plan.recommended',
-    selectedPlan: 'onboarding.plan.selectedPlan',
-    mostPopular: 'onboarding.plan.mostPopular',
-    bestValue: 'onboarding.plan.bestValue',
-    custom: 'onboarding.plan.custom',
-  },
-
-  // Steps (default data — keys can be overridden per consumer)
-  defaults: {
-    founder: 'onboarding.defaults.userType.founder',
-    founderDescription: 'onboarding.defaults.userType.founderDescription',
-    contentCreator: 'onboarding.defaults.userType.contentCreator',
-    contentCreatorDescription: 'onboarding.defaults.userType.contentCreatorDescription',
-    smallBusiness: 'onboarding.defaults.userType.smallBusiness',
-    smallBusinessDescription: 'onboarding.defaults.userType.smallBusinessDescription',
-    enterprise: 'onboarding.defaults.userType.enterprise',
-    enterpriseDescription: 'onboarding.defaults.userType.enterpriseDescription',
-    agency: 'onboarding.defaults.userType.agency',
-    agencyDescription: 'onboarding.defaults.userType.agencyDescription',
-    personal: 'onboarding.defaults.userType.personal',
-    personalDescription: 'onboarding.defaults.userType.personalDescription',
-    mobileApp: 'onboarding.defaults.appType.mobileApp',
-    mobileAppDescription: 'onboarding.defaults.appType.mobileAppDescription',
-    webApp: 'onboarding.defaults.appType.webApp',
-    webAppDescription: 'onboarding.defaults.appType.webAppDescription',
-  },
-} as const;

package/src/domains/onboarding/utils/index.ts

@@ -1,17 +0,0 @@
-/**
- * Onboarding Utils Export
- */
-
-export {
-  validateStep,
-  getStepTitle,
-  getStepDescription,
-  calculateProgress,
-  getCompletedSteps,
-  formatOnboardingData,
-  generateOnboardingEvent,
-  isValidEmail,
-  isValidPassword,
-} from './onboarding';
-
-export { ONBOARDING_KEYS } from './i18nKeys';

package/src/domains/onboarding/utils/onboarding.ts

@@ -1,166 +0,0 @@
-/**
- * Onboarding Utilities
- *
- * Utility functions for onboarding operations
- */
-
-import type { OnboardingState, OnboardingConfig } from "../types/onboarding";
-
-/**
- * Validate onboarding step
- *
- * @param state - Current onboarding state
- * @param stepNumber - Step number to validate
- * @param config - Onboarding configuration
- * @returns Whether the step is valid
- */
-export function validateStep(
-  state: OnboardingState,
-  stepNumber: number,
-  config: OnboardingConfig
-): boolean {
-  const stepConfig = config.steps[stepNumber - 1];
-
-  if (stepConfig?.validate) {
-    return stepConfig.validate(state);
-  }
-
-  // Default validations
-  switch (stepNumber) {
-    case 1:
-      // User type step
-      return !!state.selectedUserType;
-
-    case 2:
-      // App focus step
-      return !!(state.hasMobileApp || state.hasWebApp);
-
-    case 3:
-      // Platforms step
-      return state.connectedPlatforms.length > 0;
-
-    case 4:
-      // Plan step
-      return !!state.selectedPlan;
-
-    default:
-      return true;
-  }
-}
-
-/**
- * Get step title
- *
- * @param stepNumber - Step number
- * @param config - Onboarding configuration
- * @returns Step title
- */
-export function getStepTitle(stepNumber: number, config: OnboardingConfig): string {
-  const stepConfig = config.steps[stepNumber - 1];
-  return stepConfig?.title || `Step ${stepNumber}`;
-}
-
-/**
- * Get step description
- *
- * @param stepNumber - Step number
- * @param config - Onboarding configuration
- * @returns Step description or undefined
- */
-export function getStepDescription(stepNumber: number, config: OnboardingConfig): string | undefined {
-  const stepConfig = config.steps[stepNumber - 1];
-  return stepConfig?.description;
-}
-
-/**
- * Calculate onboarding progress
- *
- * @param currentStep - Current step number
- * @param totalSteps - Total number of steps
- * @returns Progress percentage (0-100)
- */
-export function calculateProgress(currentStep: number, totalSteps: number): number {
-  return Math.min((currentStep / totalSteps) * 100, 100);
-}
-
-/**
- * Get completed steps
- *
- * @param currentStep - Current step number
- * @returns Array of completed step numbers
- */
-export function getCompletedSteps(currentStep: number): number[] {
-  return Array.from({ length: currentStep - 1 }, (_, i) => i + 1);
-}
-
-/**
- * Format onboarding data for API submission
- *
- * @param state - Onboarding state
- * @param userId - User ID
- * @returns Formatted data object
- */
-export function formatOnboardingData(state: OnboardingState, userId?: string) {
-  return {
-    userId,
-    userType: state.selectedUserType,
-    hasMobileApp: state.hasMobileApp,
-    hasWebApp: state.hasWebApp,
-    connectedPlatforms: state.connectedPlatforms,
-    selectedPlan: state.selectedPlan,
-    billingCycle: state.billingCycle,
-    stepData: state.stepData,
-    completedAt: new Date().toISOString(),
-  };
-}
-
-/**
- * Generate onboarding analytics event
- *
- * @param event - Event name
- * @param state - Onboarding state
- * @param additionalData - Additional event data
- * @returns Analytics event object
- */
-export function generateOnboardingEvent(
-  event: string,
-  state: OnboardingState,
-  additionalData?: Record<string, unknown>
-) {
-  return {
-    event,
-    properties: {
-      currentStep: state.currentStep,
-      userType: state.selectedUserType,
-      hasMobileApp: state.hasMobileApp,
-      hasWebApp: state.hasWebApp,
-      platformCount: state.connectedPlatforms.length,
-      selectedPlan: state.selectedPlan,
-      billingCycle: state.billingCycle,
-      ...additionalData,
-    },
-    timestamp: new Date().toISOString(),
-  };
-}
-
-/**
- * Validate email format
- *
- * @param email - Email address
- * @returns Whether email is valid
- */
-export function isValidEmail(email: string): boolean {
-  const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
-  return emailRegex.test(email);
-}
-
-/**
- * Validate password strength
- *
- * @param password - Password
- * @param minLength - Minimum length (default: 8)
- * @returns Whether password meets requirements
- */
-export function isValidPassword(password: string, minLength: number = 8): boolean {
-  return password.length >= minLength;
-}