Skip to content

AI-native design editor. Open-source Figma alternative.

12.5 KB
Raw Blame
import { useLocalStorage } from '@vueuse/core'
import { uniq } from 'es-toolkit'
import * as v from 'valibot'

import { DEFAULT_SNAPPING_PREFERENCES, type SnappingPreferences } from '@open-pencil/core'
import { COMMENT_SORTS, type CommentSort } from '@open-pencil/scene-graph/comments'

import { DEFAULT_AGENT_STEPS, resolveAgentStepLimit } from '@/app/ai/reply/step-limit'
import {
  DEFAULT_TOOLBAR_LAYOUT,
  normalizeToolbarLayout,
  type ToolbarLayout
} from '@/app/editor/toolbar/layout'
import { DEFAULT_RECENT_FILES_LIMIT } from '@/app/recent-files/limit'
import { recentFilesLimitSchema } from '@/app/recent-files/schema'
import { DEFAULT_ACCENT } from '@/app/shell/accent/palette'
import { accentPreferenceSchema, type AccentPreference } from '@/app/shell/accent/schema'

export const INTERFACE_SCALES = [100, 110, 125, 150] as const
export type InterfaceScale = (typeof INTERFACE_SCALES)[number]

export const ANIMATION_PREFERENCES = ['system', 'off'] as const
export type AnimationPreference = (typeof ANIMATION_PREFERENCES)[number]

export const REASONING_DISPLAYS = ['collapsed', 'while-thinking', 'expanded'] as const
export type ReasoningDisplay = (typeof REASONING_DISPLAYS)[number]

export const CHANGE_PREVIEW_SIZES = ['off', 'small', 'medium', 'large'] as const
/** How large the before/after images kept for each AI edit are; `off` keeps only the JSX diff. */
export type ChangePreviewSize = (typeof CHANGE_PREVIEW_SIZES)[number]

export const TOKEN_USAGE_DISPLAYS = ['hover', 'always', 'hidden'] as const
/** When a reply shows the tokens it used: while hovered, always, or never. */
export type TokenUsageDisplay = (typeof TOKEN_USAGE_DISPLAYS)[number]

/** Multipliers for how far each wheel or pinch event zooms the canvas; 1 is Figma's rate. */
export const ZOOM_SPEEDS = [0.1, 0.25, 0.5, 0.75, 1, 1.5, 2] as const
export type ZoomSpeed = (typeof ZOOM_SPEEDS)[number]

export const DESIGN_CHECK_PRESETS = ['recommended', 'strict', 'accessibility'] as const
export type DesignCheckPreset = (typeof DESIGN_CHECK_PRESETS)[number]

export interface DesignCheckPreferences {
  /** Marks layers with errors and warnings on the canvas. */
  showOnCanvas: boolean
  preset: DesignCheckPreset
  /** Rules turned off on top of the preset. */
  disabledRules: string[]
}

export interface CommentPreferences {
  /** Pins on the canvas outside the Comment tool; View → Comments, Shift+C. */
  showOnCanvas: boolean
  /** The comments list and the canvas also show resolved threads. */
  showResolved: boolean
  /** The comments list shows only the current page's threads. */
  onlyPage: boolean
  /** The comments list shows only threads you started or replied to. */
  onlyMine: boolean
  sort: CommentSort
}

/** Whether the person was asked to share usage stats, and what they answered. */
export const USAGE_STATS_CONSENTS = ['unset', 'granted', 'denied'] as const
export type UsageStatsConsent = (typeof USAGE_STATS_CONSENTS)[number]

export interface SharingPreferences {
  /** The daily anonymous ping, on unless turned off. */
  dailyPing: boolean
  /** Opt-in usage stats; nothing is sent until this is `granted`. */
  usageStats: UsageStatsConsent
}

/** Whether guided AI setup was offered and finished or skipped. */
export const AI_SETUP_STATES = ['pending', 'done'] as const
export type AISetupState = (typeof AI_SETUP_STATES)[number]

/** When the donation question may show again, as a time in milliseconds; `null` before it was ever due. */
export interface DonationPreferences {
  promptAfter: number | null
}

/** Which events send a system notification while OpenPencil is out of view. */
export interface NotificationPreferences {
  /** An agent waits on a permission request. */
  agentNeedsInput: boolean
  /** An AI reply finished. */
  agentFinished: boolean
  /** An AI reply ended with an error. */
  agentFailed: boolean
}

