@owdproject/core 3.4.0 → 4.0.0-alpha.4

package/kit/authoring.ts

@@ -1,340 +0,0 @@
-import { existsSync } from 'node:fs'
-import { join } from 'node:path'
-
-import {
-  defineNuxtModule,
-  installModule,
-  type NuxtModule,
-} from '@nuxt/kit'
-import type { Nuxt } from '@nuxt/schema'
-import { defu } from 'defu'
-
-/** Root `desktop.config.ts` helper — keep this file free of `import.meta` for jiti. */
-export function defineDesktopConfig(config: DesktopConfig) {
-  return config
-}
-
-/**
- * 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).`,
-      )
-    }
-  }
-}
-
-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)
-  }
-}
-
-/** Path used when creating or updating config from the CLI (always the new filename). */
-export function desktopConfigWritePath(desktopDir: string): string {
-  return join(desktopDir, DESKTOP_CONFIG_FILENAME)
-}
-
-/** Nuxt top-level option names — warn if present in desktop.config (likely misconfiguration). */
-const NUXT_OPTION_KEYS = new Set([
-  'ssr',
-  'devtools',
-  'vite',
-  'nitro',
-  'runtimeConfig',
-  'app',
-  'appConfig',
-  'css',
-  'plugins',
-  'hooks',
-  'extends',
-  'compatibilityDate',
-  'experimental',
-  'future',
-  'i18n',
-  'tailwindcss',
-  'primevue',
-])
-
-/**
- * Warn when desktop.config.ts contains keys that look like Nuxt options.
- * Extension keys (fs, terminal, custom app namespaces) are intentionally not validated here.
- */
-export function warnDesktopConfigKeys(
-  config: Record<string, unknown>,
-  configFile = 'desktop.config.ts',
-): void {
-  for (const key of Object.keys(config)) {
-    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, ... }).`,
-      )
-    }
-  }
-}
-
-/**
- * Writes a resolved extension namespace to `runtimeConfig.public.desktop[configKey]`.
- * Used by {@link defineDesktopModule} after Nuxt merges inline options with module defaults.
- */
-export function setDesktopExtensionConfig(
-  nuxt: Nuxt,
-  configKey: string,
-  resolved: Record<string, unknown>,
-): void {
-  const pub = (nuxt.options.runtimeConfig.public ??= {}) as {
-    desktop?: Record<string, unknown>
-  }
-  const desktop = (pub.desktop ??= {})
-  desktop[configKey] = resolved
-}
-
-/**
- * Merges theme or module defaults into an extension namespace on `public.desktop`.
- * User values from desktop.config win over `partial` (defu: partial fills undefined only).
- */
-export function mergeDesktopExtensionConfig(
-  nuxt: Nuxt,
-  configKey: string,
-  partial: Record<string, unknown>,
-): void {
-  const pub = (nuxt.options.runtimeConfig.public ??= {}) as {
-    desktop?: Record<string, unknown>
-  }
-  const desktop = (pub.desktop ??= {})
-  const existing = desktop[configKey]
-  const base =
-    existing && typeof existing === 'object' && !Array.isArray(existing)
-      ? (existing as Record<string, unknown>)
-      : {}
-  desktop[configKey] = defu(partial, base)
-}
-
-type ModuleLike = {
-  meta?: { configKey?: string }
-  default?: { meta?: { configKey?: string } }
-}
-
-function readConfigKey(mod: ModuleLike | undefined): string | undefined {
-  const key = mod?.meta?.configKey ?? mod?.default?.meta?.configKey
-  return typeof key === 'string' && key.length > 0 ? key : undefined
-}
-
-async function loadModuleDescriptor(
-  modulePath: string,
-): Promise<ModuleLike | undefined> {
-  try {
-    const imported = await import(modulePath)
-    return (imported as { default?: ModuleLike }).default ?? imported
-  } catch (e: any) {
-    console.warn(`[@owdproject/core] Failed to load module descriptor for "${modulePath}":`, e.message || e)
-    return undefined
-  }
-}
-
-/**
- * Installs a desktop theme, module, or app package.
- * When the package exposes `meta.configKey`, passes `desktop[configKey]` to `installModule`
- * so Nuxt merges desktop.config with module defaults.
- */
-export async function installDesktopPackage(
-  nuxt: Nuxt,
-  modulePath: string,
-  desktop?: Record<string, unknown>,
-): Promise<void> {
-  const descriptor = await loadModuleDescriptor(modulePath)
-  const configKey = readConfigKey(descriptor)
-
-  if (configKey && desktop) {
-    const slice = desktop[configKey]
-    const inline =
-      slice && typeof slice === 'object' && !Array.isArray(slice)
-        ? (slice as Record<string, unknown>)
-        : {}
-    await installModule(modulePath, inline)
-    return
-  }
-
-  await installModule(modulePath)
-}
-
-type DesktopModuleMeta = {
-  name: string
-  configKey: string
-}
-
-type DesktopModuleDefinition = NuxtModule<
-  Record<string, unknown>,
-  Record<string, unknown>,
-  false
-> & {
-  meta: DesktopModuleMeta
-}
-
-/**
- * Nuxt module wrapper for desktop apps and extension modules (`configKey` → desktop.config namespace).
- * Publishes merged options to `runtimeConfig.public.desktop[configKey]` after setup runs.
- */
-export function defineDesktopModule(
-  definition: DesktopModuleDefinition,
-): ReturnType<typeof defineNuxtModule> {
-  const configKey = definition.meta.configKey
-  if (!configKey) {
-    throw new Error(
-      '[@owdproject/core] defineDesktopModule requires meta.configKey (e.g. "terminal", "fs").',
-    )
-  }
-
-  const userSetup = definition.setup
-
-  return defineNuxtModule({
-    ...definition,
-    async setup(options, nuxt) {
-      const pub = (nuxt.options.runtimeConfig.public ??= {}) as {
-        desktop?: Record<string, unknown>
-      }
-      const desktop = (pub.desktop ??= {})
-      const userConfig = desktop[configKey]
-
-      // Merge userConfig (wins) with options (defaults / inline)
-      const merged = defu(
-        userConfig && typeof userConfig === 'object' ? userConfig : {},
-        options as Record<string, unknown>,
-      )
-
-      // Mutate options in place so userSetup receives the fully merged options
-      Object.assign(options, merged)
-
-      // Set/update the merged config on public.desktop
-      desktop[configKey] = options
-
-      if (typeof userSetup === 'function') {
-        return userSetup(options, nuxt)
-      }
-    },
-  } as NuxtModule)
-}
-
-type DesktopThemeDefinition = NuxtModule<
-  Record<string, unknown>,
-  Record<string, unknown>,
-  false
->
-
-/**
- * Nuxt module wrapper for desktop themes.
- * Merges theme shell defaults into `runtimeConfig.public.desktop` (user desktop.config wins).
- *
- * Tailwind content for theme Vue templates is registered via
- * `@owdproject/kit-primevue/kit/registerTailwindPath` after installing kit-primevue.
- */
-export function defineDesktopTheme(
-  definition: DesktopThemeDefinition,
-): ReturnType<typeof defineNuxtModule> {
-  const userSetup = definition.setup
-
-  return defineNuxtModule({
-    ...definition,
-    meta: {
-      ...definition.meta,
-      configKey: 'desktop',
-    },
-    async setup(options, nuxt) {
-      const pub = (nuxt.options.runtimeConfig.public ??= {}) as {
-        desktop?: Record<string, unknown>
-      }
-      
-      // Automatically merge userConfig (pub.desktop) with theme defaults (options)
-      pub.desktop = defu(
-        (pub.desktop ?? {}) as Record<string, unknown>,
-        options as Record<string, unknown>,
-      )
-
-      // Mutate options in place so userSetup receives the fully merged options
-      Object.assign(options, pub.desktop)
-
-      if (typeof userSetup === 'function') {
-        return userSetup(options, nuxt)
-      }
-    },
-  } as NuxtModule)
-}

package/kit/defineDesktopApp.ts

@@ -1,56 +0,0 @@
-import { getActivePinia, setActivePinia } from 'pinia'
-import type { Pinia } from 'pinia'
-import { useApplicationManager } from '../runtime/composables/useApplicationManager'
-
-const pendingDesktopApps: ApplicationConfig[] = []
-
-let pluginPiniaInstance: Pinia | undefined
-
-/** Set by desktop-shell-init; avoids importing nuxt/app during jiti config load. */
-export function registerDesktopPluginPinia(pinia: Pinia | undefined) {
-  pluginPiniaInstance = pinia
-}
-
-function resolveActivePinia() {
-  const active = getActivePinia()
-  if (active) return active
-
-  if (pluginPiniaInstance) {
-    setActivePinia(pluginPiniaInstance)
-    return pluginPiniaInstance
-  }
-
-  return undefined
-}
-
-let isBooted = false
-
-/**
- * Register a desktop app. Queues until Pinia is active when theme/app plugins
- * run before shell-init (legacy published apps using synchronous setup).
- */
-export async function defineDesktopApp(config: ApplicationConfig) {
-  if (import.meta.server) return undefined
-
-  if (isBooted && resolveActivePinia()) {
-    const applicationManager = useApplicationManager()
-    return applicationManager.defineApp(config.id, config)
-  }
-
-  pendingDesktopApps.push(config)
-  return undefined
-}
-
-export async function flushPendingDesktopApps() {
-  isBooted = true
-  if (pendingDesktopApps.length === 0) return
-
-  if (!resolveActivePinia()) return
-
-  const queue = pendingDesktopApps.splice(0, pendingDesktopApps.length)
-  const applicationManager = useApplicationManager()
-
-  for (const config of queue) {
-    await applicationManager.defineApp(config.id, config)
-  }
-}

package/module.ts

@@ -1,203 +0,0 @@
-import {
-  defineNuxtModule,
-  createResolver,
-  addComponentsDir,
-  addImportsDir,
-  installModule,
-  addPlugin,
-  resolvePath
-} from '@nuxt/kit'
-import { defu } from 'defu'
-import {
-  assertValidDesktopUserConfig,
-  installDesktopPackage,
-  resolveDesktopConfigPath,
-  warnDesktopConfigKeys,
-  warnLegacyDesktopConfig,
-} from './kit/authoring'
-import pkg from './package.json'
-
-export default defineNuxtModule({
-  meta: {
-    name: 'desktop',
-    configKey: 'desktop',
-  },
-  defaults: {
-    theme: '@owdproject/theme-nova',
-    apps: [],
-    modules: [],
-  },
-  moduleDependencies: {
-    '@pinia/nuxt': {},
-    '@nuxt/fonts': {},
-    '@nuxt/icon': {
-      defaults: {
-        clientBundle: {
-          scan: true,
-          sizeLimitKb: 256,
-        },
-      },
-    },
-    '@vueuse/nuxt': {},
-    '@nuxtjs/i18n': {},
-  },
-  async setup(_options, _nuxt) {
-    const { resolve } = createResolver(import.meta.url)
-
-    let resolvedNanoid: string | null = null
-    try {
-      resolvedNanoid = await resolvePath('nanoid', { url: import.meta.url })
-    } catch (e) {
-      // ignore
-    }
-
-    // Required for Nuxt 4 dev (playgrounds, module graphs): avoids
-    // "Vite Node IPC socket path not configured" when using @nuxt/kit pipelines.
-    _nuxt.options.experimental = {
-      ..._nuxt.options.experimental,
-      viteEnvironmentApi:
-        _nuxt.options.experimental?.viteEnvironmentApi ?? true,
-    }
-
-    _nuxt.options.runtimeConfig.public.desktop = {}
-
-    // get open web desktop config (desktop.config.ts; owd.config.ts legacy)
-
-    let clientConfig
-
-    const resolvedConfig = resolveDesktopConfigPath(_nuxt.options.rootDir)
-
-    if (!resolvedConfig) {
-      const hint =
-        'Create desktop.config.ts next to your Nuxt root (e.g. desktop/desktop.config.ts), export default defineDesktopConfig({ theme, apps, modules }).'
-      throw new Error(`[@owdproject/core] Cannot find desktop.config.ts in ${_nuxt.options.rootDir}. ${hint}`)
-    }
-
-    warnLegacyDesktopConfig(resolvedConfig)
-
-    // Nuxt dev restart + ℹ log (same as nuxt.config.ts); avoid builder:watch + restart (silent / double).
-    _nuxt.options.watch ??= []
-    _nuxt.options.watch.push(resolvedConfig.path)
-
-    try {
-      clientConfig = (await import(resolvedConfig.path)).default
-    } catch (e) {
-      const hint =
-        'Export default defineDesktopConfig({ theme, apps, modules }) from desktop.config.ts.'
-      throw new Error(
-        `[@owdproject/core] Cannot load ${resolvedConfig.file}. ${hint}`,
-        { cause: e },
-      )
-    }
-
-    assertValidDesktopUserConfig(clientConfig, resolvedConfig.file)
-
-    if (!clientConfig.theme) {
-      clientConfig.theme = '@owdproject/theme-nova'
-    }
-
-    const configRecord = clientConfig as Record<string, unknown>
-    warnDesktopConfigKeys(configRecord, resolvedConfig.file)
-
-    const desktop = defu(configRecord, { coreVersion: pkg.version }) as Record<
-      string,
-      unknown
-    > & {
-      theme?: string
-      apps?: string[]
-      modules?: string[]
-    }
-
-    _nuxt.options.runtimeConfig.public.desktop = desktop
-
-    {
-      if (desktop.theme) {
-        try {
-          await installDesktopPackage(_nuxt, desktop.theme, desktop)
-        } catch (e) {
-          const msg = e instanceof Error ? e.message : String(e)
-          console.warn(`[@owdproject/core] Warning: Could not load theme "${desktop.theme}". Details: ${msg}`)
-        }
-      }
-
-      if (Array.isArray(desktop.modules)) {
-        for (const modulePath of desktop.modules) {
-          try {
-            await installDesktopPackage(_nuxt, modulePath, desktop)
-          } catch (e) {
-            const msg = e instanceof Error ? e.message : String(e)
-            console.warn(`[@owdproject/core] Warning: Could not load module "${modulePath}". Details: ${msg}`)
-          }
-        }
-      }
-
-      if (Array.isArray(desktop.apps)) {
-        for (const appPath of desktop.apps) {
-          try {
-            await installDesktopPackage(_nuxt, appPath, desktop)
-          } catch (e) {
-            const msg = e instanceof Error ? e.message : String(e)
-            console.warn(`[@owdproject/core] Warning: Could not load app "${appPath}". Details: ${msg}`)
-          }
-        }
-      }
-    }
-
-    // assign runtimeConfig desktop prop to appConfig
-    // to make it overwritable by components later
-    // via useDesktopManager
-    _nuxt.options.appConfig.desktop = _nuxt.options.runtimeConfig.public.desktop
-
-    {
-      // configure scss for vite
-
-      _nuxt.hook('vite:extendConfig', (viteConfig) => {
-        viteConfig.css = viteConfig.css || {}
-        viteConfig.css.preprocessorOptions =
-          viteConfig.css.preprocessorOptions || {}
-        viteConfig.css.preprocessorOptions.scss = {
-          api: 'modern-compiler'
-        }
-
-        viteConfig.optimizeDeps = viteConfig.optimizeDeps || {}
-        viteConfig.optimizeDeps.include = viteConfig.optimizeDeps.include || []
-        if (resolvedNanoid && !viteConfig.optimizeDeps.include.includes(resolvedNanoid)) {
-          viteConfig.optimizeDeps.include.push(resolvedNanoid)
-        }
-      })
-    }
-
-    {
-      // add css
-
-      _nuxt.options.css.push('sanitize.css')
-    }
-
-    {
-      // add components
-
-      addComponentsDir({
-        path: resolve('./runtime/components'),
-        prefix: 'Desktop',
-        pathPrefix: false,
-        global: true
-      })
-    }
-
-    {
-      addPlugin(resolve('./runtime/plugins/resize.client.ts'))
-      addPlugin(
-        resolve('./runtime/plugins/01.desktop-shell-init.client.ts'),
-      )
-      addPlugin(
-        resolve('./runtime/plugins/02.desktop-register-desktop-apps.client.ts'),
-      )
-
-      // add other files
-
-      addImportsDir(resolve('./runtime/composables'))
-      addImportsDir(resolve('./runtime/stores'))
-      addImportsDir(resolve('./runtime/utils'))
-    }
-  }
-})

package/runtime/components/Application/DesktopCoreApplicationRender.vue

@@ -1,20 +0,0 @@
-<script setup lang="ts">
-import { useApplicationManager } from '../../composables/useApplicationManager'
-
-defineProps<{
-  workspaceFilter?: string
-}>()
-
-const applicationManager = useApplicationManager()
-const runningApps = applicationManager.appsRunning
-</script>
-
-<template>
-  <DesktopCoreApplicationWindowsRender
-    v-for="app of runningApps"
-    :key="app.id"
-    :workspace-filter="workspaceFilter"
-    :windows="app.windowsOpened"
-    :window-revision="app.openWindowCount.value"
-  />
-</template>

package/runtime/components/Application/DesktopCoreApplicationWindowsRender.vue

@@ -1,38 +0,0 @@
-<script setup lang="ts">
-import { computed } from 'vue'
-import { useDesktopWorkspaceStore } from '../../stores/storeDesktopWorkspace'
-
-const props = defineProps<{
-  workspaceFilter?: string
-  windows: Map<string, IWindowController>
-  /** Tracks ApplicationController.openWindowCount so Vue re-renders when the map is replaced. */
-  windowRevision?: number
-}>()
-
-const desktopWorkspaceStore = useDesktopWorkspaceStore()
-
-const windowEntries = computed(() => {
-  void props.windowRevision
-  return Array.from(props.windows.entries())
-})
-
-function matchesWorkspace(window: IWindowController): boolean {
-  const filter = props.workspaceFilter
-  if (!filter) return true
-
-  const ws = window.state.workspace
-  if (!ws) {
-    return filter === desktopWorkspaceStore.active
-  }
-
-  return ws === filter
-}
-</script>
-
-<template>
-  <template v-for="[windowId, window] in windowEntries" :key="windowId">
-    <Suspense v-if="matchesWorkspace(window)">
-      <component :window="window" :is="window.config.component" />
-    </Suspense>
-  </template>
-</template>

package/runtime/components/background/DesktopCoreBackground.vue

@@ -1,16 +0,0 @@
-<template>
-  <div class="owd-background">
-    <slot />
-  </div>
-</template>
-
-<style scoped lang="scss">
-.owd-background {
-  position: fixed;
-  top: 0;
-  left: 0;
-  right: 0;
-  bottom: 0;
-  background-color: var(--owd-background-color);
-}
-</style>