@owdproject/core 3.3.0 → 3.4.0

package/README.md

@@ -1,89 +1,22 @@
-<p align="center">
-  <img width="160" height="160" src="https://avatars.githubusercontent.com/u/65117737?s=160&v=4" />
-</p>
-<h1 align="center">Open Web Desktop</h1>
-<h3 align="center">
-  A modular framework for building web-based desktop experiences.
-</h3>
+# 📦 OWD Core
 
-## Overview
+> The kernel and runtime engine for Open Web Desktop
 
-Open Web Desktop (OWD) is a framework designed to provide a simple environment for building web-based desktop experiences. It's built with TypeScript on top of the Nuxt.js framework.
-
-[Demo](https://atproto-os.pages.dev/) · [Community](https://discord.gg/zPNaN2HAaA) · [Documentation](https://owdproject.org/)
+This package provides the core logic, Vue components, and Nuxt module required to run an Open Web Desktop experience.
 
 ## Features
 
-- Fully extendable through themes, apps, and modules
-- Bundled with popular Vue.js libraries like Pinia and VueUse
-- Designed to make the most of the Nuxt.js ecosystem
-- Styled with PrimeVue and Tailwind for a consistent UI
-- Fully localizable with nuxt-i18n support
-
-## Getting started
-
-Bootstrap a new project by running:
-
-```bash
-npm create owd
-```
-
-Once the process is done, you can start to develop:
-
-```bash
-cd owd-client
-
-# Run the dev server with hot-reload
-pnpm install
-pnpm run dev
-
-# Build for production
-pnpm run generate
-```
-
-## Extend your desktop
-
-Thanks to Tailwind and PrimeVue, you can create custom themes from scratch and ensure a consistent look across all apps. Each theme defines its own style, making your desktop both cohesive and uniquely yours.
-
-[Applications](https://github.com/topics/owd-apps) · [Modules](https://github.com/topics/owd-modules) · [Themes](https://github.com/topics/owd-themes)
-
-### 🧩 Install an app
-
-Discover apps by searching the [owd-apps](https://github.com/topics/owd-apps) tag on GitHub.
-
-For example, to add the To-do app:
-
-```bash
-desktop add app-todo
-```
-
-Shipped with `@owdproject/core` (`bin/desktop.js`). The `owd` binary is a deprecated alias.
-
-### 🧩 Install a module
-
-Discover modules by searching the [owd-modules](https://github.com/topics/owd-modules) tag on GitHub.
-
-For example, to add Pinia persistence backed by IndexedDB (`idb-keyval`):
-
-```bash
-desktop add module-pinia-idb
-```
-
-### 🖥️ Install a theme
-
-Themes are full desktop environments that style all UI components independently, using [PrimeVue](https://primevue.org/).  
-Each theme provides a unique look and feel while maintaining consistent functionality across all applications.
-
-Discover themes by searching the [owd-themes](https://github.com/topics/owd-themes) tag on GitHub.
-
-```bash
-desktop add theme-gnome
-```
+- **Window Management**: Z-index handling, focusing, and lifecycle.
+- **Runtime Components**: \`DesktopCore\`, \`DesktopWindow\`, and more.
+- **State Management**: Pinia stores for workspaces, applications, and settings.
+- **Nuxt Integration**: Seamless module for Nuxt 3/4.
 
-## Sponsors
+## Installation
 
-Be the first to support this project and help us keep it growing! [Sponsor the project](https://github.com/sponsors/owdproject)
+\`\`\`bash
+pnpm add @owdproject/core
+\`\`\`
 
-## License
+---
 
-Open Web Desktop is released under the [MIT License](LICENSE).
+Licensed under [MIT](./LICENSE)

package/dist/module.d.mts

@@ -1,6 +1,6 @@
-import * as _nuxt_schema from '@nuxt/schema';
+import * as nuxt_schema from 'nuxt/schema';
 
-declare const _default: _nuxt_schema.NuxtModule<{
+declare const _default: nuxt_schema.NuxtModule<{
     theme: string;
     apps: never[];
     modules: never[];

package/dist/module.json

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

package/dist/module.mjs

@@ -1,4 +1,4 @@
-import { defineNuxtModule, createResolver, installModule, addComponentsDir, addPlugin, addImportsDir } from '@nuxt/kit';
+import { installModule, defineNuxtModule, createResolver, resolvePath, addComponentsDir, addPlugin, addImportsDir } from '@nuxt/kit';
 import { defu } from 'defu';
 import { existsSync } from 'node:fs';
 import { join } from 'node:path';
@@ -30,7 +30,6 @@ function assertValidDesktopUserConfig(config, configFile = "desktop.config.ts")
     }
   }
 }
-
 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).";
@@ -62,22 +61,8 @@ function warnLegacyDesktopConfig(resolved) {
     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",
@@ -95,45 +80,75 @@ const NUXT_OPTION_KEYS = /* @__PURE__ */ new Set([
   "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;
+function warnDesktopConfigKeys(config, configFile = "desktop.config.ts") {
+  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, ... }).`
       );
-    } 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 };
+}
+function readConfigKey(mod) {
+  const key = mod?.meta?.configKey ?? mod?.default?.meta?.configKey;
+  return typeof key === "string" && key.length > 0 ? key : void 0;
+}
+async function loadModuleDescriptor(modulePath) {
+  try {
+    const imported = await import(modulePath);
+    return imported.default ?? imported;
+  } catch (e) {
+    console.warn(`[@owdproject/core] Failed to load module descriptor for "${modulePath}":`, e.message || e);
+    return void 0;
+  }
+}
+async function installDesktopPackage(nuxt, modulePath, desktop) {
+  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 : {};
+    await installModule(modulePath, inline);
+    return;
+  }
+  await installModule(modulePath);
 }
 
-const version = "3.3.0";
+const version = "3.4.0";
 const pkg = {
 	version: version};
 
 const module$1 = defineNuxtModule({
   meta: {
     name: "desktop",
-    configKey: "owd"
+    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 = null;
+    try {
+      resolvedNanoid = await resolvePath("nanoid", { url: import.meta.url });
+    } catch (e) {
+    }
     _nuxt.options.experimental = {
       ..._nuxt.options.experimental,
       viteEnvironmentApi: _nuxt.options.experimental?.viteEnvironmentApi ?? true
@@ -146,6 +161,8 @@ const module$1 = defineNuxtModule({
       throw new Error(`[@owdproject/core] Cannot find desktop.config.ts in ${_nuxt.options.rootDir}. ${hint}`);
     }
     warnLegacyDesktopConfig(resolvedConfig);
+    _nuxt.options.watch ??= [];
+    _nuxt.options.watch.push(resolvedConfig.path);
     try {
       clientConfig = (await import(resolvedConfig.path)).default;
     } catch (e) {
@@ -159,79 +176,41 @@ const module$1 = defineNuxtModule({
     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");
+    const configRecord = clientConfig;
+    warnDesktopConfigKeys(configRecord, resolvedConfig.file);
+    const desktop = defu(configRecord, { coreVersion: pkg.version });
+    _nuxt.options.runtimeConfig.public.desktop = desktop;
     {
-      if (clientConfig.theme) {
-        await installModule(clientConfig.theme);
-      }
-      if (clientConfig.modules && Array.isArray(clientConfig.modules)) {
-        for (const modulePath of clientConfig.modules) {
-          await installModule(modulePath);
+      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 (clientConfig.apps && Array.isArray(clientConfig.apps)) {
-        for (const appPath of clientConfig.apps) {
-          await installModule(appPath);
+      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}`);
+          }
         }
       }
-    }
-    _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");
+      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}`);
+          }
         }
       }
-      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.options.appConfig.desktop = _nuxt.options.runtimeConfig.public.desktop;
     {
       _nuxt.hook("vite:extendConfig", (viteConfig) => {
         viteConfig.css = viteConfig.css || {};
@@ -239,6 +218,11 @@ const module$1 = defineNuxtModule({
         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);
+        }
       });
     }
     {
@@ -247,13 +231,16 @@ const module$1 = defineNuxtModule({
     {
       addComponentsDir({
         path: resolve("./runtime/components"),
-        prefix: "",
+        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")
       );

package/index.ts

@@ -1,5 +1,8 @@
+export { defineDesktopApp } from './kit/defineDesktopApp'
 export {
-  defineDesktopApp,
   defineDesktopConfig,
-} from './runtime/utils/utilDesktop'
-export { registerTailwindPath } from './runtime/utils/utilApp'
+  defineDesktopModule,
+  defineDesktopTheme,
+  mergeDesktopExtensionConfig,
+  setDesktopExtensionConfig,
+} from './kit/authoring'