@owdproject/core 3.1.4 → 3.3.0

package/dist/module.d.mts

@@ -0,0 +1,13 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+declare const _default: _nuxt_schema.NuxtModule<{
+    theme: string;
+    apps: never[];
+    modules: never[];
+}, {
+    theme: string;
+    apps: never[];
+    modules: never[];
+}, false>;
+
+export { _default as default };

package/dist/module.json

@@ -0,0 +1,9 @@
+{
+  "name": "desktop",
+  "configKey": "owd",
+  "version": "3.3.0",
+  "builder": {
+    "@nuxt/module-builder": "1.0.2",
+    "unbuild": "3.6.1"
+  }
+}

package/dist/module.mjs

@@ -0,0 +1,267 @@
+import { defineNuxtModule, createResolver, installModule, addComponentsDir, addPlugin, addImportsDir } from '@nuxt/kit';
+import { defu } from 'defu';
+import { existsSync } from 'node:fs';
+import { join } from 'node:path';
+
+function assertValidDesktopUserConfig(config, configFile = "desktop.config.ts") {
+  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;
+  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 !== void 0) {
+    if (!Array.isArray(c.apps) || !c.apps.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 !== void 0) {
+    if (!Array.isArray(c.modules) || !c.modules.every((item) => typeof item === "string")) {
+      throw new Error(
+        `[@owdproject/core] ${configFile}: \`modules\` must be an array of strings (Nuxt module package names).`
+      );
+    }
+  }
+}
+
+const DESKTOP_CONFIG_FILENAME = "desktop.config.ts";
+const LEGACY_DESKTOP_CONFIG_FILENAME = "owd.config.ts";
+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).";
+function resolveDesktopConfigPath(rootDir) {
+  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;
+}
+function warnLegacyDesktopConfig(resolved) {
+  if (resolved?.legacy) {
+    console.warn(LEGACY_CONFIG_DEPRECATION);
+  }
+}
+
+const DESKTOP_MODULE_KEYS = ["theme", "apps", "modules"];
+const DESKTOP_RUNTIME_KEYS = /* @__PURE__ */ new Set([
+  ...DESKTOP_MODULE_KEYS,
+  "docs",
+  "name",
+  "defaultApps",
+  "features",
+  "explorer",
+  "systemBar",
+  "dockBar",
+  "workspaces"
+]);
+const NUXT_OPTION_KEYS = /* @__PURE__ */ new Set([
+  "ssr",
+  "modules",
+  "devtools",
+  "vite",
+  "nitro",
+  "runtimeConfig",
+  "app",
+  "appConfig",
+  "css",
+  "plugins",
+  "hooks",
+  "extends",
+  "compatibilityDate",
+  "experimental",
+  "future",
+  "i18n",
+  "tailwindcss",
+  "primevue"
+]);
+function splitDesktopUserConfig(config, configFile = "desktop.config.ts") {
+  const theme = typeof config.theme === "string" ? config.theme : void 0;
+  const apps = Array.isArray(config.apps) ? config.apps : void 0;
+  const modules = Array.isArray(config.modules) ? config.modules : void 0;
+  const desktopRuntime = {};
+  for (const [key, value] of Object.entries(config)) {
+    if (DESKTOP_MODULE_KEYS.includes(key)) {
+      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}" \u2014 merged into runtimeConfig.public.desktop only.`
+      );
+    }
+  }
+  return { theme, apps, modules, desktopRuntime };
+}
+
+const version = "3.3.0";
+const pkg = {
+	version: version};
+
+const module$1 = defineNuxtModule({
+  meta: {
+    name: "desktop",
+    configKey: "owd"
+  },
+  defaults: {
+    theme: "@owdproject/theme-nova",
+    apps: [],
+    modules: []
+  },
+  async setup(_options, _nuxt) {
+    const { resolve } = createResolver(import.meta.url);
+    _nuxt.options.experimental = {
+      ..._nuxt.options.experimental,
+      viteEnvironmentApi: _nuxt.options.experimental?.viteEnvironmentApi ?? true
+    };
+    _nuxt.options.runtimeConfig.public.desktop = {};
+    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);
+    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 {
+      theme: configTheme,
+      apps: configApps,
+      modules: configModules,
+      desktopRuntime
+    } = splitDesktopUserConfig(
+      clientConfig,
+      resolvedConfig.file
+    );
+    clientConfig.theme = configTheme ?? clientConfig.theme;
+    if (configApps) clientConfig.apps = configApps;
+    if (configModules) clientConfig.modules = configModules;
+    _nuxt.options.runtimeConfig.public.desktop = defu(
+      desktopRuntime,
+      { coreVersion: pkg.version }
+    );
+    await installModule("@pinia/nuxt");
+    {
+      if (clientConfig.theme) {
+        await installModule(clientConfig.theme);
+      }
+      if (clientConfig.modules && Array.isArray(clientConfig.modules)) {
+        for (const modulePath of clientConfig.modules) {
+          await installModule(modulePath);
+        }
+      }
+      if (clientConfig.apps && Array.isArray(clientConfig.apps)) {
+        for (const appPath of clientConfig.apps) {
+          await installModule(appPath);
+        }
+      }
+    }
+    _nuxt.options.appConfig.desktop = _nuxt.options.runtimeConfig.public.desktop;
+    {
+      _nuxt.options.primevue = _nuxt.options.primevue || {};
+      _nuxt.options.primevue.options = _nuxt.options.primevue.options || {};
+      _nuxt.options.primevue.options.theme = _nuxt.options.primevue.options.theme || {};
+      _nuxt.options.primevue.components = _nuxt.options.primevue.components || {};
+      const include = _nuxt.options.primevue.components.include;
+      if (include && include !== "*" && Array.isArray(include)) {
+        if (!include.includes("ConfirmDialog")) {
+          include.push("ConfirmDialog");
+        }
+      }
+      await installModule("@primevue/nuxt-module");
+    }
+    {
+      const tailwindPaths = _nuxt.options.runtimeConfig.app.owd?.tailwindPaths || [];
+      tailwindPaths.push("./runtime/components/**/*.{vue,mjs,ts}");
+      _nuxt.options.tailwindcss = _nuxt.options.tailwindcss || {};
+      _nuxt.options.tailwindcss.config = _nuxt.options.tailwindcss.config || {};
+      _nuxt.options.tailwindcss.config.content = tailwindPaths;
+      await installModule("@nuxtjs/tailwindcss", {
+        viewer: false
+      });
+    }
+    {
+      await installModule("@nuxt/fonts");
+    }
+    {
+      await installModule("@nuxt/icon", {
+        clientBundle: {
+          scan: true,
+          sizeLimitKb: 256
+        }
+      });
+    }
+    {
+      await installModule("@vueuse/nuxt");
+    }
+    {
+      await installModule("@nuxtjs/i18n");
+    }
+    {
+      _nuxt.hook("vite:extendConfig", (viteConfig) => {
+        viteConfig.css = viteConfig.css || {};
+        viteConfig.css.preprocessorOptions = viteConfig.css.preprocessorOptions || {};
+        viteConfig.css.preprocessorOptions.scss = {
+          api: "modern-compiler"
+        };
+      });
+    }
+    {
+      _nuxt.options.css.push("sanitize.css");
+    }
+    {
+      addComponentsDir({
+        path: resolve("./runtime/components"),
+        prefix: "",
+        pathPrefix: false,
+        global: true
+      });
+    }
+    {
+      addPlugin(resolve("./runtime/plugins/resize.client.ts"));
+      addPlugin(
+        resolve("./runtime/plugins/02.desktop-register-desktop-apps.client.ts")
+      );
+      addImportsDir(resolve("./runtime/composables"));
+      addImportsDir(resolve("./runtime/stores"));
+      addImportsDir(resolve("./runtime/utils"));
+    }
+  }
+});
+
+export { module$1 as default };

