@owdproject/core 3.3.1 → 4.0.0-alpha.3

package/runtime/stores/storeDesktopDefaultApps.ts

@@ -1,53 +0,0 @@
-import { defineStore } from 'pinia'
-import { useDesktopStore } from './storeDesktop'
-
-export const useDesktopDefaultAppsStore = defineStore(
-  'owd/desktop/defaultApps',
-  () => {
-    const desktopStore = useDesktopStore()
-
-    /**
-     * Sets a default app for a given feature
-     */
-    function setDefaultApp(
-      feature: string,
-      application: IApplicationController,
-      entry: string,
-    ) {
-      if (!desktopStore.state.hasOwnProperty('defaultApps')) {
-        desktopStore.state.defaultApps = {}
-      }
-
-      desktopStore.state.defaultApps[feature] = {
-        applicationId: application.id,
-        entry,
-      }
-    }
-
-    /**
-     * Gets the default app config for a given feature
-     */
-    function getDefaultApp(feature: string): DefaultAppConfig | undefined {
-      if (!desktopStore.state.hasOwnProperty('defaultApps')) {
-        desktopStore.state.defaultApps = {}
-      }
-
-      return desktopStore.state.defaultApps[feature]
-    }
-
-    /**
-     * Loads default apps from current config
-     */
-    function loadDefaultAppsFromConfig(runtimeConfig) {
-      if (runtimeConfig.public.desktop.defaultApps) {
-        desktopStore.state.defaultApps = runtimeConfig.public.desktop.defaultApps
-      }
-    }
-
-    return {
-      setDefaultApp,
-      getDefaultApp,
-      loadDefaultAppsFromConfig,
-    }
-  },
-)

package/runtime/stores/storeDesktopVolume.ts

@@ -1,18 +0,0 @@
-import { defineStore } from 'pinia'
-import { computed } from 'vue'
-import { useDesktopStore } from './storeDesktop'
-
-export const useDesktopVolumeStore = defineStore('owd/desktop/volume', () => {
-  const desktopStore = useDesktopStore()
-
-  const master = computed(() => desktopStore.state.volume.master)
-
-  function setMasterVolume(value: number) {
-    desktopStore.state.volume.master = value
-  }
-
-  return {
-    master,
-    setMasterVolume,
-  }
-})

package/runtime/stores/storeDesktopWindow.ts

@@ -1,20 +0,0 @@
-import { defineStore } from 'pinia'
-import { computed } from 'vue'
-import { useDesktopStore } from './storeDesktop'
-
-export const useDesktopWindowStore = defineStore('owd/desktop/window', () => {
-  const desktopStore = useDesktopStore()
-
-  const positionZ = computed(() => desktopStore.state.window.positionZ)
-
-  function incrementPositionZ() {
-    desktopStore.state.window.positionZ++
-
-    return desktopStore.state.window.positionZ
-  }
-
-  return {
-    positionZ,
-    incrementPositionZ,
-  }
-})

package/runtime/stores/storeDesktopWorkspace.ts

@@ -1,75 +0,0 @@
-import { defineStore } from 'pinia'
-import { computed } from 'vue'
-import { useDesktopStore } from './storeDesktop'
-import { nanoid } from 'nanoid'
-
-export const useDesktopWorkspaceStore = defineStore(
-  'owd/desktop/workspace',
-  () => {
-    const desktopStore = useDesktopStore()
-
-    const active = computed(() => {
-      return desktopStore.state.workspace.active
-    })
-
-    const overview = computed(() => {
-      return desktopStore.state.workspace.overview
-    })
-
-    const list = computed(() => {
-      return desktopStore.state.workspace.list
-    })
-
-    function setupWorkspaces() {
-      if (desktopStore.state.workspace.list.length === 0) {
-        createWorkspace()
-      }
-
-      if (desktopStore.state.workspace.list.length === 1) {
-        createWorkspace()
-      }
-
-      const list = desktopStore.state.workspace.list
-      const active = desktopStore.state.workspace.active
-      if (!active || !list.includes(active)) {
-        desktopStore.state.workspace.active = list[0] ?? ''
-      }
-    }
-
-    /** Id of the workspace new windows should use (after setupWorkspaces). */
-    function resolveActiveWorkspaceId(): string {
-      setupWorkspaces()
-      return desktopStore.state.workspace.active || desktopStore.state.workspace.list[0] || ''
-    }
-
-    function setOverview(value: boolean) {
-      desktopStore.state.workspace.overview = value
-    }
-
-    function setWorkspace(value: string) {
-      desktopStore.state.workspace.active = value
-    }
-
-    function createWorkspace() {
-      desktopStore.state.workspace.list.push(nanoid(8))
-    }
-
-    const workspaceActiveIndex = computed(() => {
-      return desktopStore.state.workspace.list.findIndex(
-        (workspace) => workspace === desktopStore.state.workspace.active,
-      )
-    })
-
-    return {
-      active,
-      overview,
-      list,
-      workspaceActiveIndex,
-      setupWorkspaces,
-      resolveActiveWorkspaceId,
-      setOverview,
-      setWorkspace,
-      createWorkspace,
-    }
-  },
-)

