Move settings types and initial values to lib/settings (#1698)

src/Router.tsx

@@ -23,10 +23,8 @@ import { metadata } from 'tauri-plugin-fs-extra-api'
 import DownloadAppBanner from './components/DownloadAppBanner'
 import { WasmErrBanner } from './components/WasmErrBanner'
 import { SettingsAuthProvider } from './components/SettingsAuthProvider'
-import {
+import { settingsMachine } from './machines/settingsMachine'
-  SETTINGS_PERSIST_KEY,
+import { SETTINGS_PERSIST_KEY } from './lib/settings'
-  settingsMachine,
-} from './machines/settingsMachine'
 import { ContextFrom } from 'xstate'
 import CommandBarProvider, {
   CommandBar,

src/clientSideScene/sceneInfra.ts

@@ -24,7 +24,7 @@ import { useModelingContext } from 'hooks/useModelingContext'
 import * as TWEEN from '@tweenjs/tween.js'
 import { SourceRange } from 'lang/wasm'
 import { Axis } from 'lib/selections'
-import { BaseUnit, SETTINGS_PERSIST_KEY } from 'machines/settingsMachine'
+import { BaseUnit, SETTINGS_PERSIST_KEY } from 'lib/settings'
 import { CameraControls } from './CameraControls'
 
 type SendType = ReturnType<typeof useModelingContext>['send']

src/components/SettingsAuthProvider.tsx

@@ -5,7 +5,8 @@ import { authMachine, TOKEN_PERSIST_KEY } from '../machines/authMachine'
 import withBaseUrl from '../lib/withBaseURL'
 import React, { createContext, useEffect, useRef } from 'react'
 import useStateMachineCommands from '../hooks/useStateMachineCommands'
-import { SETTINGS_PERSIST_KEY, settingsMachine } from 'machines/settingsMachine'
+import { settingsMachine } from 'machines/settingsMachine'
+import { SETTINGS_PERSIST_KEY } from 'lib/settings'
 import { toast } from 'react-hot-toast'
 import { setThemeClass, Themes } from 'lib/theme'
 import {

src/lib/commandBarConfigs/settingsCommandConfig.ts

@@ -1,11 +1,6 @@
 import { CommandSetConfig } from '../commandTypes'
-import {
+import { BaseUnit, Toggle, UnitSystem, baseUnitsUnion } from 'lib/settings'
-  BaseUnit,
+import { settingsMachine } from 'machines/settingsMachine'
-  Toggle,
-  UnitSystem,
-  baseUnitsUnion,
-  settingsMachine,
-} from 'machines/settingsMachine'
 import { CameraSystem, cameraSystems } from '../cameraControls'
 import { Themes } from '../theme'
 

src/lib/settings.ts

@@ -0,0 +1,47 @@
+import { type Models } from '@kittycad/lib'
+import { CameraSystem } from './cameraControls'
+import { Themes } from './theme'
+
+export const DEFAULT_PROJECT_NAME = 'project-$nnn'
+export const SETTINGS_PERSIST_KEY = 'SETTINGS_PERSIST_KEY'
+export const SETTINGS_FILE_NAME = 'settings.json'
+
+export enum UnitSystem {
+  Imperial = 'imperial',
+  Metric = 'metric',
+}
+
+export const baseUnits = {
+  imperial: ['in', 'ft', 'yd'],
+  metric: ['mm', 'cm', 'm'],
+} as const
+
+export type BaseUnit = Models['UnitLength_type']
+
+export const baseUnitsUnion = Object.values(baseUnits).flatMap((v) => v)
+
+export type Toggle = 'On' | 'Off'
+
+export type SettingsMachineContext = {
+  baseUnit: BaseUnit
+  cameraControls: CameraSystem
+  defaultDirectory: string
+  defaultProjectName: string
+  onboardingStatus: string
+  showDebugPanel: boolean
+  textWrapping: Toggle
+  theme: Themes
+  unitSystem: UnitSystem
+}
+
+export const initialSettings: SettingsMachineContext = {
+  baseUnit: 'mm' as BaseUnit,
+  cameraControls: 'KittyCAD' as CameraSystem,
+  defaultDirectory: '',
+  defaultProjectName: DEFAULT_PROJECT_NAME,
+  onboardingStatus: '',
+  showDebugPanel: false,
+  textWrapping: 'On' as Toggle,
+  theme: Themes.System,
+  unitSystem: UnitSystem.Metric,
+}

src/machines/settingsMachine.ts

@@ -1,44 +1,19 @@
 import { assign, createMachine } from 'xstate'
 import { Themes, getSystemTheme, setThemeClass } from '../lib/theme'
 import { CameraSystem } from 'lib/cameraControls'
-import { Models } from '@kittycad/lib'
+import {
+  BaseUnit,
+  DEFAULT_PROJECT_NAME,
+  SETTINGS_PERSIST_KEY,
+  SettingsMachineContext,
+  Toggle,
+  UnitSystem,
+} from 'lib/settings'
 
 const kclManagerPromise = import('lang/KclSingleton').then(
   (module) => module.kclManager
 )
 
-export const DEFAULT_PROJECT_NAME = 'project-$nnn'
-
-export enum UnitSystem {
-  Imperial = 'imperial',
-  Metric = 'metric',
-}
-
-export const baseUnits = {
-  imperial: ['in', 'ft', 'yd'],
-  metric: ['mm', 'cm', 'm'],
-} as const
-
-export type BaseUnit = Models['UnitLength_type']
-
-export const baseUnitsUnion = Object.values(baseUnits).flatMap((v) => v)
-
-export type Toggle = 'On' | 'Off'
-
-export const SETTINGS_PERSIST_KEY = 'SETTINGS_PERSIST_KEY'
-
-type SettingsMachineContext = {
-  baseUnit: BaseUnit
-  cameraControls: CameraSystem
-  defaultDirectory: string
-  defaultProjectName: string
-  onboardingStatus: string
-  showDebugPanel: boolean
-  textWrapping: Toggle
-  theme: Themes
-  unitSystem: UnitSystem
-}
-
 export const settingsMachine = createMachine(
   {
     /** @xstate-layout N4IgpgJg5mDOIC5QGUwBc0EsB2VYDpMIAbMAYlTQAIAVACzAFswBtABgF1FQAHAe1iYsfbNxAAPRAA42+AEwB2KQFYAzGznKAnADZli1QBoQAT2kBGKfm37lOned3nzqgL6vjlLLgJFSFdCoAETAAMwBDAFdiagAFACc+ACswAGNqADlw5nYuJBB+QWFRfMkEABY5fDYa2rra83LjMwQdLWV8BXLyuxlVLU1Ld090bzxCEnJKYLComODMeLS0PniTXLFCoUwRMTK7fC1zNql7NgUjtnKjU0RlBSqpLVUVPVUda60tYZAvHHG-FNAgBVbBCKjIEywNBMDb5LbFPaILqdfRSORsS4qcxXZqIHqyK6qY4XOxsGTKco-P4+Cb+aYAIXCsDAVFBQjhvAE212pWkskUKnUml0+gUNxaqkU+EccnKF1UCnucnMcjcHl+o3+vkmZBofCgUFIMwARpEoFRYuFsGBiJyCtzEXzWrJlGxlKdVFKvfY1XiEBjyvhVOVzBdzu13pYFNStbTAQFqAB5bAmvjheIQf4QtDhNCRWD2hE7EqgfayHTEh7lHQNSxSf1Scz4cpHHFyFVujTKczuDXYPgQOBiGl4TaOktIhAAWg6X3nC4Xp39050sYw2rpYHHRUnztVhPJqmUlIGbEriv9WhrLZ6uibHcqUr7riAA */

src/routes/Home.tsx

@@ -31,7 +31,7 @@ import {
 import useStateMachineCommands from '../hooks/useStateMachineCommands'
 import { useSettingsAuthContext } from 'hooks/useSettingsAuthContext'
 import { useCommandsContext } from 'hooks/useCommandsContext'
-import { DEFAULT_PROJECT_NAME } from 'machines/settingsMachine'
+import { DEFAULT_PROJECT_NAME } from 'lib/settings'
 import { sep } from '@tauri-apps/api/path'
 import { homeCommandBarConfig } from 'lib/commandBarConfigs/homeCommandConfig'
 import { useHotkeys } from 'react-hotkeys-hook'

src/routes/Onboarding/Units.tsx

@@ -1,12 +1,11 @@
 import { faArrowRight, faXmark } from '@fortawesome/free-solid-svg-icons'
-import { BaseUnit, baseUnits } from '../../machines/settingsMachine'
+import { BaseUnit, baseUnits, UnitSystem } from 'lib/settings'
-import { ActionButton } from '../../components/ActionButton'
+import { ActionButton } from 'components/ActionButton'
 import { SettingsSection } from '../Settings'
-import { Toggle } from '../../components/Toggle/Toggle'
+import { Toggle } from 'components/Toggle/Toggle'
 import { useDismiss, useNextClick } from '.'
 import { onboardingPaths } from 'routes/Onboarding/paths'
 import { useSettingsAuthContext } from 'hooks/useSettingsAuthContext'
-import { UnitSystem } from 'machines/settingsMachine'
 
 export default function Units() {
   const dismiss = useDismiss()

src/routes/Settings.tsx

@@ -2,12 +2,8 @@ import { faArrowRotateBack, faXmark } from '@fortawesome/free-solid-svg-icons'
 import { ActionButton } from '../components/ActionButton'
 import { AppHeader } from '../components/AppHeader'
 import { open } from '@tauri-apps/api/dialog'
-import {
+import { BaseUnit, DEFAULT_PROJECT_NAME, baseUnits } from 'lib/settings'
-  BaseUnit,
+import { Toggle } from 'components/Toggle/Toggle'
-  DEFAULT_PROJECT_NAME,
-  baseUnits,
-} from '../machines/settingsMachine'
-import { Toggle } from '../components/Toggle/Toggle'
 import { useLocation, useNavigate, useRouteLoaderData } from 'react-router-dom'
 import { useHotkeys } from 'react-hotkeys-hook'
 import { type IndexLoaderData } from 'lib/types'
@@ -19,7 +15,7 @@ import {
   cameraSystems,
   cameraMouseDragGuards,
 } from 'lib/cameraControls'
-import { UnitSystem } from 'machines/settingsMachine'
+import { UnitSystem } from 'lib/settings'
 import { useDotDotSlash } from 'hooks/useDotDotSlash'
 import {
   createNewProject,