export interface AppPreferences {
  appearance: {
    animations: AnimationPreference
    accent: AccentPreference
    interfaceScale: InterfaceScale
  }
  chat: {
    reasoningDisplay: ReasoningDisplay
    maxAgentSteps: number
    changePreviewSize: ChangePreviewSize
    /** Whether the view follows our AI agents while they work. */
    followAgents: boolean
    /** Whether a conversation is compacted when its context window fills up. */
    compactAutomatically: boolean
    tokenUsage: TokenUsageDisplay
  }
  files: { recentLimit: number }
  version: 1
  recovery: {
    enabled: boolean
  }
  editing: {
    snapping: SnappingPreferences
  }
  navigation: {
    zoomSpeed: ZoomSpeed
  }
  designCheck: DesignCheckPreferences
  comments: CommentPreferences
  toolbar: ToolbarLayout
  onboarding: {
    aiSetup: AISetupState
  }
  sharing: SharingPreferences
  donation: DonationPreferences
  notifications: NotificationPreferences
}

export const DEFAULT_APP_PREFERENCES: Readonly<AppPreferences> = {
  appearance: { animations: 'system', accent: { ...DEFAULT_ACCENT }, interfaceScale: 100 },
  chat: {
    reasoningDisplay: 'collapsed',
    maxAgentSteps: DEFAULT_AGENT_STEPS,
    changePreviewSize: 'medium',
    followAgents: true,
    compactAutomatically: true,
    tokenUsage: 'hover'
  },
  files: { recentLimit: DEFAULT_RECENT_FILES_LIMIT },
  version: 1,
  recovery: { enabled: true },
  editing: {
    snapping: { ...DEFAULT_SNAPPING_PREFERENCES }
  },
  navigation: { zoomSpeed: 1 },
  designCheck: { showOnCanvas: true, preset: 'recommended', disabledRules: [] },
  comments: {
    showOnCanvas: true,
    showResolved: false,
    onlyPage: false,
    onlyMine: false,
    sort: 'newest'
  },
  toolbar: structuredClone(DEFAULT_TOOLBAR_LAYOUT),
  onboarding: { aiSetup: 'pending' },
  sharing: { dailyPing: true, usageStats: 'unset' },
  donation: { promptAfter: null },
  notifications: { agentNeedsInput: true, agentFinished: false, agentFailed: false }
}

const STORAGE_KEY = 'open-pencil:preferences:v1'

/** An object whose fields each fall back to their default, and that is all defaults when absent. */
function section<TEntries extends v.ObjectEntries>(entries: TEntries) {
  const schema = v.object(entries)
  return v.fallback(schema, () => v.parse(schema, {}))
}

const defaults = DEFAULT_APP_PREFERENCES
const snapping = defaults.editing.snapping

/** Stored preferences, read field by field so one bad value keeps the rest. */
const appPreferencesSchema = section({
  appearance: section({
    interfaceScale: v.fallback(v.picklist(INTERFACE_SCALES), defaults.appearance.interfaceScale),
    animations: v.fallback(v.picklist(ANIMATION_PREFERENCES), defaults.appearance.animations),
    accent: v.fallback(accentPreferenceSchema, () => ({ ...DEFAULT_ACCENT }))
  }),
  chat: section({
    reasoningDisplay: v.fallback(v.picklist(REASONING_DISPLAYS), defaults.chat.reasoningDisplay),
    maxAgentSteps: v.fallback(
      v.pipe(v.unknown(), v.transform(resolveAgentStepLimit)),
      defaults.chat.maxAgentSteps
    ),
    changePreviewSize: v.fallback(
      v.picklist(CHANGE_PREVIEW_SIZES),
      defaults.chat.changePreviewSize
    ),
    followAgents: v.fallback(v.boolean(), defaults.chat.followAgents),
    compactAutomatically: v.fallback(v.boolean(), defaults.chat.compactAutomatically),
    tokenUsage: v.fallback(v.picklist(TOKEN_USAGE_DISPLAYS), defaults.chat.tokenUsage)
  }),
  files: section({
    recentLimit: v.fallback(recentFilesLimitSchema, defaults.files.recentLimit)
  }),
  version: v.fallback(v.literal(1), 1),
  recovery: section({ enabled: v.fallback(v.boolean(), defaults.recovery.enabled) }),
  editing: section({
    snapping: section({
      geometry: v.fallback(v.boolean(), snapping.geometry),
      objects: v.fallback(v.boolean(), snapping.objects),
      pixelGrid: v.fallback(v.boolean(), snapping.pixelGrid)
    })
  }),
  navigation: section({
    zoomSpeed: v.fallback(v.picklist(ZOOM_SPEEDS), defaults.navigation.zoomSpeed)
  }),
  designCheck: section({
    showOnCanvas: v.fallback(v.boolean(), defaults.designCheck.showOnCanvas),
    preset: v.fallback(v.picklist(DESIGN_CHECK_PRESETS), defaults.designCheck.preset),
    disabledRules: v.fallback(
      v.pipe(
        v.array(v.unknown()),
        v.transform((rules) => uniq(rules.filter((rule) => typeof rule === 'string')))
      ),
      () => []
    )
  }),
  comments: section({
    showOnCanvas: v.fallback(v.boolean(), defaults.comments.showOnCanvas),
    showResolved: v.fallback(v.boolean(), defaults.comments.showResolved),
    onlyPage: v.fallback(v.boolean(), defaults.comments.onlyPage),
    onlyMine: v.fallback(v.boolean(), defaults.comments.onlyMine),
    sort: v.fallback(v.picklist(COMMENT_SORTS), defaults.comments.sort)
  }),
  toolbar: v.fallback(
    v.pipe(
      v.object({
        groups: v.fallback(v.array(v.array(v.unknown())), () =>
          structuredClone(DEFAULT_TOOLBAR_LAYOUT.groups)
        ),
        hidden: v.fallback(v.array(v.unknown()), () => [])
      }),
      v.transform(({ groups, hidden }) => normalizeToolbarLayout(groups, hidden))
    ),
    () => structuredClone(DEFAULT_TOOLBAR_LAYOUT)
  ),
  onboarding: section({
    aiSetup: v.fallback(v.picklist(AI_SETUP_STATES), defaults.onboarding.aiSetup)
  }),
  sharing: section({
    dailyPing: v.fallback(v.boolean(), defaults.sharing.dailyPing),
    usageStats: v.fallback(v.picklist(USAGE_STATS_CONSENTS), defaults.sharing.usageStats)
  }),
  donation: section({
    promptAfter: v.fallback(
      v.nullable(v.pipe(v.number(), v.integer(), v.minValue(0))),
      defaults.donation.promptAfter
    )
  }),
  notifications: section({
    agentNeedsInput: v.fallback(v.boolean(), defaults.notifications.agentNeedsInput),
    agentFinished: v.fallback(v.boolean(), defaults.notifications.agentFinished),
    agentFailed: v.fallback(v.boolean(), defaults.notifications.agentFailed)
  })
})