package/runtime/utils/captureElementToCanvas.ts

@@ -1,21 +0,0 @@
-/**
- * Renders a DOM subtree to a canvas via html2canvas (optional dependency).
- * Used for workspace thumbnails / previews; returns null if capture fails or html2canvas is missing.
- */
-export async function captureElementToCanvas(
-  element: HTMLElement | null | undefined,
-  options?: Record<string, unknown>,
-): Promise<HTMLCanvasElement | null> {
-  if (!element || typeof window === 'undefined') {
-    return null
-  }
-  try {
-    const { default: html2canvas } = await import('html2canvas')
-    return await html2canvas(element, {
-      allowTaint: true,
-      ...(options as object),
-    })
-  } catch {
-    return null
-  }
-}

package/runtime/utils/explorerEntryPath.ts

@@ -1,10 +0,0 @@
-/**
- * Absolute path for a listing entry under `basePath` (virtual FS paths).
- * Avoids `//fileName` when `basePath` is `/` or has trailing slashes.
- */
-export function explorerEntryAbsolutePath(basePath: string, fileName: string): string {
-  const normalizedBase = (basePath ?? '/').replace(/\/+$/, '') || '/'
-  const tail = fileName.replace(/^\/+/, '')
-  if (normalizedBase === '/') return `/${tail}`
-  return `${normalizedBase}/${tail}`
-}

package/runtime/utils/resolveDesktopConfigPath.ts

@@ -1,52 +0,0 @@
-import { existsSync } from 'node:fs'
-import { join } from 'node:path'
-
-export const DESKTOP_CONFIG_FILENAME = 'desktop.config.ts'
-export const LEGACY_DESKTOP_CONFIG_FILENAME = 'owd.config.ts'
-
-export const LEGACY_CONFIG_DEPRECATION =
-  '[@owdproject/core] owd.config.ts is deprecated and kept only for backward compatibility; rename to desktop.config.ts (required from @owdproject/core 3.2).'
-
-export type ResolvedDesktopConfigPath = {
-  path: string
-  file: string
-  legacy: boolean
-}
-
-export function resolveDesktopConfigPath(
-  rootDir: string,
-): ResolvedDesktopConfigPath | null {
-  const desktopPath = join(rootDir, DESKTOP_CONFIG_FILENAME)
-  const legacyPath = join(rootDir, LEGACY_DESKTOP_CONFIG_FILENAME)
-  const hasDesktop = existsSync(desktopPath)
-  const hasLegacy = existsSync(legacyPath)
-
-  if (hasDesktop && hasLegacy) {
-    console.warn(
-      '[@owdproject/core] Both desktop.config.ts and owd.config.ts exist; using desktop.config.ts. Remove owd.config.ts.',
-    )
-    return { path: desktopPath, file: DESKTOP_CONFIG_FILENAME, legacy: false }
-  }
-
-  if (hasDesktop) {
-    return { path: desktopPath, file: DESKTOP_CONFIG_FILENAME, legacy: false }
-  }
-
-  if (hasLegacy) {
-    return {
-      path: legacyPath,
-      file: LEGACY_DESKTOP_CONFIG_FILENAME,
-      legacy: true,
-    }
-  }
-
-  return null
-}
-
-export function warnLegacyDesktopConfig(
-  resolved: ResolvedDesktopConfigPath | null | undefined,
-): void {
-  if (resolved?.legacy) {
-    console.warn(LEGACY_CONFIG_DEPRECATION)
-  }
-}

package/runtime/utils/splitDesktopUserConfig.ts