package/dist/types.d.mts

@@ -0,0 +1,7 @@
+import type { NuxtModule } from '@nuxt/schema'
+
+import type { default as Module } from './module.mjs'
+
+export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
+
+export { default } from './module.mjs'

package/module.ts

@@ -6,62 +6,94 @@ import {
   installModule,
   addPlugin
 } from '@nuxt/kit'
-import { deepMerge } from './runtime/utils/utilCommon'
+import { defu } from 'defu'
+import { assertValidDesktopUserConfig } from './runtime/utils/validateDesktopUserConfig'
+import {
+  resolveDesktopConfigPath,
+  warnLegacyDesktopConfig,
+} from './runtime/utils/resolveDesktopConfigPath'
+import { splitDesktopUserConfig } from './runtime/utils/splitDesktopUserConfig'
 import pkg from './package.json'
 
 export default defineNuxtModule({
   meta: {
-    name: 'owd-core',
-    configKey: 'owd'
+    name: 'desktop',
+    configKey: 'owd',
   },
   defaults: {
-    theme: '@owdproject/theme-win95',
+    theme: '@owdproject/theme-nova',
     apps: [],
     modules: [],
   },
   async setup(_options, _nuxt) {
     const { resolve } = createResolver(import.meta.url)
 
+    // 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
+    // get open web desktop config (desktop.config.ts; owd.config.ts legacy)
 
     let clientConfig
 
-    try {
+    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}`)
+    }
 
-      clientConfig = (
-        await import(_nuxt.options.rootDir + '/owd.config.ts')
-      ).default
+    warnLegacyDesktopConfig(resolvedConfig)
 
+    try {
+      clientConfig = (await import(resolvedConfig.path)).default
     } catch (e) {
-      console.error('/desktop/owd.config.ts not found or invalid', e)
-      return
+      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-win95'
+      clientConfig.theme = '@owdproject/theme-nova'
     }
 
-    // extend nuxt.config.ts with owd.config.ts
+    const {
+      theme: configTheme,
+      apps: configApps,
+      modules: configModules,
+      desktopRuntime,
+    } = splitDesktopUserConfig(
+      clientConfig as Record<string, unknown>,
+      resolvedConfig.file,
+    )
 
-    _nuxt.options = {
-      ..._nuxt.options,
-      ...clientConfig
-    }
+    clientConfig.theme = configTheme ?? clientConfig.theme
+    if (configApps) clientConfig.apps = configApps
+    if (configModules) clientConfig.modules = configModules
 
     // init desktop runtime config and define core version
 
-    _nuxt.options.runtimeConfig.public.desktop = {
-      coreVersion: pkg.version
-    }
-
-    // assign open web desktop config to runtime config
-    _nuxt.options.runtimeConfig.public.desktop = deepMerge(
-      _nuxt.options.runtimeConfig.public.desktop,
-      clientConfig
+    _nuxt.options.runtimeConfig.public.desktop = defu(
+      desktopRuntime,
+      { coreVersion: pkg.version },
     )
 
+    // Pinia before theme/modules/apps so defineDesktopApp can use stores when
+    // published app plugins register on app:created.
+    await installModule('@pinia/nuxt')
+
     {
       // install open web desktop theme
 
@@ -99,6 +131,14 @@ export default defineNuxtModule({
       _nuxt.options.primevue.options = _nuxt.options.primevue.options || {}
       _nuxt.options.primevue.options.theme =
         _nuxt.options.primevue.options.theme || {}
+      _nuxt.options.primevue.components =
+        _nuxt.options.primevue.components || {}
+      const include = _nuxt.options.primevue.components.include
+      if (include && include !== '*' && Array.isArray(include)) {
+        if (!include.includes('ConfirmDialog')) {
+          include.push('ConfirmDialog')
+        }
+      }
 
       await installModule('@primevue/nuxt-module')
     }
@@ -120,12 +160,6 @@ export default defineNuxtModule({
       })
     }
 
-    {
-      // install pinia
-
-      await installModule('@pinia/nuxt')
-    }
-
     {
       // install @nuxt/fonts
 
@@ -180,17 +214,20 @@ export default defineNuxtModule({
       addComponentsDir({
         path: resolve('./runtime/components'),
         prefix: '',
+        pathPrefix: false,
         global: true
       })
     }
 
     {
       addPlugin(resolve('./runtime/plugins/resize.client.ts'))
+      addPlugin(
+        resolve('./runtime/plugins/02.desktop-register-desktop-apps.client.ts'),
+      )
 
       // add other files
 
       addImportsDir(resolve('./runtime/composables'))
-      addImportsDir(resolve('./runtime/core'))
       addImportsDir(resolve('./runtime/stores'))
       addImportsDir(resolve('./runtime/utils'))
     }

package/package.json

@@ -1,13 +1,16 @@
 {
   "name": "@owdproject/core",
-  "version": "3.1.4",
+  "version": "3.3.0",
+  "description": "Nuxt Desktop module for browser desktop experiences (windows, shell, apps)",
   "keywords": [
-    "web",
-    "desktop",
-    "vue",
     "nuxt",
+    "nuxt-module",
+    "nuxt-desktop",
+    "desktop",
     "web-desktop",
-    "web-os"
+    "vue",
+    "owd",
+    "open-web-desktop"
   ],
   "homepage": "https://github.com/owdproject/client#readme",
   "bugs": {
@@ -24,30 +27,86 @@
   },
   "type": "module",
   "types": "types/index.d.ts",
+  "files": [
+    "bin",
+    "dist",
+    "runtime",
+    "types",
+    "index.ts",
+    "module.ts",
+    "package.json",
+    "README.md"
+  ],
+  "scripts": {
+    "dev": "pnpm run dev:prepare",
+    "dev:prepare": "nuxt-module-build build --stub",
+    "build:module": "nuxt-module-build build",
+    "prepack": "nuxt-module-build build",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "default": "./index.ts"
+    },
+    "./module": {
+      "types": "./dist/types.d.mts",
+      "development": "./module.ts",
+      "import": "./module.ts",
+      "default": "./module.ts"
+    },
+    "./nuxt": {
+      "types": "./dist/types.d.mts",
+      "development": "./module.ts",
+      "import": "./module.ts",
+      "default": "./module.ts"
+    },
+    "./package.json": "./package.json",
+    "./runtime/*": {
+      "types": "./runtime/*",
+      "development": "./runtime/*",
+      "import": "./runtime/*",
+      "default": "./runtime/*"
+    }
+  },
   "bin": {
+    "desktop": "bin/desktop.js",
     "owd": "bin/owd.js"
   },
   "dependencies": {
-    "@nuxt/fonts": "^0.11.4",
-    "@nuxt/icon": "^1.14.0",
-    "@nuxt/kit": "^3.17.5",
-    "@nuxtjs/i18n": "^9.5.5",
+    "@nuxt/fonts": "^0.14.0",
+    "@nuxt/icon": "^2.2.1",
+    "@nuxt/kit": "^4.4.4",
+    "@nuxtjs/i18n": "^10.3.0",
     "@nuxtjs/tailwindcss": "^6.14.0",
-    "@pinia/nuxt": "^0.11.1",
-    "@primeuix/themes": "^1.1.2",
-    "@primevue/forms": "^4.3.5",
-    "@primevue/nuxt-module": "^4.3.5",
-    "@vueuse/components": "^13.4.0",
-    "@vueuse/core": "^13.4.0",
-    "@vueuse/nuxt": "^13.4.0",
+    "@pinia/nuxt": "^0.11.3",
+    "@primeuix/themes": "^2.0.3",
+    "@primevue/forms": "^4.5.5",
+    "@primevue/nuxt-module": "^4.5.5",
+    "@vueuse/components": "^14.3.0",
+    "@vueuse/core": "^14.3.0",
+    "@vueuse/nuxt": "^14.3.0",
     "mitt": "^3.0.1",
-    "nanoid": "^5.1.5",
-    "nuxt": "^3.17.5",
-    "pinia": "^3.0.3",
+    "nanoid": "^5.1.11",
+    "nuxt": "^4.4.4",
+    "pinia": "^3.0.4",
     "sanitize.css": "^13.0.0",
-    "sass": "^1.89.2",
-    "shellwords": "^1.0.1",
+    "sass": "^1.99.0",
+    "shellwords": "^1.1.1",
     "vue-resizable": "^2.1.7",
-    "getopts": "^2.3.0"
+    "getopts": "^2.3.0",
+    "defu": "^6.1.4",
+    "neo-blessed": "^0.2.0"
+  },
+  "optionalDependencies": {
+    "html2canvas": "^1.4.1"
+  },
+  "devDependencies": {
+    "@nuxt/devtools": "^3.2.4",
+    "@nuxt/module-builder": "^1.0.2",
+    "@nuxt/schema": "^4.4.4",
+    "typescript": "~5.8.3",
+    "vue-tsc": "^2.2.10"
   }
 }

package/runtime/components/{Core/Application/CoreApplicationRender.vue → Desktop/Application/DesktopApplicationRender.vue}

@@ -6,13 +6,15 @@ defineProps<{
 }>()
 
 const applicationManager = useApplicationManager()
+const runningApps = applicationManager.appsRunning
 </script>
 
 <template>
-  <CoreApplicationWindowsRender
-    v-for="app of applicationManager.appsRunning.value"
+  <DesktopApplicationWindowsRender
+    v-for="app of runningApps"
     :key="app.id"
     :workspace-filter="workspaceFilter"
     :windows="app.windowsOpened"
+    :window-revision="app.openWindowCount.value"
   />
 </template>

package/runtime/components/Desktop/Application/DesktopApplicationWindowsRender.vue

@@ -0,0 +1,38 @@
+<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>