/** Reads stored preferences, keeping every valid field and defaulting the rest. */
export function parseAppPreferences(value: unknown): AppPreferences {
  return v.parse(appPreferencesSchema, value)
}

export const appPreferences = useLocalStorage<AppPreferences>(
  STORAGE_KEY,
  structuredClone(DEFAULT_APP_PREFERENCES),
  { mergeDefaults: (storageValue) => parseAppPreferences(storageValue) }
)

export function updateAnimationPreference(animations: AnimationPreference): void {
  appPreferences.value = {
    ...appPreferences.value,
    appearance: { ...appPreferences.value.appearance, animations }
  }
}

export function updateAccentPreference(accent: AccentPreference): void {
  appPreferences.value = {
    ...appPreferences.value,
    appearance: { ...appPreferences.value.appearance, accent }
  }
}

export function updateRecoveryEnabled(enabled: boolean): void {
  const preferences = structuredClone(appPreferences.value)
  preferences.recovery.enabled = enabled
  appPreferences.value = preferences
}

export function updateAISetupState(aiSetup: AISetupState): void {
  appPreferences.value = { ...appPreferences.value, onboarding: { aiSetup } }
}

export function updateSharingPreferences(changes: Partial<SharingPreferences>): void {
  appPreferences.value = {
    ...appPreferences.value,
    sharing: { ...appPreferences.value.sharing, ...changes }
  }
}

export function updateDonationPreferences(changes: Partial<DonationPreferences>): void {
  appPreferences.value = {
    ...appPreferences.value,
    donation: { ...appPreferences.value.donation, ...changes }
  }
}

export function updateNotificationPreferences(changes: Partial<NotificationPreferences>): void {
  appPreferences.value = {
    ...appPreferences.value,
    notifications: { ...appPreferences.value.notifications, ...changes }
  }
}

export function updateZoomSpeed(zoomSpeed: ZoomSpeed): void {
  appPreferences.value = { ...appPreferences.value, navigation: { zoomSpeed } }
}

export function updateSnappingPreferences(changes: Partial<SnappingPreferences>): void {
  appPreferences.value = {
    ...appPreferences.value,
    editing: {
      ...appPreferences.value.editing,
      snapping: {
        ...appPreferences.value.editing.snapping,
        ...changes
      }
    }
  }
}

export function updateDesignCheckPreferences(changes: Partial<DesignCheckPreferences>): void {
  appPreferences.value = {
    ...appPreferences.value,
    designCheck: { ...appPreferences.value.designCheck, ...changes }
  }
}

export function updateCommentPreferences(changes: Partial<CommentPreferences>): void {
  appPreferences.value = {
    ...appPreferences.value,
    comments: { ...appPreferences.value.comments, ...changes }
  }
}

export function updateToolbarLayout(toolbar: ToolbarLayout): void {
  appPreferences.value = { ...appPreferences.value, toolbar }
}

export function updateInterfaceScale(interfaceScale: InterfaceScale): void {
  appPreferences.value = {
    ...appPreferences.value,
    appearance: { ...appPreferences.value.appearance, interfaceScale }
  }
}