@@ -1,85 +0,0 @@
-/**
- * Keys consumed by {@link @owdproject/core} module setup (install order).
- * Must not be spread onto `_nuxt.options`.
- */
-export const DESKTOP_MODULE_KEYS = ['theme', 'apps', 'modules'] as const
-
-/**
- * Known desktop shell keys merged into `runtimeConfig.public.desktop` / `appConfig.desktop`.
- * Additional keys are merged with a dev warning (extensions, theme overrides).
- */
-export const DESKTOP_RUNTIME_KEYS = new Set([
-  ...DESKTOP_MODULE_KEYS,
-  'docs',
-  'name',
-  'defaultApps',
-  'features',
-  'explorer',
-  'systemBar',
-  'dockBar',
-  'workspaces',
-])
-
-/** Nuxt top-level option names — warn if present in desktop.config (likely misconfiguration). */
-const NUXT_OPTION_KEYS = new Set([
-  'ssr',
-  'modules',
-  'devtools',
-  'vite',
-  'nitro',
-  'runtimeConfig',
-  'app',
-  'appConfig',
-  'css',
-  'plugins',
-  'hooks',
-  'extends',
-  'compatibilityDate',
-  'experimental',
-  'future',
-  'i18n',
-  'tailwindcss',
-  'primevue',
-])
-
-export type SplitDesktopUserConfigResult = {
-  theme?: string
-  apps?: string[]
-  modules?: string[]
-  desktopRuntime: Record<string, unknown>
-}
-
-export function splitDesktopUserConfig(
-  config: Record<string, unknown>,
-  configFile = 'desktop.config.ts',
-): SplitDesktopUserConfigResult {
-  const theme =
-    typeof config.theme === 'string' ? config.theme : undefined
-  const apps = Array.isArray(config.apps)
-    ? (config.apps as string[])
-    : undefined
-  const modules = Array.isArray(config.modules)
-    ? (config.modules as string[])
-    : undefined
-
-  const desktopRuntime: Record<string, unknown> = {}
-
-  for (const [key, value] of Object.entries(config)) {
-    if (DESKTOP_MODULE_KEYS.includes(key as (typeof DESKTOP_MODULE_KEYS)[number])) {
-      continue
-    }
-    desktopRuntime[key] = value
-
-    if (NUXT_OPTION_KEYS.has(key)) {
-      console.warn(
-        `[@owdproject/core] ${configFile}: key "${key}" looks like a Nuxt option and is ignored for _nuxt.options. Move it to nuxt.config.ts; shell values belong under defineDesktopConfig({ systemBar, workspaces, ... }).`,
-      )
-    } else if (!DESKTOP_RUNTIME_KEYS.has(key)) {
-      console.warn(
-        `[@owdproject/core] ${configFile}: unknown desktop key "${key}" — merged into runtimeConfig.public.desktop only.`,
-      )
-    }
-  }
-
-  return { theme, apps, modules, desktopRuntime }
-}

package/runtime/utils/utilApp.ts

@@ -1,37 +0,0 @@
-import type { Nuxt } from '@nuxt/schema'
-
-export function normalizeApplicationConfig(
-  config: ApplicationConfig,
-): ApplicationConfig {
-  const normalizedEntries: Record<string, ApplicationEntry> = {}
-
-  if (config.entries) {
-    for (const [key, entry] of Object.entries(config.entries)) {
-      normalizedEntries[key] = {
-        ...entry,
-        title: entry.title ?? config.title,
-        icon: entry.icon ?? config.icon,
-        category: entry.category ?? config.category,
-        visibility: entry.visibility ?? 'primary',
-      }
-    }
-  }
-
-  return {
-    ...config,
-    version: config.version ?? 'unknown',
-    description: config.description ?? '',
-    category: config.category ?? 'other',
-    entries: normalizedEntries,
-  }
-}
-
-export function registerTailwindPath(nuxt: Nuxt, path: string) {
-  nuxt.options.runtimeConfig.app.owd = nuxt.options.runtimeConfig.app.owd || {}
-  nuxt.options.runtimeConfig.app.owd.tailwindPaths =
-    nuxt.options.runtimeConfig.app.owd.tailwindPaths || []
-
-  if (!nuxt.options.runtimeConfig.app.owd.tailwindPaths.includes(path)) {
-    nuxt.options.runtimeConfig.app.owd.tailwindPaths.push(path)
-  }
-}

package/runtime/utils/utilCommon.ts

@@ -1,26 +0,0 @@
-export function deepClone<T>(obj: T): T {
-  return JSON.parse(JSON.stringify(obj))
-}
-
-export function deepEqual(obj1: any, obj2: any) {
-  const keys1 = Object.keys(obj1)
-  const keys2 = Object.keys(obj2)
-  if (keys1.length !== keys2.length) {
-    return false
-  }
-  for (const key of keys1) {
-    if (!obj2.hasOwnProperty(key)) {
-      return false
-    }
-    if (typeof obj1[key] === 'object' && typeof obj2[key] === 'object') {
-      if (!deepEqual(obj1[key], obj2[key])) {
-        return false
-      }
-    } else {
-      if (obj1[key] !== obj2[key]) {
-        return false
-      }
-    }
-  }
-  return true
-}

package/runtime/utils/utilDebug.ts

@@ -1,30 +0,0 @@
-export function isDebugMode() {
-  return import.meta.env.MODE === 'development'
-}
-
-export function debugLog(...messages: any[]) {
-  if (!isDebugMode()) {
-    return false
-  }
-
-  console.log('[OWD]', ...messages)
-  return true
-}
-
-export function debugWarn(...messages: any[]) {
-  if (!isDebugMode()) {
-    return false
-  }
-
-  console.warn('[OWD]', ...messages)
-  return true
-}
-
-export function debugError(...messages: any[]) {
-  if (!isDebugMode()) {
-    return false
-  }
-
-  console.error('[OWD]', ...messages)
-  return true
-}

package/runtime/utils/utilDesktop.ts

@@ -1,35 +0,0 @@
-import { getActivePinia } from 'pinia'
-import { useApplicationManager } from '../composables/useApplicationManager'
-
-const pendingDesktopApps: ApplicationConfig[] = []
-
-/**
- * Register a desktop app. Queues until Pinia is active when theme/app plugins
- * run before @pinia/nuxt (e.g. published apps using `app:created`).
- */
-export async function defineDesktopApp(config: ApplicationConfig) {
-  if (import.meta.server) return undefined
-
-  if (getActivePinia()) {
-    const applicationManager = useApplicationManager()
-    return applicationManager.defineApp(config.id, config)
-  }
-
-  pendingDesktopApps.push(config)
-  return undefined
-}
-
-export async function flushPendingDesktopApps() {
-  if (pendingDesktopApps.length === 0 || !getActivePinia()) return
-
-  const queue = pendingDesktopApps.splice(0, pendingDesktopApps.length)
-  const applicationManager = useApplicationManager()
-
-  for (const config of queue) {
-    await applicationManager.defineApp(config.id, config)
-  }
-}
-
-export function defineDesktopConfig(config: DesktopConfig) {
-  return config
-}

package/runtime/utils/utilTerminal.ts

@@ -1,6 +0,0 @@
-export function shellEscape(str: string): string {
-  if (str === '') {
-    return "''";
-  }
-  return `${str.replace(/'/g, `'\\''`)}`;
-}

package/runtime/utils/utilWindow.ts

@@ -1,15 +0,0 @@
-// support for controller-less windows
-// (for example: dummy windows in docs)
-export function handleWindowControllerProps(windowController: any) {
-  if (windowController.instanced) {
-    return windowController
-  }
-
-  return {
-    ...windowController,
-    ...windowController.config,
-    state: {
-      ...windowController.config,
-    },
-  }
-}

package/runtime/utils/validateDesktopUserConfig.ts

@@ -1,44 +0,0 @@
-/**
- * Runtime validation for the object exported from `desktop.config.ts`
- * (or legacy `owd.config.ts`).
- */
-export function assertValidDesktopUserConfig(
-  config: unknown,
-  configFile = 'desktop.config.ts',
-): void {
-  if (!config || typeof config !== 'object' || Array.isArray(config)) {
-    throw new Error(
-      `[@owdproject/core] ${configFile} must default-export a non-array object from defineDesktopConfig({ ... }).`,
-    )
-  }
-
-  const c = config as Record<string, unknown>
-
-  if (c.theme != null && typeof c.theme !== 'string') {
-    throw new Error(
-      `[@owdproject/core] ${configFile}: \`theme\` must be a string (npm package name of the theme module).`,
-    )
-  }
-
-  if (c.apps !== undefined) {
-    if (
-      !Array.isArray(c.apps) ||
-      !(c.apps as unknown[]).every((item) => typeof item === 'string')
-    ) {
-      throw new Error(
-        `[@owdproject/core] ${configFile}: \`apps\` must be an array of strings (Nuxt module package names).`,
-      )
-    }
-  }
-
-  if (c.modules !== undefined) {
-    if (
-      !Array.isArray(c.modules) ||
-      !(c.modules as unknown[]).every((item) => typeof item === 'string')
-    ) {
-      throw new Error(
-        `[@owdproject/core] ${configFile}: \`modules\` must be an array of strings (Nuxt module package names).`,
-      )
-    }
-  }
-}